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.178 by root, Tue Aug 11 01:15:17 2009 UTC vs.
Revision 1.208 by root, Sun Dec 5 11:41:45 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
… …
60use AnyEvent (); BEGIN { AnyEvent::common_sense } 60use AnyEvent (); BEGIN { AnyEvent::common_sense }
61use AnyEvent::Util qw(WSAEWOULDBLOCK); 61use AnyEvent::Util qw(WSAEWOULDBLOCK);
62 62
63our $VERSION = $AnyEvent::VERSION; 63our $VERSION = $AnyEvent::VERSION;
64 64
65sub _load_func($) {
66 my $func = $_[0];
67
68 unless (defined &$func) {
69 my $pkg = $func;
70 do {
71 $pkg =~ s/::[^:]+$//
72 or return;
73 eval "require $pkg";
74 } until defined &$func;
75 }
76
77 \&$func
78}
79
80sub MAX_READ_SIZE() { 131072 }
81
65=head1 METHODS 82=head1 METHODS
66 83
67=over 4 84=over 4
68 85
69=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... 86=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
70 87
71The constructor supports these arguments (all as C<< key => value >> pairs). 88The constructor supports these arguments (all as C<< key => value >> pairs).
72 89
73=over 4 90=over 4
74 91
… …
103prepare the file handle with parameters required for the actual connect 120prepare the file handle with parameters required for the actual connect
104(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
105established). 122established).
106 123
107The return value of this callback should be the connect timeout value in 124The return value of this callback should be the connect timeout value in
108seconds (or C<0>, or C<undef>, or the empty list, to indicate the default 125seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
109timeout is to be used). 126default timeout is to be used).
110 127
111=item on_connect => $cb->($handle, $host, $port, $retry->()) 128=item on_connect => $cb->($handle, $host, $port, $retry->())
112 129
113This callback is called when a connection has been successfully established. 130This callback is called when a connection has been successfully established.
114 131
115The actual numeric host and port (the socket peername) are passed as 132The peer's numeric host and port (the socket peername) are passed as
116parameters, together with a retry callback. 133parameters, together with a retry callback.
117 134
118When, for some reason, the handle is not acceptable, then calling 135If, for some reason, the handle is not acceptable, calling C<$retry>
119C<$retry> will continue with the next conenction target (in case of 136will continue with the next connection target (in case of multi-homed
120multi-homed hosts or SRV records there can be multiple connection 137hosts or SRV records there can be multiple connection endpoints). At the
121endpoints). When it is called then the read and write queues, eof status, 138time it is called the read and write queues, eof status, tls status and
122tls status and similar properties of the handle are being reset. 139similar properties of the handle will have been reset.
123 140
124In most cases, ignoring the C<$retry> parameter is the way to go. 141In most cases, you should ignore the C<$retry> parameter.
125 142
126=item on_connect_error => $cb->($handle, $message) 143=item on_connect_error => $cb->($handle, $message)
127 144
128This callback is called when the conenction could not be 145This callback is called when the connection could not be
129established. C<$!> will contain the relevant error code, and C<$message> a 146established. C<$!> will contain the relevant error code, and C<$message> a
130message describing it (usually the same as C<"$!">). 147message describing it (usually the same as C<"$!">).
131 148
132If this callback isn't specified, then C<on_error> will be called with a 149If this callback isn't specified, then C<on_error> will be called with a
133fatal error instead. 150fatal error instead.
… …
136 153
137=item on_error => $cb->($handle, $fatal, $message) 154=item on_error => $cb->($handle, $fatal, $message)
138 155
139This is the error callback, which is called when, well, some error 156This is the error callback, which is called when, well, some error
140occured, such as not being able to resolve the hostname, failure to 157occured, such as not being able to resolve the hostname, failure to
141connect or a read error. 158connect, or a read error.
142 159
143Some errors are fatal (which is indicated by C<$fatal> being true). On 160Some errors are fatal (which is indicated by C<$fatal> being true). On
144fatal errors the handle object will be destroyed (by a call to C<< -> 161fatal errors the handle object will be destroyed (by a call to C<< ->
145destroy >>) after invoking the error callback (which means you are free to 162destroy >>) after invoking the error callback (which means you are free to
146examine the handle object). Examples of fatal errors are an EOF condition 163examine the handle object). Examples of fatal errors are an EOF condition
147with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In 164with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
148cases where the other side can close the connection at their will it is 165cases where the other side can close the connection at will, it is
149often easiest to not report C<EPIPE> errors in this callback. 166often easiest to not report C<EPIPE> errors in this callback.
150 167
151AnyEvent::Handle tries to find an appropriate error code for you to check 168AnyEvent::Handle tries to find an appropriate error code for you to check
152against, but in some cases (TLS errors), this does not work well. It is 169against, but in some cases (TLS errors), this does not work well. It is
153recommended to always output the C<$message> argument in human-readable 170recommended to always output the C<$message> argument in human-readable
154error messages (it's usually the same as C<"$!">). 171error messages (it's usually the same as C<"$!">).
155 172
156Non-fatal errors can be retried by simply returning, but it is recommended 173Non-fatal errors can be retried by returning, but it is recommended
157to simply ignore this parameter and instead abondon the handle object 174to simply ignore this parameter and instead abondon the handle object
158when this callback is invoked. Examples of non-fatal errors are timeouts 175when this callback is invoked. Examples of non-fatal errors are timeouts
159C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 176C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
160 177
161On callback entrance, the value of C<$!> contains the operating system 178On entry to the callback, the value of C<$!> contains the operating
162error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or 179system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
163C<EPROTO>). 180C<EPROTO>).
164 181
165While not mandatory, it is I<highly> recommended to set this callback, as 182While not mandatory, it is I<highly> recommended to set this callback, as
166you will not be notified of errors otherwise. The default simply calls 183you will not be notified of errors otherwise. The default just calls
167C<croak>. 184C<croak>.
168 185
169=item on_read => $cb->($handle) 186=item on_read => $cb->($handle)
170 187
171This sets the default read callback, which is called when data arrives 188This sets the default read callback, which is called when data arrives
… …
176To access (and remove data from) the read buffer, use the C<< ->rbuf >> 193To access (and remove data from) the read buffer, use the C<< ->rbuf >>
177method or access the C<< $handle->{rbuf} >> member directly. Note that you 194method or access the C<< $handle->{rbuf} >> member directly. Note that you
178must not enlarge or modify the read buffer, you can only remove data at 195must not enlarge or modify the read buffer, you can only remove data at
179the beginning from it. 196the beginning from it.
180 197
198You can also call C<< ->push_read (...) >> or any other function that
199modifies the read queue. Or do both. Or ...
200
181When an EOF condition is detected then AnyEvent::Handle will first try to 201When an EOF condition is detected, AnyEvent::Handle will first try to
182feed all the remaining data to the queued callbacks and C<on_read> before 202feed all the remaining data to the queued callbacks and C<on_read> before
183calling the C<on_eof> callback. If no progress can be made, then a fatal 203calling the C<on_eof> callback. If no progress can be made, then a fatal
184error will be raised (with C<$!> set to C<EPIPE>). 204error will be raised (with C<$!> set to C<EPIPE>).
185 205
186Note that, unlike requests in the read queue, an C<on_read> callback 206Note that, unlike requests in the read queue, an C<on_read> callback
… …
205set, then a fatal error will be raised with C<$!> set to <0>. 225set, then a fatal error will be raised with C<$!> set to <0>.
206 226
207=item on_drain => $cb->($handle) 227=item on_drain => $cb->($handle)
208 228
209This sets the callback that is called when the write buffer becomes empty 229This sets the callback that is called when the write buffer becomes empty
210(or when the callback is set and the buffer is empty already). 230(or immediately if the buffer is empty already).
211 231
212To append to the write buffer, use the C<< ->push_write >> method. 232To append to the write buffer, use the C<< ->push_write >> method.
213 233
214This callback is useful when you don't want to put all of your write data 234This callback is useful when you don't want to put all of your write data
215into the queue at once, for example, when you want to write the contents 235into the queue at once, for example, when you want to write the contents
… …
227many seconds pass without a successful read or write on the underlying 247many seconds pass without a successful read or write on the underlying
228file handle (or a call to C<timeout_reset>), the C<on_timeout> callback 248file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
229will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> 249will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
230error will be raised). 250error will be raised).
231 251
232There are three variants of the timeouts that work fully independent 252There are three variants of the timeouts that work independently
233of 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:
234C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks 254C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
235C<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
236C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. 256C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
237 257
238Note that timeout processing is also active when you currently do not have 258Note that timeout processing is active even when you do not have
239any 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
240idle then you should disable the timout temporarily or ignore the timeout 260idle then you should disable the timeout temporarily or ignore the timeout
241in 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
242restart the timeout. 262restart the timeout.
243 263
244Zero (the default) disables this timeout. 264Zero (the default) disables this timeout.
245 265
… …
261amount 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
262isn't finished). 282isn't finished).
263 283
264=item autocork => <boolean> 284=item autocork => <boolean>
265 285
266When disabled (the default), then C<push_write> will try to immediately 286When disabled (the default), C<push_write> will try to immediately
267write 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
268a 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
269be inefficient if you write multiple small chunks (on the wire, this 289be inefficient if you write multiple small chunks (on the wire, this
270disadvantage is usually avoided by your kernel's nagle algorithm, see 290disadvantage is usually avoided by your kernel's nagle algorithm, see
271C<no_delay>, but this option can save costly syscalls). 291C<no_delay>, but this option can save costly syscalls).
272 292
273When enabled, then writes will always be queued till the next event loop 293When enabled, writes will always be queued till the next event loop
274iteration. This is efficient when you do many small writes per iteration, 294iteration. This is efficient when you do many small writes per iteration,
275but less efficient when you do a single write only per iteration (or when 295but less efficient when you do a single write only per iteration (or when
276the write buffer often is full). It also increases write latency. 296the write buffer often is full). It also increases write latency.
277 297
278=item no_delay => <boolean> 298=item no_delay => <boolean>
… …
282the Nagle algorithm, and usually it is beneficial. 302the Nagle algorithm, and usually it is beneficial.
283 303
284In 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
285accomplishd by setting this option to a true value. 305accomplishd by setting this option to a true value.
286 306
287The default is your opertaing system's default behaviour (most likely 307The default is your operating system's default behaviour (most likely
288enabled), this option explicitly enables or disables it, if possible. 308enabled). This option explicitly enables or disables it, if possible.
309
310=item keepalive => <boolean>
311
312Enables (default disable) the SO_KEEPALIVE option on the stream socket:
313normally, TCP connections have no time-out once established, so TCP
314connections, once established, can stay alive forever even when the other
315side has long gone. TCP keepalives are a cheap way to take down long-lived
316TCP connections when the other side becomes unreachable. While the default
317is OS-dependent, TCP keepalives usually kick in after around two hours,
318and, if the other side doesn't reply, take down the TCP connection some 10
319to 15 minutes later.
320
321It is harmless to specify this option for file handles that do not support
322keepalives, and enabling it on connections that are potentially long-lived
323is usually a good idea.
324
325=item oobinline => <boolean>
326
327BSD majorly fucked up the implementation of TCP urgent data. The result
328is that almost no OS implements TCP according to the specs, and every OS
329implements it slightly differently.
330
331If you want to handle TCP urgent data, then setting this flag (the default
332is enabled) gives you the most portable way of getting urgent data, by
333putting it into the stream.
334
335Since BSD emulation of OOB data on top of TCP's urgent data can have
336security implications, AnyEvent::Handle sets this flag automatically
337unless explicitly specified. Note that setting this flag after
338establishing a connection I<may> be a bit too late (data loss could
339already have occured on BSD systems), but at least it will protect you
340from most attacks.
289 341
290=item read_size => <bytes> 342=item read_size => <bytes>
291 343
292The 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
293try to read during each loop iteration, which affects memory 345read during each loop iteration. Each handle object will consume at least
294requirements). 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.
295 355
296=item low_water_mark => <bytes> 356=item low_water_mark => <bytes>
297 357
298Sets 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
299buffer: 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
300considered empty. 360considered empty.
301 361
302Sometimes it can be beneficial (for performance reasons) to add data to 362Sometimes it can be beneficial (for performance reasons) to add data to
303the 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
304the operating system kernel usually buffers data as well, so the default 364the operating system kernel usually buffers data as well, so the default
305is good in almost all cases. 365is good in almost all cases.
306 366
307=item linger => <seconds> 367=item linger => <seconds>
308 368
309If non-zero (default: C<3600>), then the destructor of the 369If this is non-zero (default: C<3600>), the destructor of the
310AnyEvent::Handle object will check whether there is still outstanding 370AnyEvent::Handle object will check whether there is still outstanding
311write 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
312socket. No errors will be reported (this mostly matches how the operating 372socket. No errors will be reported (this mostly matches how the operating
313system treats outstanding data at socket close time). 373system treats outstanding data at socket close time).
314 374
… …
321A string used to identify the remote site - usually the DNS hostname 381A string used to identify the remote site - usually the DNS hostname
322(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.
323 383
324Apart 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
325peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This 385peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
326verification will be skipped when C<peername> is not specified or 386verification will be skipped when C<peername> is not specified or is
327C<undef>. 387C<undef>.
328 388
329=item tls => "accept" | "connect" | Net::SSLeay::SSL object 389=item tls => "accept" | "connect" | Net::SSLeay::SSL object
330 390
331When this parameter is given, it enables TLS (SSL) mode, that means 391When this parameter is given, it enables TLS (SSL) mode, that means
332AnyEvent 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
333established and will transparently encrypt/decrypt data afterwards. 393established and will transparently encrypt/decrypt data afterwards.
334 394
335All TLS protocol errors will be signalled as C<EPROTO>, with an 395All TLS protocol errors will be signalled as C<EPROTO>, with an
336appropriate error message. 396appropriate error message.
337 397
… …
357B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 417B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
358passing 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
359happens 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
360segmentation fault. 420segmentation fault.
361 421
362See 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.
363 423
364=item tls_ctx => $anyevent_tls 424=item tls_ctx => $anyevent_tls
365 425
366Use 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
367(unless a connection object was specified directly). If this parameter is 427(unless a connection object was specified directly). If this
368missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 428parameter is missing (or C<undef>), then AnyEvent::Handle will use
429C<AnyEvent::Handle::TLS_CTX>.
369 430
370Instead of an object, you can also specify a hash reference with C<< key 431Instead of an object, you can also specify a hash reference with C<< key
371=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a 432=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
372new TLS context object. 433new TLS context object.
373 434
… …
382 443
383TLS handshake failures will not cause C<on_error> to be invoked when this 444TLS handshake failures will not cause C<on_error> to be invoked when this
384callback is in effect, instead, the error message will be passed to C<on_starttls>. 445callback is in effect, instead, the error message will be passed to C<on_starttls>.
385 446
386Without this callback, handshake failures lead to C<on_error> being 447Without this callback, handshake failures lead to C<on_error> being
387called, as normal. 448called as usual.
388 449
389Note that you cannot call C<starttls> right again in this callback. If you 450Note that you cannot just call C<starttls> again in this callback. If you
390need to do that, start an zero-second timer instead whose callback can 451need to do that, start an zero-second timer instead whose callback can
391then call C<< ->starttls >> again. 452then call C<< ->starttls >> again.
392 453
393=item on_stoptls => $cb->($handle) 454=item on_stoptls => $cb->($handle)
394 455
… …
441 AnyEvent::Socket::tcp_connect ( 502 AnyEvent::Socket::tcp_connect (
442 $self->{connect}[0], 503 $self->{connect}[0],
443 $self->{connect}[1], 504 $self->{connect}[1],
444 sub { 505 sub {
445 my ($fh, $host, $port, $retry) = @_; 506 my ($fh, $host, $port, $retry) = @_;
507
508 delete $self->{_connect}; # no longer needed
446 509
447 if ($fh) { 510 if ($fh) {
448 $self->{fh} = $fh; 511 $self->{fh} = $fh;
449 512
450 delete $self->{_skip_drain_rbuf}; 513 delete $self->{_skip_drain_rbuf};
… …
484} 547}
485 548
486sub _start { 549sub _start {
487 my ($self) = @_; 550 my ($self) = @_;
488 551
552 # too many clueless people try to use udp and similar sockets
553 # with AnyEvent::Handle, do them a favour.
554 my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
555 Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
556 if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
557
489 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 558 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
490 559
491 $self->{_activity} = 560 $self->{_activity} =
492 $self->{_ractivity} = 561 $self->{_ractivity} =
493 $self->{_wactivity} = AE::now; 562 $self->{_wactivity} = AE::now;
494 563
564 $self->{read_size} ||= 2048;
565 $self->{max_read_size} = $self->{read_size}
566 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
567
495 $self->timeout (delete $self->{timeout} ) if $self->{timeout}; 568 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
496 $self->rtimeout (delete $self->{rtimeout}) if $self->{rtimeout}; 569 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
497 $self->wtimeout (delete $self->{wtimeout}) if $self->{wtimeout}; 570 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
498 571
499 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; 572 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
573 $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
500 574
575 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
576
501 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 577 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
502 if $self->{tls}; 578 if $self->{tls};
503 579
504 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 580 $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
505 581
506 $self->start_read 582 $self->start_read
507 if $self->{on_read} || @{ $self->{_queue} }; 583 if $self->{on_read} || @{ $self->{_queue} };
508 584
509 $self->_drain_wbuf; 585 $self->_drain_wbuf;
… …
516 $message ||= "$!"; 592 $message ||= "$!";
517 593
518 if ($self->{on_error}) { 594 if ($self->{on_error}) {
519 $self->{on_error}($self, $fatal, $message); 595 $self->{on_error}($self, $fatal, $message);
520 $self->destroy if $fatal; 596 $self->destroy if $fatal;
521 } elsif ($self->{fh}) { 597 } elsif ($self->{fh} || $self->{connect}) {
522 $self->destroy; 598 $self->destroy;
523 Carp::croak "AnyEvent::Handle uncaught error: $message"; 599 Carp::croak "AnyEvent::Handle uncaught error: $message";
524 } 600 }
525} 601}
526 602
… …
585=cut 661=cut
586 662
587sub no_delay { 663sub no_delay {
588 $_[0]{no_delay} = $_[1]; 664 $_[0]{no_delay} = $_[1];
589 665
666 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
667 if $_[0]{fh};
668}
669
670=item $handle->keepalive ($boolean)
671
672Enables or disables the C<keepalive> setting (see constructor argument of
673the same name for details).
674
675=cut
676
677sub keepalive {
678 $_[0]{keepalive} = $_[1];
679
590 eval { 680 eval {
591 local $SIG{__DIE__}; 681 local $SIG{__DIE__};
592 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1] 682 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
593 if $_[0]{fh}; 683 if $_[0]{fh};
594 }; 684 };
595} 685}
596 686
687=item $handle->oobinline ($boolean)
688
689Enables or disables the C<oobinline> setting (see constructor argument of
690the same name for details).
691
692=cut
693
694sub oobinline {
695 $_[0]{oobinline} = $_[1];
696
697 eval {
698 local $SIG{__DIE__};
699 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
700 if $_[0]{fh};
701 };
702}
703
704=item $handle->keepalive ($boolean)
705
706Enables or disables the C<keepalive> setting (see constructor argument of
707the same name for details).
708
709=cut
710
711sub keepalive {
712 $_[0]{keepalive} = $_[1];
713
714 eval {
715 local $SIG{__DIE__};
716 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
717 if $_[0]{fh};
718 };
719}
720
597=item $handle->on_starttls ($cb) 721=item $handle->on_starttls ($cb)
598 722
599Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). 723Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
600 724
601=cut 725=cut
… …
608 732
609Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). 733Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
610 734
611=cut 735=cut
612 736
613sub on_starttls { 737sub on_stoptls {
614 $_[0]{on_stoptls} = $_[1]; 738 $_[0]{on_stoptls} = $_[1];
615} 739}
616 740
617=item $handle->rbuf_max ($max_octets) 741=item $handle->rbuf_max ($max_octets)
618 742
… …
657 $_[0]{$on_timeout} = $_[1]; 781 $_[0]{$on_timeout} = $_[1];
658 }; 782 };
659 783
660 *$timeout = sub { 784 *$timeout = sub {
661 my ($self, $new_value) = @_; 785 my ($self, $new_value) = @_;
786
787 $new_value >= 0
788 or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
662 789
663 $self->{$timeout} = $new_value; 790 $self->{$timeout} = $new_value;
664 delete $self->{$tw}; &$cb; 791 delete $self->{$tw}; &$cb;
665 }; 792 };
666 793
… …
730=item $handle->on_drain ($cb) 857=item $handle->on_drain ($cb)
731 858
732Sets the C<on_drain> callback or clears it (see the description of 859Sets the C<on_drain> callback or clears it (see the description of
733C<on_drain> in the constructor). 860C<on_drain> in the constructor).
734 861
862This method may invoke callbacks (and therefore the handle might be
863destroyed after it returns).
864
735=cut 865=cut
736 866
737sub on_drain { 867sub on_drain {
738 my ($self, $cb) = @_; 868 my ($self, $cb) = @_;
739 869
… …
746=item $handle->push_write ($data) 876=item $handle->push_write ($data)
747 877
748Queues the given scalar to be written. You can push as much data as you 878Queues the given scalar to be written. You can push as much data as you
749want (only limited by the available memory), as C<AnyEvent::Handle> 879want (only limited by the available memory), as C<AnyEvent::Handle>
750buffers it independently of the kernel. 880buffers it independently of the kernel.
881
882This method may invoke callbacks (and therefore the handle might be
883destroyed after it returns).
751 884
752=cut 885=cut
753 886
754sub _drain_wbuf { 887sub _drain_wbuf {
755 my ($self) = @_; 888 my ($self) = @_;
… …
785 }; 918 };
786} 919}
787 920
788our %WH; 921our %WH;
789 922
923# deprecated
790sub register_write_type($$) { 924sub register_write_type($$) {
791 $WH{$_[0]} = $_[1]; 925 $WH{$_[0]} = $_[1];
792} 926}
793 927
794sub push_write { 928sub push_write {
795 my $self = shift; 929 my $self = shift;
796 930
797 if (@_ > 1) { 931 if (@_ > 1) {
798 my $type = shift; 932 my $type = shift;
799 933
934 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
800 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") 935 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
801 ->($self, @_); 936 ->($self, @_);
802 } 937 }
803 938
939 # we downgrade here to avoid hard-to-track-down bugs,
940 # and diagnose the problem earlier and better.
941
804 if ($self->{tls}) { 942 if ($self->{tls}) {
805 $self->{_tls_wbuf} .= $_[0]; 943 utf8::downgrade $self->{_tls_wbuf} .= $_[0];
806 &_dotls ($self) if $self->{fh}; 944 &_dotls ($self) if $self->{fh};
807 } else { 945 } else {
808 $self->{wbuf} .= $_[0]; 946 utf8::downgrade $self->{wbuf} .= $_[0];
809 $self->_drain_wbuf if $self->{fh}; 947 $self->_drain_wbuf if $self->{fh};
810 } 948 }
811} 949}
812 950
813=item $handle->push_write (type => @args) 951=item $handle->push_write (type => @args)
814 952
815Instead of formatting your data yourself, you can also let this module do 953Instead of formatting your data yourself, you can also let this module
816the job by specifying a type and type-specific arguments. 954do the job by specifying a type and type-specific arguments. You
955can also specify the (fully qualified) name of a package, in which
956case AnyEvent tries to load the package and then expects to find the
957C<anyevent_write_type> function inside (see "custom write types", below).
817 958
818Predefined types are (if you have ideas for additional types, feel free to 959Predefined types are (if you have ideas for additional types, feel free to
819drop by and tell us): 960drop by and tell us):
820 961
821=over 4 962=over 4
… …
878Other languages could read single lines terminated by a newline and pass 1019Other languages could read single lines terminated by a newline and pass
879this line into their JSON decoder of choice. 1020this line into their JSON decoder of choice.
880 1021
881=cut 1022=cut
882 1023
1024sub json_coder() {
1025 eval { require JSON::XS; JSON::XS->new->utf8 }
1026 || do { require JSON; JSON->new->utf8 }
1027}
1028
883register_write_type json => sub { 1029register_write_type json => sub {
884 my ($self, $ref) = @_; 1030 my ($self, $ref) = @_;
885 1031
886 require JSON; 1032 my $json = $self->{json} ||= json_coder;
887 1033
888 $self->{json} ? $self->{json}->encode ($ref) 1034 $json->encode ($ref)
889 : JSON::encode_json ($ref)
890}; 1035};
891 1036
892=item storable => $reference 1037=item storable => $reference
893 1038
894Freezes the given reference using L<Storable> and writes it to the 1039Freezes the given reference using L<Storable> and writes it to the
… …
920the peer. 1065the peer.
921 1066
922You can rely on the normal read queue and C<on_eof> handling 1067You can rely on the normal read queue and C<on_eof> handling
923afterwards. This is the cleanest way to close a connection. 1068afterwards. This is the cleanest way to close a connection.
924 1069
1070This method may invoke callbacks (and therefore the handle might be
1071destroyed after it returns).
1072
925=cut 1073=cut
926 1074
927sub push_shutdown { 1075sub push_shutdown {
928 my ($self) = @_; 1076 my ($self) = @_;
929 1077
930 delete $self->{low_water_mark}; 1078 delete $self->{low_water_mark};
931 $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); 1079 $self->on_drain (sub { shutdown $_[0]{fh}, 1 });
932} 1080}
933 1081
934=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 1082=item custom write types - Package::anyevent_write_type $handle, @args
935 1083
936This function (not method) lets you add your own types to C<push_write>. 1084Instead of one of the predefined types, you can also specify the name of
1085a package. AnyEvent will try to load the package and then expects to find
1086a function named C<anyevent_write_type> inside. If it isn't found, it
1087progressively tries to load the parent package until it either finds the
1088function (good) or runs out of packages (bad).
1089
937Whenever the given C<type> is used, C<push_write> will invoke the code 1090Whenever the given C<type> is used, C<push_write> will the function with
938reference with the handle object and the remaining arguments. 1091the handle object and the remaining arguments.
939 1092
940The code reference is supposed to return a single octet string that will 1093The function is supposed to return a single octet string that will be
941be appended to the write buffer. 1094appended to the write buffer, so you cna mentally treat this function as a
1095"arguments to on-the-wire-format" converter.
942 1096
943Note that this is a function, and all types registered this way will be 1097Example: implement a custom write type C<join> that joins the remaining
944global, so try to use unique names. 1098arguments using the first one.
1099
1100 $handle->push_write (My::Type => " ", 1,2,3);
1101
1102 # uses the following package, which can be defined in the "My::Type" or in
1103 # the "My" modules to be auto-loaded, or just about anywhere when the
1104 # My::Type::anyevent_write_type is defined before invoking it.
1105
1106 package My::Type;
1107
1108 sub anyevent_write_type {
1109 my ($handle, $delim, @args) = @_;
1110
1111 join $delim, @args
1112 }
945 1113
946=cut 1114=cut
947 1115
948############################################################################# 1116#############################################################################
949 1117
… …
958ways, the "simple" way, using only C<on_read> and the "complex" way, using 1126ways, the "simple" way, using only C<on_read> and the "complex" way, using
959a queue. 1127a queue.
960 1128
961In the simple case, you just install an C<on_read> callback and whenever 1129In the simple case, you just install an C<on_read> callback and whenever
962new data arrives, it will be called. You can then remove some data (if 1130new data arrives, it will be called. You can then remove some data (if
963enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna 1131enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
964leave the data there if you want to accumulate more (e.g. when only a 1132leave the data there if you want to accumulate more (e.g. when only a
965partial message has been received so far). 1133partial message has been received so far), or change the read queue with
1134e.g. C<push_read>.
966 1135
967In the more complex case, you want to queue multiple callbacks. In this 1136In the more complex case, you want to queue multiple callbacks. In this
968case, AnyEvent::Handle will call the first queued callback each time new 1137case, AnyEvent::Handle will call the first queued callback each time new
969data arrives (also the first time it is queued) and removes it when it has 1138data arrives (also the first time it is queued) and remove it when it has
970done its job (see C<push_read>, below). 1139done its job (see C<push_read>, below).
971 1140
972This way you can, for example, push three line-reads, followed by reading 1141This way you can, for example, push three line-reads, followed by reading
973a chunk of data, and AnyEvent::Handle will execute them in order. 1142a chunk of data, and AnyEvent::Handle will execute them in order.
974 1143
… …
1105 1274
1106This replaces the currently set C<on_read> callback, or clears it (when 1275This replaces the currently set C<on_read> callback, or clears it (when
1107the new callback is C<undef>). See the description of C<on_read> in the 1276the new callback is C<undef>). See the description of C<on_read> in the
1108constructor. 1277constructor.
1109 1278
1279This method may invoke callbacks (and therefore the handle might be
1280destroyed after it returns).
1281
1110=cut 1282=cut
1111 1283
1112sub on_read { 1284sub on_read {
1113 my ($self, $cb) = @_; 1285 my ($self, $cb) = @_;
1114 1286
… …
1116 $self->_drain_rbuf if $cb; 1288 $self->_drain_rbuf if $cb;
1117} 1289}
1118 1290
1119=item $handle->rbuf 1291=item $handle->rbuf
1120 1292
1121Returns the read buffer (as a modifiable lvalue). 1293Returns the read buffer (as a modifiable lvalue). You can also access the
1294read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
1295much faster, and no less clean).
1122 1296
1123You can access the read buffer directly as the C<< ->{rbuf} >> 1297The only operation allowed on the read buffer (apart from looking at it)
1124member, if you want. However, the only operation allowed on the 1298is removing data from its beginning. Otherwise modifying or appending to
1125read buffer (apart from looking at it) is removing data from its 1299it is not allowed and will lead to hard-to-track-down bugs.
1126beginning. Otherwise modifying or appending to it is not allowed and will
1127lead to hard-to-track-down bugs.
1128 1300
1129NOTE: The read buffer should only be used or modified if the C<on_read>, 1301NOTE: The read buffer should only be used or modified in the C<on_read>
1130C<push_read> or C<unshift_read> methods are used. The other read methods 1302callback or when C<push_read> or C<unshift_read> are used with a single
1131automatically manage the read buffer. 1303callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
1304will manage the read buffer on their own.
1132 1305
1133=cut 1306=cut
1134 1307
1135sub rbuf : lvalue { 1308sub rbuf : lvalue {
1136 $_[0]{rbuf} 1309 $_[0]{rbuf}
… …
1153 1326
1154If enough data was available, then the callback must remove all data it is 1327If enough data was available, then the callback must remove all data it is
1155interested in (which can be none at all) and return a true value. After returning 1328interested in (which can be none at all) and return a true value. After returning
1156true, it will be removed from the queue. 1329true, it will be removed from the queue.
1157 1330
1331These methods may invoke callbacks (and therefore the handle might be
1332destroyed after it returns).
1333
1158=cut 1334=cut
1159 1335
1160our %RH; 1336our %RH;
1161 1337
1162sub register_read_type($$) { 1338sub register_read_type($$) {
… …
1168 my $cb = pop; 1344 my $cb = pop;
1169 1345
1170 if (@_) { 1346 if (@_) {
1171 my $type = shift; 1347 my $type = shift;
1172 1348
1349 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1173 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 1350 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1174 ->($self, $cb, @_); 1351 ->($self, $cb, @_);
1175 } 1352 }
1176 1353
1177 push @{ $self->{_queue} }, $cb; 1354 push @{ $self->{_queue} }, $cb;
1178 $self->_drain_rbuf; 1355 $self->_drain_rbuf;
… …
1183 my $cb = pop; 1360 my $cb = pop;
1184 1361
1185 if (@_) { 1362 if (@_) {
1186 my $type = shift; 1363 my $type = shift;
1187 1364
1365 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1188 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 1366 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1189 ->($self, $cb, @_); 1367 ->($self, $cb, @_);
1190 } 1368 }
1191
1192 1369
1193 unshift @{ $self->{_queue} }, $cb; 1370 unshift @{ $self->{_queue} }, $cb;
1194 $self->_drain_rbuf; 1371 $self->_drain_rbuf;
1195} 1372}
1196 1373
… …
1198 1375
1199=item $handle->unshift_read (type => @args, $cb) 1376=item $handle->unshift_read (type => @args, $cb)
1200 1377
1201Instead of providing a callback that parses the data itself you can chose 1378Instead of providing a callback that parses the data itself you can chose
1202between a number of predefined parsing formats, for chunks of data, lines 1379between a number of predefined parsing formats, for chunks of data, lines
1203etc. 1380etc. You can also specify the (fully qualified) name of a package, in
1381which case AnyEvent tries to load the package and then expects to find the
1382C<anyevent_read_type> function inside (see "custom read types", below).
1204 1383
1205Predefined types are (if you have ideas for additional types, feel free to 1384Predefined types are (if you have ideas for additional types, feel free to
1206drop by and tell us): 1385drop by and tell us):
1207 1386
1208=over 4 1387=over 4
… …
1300the receive buffer when neither C<$accept> nor C<$reject> match, 1479the receive buffer when neither C<$accept> nor C<$reject> match,
1301and everything preceding and including the match will be accepted 1480and everything preceding and including the match will be accepted
1302unconditionally. This is useful to skip large amounts of data that you 1481unconditionally. This is useful to skip large amounts of data that you
1303know cannot be matched, so that the C<$accept> or C<$reject> regex do not 1482know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1304have to start matching from the beginning. This is purely an optimisation 1483have to start matching from the beginning. This is purely an optimisation
1305and is usually worth only when you expect more than a few kilobytes. 1484and is usually worth it only when you expect more than a few kilobytes.
1306 1485
1307Example: expect a http header, which ends at C<\015\012\015\012>. Since we 1486Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1308expect the header to be very large (it isn't in practise, but...), we use 1487expect the header to be very large (it isn't in practice, but...), we use
1309a skip regex to skip initial portions. The skip regex is tricky in that 1488a skip regex to skip initial portions. The skip regex is tricky in that
1310it only accepts something not ending in either \015 or \012, as these are 1489it only accepts something not ending in either \015 or \012, as these are
1311required for the accept regex. 1490required for the accept regex.
1312 1491
1313 $handle->push_read (regex => 1492 $handle->push_read (regex =>
… …
1448=cut 1627=cut
1449 1628
1450register_read_type json => sub { 1629register_read_type json => sub {
1451 my ($self, $cb) = @_; 1630 my ($self, $cb) = @_;
1452 1631
1453 my $json = $self->{json} ||= 1632 my $json = $self->{json} ||= json_coder;
1454 eval { require JSON::XS; JSON::XS->new->utf8 }
1455 || do { require JSON; JSON->new->utf8 };
1456 1633
1457 my $data; 1634 my $data;
1458 my $rbuf = \$self->{rbuf}; 1635 my $rbuf = \$self->{rbuf};
1459 1636
1460 sub { 1637 sub {
… …
1529 } 1706 }
1530}; 1707};
1531 1708
1532=back 1709=back
1533 1710
1534=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) 1711=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1535 1712
1536This function (not method) lets you add your own types to C<push_read>. 1713Instead of one of the predefined types, you can also specify the name
1714of a package. AnyEvent will try to load the package and then expects to
1715find a function named C<anyevent_read_type> inside. If it isn't found, it
1716progressively tries to load the parent package until it either finds the
1717function (good) or runs out of packages (bad).
1537 1718
1538Whenever the given C<type> is used, C<push_read> will invoke the code 1719Whenever this type is used, C<push_read> will invoke the function with the
1539reference with the handle object, the callback and the remaining 1720handle object, the original callback and the remaining arguments.
1540arguments.
1541 1721
1542The code reference is supposed to return a callback (usually a closure) 1722The function is supposed to return a callback (usually a closure) that
1543that works as a plain read callback (see C<< ->push_read ($cb) >>). 1723works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
1724mentally treat the function as a "configurable read type to read callback"
1725converter.
1544 1726
1545It should invoke the passed callback when it is done reading (remember to 1727It should invoke the original callback when it is done reading (remember
1546pass C<$handle> as first argument as all other callbacks do that). 1728to pass C<$handle> as first argument as all other callbacks do that,
1729although there is no strict requirement on this).
1547 1730
1548Note that this is a function, and all types registered this way will be
1549global, so try to use unique names.
1550
1551For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, 1731For examples, see the source of this module (F<perldoc -m
1552search for C<register_read_type>)). 1732AnyEvent::Handle>, search for C<register_read_type>)).
1553 1733
1554=item $handle->stop_read 1734=item $handle->stop_read
1555 1735
1556=item $handle->start_read 1736=item $handle->start_read
1557 1737
… …
1577} 1757}
1578 1758
1579sub start_read { 1759sub start_read {
1580 my ($self) = @_; 1760 my ($self) = @_;
1581 1761
1582 unless ($self->{_rw} || $self->{_eof}) { 1762 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1583 Scalar::Util::weaken $self; 1763 Scalar::Util::weaken $self;
1584 1764
1585 $self->{_rw} = AE::io $self->{fh}, 0, sub { 1765 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1586 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1766 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1587 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1767 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1588 1768
1589 if ($len > 0) { 1769 if ($len > 0) {
1590 $self->{_activity} = $self->{_ractivity} = AE::now; 1770 $self->{_activity} = $self->{_ractivity} = AE::now;
1591 1771
1592 if ($self->{tls}) { 1772 if ($self->{tls}) {
1593 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1773 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1594 1774
1595 &_dotls ($self); 1775 &_dotls ($self);
1596 } else { 1776 } else {
1597 $self->_drain_rbuf; 1777 $self->_drain_rbuf;
1778 }
1779
1780 if ($len == $self->{read_size}) {
1781 $self->{read_size} *= 2;
1782 $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
1783 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1598 } 1784 }
1599 1785
1600 } elsif (defined $len) { 1786 } elsif (defined $len) {
1601 delete $self->{_rw}; 1787 delete $self->{_rw};
1602 $self->{_eof} = 1; 1788 $self->{_eof} = 1;
… …
1680 && ($tmp != $ERROR_SYSCALL || $!); 1866 && ($tmp != $ERROR_SYSCALL || $!);
1681 1867
1682 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1868 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1683 $self->{wbuf} .= $tmp; 1869 $self->{wbuf} .= $tmp;
1684 $self->_drain_wbuf; 1870 $self->_drain_wbuf;
1871 $self->{tls} or return; # tls session might have gone away in callback
1685 } 1872 }
1686 1873
1687 $self->{_on_starttls} 1874 $self->{_on_starttls}
1688 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () 1875 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1689 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); 1876 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
… …
1711context in C<< $handle->{tls_ctx} >> after this call and can be used or 1898context in C<< $handle->{tls_ctx} >> after this call and can be used or
1712changed to your liking. Note that the handshake might have already started 1899changed to your liking. Note that the handshake might have already started
1713when this function returns. 1900when this function returns.
1714 1901
1715Due to bugs in OpenSSL, it might or might not be possible to do multiple 1902Due to bugs in OpenSSL, it might or might not be possible to do multiple
1716handshakes on the same stream. Best do not attempt to use the stream after 1903handshakes on the same stream. It is best to not attempt to use the
1717stopping TLS. 1904stream after stopping TLS.
1905
1906This method may invoke callbacks (and therefore the handle might be
1907destroyed after it returns).
1718 1908
1719=cut 1909=cut
1720 1910
1721our %TLS_CACHE; #TODO not yet documented, should we? 1911our %TLS_CACHE; #TODO not yet documented, should we?
1722 1912
… …
1734 require Net::SSLeay; 1924 require Net::SSLeay;
1735 1925
1736 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); 1926 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1737 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); 1927 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1738 1928
1739 $tls = $self->{tls}; 1929 $tls = delete $self->{tls};
1740 $ctx = $self->{tls_ctx}; 1930 $ctx = $self->{tls_ctx};
1741 1931
1742 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session 1932 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1743 1933
1744 if ("HASH" eq ref $ctx) { 1934 if ("HASH" eq ref $ctx) {
… …
1788 1978
1789=item $handle->stoptls 1979=item $handle->stoptls
1790 1980
1791Shuts down the SSL connection - this makes a proper EOF handshake by 1981Shuts down the SSL connection - this makes a proper EOF handshake by
1792sending a close notify to the other side, but since OpenSSL doesn't 1982sending a close notify to the other side, but since OpenSSL doesn't
1793support non-blocking shut downs, it is not guarenteed that you can re-use 1983support non-blocking shut downs, it is not guaranteed that you can re-use
1794the stream afterwards. 1984the stream afterwards.
1985
1986This method may invoke callbacks (and therefore the handle might be
1987destroyed after it returns).
1795 1988
1796=cut 1989=cut
1797 1990
1798sub stoptls { 1991sub stoptls {
1799 my ($self) = @_; 1992 my ($self) = @_;
1800 1993
1801 if ($self->{tls}) { 1994 if ($self->{tls} && $self->{fh}) {
1802 Net::SSLeay::shutdown ($self->{tls}); 1995 Net::SSLeay::shutdown ($self->{tls});
1803 1996
1804 &_dotls; 1997 &_dotls;
1805 1998
1806# # we don't give a shit. no, we do, but we can't. no...#d# 1999# # we don't give a shit. no, we do, but we can't. no...#d#
… …
1836 push @linger, AE::io $fh, 1, sub { 2029 push @linger, AE::io $fh, 1, sub {
1837 my $len = syswrite $fh, $wbuf, length $wbuf; 2030 my $len = syswrite $fh, $wbuf, length $wbuf;
1838 2031
1839 if ($len > 0) { 2032 if ($len > 0) {
1840 substr $wbuf, 0, $len, ""; 2033 substr $wbuf, 0, $len, "";
1841 } else { 2034 } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1842 @linger = (); # end 2035 @linger = (); # end
1843 } 2036 }
1844 }; 2037 };
1845 push @linger, AE::timer $linger, 0, sub { 2038 push @linger, AE::timer $linger, 0, sub {
1846 @linger = (); 2039 @linger = ();
… …
1883 2076
1884sub AnyEvent::Handle::destroyed::AUTOLOAD { 2077sub AnyEvent::Handle::destroyed::AUTOLOAD {
1885 #nop 2078 #nop
1886} 2079}
1887 2080
2081=item $handle->destroyed
2082
2083Returns false as long as the handle hasn't been destroyed by a call to C<<
2084->destroy >>, true otherwise.
2085
2086Can be useful to decide whether the handle is still valid after some
2087callback possibly destroyed the handle. For example, C<< ->push_write >>,
2088C<< ->starttls >> and other methods can call user callbacks, which in turn
2089can destroy the handle, so work can be avoided by checking sometimes:
2090
2091 $hdl->starttls ("accept");
2092 return if $hdl->destroyed;
2093 $hdl->push_write (...
2094
2095Note that the call to C<push_write> will silently be ignored if the handle
2096has been destroyed, so often you can just ignore the possibility of the
2097handle being destroyed.
2098
2099=cut
2100
2101sub destroyed { 0 }
2102sub AnyEvent::Handle::destroyed::destroyed { 1 }
2103
1888=item AnyEvent::Handle::TLS_CTX 2104=item AnyEvent::Handle::TLS_CTX
1889 2105
1890This function creates and returns the AnyEvent::TLS object used by default 2106This function creates and returns the AnyEvent::TLS object used by default
1891for TLS mode. 2107for TLS mode.
1892 2108
… …
1919 2135
1920It is only safe to "forget" the reference inside EOF or error callbacks, 2136It is only safe to "forget" the reference inside EOF or error callbacks,
1921from within all other callbacks, you need to explicitly call the C<< 2137from within all other callbacks, you need to explicitly call the C<<
1922->destroy >> method. 2138->destroy >> method.
1923 2139
2140=item Why is my C<on_eof> callback never called?
2141
2142Probably because your C<on_error> callback is being called instead: When
2143you have outstanding requests in your read queue, then an EOF is
2144considered an error as you clearly expected some data.
2145
2146To avoid this, make sure you have an empty read queue whenever your handle
2147is supposed to be "idle" (i.e. connection closes are O.K.). You cna set
2148an C<on_read> handler that simply pushes the first read requests in the
2149queue.
2150
2151See also the next question, which explains this in a bit more detail.
2152
2153=item How can I serve requests in a loop?
2154
2155Most protocols consist of some setup phase (authentication for example)
2156followed by a request handling phase, where the server waits for requests
2157and handles them, in a loop.
2158
2159There are two important variants: The first (traditional, better) variant
2160handles requests until the server gets some QUIT command, causing it to
2161close the connection first (highly desirable for a busy TCP server). A
2162client dropping the connection is an error, which means this variant can
2163detect an unexpected detection close.
2164
2165To handle this case, always make sure you have a on-empty read queue, by
2166pushing the "read request start" handler on it:
2167
2168 # we assume a request starts with a single line
2169 my @start_request; @start_request = (line => sub {
2170 my ($hdl, $line) = @_;
2171
2172 ... handle request
2173
2174 # push next request read, possibly from a nested callback
2175 $hdl->push_read (@start_request);
2176 });
2177
2178 # auth done, now go into request handling loop
2179 # now push the first @start_request
2180 $hdl->push_read (@start_request);
2181
2182By always having an outstanding C<push_read>, the handle always expects
2183some data and raises the C<EPIPE> error when the connction is dropped
2184unexpectedly.
2185
2186The second variant is a protocol where the client can drop the connection
2187at any time. For TCP, this means that the server machine may run out of
2188sockets easier, and in general, it means you cnanot distinguish a protocl
2189failure/client crash from a normal connection close. Nevertheless, these
2190kinds of protocols are common (and sometimes even the best solution to the
2191problem).
2192
2193Having an outstanding read request at all times is possible if you ignore
2194C<EPIPE> errors, but this doesn't help with when the client drops the
2195connection during a request, which would still be an error.
2196
2197A better solution is to push the initial request read in an C<on_read>
2198callback. This avoids an error, as when the server doesn't expect data
2199(i.e. is idly waiting for the next request, an EOF will not raise an
2200error, but simply result in an C<on_eof> callback. It is also a bit slower
2201and simpler:
2202
2203 # auth done, now go into request handling loop
2204 $hdl->on_read (sub {
2205 my ($hdl) = @_;
2206
2207 # called each time we receive data but the read queue is empty
2208 # simply start read the request
2209
2210 $hdl->push_read (line => sub {
2211 my ($hdl, $line) = @_;
2212
2213 ... handle request
2214
2215 # do nothing special when the request has been handled, just
2216 # let the request queue go empty.
2217 });
2218 });
2219
1924=item I get different callback invocations in TLS mode/Why can't I pause 2220=item I get different callback invocations in TLS mode/Why can't I pause
1925reading? 2221reading?
1926 2222
1927Unlike, say, TCP, TLS connections do not consist of two independent 2223Unlike, say, TCP, TLS connections do not consist of two independent
1928communication channels, one for each direction. Or put differently. The 2224communication channels, one for each direction. Or put differently, the
1929read and write directions are not independent of each other: you cannot 2225read and write directions are not independent of each other: you cannot
1930write data unless you are also prepared to read, and vice versa. 2226write data unless you are also prepared to read, and vice versa.
1931 2227
1932This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> 2228This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1933callback invocations when you are not expecting any read data - the reason 2229callback invocations when you are not expecting any read data - the reason
1934is that AnyEvent::Handle always reads in TLS mode. 2230is that AnyEvent::Handle always reads in TLS mode.
1935 2231
1936During the connection, you have to make sure that you always have a 2232During the connection, you have to make sure that you always have a
1937non-empty read-queue, or an C<on_read> watcher. At the end of the 2233non-empty read-queue, or an C<on_read> watcher. At the end of the
… …
1951 my $data = delete $_[0]{rbuf}; 2247 my $data = delete $_[0]{rbuf};
1952 }); 2248 });
1953 2249
1954The reason to use C<on_error> is that TCP connections, due to latencies 2250The reason to use C<on_error> is that TCP connections, due to latencies
1955and packets loss, might get closed quite violently with an error, when in 2251and packets loss, might get closed quite violently with an error, when in
1956fact, all data has been received. 2252fact all data has been received.
1957 2253
1958It is usually better to use acknowledgements when transferring data, 2254It is usually better to use acknowledgements when transferring data,
1959to make sure the other side hasn't just died and you got the data 2255to make sure the other side hasn't just died and you got the data
1960intact. This is also one reason why so many internet protocols have an 2256intact. This is also one reason why so many internet protocols have an
1961explicit QUIT command. 2257explicit QUIT command.
… …
1978consider using C<< ->push_shutdown >> instead. 2274consider using C<< ->push_shutdown >> instead.
1979 2275
1980=item I want to contact a TLS/SSL server, I don't care about security. 2276=item I want to contact a TLS/SSL server, I don't care about security.
1981 2277
1982If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, 2278If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1983simply connect to it and then create the AnyEvent::Handle with the C<tls> 2279connect to it and then create the AnyEvent::Handle with the C<tls>
1984parameter: 2280parameter:
1985 2281
1986 tcp_connect $host, $port, sub { 2282 tcp_connect $host, $port, sub {
1987 my ($fh) = @_; 2283 my ($fh) = @_;
1988 2284
… …
2088 2384
2089=item * all members not documented here and not prefixed with an underscore 2385=item * all members not documented here and not prefixed with an underscore
2090are free to use in subclasses. 2386are free to use in subclasses.
2091 2387
2092Of course, new versions of AnyEvent::Handle may introduce more "public" 2388Of course, new versions of AnyEvent::Handle may introduce more "public"
2093member variables, but thats just life, at least it is documented. 2389member variables, but that's just life. At least it is documented.
2094 2390
2095=back 2391=back
2096 2392
2097=head1 AUTHOR 2393=head1 AUTHOR
2098 2394

Diff Legend

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