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.180 by root, Thu Aug 20 22:58:35 2009 UTC vs.
Revision 1.229 by root, Mon Feb 27 17:14:02 2012 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent 3AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent; 7 use AnyEvent;
8 use AnyEvent::Handle; 8 use AnyEvent::Handle;
… …
11 11
12 my $hdl; $hdl = new AnyEvent::Handle 12 my $hdl; $hdl = new AnyEvent::Handle
13 fh => \*STDIN, 13 fh => \*STDIN,
14 on_error => sub { 14 on_error => sub {
15 my ($hdl, $fatal, $msg) = @_; 15 my ($hdl, $fatal, $msg) = @_;
16 warn "got error $msg\n"; 16 AE::log error => "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
25 $hdl->push_read (line => sub { 25 $hdl->push_read (line => sub {
26 my ($hdl, $line) = @_; 26 my ($hdl, $line) = @_;
27 warn "got line <$line>\n"; 27 say "got line <$line>";
28 $cv->send; 28 $cv->send;
29 }); 29 });
30 30
31 $cv->recv; 31 $cv->recv;
32 32
33=head1 DESCRIPTION 33=head1 DESCRIPTION
34 34
35This module is a helper module to make it easier to do event-based I/O on 35This is a helper module to make it easier to do event-based I/O on
36filehandles. 36stream-based filehandles (sockets, pipes, and other stream things).
37 37
38The L<AnyEvent::Intro> tutorial contains some well-documented 38The L<AnyEvent::Intro> tutorial contains some well-documented
39AnyEvent::Handle examples. 39AnyEvent::Handle examples.
40 40
41In the following, when the documentation refers to of "bytes" then this 41In the following, where the documentation refers to "bytes", it means
42means characters. As sysread and syswrite are used for all I/O, their 42characters. As sysread and syswrite are used for all I/O, their
43treatment of characters applies to this module as well. 43treatment of characters applies to this module as well.
44 44
45At the very minimum, you should specify C<fh> or C<connect>, and the 45At the very minimum, you should specify C<fh> or C<connect>, and the
46C<on_error> callback. 46C<on_error> callback.
47 47
… …
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
… …
97=over 4 114=over 4
98 115
99=item on_prepare => $cb->($handle) 116=item on_prepare => $cb->($handle)
100 117
101This (rarely used) callback is called before a new connection is 118This (rarely used) callback is called before a new connection is
102attempted, 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
103prepare the file handle with parameters required for the actual connect 121file handle with parameters required for the actual connect (as opposed to
104(as opposed to settings that can be changed when the connection is already 122settings that can be changed when the connection is already established).
105established).
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. At the time it is called the
134read and write queues, EOF status, TLS status and similar properties of
135the handle will have been reset.
117 136
137It is not allowed to use the read or write queues while the handle object
138is connecting.
139
118When, for some reason, the handle is not acceptable, then calling 140If, for some reason, the handle is not acceptable, calling C<$retry> will
119C<$retry> will continue with the next conenction target (in case of 141continue with the next connection target (in case of multi-homed hosts or
120multi-homed hosts or SRV records there can be multiple connection 142SRV records there can be multiple connection endpoints). The C<$retry>
121endpoints). When it is called then the read and write queues, eof status, 143callback can be invoked after the connect callback returns, i.e. one can
122tls status and similar properties of the handle are being reset. 144start a handshake and then decide to retry with the next host if the
145handshake fails.
123 146
124In most cases, ignoring the C<$retry> parameter is the way to go. 147In most cases, you should ignore the C<$retry> parameter.
125 148
126=item on_connect_error => $cb->($handle, $message) 149=item on_connect_error => $cb->($handle, $message)
127 150
128This callback is called when the conenction could not be 151This callback is called when the connection could not be
129established. C<$!> will contain the relevant error code, and C<$message> a 152established. C<$!> will contain the relevant error code, and C<$message> a
130message describing it (usually the same as C<"$!">). 153message describing it (usually the same as C<"$!">).
131 154
132If this callback isn't specified, then C<on_error> will be called with a 155If this callback isn't specified, then C<on_error> will be called with a
133fatal error instead. 156fatal error instead.
… …
136 159
137=item on_error => $cb->($handle, $fatal, $message) 160=item on_error => $cb->($handle, $fatal, $message)
138 161
139This is the error callback, which is called when, well, some error 162This is the error callback, which is called when, well, some error
140occured, such as not being able to resolve the hostname, failure to 163occured, such as not being able to resolve the hostname, failure to
141connect or a read error. 164connect, or a read error.
142 165
143Some errors are fatal (which is indicated by C<$fatal> being true). On 166Some errors are fatal (which is indicated by C<$fatal> being true). On
144fatal errors the handle object will be destroyed (by a call to C<< -> 167fatal errors the handle object will be destroyed (by a call to C<< ->
145destroy >>) after invoking the error callback (which means you are free to 168destroy >>) after invoking the error callback (which means you are free to
146examine the handle object). Examples of fatal errors are an EOF condition 169examine the handle object). Examples of fatal errors are an EOF condition
147with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In 170with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
148cases where the other side can close the connection at their will it is 171cases where the other side can close the connection at will, it is
149often easiest to not report C<EPIPE> errors in this callback. 172often easiest to not report C<EPIPE> errors in this callback.
150 173
151AnyEvent::Handle tries to find an appropriate error code for you to check 174AnyEvent::Handle tries to find an appropriate error code for you to check
152against, but in some cases (TLS errors), this does not work well. It is 175against, but in some cases (TLS errors), this does not work well. It is
153recommended to always output the C<$message> argument in human-readable 176recommended to always output the C<$message> argument in human-readable
154error messages (it's usually the same as C<"$!">). 177error messages (it's usually the same as C<"$!">).
155 178
156Non-fatal errors can be retried by simply returning, but it is recommended 179Non-fatal errors can be retried by returning, but it is recommended
157to simply ignore this parameter and instead abondon the handle object 180to simply ignore this parameter and instead abondon the handle object
158when this callback is invoked. Examples of non-fatal errors are timeouts 181when this callback is invoked. Examples of non-fatal errors are timeouts
159C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 182C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
160 183
161On callback entrance, the value of C<$!> contains the operating system 184On entry to the callback, the value of C<$!> contains the operating
162error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or 185system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
163C<EPROTO>). 186C<EPROTO>).
164 187
165While not mandatory, it is I<highly> recommended to set this callback, as 188While not mandatory, it is I<highly> recommended to set this callback, as
166you will not be notified of errors otherwise. The default simply calls 189you will not be notified of errors otherwise. The default just calls
167C<croak>. 190C<croak>.
168 191
169=item on_read => $cb->($handle) 192=item on_read => $cb->($handle)
170 193
171This sets the default read callback, which is called when data arrives 194This sets the default read callback, which is called when data arrives
… …
176To access (and remove data from) the read buffer, use the C<< ->rbuf >> 199To access (and remove data from) the read buffer, use the C<< ->rbuf >>
177method or access the C<< $handle->{rbuf} >> member directly. Note that you 200method 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 201must not enlarge or modify the read buffer, you can only remove data at
179the beginning from it. 202the beginning from it.
180 203
204You can also call C<< ->push_read (...) >> or any other function that
205modifies the read queue. Or do both. Or ...
206
181When an EOF condition is detected then AnyEvent::Handle will first try to 207When 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 208feed 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 209calling the C<on_eof> callback. If no progress can be made, then a fatal
184error will be raised (with C<$!> set to C<EPIPE>). 210error will be raised (with C<$!> set to C<EPIPE>).
185 211
186Note that, unlike requests in the read queue, an C<on_read> callback 212Note that, unlike requests in the read queue, an C<on_read> callback
… …
204If an EOF condition has been detected but no C<on_eof> callback has been 230If an EOF condition has been detected but no C<on_eof> callback has been
205set, then a fatal error will be raised with C<$!> set to <0>. 231set, then a fatal error will be raised with C<$!> set to <0>.
206 232
207=item on_drain => $cb->($handle) 233=item on_drain => $cb->($handle)
208 234
209This sets the callback that is called when the write buffer becomes empty 235This sets the callback that is called once when the write buffer becomes
210(or when the callback is set and the buffer is empty already). 236empty (and immediately when the handle object is created).
211 237
212To append to the write buffer, use the C<< ->push_write >> method. 238To append to the write buffer, use the C<< ->push_write >> method.
213 239
214This callback is useful when you don't want to put all of your write data 240This 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 241into 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 253many 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 254file 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> 255will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
230error will be raised). 256error will be raised).
231 257
232There are three variants of the timeouts that work fully independent 258There are three variants of the timeouts that work independently of each
233of each other, for both read and write, just read, and just write: 259other, for both read and write (triggered when nothing was read I<OR>
260written), just read (triggered when nothing was read), and just write:
234C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks 261C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
235C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions 262C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
236C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. 263C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
237 264
238Note that timeout processing is also active when you currently do not have 265Note that timeout processing is active even when you do not have any
239any outstanding read or write requests: If you plan to keep the connection 266outstanding read or write requests: If you plan to keep the connection
240idle then you should disable the timout temporarily or ignore the timeout 267idle then you should disable the timeout temporarily or ignore the
241in the C<on_timeout> callback, in which case AnyEvent::Handle will simply 268timeout in the corresponding C<on_timeout> callback, in which case
242restart the timeout. 269AnyEvent::Handle will simply restart the timeout.
243 270
244Zero (the default) disables this timeout. 271Zero (the default) disables the corresponding timeout.
245 272
246=item on_timeout => $cb->($handle) 273=item on_timeout => $cb->($handle)
274
275=item on_rtimeout => $cb->($handle)
276
277=item on_wtimeout => $cb->($handle)
247 278
248Called whenever the inactivity timeout passes. If you return from this 279Called whenever the inactivity timeout passes. If you return from this
249callback, then the timeout will be reset as if some activity had happened, 280callback, then the timeout will be reset as if some activity had happened,
250so this condition is not fatal in any way. 281so this condition is not fatal in any way.
251 282
… …
259be configured to accept only so-and-so much data that it cannot act on 290be configured to accept only so-and-so much data that it cannot act on
260(for example, when expecting a line, an attacker could send an unlimited 291(for example, when expecting a line, an attacker could send an unlimited
261amount of data without a callback ever being called as long as the line 292amount of data without a callback ever being called as long as the line
262isn't finished). 293isn't finished).
263 294
295=item wbuf_max => <bytes>
296
297If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
298when the write buffer ever (strictly) exceeds this size. This is useful to
299avoid some forms of denial-of-service attacks.
300
301Although the units of this parameter is bytes, this is the I<raw> number
302of bytes not yet accepted by the kernel. This can make a difference when
303you e.g. use TLS, as TLS typically makes your write data larger (but it
304can also make it smaller due to compression).
305
306As an example of when this limit is useful, take a chat server that sends
307chat messages to a client. If the client does not read those in a timely
308manner then the send buffer in the server would grow unbounded.
309
264=item autocork => <boolean> 310=item autocork => <boolean>
265 311
266When disabled (the default), then C<push_write> will try to immediately 312When disabled (the default), C<push_write> will try to immediately
267write the data to the handle, if possible. This avoids having to register 313write 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 314a write watcher and wait for the next event loop iteration, but can
269be inefficient if you write multiple small chunks (on the wire, this 315be inefficient if you write multiple small chunks (on the wire, this
270disadvantage is usually avoided by your kernel's nagle algorithm, see 316disadvantage is usually avoided by your kernel's nagle algorithm, see
271C<no_delay>, but this option can save costly syscalls). 317C<no_delay>, but this option can save costly syscalls).
272 318
273When enabled, then writes will always be queued till the next event loop 319When enabled, writes will always be queued till the next event loop
274iteration. This is efficient when you do many small writes per iteration, 320iteration. 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 321but less efficient when you do a single write only per iteration (or when
276the write buffer often is full). It also increases write latency. 322the write buffer often is full). It also increases write latency.
277 323
278=item no_delay => <boolean> 324=item no_delay => <boolean>
… …
282the Nagle algorithm, and usually it is beneficial. 328the Nagle algorithm, and usually it is beneficial.
283 329
284In some situations you want as low a delay as possible, which can be 330In some situations you want as low a delay as possible, which can be
285accomplishd by setting this option to a true value. 331accomplishd by setting this option to a true value.
286 332
287The default is your opertaing system's default behaviour (most likely 333The default is your operating system's default behaviour (most likely
288enabled), this option explicitly enables or disables it, if possible. 334enabled). This option explicitly enables or disables it, if possible.
335
336=item keepalive => <boolean>
337
338Enables (default disable) the SO_KEEPALIVE option on the stream socket:
339normally, TCP connections have no time-out once established, so TCP
340connections, once established, can stay alive forever even when the other
341side has long gone. TCP keepalives are a cheap way to take down long-lived
342TCP connections when the other side becomes unreachable. While the default
343is OS-dependent, TCP keepalives usually kick in after around two hours,
344and, if the other side doesn't reply, take down the TCP connection some 10
345to 15 minutes later.
346
347It is harmless to specify this option for file handles that do not support
348keepalives, and enabling it on connections that are potentially long-lived
349is usually a good idea.
350
351=item oobinline => <boolean>
352
353BSD majorly fucked up the implementation of TCP urgent data. The result
354is that almost no OS implements TCP according to the specs, and every OS
355implements it slightly differently.
356
357If you want to handle TCP urgent data, then setting this flag (the default
358is enabled) gives you the most portable way of getting urgent data, by
359putting it into the stream.
360
361Since BSD emulation of OOB data on top of TCP's urgent data can have
362security implications, AnyEvent::Handle sets this flag automatically
363unless explicitly specified. Note that setting this flag after
364establishing a connection I<may> be a bit too late (data loss could
365already have occured on BSD systems), but at least it will protect you
366from most attacks.
289 367
290=item read_size => <bytes> 368=item read_size => <bytes>
291 369
292The default read block size (the amount of bytes this module will 370The initial read block size, the number of bytes this module will try
293try to read during each loop iteration, which affects memory 371to read during each loop iteration. Each handle object will consume
294requirements). Default: C<8192>. 372at least this amount of memory for the read buffer as well, so when
373handling many connections watch out for memory requirements). See also
374C<max_read_size>. Default: C<2048>.
375
376=item max_read_size => <bytes>
377
378The maximum read buffer size used by the dynamic adjustment
379algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
380one go it will double C<read_size> up to the maximum given by this
381option. Default: C<131072> or C<read_size>, whichever is higher.
295 382
296=item low_water_mark => <bytes> 383=item low_water_mark => <bytes>
297 384
298Sets the amount of bytes (default: C<0>) that make up an "empty" write 385Sets 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 386buffer: If the buffer reaches this size or gets even samller it is
300considered empty. 387considered empty.
301 388
302Sometimes it can be beneficial (for performance reasons) to add data to 389Sometimes 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 390the 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 391the operating system kernel usually buffers data as well, so the default
305is good in almost all cases. 392is good in almost all cases.
306 393
307=item linger => <seconds> 394=item linger => <seconds>
308 395
309If non-zero (default: C<3600>), then the destructor of the 396If this is non-zero (default: C<3600>), the destructor of the
310AnyEvent::Handle object will check whether there is still outstanding 397AnyEvent::Handle object will check whether there is still outstanding
311write data and will install a watcher that will write this data to the 398write 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 399socket. No errors will be reported (this mostly matches how the operating
313system treats outstanding data at socket close time). 400system treats outstanding data at socket close time).
314 401
… …
321A string used to identify the remote site - usually the DNS hostname 408A string used to identify the remote site - usually the DNS hostname
322(I<not> IDN!) used to create the connection, rarely the IP address. 409(I<not> IDN!) used to create the connection, rarely the IP address.
323 410
324Apart from being useful in error messages, this string is also used in TLS 411Apart from being useful in error messages, this string is also used in TLS
325peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This 412peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
326verification will be skipped when C<peername> is not specified or 413verification will be skipped when C<peername> is not specified or is
327C<undef>. 414C<undef>.
328 415
329=item tls => "accept" | "connect" | Net::SSLeay::SSL object 416=item tls => "accept" | "connect" | Net::SSLeay::SSL object
330 417
331When this parameter is given, it enables TLS (SSL) mode, that means 418When this parameter is given, it enables TLS (SSL) mode, that means
332AnyEvent will start a TLS handshake as soon as the conenction has been 419AnyEvent will start a TLS handshake as soon as the connection has been
333established and will transparently encrypt/decrypt data afterwards. 420established and will transparently encrypt/decrypt data afterwards.
334 421
335All TLS protocol errors will be signalled as C<EPROTO>, with an 422All TLS protocol errors will be signalled as C<EPROTO>, with an
336appropriate error message. 423appropriate error message.
337 424
… …
357B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 444B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
358passing in the wrong integer will lead to certain crash. This most often 445passing 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 446happens when one uses a stylish C<< tls => 1 >> and is surprised about the
360segmentation fault. 447segmentation fault.
361 448
362See the C<< ->starttls >> method for when need to start TLS negotiation later. 449Use the C<< ->starttls >> method if you need to start TLS negotiation later.
363 450
364=item tls_ctx => $anyevent_tls 451=item tls_ctx => $anyevent_tls
365 452
366Use the given C<AnyEvent::TLS> object to create the new TLS connection 453Use the given C<AnyEvent::TLS> object to create the new TLS connection
367(unless a connection object was specified directly). If this parameter is 454(unless a connection object was specified directly). If this
368missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 455parameter is missing (or C<undef>), then AnyEvent::Handle will use
456C<AnyEvent::Handle::TLS_CTX>.
369 457
370Instead of an object, you can also specify a hash reference with C<< key 458Instead 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 459=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
372new TLS context object. 460new TLS context object.
373 461
… …
382 470
383TLS handshake failures will not cause C<on_error> to be invoked when this 471TLS 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>. 472callback is in effect, instead, the error message will be passed to C<on_starttls>.
385 473
386Without this callback, handshake failures lead to C<on_error> being 474Without this callback, handshake failures lead to C<on_error> being
387called, as normal. 475called as usual.
388 476
389Note that you cannot call C<starttls> right again in this callback. If you 477Note 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 478need to do that, start an zero-second timer instead whose callback can
391then call C<< ->starttls >> again. 479then call C<< ->starttls >> again.
392 480
393=item on_stoptls => $cb->($handle) 481=item on_stoptls => $cb->($handle)
394 482
… …
442 $self->{connect}[0], 530 $self->{connect}[0],
443 $self->{connect}[1], 531 $self->{connect}[1],
444 sub { 532 sub {
445 my ($fh, $host, $port, $retry) = @_; 533 my ($fh, $host, $port, $retry) = @_;
446 534
535 delete $self->{_connect}; # no longer needed
536
447 if ($fh) { 537 if ($fh) {
448 $self->{fh} = $fh; 538 $self->{fh} = $fh;
449 539
450 delete $self->{_skip_drain_rbuf}; 540 delete $self->{_skip_drain_rbuf};
451 $self->_start; 541 $self->_start;
… …
458 }); 548 });
459 549
460 } else { 550 } else {
461 if ($self->{on_connect_error}) { 551 if ($self->{on_connect_error}) {
462 $self->{on_connect_error}($self, "$!"); 552 $self->{on_connect_error}($self, "$!");
463 $self->destroy; 553 $self->destroy if $self;
464 } else { 554 } else {
465 $self->_error ($!, 1); 555 $self->_error ($!, 1);
466 } 556 }
467 } 557 }
468 }, 558 },
469 sub { 559 sub {
470 local $self->{fh} = $_[0]; 560 local $self->{fh} = $_[0];
471 561
472 $self->{on_prepare} 562 $self->{on_prepare}
473 ? $self->{on_prepare}->($self) 563 ? $self->{on_prepare}->($self)
474 : () 564 : ()
475 } 565 }
476 ); 566 );
477 } 567 }
478 568
… …
484} 574}
485 575
486sub _start { 576sub _start {
487 my ($self) = @_; 577 my ($self) = @_;
488 578
579 # too many clueless people try to use udp and similar sockets
580 # with AnyEvent::Handle, do them a favour.
581 my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
582 Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
583 if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
584
489 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 585 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
490 586
491 $self->{_activity} = 587 $self->{_activity} =
492 $self->{_ractivity} = 588 $self->{_ractivity} =
493 $self->{_wactivity} = AE::now; 589 $self->{_wactivity} = AE::now;
494 590
591 $self->{read_size} ||= 2048;
592 $self->{max_read_size} = $self->{read_size}
593 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
594
495 $self->timeout (delete $self->{timeout} ) if $self->{timeout}; 595 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
496 $self->rtimeout (delete $self->{rtimeout}) if $self->{rtimeout}; 596 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
497 $self->wtimeout (delete $self->{wtimeout}) if $self->{wtimeout}; 597 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
498 598
499 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; 599 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
600 $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
500 601
602 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
603
501 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 604 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
502 if $self->{tls}; 605 if $self->{tls};
503 606
504 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 607 $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
505 608
506 $self->start_read 609 $self->start_read
507 if $self->{on_read} || @{ $self->{_queue} }; 610 if $self->{on_read} || @{ $self->{_queue} };
508 611
509 $self->_drain_wbuf; 612 $self->_drain_wbuf;
… …
516 $message ||= "$!"; 619 $message ||= "$!";
517 620
518 if ($self->{on_error}) { 621 if ($self->{on_error}) {
519 $self->{on_error}($self, $fatal, $message); 622 $self->{on_error}($self, $fatal, $message);
520 $self->destroy if $fatal; 623 $self->destroy if $fatal;
521 } elsif ($self->{fh}) { 624 } elsif ($self->{fh} || $self->{connect}) {
522 $self->destroy; 625 $self->destroy;
523 Carp::croak "AnyEvent::Handle uncaught error: $message"; 626 Carp::croak "AnyEvent::Handle uncaught error: $message";
524 } 627 }
525} 628}
526 629
… …
585=cut 688=cut
586 689
587sub no_delay { 690sub no_delay {
588 $_[0]{no_delay} = $_[1]; 691 $_[0]{no_delay} = $_[1];
589 692
693 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
694 if $_[0]{fh};
695}
696
697=item $handle->keepalive ($boolean)
698
699Enables or disables the C<keepalive> setting (see constructor argument of
700the same name for details).
701
702=cut
703
704sub keepalive {
705 $_[0]{keepalive} = $_[1];
706
590 eval { 707 eval {
591 local $SIG{__DIE__}; 708 local $SIG{__DIE__};
592 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1] 709 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
593 if $_[0]{fh}; 710 if $_[0]{fh};
594 }; 711 };
595} 712}
596 713
714=item $handle->oobinline ($boolean)
715
716Enables or disables the C<oobinline> setting (see constructor argument of
717the same name for details).
718
719=cut
720
721sub oobinline {
722 $_[0]{oobinline} = $_[1];
723
724 eval {
725 local $SIG{__DIE__};
726 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
727 if $_[0]{fh};
728 };
729}
730
731=item $handle->keepalive ($boolean)
732
733Enables or disables the C<keepalive> setting (see constructor argument of
734the same name for details).
735
736=cut
737
738sub keepalive {
739 $_[0]{keepalive} = $_[1];
740
741 eval {
742 local $SIG{__DIE__};
743 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
744 if $_[0]{fh};
745 };
746}
747
597=item $handle->on_starttls ($cb) 748=item $handle->on_starttls ($cb)
598 749
599Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). 750Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
600 751
601=cut 752=cut
… …
608 759
609Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). 760Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
610 761
611=cut 762=cut
612 763
613sub on_starttls { 764sub on_stoptls {
614 $_[0]{on_stoptls} = $_[1]; 765 $_[0]{on_stoptls} = $_[1];
615} 766}
616 767
617=item $handle->rbuf_max ($max_octets) 768=item $handle->rbuf_max ($max_octets)
618 769
619Configures the C<rbuf_max> setting (C<undef> disables it). 770Configures the C<rbuf_max> setting (C<undef> disables it).
771
772=item $handle->wbuf_max ($max_octets)
773
774Configures the C<wbuf_max> setting (C<undef> disables it).
620 775
621=cut 776=cut
622 777
623sub rbuf_max { 778sub rbuf_max {
624 $_[0]{rbuf_max} = $_[1]; 779 $_[0]{rbuf_max} = $_[1];
625} 780}
626 781
782sub wbuf_max {
783 $_[0]{wbuf_max} = $_[1];
784}
785
627############################################################################# 786#############################################################################
628 787
629=item $handle->timeout ($seconds) 788=item $handle->timeout ($seconds)
630 789
631=item $handle->rtimeout ($seconds) 790=item $handle->rtimeout ($seconds)
632 791
633=item $handle->wtimeout ($seconds) 792=item $handle->wtimeout ($seconds)
634 793
635Configures (or disables) the inactivity timeout. 794Configures (or disables) the inactivity timeout.
795
796The timeout will be checked instantly, so this method might destroy the
797handle before it returns.
636 798
637=item $handle->timeout_reset 799=item $handle->timeout_reset
638 800
639=item $handle->rtimeout_reset 801=item $handle->rtimeout_reset
640 802
… …
657 $_[0]{$on_timeout} = $_[1]; 819 $_[0]{$on_timeout} = $_[1];
658 }; 820 };
659 821
660 *$timeout = sub { 822 *$timeout = sub {
661 my ($self, $new_value) = @_; 823 my ($self, $new_value) = @_;
824
825 $new_value >= 0
826 or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
662 827
663 $self->{$timeout} = $new_value; 828 $self->{$timeout} = $new_value;
664 delete $self->{$tw}; &$cb; 829 delete $self->{$tw}; &$cb;
665 }; 830 };
666 831
… …
721 886
722The write queue is very simple: you can add data to its end, and 887The write queue is very simple: you can add data to its end, and
723AnyEvent::Handle will automatically try to get rid of it for you. 888AnyEvent::Handle will automatically try to get rid of it for you.
724 889
725When data could be written and the write buffer is shorter then the low 890When data could be written and the write buffer is shorter then the low
726water mark, the C<on_drain> callback will be invoked. 891water mark, the C<on_drain> callback will be invoked once.
727 892
728=over 4 893=over 4
729 894
730=item $handle->on_drain ($cb) 895=item $handle->on_drain ($cb)
731 896
732Sets the C<on_drain> callback or clears it (see the description of 897Sets the C<on_drain> callback or clears it (see the description of
733C<on_drain> in the constructor). 898C<on_drain> in the constructor).
734 899
900This method may invoke callbacks (and therefore the handle might be
901destroyed after it returns).
902
735=cut 903=cut
736 904
737sub on_drain { 905sub on_drain {
738 my ($self, $cb) = @_; 906 my ($self, $cb) = @_;
739 907
… …
743 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); 911 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
744} 912}
745 913
746=item $handle->push_write ($data) 914=item $handle->push_write ($data)
747 915
748Queues the given scalar to be written. You can push as much data as you 916Queues the given scalar to be written. You can push as much data as
749want (only limited by the available memory), as C<AnyEvent::Handle> 917you want (only limited by the available memory and C<wbuf_max>), as
750buffers it independently of the kernel. 918C<AnyEvent::Handle> buffers it independently of the kernel.
919
920This method may invoke callbacks (and therefore the handle might be
921destroyed after it returns).
751 922
752=cut 923=cut
753 924
754sub _drain_wbuf { 925sub _drain_wbuf {
755 my ($self) = @_; 926 my ($self) = @_;
… …
780 $cb->() unless $self->{autocork}; 951 $cb->() unless $self->{autocork};
781 952
782 # if still data left in wbuf, we need to poll 953 # if still data left in wbuf, we need to poll
783 $self->{_ww} = AE::io $self->{fh}, 1, $cb 954 $self->{_ww} = AE::io $self->{fh}, 1, $cb
784 if length $self->{wbuf}; 955 if length $self->{wbuf};
956
957 if (
958 defined $self->{wbuf_max}
959 && $self->{wbuf_max} < length $self->{wbuf}
960 ) {
961 $self->_error (Errno::ENOSPC, 1), return;
962 }
785 }; 963 };
786} 964}
787 965
788our %WH; 966our %WH;
789 967
968# deprecated
790sub register_write_type($$) { 969sub register_write_type($$) {
791 $WH{$_[0]} = $_[1]; 970 $WH{$_[0]} = $_[1];
792} 971}
793 972
794sub push_write { 973sub push_write {
795 my $self = shift; 974 my $self = shift;
796 975
797 if (@_ > 1) { 976 if (@_ > 1) {
798 my $type = shift; 977 my $type = shift;
799 978
979 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
800 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") 980 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
801 ->($self, @_); 981 ->($self, @_);
802 } 982 }
803 983
984 # we downgrade here to avoid hard-to-track-down bugs,
985 # and diagnose the problem earlier and better.
986
804 if ($self->{tls}) { 987 if ($self->{tls}) {
805 $self->{_tls_wbuf} .= $_[0]; 988 utf8::downgrade $self->{_tls_wbuf} .= $_[0];
806 &_dotls ($self) if $self->{fh}; 989 &_dotls ($self) if $self->{fh};
807 } else { 990 } else {
808 $self->{wbuf} .= $_[0]; 991 utf8::downgrade $self->{wbuf} .= $_[0];
809 $self->_drain_wbuf if $self->{fh}; 992 $self->_drain_wbuf if $self->{fh};
810 } 993 }
811} 994}
812 995
813=item $handle->push_write (type => @args) 996=item $handle->push_write (type => @args)
814 997
815Instead of formatting your data yourself, you can also let this module do 998Instead of formatting your data yourself, you can also let this module
816the job by specifying a type and type-specific arguments. 999do the job by specifying a type and type-specific arguments. You
1000can also specify the (fully qualified) name of a package, in which
1001case AnyEvent tries to load the package and then expects to find the
1002C<anyevent_write_type> function inside (see "custom write types", below).
817 1003
818Predefined types are (if you have ideas for additional types, feel free to 1004Predefined types are (if you have ideas for additional types, feel free to
819drop by and tell us): 1005drop by and tell us):
820 1006
821=over 4 1007=over 4
… …
901=cut 1087=cut
902 1088
903register_write_type storable => sub { 1089register_write_type storable => sub {
904 my ($self, $ref) = @_; 1090 my ($self, $ref) = @_;
905 1091
906 require Storable; 1092 require Storable unless $Storable::VERSION;
907 1093
908 pack "w/a*", Storable::nfreeze ($ref) 1094 pack "w/a*", Storable::nfreeze ($ref)
909}; 1095};
910 1096
911=back 1097=back
… …
916before it was actually written. One way to do that is to replace your 1102before it was actually written. One way to do that is to replace your
917C<on_drain> handler by a callback that shuts down the socket (and set 1103C<on_drain> handler by a callback that shuts down the socket (and set
918C<low_water_mark> to C<0>). This method is a shorthand for just that, and 1104C<low_water_mark> to C<0>). This method is a shorthand for just that, and
919replaces the C<on_drain> callback with: 1105replaces the C<on_drain> callback with:
920 1106
921 sub { shutdown $_[0]{fh}, 1 } # for push_shutdown 1107 sub { shutdown $_[0]{fh}, 1 }
922 1108
923This simply shuts down the write side and signals an EOF condition to the 1109This simply shuts down the write side and signals an EOF condition to the
924the peer. 1110the peer.
925 1111
926You can rely on the normal read queue and C<on_eof> handling 1112You can rely on the normal read queue and C<on_eof> handling
927afterwards. This is the cleanest way to close a connection. 1113afterwards. This is the cleanest way to close a connection.
928 1114
1115This method may invoke callbacks (and therefore the handle might be
1116destroyed after it returns).
1117
929=cut 1118=cut
930 1119
931sub push_shutdown { 1120sub push_shutdown {
932 my ($self) = @_; 1121 my ($self) = @_;
933 1122
934 delete $self->{low_water_mark}; 1123 delete $self->{low_water_mark};
935 $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); 1124 $self->on_drain (sub { shutdown $_[0]{fh}, 1 });
936} 1125}
937 1126
938=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 1127=item custom write types - Package::anyevent_write_type $handle, @args
939 1128
940This function (not method) lets you add your own types to C<push_write>. 1129Instead of one of the predefined types, you can also specify the name of
1130a package. AnyEvent will try to load the package and then expects to find
1131a function named C<anyevent_write_type> inside. If it isn't found, it
1132progressively tries to load the parent package until it either finds the
1133function (good) or runs out of packages (bad).
1134
941Whenever the given C<type> is used, C<push_write> will invoke the code 1135Whenever the given C<type> is used, C<push_write> will the function with
942reference with the handle object and the remaining arguments. 1136the handle object and the remaining arguments.
943 1137
944The code reference is supposed to return a single octet string that will 1138The function is supposed to return a single octet string that will be
945be appended to the write buffer. 1139appended to the write buffer, so you can mentally treat this function as a
1140"arguments to on-the-wire-format" converter.
946 1141
947Note that this is a function, and all types registered this way will be 1142Example: implement a custom write type C<join> that joins the remaining
948global, so try to use unique names. 1143arguments using the first one.
1144
1145 $handle->push_write (My::Type => " ", 1,2,3);
1146
1147 # uses the following package, which can be defined in the "My::Type" or in
1148 # the "My" modules to be auto-loaded, or just about anywhere when the
1149 # My::Type::anyevent_write_type is defined before invoking it.
1150
1151 package My::Type;
1152
1153 sub anyevent_write_type {
1154 my ($handle, $delim, @args) = @_;
1155
1156 join $delim, @args
1157 }
949 1158
950=cut 1159=cut
951 1160
952############################################################################# 1161#############################################################################
953 1162
… …
962ways, the "simple" way, using only C<on_read> and the "complex" way, using 1171ways, the "simple" way, using only C<on_read> and the "complex" way, using
963a queue. 1172a queue.
964 1173
965In the simple case, you just install an C<on_read> callback and whenever 1174In the simple case, you just install an C<on_read> callback and whenever
966new data arrives, it will be called. You can then remove some data (if 1175new data arrives, it will be called. You can then remove some data (if
967enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna 1176enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
968leave the data there if you want to accumulate more (e.g. when only a 1177leave the data there if you want to accumulate more (e.g. when only a
969partial message has been received so far). 1178partial message has been received so far), or change the read queue with
1179e.g. C<push_read>.
970 1180
971In the more complex case, you want to queue multiple callbacks. In this 1181In the more complex case, you want to queue multiple callbacks. In this
972case, AnyEvent::Handle will call the first queued callback each time new 1182case, AnyEvent::Handle will call the first queued callback each time new
973data arrives (also the first time it is queued) and removes it when it has 1183data arrives (also the first time it is queued) and remove it when it has
974done its job (see C<push_read>, below). 1184done its job (see C<push_read>, below).
975 1185
976This way you can, for example, push three line-reads, followed by reading 1186This way you can, for example, push three line-reads, followed by reading
977a chunk of data, and AnyEvent::Handle will execute them in order. 1187a chunk of data, and AnyEvent::Handle will execute them in order.
978 1188
… …
1109 1319
1110This replaces the currently set C<on_read> callback, or clears it (when 1320This replaces the currently set C<on_read> callback, or clears it (when
1111the new callback is C<undef>). See the description of C<on_read> in the 1321the new callback is C<undef>). See the description of C<on_read> in the
1112constructor. 1322constructor.
1113 1323
1324This method may invoke callbacks (and therefore the handle might be
1325destroyed after it returns).
1326
1114=cut 1327=cut
1115 1328
1116sub on_read { 1329sub on_read {
1117 my ($self, $cb) = @_; 1330 my ($self, $cb) = @_;
1118 1331
… …
1120 $self->_drain_rbuf if $cb; 1333 $self->_drain_rbuf if $cb;
1121} 1334}
1122 1335
1123=item $handle->rbuf 1336=item $handle->rbuf
1124 1337
1125Returns the read buffer (as a modifiable lvalue). 1338Returns the read buffer (as a modifiable lvalue). You can also access the
1339read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
1340much faster, and no less clean).
1126 1341
1127You can access the read buffer directly as the C<< ->{rbuf} >> 1342The only operation allowed on the read buffer (apart from looking at it)
1128member, if you want. However, the only operation allowed on the 1343is removing data from its beginning. Otherwise modifying or appending to
1129read buffer (apart from looking at it) is removing data from its 1344it is not allowed and will lead to hard-to-track-down bugs.
1130beginning. Otherwise modifying or appending to it is not allowed and will
1131lead to hard-to-track-down bugs.
1132 1345
1133NOTE: The read buffer should only be used or modified if the C<on_read>, 1346NOTE: The read buffer should only be used or modified in the C<on_read>
1134C<push_read> or C<unshift_read> methods are used. The other read methods 1347callback or when C<push_read> or C<unshift_read> are used with a single
1135automatically manage the read buffer. 1348callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
1349will manage the read buffer on their own.
1136 1350
1137=cut 1351=cut
1138 1352
1139sub rbuf : lvalue { 1353sub rbuf : lvalue {
1140 $_[0]{rbuf} 1354 $_[0]{rbuf}
… …
1157 1371
1158If enough data was available, then the callback must remove all data it is 1372If enough data was available, then the callback must remove all data it is
1159interested in (which can be none at all) and return a true value. After returning 1373interested in (which can be none at all) and return a true value. After returning
1160true, it will be removed from the queue. 1374true, it will be removed from the queue.
1161 1375
1376These methods may invoke callbacks (and therefore the handle might be
1377destroyed after it returns).
1378
1162=cut 1379=cut
1163 1380
1164our %RH; 1381our %RH;
1165 1382
1166sub register_read_type($$) { 1383sub register_read_type($$) {
… …
1172 my $cb = pop; 1389 my $cb = pop;
1173 1390
1174 if (@_) { 1391 if (@_) {
1175 my $type = shift; 1392 my $type = shift;
1176 1393
1394 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1177 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 1395 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1178 ->($self, $cb, @_); 1396 ->($self, $cb, @_);
1179 } 1397 }
1180 1398
1181 push @{ $self->{_queue} }, $cb; 1399 push @{ $self->{_queue} }, $cb;
1182 $self->_drain_rbuf; 1400 $self->_drain_rbuf;
… …
1187 my $cb = pop; 1405 my $cb = pop;
1188 1406
1189 if (@_) { 1407 if (@_) {
1190 my $type = shift; 1408 my $type = shift;
1191 1409
1410 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1192 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 1411 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1193 ->($self, $cb, @_); 1412 ->($self, $cb, @_);
1194 } 1413 }
1195
1196 1414
1197 unshift @{ $self->{_queue} }, $cb; 1415 unshift @{ $self->{_queue} }, $cb;
1198 $self->_drain_rbuf; 1416 $self->_drain_rbuf;
1199} 1417}
1200 1418
… …
1202 1420
1203=item $handle->unshift_read (type => @args, $cb) 1421=item $handle->unshift_read (type => @args, $cb)
1204 1422
1205Instead of providing a callback that parses the data itself you can chose 1423Instead of providing a callback that parses the data itself you can chose
1206between a number of predefined parsing formats, for chunks of data, lines 1424between a number of predefined parsing formats, for chunks of data, lines
1207etc. 1425etc. You can also specify the (fully qualified) name of a package, in
1426which case AnyEvent tries to load the package and then expects to find the
1427C<anyevent_read_type> function inside (see "custom read types", below).
1208 1428
1209Predefined types are (if you have ideas for additional types, feel free to 1429Predefined types are (if you have ideas for additional types, feel free to
1210drop by and tell us): 1430drop by and tell us):
1211 1431
1212=over 4 1432=over 4
… …
1218data. 1438data.
1219 1439
1220Example: read 2 bytes. 1440Example: read 2 bytes.
1221 1441
1222 $handle->push_read (chunk => 2, sub { 1442 $handle->push_read (chunk => 2, sub {
1223 warn "yay ", unpack "H*", $_[1]; 1443 say "yay " . unpack "H*", $_[1];
1224 }); 1444 });
1225 1445
1226=cut 1446=cut
1227 1447
1228register_read_type chunk => sub { 1448register_read_type chunk => sub {
… …
1262 if (@_ < 3) { 1482 if (@_ < 3) {
1263 # this is more than twice as fast as the generic code below 1483 # this is more than twice as fast as the generic code below
1264 sub { 1484 sub {
1265 $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; 1485 $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
1266 1486
1267 $cb->($_[0], $1, $2); 1487 $cb->($_[0], "$1", "$2");
1268 1 1488 1
1269 } 1489 }
1270 } else { 1490 } else {
1271 $eol = quotemeta $eol unless ref $eol; 1491 $eol = quotemeta $eol unless ref $eol;
1272 $eol = qr|^(.*?)($eol)|s; 1492 $eol = qr|^(.*?)($eol)|s;
1273 1493
1274 sub { 1494 sub {
1275 $_[0]{rbuf} =~ s/$eol// or return; 1495 $_[0]{rbuf} =~ s/$eol// or return;
1276 1496
1277 $cb->($_[0], $1, $2); 1497 $cb->($_[0], "$1", "$2");
1278 1 1498 1
1279 } 1499 }
1280 } 1500 }
1281}; 1501};
1282 1502
… …
1304the receive buffer when neither C<$accept> nor C<$reject> match, 1524the receive buffer when neither C<$accept> nor C<$reject> match,
1305and everything preceding and including the match will be accepted 1525and everything preceding and including the match will be accepted
1306unconditionally. This is useful to skip large amounts of data that you 1526unconditionally. This is useful to skip large amounts of data that you
1307know cannot be matched, so that the C<$accept> or C<$reject> regex do not 1527know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1308have to start matching from the beginning. This is purely an optimisation 1528have to start matching from the beginning. This is purely an optimisation
1309and is usually worth only when you expect more than a few kilobytes. 1529and is usually worth it only when you expect more than a few kilobytes.
1310 1530
1311Example: expect a http header, which ends at C<\015\012\015\012>. Since we 1531Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1312expect the header to be very large (it isn't in practise, but...), we use 1532expect the header to be very large (it isn't in practice, but...), we use
1313a skip regex to skip initial portions. The skip regex is tricky in that 1533a skip regex to skip initial portions. The skip regex is tricky in that
1314it only accepts something not ending in either \015 or \012, as these are 1534it only accepts something not ending in either \015 or \012, as these are
1315required for the accept regex. 1535required for the accept regex.
1316 1536
1317 $handle->push_read (regex => 1537 $handle->push_read (regex =>
… …
1330 1550
1331 sub { 1551 sub {
1332 # accept 1552 # accept
1333 if ($$rbuf =~ $accept) { 1553 if ($$rbuf =~ $accept) {
1334 $data .= substr $$rbuf, 0, $+[0], ""; 1554 $data .= substr $$rbuf, 0, $+[0], "";
1335 $cb->($self, $data); 1555 $cb->($_[0], $data);
1336 return 1; 1556 return 1;
1337 } 1557 }
1338 1558
1339 # reject 1559 # reject
1340 if ($reject && $$rbuf =~ $reject) { 1560 if ($reject && $$rbuf =~ $reject) {
1341 $self->_error (Errno::EBADMSG); 1561 $_[0]->_error (Errno::EBADMSG);
1342 } 1562 }
1343 1563
1344 # skip 1564 # skip
1345 if ($skip && $$rbuf =~ $skip) { 1565 if ($skip && $$rbuf =~ $skip) {
1346 $data .= substr $$rbuf, 0, $+[0], ""; 1566 $data .= substr $$rbuf, 0, $+[0], "";
… …
1362 my ($self, $cb) = @_; 1582 my ($self, $cb) = @_;
1363 1583
1364 sub { 1584 sub {
1365 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { 1585 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1366 if ($_[0]{rbuf} =~ /[^0-9]/) { 1586 if ($_[0]{rbuf} =~ /[^0-9]/) {
1367 $self->_error (Errno::EBADMSG); 1587 $_[0]->_error (Errno::EBADMSG);
1368 } 1588 }
1369 return; 1589 return;
1370 } 1590 }
1371 1591
1372 my $len = $1; 1592 my $len = $1;
1373 1593
1374 $self->unshift_read (chunk => $len, sub { 1594 $_[0]->unshift_read (chunk => $len, sub {
1375 my $string = $_[1]; 1595 my $string = $_[1];
1376 $_[0]->unshift_read (chunk => 1, sub { 1596 $_[0]->unshift_read (chunk => 1, sub {
1377 if ($_[1] eq ",") { 1597 if ($_[1] eq ",") {
1378 $cb->($_[0], $string); 1598 $cb->($_[0], $string);
1379 } else { 1599 } else {
1380 $self->_error (Errno::EBADMSG); 1600 $_[0]->_error (Errno::EBADMSG);
1381 } 1601 }
1382 }); 1602 });
1383 }); 1603 });
1384 1604
1385 1 1605 1
… …
1458 1678
1459 my $data; 1679 my $data;
1460 my $rbuf = \$self->{rbuf}; 1680 my $rbuf = \$self->{rbuf};
1461 1681
1462 sub { 1682 sub {
1463 my $ref = eval { $json->incr_parse ($self->{rbuf}) }; 1683 my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1464 1684
1465 if ($ref) { 1685 if ($ref) {
1466 $self->{rbuf} = $json->incr_text; 1686 $_[0]{rbuf} = $json->incr_text;
1467 $json->incr_text = ""; 1687 $json->incr_text = "";
1468 $cb->($self, $ref); 1688 $cb->($_[0], $ref);
1469 1689
1470 1 1690 1
1471 } elsif ($@) { 1691 } elsif ($@) {
1472 # error case 1692 # error case
1473 $json->incr_skip; 1693 $json->incr_skip;
1474 1694
1475 $self->{rbuf} = $json->incr_text; 1695 $_[0]{rbuf} = $json->incr_text;
1476 $json->incr_text = ""; 1696 $json->incr_text = "";
1477 1697
1478 $self->_error (Errno::EBADMSG); 1698 $_[0]->_error (Errno::EBADMSG);
1479 1699
1480 () 1700 ()
1481 } else { 1701 } else {
1482 $self->{rbuf} = ""; 1702 $_[0]{rbuf} = "";
1483 1703
1484 () 1704 ()
1485 } 1705 }
1486 } 1706 }
1487}; 1707};
… …
1497=cut 1717=cut
1498 1718
1499register_read_type storable => sub { 1719register_read_type storable => sub {
1500 my ($self, $cb) = @_; 1720 my ($self, $cb) = @_;
1501 1721
1502 require Storable; 1722 require Storable unless $Storable::VERSION;
1503 1723
1504 sub { 1724 sub {
1505 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method 1725 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1506 defined (my $len = eval { unpack "w", $_[0]{rbuf} }) 1726 defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1507 or return; 1727 or return;
… …
1520 # read remaining chunk 1740 # read remaining chunk
1521 $_[0]->unshift_read (chunk => $len, sub { 1741 $_[0]->unshift_read (chunk => $len, sub {
1522 if (my $ref = eval { Storable::thaw ($_[1]) }) { 1742 if (my $ref = eval { Storable::thaw ($_[1]) }) {
1523 $cb->($_[0], $ref); 1743 $cb->($_[0], $ref);
1524 } else { 1744 } else {
1525 $self->_error (Errno::EBADMSG); 1745 $_[0]->_error (Errno::EBADMSG);
1526 } 1746 }
1527 }); 1747 });
1528 } 1748 }
1529 1749
1530 1 1750 1
1531 } 1751 }
1532}; 1752};
1533 1753
1534=back 1754=back
1535 1755
1536=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) 1756=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1537 1757
1538This function (not method) lets you add your own types to C<push_read>. 1758Instead of one of the predefined types, you can also specify the name
1759of a package. AnyEvent will try to load the package and then expects to
1760find a function named C<anyevent_read_type> inside. If it isn't found, it
1761progressively tries to load the parent package until it either finds the
1762function (good) or runs out of packages (bad).
1539 1763
1540Whenever the given C<type> is used, C<push_read> will invoke the code 1764Whenever this type is used, C<push_read> will invoke the function with the
1541reference with the handle object, the callback and the remaining 1765handle object, the original callback and the remaining arguments.
1542arguments.
1543 1766
1544The code reference is supposed to return a callback (usually a closure) 1767The function is supposed to return a callback (usually a closure) that
1545that works as a plain read callback (see C<< ->push_read ($cb) >>). 1768works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
1769mentally treat the function as a "configurable read type to read callback"
1770converter.
1546 1771
1547It should invoke the passed callback when it is done reading (remember to 1772It should invoke the original callback when it is done reading (remember
1548pass C<$handle> as first argument as all other callbacks do that). 1773to pass C<$handle> as first argument as all other callbacks do that,
1774although there is no strict requirement on this).
1549 1775
1550Note that this is a function, and all types registered this way will be
1551global, so try to use unique names.
1552
1553For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, 1776For examples, see the source of this module (F<perldoc -m
1554search for C<register_read_type>)). 1777AnyEvent::Handle>, search for C<register_read_type>)).
1555 1778
1556=item $handle->stop_read 1779=item $handle->stop_read
1557 1780
1558=item $handle->start_read 1781=item $handle->start_read
1559 1782
… …
1565Note that AnyEvent::Handle will automatically C<start_read> for you when 1788Note that AnyEvent::Handle will automatically C<start_read> for you when
1566you change the C<on_read> callback or push/unshift a read callback, and it 1789you change the C<on_read> callback or push/unshift a read callback, and it
1567will automatically C<stop_read> for you when neither C<on_read> is set nor 1790will automatically C<stop_read> for you when neither C<on_read> is set nor
1568there are any read requests in the queue. 1791there are any read requests in the queue.
1569 1792
1570These methods will have no effect when in TLS mode (as TLS doesn't support 1793In older versions of this module (<= 5.3), these methods had no effect,
1571half-duplex connections). 1794as TLS does not support half-duplex connections. In current versions they
1795work as expected, as this behaviour is required to avoid certain resource
1796attacks, where the program would be forced to read (and buffer) arbitrary
1797amounts of data before being able to send some data. The drawback is that
1798some readings of the the SSL/TLS specifications basically require this
1799attack to be working, as SSL/TLS implementations might stall sending data
1800during a rehandshake.
1801
1802As a guideline, during the initial handshake, you should not stop reading,
1803and as a client, it might cause problems, depending on your application.
1572 1804
1573=cut 1805=cut
1574 1806
1575sub stop_read { 1807sub stop_read {
1576 my ($self) = @_; 1808 my ($self) = @_;
1577 1809
1578 delete $self->{_rw} unless $self->{tls}; 1810 delete $self->{_rw};
1579} 1811}
1580 1812
1581sub start_read { 1813sub start_read {
1582 my ($self) = @_; 1814 my ($self) = @_;
1583 1815
1584 unless ($self->{_rw} || $self->{_eof}) { 1816 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1585 Scalar::Util::weaken $self; 1817 Scalar::Util::weaken $self;
1586 1818
1587 $self->{_rw} = AE::io $self->{fh}, 0, sub { 1819 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1588 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1820 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1589 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1821 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1590 1822
1591 if ($len > 0) { 1823 if ($len > 0) {
1592 $self->{_activity} = $self->{_ractivity} = AE::now; 1824 $self->{_activity} = $self->{_ractivity} = AE::now;
1593 1825
1594 if ($self->{tls}) { 1826 if ($self->{tls}) {
1595 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1827 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1596 1828
1597 &_dotls ($self); 1829 &_dotls ($self);
1598 } else { 1830 } else {
1599 $self->_drain_rbuf; 1831 $self->_drain_rbuf;
1832 }
1833
1834 if ($len == $self->{read_size}) {
1835 $self->{read_size} *= 2;
1836 $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
1837 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1600 } 1838 }
1601 1839
1602 } elsif (defined $len) { 1840 } elsif (defined $len) {
1603 delete $self->{_rw}; 1841 delete $self->{_rw};
1604 $self->{_eof} = 1; 1842 $self->{_eof} = 1;
… …
1682 && ($tmp != $ERROR_SYSCALL || $!); 1920 && ($tmp != $ERROR_SYSCALL || $!);
1683 1921
1684 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1922 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1685 $self->{wbuf} .= $tmp; 1923 $self->{wbuf} .= $tmp;
1686 $self->_drain_wbuf; 1924 $self->_drain_wbuf;
1925 $self->{tls} or return; # tls session might have gone away in callback
1687 } 1926 }
1688 1927
1689 $self->{_on_starttls} 1928 $self->{_on_starttls}
1690 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () 1929 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1691 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); 1930 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
… …
1713context in C<< $handle->{tls_ctx} >> after this call and can be used or 1952context in C<< $handle->{tls_ctx} >> after this call and can be used or
1714changed to your liking. Note that the handshake might have already started 1953changed to your liking. Note that the handshake might have already started
1715when this function returns. 1954when this function returns.
1716 1955
1717Due to bugs in OpenSSL, it might or might not be possible to do multiple 1956Due to bugs in OpenSSL, it might or might not be possible to do multiple
1718handshakes on the same stream. Best do not attempt to use the stream after 1957handshakes on the same stream. It is best to not attempt to use the
1719stopping TLS. 1958stream after stopping TLS.
1959
1960This method may invoke callbacks (and therefore the handle might be
1961destroyed after it returns).
1720 1962
1721=cut 1963=cut
1722 1964
1723our %TLS_CACHE; #TODO not yet documented, should we? 1965our %TLS_CACHE; #TODO not yet documented, should we?
1724 1966
… …
1775 Net::SSLeay::CTX_set_mode ($tls, 1|2); 2017 Net::SSLeay::CTX_set_mode ($tls, 1|2);
1776 2018
1777 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 2019 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1778 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 2020 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1779 2021
1780 Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); 2022 Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
2023 $self->{rbuf} = "";
1781 2024
1782 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); 2025 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1783 2026
1784 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } 2027 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1785 if $self->{on_starttls}; 2028 if $self->{on_starttls};
… …
1790 2033
1791=item $handle->stoptls 2034=item $handle->stoptls
1792 2035
1793Shuts down the SSL connection - this makes a proper EOF handshake by 2036Shuts down the SSL connection - this makes a proper EOF handshake by
1794sending a close notify to the other side, but since OpenSSL doesn't 2037sending a close notify to the other side, but since OpenSSL doesn't
1795support non-blocking shut downs, it is not guarenteed that you can re-use 2038support non-blocking shut downs, it is not guaranteed that you can re-use
1796the stream afterwards. 2039the stream afterwards.
2040
2041This method may invoke callbacks (and therefore the handle might be
2042destroyed after it returns).
1797 2043
1798=cut 2044=cut
1799 2045
1800sub stoptls { 2046sub stoptls {
1801 my ($self) = @_; 2047 my ($self) = @_;
1802 2048
1803 if ($self->{tls}) { 2049 if ($self->{tls} && $self->{fh}) {
1804 Net::SSLeay::shutdown ($self->{tls}); 2050 Net::SSLeay::shutdown ($self->{tls});
1805 2051
1806 &_dotls; 2052 &_dotls;
1807 2053
1808# # we don't give a shit. no, we do, but we can't. no...#d# 2054# # we don't give a shit. no, we do, but we can't. no...#d#
… …
1820 if $self->{tls} > 0; 2066 if $self->{tls} > 0;
1821 2067
1822 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; 2068 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1823} 2069}
1824 2070
2071=item $handle->resettls
2072
2073This rarely-used method simply resets and TLS state on the handle, usually
2074causing data loss.
2075
2076One case where it may be useful is when you want to skip over the data in
2077the stream but you are not interested in interpreting it, so data loss is
2078no concern.
2079
2080=cut
2081
2082*resettls = \&_freetls;
2083
1825sub DESTROY { 2084sub DESTROY {
1826 my ($self) = @_; 2085 my ($self) = @_;
1827 2086
1828 &_freetls; 2087 &_freetls;
1829 2088
… …
1838 push @linger, AE::io $fh, 1, sub { 2097 push @linger, AE::io $fh, 1, sub {
1839 my $len = syswrite $fh, $wbuf, length $wbuf; 2098 my $len = syswrite $fh, $wbuf, length $wbuf;
1840 2099
1841 if ($len > 0) { 2100 if ($len > 0) {
1842 substr $wbuf, 0, $len, ""; 2101 substr $wbuf, 0, $len, "";
1843 } else { 2102 } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1844 @linger = (); # end 2103 @linger = (); # end
1845 } 2104 }
1846 }; 2105 };
1847 push @linger, AE::timer $linger, 0, sub { 2106 push @linger, AE::timer $linger, 0, sub {
1848 @linger = (); 2107 @linger = ();
… …
1885 2144
1886sub AnyEvent::Handle::destroyed::AUTOLOAD { 2145sub AnyEvent::Handle::destroyed::AUTOLOAD {
1887 #nop 2146 #nop
1888} 2147}
1889 2148
2149=item $handle->destroyed
2150
2151Returns false as long as the handle hasn't been destroyed by a call to C<<
2152->destroy >>, true otherwise.
2153
2154Can be useful to decide whether the handle is still valid after some
2155callback possibly destroyed the handle. For example, C<< ->push_write >>,
2156C<< ->starttls >> and other methods can call user callbacks, which in turn
2157can destroy the handle, so work can be avoided by checking sometimes:
2158
2159 $hdl->starttls ("accept");
2160 return if $hdl->destroyed;
2161 $hdl->push_write (...
2162
2163Note that the call to C<push_write> will silently be ignored if the handle
2164has been destroyed, so often you can just ignore the possibility of the
2165handle being destroyed.
2166
2167=cut
2168
2169sub destroyed { 0 }
2170sub AnyEvent::Handle::destroyed::destroyed { 1 }
2171
1890=item AnyEvent::Handle::TLS_CTX 2172=item AnyEvent::Handle::TLS_CTX
1891 2173
1892This function creates and returns the AnyEvent::TLS object used by default 2174This function creates and returns the AnyEvent::TLS object used by default
1893for TLS mode. 2175for TLS mode.
1894 2176
… …
1921 2203
1922It is only safe to "forget" the reference inside EOF or error callbacks, 2204It is only safe to "forget" the reference inside EOF or error callbacks,
1923from within all other callbacks, you need to explicitly call the C<< 2205from within all other callbacks, you need to explicitly call the C<<
1924->destroy >> method. 2206->destroy >> method.
1925 2207
2208=item Why is my C<on_eof> callback never called?
2209
2210Probably because your C<on_error> callback is being called instead: When
2211you have outstanding requests in your read queue, then an EOF is
2212considered an error as you clearly expected some data.
2213
2214To avoid this, make sure you have an empty read queue whenever your handle
2215is supposed to be "idle" (i.e. connection closes are O.K.). You can set
2216an C<on_read> handler that simply pushes the first read requests in the
2217queue.
2218
2219See also the next question, which explains this in a bit more detail.
2220
2221=item How can I serve requests in a loop?
2222
2223Most protocols consist of some setup phase (authentication for example)
2224followed by a request handling phase, where the server waits for requests
2225and handles them, in a loop.
2226
2227There are two important variants: The first (traditional, better) variant
2228handles requests until the server gets some QUIT command, causing it to
2229close the connection first (highly desirable for a busy TCP server). A
2230client dropping the connection is an error, which means this variant can
2231detect an unexpected detection close.
2232
2233To handle this case, always make sure you have a on-empty read queue, by
2234pushing the "read request start" handler on it:
2235
2236 # we assume a request starts with a single line
2237 my @start_request; @start_request = (line => sub {
2238 my ($hdl, $line) = @_;
2239
2240 ... handle request
2241
2242 # push next request read, possibly from a nested callback
2243 $hdl->push_read (@start_request);
2244 });
2245
2246 # auth done, now go into request handling loop
2247 # now push the first @start_request
2248 $hdl->push_read (@start_request);
2249
2250By always having an outstanding C<push_read>, the handle always expects
2251some data and raises the C<EPIPE> error when the connction is dropped
2252unexpectedly.
2253
2254The second variant is a protocol where the client can drop the connection
2255at any time. For TCP, this means that the server machine may run out of
2256sockets easier, and in general, it means you cannot distinguish a protocl
2257failure/client crash from a normal connection close. Nevertheless, these
2258kinds of protocols are common (and sometimes even the best solution to the
2259problem).
2260
2261Having an outstanding read request at all times is possible if you ignore
2262C<EPIPE> errors, but this doesn't help with when the client drops the
2263connection during a request, which would still be an error.
2264
2265A better solution is to push the initial request read in an C<on_read>
2266callback. This avoids an error, as when the server doesn't expect data
2267(i.e. is idly waiting for the next request, an EOF will not raise an
2268error, but simply result in an C<on_eof> callback. It is also a bit slower
2269and simpler:
2270
2271 # auth done, now go into request handling loop
2272 $hdl->on_read (sub {
2273 my ($hdl) = @_;
2274
2275 # called each time we receive data but the read queue is empty
2276 # simply start read the request
2277
2278 $hdl->push_read (line => sub {
2279 my ($hdl, $line) = @_;
2280
2281 ... handle request
2282
2283 # do nothing special when the request has been handled, just
2284 # let the request queue go empty.
2285 });
2286 });
2287
1926=item I get different callback invocations in TLS mode/Why can't I pause 2288=item I get different callback invocations in TLS mode/Why can't I pause
1927reading? 2289reading?
1928 2290
1929Unlike, say, TCP, TLS connections do not consist of two independent 2291Unlike, say, TCP, TLS connections do not consist of two independent
1930communication channels, one for each direction. Or put differently. The 2292communication channels, one for each direction. Or put differently, the
1931read and write directions are not independent of each other: you cannot 2293read and write directions are not independent of each other: you cannot
1932write data unless you are also prepared to read, and vice versa. 2294write data unless you are also prepared to read, and vice versa.
1933 2295
1934This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> 2296This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1935callback invocations when you are not expecting any read data - the reason 2297callback invocations when you are not expecting any read data - the reason
1936is that AnyEvent::Handle always reads in TLS mode. 2298is that AnyEvent::Handle always reads in TLS mode.
1937 2299
1938During the connection, you have to make sure that you always have a 2300During the connection, you have to make sure that you always have a
1939non-empty read-queue, or an C<on_read> watcher. At the end of the 2301non-empty read-queue, or an C<on_read> watcher. At the end of the
… …
1951 $handle->on_eof (undef); 2313 $handle->on_eof (undef);
1952 $handle->on_error (sub { 2314 $handle->on_error (sub {
1953 my $data = delete $_[0]{rbuf}; 2315 my $data = delete $_[0]{rbuf};
1954 }); 2316 });
1955 2317
2318Note that this example removes the C<rbuf> member from the handle object,
2319which is not normally allowed by the API. It is expressly permitted in
2320this case only, as the handle object needs to be destroyed afterwards.
2321
1956The reason to use C<on_error> is that TCP connections, due to latencies 2322The reason to use C<on_error> is that TCP connections, due to latencies
1957and packets loss, might get closed quite violently with an error, when in 2323and packets loss, might get closed quite violently with an error, when in
1958fact, all data has been received. 2324fact all data has been received.
1959 2325
1960It is usually better to use acknowledgements when transferring data, 2326It is usually better to use acknowledgements when transferring data,
1961to make sure the other side hasn't just died and you got the data 2327to make sure the other side hasn't just died and you got the data
1962intact. This is also one reason why so many internet protocols have an 2328intact. This is also one reason why so many internet protocols have an
1963explicit QUIT command. 2329explicit QUIT command.
… …
1970C<low_water_mark> this will be called precisely when all data has been 2336C<low_water_mark> this will be called precisely when all data has been
1971written to the socket: 2337written to the socket:
1972 2338
1973 $handle->push_write (...); 2339 $handle->push_write (...);
1974 $handle->on_drain (sub { 2340 $handle->on_drain (sub {
1975 warn "all data submitted to the kernel\n"; 2341 AE::log debug => "all data submitted to the kernel\n";
1976 undef $handle; 2342 undef $handle;
1977 }); 2343 });
1978 2344
1979If you just want to queue some data and then signal EOF to the other side, 2345If you just want to queue some data and then signal EOF to the other side,
1980consider using C<< ->push_shutdown >> instead. 2346consider using C<< ->push_shutdown >> instead.
1981 2347
1982=item I want to contact a TLS/SSL server, I don't care about security. 2348=item I want to contact a TLS/SSL server, I don't care about security.
1983 2349
1984If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, 2350If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1985simply connect to it and then create the AnyEvent::Handle with the C<tls> 2351connect to it and then create the AnyEvent::Handle with the C<tls>
1986parameter: 2352parameter:
1987 2353
1988 tcp_connect $host, $port, sub { 2354 tcp_connect $host, $port, sub {
1989 my ($fh) = @_; 2355 my ($fh) = @_;
1990 2356
… …
2090 2456
2091=item * all members not documented here and not prefixed with an underscore 2457=item * all members not documented here and not prefixed with an underscore
2092are free to use in subclasses. 2458are free to use in subclasses.
2093 2459
2094Of course, new versions of AnyEvent::Handle may introduce more "public" 2460Of course, new versions of AnyEvent::Handle may introduce more "public"
2095member variables, but thats just life, at least it is documented. 2461member variables, but that's just life. At least it is documented.
2096 2462
2097=back 2463=back
2098 2464
2099=head1 AUTHOR 2465=head1 AUTHOR
2100 2466

Diff Legend

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