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.172 by root, Wed Aug 5 20:50:27 2009 UTC vs.
Revision 1.214 by root, Sun Jan 16 17:12:27 2011 UTC

1package AnyEvent::Handle;
2
3use Scalar::Util ();
4use Carp ();
5use Errno qw(EAGAIN EINTR);
6
7use AnyEvent (); BEGIN { AnyEvent::common_sense }
8use AnyEvent::Util qw(WSAEWOULDBLOCK);
9
10=head1 NAME 1=head1 NAME
11 2
12AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent 3AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
13
14=cut
15
16our $VERSION = 4.901;
17 4
18=head1 SYNOPSIS 5=head1 SYNOPSIS
19 6
20 use AnyEvent; 7 use AnyEvent;
21 use AnyEvent::Handle; 8 use AnyEvent::Handle;
… …
27 on_error => sub { 14 on_error => sub {
28 my ($hdl, $fatal, $msg) = @_; 15 my ($hdl, $fatal, $msg) = @_;
29 warn "got error $msg\n"; 16 warn "got error $msg\n";
30 $hdl->destroy; 17 $hdl->destroy;
31 $cv->send; 18 $cv->send;
32 ); 19 };
33 20
34 # send some request line 21 # send some request line
35 $hdl->push_write ("getinfo\015\012"); 22 $hdl->push_write ("getinfo\015\012");
36 23
37 # read the response line 24 # read the response line
… …
43 30
44 $cv->recv; 31 $cv->recv;
45 32
46=head1 DESCRIPTION 33=head1 DESCRIPTION
47 34
48This 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
49filehandles. 36stream-based filehandles (sockets, pipes, and other stream things).
50 37
51The L<AnyEvent::Intro> tutorial contains some well-documented 38The L<AnyEvent::Intro> tutorial contains some well-documented
52AnyEvent::Handle examples. 39AnyEvent::Handle examples.
53 40
54In the following, when the documentation refers to of "bytes" then this 41In the following, where the documentation refers to "bytes", it means
55means characters. As sysread and syswrite are used for all I/O, their 42characters. As sysread and syswrite are used for all I/O, their
56treatment of characters applies to this module as well. 43treatment of characters applies to this module as well.
57 44
58At 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
59C<on_error> callback. 46C<on_error> callback.
60 47
61All callbacks will be invoked with the handle object as their first 48All callbacks will be invoked with the handle object as their first
62argument. 49argument.
63 50
51=cut
52
53package AnyEvent::Handle;
54
55use Scalar::Util ();
56use List::Util ();
57use Carp ();
58use Errno qw(EAGAIN EINTR);
59
60use AnyEvent (); BEGIN { AnyEvent::common_sense }
61use AnyEvent::Util qw(WSAEWOULDBLOCK);
62
63our $VERSION = $AnyEvent::VERSION;
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
64=head1 METHODS 82=head1 METHODS
65 83
66=over 4 84=over 4
67 85
68=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... 86=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69 87
70The constructor supports these arguments (all as C<< key => value >> pairs). 88The constructor supports these arguments (all as C<< key => value >> pairs).
71 89
72=over 4 90=over 4
73 91
… …
96=over 4 114=over 4
97 115
98=item on_prepare => $cb->($handle) 116=item on_prepare => $cb->($handle)
99 117
100This (rarely used) callback is called before a new connection is 118This (rarely used) callback is called before a new connection is
101attempted, but after the file handle has been created. It could be used to 119attempted, but after the file handle has been created (you can access that
120file handle via C<< $handle->{fh} >>). It could be used to prepare the
102prepare the file handle with parameters required for the actual connect 121file handle with parameters required for the actual connect (as opposed to
103(as opposed to settings that can be changed when the connection is already 122settings that can be changed when the connection is already established).
104established).
105 123
106The 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
107seconds (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
108timeout is to be used). 126default timeout is to be used).
109 127
110=item on_connect => $cb->($handle, $host, $port, $retry->()) 128=item on_connect => $cb->($handle, $host, $port, $retry->())
111 129
112This callback is called when a connection has been successfully established. 130This callback is called when a connection has been successfully established.
113 131
114The actual numeric host and port (the socket peername) are passed as 132The peer's numeric host and port (the socket peername) are passed as
115parameters, together with a retry callback. 133parameters, together with a retry callback.
116 134
117When, for some reason, the handle is not acceptable, then calling 135If, for some reason, the handle is not acceptable, calling C<$retry>
118C<$retry> will continue with the next conenction target (in case of 136will continue with the next connection target (in case of multi-homed
119multi-homed hosts or SRV records there can be multiple connection 137hosts or SRV records there can be multiple connection endpoints). At the
120endpoints). 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
121tls status and similar properties of the handle are being reset. 139similar properties of the handle will have been reset.
122 140
123In most cases, ignoring the C<$retry> parameter is the way to go. 141In most cases, you should ignore the C<$retry> parameter.
124 142
125=item on_connect_error => $cb->($handle, $message) 143=item on_connect_error => $cb->($handle, $message)
126 144
127This callback is called when the conenction could not be 145This callback is called when the connection could not be
128established. C<$!> will contain the relevant error code, and C<$message> a 146established. C<$!> will contain the relevant error code, and C<$message> a
129message describing it (usually the same as C<"$!">). 147message describing it (usually the same as C<"$!">).
130 148
131If 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
132fatal error instead. 150fatal error instead.
… …
135 153
136=item on_error => $cb->($handle, $fatal, $message) 154=item on_error => $cb->($handle, $fatal, $message)
137 155
138This is the error callback, which is called when, well, some error 156This is the error callback, which is called when, well, some error
139occured, such as not being able to resolve the hostname, failure to 157occured, such as not being able to resolve the hostname, failure to
140connect or a read error. 158connect, or a read error.
141 159
142Some 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
143fatal 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<< ->
144destroy >>) after invoking the error callback (which means you are free to 162destroy >>) after invoking the error callback (which means you are free to
145examine the handle object). Examples of fatal errors are an EOF condition 163examine the handle object). Examples of fatal errors are an EOF condition
146with 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
147cases 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
148often easiest to not report C<EPIPE> errors in this callback. 166often easiest to not report C<EPIPE> errors in this callback.
149 167
150AnyEvent::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
151against, 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
152recommended to always output the C<$message> argument in human-readable 170recommended to always output the C<$message> argument in human-readable
153error messages (it's usually the same as C<"$!">). 171error messages (it's usually the same as C<"$!">).
154 172
155Non-fatal errors can be retried by simply returning, but it is recommended 173Non-fatal errors can be retried by returning, but it is recommended
156to simply ignore this parameter and instead abondon the handle object 174to simply ignore this parameter and instead abondon the handle object
157when this callback is invoked. Examples of non-fatal errors are timeouts 175when this callback is invoked. Examples of non-fatal errors are timeouts
158C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 176C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
159 177
160On callback entrance, the value of C<$!> contains the operating system 178On entry to the callback, the value of C<$!> contains the operating
161error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or 179system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
162C<EPROTO>). 180C<EPROTO>).
163 181
164While 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
165you will not be notified of errors otherwise. The default simply calls 183you will not be notified of errors otherwise. The default just calls
166C<croak>. 184C<croak>.
167 185
168=item on_read => $cb->($handle) 186=item on_read => $cb->($handle)
169 187
170This sets the default read callback, which is called when data arrives 188This sets the default read callback, which is called when data arrives
… …
175To 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 >>
176method or access the C<< $handle->{rbuf} >> member directly. Note that you 194method or access the C<< $handle->{rbuf} >> member directly. Note that you
177must 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
178the beginning from it. 196the beginning from it.
179 197
198You can also call C<< ->push_read (...) >> or any other function that
199modifies the read queue. Or do both. Or ...
200
180When an EOF condition is detected then AnyEvent::Handle will first try to 201When an EOF condition is detected, AnyEvent::Handle will first try to
181feed 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
182calling 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
183error will be raised (with C<$!> set to C<EPIPE>). 204error will be raised (with C<$!> set to C<EPIPE>).
184 205
185Note 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
… …
204set, 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>.
205 226
206=item on_drain => $cb->($handle) 227=item on_drain => $cb->($handle)
207 228
208This 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
209(or when the callback is set and the buffer is empty already). 230(or immediately if the buffer is empty already).
210 231
211To append to the write buffer, use the C<< ->push_write >> method. 232To append to the write buffer, use the C<< ->push_write >> method.
212 233
213This 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
214into 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
… …
216memory and push it into the queue, but instead only read more data from 237memory and push it into the queue, but instead only read more data from
217the file when the write queue becomes empty. 238the file when the write queue becomes empty.
218 239
219=item timeout => $fractional_seconds 240=item timeout => $fractional_seconds
220 241
242=item rtimeout => $fractional_seconds
243
244=item wtimeout => $fractional_seconds
245
221If non-zero, then this enables an "inactivity" timeout: whenever this many 246If non-zero, then these enables an "inactivity" timeout: whenever this
222seconds pass without a successful read or write on the underlying file 247many seconds pass without a successful read or write on the underlying
223handle, the C<on_timeout> callback will be invoked (and if that one is 248file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
224missing, a non-fatal C<ETIMEDOUT> error will be raised). 249will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
250error will be raised).
225 251
252There are three variants of the timeouts that work independently
253of each other, for both read and write, just read, and just write:
254C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
255C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
256C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
257
226Note that timeout processing is also active when you currently do not have 258Note that timeout processing is active even when you do not have
227any 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
228idle then you should disable the timout temporarily or ignore the timeout 260idle then you should disable the timeout temporarily or ignore the timeout
229in 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
230restart the timeout. 262restart the timeout.
231 263
232Zero (the default) disables this timeout. 264Zero (the default) disables this timeout.
233 265
… …
247be configured to accept only so-and-so much data that it cannot act on 279be configured to accept only so-and-so much data that it cannot act on
248(for example, when expecting a line, an attacker could send an unlimited 280(for example, when expecting a line, an attacker could send an unlimited
249amount 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
250isn't finished). 282isn't finished).
251 283
284=item wbuf_max => <bytes>
285
286If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
287when the write buffer ever (strictly) exceeds this size. This is useful to
288avoid some forms of denial-of-service attacks.
289
290Although the units of this parameter is bytes, this is the I<raw> number
291of bytes not yet accepted by the kernel. This can make a difference when
292you e.g. use TLS, as TLS typically makes your write data larger (but it
293can also make it smaller due to compression).
294
295As an example of when this limit is useful, take a chat server that sends
296chat messages to a client. If the client does not read those in a timely
297manner then the send buffer in the server would grow unbounded.
298
252=item autocork => <boolean> 299=item autocork => <boolean>
253 300
254When disabled (the default), then C<push_write> will try to immediately 301When disabled (the default), C<push_write> will try to immediately
255write the data to the handle, if possible. This avoids having to register 302write the data to the handle if possible. This avoids having to register
256a write watcher and wait for the next event loop iteration, but can 303a write watcher and wait for the next event loop iteration, but can
257be inefficient if you write multiple small chunks (on the wire, this 304be inefficient if you write multiple small chunks (on the wire, this
258disadvantage is usually avoided by your kernel's nagle algorithm, see 305disadvantage is usually avoided by your kernel's nagle algorithm, see
259C<no_delay>, but this option can save costly syscalls). 306C<no_delay>, but this option can save costly syscalls).
260 307
261When enabled, then writes will always be queued till the next event loop 308When enabled, writes will always be queued till the next event loop
262iteration. This is efficient when you do many small writes per iteration, 309iteration. This is efficient when you do many small writes per iteration,
263but less efficient when you do a single write only per iteration (or when 310but less efficient when you do a single write only per iteration (or when
264the write buffer often is full). It also increases write latency. 311the write buffer often is full). It also increases write latency.
265 312
266=item no_delay => <boolean> 313=item no_delay => <boolean>
… …
270the Nagle algorithm, and usually it is beneficial. 317the Nagle algorithm, and usually it is beneficial.
271 318
272In some situations you want as low a delay as possible, which can be 319In some situations you want as low a delay as possible, which can be
273accomplishd by setting this option to a true value. 320accomplishd by setting this option to a true value.
274 321
275The default is your opertaing system's default behaviour (most likely 322The default is your operating system's default behaviour (most likely
276enabled), this option explicitly enables or disables it, if possible. 323enabled). This option explicitly enables or disables it, if possible.
324
325=item keepalive => <boolean>
326
327Enables (default disable) the SO_KEEPALIVE option on the stream socket:
328normally, TCP connections have no time-out once established, so TCP
329connections, once established, can stay alive forever even when the other
330side has long gone. TCP keepalives are a cheap way to take down long-lived
331TCP connections when the other side becomes unreachable. While the default
332is OS-dependent, TCP keepalives usually kick in after around two hours,
333and, if the other side doesn't reply, take down the TCP connection some 10
334to 15 minutes later.
335
336It is harmless to specify this option for file handles that do not support
337keepalives, and enabling it on connections that are potentially long-lived
338is usually a good idea.
339
340=item oobinline => <boolean>
341
342BSD majorly fucked up the implementation of TCP urgent data. The result
343is that almost no OS implements TCP according to the specs, and every OS
344implements it slightly differently.
345
346If you want to handle TCP urgent data, then setting this flag (the default
347is enabled) gives you the most portable way of getting urgent data, by
348putting it into the stream.
349
350Since BSD emulation of OOB data on top of TCP's urgent data can have
351security implications, AnyEvent::Handle sets this flag automatically
352unless explicitly specified. Note that setting this flag after
353establishing a connection I<may> be a bit too late (data loss could
354already have occured on BSD systems), but at least it will protect you
355from most attacks.
277 356
278=item read_size => <bytes> 357=item read_size => <bytes>
279 358
280The default read block size (the amount of bytes this module will 359The initial read block size, the number of bytes this module will try to
281try to read during each loop iteration, which affects memory 360read during each loop iteration. Each handle object will consume at least
282requirements). Default: C<8192>. 361this amount of memory for the read buffer as well, so when handling many
362connections requirements). See also C<max_read_size>. Default: C<2048>.
363
364=item max_read_size => <bytes>
365
366The maximum read buffer size used by the dynamic adjustment
367algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
368one go it will double C<read_size> up to the maximum given by this
369option. Default: C<131072> or C<read_size>, whichever is higher.
283 370
284=item low_water_mark => <bytes> 371=item low_water_mark => <bytes>
285 372
286Sets the amount of bytes (default: C<0>) that make up an "empty" write 373Sets the number of bytes (default: C<0>) that make up an "empty" write
287buffer: If the write reaches this size or gets even samller it is 374buffer: If the buffer reaches this size or gets even samller it is
288considered empty. 375considered empty.
289 376
290Sometimes it can be beneficial (for performance reasons) to add data to 377Sometimes it can be beneficial (for performance reasons) to add data to
291the write buffer before it is fully drained, but this is a rare case, as 378the write buffer before it is fully drained, but this is a rare case, as
292the operating system kernel usually buffers data as well, so the default 379the operating system kernel usually buffers data as well, so the default
293is good in almost all cases. 380is good in almost all cases.
294 381
295=item linger => <seconds> 382=item linger => <seconds>
296 383
297If non-zero (default: C<3600>), then the destructor of the 384If this is non-zero (default: C<3600>), the destructor of the
298AnyEvent::Handle object will check whether there is still outstanding 385AnyEvent::Handle object will check whether there is still outstanding
299write data and will install a watcher that will write this data to the 386write data and will install a watcher that will write this data to the
300socket. No errors will be reported (this mostly matches how the operating 387socket. No errors will be reported (this mostly matches how the operating
301system treats outstanding data at socket close time). 388system treats outstanding data at socket close time).
302 389
… …
309A string used to identify the remote site - usually the DNS hostname 396A string used to identify the remote site - usually the DNS hostname
310(I<not> IDN!) used to create the connection, rarely the IP address. 397(I<not> IDN!) used to create the connection, rarely the IP address.
311 398
312Apart from being useful in error messages, this string is also used in TLS 399Apart from being useful in error messages, this string is also used in TLS
313peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This 400peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
314verification will be skipped when C<peername> is not specified or 401verification will be skipped when C<peername> is not specified or is
315C<undef>. 402C<undef>.
316 403
317=item tls => "accept" | "connect" | Net::SSLeay::SSL object 404=item tls => "accept" | "connect" | Net::SSLeay::SSL object
318 405
319When this parameter is given, it enables TLS (SSL) mode, that means 406When this parameter is given, it enables TLS (SSL) mode, that means
320AnyEvent will start a TLS handshake as soon as the conenction has been 407AnyEvent will start a TLS handshake as soon as the connection has been
321established and will transparently encrypt/decrypt data afterwards. 408established and will transparently encrypt/decrypt data afterwards.
322 409
323All TLS protocol errors will be signalled as C<EPROTO>, with an 410All TLS protocol errors will be signalled as C<EPROTO>, with an
324appropriate error message. 411appropriate error message.
325 412
… …
345B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 432B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
346passing in the wrong integer will lead to certain crash. This most often 433passing in the wrong integer will lead to certain crash. This most often
347happens when one uses a stylish C<< tls => 1 >> and is surprised about the 434happens when one uses a stylish C<< tls => 1 >> and is surprised about the
348segmentation fault. 435segmentation fault.
349 436
350See the C<< ->starttls >> method for when need to start TLS negotiation later. 437Use the C<< ->starttls >> method if you need to start TLS negotiation later.
351 438
352=item tls_ctx => $anyevent_tls 439=item tls_ctx => $anyevent_tls
353 440
354Use the given C<AnyEvent::TLS> object to create the new TLS connection 441Use the given C<AnyEvent::TLS> object to create the new TLS connection
355(unless a connection object was specified directly). If this parameter is 442(unless a connection object was specified directly). If this
356missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 443parameter is missing (or C<undef>), then AnyEvent::Handle will use
444C<AnyEvent::Handle::TLS_CTX>.
357 445
358Instead of an object, you can also specify a hash reference with C<< key 446Instead of an object, you can also specify a hash reference with C<< key
359=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a 447=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
360new TLS context object. 448new TLS context object.
361 449
… …
370 458
371TLS handshake failures will not cause C<on_error> to be invoked when this 459TLS handshake failures will not cause C<on_error> to be invoked when this
372callback is in effect, instead, the error message will be passed to C<on_starttls>. 460callback is in effect, instead, the error message will be passed to C<on_starttls>.
373 461
374Without this callback, handshake failures lead to C<on_error> being 462Without this callback, handshake failures lead to C<on_error> being
375called, as normal. 463called as usual.
376 464
377Note that you cannot call C<starttls> right again in this callback. If you 465Note that you cannot just call C<starttls> again in this callback. If you
378need to do that, start an zero-second timer instead whose callback can 466need to do that, start an zero-second timer instead whose callback can
379then call C<< ->starttls >> again. 467then call C<< ->starttls >> again.
380 468
381=item on_stoptls => $cb->($handle) 469=item on_stoptls => $cb->($handle)
382 470
… …
430 $self->{connect}[0], 518 $self->{connect}[0],
431 $self->{connect}[1], 519 $self->{connect}[1],
432 sub { 520 sub {
433 my ($fh, $host, $port, $retry) = @_; 521 my ($fh, $host, $port, $retry) = @_;
434 522
523 delete $self->{_connect}; # no longer needed
524
435 if ($fh) { 525 if ($fh) {
436 $self->{fh} = $fh; 526 $self->{fh} = $fh;
437 527
438 delete $self->{_skip_drain_rbuf}; 528 delete $self->{_skip_drain_rbuf};
439 $self->_start; 529 $self->_start;
440 530
441 $self->{on_connect} 531 $self->{on_connect}
442 and $self->{on_connect}($self, $host, $port, sub { 532 and $self->{on_connect}($self, $host, $port, sub {
443 delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)}; 533 delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
444 $self->{_skip_drain_rbuf} = 1; 534 $self->{_skip_drain_rbuf} = 1;
445 &$retry; 535 &$retry;
446 }); 536 });
447 537
448 } else { 538 } else {
… …
456 }, 546 },
457 sub { 547 sub {
458 local $self->{fh} = $_[0]; 548 local $self->{fh} = $_[0];
459 549
460 $self->{on_prepare} 550 $self->{on_prepare}
461 ? $self->{on_prepare}->($self) 551 ? $self->{on_prepare}->($self)
462 : () 552 : ()
463 } 553 }
464 ); 554 );
465 } 555 }
466 556
… …
472} 562}
473 563
474sub _start { 564sub _start {
475 my ($self) = @_; 565 my ($self) = @_;
476 566
567 # too many clueless people try to use udp and similar sockets
568 # with AnyEvent::Handle, do them a favour.
569 my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
570 Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
571 if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
572
477 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 573 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
478 574
575 $self->{_activity} =
576 $self->{_ractivity} =
479 $self->{_activity} = AnyEvent->now; 577 $self->{_wactivity} = AE::now;
480 $self->_timeout;
481 578
579 $self->{read_size} ||= 2048;
580 $self->{max_read_size} = $self->{read_size}
581 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
582
583 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
584 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
585 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
586
482 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; 587 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
588 $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
483 589
590 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
591
484 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 592 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
485 if $self->{tls}; 593 if $self->{tls};
486 594
487 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 595 $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
488 596
489 $self->start_read 597 $self->start_read
490 if $self->{on_read} || @{ $self->{_queue} }; 598 if $self->{on_read} || @{ $self->{_queue} };
491 599
492 $self->_drain_wbuf; 600 $self->_drain_wbuf;
493} 601}
494
495#sub _shutdown {
496# my ($self) = @_;
497#
498# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
499# $self->{_eof} = 1; # tell starttls et. al to stop trying
500#
501# &_freetls;
502#}
503 602
504sub _error { 603sub _error {
505 my ($self, $errno, $fatal, $message) = @_; 604 my ($self, $errno, $fatal, $message) = @_;
506 605
507 $! = $errno; 606 $! = $errno;
508 $message ||= "$!"; 607 $message ||= "$!";
509 608
510 if ($self->{on_error}) { 609 if ($self->{on_error}) {
511 $self->{on_error}($self, $fatal, $message); 610 $self->{on_error}($self, $fatal, $message);
512 $self->destroy if $fatal; 611 $self->destroy if $fatal;
513 } elsif ($self->{fh}) { 612 } elsif ($self->{fh} || $self->{connect}) {
514 $self->destroy; 613 $self->destroy;
515 Carp::croak "AnyEvent::Handle uncaught error: $message"; 614 Carp::croak "AnyEvent::Handle uncaught error: $message";
516 } 615 }
517} 616}
518 617
… …
544 $_[0]{on_eof} = $_[1]; 643 $_[0]{on_eof} = $_[1];
545} 644}
546 645
547=item $handle->on_timeout ($cb) 646=item $handle->on_timeout ($cb)
548 647
549Replace the current C<on_timeout> callback, or disables the callback (but 648=item $handle->on_rtimeout ($cb)
550not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
551argument and method.
552 649
553=cut 650=item $handle->on_wtimeout ($cb)
554 651
555sub on_timeout { 652Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
556 $_[0]{on_timeout} = $_[1]; 653callback, or disables the callback (but not the timeout) if C<$cb> =
557} 654C<undef>. See the C<timeout> constructor argument and method.
655
656=cut
657
658# see below
558 659
559=item $handle->autocork ($boolean) 660=item $handle->autocork ($boolean)
560 661
561Enables or disables the current autocork behaviour (see C<autocork> 662Enables or disables the current autocork behaviour (see C<autocork>
562constructor argument). Changes will only take effect on the next write. 663constructor argument). Changes will only take effect on the next write.
… …
575=cut 676=cut
576 677
577sub no_delay { 678sub no_delay {
578 $_[0]{no_delay} = $_[1]; 679 $_[0]{no_delay} = $_[1];
579 680
681 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
682 if $_[0]{fh};
683}
684
685=item $handle->keepalive ($boolean)
686
687Enables or disables the C<keepalive> setting (see constructor argument of
688the same name for details).
689
690=cut
691
692sub keepalive {
693 $_[0]{keepalive} = $_[1];
694
580 eval { 695 eval {
581 local $SIG{__DIE__}; 696 local $SIG{__DIE__};
582 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1] 697 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
583 if $_[0]{fh}; 698 if $_[0]{fh};
584 }; 699 };
585} 700}
586 701
702=item $handle->oobinline ($boolean)
703
704Enables or disables the C<oobinline> setting (see constructor argument of
705the same name for details).
706
707=cut
708
709sub oobinline {
710 $_[0]{oobinline} = $_[1];
711
712 eval {
713 local $SIG{__DIE__};
714 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
715 if $_[0]{fh};
716 };
717}
718
719=item $handle->keepalive ($boolean)
720
721Enables or disables the C<keepalive> setting (see constructor argument of
722the same name for details).
723
724=cut
725
726sub keepalive {
727 $_[0]{keepalive} = $_[1];
728
729 eval {
730 local $SIG{__DIE__};
731 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
732 if $_[0]{fh};
733 };
734}
735
587=item $handle->on_starttls ($cb) 736=item $handle->on_starttls ($cb)
588 737
589Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). 738Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
590 739
591=cut 740=cut
… …
598 747
599Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). 748Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
600 749
601=cut 750=cut
602 751
603sub on_starttls { 752sub on_stoptls {
604 $_[0]{on_stoptls} = $_[1]; 753 $_[0]{on_stoptls} = $_[1];
605} 754}
606 755
607=item $handle->rbuf_max ($max_octets) 756=item $handle->rbuf_max ($max_octets)
608 757
609Configures the C<rbuf_max> setting (C<undef> disables it). 758Configures the C<rbuf_max> setting (C<undef> disables it).
759
760=item $handle->wbuf_max ($max_octets)
761
762Configures the C<wbuf_max> setting (C<undef> disables it).
610 763
611=cut 764=cut
612 765
613sub rbuf_max { 766sub rbuf_max {
614 $_[0]{rbuf_max} = $_[1]; 767 $_[0]{rbuf_max} = $_[1];
615} 768}
616 769
770sub rbuf_max {
771 $_[0]{wbuf_max} = $_[1];
772}
773
617############################################################################# 774#############################################################################
618 775
619=item $handle->timeout ($seconds) 776=item $handle->timeout ($seconds)
620 777
778=item $handle->rtimeout ($seconds)
779
780=item $handle->wtimeout ($seconds)
781
621Configures (or disables) the inactivity timeout. 782Configures (or disables) the inactivity timeout.
622 783
623=cut 784=item $handle->timeout_reset
624 785
625sub timeout { 786=item $handle->rtimeout_reset
787
788=item $handle->wtimeout_reset
789
790Reset the activity timeout, as if data was received or sent.
791
792These methods are cheap to call.
793
794=cut
795
796for my $dir ("", "r", "w") {
797 my $timeout = "${dir}timeout";
798 my $tw = "_${dir}tw";
799 my $on_timeout = "on_${dir}timeout";
800 my $activity = "_${dir}activity";
801 my $cb;
802
803 *$on_timeout = sub {
804 $_[0]{$on_timeout} = $_[1];
805 };
806
807 *$timeout = sub {
626 my ($self, $timeout) = @_; 808 my ($self, $new_value) = @_;
627 809
810 $new_value >= 0
811 or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
812
628 $self->{timeout} = $timeout; 813 $self->{$timeout} = $new_value;
629 $self->_timeout; 814 delete $self->{$tw}; &$cb;
630} 815 };
631 816
817 *{"${dir}timeout_reset"} = sub {
818 $_[0]{$activity} = AE::now;
819 };
820
821 # main workhorse:
632# reset the timeout watcher, as neccessary 822 # reset the timeout watcher, as neccessary
633# also check for time-outs 823 # also check for time-outs
634sub _timeout { 824 $cb = sub {
635 my ($self) = @_; 825 my ($self) = @_;
636 826
637 if ($self->{timeout} && $self->{fh}) { 827 if ($self->{$timeout} && $self->{fh}) {
638 my $NOW = AnyEvent->now; 828 my $NOW = AE::now;
639 829
640 # when would the timeout trigger? 830 # when would the timeout trigger?
641 my $after = $self->{_activity} + $self->{timeout} - $NOW; 831 my $after = $self->{$activity} + $self->{$timeout} - $NOW;
642 832
643 # now or in the past already? 833 # now or in the past already?
644 if ($after <= 0) { 834 if ($after <= 0) {
645 $self->{_activity} = $NOW; 835 $self->{$activity} = $NOW;
646 836
647 if ($self->{on_timeout}) { 837 if ($self->{$on_timeout}) {
648 $self->{on_timeout}($self); 838 $self->{$on_timeout}($self);
649 } else { 839 } else {
650 $self->_error (Errno::ETIMEDOUT); 840 $self->_error (Errno::ETIMEDOUT);
841 }
842
843 # callback could have changed timeout value, optimise
844 return unless $self->{$timeout};
845
846 # calculate new after
847 $after = $self->{$timeout};
651 } 848 }
652 849
653 # callback could have changed timeout value, optimise 850 Scalar::Util::weaken $self;
654 return unless $self->{timeout}; 851 return unless $self; # ->error could have destroyed $self
655 852
656 # calculate new after 853 $self->{$tw} ||= AE::timer $after, 0, sub {
657 $after = $self->{timeout}; 854 delete $self->{$tw};
855 $cb->($self);
856 };
857 } else {
858 delete $self->{$tw};
658 } 859 }
659
660 Scalar::Util::weaken $self;
661 return unless $self; # ->error could have destroyed $self
662
663 $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
664 delete $self->{_tw};
665 $self->_timeout;
666 });
667 } else {
668 delete $self->{_tw};
669 } 860 }
670} 861}
671 862
672############################################################################# 863#############################################################################
673 864
… …
689=item $handle->on_drain ($cb) 880=item $handle->on_drain ($cb)
690 881
691Sets the C<on_drain> callback or clears it (see the description of 882Sets the C<on_drain> callback or clears it (see the description of
692C<on_drain> in the constructor). 883C<on_drain> in the constructor).
693 884
885This method may invoke callbacks (and therefore the handle might be
886destroyed after it returns).
887
694=cut 888=cut
695 889
696sub on_drain { 890sub on_drain {
697 my ($self, $cb) = @_; 891 my ($self, $cb) = @_;
698 892
… …
702 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); 896 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
703} 897}
704 898
705=item $handle->push_write ($data) 899=item $handle->push_write ($data)
706 900
707Queues the given scalar to be written. You can push as much data as you 901Queues the given scalar to be written. You can push as much data as
708want (only limited by the available memory), as C<AnyEvent::Handle> 902you want (only limited by the available memory and C<wbuf_max>), as
709buffers it independently of the kernel. 903C<AnyEvent::Handle> buffers it independently of the kernel.
904
905This method may invoke callbacks (and therefore the handle might be
906destroyed after it returns).
710 907
711=cut 908=cut
712 909
713sub _drain_wbuf { 910sub _drain_wbuf {
714 my ($self) = @_; 911 my ($self) = @_;
… …
721 my $len = syswrite $self->{fh}, $self->{wbuf}; 918 my $len = syswrite $self->{fh}, $self->{wbuf};
722 919
723 if (defined $len) { 920 if (defined $len) {
724 substr $self->{wbuf}, 0, $len, ""; 921 substr $self->{wbuf}, 0, $len, "";
725 922
726 $self->{_activity} = AnyEvent->now; 923 $self->{_activity} = $self->{_wactivity} = AE::now;
727 924
728 $self->{on_drain}($self) 925 $self->{on_drain}($self)
729 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) 926 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
730 && $self->{on_drain}; 927 && $self->{on_drain};
731 928
… …
737 934
738 # try to write data immediately 935 # try to write data immediately
739 $cb->() unless $self->{autocork}; 936 $cb->() unless $self->{autocork};
740 937
741 # if still data left in wbuf, we need to poll 938 # if still data left in wbuf, we need to poll
742 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) 939 $self->{_ww} = AE::io $self->{fh}, 1, $cb
743 if length $self->{wbuf}; 940 if length $self->{wbuf};
941
942 if (
943 defined $self->{wbuf_max}
944 && $self->{wbuf_max} < length $self->{wbuf}
945 ) {
946 $self->_error (Errno::ENOSPC, 1), return;
947 }
744 }; 948 };
745} 949}
746 950
747our %WH; 951our %WH;
748 952
953# deprecated
749sub register_write_type($$) { 954sub register_write_type($$) {
750 $WH{$_[0]} = $_[1]; 955 $WH{$_[0]} = $_[1];
751} 956}
752 957
753sub push_write { 958sub push_write {
754 my $self = shift; 959 my $self = shift;
755 960
756 if (@_ > 1) { 961 if (@_ > 1) {
757 my $type = shift; 962 my $type = shift;
758 963
964 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
759 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") 965 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
760 ->($self, @_); 966 ->($self, @_);
761 } 967 }
762 968
969 # we downgrade here to avoid hard-to-track-down bugs,
970 # and diagnose the problem earlier and better.
971
763 if ($self->{tls}) { 972 if ($self->{tls}) {
764 $self->{_tls_wbuf} .= $_[0]; 973 utf8::downgrade $self->{_tls_wbuf} .= $_[0];
765 &_dotls ($self) if $self->{fh}; 974 &_dotls ($self) if $self->{fh};
766 } else { 975 } else {
767 $self->{wbuf} .= $_[0]; 976 utf8::downgrade $self->{wbuf} .= $_[0];
768 $self->_drain_wbuf if $self->{fh}; 977 $self->_drain_wbuf if $self->{fh};
769 } 978 }
770} 979}
771 980
772=item $handle->push_write (type => @args) 981=item $handle->push_write (type => @args)
773 982
774Instead of formatting your data yourself, you can also let this module do 983Instead of formatting your data yourself, you can also let this module
775the job by specifying a type and type-specific arguments. 984do the job by specifying a type and type-specific arguments. You
985can also specify the (fully qualified) name of a package, in which
986case AnyEvent tries to load the package and then expects to find the
987C<anyevent_write_type> function inside (see "custom write types", below).
776 988
777Predefined types are (if you have ideas for additional types, feel free to 989Predefined types are (if you have ideas for additional types, feel free to
778drop by and tell us): 990drop by and tell us):
779 991
780=over 4 992=over 4
… …
837Other languages could read single lines terminated by a newline and pass 1049Other languages could read single lines terminated by a newline and pass
838this line into their JSON decoder of choice. 1050this line into their JSON decoder of choice.
839 1051
840=cut 1052=cut
841 1053
1054sub json_coder() {
1055 eval { require JSON::XS; JSON::XS->new->utf8 }
1056 || do { require JSON; JSON->new->utf8 }
1057}
1058
842register_write_type json => sub { 1059register_write_type json => sub {
843 my ($self, $ref) = @_; 1060 my ($self, $ref) = @_;
844 1061
845 require JSON; 1062 my $json = $self->{json} ||= json_coder;
846 1063
847 $self->{json} ? $self->{json}->encode ($ref) 1064 $json->encode ($ref)
848 : JSON::encode_json ($ref)
849}; 1065};
850 1066
851=item storable => $reference 1067=item storable => $reference
852 1068
853Freezes the given reference using L<Storable> and writes it to the 1069Freezes the given reference using L<Storable> and writes it to the
… …
871before it was actually written. One way to do that is to replace your 1087before it was actually written. One way to do that is to replace your
872C<on_drain> handler by a callback that shuts down the socket (and set 1088C<on_drain> handler by a callback that shuts down the socket (and set
873C<low_water_mark> to C<0>). This method is a shorthand for just that, and 1089C<low_water_mark> to C<0>). This method is a shorthand for just that, and
874replaces the C<on_drain> callback with: 1090replaces the C<on_drain> callback with:
875 1091
876 sub { shutdown $_[0]{fh}, 1 } # for push_shutdown 1092 sub { shutdown $_[0]{fh}, 1 }
877 1093
878This simply shuts down the write side and signals an EOF condition to the 1094This simply shuts down the write side and signals an EOF condition to the
879the peer. 1095the peer.
880 1096
881You can rely on the normal read queue and C<on_eof> handling 1097You can rely on the normal read queue and C<on_eof> handling
882afterwards. This is the cleanest way to close a connection. 1098afterwards. This is the cleanest way to close a connection.
883 1099
1100This method may invoke callbacks (and therefore the handle might be
1101destroyed after it returns).
1102
884=cut 1103=cut
885 1104
886sub push_shutdown { 1105sub push_shutdown {
887 my ($self) = @_; 1106 my ($self) = @_;
888 1107
889 delete $self->{low_water_mark}; 1108 delete $self->{low_water_mark};
890 $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); 1109 $self->on_drain (sub { shutdown $_[0]{fh}, 1 });
891} 1110}
892 1111
893=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 1112=item custom write types - Package::anyevent_write_type $handle, @args
894 1113
895This function (not method) lets you add your own types to C<push_write>. 1114Instead of one of the predefined types, you can also specify the name of
1115a package. AnyEvent will try to load the package and then expects to find
1116a function named C<anyevent_write_type> inside. If it isn't found, it
1117progressively tries to load the parent package until it either finds the
1118function (good) or runs out of packages (bad).
1119
896Whenever the given C<type> is used, C<push_write> will invoke the code 1120Whenever the given C<type> is used, C<push_write> will the function with
897reference with the handle object and the remaining arguments. 1121the handle object and the remaining arguments.
898 1122
899The code reference is supposed to return a single octet string that will 1123The function is supposed to return a single octet string that will be
900be appended to the write buffer. 1124appended to the write buffer, so you cna mentally treat this function as a
1125"arguments to on-the-wire-format" converter.
901 1126
902Note that this is a function, and all types registered this way will be 1127Example: implement a custom write type C<join> that joins the remaining
903global, so try to use unique names. 1128arguments using the first one.
1129
1130 $handle->push_write (My::Type => " ", 1,2,3);
1131
1132 # uses the following package, which can be defined in the "My::Type" or in
1133 # the "My" modules to be auto-loaded, or just about anywhere when the
1134 # My::Type::anyevent_write_type is defined before invoking it.
1135
1136 package My::Type;
1137
1138 sub anyevent_write_type {
1139 my ($handle, $delim, @args) = @_;
1140
1141 join $delim, @args
1142 }
904 1143
905=cut 1144=cut
906 1145
907############################################################################# 1146#############################################################################
908 1147
… …
917ways, the "simple" way, using only C<on_read> and the "complex" way, using 1156ways, the "simple" way, using only C<on_read> and the "complex" way, using
918a queue. 1157a queue.
919 1158
920In the simple case, you just install an C<on_read> callback and whenever 1159In the simple case, you just install an C<on_read> callback and whenever
921new data arrives, it will be called. You can then remove some data (if 1160new data arrives, it will be called. You can then remove some data (if
922enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna 1161enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
923leave the data there if you want to accumulate more (e.g. when only a 1162leave the data there if you want to accumulate more (e.g. when only a
924partial message has been received so far). 1163partial message has been received so far), or change the read queue with
1164e.g. C<push_read>.
925 1165
926In the more complex case, you want to queue multiple callbacks. In this 1166In the more complex case, you want to queue multiple callbacks. In this
927case, AnyEvent::Handle will call the first queued callback each time new 1167case, AnyEvent::Handle will call the first queued callback each time new
928data arrives (also the first time it is queued) and removes it when it has 1168data arrives (also the first time it is queued) and remove it when it has
929done its job (see C<push_read>, below). 1169done its job (see C<push_read>, below).
930 1170
931This way you can, for example, push three line-reads, followed by reading 1171This way you can, for example, push three line-reads, followed by reading
932a chunk of data, and AnyEvent::Handle will execute them in order. 1172a chunk of data, and AnyEvent::Handle will execute them in order.
933 1173
… …
1064 1304
1065This replaces the currently set C<on_read> callback, or clears it (when 1305This replaces the currently set C<on_read> callback, or clears it (when
1066the new callback is C<undef>). See the description of C<on_read> in the 1306the new callback is C<undef>). See the description of C<on_read> in the
1067constructor. 1307constructor.
1068 1308
1309This method may invoke callbacks (and therefore the handle might be
1310destroyed after it returns).
1311
1069=cut 1312=cut
1070 1313
1071sub on_read { 1314sub on_read {
1072 my ($self, $cb) = @_; 1315 my ($self, $cb) = @_;
1073 1316
… …
1075 $self->_drain_rbuf if $cb; 1318 $self->_drain_rbuf if $cb;
1076} 1319}
1077 1320
1078=item $handle->rbuf 1321=item $handle->rbuf
1079 1322
1080Returns the read buffer (as a modifiable lvalue). 1323Returns the read buffer (as a modifiable lvalue). You can also access the
1324read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
1325much faster, and no less clean).
1081 1326
1082You can access the read buffer directly as the C<< ->{rbuf} >> 1327The only operation allowed on the read buffer (apart from looking at it)
1083member, if you want. However, the only operation allowed on the 1328is removing data from its beginning. Otherwise modifying or appending to
1084read buffer (apart from looking at it) is removing data from its 1329it is not allowed and will lead to hard-to-track-down bugs.
1085beginning. Otherwise modifying or appending to it is not allowed and will
1086lead to hard-to-track-down bugs.
1087 1330
1088NOTE: The read buffer should only be used or modified if the C<on_read>, 1331NOTE: The read buffer should only be used or modified in the C<on_read>
1089C<push_read> or C<unshift_read> methods are used. The other read methods 1332callback or when C<push_read> or C<unshift_read> are used with a single
1090automatically manage the read buffer. 1333callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
1334will manage the read buffer on their own.
1091 1335
1092=cut 1336=cut
1093 1337
1094sub rbuf : lvalue { 1338sub rbuf : lvalue {
1095 $_[0]{rbuf} 1339 $_[0]{rbuf}
… …
1112 1356
1113If enough data was available, then the callback must remove all data it is 1357If enough data was available, then the callback must remove all data it is
1114interested in (which can be none at all) and return a true value. After returning 1358interested in (which can be none at all) and return a true value. After returning
1115true, it will be removed from the queue. 1359true, it will be removed from the queue.
1116 1360
1361These methods may invoke callbacks (and therefore the handle might be
1362destroyed after it returns).
1363
1117=cut 1364=cut
1118 1365
1119our %RH; 1366our %RH;
1120 1367
1121sub register_read_type($$) { 1368sub register_read_type($$) {
… …
1127 my $cb = pop; 1374 my $cb = pop;
1128 1375
1129 if (@_) { 1376 if (@_) {
1130 my $type = shift; 1377 my $type = shift;
1131 1378
1379 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1132 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 1380 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1133 ->($self, $cb, @_); 1381 ->($self, $cb, @_);
1134 } 1382 }
1135 1383
1136 push @{ $self->{_queue} }, $cb; 1384 push @{ $self->{_queue} }, $cb;
1137 $self->_drain_rbuf; 1385 $self->_drain_rbuf;
… …
1142 my $cb = pop; 1390 my $cb = pop;
1143 1391
1144 if (@_) { 1392 if (@_) {
1145 my $type = shift; 1393 my $type = shift;
1146 1394
1395 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1147 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 1396 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1148 ->($self, $cb, @_); 1397 ->($self, $cb, @_);
1149 } 1398 }
1150
1151 1399
1152 unshift @{ $self->{_queue} }, $cb; 1400 unshift @{ $self->{_queue} }, $cb;
1153 $self->_drain_rbuf; 1401 $self->_drain_rbuf;
1154} 1402}
1155 1403
… …
1157 1405
1158=item $handle->unshift_read (type => @args, $cb) 1406=item $handle->unshift_read (type => @args, $cb)
1159 1407
1160Instead of providing a callback that parses the data itself you can chose 1408Instead of providing a callback that parses the data itself you can chose
1161between a number of predefined parsing formats, for chunks of data, lines 1409between a number of predefined parsing formats, for chunks of data, lines
1162etc. 1410etc. You can also specify the (fully qualified) name of a package, in
1411which case AnyEvent tries to load the package and then expects to find the
1412C<anyevent_read_type> function inside (see "custom read types", below).
1163 1413
1164Predefined types are (if you have ideas for additional types, feel free to 1414Predefined types are (if you have ideas for additional types, feel free to
1165drop by and tell us): 1415drop by and tell us):
1166 1416
1167=over 4 1417=over 4
… …
1259the receive buffer when neither C<$accept> nor C<$reject> match, 1509the receive buffer when neither C<$accept> nor C<$reject> match,
1260and everything preceding and including the match will be accepted 1510and everything preceding and including the match will be accepted
1261unconditionally. This is useful to skip large amounts of data that you 1511unconditionally. This is useful to skip large amounts of data that you
1262know cannot be matched, so that the C<$accept> or C<$reject> regex do not 1512know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1263have to start matching from the beginning. This is purely an optimisation 1513have to start matching from the beginning. This is purely an optimisation
1264and is usually worth only when you expect more than a few kilobytes. 1514and is usually worth it only when you expect more than a few kilobytes.
1265 1515
1266Example: expect a http header, which ends at C<\015\012\015\012>. Since we 1516Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1267expect the header to be very large (it isn't in practise, but...), we use 1517expect the header to be very large (it isn't in practice, but...), we use
1268a skip regex to skip initial portions. The skip regex is tricky in that 1518a skip regex to skip initial portions. The skip regex is tricky in that
1269it only accepts something not ending in either \015 or \012, as these are 1519it only accepts something not ending in either \015 or \012, as these are
1270required for the accept regex. 1520required for the accept regex.
1271 1521
1272 $handle->push_read (regex => 1522 $handle->push_read (regex =>
… …
1407=cut 1657=cut
1408 1658
1409register_read_type json => sub { 1659register_read_type json => sub {
1410 my ($self, $cb) = @_; 1660 my ($self, $cb) = @_;
1411 1661
1412 my $json = $self->{json} ||= 1662 my $json = $self->{json} ||= json_coder;
1413 eval { require JSON::XS; JSON::XS->new->utf8 }
1414 || do { require JSON; JSON->new->utf8 };
1415 1663
1416 my $data; 1664 my $data;
1417 my $rbuf = \$self->{rbuf}; 1665 my $rbuf = \$self->{rbuf};
1418 1666
1419 sub { 1667 sub {
… …
1488 } 1736 }
1489}; 1737};
1490 1738
1491=back 1739=back
1492 1740
1493=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) 1741=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1494 1742
1495This function (not method) lets you add your own types to C<push_read>. 1743Instead of one of the predefined types, you can also specify the name
1744of a package. AnyEvent will try to load the package and then expects to
1745find a function named C<anyevent_read_type> inside. If it isn't found, it
1746progressively tries to load the parent package until it either finds the
1747function (good) or runs out of packages (bad).
1496 1748
1497Whenever the given C<type> is used, C<push_read> will invoke the code 1749Whenever this type is used, C<push_read> will invoke the function with the
1498reference with the handle object, the callback and the remaining 1750handle object, the original callback and the remaining arguments.
1499arguments.
1500 1751
1501The code reference is supposed to return a callback (usually a closure) 1752The function is supposed to return a callback (usually a closure) that
1502that works as a plain read callback (see C<< ->push_read ($cb) >>). 1753works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
1754mentally treat the function as a "configurable read type to read callback"
1755converter.
1503 1756
1504It should invoke the passed callback when it is done reading (remember to 1757It should invoke the original callback when it is done reading (remember
1505pass C<$handle> as first argument as all other callbacks do that). 1758to pass C<$handle> as first argument as all other callbacks do that,
1759although there is no strict requirement on this).
1506 1760
1507Note that this is a function, and all types registered this way will be
1508global, so try to use unique names.
1509
1510For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, 1761For examples, see the source of this module (F<perldoc -m
1511search for C<register_read_type>)). 1762AnyEvent::Handle>, search for C<register_read_type>)).
1512 1763
1513=item $handle->stop_read 1764=item $handle->stop_read
1514 1765
1515=item $handle->start_read 1766=item $handle->start_read
1516 1767
… …
1522Note that AnyEvent::Handle will automatically C<start_read> for you when 1773Note that AnyEvent::Handle will automatically C<start_read> for you when
1523you change the C<on_read> callback or push/unshift a read callback, and it 1774you change the C<on_read> callback or push/unshift a read callback, and it
1524will automatically C<stop_read> for you when neither C<on_read> is set nor 1775will automatically C<stop_read> for you when neither C<on_read> is set nor
1525there are any read requests in the queue. 1776there are any read requests in the queue.
1526 1777
1527These methods will have no effect when in TLS mode (as TLS doesn't support 1778In older versions of this module (<= 5.3), these methods had no effect,
1528half-duplex connections). 1779as TLS does not support half-duplex connections. In current versions they
1780work as expected, as this behaviour is required to avoid certain resource
1781attacks, where the program would be forced to read (and buffer) arbitrary
1782amounts of data before being able to send some data. The drawback is that
1783some readings of the the SSL/TLS specifications basically require this
1784attack to be working, as SSL/TLS implementations might stall sending data
1785during a rehandshake.
1786
1787As a guideline, during the initial handshake, you should not stop reading,
1788and as a client, it might cause problems, depending on your applciation.
1529 1789
1530=cut 1790=cut
1531 1791
1532sub stop_read { 1792sub stop_read {
1533 my ($self) = @_; 1793 my ($self) = @_;
1534 1794
1535 delete $self->{_rw} unless $self->{tls}; 1795 delete $self->{_rw};
1536} 1796}
1537 1797
1538sub start_read { 1798sub start_read {
1539 my ($self) = @_; 1799 my ($self) = @_;
1540 1800
1541 unless ($self->{_rw} || $self->{_eof}) { 1801 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1542 Scalar::Util::weaken $self; 1802 Scalar::Util::weaken $self;
1543 1803
1544 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { 1804 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1545 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1805 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1546 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1806 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1547 1807
1548 if ($len > 0) { 1808 if ($len > 0) {
1549 $self->{_activity} = AnyEvent->now; 1809 $self->{_activity} = $self->{_ractivity} = AE::now;
1550 1810
1551 if ($self->{tls}) { 1811 if ($self->{tls}) {
1552 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1812 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1553 1813
1554 &_dotls ($self); 1814 &_dotls ($self);
1555 } else { 1815 } else {
1556 $self->_drain_rbuf; 1816 $self->_drain_rbuf;
1557 } 1817 }
1558 1818
1819 if ($len == $self->{read_size}) {
1820 $self->{read_size} *= 2;
1821 $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
1822 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1823 }
1824
1559 } elsif (defined $len) { 1825 } elsif (defined $len) {
1560 delete $self->{_rw}; 1826 delete $self->{_rw};
1561 $self->{_eof} = 1; 1827 $self->{_eof} = 1;
1562 $self->_drain_rbuf; 1828 $self->_drain_rbuf;
1563 1829
1564 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 1830 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1565 return $self->_error ($!, 1); 1831 return $self->_error ($!, 1);
1566 } 1832 }
1567 }); 1833 };
1568 } 1834 }
1569} 1835}
1570 1836
1571our $ERROR_SYSCALL; 1837our $ERROR_SYSCALL;
1572our $ERROR_WANT_READ; 1838our $ERROR_WANT_READ;
… …
1639 && ($tmp != $ERROR_SYSCALL || $!); 1905 && ($tmp != $ERROR_SYSCALL || $!);
1640 1906
1641 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1907 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1642 $self->{wbuf} .= $tmp; 1908 $self->{wbuf} .= $tmp;
1643 $self->_drain_wbuf; 1909 $self->_drain_wbuf;
1910 $self->{tls} or return; # tls session might have gone away in callback
1644 } 1911 }
1645 1912
1646 $self->{_on_starttls} 1913 $self->{_on_starttls}
1647 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () 1914 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1648 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); 1915 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
… …
1670context in C<< $handle->{tls_ctx} >> after this call and can be used or 1937context in C<< $handle->{tls_ctx} >> after this call and can be used or
1671changed to your liking. Note that the handshake might have already started 1938changed to your liking. Note that the handshake might have already started
1672when this function returns. 1939when this function returns.
1673 1940
1674Due to bugs in OpenSSL, it might or might not be possible to do multiple 1941Due to bugs in OpenSSL, it might or might not be possible to do multiple
1675handshakes on the same stream. Best do not attempt to use the stream after 1942handshakes on the same stream. It is best to not attempt to use the
1676stopping TLS. 1943stream after stopping TLS.
1944
1945This method may invoke callbacks (and therefore the handle might be
1946destroyed after it returns).
1677 1947
1678=cut 1948=cut
1679 1949
1680our %TLS_CACHE; #TODO not yet documented, should we? 1950our %TLS_CACHE; #TODO not yet documented, should we?
1681 1951
… …
1693 require Net::SSLeay; 1963 require Net::SSLeay;
1694 1964
1695 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); 1965 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1696 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); 1966 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1697 1967
1698 $tls = $self->{tls}; 1968 $tls = delete $self->{tls};
1699 $ctx = $self->{tls_ctx}; 1969 $ctx = $self->{tls_ctx};
1700 1970
1701 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session 1971 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1702 1972
1703 if ("HASH" eq ref $ctx) { 1973 if ("HASH" eq ref $ctx) {
… …
1747 2017
1748=item $handle->stoptls 2018=item $handle->stoptls
1749 2019
1750Shuts down the SSL connection - this makes a proper EOF handshake by 2020Shuts down the SSL connection - this makes a proper EOF handshake by
1751sending a close notify to the other side, but since OpenSSL doesn't 2021sending a close notify to the other side, but since OpenSSL doesn't
1752support non-blocking shut downs, it is not guarenteed that you can re-use 2022support non-blocking shut downs, it is not guaranteed that you can re-use
1753the stream afterwards. 2023the stream afterwards.
2024
2025This method may invoke callbacks (and therefore the handle might be
2026destroyed after it returns).
1754 2027
1755=cut 2028=cut
1756 2029
1757sub stoptls { 2030sub stoptls {
1758 my ($self) = @_; 2031 my ($self) = @_;
1759 2032
1760 if ($self->{tls}) { 2033 if ($self->{tls} && $self->{fh}) {
1761 Net::SSLeay::shutdown ($self->{tls}); 2034 Net::SSLeay::shutdown ($self->{tls});
1762 2035
1763 &_dotls; 2036 &_dotls;
1764 2037
1765# # we don't give a shit. no, we do, but we can't. no...#d# 2038# # we don't give a shit. no, we do, but we can't. no...#d#
… …
1790 my $fh = delete $self->{fh}; 2063 my $fh = delete $self->{fh};
1791 my $wbuf = delete $self->{wbuf}; 2064 my $wbuf = delete $self->{wbuf};
1792 2065
1793 my @linger; 2066 my @linger;
1794 2067
1795 push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { 2068 push @linger, AE::io $fh, 1, sub {
1796 my $len = syswrite $fh, $wbuf, length $wbuf; 2069 my $len = syswrite $fh, $wbuf, length $wbuf;
1797 2070
1798 if ($len > 0) { 2071 if ($len > 0) {
1799 substr $wbuf, 0, $len, ""; 2072 substr $wbuf, 0, $len, "";
1800 } else { 2073 } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1801 @linger = (); # end 2074 @linger = (); # end
1802 } 2075 }
1803 }); 2076 };
1804 push @linger, AnyEvent->timer (after => $linger, cb => sub { 2077 push @linger, AE::timer $linger, 0, sub {
1805 @linger = (); 2078 @linger = ();
1806 }); 2079 };
1807 } 2080 }
1808} 2081}
1809 2082
1810=item $handle->destroy 2083=item $handle->destroy
1811 2084
… …
1842 2115
1843sub AnyEvent::Handle::destroyed::AUTOLOAD { 2116sub AnyEvent::Handle::destroyed::AUTOLOAD {
1844 #nop 2117 #nop
1845} 2118}
1846 2119
2120=item $handle->destroyed
2121
2122Returns false as long as the handle hasn't been destroyed by a call to C<<
2123->destroy >>, true otherwise.
2124
2125Can be useful to decide whether the handle is still valid after some
2126callback possibly destroyed the handle. For example, C<< ->push_write >>,
2127C<< ->starttls >> and other methods can call user callbacks, which in turn
2128can destroy the handle, so work can be avoided by checking sometimes:
2129
2130 $hdl->starttls ("accept");
2131 return if $hdl->destroyed;
2132 $hdl->push_write (...
2133
2134Note that the call to C<push_write> will silently be ignored if the handle
2135has been destroyed, so often you can just ignore the possibility of the
2136handle being destroyed.
2137
2138=cut
2139
2140sub destroyed { 0 }
2141sub AnyEvent::Handle::destroyed::destroyed { 1 }
2142
1847=item AnyEvent::Handle::TLS_CTX 2143=item AnyEvent::Handle::TLS_CTX
1848 2144
1849This function creates and returns the AnyEvent::TLS object used by default 2145This function creates and returns the AnyEvent::TLS object used by default
1850for TLS mode. 2146for TLS mode.
1851 2147
… …
1878 2174
1879It is only safe to "forget" the reference inside EOF or error callbacks, 2175It is only safe to "forget" the reference inside EOF or error callbacks,
1880from within all other callbacks, you need to explicitly call the C<< 2176from within all other callbacks, you need to explicitly call the C<<
1881->destroy >> method. 2177->destroy >> method.
1882 2178
2179=item Why is my C<on_eof> callback never called?
2180
2181Probably because your C<on_error> callback is being called instead: When
2182you have outstanding requests in your read queue, then an EOF is
2183considered an error as you clearly expected some data.
2184
2185To avoid this, make sure you have an empty read queue whenever your handle
2186is supposed to be "idle" (i.e. connection closes are O.K.). You cna set
2187an C<on_read> handler that simply pushes the first read requests in the
2188queue.
2189
2190See also the next question, which explains this in a bit more detail.
2191
2192=item How can I serve requests in a loop?
2193
2194Most protocols consist of some setup phase (authentication for example)
2195followed by a request handling phase, where the server waits for requests
2196and handles them, in a loop.
2197
2198There are two important variants: The first (traditional, better) variant
2199handles requests until the server gets some QUIT command, causing it to
2200close the connection first (highly desirable for a busy TCP server). A
2201client dropping the connection is an error, which means this variant can
2202detect an unexpected detection close.
2203
2204To handle this case, always make sure you have a on-empty read queue, by
2205pushing the "read request start" handler on it:
2206
2207 # we assume a request starts with a single line
2208 my @start_request; @start_request = (line => sub {
2209 my ($hdl, $line) = @_;
2210
2211 ... handle request
2212
2213 # push next request read, possibly from a nested callback
2214 $hdl->push_read (@start_request);
2215 });
2216
2217 # auth done, now go into request handling loop
2218 # now push the first @start_request
2219 $hdl->push_read (@start_request);
2220
2221By always having an outstanding C<push_read>, the handle always expects
2222some data and raises the C<EPIPE> error when the connction is dropped
2223unexpectedly.
2224
2225The second variant is a protocol where the client can drop the connection
2226at any time. For TCP, this means that the server machine may run out of
2227sockets easier, and in general, it means you cnanot distinguish a protocl
2228failure/client crash from a normal connection close. Nevertheless, these
2229kinds of protocols are common (and sometimes even the best solution to the
2230problem).
2231
2232Having an outstanding read request at all times is possible if you ignore
2233C<EPIPE> errors, but this doesn't help with when the client drops the
2234connection during a request, which would still be an error.
2235
2236A better solution is to push the initial request read in an C<on_read>
2237callback. This avoids an error, as when the server doesn't expect data
2238(i.e. is idly waiting for the next request, an EOF will not raise an
2239error, but simply result in an C<on_eof> callback. It is also a bit slower
2240and simpler:
2241
2242 # auth done, now go into request handling loop
2243 $hdl->on_read (sub {
2244 my ($hdl) = @_;
2245
2246 # called each time we receive data but the read queue is empty
2247 # simply start read the request
2248
2249 $hdl->push_read (line => sub {
2250 my ($hdl, $line) = @_;
2251
2252 ... handle request
2253
2254 # do nothing special when the request has been handled, just
2255 # let the request queue go empty.
2256 });
2257 });
2258
1883=item I get different callback invocations in TLS mode/Why can't I pause 2259=item I get different callback invocations in TLS mode/Why can't I pause
1884reading? 2260reading?
1885 2261
1886Unlike, say, TCP, TLS connections do not consist of two independent 2262Unlike, say, TCP, TLS connections do not consist of two independent
1887communication channels, one for each direction. Or put differently. The 2263communication channels, one for each direction. Or put differently, the
1888read and write directions are not independent of each other: you cannot 2264read and write directions are not independent of each other: you cannot
1889write data unless you are also prepared to read, and vice versa. 2265write data unless you are also prepared to read, and vice versa.
1890 2266
1891This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> 2267This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1892callback invocations when you are not expecting any read data - the reason 2268callback invocations when you are not expecting any read data - the reason
1893is that AnyEvent::Handle always reads in TLS mode. 2269is that AnyEvent::Handle always reads in TLS mode.
1894 2270
1895During the connection, you have to make sure that you always have a 2271During the connection, you have to make sure that you always have a
1896non-empty read-queue, or an C<on_read> watcher. At the end of the 2272non-empty read-queue, or an C<on_read> watcher. At the end of the
… …
1910 my $data = delete $_[0]{rbuf}; 2286 my $data = delete $_[0]{rbuf};
1911 }); 2287 });
1912 2288
1913The reason to use C<on_error> is that TCP connections, due to latencies 2289The reason to use C<on_error> is that TCP connections, due to latencies
1914and packets loss, might get closed quite violently with an error, when in 2290and packets loss, might get closed quite violently with an error, when in
1915fact, all data has been received. 2291fact all data has been received.
1916 2292
1917It is usually better to use acknowledgements when transferring data, 2293It is usually better to use acknowledgements when transferring data,
1918to make sure the other side hasn't just died and you got the data 2294to make sure the other side hasn't just died and you got the data
1919intact. This is also one reason why so many internet protocols have an 2295intact. This is also one reason why so many internet protocols have an
1920explicit QUIT command. 2296explicit QUIT command.
… …
1937consider using C<< ->push_shutdown >> instead. 2313consider using C<< ->push_shutdown >> instead.
1938 2314
1939=item I want to contact a TLS/SSL server, I don't care about security. 2315=item I want to contact a TLS/SSL server, I don't care about security.
1940 2316
1941If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, 2317If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1942simply connect to it and then create the AnyEvent::Handle with the C<tls> 2318connect to it and then create the AnyEvent::Handle with the C<tls>
1943parameter: 2319parameter:
1944 2320
1945 tcp_connect $host, $port, sub { 2321 tcp_connect $host, $port, sub {
1946 my ($fh) = @_; 2322 my ($fh) = @_;
1947 2323
… …
2047 2423
2048=item * all members not documented here and not prefixed with an underscore 2424=item * all members not documented here and not prefixed with an underscore
2049are free to use in subclasses. 2425are free to use in subclasses.
2050 2426
2051Of course, new versions of AnyEvent::Handle may introduce more "public" 2427Of course, new versions of AnyEvent::Handle may introduce more "public"
2052member variables, but thats just life, at least it is documented. 2428member variables, but that's just life. At least it is documented.
2053 2429
2054=back 2430=back
2055 2431
2056=head1 AUTHOR 2432=head1 AUTHOR
2057 2433

Diff Legend

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