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.174 by root, Sat Aug 8 20:52:06 2009 UTC vs.
Revision 1.243 by root, Mon Mar 16 08:15:46 2015 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.91;
17 4
18=head1 SYNOPSIS 5=head1 SYNOPSIS
19 6
20 use AnyEvent; 7 use AnyEvent;
21 use AnyEvent::Handle; 8 use AnyEvent::Handle;
24 11
25 my $hdl; $hdl = new AnyEvent::Handle 12 my $hdl; $hdl = new AnyEvent::Handle
26 fh => \*STDIN, 13 fh => \*STDIN,
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 AE::log error => $msg;
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
38 $hdl->push_read (line => sub { 25 $hdl->push_read (line => sub {
39 my ($hdl, $line) = @_; 26 my ($hdl, $line) = @_;
40 warn "got line <$line>\n"; 27 say "got line <$line>";
41 $cv->send; 28 $cv->send;
42 }); 29 });
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 EWOULDBLOCK 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. 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.
116 136
117When, for some reason, the handle is not acceptable, then calling 137If, for some reason, the handle is not acceptable, calling C<$retry> will
118C<$retry> will continue with the next conenction target (in case of 138continue with the next connection target (in case of multi-homed hosts or
119multi-homed hosts or SRV records there can be multiple connection 139SRV records there can be multiple connection endpoints). The C<$retry>
120endpoints). When it is called then the read and write queues, eof status, 140callback can be invoked after the connect callback returns, i.e. one can
121tls status and similar properties of the handle are being reset. 141start a handshake and then decide to retry with the next host if the
142handshake fails.
122 143
123In most cases, ignoring the C<$retry> parameter is the way to go. 144In most cases, you should ignore the C<$retry> parameter.
124 145
125=item on_connect_error => $cb->($handle, $message) 146=item on_connect_error => $cb->($handle, $message)
126 147
127This callback is called when the conenction could not be 148This callback is called when the connection could not be
128established. C<$!> will contain the relevant error code, and C<$message> a 149established. C<$!> will contain the relevant error code, and C<$message> a
129message describing it (usually the same as C<"$!">). 150message describing it (usually the same as C<"$!">).
130 151
131If this callback isn't specified, then C<on_error> will be called with a 152If this callback isn't specified, then C<on_error> will be called with a
132fatal error instead. 153fatal error instead.
135 156
136=item on_error => $cb->($handle, $fatal, $message) 157=item on_error => $cb->($handle, $fatal, $message)
137 158
138This is the error callback, which is called when, well, some error 159This is the error callback, which is called when, well, some error
139occured, such as not being able to resolve the hostname, failure to 160occured, such as not being able to resolve the hostname, failure to
140connect or a read error. 161connect, or a read error.
141 162
142Some errors are fatal (which is indicated by C<$fatal> being true). On 163Some 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<< -> 164fatal errors the handle object will be destroyed (by a call to C<< ->
144destroy >>) after invoking the error callback (which means you are free to 165destroy >>) after invoking the error callback (which means you are free to
145examine the handle object). Examples of fatal errors are an EOF condition 166examine the handle object). Examples of fatal errors are an EOF condition
146with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In 167with 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 168cases where the other side can close the connection at will, it is
148often easiest to not report C<EPIPE> errors in this callback. 169often easiest to not report C<EPIPE> errors in this callback.
149 170
150AnyEvent::Handle tries to find an appropriate error code for you to check 171AnyEvent::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 172against, but in some cases (TLS errors), this does not work well.
152recommended to always output the C<$message> argument in human-readable
153error messages (it's usually the same as C<"$!">).
154 173
174If you report the error to the user, it is recommended to always output
175the C<$message> argument in human-readable error messages (you don't need
176to report C<"$!"> if you report C<$message>).
177
178If you want to react programmatically to the error, then looking at C<$!>
179and comparing it against some of the documented C<Errno> values is usually
180better than looking at the C<$message>.
181
155Non-fatal errors can be retried by simply returning, but it is recommended 182Non-fatal errors can be retried by returning, but it is recommended
156to simply ignore this parameter and instead abondon the handle object 183to simply ignore this parameter and instead abondon the handle object
157when this callback is invoked. Examples of non-fatal errors are timeouts 184when this callback is invoked. Examples of non-fatal errors are timeouts
158C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 185C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
159 186
160On callback entrance, the value of C<$!> contains the operating system 187On entry to the callback, the value of C<$!> contains the operating
161error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or 188system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
162C<EPROTO>). 189C<EPROTO>).
163 190
164While not mandatory, it is I<highly> recommended to set this callback, as 191While not mandatory, it is I<highly> recommended to set this callback, as
165you will not be notified of errors otherwise. The default simply calls 192you will not be notified of errors otherwise. The default just calls
166C<croak>. 193C<croak>.
167 194
168=item on_read => $cb->($handle) 195=item on_read => $cb->($handle)
169 196
170This sets the default read callback, which is called when data arrives 197This sets the default read callback, which is called when data arrives
175To access (and remove data from) the read buffer, use the C<< ->rbuf >> 202To access (and remove data from) the read buffer, use the C<< ->rbuf >>
176method or access the C<< $handle->{rbuf} >> member directly. Note that you 203method 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 204must not enlarge or modify the read buffer, you can only remove data at
178the beginning from it. 205the beginning from it.
179 206
207You can also call C<< ->push_read (...) >> or any other function that
208modifies the read queue. Or do both. Or ...
209
180When an EOF condition is detected then AnyEvent::Handle will first try to 210When 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 211feed 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 212calling the C<on_eof> callback. If no progress can be made, then a fatal
183error will be raised (with C<$!> set to C<EPIPE>). 213error will be raised (with C<$!> set to C<EPIPE>).
184 214
185Note that, unlike requests in the read queue, an C<on_read> callback 215Note that, unlike requests in the read queue, an C<on_read> callback
203If an EOF condition has been detected but no C<on_eof> callback has been 233If an EOF condition has been detected but no C<on_eof> callback has been
204set, then a fatal error will be raised with C<$!> set to <0>. 234set, then a fatal error will be raised with C<$!> set to <0>.
205 235
206=item on_drain => $cb->($handle) 236=item on_drain => $cb->($handle)
207 237
208This sets the callback that is called when the write buffer becomes empty 238This sets the callback that is called once when the write buffer becomes
209(or when the callback is set and the buffer is empty already). 239empty (and immediately when the handle object is created).
210 240
211To append to the write buffer, use the C<< ->push_write >> method. 241To append to the write buffer, use the C<< ->push_write >> method.
212 242
213This callback is useful when you don't want to put all of your write data 243This 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 244into 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 246memory and push it into the queue, but instead only read more data from
217the file when the write queue becomes empty. 247the file when the write queue becomes empty.
218 248
219=item timeout => $fractional_seconds 249=item timeout => $fractional_seconds
220 250
251=item rtimeout => $fractional_seconds
252
253=item wtimeout => $fractional_seconds
254
221If non-zero, then this enables an "inactivity" timeout: whenever this many 255If non-zero, then these enables an "inactivity" timeout: whenever this
222seconds pass without a successful read or write on the underlying file 256many 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 257file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
224missing, a non-fatal C<ETIMEDOUT> error will be raised). 258will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
259error will be raised).
225 260
261There are three variants of the timeouts that work independently of each
262other, for both read and write (triggered when nothing was read I<OR>
263written), just read (triggered when nothing was read), and just write:
264C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
265C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
266C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
267
226Note that timeout processing is also active when you currently do not have 268Note that timeout processing is active even when you do not have any
227any outstanding read or write requests: If you plan to keep the connection 269outstanding read or write requests: If you plan to keep the connection
228idle then you should disable the timout temporarily or ignore the timeout 270idle then you should disable the timeout temporarily or ignore the
229in the C<on_timeout> callback, in which case AnyEvent::Handle will simply 271timeout in the corresponding C<on_timeout> callback, in which case
230restart the timeout. 272AnyEvent::Handle will simply restart the timeout.
231 273
232Zero (the default) disables this timeout. 274Zero (the default) disables the corresponding timeout.
233 275
234=item on_timeout => $cb->($handle) 276=item on_timeout => $cb->($handle)
277
278=item on_rtimeout => $cb->($handle)
279
280=item on_wtimeout => $cb->($handle)
235 281
236Called whenever the inactivity timeout passes. If you return from this 282Called whenever the inactivity timeout passes. If you return from this
237callback, then the timeout will be reset as if some activity had happened, 283callback, then the timeout will be reset as if some activity had happened,
238so this condition is not fatal in any way. 284so this condition is not fatal in any way.
239 285
247be configured to accept only so-and-so much data that it cannot act on 293be 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 294(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 295amount of data without a callback ever being called as long as the line
250isn't finished). 296isn't finished).
251 297
298=item wbuf_max => <bytes>
299
300If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
301when the write buffer ever (strictly) exceeds this size. This is useful to
302avoid some forms of denial-of-service attacks.
303
304Although the units of this parameter is bytes, this is the I<raw> number
305of bytes not yet accepted by the kernel. This can make a difference when
306you e.g. use TLS, as TLS typically makes your write data larger (but it
307can also make it smaller due to compression).
308
309As an example of when this limit is useful, take a chat server that sends
310chat messages to a client. If the client does not read those in a timely
311manner then the send buffer in the server would grow unbounded.
312
252=item autocork => <boolean> 313=item autocork => <boolean>
253 314
254When disabled (the default), then C<push_write> will try to immediately 315When disabled (the default), C<push_write> will try to immediately
255write the data to the handle, if possible. This avoids having to register 316write 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 317a write watcher and wait for the next event loop iteration, but can
257be inefficient if you write multiple small chunks (on the wire, this 318be inefficient if you write multiple small chunks (on the wire, this
258disadvantage is usually avoided by your kernel's nagle algorithm, see 319disadvantage is usually avoided by your kernel's nagle algorithm, see
259C<no_delay>, but this option can save costly syscalls). 320C<no_delay>, but this option can save costly syscalls).
260 321
261When enabled, then writes will always be queued till the next event loop 322When enabled, writes will always be queued till the next event loop
262iteration. This is efficient when you do many small writes per iteration, 323iteration. 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 324but less efficient when you do a single write only per iteration (or when
264the write buffer often is full). It also increases write latency. 325the write buffer often is full). It also increases write latency.
265 326
266=item no_delay => <boolean> 327=item no_delay => <boolean>
270the Nagle algorithm, and usually it is beneficial. 331the Nagle algorithm, and usually it is beneficial.
271 332
272In some situations you want as low a delay as possible, which can be 333In some situations you want as low a delay as possible, which can be
273accomplishd by setting this option to a true value. 334accomplishd by setting this option to a true value.
274 335
275The default is your opertaing system's default behaviour (most likely 336The default is your operating system's default behaviour (most likely
276enabled), this option explicitly enables or disables it, if possible. 337enabled). This option explicitly enables or disables it, if possible.
338
339=item keepalive => <boolean>
340
341Enables (default disable) the SO_KEEPALIVE option on the stream socket:
342normally, TCP connections have no time-out once established, so TCP
343connections, once established, can stay alive forever even when the other
344side has long gone. TCP keepalives are a cheap way to take down long-lived
345TCP connections when the other side becomes unreachable. While the default
346is OS-dependent, TCP keepalives usually kick in after around two hours,
347and, if the other side doesn't reply, take down the TCP connection some 10
348to 15 minutes later.
349
350It is harmless to specify this option for file handles that do not support
351keepalives, and enabling it on connections that are potentially long-lived
352is usually a good idea.
353
354=item oobinline => <boolean>
355
356BSD majorly fucked up the implementation of TCP urgent data. The result
357is that almost no OS implements TCP according to the specs, and every OS
358implements it slightly differently.
359
360If you want to handle TCP urgent data, then setting this flag (the default
361is enabled) gives you the most portable way of getting urgent data, by
362putting it into the stream.
363
364Since BSD emulation of OOB data on top of TCP's urgent data can have
365security implications, AnyEvent::Handle sets this flag automatically
366unless explicitly specified. Note that setting this flag after
367establishing a connection I<may> be a bit too late (data loss could
368already have occured on BSD systems), but at least it will protect you
369from most attacks.
277 370
278=item read_size => <bytes> 371=item read_size => <bytes>
279 372
280The default read block size (the amount of bytes this module will 373The initial read block size, the number of bytes this module will try
281try to read during each loop iteration, which affects memory 374to read during each loop iteration. Each handle object will consume
282requirements). Default: C<8192>. 375at least this amount of memory for the read buffer as well, so when
376handling many connections watch out for memory requirements). See also
377C<max_read_size>. Default: C<2048>.
378
379=item max_read_size => <bytes>
380
381The maximum read buffer size used by the dynamic adjustment
382algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
383one go it will double C<read_size> up to the maximum given by this
384option. Default: C<131072> or C<read_size>, whichever is higher.
283 385
284=item low_water_mark => <bytes> 386=item low_water_mark => <bytes>
285 387
286Sets the amount of bytes (default: C<0>) that make up an "empty" write 388Sets 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 389buffer: If the buffer reaches this size or gets even samller it is
288considered empty. 390considered empty.
289 391
290Sometimes it can be beneficial (for performance reasons) to add data to 392Sometimes 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 393the 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 394the operating system kernel usually buffers data as well, so the default
293is good in almost all cases. 395is good in almost all cases.
294 396
295=item linger => <seconds> 397=item linger => <seconds>
296 398
297If non-zero (default: C<3600>), then the destructor of the 399If this is non-zero (default: C<3600>), the destructor of the
298AnyEvent::Handle object will check whether there is still outstanding 400AnyEvent::Handle object will check whether there is still outstanding
299write data and will install a watcher that will write this data to the 401write 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 402socket. No errors will be reported (this mostly matches how the operating
301system treats outstanding data at socket close time). 403system treats outstanding data at socket close time).
302 404
309A string used to identify the remote site - usually the DNS hostname 411A string used to identify the remote site - usually the DNS hostname
310(I<not> IDN!) used to create the connection, rarely the IP address. 412(I<not> IDN!) used to create the connection, rarely the IP address.
311 413
312Apart from being useful in error messages, this string is also used in TLS 414Apart from being useful in error messages, this string is also used in TLS
313peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This 415peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
314verification will be skipped when C<peername> is not specified or 416verification will be skipped when C<peername> is not specified or is
315C<undef>. 417C<undef>.
316 418
317=item tls => "accept" | "connect" | Net::SSLeay::SSL object 419=item tls => "accept" | "connect" | Net::SSLeay::SSL object
318 420
319When this parameter is given, it enables TLS (SSL) mode, that means 421When this parameter is given, it enables TLS (SSL) mode, that means
320AnyEvent will start a TLS handshake as soon as the conenction has been 422AnyEvent will start a TLS handshake as soon as the connection has been
321established and will transparently encrypt/decrypt data afterwards. 423established and will transparently encrypt/decrypt data afterwards.
322 424
323All TLS protocol errors will be signalled as C<EPROTO>, with an 425All TLS protocol errors will be signalled as C<EPROTO>, with an
324appropriate error message. 426appropriate error message.
325 427
326TLS mode requires Net::SSLeay to be installed (it will be loaded 428TLS mode requires Net::SSLeay to be installed (it will be loaded
327automatically when you try to create a TLS handle): this module doesn't 429automatically when you try to create a TLS handle): this module doesn't
328have a dependency on that module, so if your module requires it, you have 430have a dependency on that module, so if your module requires it, you have
329to add the dependency yourself. 431to add the dependency yourself. If Net::SSLeay cannot be loaded or is too
432old, you get an C<EPROTO> error.
330 433
331Unlike TCP, TLS has a server and client side: for the TLS server side, use 434Unlike TCP, TLS has a server and client side: for the TLS server side, use
332C<accept>, and for the TLS client side of a connection, use C<connect> 435C<accept>, and for the TLS client side of a connection, use C<connect>
333mode. 436mode.
334 437
345B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 448B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
346passing in the wrong integer will lead to certain crash. This most often 449passing 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 450happens when one uses a stylish C<< tls => 1 >> and is surprised about the
348segmentation fault. 451segmentation fault.
349 452
350See the C<< ->starttls >> method for when need to start TLS negotiation later. 453Use the C<< ->starttls >> method if you need to start TLS negotiation later.
351 454
352=item tls_ctx => $anyevent_tls 455=item tls_ctx => $anyevent_tls
353 456
354Use the given C<AnyEvent::TLS> object to create the new TLS connection 457Use the given C<AnyEvent::TLS> object to create the new TLS connection
355(unless a connection object was specified directly). If this parameter is 458(unless a connection object was specified directly). If this
356missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 459parameter is missing (or C<undef>), then AnyEvent::Handle will use
460C<AnyEvent::Handle::TLS_CTX>.
357 461
358Instead of an object, you can also specify a hash reference with C<< key 462Instead 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 463=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
360new TLS context object. 464new TLS context object.
361 465
370 474
371TLS handshake failures will not cause C<on_error> to be invoked when this 475TLS 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>. 476callback is in effect, instead, the error message will be passed to C<on_starttls>.
373 477
374Without this callback, handshake failures lead to C<on_error> being 478Without this callback, handshake failures lead to C<on_error> being
375called, as normal. 479called as usual.
376 480
377Note that you cannot call C<starttls> right again in this callback. If you 481Note 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 482need to do that, start an zero-second timer instead whose callback can
379then call C<< ->starttls >> again. 483then call C<< ->starttls >> again.
380 484
381=item on_stoptls => $cb->($handle) 485=item on_stoptls => $cb->($handle)
382 486
389callback. 493callback.
390 494
391This callback will only be called on TLS shutdowns, not when the 495This callback will only be called on TLS shutdowns, not when the
392underlying handle signals EOF. 496underlying handle signals EOF.
393 497
394=item json => JSON or JSON::XS object 498=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
395 499
396This is the json coder object used by the C<json> read and write types. 500This is the json coder object used by the C<json> read and write types.
397 501
398If you don't supply it, then AnyEvent::Handle will create and use a 502If you don't supply it, then AnyEvent::Handle will create and use a
399suitable one (on demand), which will write and expect UTF-8 encoded JSON 503suitable one (on demand), which will write and expect UTF-8 encoded
504JSON texts (either using L<JSON::XS> or L<JSON>). The written texts are
505guaranteed not to contain any newline character.
506
507For security reasons, this encoder will likely I<not> handle numbers and
508strings, only arrays and objects/hashes. The reason is that originally
509JSON was self-delimited, but Dougles Crockford thought it was a splendid
510idea to redefine JSON incompatibly, so this is no longer true.
511
512For protocols that used back-to-back JSON texts, this might lead to
513run-ins, where two or more JSON texts will be interpreted as one JSON
400texts. 514text.
401 515
516For this reason, if the default encoder uses L<JSON::XS>, it will default
517to not allowing anything but arrays and objects/hashes, at least for the
518forseeable future (it will change at some point). This might or might not
519be true for the L<JSON> module, so this might cause a security issue.
520
521If you depend on either behaviour, you should create your own json object
522and pass it in explicitly.
523
524=item cbor => L<CBOR::XS> object
525
526This is the cbor coder object used by the C<cbor> read and write types.
527
528If you don't supply it, then AnyEvent::Handle will create and use a
529suitable one (on demand), which will write CBOR without using extensions,
530if possible.
531
402Note that you are responsible to depend on the JSON module if you want to 532Note that you are responsible to depend on the L<CBOR::XS> module if you
403use this functionality, as AnyEvent does not have a dependency itself. 533want to use this functionality, as AnyEvent does not have a dependency on
534it itself.
404 535
405=back 536=back
406 537
407=cut 538=cut
408 539
430 $self->{connect}[0], 561 $self->{connect}[0],
431 $self->{connect}[1], 562 $self->{connect}[1],
432 sub { 563 sub {
433 my ($fh, $host, $port, $retry) = @_; 564 my ($fh, $host, $port, $retry) = @_;
434 565
566 delete $self->{_connect}; # no longer needed
567
435 if ($fh) { 568 if ($fh) {
436 $self->{fh} = $fh; 569 $self->{fh} = $fh;
437 570
438 delete $self->{_skip_drain_rbuf}; 571 delete $self->{_skip_drain_rbuf};
439 $self->_start; 572 $self->_start;
440 573
441 $self->{on_connect} 574 $self->{on_connect}
442 and $self->{on_connect}($self, $host, $port, sub { 575 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)}; 576 delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
444 $self->{_skip_drain_rbuf} = 1; 577 $self->{_skip_drain_rbuf} = 1;
445 &$retry; 578 &$retry;
446 }); 579 });
447 580
448 } else { 581 } else {
449 if ($self->{on_connect_error}) { 582 if ($self->{on_connect_error}) {
450 $self->{on_connect_error}($self, "$!"); 583 $self->{on_connect_error}($self, "$!");
451 $self->destroy; 584 $self->destroy if $self;
452 } else { 585 } else {
453 $self->_error ($!, 1); 586 $self->_error ($!, 1);
454 } 587 }
455 } 588 }
456 }, 589 },
457 sub { 590 sub {
458 local $self->{fh} = $_[0]; 591 local $self->{fh} = $_[0];
459 592
460 $self->{on_prepare} 593 $self->{on_prepare}
461 ? $self->{on_prepare}->($self) 594 ? $self->{on_prepare}->($self)
462 : () 595 : ()
463 } 596 }
464 ); 597 );
465 } 598 }
466 599
472} 605}
473 606
474sub _start { 607sub _start {
475 my ($self) = @_; 608 my ($self) = @_;
476 609
610 # too many clueless people try to use udp and similar sockets
611 # with AnyEvent::Handle, do them a favour.
612 my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
613 Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
614 if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
615
477 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 616 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
478 617
618 $self->{_activity} =
619 $self->{_ractivity} =
479 $self->{_activity} = AnyEvent->now; 620 $self->{_wactivity} = AE::now;
480 $self->_timeout;
481 621
622 $self->{read_size} ||= 2048;
623 $self->{max_read_size} = $self->{read_size}
624 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
625
626 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
627 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
628 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
629
482 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; 630 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
631 $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
483 632
633 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
634
484 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 635 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
485 if $self->{tls}; 636 if $self->{tls};
486 637
487 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 638 $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
488 639
489 $self->start_read 640 $self->start_read
490 if $self->{on_read} || @{ $self->{_queue} }; 641 if $self->{on_read} || @{ $self->{_queue} };
491 642
492 $self->_drain_wbuf; 643 $self->_drain_wbuf;
493} 644}
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 645
504sub _error { 646sub _error {
505 my ($self, $errno, $fatal, $message) = @_; 647 my ($self, $errno, $fatal, $message) = @_;
506 648
507 $! = $errno; 649 $! = $errno;
508 $message ||= "$!"; 650 $message ||= "$!";
509 651
510 if ($self->{on_error}) { 652 if ($self->{on_error}) {
511 $self->{on_error}($self, $fatal, $message); 653 $self->{on_error}($self, $fatal, $message);
512 $self->destroy if $fatal; 654 $self->destroy if $fatal;
513 } elsif ($self->{fh}) { 655 } elsif ($self->{fh} || $self->{connect}) {
514 $self->destroy; 656 $self->destroy;
515 Carp::croak "AnyEvent::Handle uncaught error: $message"; 657 Carp::croak "AnyEvent::Handle uncaught error: $message";
516 } 658 }
517} 659}
518 660
544 $_[0]{on_eof} = $_[1]; 686 $_[0]{on_eof} = $_[1];
545} 687}
546 688
547=item $handle->on_timeout ($cb) 689=item $handle->on_timeout ($cb)
548 690
549Replace the current C<on_timeout> callback, or disables the callback (but 691=item $handle->on_rtimeout ($cb)
550not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
551argument and method.
552 692
553=cut 693=item $handle->on_wtimeout ($cb)
554 694
555sub on_timeout { 695Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
556 $_[0]{on_timeout} = $_[1]; 696callback, or disables the callback (but not the timeout) if C<$cb> =
557} 697C<undef>. See the C<timeout> constructor argument and method.
698
699=cut
700
701# see below
558 702
559=item $handle->autocork ($boolean) 703=item $handle->autocork ($boolean)
560 704
561Enables or disables the current autocork behaviour (see C<autocork> 705Enables or disables the current autocork behaviour (see C<autocork>
562constructor argument). Changes will only take effect on the next write. 706constructor argument). Changes will only take effect on the next write.
575=cut 719=cut
576 720
577sub no_delay { 721sub no_delay {
578 $_[0]{no_delay} = $_[1]; 722 $_[0]{no_delay} = $_[1];
579 723
724 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
725 if $_[0]{fh};
726}
727
728=item $handle->keepalive ($boolean)
729
730Enables or disables the C<keepalive> setting (see constructor argument of
731the same name for details).
732
733=cut
734
735sub keepalive {
736 $_[0]{keepalive} = $_[1];
737
580 eval { 738 eval {
581 local $SIG{__DIE__}; 739 local $SIG{__DIE__};
582 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1] 740 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
583 if $_[0]{fh}; 741 if $_[0]{fh};
584 }; 742 };
585} 743}
586 744
745=item $handle->oobinline ($boolean)
746
747Enables or disables the C<oobinline> setting (see constructor argument of
748the same name for details).
749
750=cut
751
752sub oobinline {
753 $_[0]{oobinline} = $_[1];
754
755 eval {
756 local $SIG{__DIE__};
757 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
758 if $_[0]{fh};
759 };
760}
761
762=item $handle->keepalive ($boolean)
763
764Enables or disables the C<keepalive> setting (see constructor argument of
765the same name for details).
766
767=cut
768
769sub keepalive {
770 $_[0]{keepalive} = $_[1];
771
772 eval {
773 local $SIG{__DIE__};
774 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
775 if $_[0]{fh};
776 };
777}
778
587=item $handle->on_starttls ($cb) 779=item $handle->on_starttls ($cb)
588 780
589Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). 781Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
590 782
591=cut 783=cut
598 790
599Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). 791Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
600 792
601=cut 793=cut
602 794
603sub on_starttls { 795sub on_stoptls {
604 $_[0]{on_stoptls} = $_[1]; 796 $_[0]{on_stoptls} = $_[1];
605} 797}
606 798
607=item $handle->rbuf_max ($max_octets) 799=item $handle->rbuf_max ($max_octets)
608 800
609Configures the C<rbuf_max> setting (C<undef> disables it). 801Configures the C<rbuf_max> setting (C<undef> disables it).
802
803=item $handle->wbuf_max ($max_octets)
804
805Configures the C<wbuf_max> setting (C<undef> disables it).
610 806
611=cut 807=cut
612 808
613sub rbuf_max { 809sub rbuf_max {
614 $_[0]{rbuf_max} = $_[1]; 810 $_[0]{rbuf_max} = $_[1];
615} 811}
616 812
813sub wbuf_max {
814 $_[0]{wbuf_max} = $_[1];
815}
816
617############################################################################# 817#############################################################################
618 818
619=item $handle->timeout ($seconds) 819=item $handle->timeout ($seconds)
620 820
821=item $handle->rtimeout ($seconds)
822
823=item $handle->wtimeout ($seconds)
824
621Configures (or disables) the inactivity timeout. 825Configures (or disables) the inactivity timeout.
622 826
623=cut 827The timeout will be checked instantly, so this method might destroy the
828handle before it returns.
624 829
625sub timeout { 830=item $handle->timeout_reset
831
832=item $handle->rtimeout_reset
833
834=item $handle->wtimeout_reset
835
836Reset the activity timeout, as if data was received or sent.
837
838These methods are cheap to call.
839
840=cut
841
842for my $dir ("", "r", "w") {
843 my $timeout = "${dir}timeout";
844 my $tw = "_${dir}tw";
845 my $on_timeout = "on_${dir}timeout";
846 my $activity = "_${dir}activity";
847 my $cb;
848
849 *$on_timeout = sub {
850 $_[0]{$on_timeout} = $_[1];
851 };
852
853 *$timeout = sub {
626 my ($self, $timeout) = @_; 854 my ($self, $new_value) = @_;
627 855
856 $new_value >= 0
857 or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
858
628 $self->{timeout} = $timeout; 859 $self->{$timeout} = $new_value;
629 delete $self->{_tw}; 860 delete $self->{$tw}; &$cb;
630 $self->_timeout; 861 };
631}
632 862
863 *{"${dir}timeout_reset"} = sub {
864 $_[0]{$activity} = AE::now;
865 };
866
867 # main workhorse:
633# reset the timeout watcher, as neccessary 868 # reset the timeout watcher, as neccessary
634# also check for time-outs 869 # also check for time-outs
635sub _timeout { 870 $cb = sub {
636 my ($self) = @_; 871 my ($self) = @_;
637 872
638 if ($self->{timeout} && $self->{fh}) { 873 if ($self->{$timeout} && $self->{fh}) {
639 my $NOW = AnyEvent->now; 874 my $NOW = AE::now;
640 875
641 # when would the timeout trigger? 876 # when would the timeout trigger?
642 my $after = $self->{_activity} + $self->{timeout} - $NOW; 877 my $after = $self->{$activity} + $self->{$timeout} - $NOW;
643 878
644 # now or in the past already? 879 # now or in the past already?
645 if ($after <= 0) { 880 if ($after <= 0) {
646 $self->{_activity} = $NOW; 881 $self->{$activity} = $NOW;
647 882
648 if ($self->{on_timeout}) { 883 if ($self->{$on_timeout}) {
649 $self->{on_timeout}($self); 884 $self->{$on_timeout}($self);
650 } else { 885 } else {
651 $self->_error (Errno::ETIMEDOUT); 886 $self->_error (Errno::ETIMEDOUT);
887 }
888
889 # callback could have changed timeout value, optimise
890 return unless $self->{$timeout};
891
892 # calculate new after
893 $after = $self->{$timeout};
652 } 894 }
653 895
654 # callback could have changed timeout value, optimise 896 Scalar::Util::weaken $self;
655 return unless $self->{timeout}; 897 return unless $self; # ->error could have destroyed $self
656 898
657 # calculate new after 899 $self->{$tw} ||= AE::timer $after, 0, sub {
658 $after = $self->{timeout}; 900 delete $self->{$tw};
901 $cb->($self);
902 };
903 } else {
904 delete $self->{$tw};
659 } 905 }
660
661 Scalar::Util::weaken $self;
662 return unless $self; # ->error could have destroyed $self
663
664 $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
665 delete $self->{_tw};
666 $self->_timeout;
667 });
668 } else {
669 delete $self->{_tw};
670 } 906 }
671} 907}
672 908
673############################################################################# 909#############################################################################
674 910
681 917
682The write queue is very simple: you can add data to its end, and 918The write queue is very simple: you can add data to its end, and
683AnyEvent::Handle will automatically try to get rid of it for you. 919AnyEvent::Handle will automatically try to get rid of it for you.
684 920
685When data could be written and the write buffer is shorter then the low 921When data could be written and the write buffer is shorter then the low
686water mark, the C<on_drain> callback will be invoked. 922water mark, the C<on_drain> callback will be invoked once.
687 923
688=over 4 924=over 4
689 925
690=item $handle->on_drain ($cb) 926=item $handle->on_drain ($cb)
691 927
692Sets the C<on_drain> callback or clears it (see the description of 928Sets the C<on_drain> callback or clears it (see the description of
693C<on_drain> in the constructor). 929C<on_drain> in the constructor).
694 930
931This method may invoke callbacks (and therefore the handle might be
932destroyed after it returns).
933
695=cut 934=cut
696 935
697sub on_drain { 936sub on_drain {
698 my ($self, $cb) = @_; 937 my ($self, $cb) = @_;
699 938
703 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); 942 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
704} 943}
705 944
706=item $handle->push_write ($data) 945=item $handle->push_write ($data)
707 946
708Queues the given scalar to be written. You can push as much data as you 947Queues the given scalar to be written. You can push as much data as
709want (only limited by the available memory), as C<AnyEvent::Handle> 948you want (only limited by the available memory and C<wbuf_max>), as
710buffers it independently of the kernel. 949C<AnyEvent::Handle> buffers it independently of the kernel.
950
951This method may invoke callbacks (and therefore the handle might be
952destroyed after it returns).
711 953
712=cut 954=cut
713 955
714sub _drain_wbuf { 956sub _drain_wbuf {
715 my ($self) = @_; 957 my ($self) = @_;
722 my $len = syswrite $self->{fh}, $self->{wbuf}; 964 my $len = syswrite $self->{fh}, $self->{wbuf};
723 965
724 if (defined $len) { 966 if (defined $len) {
725 substr $self->{wbuf}, 0, $len, ""; 967 substr $self->{wbuf}, 0, $len, "";
726 968
727 $self->{_activity} = AnyEvent->now; 969 $self->{_activity} = $self->{_wactivity} = AE::now;
728 970
729 $self->{on_drain}($self) 971 $self->{on_drain}($self)
730 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) 972 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
731 && $self->{on_drain}; 973 && $self->{on_drain};
732 974
733 delete $self->{_ww} unless length $self->{wbuf}; 975 delete $self->{_ww} unless length $self->{wbuf};
734 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 976 } elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
735 $self->_error ($!, 1); 977 $self->_error ($!, 1);
736 } 978 }
737 }; 979 };
738 980
739 # try to write data immediately 981 # try to write data immediately
740 $cb->() unless $self->{autocork}; 982 $cb->() unless $self->{autocork};
741 983
742 # if still data left in wbuf, we need to poll 984 # if still data left in wbuf, we need to poll
743 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) 985 $self->{_ww} = AE::io $self->{fh}, 1, $cb
744 if length $self->{wbuf}; 986 if length $self->{wbuf};
987
988 if (
989 defined $self->{wbuf_max}
990 && $self->{wbuf_max} < length $self->{wbuf}
991 ) {
992 $self->_error (Errno::ENOSPC, 1), return;
993 }
745 }; 994 };
746} 995}
747 996
748our %WH; 997our %WH;
749 998
999# deprecated
750sub register_write_type($$) { 1000sub register_write_type($$) {
751 $WH{$_[0]} = $_[1]; 1001 $WH{$_[0]} = $_[1];
752} 1002}
753 1003
754sub push_write { 1004sub push_write {
755 my $self = shift; 1005 my $self = shift;
756 1006
757 if (@_ > 1) { 1007 if (@_ > 1) {
758 my $type = shift; 1008 my $type = shift;
759 1009
1010 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
760 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") 1011 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
761 ->($self, @_); 1012 ->($self, @_);
762 } 1013 }
763 1014
1015 # we downgrade here to avoid hard-to-track-down bugs,
1016 # and diagnose the problem earlier and better.
1017
764 if ($self->{tls}) { 1018 if ($self->{tls}) {
765 $self->{_tls_wbuf} .= $_[0]; 1019 utf8::downgrade $self->{_tls_wbuf} .= $_[0];
766 &_dotls ($self) if $self->{fh}; 1020 &_dotls ($self) if $self->{fh};
767 } else { 1021 } else {
768 $self->{wbuf} .= $_[0]; 1022 utf8::downgrade $self->{wbuf} .= $_[0];
769 $self->_drain_wbuf if $self->{fh}; 1023 $self->_drain_wbuf if $self->{fh};
770 } 1024 }
771} 1025}
772 1026
773=item $handle->push_write (type => @args) 1027=item $handle->push_write (type => @args)
774 1028
775Instead of formatting your data yourself, you can also let this module do 1029Instead of formatting your data yourself, you can also let this module
776the job by specifying a type and type-specific arguments. 1030do the job by specifying a type and type-specific arguments. You
1031can also specify the (fully qualified) name of a package, in which
1032case AnyEvent tries to load the package and then expects to find the
1033C<anyevent_write_type> function inside (see "custom write types", below).
777 1034
778Predefined types are (if you have ideas for additional types, feel free to 1035Predefined types are (if you have ideas for additional types, feel free to
779drop by and tell us): 1036drop by and tell us):
780 1037
781=over 4 1038=over 4
812 1069
813Encodes the given hash or array reference into a JSON object. Unless you 1070Encodes the given hash or array reference into a JSON object. Unless you
814provide your own JSON object, this means it will be encoded to JSON text 1071provide your own JSON object, this means it will be encoded to JSON text
815in UTF-8. 1072in UTF-8.
816 1073
1074The default encoder might or might not handle every type of JSON value -
1075it might be limited to arrays and objects for security reasons. See the
1076C<json> constructor attribute for more details.
1077
817JSON objects (and arrays) are self-delimiting, so you can write JSON at 1078JSON objects (and arrays) are self-delimiting, so if you only use arrays
818one end of a handle and read them at the other end without using any 1079and hashes, you can write JSON at one end of a handle and read them at the
819additional framing. 1080other end without using any additional framing.
820 1081
821The generated JSON text is guaranteed not to contain any newlines: While 1082The JSON text generated by the default encoder is guaranteed not to
822this module doesn't need delimiters after or between JSON texts to be 1083contain any newlines: While this module doesn't need delimiters after or
823able to read them, many other languages depend on that. 1084between JSON texts to be able to read them, many other languages depend on
1085them.
824 1086
825A simple RPC protocol that interoperates easily with others is to send 1087A simple RPC protocol that interoperates easily with other languages is
826JSON arrays (or objects, although arrays are usually the better choice as 1088to send JSON arrays (or objects, although arrays are usually the better
827they mimic how function argument passing works) and a newline after each 1089choice as they mimic how function argument passing works) and a newline
828JSON text: 1090after each JSON text:
829 1091
830 $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever 1092 $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
831 $handle->push_write ("\012"); 1093 $handle->push_write ("\012");
832 1094
833An AnyEvent::Handle receiver would simply use the C<json> read type and 1095An AnyEvent::Handle receiver would simply use the C<json> read type and
836 $handle->push_read (json => sub { my $array = $_[1]; ... }); 1098 $handle->push_read (json => sub { my $array = $_[1]; ... });
837 1099
838Other languages could read single lines terminated by a newline and pass 1100Other languages could read single lines terminated by a newline and pass
839this line into their JSON decoder of choice. 1101this line into their JSON decoder of choice.
840 1102
1103=item cbor => $perl_scalar
1104
1105Encodes the given scalar into a CBOR value. Unless you provide your own
1106L<CBOR::XS> object, this means it will be encoded to a CBOR string not
1107using any extensions, if possible.
1108
1109CBOR values are self-delimiting, so you can write CBOR at one end of
1110a handle and read them at the other end without using any additional
1111framing.
1112
1113A simple nd very very fast RPC protocol that interoperates with
1114other languages is to send CBOR and receive CBOR values (arrays are
1115recommended):
1116
1117 $handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
1118
1119An AnyEvent::Handle receiver would simply use the C<cbor> read type:
1120
1121 $handle->push_read (cbor => sub { my $array = $_[1]; ... });
1122
841=cut 1123=cut
1124
1125sub json_coder() {
1126 eval { require JSON::XS; JSON::XS->new->utf8 }
1127 || do { require JSON::PP; JSON::PP->new->utf8 }
1128}
842 1129
843register_write_type json => sub { 1130register_write_type json => sub {
844 my ($self, $ref) = @_; 1131 my ($self, $ref) = @_;
845 1132
846 require JSON; 1133 ($self->{json} ||= json_coder)
1134 ->encode ($ref)
1135};
847 1136
848 $self->{json} ? $self->{json}->encode ($ref) 1137sub cbor_coder() {
849 : JSON::encode_json ($ref) 1138 require CBOR::XS;
1139 CBOR::XS->new
1140}
1141
1142register_write_type cbor => sub {
1143 my ($self, $scalar) = @_;
1144
1145 ($self->{cbor} ||= cbor_coder)
1146 ->encode ($scalar)
850}; 1147};
851 1148
852=item storable => $reference 1149=item storable => $reference
853 1150
854Freezes the given reference using L<Storable> and writes it to the 1151Freezes the given reference using L<Storable> and writes it to the
857=cut 1154=cut
858 1155
859register_write_type storable => sub { 1156register_write_type storable => sub {
860 my ($self, $ref) = @_; 1157 my ($self, $ref) = @_;
861 1158
862 require Storable; 1159 require Storable unless $Storable::VERSION;
863 1160
864 pack "w/a*", Storable::nfreeze ($ref) 1161 pack "w/a*", Storable::nfreeze ($ref)
865}; 1162};
866 1163
867=back 1164=back
872before it was actually written. One way to do that is to replace your 1169before it was actually written. One way to do that is to replace your
873C<on_drain> handler by a callback that shuts down the socket (and set 1170C<on_drain> handler by a callback that shuts down the socket (and set
874C<low_water_mark> to C<0>). This method is a shorthand for just that, and 1171C<low_water_mark> to C<0>). This method is a shorthand for just that, and
875replaces the C<on_drain> callback with: 1172replaces the C<on_drain> callback with:
876 1173
877 sub { shutdown $_[0]{fh}, 1 } # for push_shutdown 1174 sub { shutdown $_[0]{fh}, 1 }
878 1175
879This simply shuts down the write side and signals an EOF condition to the 1176This simply shuts down the write side and signals an EOF condition to the
880the peer. 1177the peer.
881 1178
882You can rely on the normal read queue and C<on_eof> handling 1179You can rely on the normal read queue and C<on_eof> handling
883afterwards. This is the cleanest way to close a connection. 1180afterwards. This is the cleanest way to close a connection.
884 1181
1182This method may invoke callbacks (and therefore the handle might be
1183destroyed after it returns).
1184
885=cut 1185=cut
886 1186
887sub push_shutdown { 1187sub push_shutdown {
888 my ($self) = @_; 1188 my ($self) = @_;
889 1189
890 delete $self->{low_water_mark}; 1190 delete $self->{low_water_mark};
891 $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); 1191 $self->on_drain (sub { shutdown $_[0]{fh}, 1 });
892} 1192}
893 1193
894=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 1194=item custom write types - Package::anyevent_write_type $handle, @args
895 1195
896This function (not method) lets you add your own types to C<push_write>. 1196Instead of one of the predefined types, you can also specify the name of
1197a package. AnyEvent will try to load the package and then expects to find
1198a function named C<anyevent_write_type> inside. If it isn't found, it
1199progressively tries to load the parent package until it either finds the
1200function (good) or runs out of packages (bad).
1201
897Whenever the given C<type> is used, C<push_write> will invoke the code 1202Whenever the given C<type> is used, C<push_write> will the function with
898reference with the handle object and the remaining arguments. 1203the handle object and the remaining arguments.
899 1204
900The code reference is supposed to return a single octet string that will 1205The function is supposed to return a single octet string that will be
901be appended to the write buffer. 1206appended to the write buffer, so you can mentally treat this function as a
1207"arguments to on-the-wire-format" converter.
902 1208
903Note that this is a function, and all types registered this way will be 1209Example: implement a custom write type C<join> that joins the remaining
904global, so try to use unique names. 1210arguments using the first one.
1211
1212 $handle->push_write (My::Type => " ", 1,2,3);
1213
1214 # uses the following package, which can be defined in the "My::Type" or in
1215 # the "My" modules to be auto-loaded, or just about anywhere when the
1216 # My::Type::anyevent_write_type is defined before invoking it.
1217
1218 package My::Type;
1219
1220 sub anyevent_write_type {
1221 my ($handle, $delim, @args) = @_;
1222
1223 join $delim, @args
1224 }
905 1225
906=cut 1226=cut
907 1227
908############################################################################# 1228#############################################################################
909 1229
918ways, the "simple" way, using only C<on_read> and the "complex" way, using 1238ways, the "simple" way, using only C<on_read> and the "complex" way, using
919a queue. 1239a queue.
920 1240
921In the simple case, you just install an C<on_read> callback and whenever 1241In the simple case, you just install an C<on_read> callback and whenever
922new data arrives, it will be called. You can then remove some data (if 1242new data arrives, it will be called. You can then remove some data (if
923enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna 1243enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
924leave the data there if you want to accumulate more (e.g. when only a 1244leave the data there if you want to accumulate more (e.g. when only a
925partial message has been received so far). 1245partial message has been received so far), or change the read queue with
1246e.g. C<push_read>.
926 1247
927In the more complex case, you want to queue multiple callbacks. In this 1248In the more complex case, you want to queue multiple callbacks. In this
928case, AnyEvent::Handle will call the first queued callback each time new 1249case, AnyEvent::Handle will call the first queued callback each time new
929data arrives (also the first time it is queued) and removes it when it has 1250data arrives (also the first time it is queued) and remove it when it has
930done its job (see C<push_read>, below). 1251done its job (see C<push_read>, below).
931 1252
932This way you can, for example, push three line-reads, followed by reading 1253This way you can, for example, push three line-reads, followed by reading
933a chunk of data, and AnyEvent::Handle will execute them in order. 1254a chunk of data, and AnyEvent::Handle will execute them in order.
934 1255
1065 1386
1066This replaces the currently set C<on_read> callback, or clears it (when 1387This replaces the currently set C<on_read> callback, or clears it (when
1067the new callback is C<undef>). See the description of C<on_read> in the 1388the new callback is C<undef>). See the description of C<on_read> in the
1068constructor. 1389constructor.
1069 1390
1391This method may invoke callbacks (and therefore the handle might be
1392destroyed after it returns).
1393
1070=cut 1394=cut
1071 1395
1072sub on_read { 1396sub on_read {
1073 my ($self, $cb) = @_; 1397 my ($self, $cb) = @_;
1074 1398
1076 $self->_drain_rbuf if $cb; 1400 $self->_drain_rbuf if $cb;
1077} 1401}
1078 1402
1079=item $handle->rbuf 1403=item $handle->rbuf
1080 1404
1081Returns the read buffer (as a modifiable lvalue). 1405Returns the read buffer (as a modifiable lvalue). You can also access the
1406read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
1407much faster, and no less clean).
1082 1408
1083You can access the read buffer directly as the C<< ->{rbuf} >> 1409The only operation allowed on the read buffer (apart from looking at it)
1084member, if you want. However, the only operation allowed on the 1410is removing data from its beginning. Otherwise modifying or appending to
1085read buffer (apart from looking at it) is removing data from its 1411it is not allowed and will lead to hard-to-track-down bugs.
1086beginning. Otherwise modifying or appending to it is not allowed and will
1087lead to hard-to-track-down bugs.
1088 1412
1089NOTE: The read buffer should only be used or modified if the C<on_read>, 1413NOTE: The read buffer should only be used or modified in the C<on_read>
1090C<push_read> or C<unshift_read> methods are used. The other read methods 1414callback or when C<push_read> or C<unshift_read> are used with a single
1091automatically manage the read buffer. 1415callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
1416will manage the read buffer on their own.
1092 1417
1093=cut 1418=cut
1094 1419
1095sub rbuf : lvalue { 1420sub rbuf : lvalue {
1096 $_[0]{rbuf} 1421 $_[0]{rbuf}
1113 1438
1114If enough data was available, then the callback must remove all data it is 1439If enough data was available, then the callback must remove all data it is
1115interested in (which can be none at all) and return a true value. After returning 1440interested in (which can be none at all) and return a true value. After returning
1116true, it will be removed from the queue. 1441true, it will be removed from the queue.
1117 1442
1443These methods may invoke callbacks (and therefore the handle might be
1444destroyed after it returns).
1445
1118=cut 1446=cut
1119 1447
1120our %RH; 1448our %RH;
1121 1449
1122sub register_read_type($$) { 1450sub register_read_type($$) {
1128 my $cb = pop; 1456 my $cb = pop;
1129 1457
1130 if (@_) { 1458 if (@_) {
1131 my $type = shift; 1459 my $type = shift;
1132 1460
1461 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1133 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 1462 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1134 ->($self, $cb, @_); 1463 ->($self, $cb, @_);
1135 } 1464 }
1136 1465
1137 push @{ $self->{_queue} }, $cb; 1466 push @{ $self->{_queue} }, $cb;
1138 $self->_drain_rbuf; 1467 $self->_drain_rbuf;
1143 my $cb = pop; 1472 my $cb = pop;
1144 1473
1145 if (@_) { 1474 if (@_) {
1146 my $type = shift; 1475 my $type = shift;
1147 1476
1477 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1148 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 1478 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1149 ->($self, $cb, @_); 1479 ->($self, $cb, @_);
1150 } 1480 }
1151
1152 1481
1153 unshift @{ $self->{_queue} }, $cb; 1482 unshift @{ $self->{_queue} }, $cb;
1154 $self->_drain_rbuf; 1483 $self->_drain_rbuf;
1155} 1484}
1156 1485
1158 1487
1159=item $handle->unshift_read (type => @args, $cb) 1488=item $handle->unshift_read (type => @args, $cb)
1160 1489
1161Instead of providing a callback that parses the data itself you can chose 1490Instead of providing a callback that parses the data itself you can chose
1162between a number of predefined parsing formats, for chunks of data, lines 1491between a number of predefined parsing formats, for chunks of data, lines
1163etc. 1492etc. You can also specify the (fully qualified) name of a package, in
1493which case AnyEvent tries to load the package and then expects to find the
1494C<anyevent_read_type> function inside (see "custom read types", below).
1164 1495
1165Predefined types are (if you have ideas for additional types, feel free to 1496Predefined types are (if you have ideas for additional types, feel free to
1166drop by and tell us): 1497drop by and tell us):
1167 1498
1168=over 4 1499=over 4
1174data. 1505data.
1175 1506
1176Example: read 2 bytes. 1507Example: read 2 bytes.
1177 1508
1178 $handle->push_read (chunk => 2, sub { 1509 $handle->push_read (chunk => 2, sub {
1179 warn "yay ", unpack "H*", $_[1]; 1510 say "yay " . unpack "H*", $_[1];
1180 }); 1511 });
1181 1512
1182=cut 1513=cut
1183 1514
1184register_read_type chunk => sub { 1515register_read_type chunk => sub {
1214 1545
1215register_read_type line => sub { 1546register_read_type line => sub {
1216 my ($self, $cb, $eol) = @_; 1547 my ($self, $cb, $eol) = @_;
1217 1548
1218 if (@_ < 3) { 1549 if (@_ < 3) {
1219 # this is more than twice as fast as the generic code below 1550 # this is faster then the generic code below
1220 sub { 1551 sub {
1221 $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; 1552 (my $pos = index $_[0]{rbuf}, "\012") >= 0
1553 or return;
1222 1554
1555 (my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1223 $cb->($_[0], $1, $2); 1556 $cb->($_[0], $str, "$1");
1224 1 1557 1
1225 } 1558 }
1226 } else { 1559 } else {
1227 $eol = quotemeta $eol unless ref $eol; 1560 $eol = quotemeta $eol unless ref $eol;
1228 $eol = qr|^(.*?)($eol)|s; 1561 $eol = qr|^(.*?)($eol)|s;
1229 1562
1230 sub { 1563 sub {
1231 $_[0]{rbuf} =~ s/$eol// or return; 1564 $_[0]{rbuf} =~ s/$eol// or return;
1232 1565
1233 $cb->($_[0], $1, $2); 1566 $cb->($_[0], "$1", "$2");
1234 1 1567 1
1235 } 1568 }
1236 } 1569 }
1237}; 1570};
1238 1571
1260the receive buffer when neither C<$accept> nor C<$reject> match, 1593the receive buffer when neither C<$accept> nor C<$reject> match,
1261and everything preceding and including the match will be accepted 1594and everything preceding and including the match will be accepted
1262unconditionally. This is useful to skip large amounts of data that you 1595unconditionally. This is useful to skip large amounts of data that you
1263know cannot be matched, so that the C<$accept> or C<$reject> regex do not 1596know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1264have to start matching from the beginning. This is purely an optimisation 1597have to start matching from the beginning. This is purely an optimisation
1265and is usually worth only when you expect more than a few kilobytes. 1598and is usually worth it only when you expect more than a few kilobytes.
1266 1599
1267Example: expect a http header, which ends at C<\015\012\015\012>. Since we 1600Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1268expect the header to be very large (it isn't in practise, but...), we use 1601expect the header to be very large (it isn't in practice, but...), we use
1269a skip regex to skip initial portions. The skip regex is tricky in that 1602a skip regex to skip initial portions. The skip regex is tricky in that
1270it only accepts something not ending in either \015 or \012, as these are 1603it only accepts something not ending in either \015 or \012, as these are
1271required for the accept regex. 1604required for the accept regex.
1272 1605
1273 $handle->push_read (regex => 1606 $handle->push_read (regex =>
1286 1619
1287 sub { 1620 sub {
1288 # accept 1621 # accept
1289 if ($$rbuf =~ $accept) { 1622 if ($$rbuf =~ $accept) {
1290 $data .= substr $$rbuf, 0, $+[0], ""; 1623 $data .= substr $$rbuf, 0, $+[0], "";
1291 $cb->($self, $data); 1624 $cb->($_[0], $data);
1292 return 1; 1625 return 1;
1293 } 1626 }
1294 1627
1295 # reject 1628 # reject
1296 if ($reject && $$rbuf =~ $reject) { 1629 if ($reject && $$rbuf =~ $reject) {
1297 $self->_error (Errno::EBADMSG); 1630 $_[0]->_error (Errno::EBADMSG);
1298 } 1631 }
1299 1632
1300 # skip 1633 # skip
1301 if ($skip && $$rbuf =~ $skip) { 1634 if ($skip && $$rbuf =~ $skip) {
1302 $data .= substr $$rbuf, 0, $+[0], ""; 1635 $data .= substr $$rbuf, 0, $+[0], "";
1318 my ($self, $cb) = @_; 1651 my ($self, $cb) = @_;
1319 1652
1320 sub { 1653 sub {
1321 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { 1654 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1322 if ($_[0]{rbuf} =~ /[^0-9]/) { 1655 if ($_[0]{rbuf} =~ /[^0-9]/) {
1323 $self->_error (Errno::EBADMSG); 1656 $_[0]->_error (Errno::EBADMSG);
1324 } 1657 }
1325 return; 1658 return;
1326 } 1659 }
1327 1660
1328 my $len = $1; 1661 my $len = $1;
1329 1662
1330 $self->unshift_read (chunk => $len, sub { 1663 $_[0]->unshift_read (chunk => $len, sub {
1331 my $string = $_[1]; 1664 my $string = $_[1];
1332 $_[0]->unshift_read (chunk => 1, sub { 1665 $_[0]->unshift_read (chunk => 1, sub {
1333 if ($_[1] eq ",") { 1666 if ($_[1] eq ",") {
1334 $cb->($_[0], $string); 1667 $cb->($_[0], $string);
1335 } else { 1668 } else {
1336 $self->_error (Errno::EBADMSG); 1669 $_[0]->_error (Errno::EBADMSG);
1337 } 1670 }
1338 }); 1671 });
1339 }); 1672 });
1340 1673
1341 1 1674 1
1391=item json => $cb->($handle, $hash_or_arrayref) 1724=item json => $cb->($handle, $hash_or_arrayref)
1392 1725
1393Reads a JSON object or array, decodes it and passes it to the 1726Reads a JSON object or array, decodes it and passes it to the
1394callback. When a parse error occurs, an C<EBADMSG> error will be raised. 1727callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1395 1728
1396If a C<json> object was passed to the constructor, then that will be used 1729If a C<json> object was passed to the constructor, then that will be
1397for the final decode, otherwise it will create a JSON coder expecting UTF-8. 1730used for the final decode, otherwise it will create a L<JSON::XS> or
1731L<JSON::PP> coder object expecting UTF-8.
1398 1732
1399This read type uses the incremental parser available with JSON version 1733This read type uses the incremental parser available with JSON version
14002.09 (and JSON::XS version 2.2) and above. You have to provide a 17342.09 (and JSON::XS version 2.2) and above.
1401dependency on your own: this module will load the JSON module, but
1402AnyEvent does not depend on it itself.
1403 1735
1404Since JSON texts are fully self-delimiting, the C<json> read and write 1736Since JSON texts are fully self-delimiting, the C<json> read and write
1405types are an ideal simple RPC protocol: just exchange JSON datagrams. See 1737types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1406the C<json> write type description, above, for an actual example. 1738the C<json> write type description, above, for an actual example.
1407 1739
1408=cut 1740=cut
1409 1741
1410register_read_type json => sub { 1742register_read_type json => sub {
1411 my ($self, $cb) = @_; 1743 my ($self, $cb) = @_;
1412 1744
1413 my $json = $self->{json} ||= 1745 my $json = $self->{json} ||= json_coder;
1414 eval { require JSON::XS; JSON::XS->new->utf8 }
1415 || do { require JSON; JSON->new->utf8 };
1416 1746
1417 my $data; 1747 my $data;
1418 my $rbuf = \$self->{rbuf};
1419 1748
1420 sub { 1749 sub {
1421 my $ref = eval { $json->incr_parse ($self->{rbuf}) }; 1750 my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1422 1751
1423 if ($ref) { 1752 if ($ref) {
1424 $self->{rbuf} = $json->incr_text; 1753 $_[0]{rbuf} = $json->incr_text;
1425 $json->incr_text = ""; 1754 $json->incr_text = "";
1426 $cb->($self, $ref); 1755 $cb->($_[0], $ref);
1427 1756
1428 1 1757 1
1429 } elsif ($@) { 1758 } elsif ($@) {
1430 # error case 1759 # error case
1431 $json->incr_skip; 1760 $json->incr_skip;
1432 1761
1433 $self->{rbuf} = $json->incr_text; 1762 $_[0]{rbuf} = $json->incr_text;
1434 $json->incr_text = ""; 1763 $json->incr_text = "";
1435 1764
1436 $self->_error (Errno::EBADMSG); 1765 $_[0]->_error (Errno::EBADMSG);
1437 1766
1438 () 1767 ()
1439 } else { 1768 } else {
1440 $self->{rbuf} = ""; 1769 $_[0]{rbuf} = "";
1441 1770
1771 ()
1772 }
1773 }
1774};
1775
1776=item cbor => $cb->($handle, $scalar)
1777
1778Reads a CBOR value, decodes it and passes it to the callback. When a parse
1779error occurs, an C<EBADMSG> error will be raised.
1780
1781If a L<CBOR::XS> object was passed to the constructor, then that will be
1782used for the final decode, otherwise it will create a CBOR coder without
1783enabling any options.
1784
1785You have to provide a dependency to L<CBOR::XS> on your own: this module
1786will load the L<CBOR::XS> module, but AnyEvent does not depend on it
1787itself.
1788
1789Since CBOR values are fully self-delimiting, the C<cbor> read and write
1790types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
1791the C<cbor> write type description, above, for an actual example.
1792
1793=cut
1794
1795register_read_type cbor => sub {
1796 my ($self, $cb) = @_;
1797
1798 my $cbor = $self->{cbor} ||= cbor_coder;
1799
1800 my $data;
1801
1802 sub {
1803 my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
1804
1805 if (@value) {
1806 $cb->($_[0], @value);
1807
1808 1
1809 } elsif ($@) {
1810 # error case
1811 $cbor->incr_reset;
1812
1813 $_[0]->_error (Errno::EBADMSG);
1814
1815 ()
1816 } else {
1442 () 1817 ()
1443 } 1818 }
1444 } 1819 }
1445}; 1820};
1446 1821
1455=cut 1830=cut
1456 1831
1457register_read_type storable => sub { 1832register_read_type storable => sub {
1458 my ($self, $cb) = @_; 1833 my ($self, $cb) = @_;
1459 1834
1460 require Storable; 1835 require Storable unless $Storable::VERSION;
1461 1836
1462 sub { 1837 sub {
1463 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method 1838 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1464 defined (my $len = eval { unpack "w", $_[0]{rbuf} }) 1839 defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1465 or return; 1840 or return;
1468 1843
1469 # bypass unshift if we already have the remaining chunk 1844 # bypass unshift if we already have the remaining chunk
1470 if ($format + $len <= length $_[0]{rbuf}) { 1845 if ($format + $len <= length $_[0]{rbuf}) {
1471 my $data = substr $_[0]{rbuf}, $format, $len; 1846 my $data = substr $_[0]{rbuf}, $format, $len;
1472 substr $_[0]{rbuf}, 0, $format + $len, ""; 1847 substr $_[0]{rbuf}, 0, $format + $len, "";
1848
1473 $cb->($_[0], Storable::thaw ($data)); 1849 eval { $cb->($_[0], Storable::thaw ($data)); 1 }
1850 or return $_[0]->_error (Errno::EBADMSG);
1474 } else { 1851 } else {
1475 # remove prefix 1852 # remove prefix
1476 substr $_[0]{rbuf}, 0, $format, ""; 1853 substr $_[0]{rbuf}, 0, $format, "";
1477 1854
1478 # read remaining chunk 1855 # read remaining chunk
1479 $_[0]->unshift_read (chunk => $len, sub { 1856 $_[0]->unshift_read (chunk => $len, sub {
1480 if (my $ref = eval { Storable::thaw ($_[1]) }) { 1857 eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1481 $cb->($_[0], $ref);
1482 } else {
1483 $self->_error (Errno::EBADMSG); 1858 or $_[0]->_error (Errno::EBADMSG);
1484 }
1485 }); 1859 });
1486 } 1860 }
1487 1861
1488 1 1862 1
1489 } 1863 }
1490}; 1864};
1491 1865
1866=item tls_detect => $cb->($handle, $detect, $major, $minor)
1867
1868Checks the input stream for a valid SSL or TLS handshake TLSPaintext
1869record without consuming anything. Only SSL version 3 or higher
1870is handled, up to the fictituous protocol 4.x (but both SSL3+ and
1871SSL2-compatible framing is supported).
1872
1873If it detects that the input data is likely TLS, it calls the callback
1874with a true value for C<$detect> and the (on-wire) TLS version as second
1875and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
18763.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
1877be definitely not TLS, it calls the callback with a false value for
1878C<$detect>.
1879
1880The callback could use this information to decide whether or not to start
1881TLS negotiation.
1882
1883In all cases the data read so far is passed to the following read
1884handlers.
1885
1886Usually you want to use the C<tls_autostart> read type instead.
1887
1888If you want to design a protocol that works in the presence of TLS
1889dtection, make sure that any non-TLS data doesn't start with the octet 22
1890(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
1891read type does are a bit more strict, but might losen in the future to
1892accomodate protocol changes.
1893
1894This read type does not rely on L<AnyEvent::TLS> (and thus, not on
1895L<Net::SSLeay>).
1896
1897=item tls_autostart => $tls[, $tls_ctx]
1898
1899Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
1900to start tls by calling C<starttls> with the given arguments.
1901
1902In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
1903been configured to accept, as servers do not normally send a handshake on
1904their own and ths cannot be detected in this way.
1905
1906See C<tls_detect> above for more details.
1907
1908Example: give the client a chance to start TLS before accepting a text
1909line.
1910
1911 $hdl->push_read (tls_detect => "accept");
1912 $hdl->push_read (line => sub {
1913 print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
1914 });
1915
1916=cut
1917
1918register_read_type tls_detect => sub {
1919 my ($self, $cb) = @_;
1920
1921 sub {
1922 # this regex matches a full or partial tls record
1923 if (
1924 # ssl3+: type(22=handshake) major(=3) minor(any) length_hi
1925 $self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs
1926 # ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
1927 or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs
1928 ) {
1929 return if 3 != length $1; # partial match, can't decide yet
1930
1931 # full match, valid TLS record
1932 my ($major, $minor) = unpack "CC", $1;
1933 $cb->($self, "accept", $major + $minor * 0.1);
1934 } else {
1935 # mismatch == guaranteed not TLS
1936 $cb->($self, undef);
1937 }
1938
1939 1
1940 }
1941};
1942
1943register_read_type tls_autostart => sub {
1944 my ($self, @tls) = @_;
1945
1946 $RH{tls_detect}($self, sub {
1947 return unless $_[1];
1948 $_[0]->starttls (@tls);
1949 })
1950};
1951
1492=back 1952=back
1493 1953
1494=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) 1954=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1495 1955
1496This function (not method) lets you add your own types to C<push_read>. 1956Instead of one of the predefined types, you can also specify the name
1957of a package. AnyEvent will try to load the package and then expects to
1958find a function named C<anyevent_read_type> inside. If it isn't found, it
1959progressively tries to load the parent package until it either finds the
1960function (good) or runs out of packages (bad).
1497 1961
1498Whenever the given C<type> is used, C<push_read> will invoke the code 1962Whenever this type is used, C<push_read> will invoke the function with the
1499reference with the handle object, the callback and the remaining 1963handle object, the original callback and the remaining arguments.
1500arguments.
1501 1964
1502The code reference is supposed to return a callback (usually a closure) 1965The function is supposed to return a callback (usually a closure) that
1503that works as a plain read callback (see C<< ->push_read ($cb) >>). 1966works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
1967mentally treat the function as a "configurable read type to read callback"
1968converter.
1504 1969
1505It should invoke the passed callback when it is done reading (remember to 1970It should invoke the original callback when it is done reading (remember
1506pass C<$handle> as first argument as all other callbacks do that). 1971to pass C<$handle> as first argument as all other callbacks do that,
1972although there is no strict requirement on this).
1507 1973
1508Note that this is a function, and all types registered this way will be
1509global, so try to use unique names.
1510
1511For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, 1974For examples, see the source of this module (F<perldoc -m
1512search for C<register_read_type>)). 1975AnyEvent::Handle>, search for C<register_read_type>)).
1513 1976
1514=item $handle->stop_read 1977=item $handle->stop_read
1515 1978
1516=item $handle->start_read 1979=item $handle->start_read
1517 1980
1523Note that AnyEvent::Handle will automatically C<start_read> for you when 1986Note that AnyEvent::Handle will automatically C<start_read> for you when
1524you change the C<on_read> callback or push/unshift a read callback, and it 1987you change the C<on_read> callback or push/unshift a read callback, and it
1525will automatically C<stop_read> for you when neither C<on_read> is set nor 1988will automatically C<stop_read> for you when neither C<on_read> is set nor
1526there are any read requests in the queue. 1989there are any read requests in the queue.
1527 1990
1528These methods will have no effect when in TLS mode (as TLS doesn't support 1991In older versions of this module (<= 5.3), these methods had no effect,
1529half-duplex connections). 1992as TLS does not support half-duplex connections. In current versions they
1993work as expected, as this behaviour is required to avoid certain resource
1994attacks, where the program would be forced to read (and buffer) arbitrary
1995amounts of data before being able to send some data. The drawback is that
1996some readings of the the SSL/TLS specifications basically require this
1997attack to be working, as SSL/TLS implementations might stall sending data
1998during a rehandshake.
1999
2000As a guideline, during the initial handshake, you should not stop reading,
2001and as a client, it might cause problems, depending on your application.
1530 2002
1531=cut 2003=cut
1532 2004
1533sub stop_read { 2005sub stop_read {
1534 my ($self) = @_; 2006 my ($self) = @_;
1535 2007
1536 delete $self->{_rw} unless $self->{tls}; 2008 delete $self->{_rw};
1537} 2009}
1538 2010
1539sub start_read { 2011sub start_read {
1540 my ($self) = @_; 2012 my ($self) = @_;
1541 2013
1542 unless ($self->{_rw} || $self->{_eof}) { 2014 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1543 Scalar::Util::weaken $self; 2015 Scalar::Util::weaken $self;
1544 2016
1545 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { 2017 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1546 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 2018 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1547 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 2019 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1548 2020
1549 if ($len > 0) { 2021 if ($len > 0) {
1550 $self->{_activity} = AnyEvent->now; 2022 $self->{_activity} = $self->{_ractivity} = AE::now;
1551 2023
1552 if ($self->{tls}) { 2024 if ($self->{tls}) {
1553 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 2025 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1554 2026
1555 &_dotls ($self); 2027 &_dotls ($self);
1556 } else { 2028 } else {
1557 $self->_drain_rbuf; 2029 $self->_drain_rbuf;
1558 } 2030 }
1559 2031
2032 if ($len == $self->{read_size}) {
2033 $self->{read_size} *= 2;
2034 $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
2035 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
2036 }
2037
1560 } elsif (defined $len) { 2038 } elsif (defined $len) {
1561 delete $self->{_rw}; 2039 delete $self->{_rw};
1562 $self->{_eof} = 1; 2040 $self->{_eof} = 1;
1563 $self->_drain_rbuf; 2041 $self->_drain_rbuf;
1564 2042
1565 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 2043 } elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
1566 return $self->_error ($!, 1); 2044 return $self->_error ($!, 1);
1567 } 2045 }
1568 }); 2046 };
1569 } 2047 }
1570} 2048}
1571 2049
1572our $ERROR_SYSCALL; 2050our $ERROR_SYSCALL;
1573our $ERROR_WANT_READ; 2051our $ERROR_WANT_READ;
1576 my ($self, $err) = @_; 2054 my ($self, $err) = @_;
1577 2055
1578 return $self->_error ($!, 1) 2056 return $self->_error ($!, 1)
1579 if $err == Net::SSLeay::ERROR_SYSCALL (); 2057 if $err == Net::SSLeay::ERROR_SYSCALL ();
1580 2058
1581 my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); 2059 my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1582 2060
1583 # reduce error string to look less scary 2061 # reduce error string to look less scary
1584 $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; 2062 $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1585 2063
1586 if ($self->{_on_starttls}) { 2064 if ($self->{_on_starttls}) {
1600sub _dotls { 2078sub _dotls {
1601 my ($self) = @_; 2079 my ($self) = @_;
1602 2080
1603 my $tmp; 2081 my $tmp;
1604 2082
1605 if (length $self->{_tls_wbuf}) { 2083 while (length $self->{_tls_wbuf}) {
1606 while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { 2084 if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1607 substr $self->{_tls_wbuf}, 0, $tmp, ""; 2085 $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
2086
2087 return $self->_tls_error ($tmp)
2088 if $tmp != $ERROR_WANT_READ
2089 && ($tmp != $ERROR_SYSCALL || $!);
2090
2091 last;
1608 } 2092 }
1609 2093
1610 $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); 2094 substr $self->{_tls_wbuf}, 0, $tmp, "";
1611 return $self->_tls_error ($tmp)
1612 if $tmp != $ERROR_WANT_READ
1613 && ($tmp != $ERROR_SYSCALL || $!);
1614 } 2095 }
1615 2096
1616 while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { 2097 while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1617 unless (length $tmp) { 2098 unless (length $tmp) {
1618 $self->{_on_starttls} 2099 $self->{_on_starttls}
1632 $self->{_tls_rbuf} .= $tmp; 2113 $self->{_tls_rbuf} .= $tmp;
1633 $self->_drain_rbuf; 2114 $self->_drain_rbuf;
1634 $self->{tls} or return; # tls session might have gone away in callback 2115 $self->{tls} or return; # tls session might have gone away in callback
1635 } 2116 }
1636 2117
1637 $tmp = Net::SSLeay::get_error ($self->{tls}, -1); 2118 $tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us
1638 return $self->_tls_error ($tmp) 2119 return $self->_tls_error ($tmp)
1639 if $tmp != $ERROR_WANT_READ 2120 if $tmp != $ERROR_WANT_READ
1640 && ($tmp != $ERROR_SYSCALL || $!); 2121 && ($tmp != $ERROR_SYSCALL || $!);
1641 2122
1642 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 2123 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1643 $self->{wbuf} .= $tmp; 2124 $self->{wbuf} .= $tmp;
1644 $self->_drain_wbuf; 2125 $self->_drain_wbuf;
2126 $self->{tls} or return; # tls session might have gone away in callback
1645 } 2127 }
1646 2128
1647 $self->{_on_starttls} 2129 $self->{_on_starttls}
1648 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () 2130 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1649 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); 2131 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1651 2133
1652=item $handle->starttls ($tls[, $tls_ctx]) 2134=item $handle->starttls ($tls[, $tls_ctx])
1653 2135
1654Instead of starting TLS negotiation immediately when the AnyEvent::Handle 2136Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1655object is created, you can also do that at a later time by calling 2137object is created, you can also do that at a later time by calling
1656C<starttls>. 2138C<starttls>. See the C<tls> constructor argument for general info.
1657 2139
1658Starting TLS is currently an asynchronous operation - when you push some 2140Starting TLS is currently an asynchronous operation - when you push some
1659write data and then call C<< ->starttls >> then TLS negotiation will start 2141write data and then call C<< ->starttls >> then TLS negotiation will start
1660immediately, after which the queued write data is then sent. 2142immediately, after which the queued write data is then sent. This might
2143change in future versions, so best make sure you have no outstanding write
2144data when calling this method.
1661 2145
1662The first argument is the same as the C<tls> constructor argument (either 2146The first argument is the same as the C<tls> constructor argument (either
1663C<"connect">, C<"accept"> or an existing Net::SSLeay object). 2147C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1664 2148
1665The second argument is the optional C<AnyEvent::TLS> object that is used 2149The second argument is the optional C<AnyEvent::TLS> object that is used
1671context in C<< $handle->{tls_ctx} >> after this call and can be used or 2155context in C<< $handle->{tls_ctx} >> after this call and can be used or
1672changed to your liking. Note that the handshake might have already started 2156changed to your liking. Note that the handshake might have already started
1673when this function returns. 2157when this function returns.
1674 2158
1675Due to bugs in OpenSSL, it might or might not be possible to do multiple 2159Due to bugs in OpenSSL, it might or might not be possible to do multiple
1676handshakes on the same stream. Best do not attempt to use the stream after 2160handshakes on the same stream. It is best to not attempt to use the
1677stopping TLS. 2161stream after stopping TLS.
2162
2163This method may invoke callbacks (and therefore the handle might be
2164destroyed after it returns).
1678 2165
1679=cut 2166=cut
1680 2167
1681our %TLS_CACHE; #TODO not yet documented, should we? 2168our %TLS_CACHE; #TODO not yet documented, should we?
1682 2169
1684 my ($self, $tls, $ctx) = @_; 2171 my ($self, $tls, $ctx) = @_;
1685 2172
1686 Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" 2173 Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1687 if $self->{tls}; 2174 if $self->{tls};
1688 2175
2176 unless (defined $AnyEvent::TLS::VERSION) {
2177 eval {
2178 require Net::SSLeay;
2179 require AnyEvent::TLS;
2180 1
2181 } or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
2182 }
2183
1689 $self->{tls} = $tls; 2184 $self->{tls} = $tls;
1690 $self->{tls_ctx} = $ctx if @_ > 2; 2185 $self->{tls_ctx} = $ctx if @_ > 2;
1691 2186
1692 return unless $self->{fh}; 2187 return unless $self->{fh};
1693 2188
1694 require Net::SSLeay;
1695
1696 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); 2189 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1697 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); 2190 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1698 2191
1699 $tls = $self->{tls}; 2192 $tls = delete $self->{tls};
1700 $ctx = $self->{tls_ctx}; 2193 $ctx = $self->{tls_ctx};
1701 2194
1702 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session 2195 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1703 2196
1704 if ("HASH" eq ref $ctx) { 2197 if ("HASH" eq ref $ctx) {
1705 require AnyEvent::TLS;
1706
1707 if ($ctx->{cache}) { 2198 if ($ctx->{cache}) {
1708 my $key = $ctx+0; 2199 my $key = $ctx+0;
1709 $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; 2200 $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1710 } else { 2201 } else {
1711 $ctx = new AnyEvent::TLS %$ctx; 2202 $ctx = new AnyEvent::TLS %$ctx;
1733 Net::SSLeay::CTX_set_mode ($tls, 1|2); 2224 Net::SSLeay::CTX_set_mode ($tls, 1|2);
1734 2225
1735 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 2226 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1736 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 2227 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1737 2228
1738 Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); 2229 Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
2230 $self->{rbuf} = "";
1739 2231
1740 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); 2232 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1741 2233
1742 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } 2234 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1743 if $self->{on_starttls}; 2235 if $self->{on_starttls};
1748 2240
1749=item $handle->stoptls 2241=item $handle->stoptls
1750 2242
1751Shuts down the SSL connection - this makes a proper EOF handshake by 2243Shuts down the SSL connection - this makes a proper EOF handshake by
1752sending a close notify to the other side, but since OpenSSL doesn't 2244sending a close notify to the other side, but since OpenSSL doesn't
1753support non-blocking shut downs, it is not guarenteed that you can re-use 2245support non-blocking shut downs, it is not guaranteed that you can re-use
1754the stream afterwards. 2246the stream afterwards.
2247
2248This method may invoke callbacks (and therefore the handle might be
2249destroyed after it returns).
1755 2250
1756=cut 2251=cut
1757 2252
1758sub stoptls { 2253sub stoptls {
1759 my ($self) = @_; 2254 my ($self) = @_;
1760 2255
1761 if ($self->{tls}) { 2256 if ($self->{tls} && $self->{fh}) {
1762 Net::SSLeay::shutdown ($self->{tls}); 2257 Net::SSLeay::shutdown ($self->{tls});
1763 2258
1764 &_dotls; 2259 &_dotls;
1765 2260
1766# # we don't give a shit. no, we do, but we can't. no...#d# 2261# # we don't give a shit. no, we do, but we can't. no...#d#
1778 if $self->{tls} > 0; 2273 if $self->{tls} > 0;
1779 2274
1780 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; 2275 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1781} 2276}
1782 2277
2278=item $handle->resettls
2279
2280This rarely-used method simply resets and TLS state on the handle, usually
2281causing data loss.
2282
2283One case where it may be useful is when you want to skip over the data in
2284the stream but you are not interested in interpreting it, so data loss is
2285no concern.
2286
2287=cut
2288
2289*resettls = \&_freetls;
2290
1783sub DESTROY { 2291sub DESTROY {
1784 my ($self) = @_; 2292 my ($self) = @_;
1785 2293
1786 &_freetls; 2294 &_freetls;
1787 2295
1791 my $fh = delete $self->{fh}; 2299 my $fh = delete $self->{fh};
1792 my $wbuf = delete $self->{wbuf}; 2300 my $wbuf = delete $self->{wbuf};
1793 2301
1794 my @linger; 2302 my @linger;
1795 2303
1796 push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { 2304 push @linger, AE::io $fh, 1, sub {
1797 my $len = syswrite $fh, $wbuf, length $wbuf; 2305 my $len = syswrite $fh, $wbuf, length $wbuf;
1798 2306
1799 if ($len > 0) { 2307 if ($len > 0) {
1800 substr $wbuf, 0, $len, ""; 2308 substr $wbuf, 0, $len, "";
1801 } else { 2309 } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) {
1802 @linger = (); # end 2310 @linger = (); # end
1803 } 2311 }
1804 }); 2312 };
1805 push @linger, AnyEvent->timer (after => $linger, cb => sub { 2313 push @linger, AE::timer $linger, 0, sub {
1806 @linger = (); 2314 @linger = ();
1807 }); 2315 };
1808 } 2316 }
1809} 2317}
1810 2318
1811=item $handle->destroy 2319=item $handle->destroy
1812 2320
1843 2351
1844sub AnyEvent::Handle::destroyed::AUTOLOAD { 2352sub AnyEvent::Handle::destroyed::AUTOLOAD {
1845 #nop 2353 #nop
1846} 2354}
1847 2355
2356=item $handle->destroyed
2357
2358Returns false as long as the handle hasn't been destroyed by a call to C<<
2359->destroy >>, true otherwise.
2360
2361Can be useful to decide whether the handle is still valid after some
2362callback possibly destroyed the handle. For example, C<< ->push_write >>,
2363C<< ->starttls >> and other methods can call user callbacks, which in turn
2364can destroy the handle, so work can be avoided by checking sometimes:
2365
2366 $hdl->starttls ("accept");
2367 return if $hdl->destroyed;
2368 $hdl->push_write (...
2369
2370Note that the call to C<push_write> will silently be ignored if the handle
2371has been destroyed, so often you can just ignore the possibility of the
2372handle being destroyed.
2373
2374=cut
2375
2376sub destroyed { 0 }
2377sub AnyEvent::Handle::destroyed::destroyed { 1 }
2378
1848=item AnyEvent::Handle::TLS_CTX 2379=item AnyEvent::Handle::TLS_CTX
1849 2380
1850This function creates and returns the AnyEvent::TLS object used by default 2381This function creates and returns the AnyEvent::TLS object used by default
1851for TLS mode. 2382for TLS mode.
1852 2383
1879 2410
1880It is only safe to "forget" the reference inside EOF or error callbacks, 2411It is only safe to "forget" the reference inside EOF or error callbacks,
1881from within all other callbacks, you need to explicitly call the C<< 2412from within all other callbacks, you need to explicitly call the C<<
1882->destroy >> method. 2413->destroy >> method.
1883 2414
2415=item Why is my C<on_eof> callback never called?
2416
2417Probably because your C<on_error> callback is being called instead: When
2418you have outstanding requests in your read queue, then an EOF is
2419considered an error as you clearly expected some data.
2420
2421To avoid this, make sure you have an empty read queue whenever your handle
2422is supposed to be "idle" (i.e. connection closes are O.K.). You can set
2423an C<on_read> handler that simply pushes the first read requests in the
2424queue.
2425
2426See also the next question, which explains this in a bit more detail.
2427
2428=item How can I serve requests in a loop?
2429
2430Most protocols consist of some setup phase (authentication for example)
2431followed by a request handling phase, where the server waits for requests
2432and handles them, in a loop.
2433
2434There are two important variants: The first (traditional, better) variant
2435handles requests until the server gets some QUIT command, causing it to
2436close the connection first (highly desirable for a busy TCP server). A
2437client dropping the connection is an error, which means this variant can
2438detect an unexpected detection close.
2439
2440To handle this case, always make sure you have a non-empty read queue, by
2441pushing the "read request start" handler on it:
2442
2443 # we assume a request starts with a single line
2444 my @start_request; @start_request = (line => sub {
2445 my ($hdl, $line) = @_;
2446
2447 ... handle request
2448
2449 # push next request read, possibly from a nested callback
2450 $hdl->push_read (@start_request);
2451 });
2452
2453 # auth done, now go into request handling loop
2454 # now push the first @start_request
2455 $hdl->push_read (@start_request);
2456
2457By always having an outstanding C<push_read>, the handle always expects
2458some data and raises the C<EPIPE> error when the connction is dropped
2459unexpectedly.
2460
2461The second variant is a protocol where the client can drop the connection
2462at any time. For TCP, this means that the server machine may run out of
2463sockets easier, and in general, it means you cannot distinguish a protocl
2464failure/client crash from a normal connection close. Nevertheless, these
2465kinds of protocols are common (and sometimes even the best solution to the
2466problem).
2467
2468Having an outstanding read request at all times is possible if you ignore
2469C<EPIPE> errors, but this doesn't help with when the client drops the
2470connection during a request, which would still be an error.
2471
2472A better solution is to push the initial request read in an C<on_read>
2473callback. This avoids an error, as when the server doesn't expect data
2474(i.e. is idly waiting for the next request, an EOF will not raise an
2475error, but simply result in an C<on_eof> callback. It is also a bit slower
2476and simpler:
2477
2478 # auth done, now go into request handling loop
2479 $hdl->on_read (sub {
2480 my ($hdl) = @_;
2481
2482 # called each time we receive data but the read queue is empty
2483 # simply start read the request
2484
2485 $hdl->push_read (line => sub {
2486 my ($hdl, $line) = @_;
2487
2488 ... handle request
2489
2490 # do nothing special when the request has been handled, just
2491 # let the request queue go empty.
2492 });
2493 });
2494
1884=item I get different callback invocations in TLS mode/Why can't I pause 2495=item I get different callback invocations in TLS mode/Why can't I pause
1885reading? 2496reading?
1886 2497
1887Unlike, say, TCP, TLS connections do not consist of two independent 2498Unlike, say, TCP, TLS connections do not consist of two independent
1888communication channels, one for each direction. Or put differently. The 2499communication channels, one for each direction. Or put differently, the
1889read and write directions are not independent of each other: you cannot 2500read and write directions are not independent of each other: you cannot
1890write data unless you are also prepared to read, and vice versa. 2501write data unless you are also prepared to read, and vice versa.
1891 2502
1892This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> 2503This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1893callback invocations when you are not expecting any read data - the reason 2504callback invocations when you are not expecting any read data - the reason
1894is that AnyEvent::Handle always reads in TLS mode. 2505is that AnyEvent::Handle always reads in TLS mode.
1895 2506
1896During the connection, you have to make sure that you always have a 2507During the connection, you have to make sure that you always have a
1897non-empty read-queue, or an C<on_read> watcher. At the end of the 2508non-empty read-queue, or an C<on_read> watcher. At the end of the
1909 $handle->on_eof (undef); 2520 $handle->on_eof (undef);
1910 $handle->on_error (sub { 2521 $handle->on_error (sub {
1911 my $data = delete $_[0]{rbuf}; 2522 my $data = delete $_[0]{rbuf};
1912 }); 2523 });
1913 2524
2525Note that this example removes the C<rbuf> member from the handle object,
2526which is not normally allowed by the API. It is expressly permitted in
2527this case only, as the handle object needs to be destroyed afterwards.
2528
1914The reason to use C<on_error> is that TCP connections, due to latencies 2529The reason to use C<on_error> is that TCP connections, due to latencies
1915and packets loss, might get closed quite violently with an error, when in 2530and packets loss, might get closed quite violently with an error, when in
1916fact, all data has been received. 2531fact all data has been received.
1917 2532
1918It is usually better to use acknowledgements when transferring data, 2533It is usually better to use acknowledgements when transferring data,
1919to make sure the other side hasn't just died and you got the data 2534to make sure the other side hasn't just died and you got the data
1920intact. This is also one reason why so many internet protocols have an 2535intact. This is also one reason why so many internet protocols have an
1921explicit QUIT command. 2536explicit QUIT command.
1928C<low_water_mark> this will be called precisely when all data has been 2543C<low_water_mark> this will be called precisely when all data has been
1929written to the socket: 2544written to the socket:
1930 2545
1931 $handle->push_write (...); 2546 $handle->push_write (...);
1932 $handle->on_drain (sub { 2547 $handle->on_drain (sub {
1933 warn "all data submitted to the kernel\n"; 2548 AE::log debug => "All data submitted to the kernel.";
1934 undef $handle; 2549 undef $handle;
1935 }); 2550 });
1936 2551
1937If you just want to queue some data and then signal EOF to the other side, 2552If you just want to queue some data and then signal EOF to the other side,
1938consider using C<< ->push_shutdown >> instead. 2553consider using C<< ->push_shutdown >> instead.
1939 2554
1940=item I want to contact a TLS/SSL server, I don't care about security. 2555=item I want to contact a TLS/SSL server, I don't care about security.
1941 2556
1942If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, 2557If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1943simply connect to it and then create the AnyEvent::Handle with the C<tls> 2558connect to it and then create the AnyEvent::Handle with the C<tls>
1944parameter: 2559parameter:
1945 2560
1946 tcp_connect $host, $port, sub { 2561 tcp_connect $host, $port, sub {
1947 my ($fh) = @_; 2562 my ($fh) = @_;
1948 2563
2022When you have intermediate CA certificates that your clients might not 2637When you have intermediate CA certificates that your clients might not
2023know about, just append them to the C<cert_file>. 2638know about, just append them to the C<cert_file>.
2024 2639
2025=back 2640=back
2026 2641
2027
2028=head1 SUBCLASSING AnyEvent::Handle 2642=head1 SUBCLASSING AnyEvent::Handle
2029 2643
2030In many cases, you might want to subclass AnyEvent::Handle. 2644In many cases, you might want to subclass AnyEvent::Handle.
2031 2645
2032To make this easier, a given version of AnyEvent::Handle uses these 2646To make this easier, a given version of AnyEvent::Handle uses these
2048 2662
2049=item * all members not documented here and not prefixed with an underscore 2663=item * all members not documented here and not prefixed with an underscore
2050are free to use in subclasses. 2664are free to use in subclasses.
2051 2665
2052Of course, new versions of AnyEvent::Handle may introduce more "public" 2666Of course, new versions of AnyEvent::Handle may introduce more "public"
2053member variables, but thats just life, at least it is documented. 2667member variables, but that's just life. At least it is documented.
2054 2668
2055=back 2669=back
2056 2670
2057=head1 AUTHOR 2671=head1 AUTHOR
2058 2672
2059Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. 2673Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2060 2674
2061=cut 2675=cut
2062 2676
20631; # End of AnyEvent::Handle 26771
2678

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines