1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
3 | AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use AnyEvent; |
7 | use AnyEvent; |
8 | use AnyEvent::Handle; |
8 | use AnyEvent::Handle; |
… | |
… | |
11 | |
11 | |
12 | my $hdl; $hdl = new AnyEvent::Handle |
12 | my $hdl; $hdl = new AnyEvent::Handle |
13 | fh => \*STDIN, |
13 | fh => \*STDIN, |
14 | on_error => sub { |
14 | on_error => sub { |
15 | my ($hdl, $fatal, $msg) = @_; |
15 | my ($hdl, $fatal, $msg) = @_; |
16 | warn "got error $msg\n"; |
16 | AE::log error => $msg; |
17 | $hdl->destroy; |
17 | $hdl->destroy; |
18 | $cv->send; |
18 | $cv->send; |
19 | ); |
19 | }; |
20 | |
20 | |
21 | # send some request line |
21 | # send some request line |
22 | $hdl->push_write ("getinfo\015\012"); |
22 | $hdl->push_write ("getinfo\015\012"); |
23 | |
23 | |
24 | # read the response line |
24 | # read the response line |
25 | $hdl->push_read (line => sub { |
25 | $hdl->push_read (line => sub { |
26 | my ($hdl, $line) = @_; |
26 | my ($hdl, $line) = @_; |
27 | warn "got line <$line>\n"; |
27 | say "got line <$line>"; |
28 | $cv->send; |
28 | $cv->send; |
29 | }); |
29 | }); |
30 | |
30 | |
31 | $cv->recv; |
31 | $cv->recv; |
32 | |
32 | |
33 | =head1 DESCRIPTION |
33 | =head1 DESCRIPTION |
34 | |
34 | |
35 | This module is a helper module to make it easier to do event-based I/O on |
35 | This is a helper module to make it easier to do event-based I/O on |
36 | filehandles. |
36 | stream-based filehandles (sockets, pipes, and other stream things). |
37 | |
37 | |
38 | The L<AnyEvent::Intro> tutorial contains some well-documented |
38 | The L<AnyEvent::Intro> tutorial contains some well-documented |
39 | AnyEvent::Handle examples. |
39 | AnyEvent::Handle examples. |
40 | |
40 | |
41 | In the following, when the documentation refers to of "bytes" then this |
41 | In the following, where the documentation refers to "bytes", it means |
42 | means characters. As sysread and syswrite are used for all I/O, their |
42 | characters. As sysread and syswrite are used for all I/O, their |
43 | treatment of characters applies to this module as well. |
43 | treatment of characters applies to this module as well. |
44 | |
44 | |
45 | At the very minimum, you should specify C<fh> or C<connect>, and the |
45 | At the very minimum, you should specify C<fh> or C<connect>, and the |
46 | C<on_error> callback. |
46 | C<on_error> callback. |
47 | |
47 | |
… | |
… | |
60 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
60 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
61 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
61 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
62 | |
62 | |
63 | our $VERSION = $AnyEvent::VERSION; |
63 | our $VERSION = $AnyEvent::VERSION; |
64 | |
64 | |
|
|
65 | sub _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 | |
|
|
80 | sub MAX_READ_SIZE() { 131072 } |
|
|
81 | |
65 | =head1 METHODS |
82 | =head1 METHODS |
66 | |
83 | |
67 | =over 4 |
84 | =over 4 |
68 | |
85 | |
69 | =item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... |
86 | =item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value... |
70 | |
87 | |
71 | The constructor supports these arguments (all as C<< key => value >> pairs). |
88 | The constructor supports these arguments (all as C<< key => value >> pairs). |
72 | |
89 | |
73 | =over 4 |
90 | =over 4 |
74 | |
91 | |
… | |
… | |
97 | =over 4 |
114 | =over 4 |
98 | |
115 | |
99 | =item on_prepare => $cb->($handle) |
116 | =item on_prepare => $cb->($handle) |
100 | |
117 | |
101 | This (rarely used) callback is called before a new connection is |
118 | This (rarely used) callback is called before a new connection is |
102 | attempted, but after the file handle has been created. It could be used to |
119 | attempted, but after the file handle has been created (you can access that |
|
|
120 | file handle via C<< $handle->{fh} >>). It could be used to prepare the |
103 | prepare the file handle with parameters required for the actual connect |
121 | file handle with parameters required for the actual connect (as opposed to |
104 | (as opposed to settings that can be changed when the connection is already |
122 | settings that can be changed when the connection is already established). |
105 | established). |
|
|
106 | |
123 | |
107 | The return value of this callback should be the connect timeout value in |
124 | The return value of this callback should be the connect timeout value in |
108 | seconds (or C<0>, or C<undef>, or the empty list, to indicate the default |
125 | seconds (or C<0>, or C<undef>, or the empty list, to indicate that the |
109 | timeout is to be used). |
126 | default timeout is to be used). |
110 | |
127 | |
111 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
128 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
112 | |
129 | |
113 | This callback is called when a connection has been successfully established. |
130 | This callback is called when a connection has been successfully established. |
114 | |
131 | |
115 | The actual numeric host and port (the socket peername) are passed as |
132 | The peer's numeric host and port (the socket peername) are passed as |
116 | parameters, together with a retry callback. |
133 | parameters, together with a retry callback. At the time it is called the |
|
|
134 | read and write queues, EOF status, TLS status and similar properties of |
|
|
135 | the handle will have been reset. |
117 | |
136 | |
|
|
137 | It is not allowed to use the read or write queues while the handle object |
|
|
138 | is connecting. |
|
|
139 | |
118 | When, for some reason, the handle is not acceptable, then calling |
140 | If, for some reason, the handle is not acceptable, calling C<$retry> will |
119 | C<$retry> will continue with the next conenction target (in case of |
141 | continue with the next connection target (in case of multi-homed hosts or |
120 | multi-homed hosts or SRV records there can be multiple connection |
142 | SRV records there can be multiple connection endpoints). The C<$retry> |
121 | endpoints). When it is called then the read and write queues, eof status, |
143 | callback can be invoked after the connect callback returns, i.e. one can |
122 | tls status and similar properties of the handle are being reset. |
144 | start a handshake and then decide to retry with the next host if the |
|
|
145 | handshake fails. |
123 | |
146 | |
124 | In most cases, ignoring the C<$retry> parameter is the way to go. |
147 | In most cases, you should ignore the C<$retry> parameter. |
125 | |
148 | |
126 | =item on_connect_error => $cb->($handle, $message) |
149 | =item on_connect_error => $cb->($handle, $message) |
127 | |
150 | |
128 | This callback is called when the conenction could not be |
151 | This callback is called when the connection could not be |
129 | established. C<$!> will contain the relevant error code, and C<$message> a |
152 | established. C<$!> will contain the relevant error code, and C<$message> a |
130 | message describing it (usually the same as C<"$!">). |
153 | message describing it (usually the same as C<"$!">). |
131 | |
154 | |
132 | If this callback isn't specified, then C<on_error> will be called with a |
155 | If this callback isn't specified, then C<on_error> will be called with a |
133 | fatal error instead. |
156 | fatal error instead. |
… | |
… | |
136 | |
159 | |
137 | =item on_error => $cb->($handle, $fatal, $message) |
160 | =item on_error => $cb->($handle, $fatal, $message) |
138 | |
161 | |
139 | This is the error callback, which is called when, well, some error |
162 | This is the error callback, which is called when, well, some error |
140 | occured, such as not being able to resolve the hostname, failure to |
163 | occured, such as not being able to resolve the hostname, failure to |
141 | connect or a read error. |
164 | connect, or a read error. |
142 | |
165 | |
143 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
166 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
144 | fatal errors the handle object will be destroyed (by a call to C<< -> |
167 | fatal errors the handle object will be destroyed (by a call to C<< -> |
145 | destroy >>) after invoking the error callback (which means you are free to |
168 | destroy >>) after invoking the error callback (which means you are free to |
146 | examine the handle object). Examples of fatal errors are an EOF condition |
169 | examine the handle object). Examples of fatal errors are an EOF condition |
147 | with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In |
170 | with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In |
148 | cases where the other side can close the connection at their will it is |
171 | cases where the other side can close the connection at will, it is |
149 | often easiest to not report C<EPIPE> errors in this callback. |
172 | often easiest to not report C<EPIPE> errors in this callback. |
150 | |
173 | |
151 | AnyEvent::Handle tries to find an appropriate error code for you to check |
174 | AnyEvent::Handle tries to find an appropriate error code for you to check |
152 | against, but in some cases (TLS errors), this does not work well. It is |
175 | against, but in some cases (TLS errors), this does not work well. |
153 | recommended to always output the C<$message> argument in human-readable |
|
|
154 | error messages (it's usually the same as C<"$!">). |
|
|
155 | |
176 | |
|
|
177 | If you report the error to the user, it is recommended to always output |
|
|
178 | the C<$message> argument in human-readable error messages (you don't need |
|
|
179 | to report C<"$!"> if you report C<$message>). |
|
|
180 | |
|
|
181 | If you want to react programmatically to the error, then looking at C<$!> |
|
|
182 | and comparing it against some of the documented C<Errno> values is usually |
|
|
183 | better than looking at the C<$message>. |
|
|
184 | |
156 | Non-fatal errors can be retried by simply returning, but it is recommended |
185 | Non-fatal errors can be retried by returning, but it is recommended |
157 | to simply ignore this parameter and instead abondon the handle object |
186 | to simply ignore this parameter and instead abondon the handle object |
158 | when this callback is invoked. Examples of non-fatal errors are timeouts |
187 | when this callback is invoked. Examples of non-fatal errors are timeouts |
159 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
188 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
160 | |
189 | |
161 | On callback entrance, the value of C<$!> contains the operating system |
190 | On entry to the callback, the value of C<$!> contains the operating |
162 | error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
191 | system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
163 | C<EPROTO>). |
192 | C<EPROTO>). |
164 | |
193 | |
165 | While not mandatory, it is I<highly> recommended to set this callback, as |
194 | While not mandatory, it is I<highly> recommended to set this callback, as |
166 | you will not be notified of errors otherwise. The default simply calls |
195 | you will not be notified of errors otherwise. The default just calls |
167 | C<croak>. |
196 | C<croak>. |
168 | |
197 | |
169 | =item on_read => $cb->($handle) |
198 | =item on_read => $cb->($handle) |
170 | |
199 | |
171 | This sets the default read callback, which is called when data arrives |
200 | This sets the default read callback, which is called when data arrives |
… | |
… | |
176 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
205 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
177 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
206 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
178 | must not enlarge or modify the read buffer, you can only remove data at |
207 | must not enlarge or modify the read buffer, you can only remove data at |
179 | the beginning from it. |
208 | the beginning from it. |
180 | |
209 | |
|
|
210 | You can also call C<< ->push_read (...) >> or any other function that |
|
|
211 | modifies the read queue. Or do both. Or ... |
|
|
212 | |
181 | When an EOF condition is detected then AnyEvent::Handle will first try to |
213 | When an EOF condition is detected, AnyEvent::Handle will first try to |
182 | feed all the remaining data to the queued callbacks and C<on_read> before |
214 | feed all the remaining data to the queued callbacks and C<on_read> before |
183 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
215 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
184 | error will be raised (with C<$!> set to C<EPIPE>). |
216 | error will be raised (with C<$!> set to C<EPIPE>). |
185 | |
217 | |
186 | Note that, unlike requests in the read queue, an C<on_read> callback |
218 | Note that, unlike requests in the read queue, an C<on_read> callback |
… | |
… | |
204 | If an EOF condition has been detected but no C<on_eof> callback has been |
236 | If an EOF condition has been detected but no C<on_eof> callback has been |
205 | set, then a fatal error will be raised with C<$!> set to <0>. |
237 | set, then a fatal error will be raised with C<$!> set to <0>. |
206 | |
238 | |
207 | =item on_drain => $cb->($handle) |
239 | =item on_drain => $cb->($handle) |
208 | |
240 | |
209 | This sets the callback that is called when the write buffer becomes empty |
241 | This sets the callback that is called once when the write buffer becomes |
210 | (or when the callback is set and the buffer is empty already). |
242 | empty (and immediately when the handle object is created). |
211 | |
243 | |
212 | To append to the write buffer, use the C<< ->push_write >> method. |
244 | To append to the write buffer, use the C<< ->push_write >> method. |
213 | |
245 | |
214 | This callback is useful when you don't want to put all of your write data |
246 | This callback is useful when you don't want to put all of your write data |
215 | into the queue at once, for example, when you want to write the contents |
247 | into the queue at once, for example, when you want to write the contents |
… | |
… | |
227 | many seconds pass without a successful read or write on the underlying |
259 | many seconds pass without a successful read or write on the underlying |
228 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
260 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
229 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
261 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
230 | error will be raised). |
262 | error will be raised). |
231 | |
263 | |
232 | There are three variants of the timeouts that work fully independent |
264 | There are three variants of the timeouts that work independently of each |
233 | of each other, for both read and write, just read, and just write: |
265 | other, for both read and write (triggered when nothing was read I<OR> |
|
|
266 | written), just read (triggered when nothing was read), and just write: |
234 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
267 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
235 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
268 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
236 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
269 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
237 | |
270 | |
238 | Note that timeout processing is also active when you currently do not have |
271 | Note that timeout processing is active even when you do not have any |
239 | any outstanding read or write requests: If you plan to keep the connection |
272 | outstanding read or write requests: If you plan to keep the connection |
240 | idle then you should disable the timout temporarily or ignore the timeout |
273 | idle then you should disable the timeout temporarily or ignore the |
241 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
274 | timeout in the corresponding C<on_timeout> callback, in which case |
242 | restart the timeout. |
275 | AnyEvent::Handle will simply restart the timeout. |
243 | |
276 | |
244 | Zero (the default) disables this timeout. |
277 | Zero (the default) disables the corresponding timeout. |
245 | |
278 | |
246 | =item on_timeout => $cb->($handle) |
279 | =item on_timeout => $cb->($handle) |
|
|
280 | |
|
|
281 | =item on_rtimeout => $cb->($handle) |
|
|
282 | |
|
|
283 | =item on_wtimeout => $cb->($handle) |
247 | |
284 | |
248 | Called whenever the inactivity timeout passes. If you return from this |
285 | Called whenever the inactivity timeout passes. If you return from this |
249 | callback, then the timeout will be reset as if some activity had happened, |
286 | callback, then the timeout will be reset as if some activity had happened, |
250 | so this condition is not fatal in any way. |
287 | so this condition is not fatal in any way. |
251 | |
288 | |
… | |
… | |
259 | be configured to accept only so-and-so much data that it cannot act on |
296 | be configured to accept only so-and-so much data that it cannot act on |
260 | (for example, when expecting a line, an attacker could send an unlimited |
297 | (for example, when expecting a line, an attacker could send an unlimited |
261 | amount of data without a callback ever being called as long as the line |
298 | amount of data without a callback ever being called as long as the line |
262 | isn't finished). |
299 | isn't finished). |
263 | |
300 | |
|
|
301 | =item wbuf_max => <bytes> |
|
|
302 | |
|
|
303 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
|
|
304 | when the write buffer ever (strictly) exceeds this size. This is useful to |
|
|
305 | avoid some forms of denial-of-service attacks. |
|
|
306 | |
|
|
307 | Although the units of this parameter is bytes, this is the I<raw> number |
|
|
308 | of bytes not yet accepted by the kernel. This can make a difference when |
|
|
309 | you e.g. use TLS, as TLS typically makes your write data larger (but it |
|
|
310 | can also make it smaller due to compression). |
|
|
311 | |
|
|
312 | As an example of when this limit is useful, take a chat server that sends |
|
|
313 | chat messages to a client. If the client does not read those in a timely |
|
|
314 | manner then the send buffer in the server would grow unbounded. |
|
|
315 | |
264 | =item autocork => <boolean> |
316 | =item autocork => <boolean> |
265 | |
317 | |
266 | When disabled (the default), then C<push_write> will try to immediately |
318 | When disabled (the default), C<push_write> will try to immediately |
267 | write the data to the handle, if possible. This avoids having to register |
319 | write the data to the handle if possible. This avoids having to register |
268 | a write watcher and wait for the next event loop iteration, but can |
320 | a write watcher and wait for the next event loop iteration, but can |
269 | be inefficient if you write multiple small chunks (on the wire, this |
321 | be inefficient if you write multiple small chunks (on the wire, this |
270 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
322 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
271 | C<no_delay>, but this option can save costly syscalls). |
323 | C<no_delay>, but this option can save costly syscalls). |
272 | |
324 | |
273 | When enabled, then writes will always be queued till the next event loop |
325 | When enabled, writes will always be queued till the next event loop |
274 | iteration. This is efficient when you do many small writes per iteration, |
326 | iteration. This is efficient when you do many small writes per iteration, |
275 | but less efficient when you do a single write only per iteration (or when |
327 | but less efficient when you do a single write only per iteration (or when |
276 | the write buffer often is full). It also increases write latency. |
328 | the write buffer often is full). It also increases write latency. |
277 | |
329 | |
278 | =item no_delay => <boolean> |
330 | =item no_delay => <boolean> |
… | |
… | |
282 | the Nagle algorithm, and usually it is beneficial. |
334 | the Nagle algorithm, and usually it is beneficial. |
283 | |
335 | |
284 | In some situations you want as low a delay as possible, which can be |
336 | In some situations you want as low a delay as possible, which can be |
285 | accomplishd by setting this option to a true value. |
337 | accomplishd by setting this option to a true value. |
286 | |
338 | |
287 | The default is your opertaing system's default behaviour (most likely |
339 | The default is your operating system's default behaviour (most likely |
288 | enabled), this option explicitly enables or disables it, if possible. |
340 | enabled). This option explicitly enables or disables it, if possible. |
289 | |
341 | |
290 | =item keepalive => <boolean> |
342 | =item keepalive => <boolean> |
291 | |
343 | |
292 | Enables (default disable) the SO_KEEPALIVE option on the stream socket: |
344 | Enables (default disable) the SO_KEEPALIVE option on the stream socket: |
293 | normally, TCP connections have no time-out once established, so TCP |
345 | normally, TCP connections have no time-out once established, so TCP |
294 | conenctions, once established, can stay alive forever even when the other |
346 | connections, once established, can stay alive forever even when the other |
295 | side has long gone. TCP keepalives are a cheap way to take down long-lived |
347 | side has long gone. TCP keepalives are a cheap way to take down long-lived |
296 | TCP connections whent he other side becomes unreachable. While the default |
348 | TCP connections when the other side becomes unreachable. While the default |
297 | is OS-dependent, TCP keepalives usually kick in after around two hours, |
349 | is OS-dependent, TCP keepalives usually kick in after around two hours, |
298 | and, if the other side doesn't reply, take down the TCP connection some 10 |
350 | and, if the other side doesn't reply, take down the TCP connection some 10 |
299 | to 15 minutes later. |
351 | to 15 minutes later. |
300 | |
352 | |
301 | It is harmless to specify this option for file handles that do not support |
353 | It is harmless to specify this option for file handles that do not support |
… | |
… | |
306 | |
358 | |
307 | BSD majorly fucked up the implementation of TCP urgent data. The result |
359 | BSD majorly fucked up the implementation of TCP urgent data. The result |
308 | is that almost no OS implements TCP according to the specs, and every OS |
360 | is that almost no OS implements TCP according to the specs, and every OS |
309 | implements it slightly differently. |
361 | implements it slightly differently. |
310 | |
362 | |
311 | If you want to handle TCP urgent data, then setting this flag gives you |
363 | If you want to handle TCP urgent data, then setting this flag (the default |
312 | the most portable way of getting urgent data, by putting it into the |
364 | is enabled) gives you the most portable way of getting urgent data, by |
313 | stream. |
365 | putting it into the stream. |
|
|
366 | |
|
|
367 | Since BSD emulation of OOB data on top of TCP's urgent data can have |
|
|
368 | security implications, AnyEvent::Handle sets this flag automatically |
|
|
369 | unless explicitly specified. Note that setting this flag after |
|
|
370 | establishing a connection I<may> be a bit too late (data loss could |
|
|
371 | already have occured on BSD systems), but at least it will protect you |
|
|
372 | from most attacks. |
314 | |
373 | |
315 | =item read_size => <bytes> |
374 | =item read_size => <bytes> |
316 | |
375 | |
317 | The default read block size (the amount of bytes this module will |
376 | The initial read block size, the number of bytes this module will try |
318 | try to read during each loop iteration, which affects memory |
377 | to read during each loop iteration. Each handle object will consume |
319 | requirements). Default: C<8192>. |
378 | at least this amount of memory for the read buffer as well, so when |
|
|
379 | handling many connections watch out for memory requirements). See also |
|
|
380 | C<max_read_size>. Default: C<2048>. |
|
|
381 | |
|
|
382 | =item max_read_size => <bytes> |
|
|
383 | |
|
|
384 | The maximum read buffer size used by the dynamic adjustment |
|
|
385 | algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in |
|
|
386 | one go it will double C<read_size> up to the maximum given by this |
|
|
387 | option. Default: C<131072> or C<read_size>, whichever is higher. |
320 | |
388 | |
321 | =item low_water_mark => <bytes> |
389 | =item low_water_mark => <bytes> |
322 | |
390 | |
323 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
391 | Sets the number of bytes (default: C<0>) that make up an "empty" write |
324 | buffer: If the write reaches this size or gets even samller it is |
392 | buffer: If the buffer reaches this size or gets even samller it is |
325 | considered empty. |
393 | considered empty. |
326 | |
394 | |
327 | Sometimes it can be beneficial (for performance reasons) to add data to |
395 | Sometimes it can be beneficial (for performance reasons) to add data to |
328 | the write buffer before it is fully drained, but this is a rare case, as |
396 | the write buffer before it is fully drained, but this is a rare case, as |
329 | the operating system kernel usually buffers data as well, so the default |
397 | the operating system kernel usually buffers data as well, so the default |
330 | is good in almost all cases. |
398 | is good in almost all cases. |
331 | |
399 | |
332 | =item linger => <seconds> |
400 | =item linger => <seconds> |
333 | |
401 | |
334 | If non-zero (default: C<3600>), then the destructor of the |
402 | If this is non-zero (default: C<3600>), the destructor of the |
335 | AnyEvent::Handle object will check whether there is still outstanding |
403 | AnyEvent::Handle object will check whether there is still outstanding |
336 | write data and will install a watcher that will write this data to the |
404 | write data and will install a watcher that will write this data to the |
337 | socket. No errors will be reported (this mostly matches how the operating |
405 | socket. No errors will be reported (this mostly matches how the operating |
338 | system treats outstanding data at socket close time). |
406 | system treats outstanding data at socket close time). |
339 | |
407 | |
… | |
… | |
346 | A string used to identify the remote site - usually the DNS hostname |
414 | A string used to identify the remote site - usually the DNS hostname |
347 | (I<not> IDN!) used to create the connection, rarely the IP address. |
415 | (I<not> IDN!) used to create the connection, rarely the IP address. |
348 | |
416 | |
349 | Apart from being useful in error messages, this string is also used in TLS |
417 | Apart from being useful in error messages, this string is also used in TLS |
350 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
418 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
351 | verification will be skipped when C<peername> is not specified or |
419 | verification will be skipped when C<peername> is not specified or is |
352 | C<undef>. |
420 | C<undef>. |
353 | |
421 | |
354 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
422 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
355 | |
423 | |
356 | When this parameter is given, it enables TLS (SSL) mode, that means |
424 | When this parameter is given, it enables TLS (SSL) mode, that means |
357 | AnyEvent will start a TLS handshake as soon as the conenction has been |
425 | AnyEvent will start a TLS handshake as soon as the connection has been |
358 | established and will transparently encrypt/decrypt data afterwards. |
426 | established and will transparently encrypt/decrypt data afterwards. |
359 | |
427 | |
360 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
428 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
361 | appropriate error message. |
429 | appropriate error message. |
362 | |
430 | |
363 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
431 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
364 | automatically when you try to create a TLS handle): this module doesn't |
432 | automatically when you try to create a TLS handle): this module doesn't |
365 | have a dependency on that module, so if your module requires it, you have |
433 | have a dependency on that module, so if your module requires it, you have |
366 | to add the dependency yourself. |
434 | to add the dependency yourself. If Net::SSLeay cannot be loaded or is too |
|
|
435 | old, you get an C<EPROTO> error. |
367 | |
436 | |
368 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
437 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
369 | C<accept>, and for the TLS client side of a connection, use C<connect> |
438 | C<accept>, and for the TLS client side of a connection, use C<connect> |
370 | mode. |
439 | mode. |
371 | |
440 | |
… | |
… | |
382 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
451 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
383 | passing in the wrong integer will lead to certain crash. This most often |
452 | passing in the wrong integer will lead to certain crash. This most often |
384 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
453 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
385 | segmentation fault. |
454 | segmentation fault. |
386 | |
455 | |
387 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
456 | Use the C<< ->starttls >> method if you need to start TLS negotiation later. |
388 | |
457 | |
389 | =item tls_ctx => $anyevent_tls |
458 | =item tls_ctx => $anyevent_tls |
390 | |
459 | |
391 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
460 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
392 | (unless a connection object was specified directly). If this parameter is |
461 | (unless a connection object was specified directly). If this |
393 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
462 | parameter is missing (or C<undef>), then AnyEvent::Handle will use |
|
|
463 | C<AnyEvent::Handle::TLS_CTX>. |
394 | |
464 | |
395 | Instead of an object, you can also specify a hash reference with C<< key |
465 | Instead of an object, you can also specify a hash reference with C<< key |
396 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
466 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
397 | new TLS context object. |
467 | new TLS context object. |
398 | |
468 | |
… | |
… | |
407 | |
477 | |
408 | TLS handshake failures will not cause C<on_error> to be invoked when this |
478 | TLS handshake failures will not cause C<on_error> to be invoked when this |
409 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
479 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
410 | |
480 | |
411 | Without this callback, handshake failures lead to C<on_error> being |
481 | Without this callback, handshake failures lead to C<on_error> being |
412 | called, as normal. |
482 | called as usual. |
413 | |
483 | |
414 | Note that you cannot call C<starttls> right again in this callback. If you |
484 | Note that you cannot just call C<starttls> again in this callback. If you |
415 | need to do that, start an zero-second timer instead whose callback can |
485 | need to do that, start an zero-second timer instead whose callback can |
416 | then call C<< ->starttls >> again. |
486 | then call C<< ->starttls >> again. |
417 | |
487 | |
418 | =item on_stoptls => $cb->($handle) |
488 | =item on_stoptls => $cb->($handle) |
419 | |
489 | |
… | |
… | |
426 | callback. |
496 | callback. |
427 | |
497 | |
428 | This callback will only be called on TLS shutdowns, not when the |
498 | This callback will only be called on TLS shutdowns, not when the |
429 | underlying handle signals EOF. |
499 | underlying handle signals EOF. |
430 | |
500 | |
431 | =item json => JSON or JSON::XS object |
501 | =item json => L<JSON> or L<JSON::XS> object |
432 | |
502 | |
433 | This is the json coder object used by the C<json> read and write types. |
503 | This is the json coder object used by the C<json> read and write types. |
434 | |
504 | |
435 | If you don't supply it, then AnyEvent::Handle will create and use a |
505 | If you don't supply it, then AnyEvent::Handle will create and use a |
436 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
506 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
437 | texts. |
507 | texts. |
438 | |
508 | |
439 | Note that you are responsible to depend on the JSON module if you want to |
509 | Note that you are responsible to depend on the L<JSON> module if you want |
440 | use this functionality, as AnyEvent does not have a dependency itself. |
510 | to use this functionality, as AnyEvent does not have a dependency on it |
|
|
511 | itself. |
|
|
512 | |
|
|
513 | =item cbor => L<CBOR::XS> object |
|
|
514 | |
|
|
515 | This is the cbor coder object used by the C<cbor> read and write types. |
|
|
516 | |
|
|
517 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
518 | suitable one (on demand), which will write CBOR without using extensions, |
|
|
519 | if possible. texts. |
|
|
520 | |
|
|
521 | Note that you are responsible to depend on the L<CBOR::XS> module if you |
|
|
522 | want to use this functionality, as AnyEvent does not have a dependency on |
|
|
523 | it itself. |
441 | |
524 | |
442 | =back |
525 | =back |
443 | |
526 | |
444 | =cut |
527 | =cut |
445 | |
528 | |
… | |
… | |
467 | $self->{connect}[0], |
550 | $self->{connect}[0], |
468 | $self->{connect}[1], |
551 | $self->{connect}[1], |
469 | sub { |
552 | sub { |
470 | my ($fh, $host, $port, $retry) = @_; |
553 | my ($fh, $host, $port, $retry) = @_; |
471 | |
554 | |
|
|
555 | delete $self->{_connect}; # no longer needed |
|
|
556 | |
472 | if ($fh) { |
557 | if ($fh) { |
473 | $self->{fh} = $fh; |
558 | $self->{fh} = $fh; |
474 | |
559 | |
475 | delete $self->{_skip_drain_rbuf}; |
560 | delete $self->{_skip_drain_rbuf}; |
476 | $self->_start; |
561 | $self->_start; |
… | |
… | |
483 | }); |
568 | }); |
484 | |
569 | |
485 | } else { |
570 | } else { |
486 | if ($self->{on_connect_error}) { |
571 | if ($self->{on_connect_error}) { |
487 | $self->{on_connect_error}($self, "$!"); |
572 | $self->{on_connect_error}($self, "$!"); |
488 | $self->destroy; |
573 | $self->destroy if $self; |
489 | } else { |
574 | } else { |
490 | $self->_error ($!, 1); |
575 | $self->_error ($!, 1); |
491 | } |
576 | } |
492 | } |
577 | } |
493 | }, |
578 | }, |
494 | sub { |
579 | sub { |
495 | local $self->{fh} = $_[0]; |
580 | local $self->{fh} = $_[0]; |
496 | |
581 | |
497 | $self->{on_prepare} |
582 | $self->{on_prepare} |
498 | ? $self->{on_prepare}->($self) |
583 | ? $self->{on_prepare}->($self) |
499 | : () |
584 | : () |
500 | } |
585 | } |
501 | ); |
586 | ); |
502 | } |
587 | } |
503 | |
588 | |
… | |
… | |
509 | } |
594 | } |
510 | |
595 | |
511 | sub _start { |
596 | sub _start { |
512 | my ($self) = @_; |
597 | my ($self) = @_; |
513 | |
598 | |
|
|
599 | # too many clueless people try to use udp and similar sockets |
|
|
600 | # with AnyEvent::Handle, do them a favour. |
|
|
601 | my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE (); |
|
|
602 | Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!" |
|
|
603 | if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type; |
|
|
604 | |
514 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
605 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
515 | |
606 | |
516 | $self->{_activity} = |
607 | $self->{_activity} = |
517 | $self->{_ractivity} = |
608 | $self->{_ractivity} = |
518 | $self->{_wactivity} = AE::now; |
609 | $self->{_wactivity} = AE::now; |
519 | |
610 | |
|
|
611 | $self->{read_size} ||= 2048; |
|
|
612 | $self->{max_read_size} = $self->{read_size} |
|
|
613 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
|
|
614 | |
520 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
615 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
521 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
616 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
522 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
617 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
523 | |
618 | |
524 | $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay}; |
619 | $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; |
525 | $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive}; |
620 | $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive}; |
|
|
621 | |
526 | $self->oobinline (delete $self->{oobinline}) if exists $self->{oobinline}; |
622 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
527 | |
623 | |
528 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
624 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
529 | if $self->{tls}; |
625 | if $self->{tls}; |
530 | |
626 | |
531 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
627 | $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain}; |
532 | |
628 | |
533 | $self->start_read |
629 | $self->start_read |
534 | if $self->{on_read} || @{ $self->{_queue} }; |
630 | if $self->{on_read} || @{ $self->{_queue} }; |
535 | |
631 | |
536 | $self->_drain_wbuf; |
632 | $self->_drain_wbuf; |
… | |
… | |
543 | $message ||= "$!"; |
639 | $message ||= "$!"; |
544 | |
640 | |
545 | if ($self->{on_error}) { |
641 | if ($self->{on_error}) { |
546 | $self->{on_error}($self, $fatal, $message); |
642 | $self->{on_error}($self, $fatal, $message); |
547 | $self->destroy if $fatal; |
643 | $self->destroy if $fatal; |
548 | } elsif ($self->{fh}) { |
644 | } elsif ($self->{fh} || $self->{connect}) { |
549 | $self->destroy; |
645 | $self->destroy; |
550 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
646 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
551 | } |
647 | } |
552 | } |
648 | } |
553 | |
649 | |
… | |
… | |
612 | =cut |
708 | =cut |
613 | |
709 | |
614 | sub no_delay { |
710 | sub no_delay { |
615 | $_[0]{no_delay} = $_[1]; |
711 | $_[0]{no_delay} = $_[1]; |
616 | |
712 | |
617 | eval { |
|
|
618 | local $SIG{__DIE__}; |
|
|
619 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
713 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
620 | if $_[0]{fh}; |
714 | if $_[0]{fh}; |
621 | }; |
|
|
622 | } |
715 | } |
623 | |
716 | |
624 | =item $handle->keepalive ($boolean) |
717 | =item $handle->keepalive ($boolean) |
625 | |
718 | |
626 | Enables or disables the C<keepalive> setting (see constructor argument of |
719 | Enables or disables the C<keepalive> setting (see constructor argument of |
… | |
… | |
686 | |
779 | |
687 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
780 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
688 | |
781 | |
689 | =cut |
782 | =cut |
690 | |
783 | |
691 | sub on_starttls { |
784 | sub on_stoptls { |
692 | $_[0]{on_stoptls} = $_[1]; |
785 | $_[0]{on_stoptls} = $_[1]; |
693 | } |
786 | } |
694 | |
787 | |
695 | =item $handle->rbuf_max ($max_octets) |
788 | =item $handle->rbuf_max ($max_octets) |
696 | |
789 | |
697 | Configures the C<rbuf_max> setting (C<undef> disables it). |
790 | Configures the C<rbuf_max> setting (C<undef> disables it). |
|
|
791 | |
|
|
792 | =item $handle->wbuf_max ($max_octets) |
|
|
793 | |
|
|
794 | Configures the C<wbuf_max> setting (C<undef> disables it). |
698 | |
795 | |
699 | =cut |
796 | =cut |
700 | |
797 | |
701 | sub rbuf_max { |
798 | sub rbuf_max { |
702 | $_[0]{rbuf_max} = $_[1]; |
799 | $_[0]{rbuf_max} = $_[1]; |
703 | } |
800 | } |
704 | |
801 | |
|
|
802 | sub wbuf_max { |
|
|
803 | $_[0]{wbuf_max} = $_[1]; |
|
|
804 | } |
|
|
805 | |
705 | ############################################################################# |
806 | ############################################################################# |
706 | |
807 | |
707 | =item $handle->timeout ($seconds) |
808 | =item $handle->timeout ($seconds) |
708 | |
809 | |
709 | =item $handle->rtimeout ($seconds) |
810 | =item $handle->rtimeout ($seconds) |
710 | |
811 | |
711 | =item $handle->wtimeout ($seconds) |
812 | =item $handle->wtimeout ($seconds) |
712 | |
813 | |
713 | Configures (or disables) the inactivity timeout. |
814 | Configures (or disables) the inactivity timeout. |
|
|
815 | |
|
|
816 | The timeout will be checked instantly, so this method might destroy the |
|
|
817 | handle before it returns. |
714 | |
818 | |
715 | =item $handle->timeout_reset |
819 | =item $handle->timeout_reset |
716 | |
820 | |
717 | =item $handle->rtimeout_reset |
821 | =item $handle->rtimeout_reset |
718 | |
822 | |
… | |
… | |
735 | $_[0]{$on_timeout} = $_[1]; |
839 | $_[0]{$on_timeout} = $_[1]; |
736 | }; |
840 | }; |
737 | |
841 | |
738 | *$timeout = sub { |
842 | *$timeout = sub { |
739 | my ($self, $new_value) = @_; |
843 | my ($self, $new_value) = @_; |
|
|
844 | |
|
|
845 | $new_value >= 0 |
|
|
846 | or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught"; |
740 | |
847 | |
741 | $self->{$timeout} = $new_value; |
848 | $self->{$timeout} = $new_value; |
742 | delete $self->{$tw}; &$cb; |
849 | delete $self->{$tw}; &$cb; |
743 | }; |
850 | }; |
744 | |
851 | |
… | |
… | |
799 | |
906 | |
800 | The write queue is very simple: you can add data to its end, and |
907 | The write queue is very simple: you can add data to its end, and |
801 | AnyEvent::Handle will automatically try to get rid of it for you. |
908 | AnyEvent::Handle will automatically try to get rid of it for you. |
802 | |
909 | |
803 | When data could be written and the write buffer is shorter then the low |
910 | When data could be written and the write buffer is shorter then the low |
804 | water mark, the C<on_drain> callback will be invoked. |
911 | water mark, the C<on_drain> callback will be invoked once. |
805 | |
912 | |
806 | =over 4 |
913 | =over 4 |
807 | |
914 | |
808 | =item $handle->on_drain ($cb) |
915 | =item $handle->on_drain ($cb) |
809 | |
916 | |
810 | Sets the C<on_drain> callback or clears it (see the description of |
917 | Sets the C<on_drain> callback or clears it (see the description of |
811 | C<on_drain> in the constructor). |
918 | C<on_drain> in the constructor). |
812 | |
919 | |
|
|
920 | This method may invoke callbacks (and therefore the handle might be |
|
|
921 | destroyed after it returns). |
|
|
922 | |
813 | =cut |
923 | =cut |
814 | |
924 | |
815 | sub on_drain { |
925 | sub on_drain { |
816 | my ($self, $cb) = @_; |
926 | my ($self, $cb) = @_; |
817 | |
927 | |
… | |
… | |
821 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
931 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
822 | } |
932 | } |
823 | |
933 | |
824 | =item $handle->push_write ($data) |
934 | =item $handle->push_write ($data) |
825 | |
935 | |
826 | Queues the given scalar to be written. You can push as much data as you |
936 | Queues the given scalar to be written. You can push as much data as |
827 | want (only limited by the available memory), as C<AnyEvent::Handle> |
937 | you want (only limited by the available memory and C<wbuf_max>), as |
828 | buffers it independently of the kernel. |
938 | C<AnyEvent::Handle> buffers it independently of the kernel. |
|
|
939 | |
|
|
940 | This method may invoke callbacks (and therefore the handle might be |
|
|
941 | destroyed after it returns). |
829 | |
942 | |
830 | =cut |
943 | =cut |
831 | |
944 | |
832 | sub _drain_wbuf { |
945 | sub _drain_wbuf { |
833 | my ($self) = @_; |
946 | my ($self) = @_; |
… | |
… | |
858 | $cb->() unless $self->{autocork}; |
971 | $cb->() unless $self->{autocork}; |
859 | |
972 | |
860 | # if still data left in wbuf, we need to poll |
973 | # if still data left in wbuf, we need to poll |
861 | $self->{_ww} = AE::io $self->{fh}, 1, $cb |
974 | $self->{_ww} = AE::io $self->{fh}, 1, $cb |
862 | if length $self->{wbuf}; |
975 | if length $self->{wbuf}; |
|
|
976 | |
|
|
977 | if ( |
|
|
978 | defined $self->{wbuf_max} |
|
|
979 | && $self->{wbuf_max} < length $self->{wbuf} |
|
|
980 | ) { |
|
|
981 | $self->_error (Errno::ENOSPC, 1), return; |
|
|
982 | } |
863 | }; |
983 | }; |
864 | } |
984 | } |
865 | |
985 | |
866 | our %WH; |
986 | our %WH; |
867 | |
987 | |
|
|
988 | # deprecated |
868 | sub register_write_type($$) { |
989 | sub register_write_type($$) { |
869 | $WH{$_[0]} = $_[1]; |
990 | $WH{$_[0]} = $_[1]; |
870 | } |
991 | } |
871 | |
992 | |
872 | sub push_write { |
993 | sub push_write { |
873 | my $self = shift; |
994 | my $self = shift; |
874 | |
995 | |
875 | if (@_ > 1) { |
996 | if (@_ > 1) { |
876 | my $type = shift; |
997 | my $type = shift; |
877 | |
998 | |
|
|
999 | @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" |
878 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
1000 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") |
879 | ->($self, @_); |
1001 | ->($self, @_); |
880 | } |
1002 | } |
881 | |
1003 | |
|
|
1004 | # we downgrade here to avoid hard-to-track-down bugs, |
|
|
1005 | # and diagnose the problem earlier and better. |
|
|
1006 | |
882 | if ($self->{tls}) { |
1007 | if ($self->{tls}) { |
883 | $self->{_tls_wbuf} .= $_[0]; |
1008 | utf8::downgrade $self->{_tls_wbuf} .= $_[0]; |
884 | &_dotls ($self) if $self->{fh}; |
1009 | &_dotls ($self) if $self->{fh}; |
885 | } else { |
1010 | } else { |
886 | $self->{wbuf} .= $_[0]; |
1011 | utf8::downgrade $self->{wbuf} .= $_[0]; |
887 | $self->_drain_wbuf if $self->{fh}; |
1012 | $self->_drain_wbuf if $self->{fh}; |
888 | } |
1013 | } |
889 | } |
1014 | } |
890 | |
1015 | |
891 | =item $handle->push_write (type => @args) |
1016 | =item $handle->push_write (type => @args) |
892 | |
1017 | |
893 | Instead of formatting your data yourself, you can also let this module do |
1018 | Instead of formatting your data yourself, you can also let this module |
894 | the job by specifying a type and type-specific arguments. |
1019 | do the job by specifying a type and type-specific arguments. You |
|
|
1020 | can also specify the (fully qualified) name of a package, in which |
|
|
1021 | case AnyEvent tries to load the package and then expects to find the |
|
|
1022 | C<anyevent_write_type> function inside (see "custom write types", below). |
895 | |
1023 | |
896 | Predefined types are (if you have ideas for additional types, feel free to |
1024 | Predefined types are (if you have ideas for additional types, feel free to |
897 | drop by and tell us): |
1025 | drop by and tell us): |
898 | |
1026 | |
899 | =over 4 |
1027 | =over 4 |
… | |
… | |
938 | |
1066 | |
939 | The generated JSON text is guaranteed not to contain any newlines: While |
1067 | The generated JSON text is guaranteed not to contain any newlines: While |
940 | this module doesn't need delimiters after or between JSON texts to be |
1068 | this module doesn't need delimiters after or between JSON texts to be |
941 | able to read them, many other languages depend on that. |
1069 | able to read them, many other languages depend on that. |
942 | |
1070 | |
943 | A simple RPC protocol that interoperates easily with others is to send |
1071 | A simple RPC protocol that interoperates easily with other languages is |
944 | JSON arrays (or objects, although arrays are usually the better choice as |
1072 | to send JSON arrays (or objects, although arrays are usually the better |
945 | they mimic how function argument passing works) and a newline after each |
1073 | choice as they mimic how function argument passing works) and a newline |
946 | JSON text: |
1074 | after each JSON text: |
947 | |
1075 | |
948 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
1076 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
949 | $handle->push_write ("\012"); |
1077 | $handle->push_write ("\012"); |
950 | |
1078 | |
951 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
1079 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
… | |
… | |
954 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
1082 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
955 | |
1083 | |
956 | Other languages could read single lines terminated by a newline and pass |
1084 | Other languages could read single lines terminated by a newline and pass |
957 | this line into their JSON decoder of choice. |
1085 | this line into their JSON decoder of choice. |
958 | |
1086 | |
|
|
1087 | =item cbor => $perl_scalar |
|
|
1088 | |
|
|
1089 | Encodes the given scalar into a CBOR value. Unless you provide your own |
|
|
1090 | L<CBOR::XS> object, this means it will be encoded to a CBOR string not |
|
|
1091 | using any extensions, if possible. |
|
|
1092 | |
|
|
1093 | CBOR values are self-delimiting, so you can write CBOR at one end of |
|
|
1094 | a handle and read them at the other end without using any additional |
|
|
1095 | framing. |
|
|
1096 | |
|
|
1097 | A simple nd very very fast RPC protocol that interoperates with |
|
|
1098 | other languages is to send CBOR and receive CBOR values (arrays are |
|
|
1099 | recommended): |
|
|
1100 | |
|
|
1101 | $handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever |
|
|
1102 | |
|
|
1103 | An AnyEvent::Handle receiver would simply use the C<cbor> read type: |
|
|
1104 | |
|
|
1105 | $handle->push_read (cbor => sub { my $array = $_[1]; ... }); |
|
|
1106 | |
959 | =cut |
1107 | =cut |
960 | |
1108 | |
961 | sub json_coder() { |
1109 | sub json_coder() { |
962 | eval { require JSON::XS; JSON::XS->new->utf8 } |
1110 | eval { require JSON::XS; JSON::XS->new->utf8 } |
963 | || do { require JSON; JSON->new->utf8 } |
1111 | || do { require JSON; JSON->new->utf8 } |
964 | } |
1112 | } |
965 | |
1113 | |
966 | register_write_type json => sub { |
1114 | register_write_type json => sub { |
967 | my ($self, $ref) = @_; |
1115 | my ($self, $ref) = @_; |
968 | |
1116 | |
969 | my $json = $self->{json} ||= json_coder; |
1117 | ($self->{json} ||= json_coder) |
970 | |
|
|
971 | $json->encode ($ref) |
1118 | ->encode ($ref) |
|
|
1119 | }; |
|
|
1120 | |
|
|
1121 | sub cbor_coder() { |
|
|
1122 | require CBOR::XS; |
|
|
1123 | CBOR::XS->new |
|
|
1124 | } |
|
|
1125 | |
|
|
1126 | register_write_type cbor => sub { |
|
|
1127 | my ($self, $scalar) = @_; |
|
|
1128 | |
|
|
1129 | ($self->{cbor} ||= cbor_coder) |
|
|
1130 | ->encode ($scalar) |
972 | }; |
1131 | }; |
973 | |
1132 | |
974 | =item storable => $reference |
1133 | =item storable => $reference |
975 | |
1134 | |
976 | Freezes the given reference using L<Storable> and writes it to the |
1135 | Freezes the given reference using L<Storable> and writes it to the |
… | |
… | |
979 | =cut |
1138 | =cut |
980 | |
1139 | |
981 | register_write_type storable => sub { |
1140 | register_write_type storable => sub { |
982 | my ($self, $ref) = @_; |
1141 | my ($self, $ref) = @_; |
983 | |
1142 | |
984 | require Storable; |
1143 | require Storable unless $Storable::VERSION; |
985 | |
1144 | |
986 | pack "w/a*", Storable::nfreeze ($ref) |
1145 | pack "w/a*", Storable::nfreeze ($ref) |
987 | }; |
1146 | }; |
988 | |
1147 | |
989 | =back |
1148 | =back |
… | |
… | |
994 | before it was actually written. One way to do that is to replace your |
1153 | before it was actually written. One way to do that is to replace your |
995 | C<on_drain> handler by a callback that shuts down the socket (and set |
1154 | C<on_drain> handler by a callback that shuts down the socket (and set |
996 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
1155 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
997 | replaces the C<on_drain> callback with: |
1156 | replaces the C<on_drain> callback with: |
998 | |
1157 | |
999 | sub { shutdown $_[0]{fh}, 1 } # for push_shutdown |
1158 | sub { shutdown $_[0]{fh}, 1 } |
1000 | |
1159 | |
1001 | This simply shuts down the write side and signals an EOF condition to the |
1160 | This simply shuts down the write side and signals an EOF condition to the |
1002 | the peer. |
1161 | the peer. |
1003 | |
1162 | |
1004 | You can rely on the normal read queue and C<on_eof> handling |
1163 | You can rely on the normal read queue and C<on_eof> handling |
1005 | afterwards. This is the cleanest way to close a connection. |
1164 | afterwards. This is the cleanest way to close a connection. |
1006 | |
1165 | |
|
|
1166 | This method may invoke callbacks (and therefore the handle might be |
|
|
1167 | destroyed after it returns). |
|
|
1168 | |
1007 | =cut |
1169 | =cut |
1008 | |
1170 | |
1009 | sub push_shutdown { |
1171 | sub push_shutdown { |
1010 | my ($self) = @_; |
1172 | my ($self) = @_; |
1011 | |
1173 | |
1012 | delete $self->{low_water_mark}; |
1174 | delete $self->{low_water_mark}; |
1013 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
1175 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
1014 | } |
1176 | } |
1015 | |
1177 | |
1016 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
1178 | =item custom write types - Package::anyevent_write_type $handle, @args |
1017 | |
1179 | |
1018 | This function (not method) lets you add your own types to C<push_write>. |
1180 | Instead of one of the predefined types, you can also specify the name of |
|
|
1181 | a package. AnyEvent will try to load the package and then expects to find |
|
|
1182 | a function named C<anyevent_write_type> inside. If it isn't found, it |
|
|
1183 | progressively tries to load the parent package until it either finds the |
|
|
1184 | function (good) or runs out of packages (bad). |
|
|
1185 | |
1019 | Whenever the given C<type> is used, C<push_write> will invoke the code |
1186 | Whenever the given C<type> is used, C<push_write> will the function with |
1020 | reference with the handle object and the remaining arguments. |
1187 | the handle object and the remaining arguments. |
1021 | |
1188 | |
1022 | The code reference is supposed to return a single octet string that will |
1189 | The function is supposed to return a single octet string that will be |
1023 | be appended to the write buffer. |
1190 | appended to the write buffer, so you can mentally treat this function as a |
|
|
1191 | "arguments to on-the-wire-format" converter. |
1024 | |
1192 | |
1025 | Note that this is a function, and all types registered this way will be |
1193 | Example: implement a custom write type C<join> that joins the remaining |
1026 | global, so try to use unique names. |
1194 | arguments using the first one. |
|
|
1195 | |
|
|
1196 | $handle->push_write (My::Type => " ", 1,2,3); |
|
|
1197 | |
|
|
1198 | # uses the following package, which can be defined in the "My::Type" or in |
|
|
1199 | # the "My" modules to be auto-loaded, or just about anywhere when the |
|
|
1200 | # My::Type::anyevent_write_type is defined before invoking it. |
|
|
1201 | |
|
|
1202 | package My::Type; |
|
|
1203 | |
|
|
1204 | sub anyevent_write_type { |
|
|
1205 | my ($handle, $delim, @args) = @_; |
|
|
1206 | |
|
|
1207 | join $delim, @args |
|
|
1208 | } |
1027 | |
1209 | |
1028 | =cut |
1210 | =cut |
1029 | |
1211 | |
1030 | ############################################################################# |
1212 | ############################################################################# |
1031 | |
1213 | |
… | |
… | |
1040 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1222 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1041 | a queue. |
1223 | a queue. |
1042 | |
1224 | |
1043 | In the simple case, you just install an C<on_read> callback and whenever |
1225 | In the simple case, you just install an C<on_read> callback and whenever |
1044 | new data arrives, it will be called. You can then remove some data (if |
1226 | new data arrives, it will be called. You can then remove some data (if |
1045 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
1227 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can |
1046 | leave the data there if you want to accumulate more (e.g. when only a |
1228 | leave the data there if you want to accumulate more (e.g. when only a |
1047 | partial message has been received so far). |
1229 | partial message has been received so far), or change the read queue with |
|
|
1230 | e.g. C<push_read>. |
1048 | |
1231 | |
1049 | In the more complex case, you want to queue multiple callbacks. In this |
1232 | In the more complex case, you want to queue multiple callbacks. In this |
1050 | case, AnyEvent::Handle will call the first queued callback each time new |
1233 | case, AnyEvent::Handle will call the first queued callback each time new |
1051 | data arrives (also the first time it is queued) and removes it when it has |
1234 | data arrives (also the first time it is queued) and remove it when it has |
1052 | done its job (see C<push_read>, below). |
1235 | done its job (see C<push_read>, below). |
1053 | |
1236 | |
1054 | This way you can, for example, push three line-reads, followed by reading |
1237 | This way you can, for example, push three line-reads, followed by reading |
1055 | a chunk of data, and AnyEvent::Handle will execute them in order. |
1238 | a chunk of data, and AnyEvent::Handle will execute them in order. |
1056 | |
1239 | |
… | |
… | |
1187 | |
1370 | |
1188 | This replaces the currently set C<on_read> callback, or clears it (when |
1371 | This replaces the currently set C<on_read> callback, or clears it (when |
1189 | the new callback is C<undef>). See the description of C<on_read> in the |
1372 | the new callback is C<undef>). See the description of C<on_read> in the |
1190 | constructor. |
1373 | constructor. |
1191 | |
1374 | |
|
|
1375 | This method may invoke callbacks (and therefore the handle might be |
|
|
1376 | destroyed after it returns). |
|
|
1377 | |
1192 | =cut |
1378 | =cut |
1193 | |
1379 | |
1194 | sub on_read { |
1380 | sub on_read { |
1195 | my ($self, $cb) = @_; |
1381 | my ($self, $cb) = @_; |
1196 | |
1382 | |
… | |
… | |
1198 | $self->_drain_rbuf if $cb; |
1384 | $self->_drain_rbuf if $cb; |
1199 | } |
1385 | } |
1200 | |
1386 | |
1201 | =item $handle->rbuf |
1387 | =item $handle->rbuf |
1202 | |
1388 | |
1203 | Returns the read buffer (as a modifiable lvalue). |
1389 | Returns the read buffer (as a modifiable lvalue). You can also access the |
|
|
1390 | read buffer directly as the C<< ->{rbuf} >> member, if you want (this is |
|
|
1391 | much faster, and no less clean). |
1204 | |
1392 | |
1205 | You can access the read buffer directly as the C<< ->{rbuf} >> |
1393 | The only operation allowed on the read buffer (apart from looking at it) |
1206 | member, if you want. However, the only operation allowed on the |
1394 | is removing data from its beginning. Otherwise modifying or appending to |
1207 | read buffer (apart from looking at it) is removing data from its |
1395 | it is not allowed and will lead to hard-to-track-down bugs. |
1208 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
1209 | lead to hard-to-track-down bugs. |
|
|
1210 | |
1396 | |
1211 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
1397 | NOTE: The read buffer should only be used or modified in the C<on_read> |
1212 | C<push_read> or C<unshift_read> methods are used. The other read methods |
1398 | callback or when C<push_read> or C<unshift_read> are used with a single |
1213 | automatically manage the read buffer. |
1399 | callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods |
|
|
1400 | will manage the read buffer on their own. |
1214 | |
1401 | |
1215 | =cut |
1402 | =cut |
1216 | |
1403 | |
1217 | sub rbuf : lvalue { |
1404 | sub rbuf : lvalue { |
1218 | $_[0]{rbuf} |
1405 | $_[0]{rbuf} |
… | |
… | |
1235 | |
1422 | |
1236 | If enough data was available, then the callback must remove all data it is |
1423 | If enough data was available, then the callback must remove all data it is |
1237 | interested in (which can be none at all) and return a true value. After returning |
1424 | interested in (which can be none at all) and return a true value. After returning |
1238 | true, it will be removed from the queue. |
1425 | true, it will be removed from the queue. |
1239 | |
1426 | |
|
|
1427 | These methods may invoke callbacks (and therefore the handle might be |
|
|
1428 | destroyed after it returns). |
|
|
1429 | |
1240 | =cut |
1430 | =cut |
1241 | |
1431 | |
1242 | our %RH; |
1432 | our %RH; |
1243 | |
1433 | |
1244 | sub register_read_type($$) { |
1434 | sub register_read_type($$) { |
… | |
… | |
1250 | my $cb = pop; |
1440 | my $cb = pop; |
1251 | |
1441 | |
1252 | if (@_) { |
1442 | if (@_) { |
1253 | my $type = shift; |
1443 | my $type = shift; |
1254 | |
1444 | |
|
|
1445 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1255 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
1446 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read") |
1256 | ->($self, $cb, @_); |
1447 | ->($self, $cb, @_); |
1257 | } |
1448 | } |
1258 | |
1449 | |
1259 | push @{ $self->{_queue} }, $cb; |
1450 | push @{ $self->{_queue} }, $cb; |
1260 | $self->_drain_rbuf; |
1451 | $self->_drain_rbuf; |
… | |
… | |
1265 | my $cb = pop; |
1456 | my $cb = pop; |
1266 | |
1457 | |
1267 | if (@_) { |
1458 | if (@_) { |
1268 | my $type = shift; |
1459 | my $type = shift; |
1269 | |
1460 | |
|
|
1461 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1270 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
1462 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read") |
1271 | ->($self, $cb, @_); |
1463 | ->($self, $cb, @_); |
1272 | } |
1464 | } |
1273 | |
1465 | |
1274 | unshift @{ $self->{_queue} }, $cb; |
1466 | unshift @{ $self->{_queue} }, $cb; |
1275 | $self->_drain_rbuf; |
1467 | $self->_drain_rbuf; |
… | |
… | |
1279 | |
1471 | |
1280 | =item $handle->unshift_read (type => @args, $cb) |
1472 | =item $handle->unshift_read (type => @args, $cb) |
1281 | |
1473 | |
1282 | Instead of providing a callback that parses the data itself you can chose |
1474 | Instead of providing a callback that parses the data itself you can chose |
1283 | between a number of predefined parsing formats, for chunks of data, lines |
1475 | between a number of predefined parsing formats, for chunks of data, lines |
1284 | etc. |
1476 | etc. You can also specify the (fully qualified) name of a package, in |
|
|
1477 | which case AnyEvent tries to load the package and then expects to find the |
|
|
1478 | C<anyevent_read_type> function inside (see "custom read types", below). |
1285 | |
1479 | |
1286 | Predefined types are (if you have ideas for additional types, feel free to |
1480 | Predefined types are (if you have ideas for additional types, feel free to |
1287 | drop by and tell us): |
1481 | drop by and tell us): |
1288 | |
1482 | |
1289 | =over 4 |
1483 | =over 4 |
… | |
… | |
1295 | data. |
1489 | data. |
1296 | |
1490 | |
1297 | Example: read 2 bytes. |
1491 | Example: read 2 bytes. |
1298 | |
1492 | |
1299 | $handle->push_read (chunk => 2, sub { |
1493 | $handle->push_read (chunk => 2, sub { |
1300 | warn "yay ", unpack "H*", $_[1]; |
1494 | say "yay " . unpack "H*", $_[1]; |
1301 | }); |
1495 | }); |
1302 | |
1496 | |
1303 | =cut |
1497 | =cut |
1304 | |
1498 | |
1305 | register_read_type chunk => sub { |
1499 | register_read_type chunk => sub { |
… | |
… | |
1335 | |
1529 | |
1336 | register_read_type line => sub { |
1530 | register_read_type line => sub { |
1337 | my ($self, $cb, $eol) = @_; |
1531 | my ($self, $cb, $eol) = @_; |
1338 | |
1532 | |
1339 | if (@_ < 3) { |
1533 | if (@_ < 3) { |
1340 | # this is more than twice as fast as the generic code below |
1534 | # this is faster then the generic code below |
1341 | sub { |
1535 | sub { |
1342 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1536 | (my $pos = index $_[0]{rbuf}, "\012") >= 0 |
|
|
1537 | or return; |
1343 | |
1538 | |
|
|
1539 | (my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die; |
1344 | $cb->($_[0], $1, $2); |
1540 | $cb->($_[0], $str, "$1"); |
1345 | 1 |
1541 | 1 |
1346 | } |
1542 | } |
1347 | } else { |
1543 | } else { |
1348 | $eol = quotemeta $eol unless ref $eol; |
1544 | $eol = quotemeta $eol unless ref $eol; |
1349 | $eol = qr|^(.*?)($eol)|s; |
1545 | $eol = qr|^(.*?)($eol)|s; |
1350 | |
1546 | |
1351 | sub { |
1547 | sub { |
1352 | $_[0]{rbuf} =~ s/$eol// or return; |
1548 | $_[0]{rbuf} =~ s/$eol// or return; |
1353 | |
1549 | |
1354 | $cb->($_[0], $1, $2); |
1550 | $cb->($_[0], "$1", "$2"); |
1355 | 1 |
1551 | 1 |
1356 | } |
1552 | } |
1357 | } |
1553 | } |
1358 | }; |
1554 | }; |
1359 | |
1555 | |
… | |
… | |
1381 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1577 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1382 | and everything preceding and including the match will be accepted |
1578 | and everything preceding and including the match will be accepted |
1383 | unconditionally. This is useful to skip large amounts of data that you |
1579 | unconditionally. This is useful to skip large amounts of data that you |
1384 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1580 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1385 | have to start matching from the beginning. This is purely an optimisation |
1581 | have to start matching from the beginning. This is purely an optimisation |
1386 | and is usually worth only when you expect more than a few kilobytes. |
1582 | and is usually worth it only when you expect more than a few kilobytes. |
1387 | |
1583 | |
1388 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1584 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1389 | expect the header to be very large (it isn't in practise, but...), we use |
1585 | expect the header to be very large (it isn't in practice, but...), we use |
1390 | a skip regex to skip initial portions. The skip regex is tricky in that |
1586 | a skip regex to skip initial portions. The skip regex is tricky in that |
1391 | it only accepts something not ending in either \015 or \012, as these are |
1587 | it only accepts something not ending in either \015 or \012, as these are |
1392 | required for the accept regex. |
1588 | required for the accept regex. |
1393 | |
1589 | |
1394 | $handle->push_read (regex => |
1590 | $handle->push_read (regex => |
… | |
… | |
1407 | |
1603 | |
1408 | sub { |
1604 | sub { |
1409 | # accept |
1605 | # accept |
1410 | if ($$rbuf =~ $accept) { |
1606 | if ($$rbuf =~ $accept) { |
1411 | $data .= substr $$rbuf, 0, $+[0], ""; |
1607 | $data .= substr $$rbuf, 0, $+[0], ""; |
1412 | $cb->($self, $data); |
1608 | $cb->($_[0], $data); |
1413 | return 1; |
1609 | return 1; |
1414 | } |
1610 | } |
1415 | |
1611 | |
1416 | # reject |
1612 | # reject |
1417 | if ($reject && $$rbuf =~ $reject) { |
1613 | if ($reject && $$rbuf =~ $reject) { |
1418 | $self->_error (Errno::EBADMSG); |
1614 | $_[0]->_error (Errno::EBADMSG); |
1419 | } |
1615 | } |
1420 | |
1616 | |
1421 | # skip |
1617 | # skip |
1422 | if ($skip && $$rbuf =~ $skip) { |
1618 | if ($skip && $$rbuf =~ $skip) { |
1423 | $data .= substr $$rbuf, 0, $+[0], ""; |
1619 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
1439 | my ($self, $cb) = @_; |
1635 | my ($self, $cb) = @_; |
1440 | |
1636 | |
1441 | sub { |
1637 | sub { |
1442 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1638 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1443 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1639 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1444 | $self->_error (Errno::EBADMSG); |
1640 | $_[0]->_error (Errno::EBADMSG); |
1445 | } |
1641 | } |
1446 | return; |
1642 | return; |
1447 | } |
1643 | } |
1448 | |
1644 | |
1449 | my $len = $1; |
1645 | my $len = $1; |
1450 | |
1646 | |
1451 | $self->unshift_read (chunk => $len, sub { |
1647 | $_[0]->unshift_read (chunk => $len, sub { |
1452 | my $string = $_[1]; |
1648 | my $string = $_[1]; |
1453 | $_[0]->unshift_read (chunk => 1, sub { |
1649 | $_[0]->unshift_read (chunk => 1, sub { |
1454 | if ($_[1] eq ",") { |
1650 | if ($_[1] eq ",") { |
1455 | $cb->($_[0], $string); |
1651 | $cb->($_[0], $string); |
1456 | } else { |
1652 | } else { |
1457 | $self->_error (Errno::EBADMSG); |
1653 | $_[0]->_error (Errno::EBADMSG); |
1458 | } |
1654 | } |
1459 | }); |
1655 | }); |
1460 | }); |
1656 | }); |
1461 | |
1657 | |
1462 | 1 |
1658 | 1 |
… | |
… | |
1532 | my ($self, $cb) = @_; |
1728 | my ($self, $cb) = @_; |
1533 | |
1729 | |
1534 | my $json = $self->{json} ||= json_coder; |
1730 | my $json = $self->{json} ||= json_coder; |
1535 | |
1731 | |
1536 | my $data; |
1732 | my $data; |
1537 | my $rbuf = \$self->{rbuf}; |
|
|
1538 | |
1733 | |
1539 | sub { |
1734 | sub { |
1540 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1735 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1541 | |
1736 | |
1542 | if ($ref) { |
1737 | if ($ref) { |
1543 | $self->{rbuf} = $json->incr_text; |
1738 | $_[0]{rbuf} = $json->incr_text; |
1544 | $json->incr_text = ""; |
1739 | $json->incr_text = ""; |
1545 | $cb->($self, $ref); |
1740 | $cb->($_[0], $ref); |
1546 | |
1741 | |
1547 | 1 |
1742 | 1 |
1548 | } elsif ($@) { |
1743 | } elsif ($@) { |
1549 | # error case |
1744 | # error case |
1550 | $json->incr_skip; |
1745 | $json->incr_skip; |
1551 | |
1746 | |
1552 | $self->{rbuf} = $json->incr_text; |
1747 | $_[0]{rbuf} = $json->incr_text; |
1553 | $json->incr_text = ""; |
1748 | $json->incr_text = ""; |
1554 | |
1749 | |
1555 | $self->_error (Errno::EBADMSG); |
1750 | $_[0]->_error (Errno::EBADMSG); |
1556 | |
1751 | |
1557 | () |
1752 | () |
1558 | } else { |
1753 | } else { |
1559 | $self->{rbuf} = ""; |
1754 | $_[0]{rbuf} = ""; |
1560 | |
1755 | |
|
|
1756 | () |
|
|
1757 | } |
|
|
1758 | } |
|
|
1759 | }; |
|
|
1760 | |
|
|
1761 | =item cbor => $cb->($handle, $scalar) |
|
|
1762 | |
|
|
1763 | Reads a CBOR value, decodes it and passes it to the callback. When a parse |
|
|
1764 | error occurs, an C<EBADMSG> error will be raised. |
|
|
1765 | |
|
|
1766 | If a L<CBOR::XS> object was passed to the constructor, then that will be |
|
|
1767 | used for the final decode, otherwise it will create a CBOR coder without |
|
|
1768 | enabling any options. |
|
|
1769 | |
|
|
1770 | You have to provide a dependency to L<CBOR::XS> on your own: this module |
|
|
1771 | will load the L<CBOR::XS> module, but AnyEvent does not depend on it |
|
|
1772 | itself. |
|
|
1773 | |
|
|
1774 | Since CBOR values are fully self-delimiting, the C<cbor> read and write |
|
|
1775 | types are an ideal simple RPC protocol: just exchange CBOR datagrams. See |
|
|
1776 | the C<cbor> write type description, above, for an actual example. |
|
|
1777 | |
|
|
1778 | =cut |
|
|
1779 | |
|
|
1780 | register_read_type cbor => sub { |
|
|
1781 | my ($self, $cb) = @_; |
|
|
1782 | |
|
|
1783 | my $cbor = $self->{cbor} ||= cbor_coder; |
|
|
1784 | |
|
|
1785 | my $data; |
|
|
1786 | |
|
|
1787 | sub { |
|
|
1788 | my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) }; |
|
|
1789 | |
|
|
1790 | if (@value) { |
|
|
1791 | $cb->($_[0], @value); |
|
|
1792 | |
|
|
1793 | 1 |
|
|
1794 | } elsif ($@) { |
|
|
1795 | # error case |
|
|
1796 | $cbor->incr_reset; |
|
|
1797 | |
|
|
1798 | $_[0]->_error (Errno::EBADMSG); |
|
|
1799 | |
|
|
1800 | () |
|
|
1801 | } else { |
1561 | () |
1802 | () |
1562 | } |
1803 | } |
1563 | } |
1804 | } |
1564 | }; |
1805 | }; |
1565 | |
1806 | |
… | |
… | |
1574 | =cut |
1815 | =cut |
1575 | |
1816 | |
1576 | register_read_type storable => sub { |
1817 | register_read_type storable => sub { |
1577 | my ($self, $cb) = @_; |
1818 | my ($self, $cb) = @_; |
1578 | |
1819 | |
1579 | require Storable; |
1820 | require Storable unless $Storable::VERSION; |
1580 | |
1821 | |
1581 | sub { |
1822 | sub { |
1582 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1823 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1583 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1824 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1584 | or return; |
1825 | or return; |
… | |
… | |
1587 | |
1828 | |
1588 | # bypass unshift if we already have the remaining chunk |
1829 | # bypass unshift if we already have the remaining chunk |
1589 | if ($format + $len <= length $_[0]{rbuf}) { |
1830 | if ($format + $len <= length $_[0]{rbuf}) { |
1590 | my $data = substr $_[0]{rbuf}, $format, $len; |
1831 | my $data = substr $_[0]{rbuf}, $format, $len; |
1591 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
1832 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1833 | |
1592 | $cb->($_[0], Storable::thaw ($data)); |
1834 | eval { $cb->($_[0], Storable::thaw ($data)); 1 } |
|
|
1835 | or return $_[0]->_error (Errno::EBADMSG); |
1593 | } else { |
1836 | } else { |
1594 | # remove prefix |
1837 | # remove prefix |
1595 | substr $_[0]{rbuf}, 0, $format, ""; |
1838 | substr $_[0]{rbuf}, 0, $format, ""; |
1596 | |
1839 | |
1597 | # read remaining chunk |
1840 | # read remaining chunk |
1598 | $_[0]->unshift_read (chunk => $len, sub { |
1841 | $_[0]->unshift_read (chunk => $len, sub { |
1599 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1842 | eval { $cb->($_[0], Storable::thaw ($_[1])); 1 } |
1600 | $cb->($_[0], $ref); |
|
|
1601 | } else { |
|
|
1602 | $self->_error (Errno::EBADMSG); |
1843 | or $_[0]->_error (Errno::EBADMSG); |
1603 | } |
|
|
1604 | }); |
1844 | }); |
1605 | } |
1845 | } |
1606 | |
1846 | |
1607 | 1 |
1847 | 1 |
1608 | } |
1848 | } |
1609 | }; |
1849 | }; |
1610 | |
1850 | |
|
|
1851 | =item tls_detect => $cb->($handle, $detect, $major, $minor) |
|
|
1852 | |
|
|
1853 | Checks the input stream for a valid SSL or TLS handshake TLSPaintext |
|
|
1854 | record without consuming anything. Only SSL version 3 or higher |
|
|
1855 | is handled, up to the fictituous protocol 4.x (but both SSL3+ and |
|
|
1856 | SSL2-compatible framing is supported). |
|
|
1857 | |
|
|
1858 | If it detects that the input data is likely TLS, it calls the callback |
|
|
1859 | with a true value for C<$detect> and the (on-wire) TLS version as second |
|
|
1860 | and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL |
|
|
1861 | 3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to |
|
|
1862 | be definitely not TLS, it calls the callback with a false value for |
|
|
1863 | C<$detect>. |
|
|
1864 | |
|
|
1865 | The callback could use this information to decide whether or not to start |
|
|
1866 | TLS negotiation. |
|
|
1867 | |
|
|
1868 | In all cases the data read so far is passed to the following read |
|
|
1869 | handlers. |
|
|
1870 | |
|
|
1871 | Usually you want to use the C<tls_autostart> read type instead. |
|
|
1872 | |
|
|
1873 | If you want to design a protocol that works in the presence of TLS |
|
|
1874 | dtection, make sure that any non-TLS data doesn't start with the octet 22 |
|
|
1875 | (ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this |
|
|
1876 | read type does are a bit more strict, but might losen in the future to |
|
|
1877 | accomodate protocol changes. |
|
|
1878 | |
|
|
1879 | This read type does not rely on L<AnyEvent::TLS> (and thus, not on |
|
|
1880 | L<Net::SSLeay>). |
|
|
1881 | |
|
|
1882 | =item tls_autostart => $tls[, $tls_ctx] |
|
|
1883 | |
|
|
1884 | Tries to detect a valid SSL or TLS handshake. If one is detected, it tries |
|
|
1885 | to start tls by calling C<starttls> with the given arguments. |
|
|
1886 | |
|
|
1887 | In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has |
|
|
1888 | been configured to accept, as servers do not normally send a handshake on |
|
|
1889 | their own and ths cannot be detected in this way. |
|
|
1890 | |
|
|
1891 | See C<tls_detect> above for more details. |
|
|
1892 | |
|
|
1893 | Example: give the client a chance to start TLS before accepting a text |
|
|
1894 | line. |
|
|
1895 | |
|
|
1896 | $hdl->push_read (tls_detect => "accept"); |
|
|
1897 | $hdl->push_read (line => sub { |
|
|
1898 | print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n"; |
|
|
1899 | }); |
|
|
1900 | |
|
|
1901 | =cut |
|
|
1902 | |
|
|
1903 | register_read_type tls_detect => sub { |
|
|
1904 | my ($self, $cb) = @_; |
|
|
1905 | |
|
|
1906 | sub { |
|
|
1907 | # this regex matches a full or partial tls record |
|
|
1908 | if ( |
|
|
1909 | # ssl3+: type(22=handshake) major(=3) minor(any) length_hi |
|
|
1910 | $self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs |
|
|
1911 | # ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength) |
|
|
1912 | or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs |
|
|
1913 | ) { |
|
|
1914 | return if 3 != length $1; # partial match, can't decide yet |
|
|
1915 | |
|
|
1916 | # full match, valid TLS record |
|
|
1917 | my ($major, $minor) = unpack "CC", $1; |
|
|
1918 | $cb->($self, "accept", $major + $minor * 0.1); |
|
|
1919 | } else { |
|
|
1920 | # mismatch == guaranteed not TLS |
|
|
1921 | $cb->($self, undef); |
|
|
1922 | } |
|
|
1923 | |
|
|
1924 | 1 |
|
|
1925 | } |
|
|
1926 | }; |
|
|
1927 | |
|
|
1928 | register_read_type tls_autostart => sub { |
|
|
1929 | my ($self, @tls) = @_; |
|
|
1930 | |
|
|
1931 | $RH{tls_detect}($self, sub { |
|
|
1932 | return unless $_[1]; |
|
|
1933 | $_[0]->starttls (@tls); |
|
|
1934 | }) |
|
|
1935 | }; |
|
|
1936 | |
1611 | =back |
1937 | =back |
1612 | |
1938 | |
1613 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1939 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
1614 | |
1940 | |
1615 | This function (not method) lets you add your own types to C<push_read>. |
1941 | Instead of one of the predefined types, you can also specify the name |
|
|
1942 | of a package. AnyEvent will try to load the package and then expects to |
|
|
1943 | find a function named C<anyevent_read_type> inside. If it isn't found, it |
|
|
1944 | progressively tries to load the parent package until it either finds the |
|
|
1945 | function (good) or runs out of packages (bad). |
1616 | |
1946 | |
1617 | Whenever the given C<type> is used, C<push_read> will invoke the code |
1947 | Whenever this type is used, C<push_read> will invoke the function with the |
1618 | reference with the handle object, the callback and the remaining |
1948 | handle object, the original callback and the remaining arguments. |
1619 | arguments. |
|
|
1620 | |
1949 | |
1621 | The code reference is supposed to return a callback (usually a closure) |
1950 | The function is supposed to return a callback (usually a closure) that |
1622 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
1951 | works as a plain read callback (see C<< ->push_read ($cb) >>), so you can |
|
|
1952 | mentally treat the function as a "configurable read type to read callback" |
|
|
1953 | converter. |
1623 | |
1954 | |
1624 | It should invoke the passed callback when it is done reading (remember to |
1955 | It should invoke the original callback when it is done reading (remember |
1625 | pass C<$handle> as first argument as all other callbacks do that). |
1956 | to pass C<$handle> as first argument as all other callbacks do that, |
|
|
1957 | although there is no strict requirement on this). |
1626 | |
1958 | |
1627 | Note that this is a function, and all types registered this way will be |
|
|
1628 | global, so try to use unique names. |
|
|
1629 | |
|
|
1630 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
1959 | For examples, see the source of this module (F<perldoc -m |
1631 | search for C<register_read_type>)). |
1960 | AnyEvent::Handle>, search for C<register_read_type>)). |
1632 | |
1961 | |
1633 | =item $handle->stop_read |
1962 | =item $handle->stop_read |
1634 | |
1963 | |
1635 | =item $handle->start_read |
1964 | =item $handle->start_read |
1636 | |
1965 | |
… | |
… | |
1642 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1971 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1643 | you change the C<on_read> callback or push/unshift a read callback, and it |
1972 | you change the C<on_read> callback or push/unshift a read callback, and it |
1644 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1973 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1645 | there are any read requests in the queue. |
1974 | there are any read requests in the queue. |
1646 | |
1975 | |
1647 | These methods will have no effect when in TLS mode (as TLS doesn't support |
1976 | In older versions of this module (<= 5.3), these methods had no effect, |
1648 | half-duplex connections). |
1977 | as TLS does not support half-duplex connections. In current versions they |
|
|
1978 | work as expected, as this behaviour is required to avoid certain resource |
|
|
1979 | attacks, where the program would be forced to read (and buffer) arbitrary |
|
|
1980 | amounts of data before being able to send some data. The drawback is that |
|
|
1981 | some readings of the the SSL/TLS specifications basically require this |
|
|
1982 | attack to be working, as SSL/TLS implementations might stall sending data |
|
|
1983 | during a rehandshake. |
|
|
1984 | |
|
|
1985 | As a guideline, during the initial handshake, you should not stop reading, |
|
|
1986 | and as a client, it might cause problems, depending on your application. |
1649 | |
1987 | |
1650 | =cut |
1988 | =cut |
1651 | |
1989 | |
1652 | sub stop_read { |
1990 | sub stop_read { |
1653 | my ($self) = @_; |
1991 | my ($self) = @_; |
1654 | |
1992 | |
1655 | delete $self->{_rw} unless $self->{tls}; |
1993 | delete $self->{_rw}; |
1656 | } |
1994 | } |
1657 | |
1995 | |
1658 | sub start_read { |
1996 | sub start_read { |
1659 | my ($self) = @_; |
1997 | my ($self) = @_; |
1660 | |
1998 | |
1661 | unless ($self->{_rw} || $self->{_eof}) { |
1999 | unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) { |
1662 | Scalar::Util::weaken $self; |
2000 | Scalar::Util::weaken $self; |
1663 | |
2001 | |
1664 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
2002 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1665 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
2003 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1666 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
2004 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf; |
1667 | |
2005 | |
1668 | if ($len > 0) { |
2006 | if ($len > 0) { |
1669 | $self->{_activity} = $self->{_ractivity} = AE::now; |
2007 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1670 | |
2008 | |
1671 | if ($self->{tls}) { |
2009 | if ($self->{tls}) { |
… | |
… | |
1674 | &_dotls ($self); |
2012 | &_dotls ($self); |
1675 | } else { |
2013 | } else { |
1676 | $self->_drain_rbuf; |
2014 | $self->_drain_rbuf; |
1677 | } |
2015 | } |
1678 | |
2016 | |
|
|
2017 | if ($len == $self->{read_size}) { |
|
|
2018 | $self->{read_size} *= 2; |
|
|
2019 | $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE |
|
|
2020 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
|
|
2021 | } |
|
|
2022 | |
1679 | } elsif (defined $len) { |
2023 | } elsif (defined $len) { |
1680 | delete $self->{_rw}; |
2024 | delete $self->{_rw}; |
1681 | $self->{_eof} = 1; |
2025 | $self->{_eof} = 1; |
1682 | $self->_drain_rbuf; |
2026 | $self->_drain_rbuf; |
1683 | |
2027 | |
… | |
… | |
1695 | my ($self, $err) = @_; |
2039 | my ($self, $err) = @_; |
1696 | |
2040 | |
1697 | return $self->_error ($!, 1) |
2041 | return $self->_error ($!, 1) |
1698 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
2042 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
1699 | |
2043 | |
1700 | my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
2044 | my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
1701 | |
2045 | |
1702 | # reduce error string to look less scary |
2046 | # reduce error string to look less scary |
1703 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
2047 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
1704 | |
2048 | |
1705 | if ($self->{_on_starttls}) { |
2049 | if ($self->{_on_starttls}) { |
… | |
… | |
1719 | sub _dotls { |
2063 | sub _dotls { |
1720 | my ($self) = @_; |
2064 | my ($self) = @_; |
1721 | |
2065 | |
1722 | my $tmp; |
2066 | my $tmp; |
1723 | |
2067 | |
1724 | if (length $self->{_tls_wbuf}) { |
2068 | while (length $self->{_tls_wbuf}) { |
1725 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
2069 | if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) { |
1726 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
2070 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
|
|
2071 | |
|
|
2072 | return $self->_tls_error ($tmp) |
|
|
2073 | if $tmp != $ERROR_WANT_READ |
|
|
2074 | && ($tmp != $ERROR_SYSCALL || $!); |
|
|
2075 | |
|
|
2076 | last; |
1727 | } |
2077 | } |
1728 | |
2078 | |
1729 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
2079 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1730 | return $self->_tls_error ($tmp) |
|
|
1731 | if $tmp != $ERROR_WANT_READ |
|
|
1732 | && ($tmp != $ERROR_SYSCALL || $!); |
|
|
1733 | } |
2080 | } |
1734 | |
2081 | |
1735 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
2082 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1736 | unless (length $tmp) { |
2083 | unless (length $tmp) { |
1737 | $self->{_on_starttls} |
2084 | $self->{_on_starttls} |
… | |
… | |
1751 | $self->{_tls_rbuf} .= $tmp; |
2098 | $self->{_tls_rbuf} .= $tmp; |
1752 | $self->_drain_rbuf; |
2099 | $self->_drain_rbuf; |
1753 | $self->{tls} or return; # tls session might have gone away in callback |
2100 | $self->{tls} or return; # tls session might have gone away in callback |
1754 | } |
2101 | } |
1755 | |
2102 | |
1756 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
2103 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us |
1757 | return $self->_tls_error ($tmp) |
2104 | return $self->_tls_error ($tmp) |
1758 | if $tmp != $ERROR_WANT_READ |
2105 | if $tmp != $ERROR_WANT_READ |
1759 | && ($tmp != $ERROR_SYSCALL || $!); |
2106 | && ($tmp != $ERROR_SYSCALL || $!); |
1760 | |
2107 | |
1761 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
2108 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1762 | $self->{wbuf} .= $tmp; |
2109 | $self->{wbuf} .= $tmp; |
1763 | $self->_drain_wbuf; |
2110 | $self->_drain_wbuf; |
|
|
2111 | $self->{tls} or return; # tls session might have gone away in callback |
1764 | } |
2112 | } |
1765 | |
2113 | |
1766 | $self->{_on_starttls} |
2114 | $self->{_on_starttls} |
1767 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
2115 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1768 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
2116 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
… | |
… | |
1770 | |
2118 | |
1771 | =item $handle->starttls ($tls[, $tls_ctx]) |
2119 | =item $handle->starttls ($tls[, $tls_ctx]) |
1772 | |
2120 | |
1773 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
2121 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1774 | object is created, you can also do that at a later time by calling |
2122 | object is created, you can also do that at a later time by calling |
1775 | C<starttls>. |
2123 | C<starttls>. See the C<tls> constructor argument for general info. |
1776 | |
2124 | |
1777 | Starting TLS is currently an asynchronous operation - when you push some |
2125 | Starting TLS is currently an asynchronous operation - when you push some |
1778 | write data and then call C<< ->starttls >> then TLS negotiation will start |
2126 | write data and then call C<< ->starttls >> then TLS negotiation will start |
1779 | immediately, after which the queued write data is then sent. |
2127 | immediately, after which the queued write data is then sent. This might |
|
|
2128 | change in future versions, so best make sure you have no outstanding write |
|
|
2129 | data when calling this method. |
1780 | |
2130 | |
1781 | The first argument is the same as the C<tls> constructor argument (either |
2131 | The first argument is the same as the C<tls> constructor argument (either |
1782 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
2132 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1783 | |
2133 | |
1784 | The second argument is the optional C<AnyEvent::TLS> object that is used |
2134 | The second argument is the optional C<AnyEvent::TLS> object that is used |
… | |
… | |
1790 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
2140 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1791 | changed to your liking. Note that the handshake might have already started |
2141 | changed to your liking. Note that the handshake might have already started |
1792 | when this function returns. |
2142 | when this function returns. |
1793 | |
2143 | |
1794 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
2144 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1795 | handshakes on the same stream. Best do not attempt to use the stream after |
2145 | handshakes on the same stream. It is best to not attempt to use the |
1796 | stopping TLS. |
2146 | stream after stopping TLS. |
|
|
2147 | |
|
|
2148 | This method may invoke callbacks (and therefore the handle might be |
|
|
2149 | destroyed after it returns). |
1797 | |
2150 | |
1798 | =cut |
2151 | =cut |
1799 | |
2152 | |
1800 | our %TLS_CACHE; #TODO not yet documented, should we? |
2153 | our %TLS_CACHE; #TODO not yet documented, should we? |
1801 | |
2154 | |
… | |
… | |
1803 | my ($self, $tls, $ctx) = @_; |
2156 | my ($self, $tls, $ctx) = @_; |
1804 | |
2157 | |
1805 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
2158 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
1806 | if $self->{tls}; |
2159 | if $self->{tls}; |
1807 | |
2160 | |
|
|
2161 | unless (defined $AnyEvent::TLS::VERSION) { |
|
|
2162 | eval { |
|
|
2163 | require Net::SSLeay; |
|
|
2164 | require AnyEvent::TLS; |
|
|
2165 | 1 |
|
|
2166 | } or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system"); |
|
|
2167 | } |
|
|
2168 | |
1808 | $self->{tls} = $tls; |
2169 | $self->{tls} = $tls; |
1809 | $self->{tls_ctx} = $ctx if @_ > 2; |
2170 | $self->{tls_ctx} = $ctx if @_ > 2; |
1810 | |
2171 | |
1811 | return unless $self->{fh}; |
2172 | return unless $self->{fh}; |
1812 | |
2173 | |
1813 | require Net::SSLeay; |
|
|
1814 | |
|
|
1815 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
2174 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1816 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
2175 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1817 | |
2176 | |
1818 | $tls = delete $self->{tls}; |
2177 | $tls = delete $self->{tls}; |
1819 | $ctx = $self->{tls_ctx}; |
2178 | $ctx = $self->{tls_ctx}; |
1820 | |
2179 | |
1821 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
2180 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1822 | |
2181 | |
1823 | if ("HASH" eq ref $ctx) { |
2182 | if ("HASH" eq ref $ctx) { |
1824 | require AnyEvent::TLS; |
|
|
1825 | |
|
|
1826 | if ($ctx->{cache}) { |
2183 | if ($ctx->{cache}) { |
1827 | my $key = $ctx+0; |
2184 | my $key = $ctx+0; |
1828 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
2185 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
1829 | } else { |
2186 | } else { |
1830 | $ctx = new AnyEvent::TLS %$ctx; |
2187 | $ctx = new AnyEvent::TLS %$ctx; |
… | |
… | |
1852 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
2209 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
1853 | |
2210 | |
1854 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2211 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1855 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2212 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1856 | |
2213 | |
1857 | Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); |
2214 | Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf}); |
|
|
2215 | $self->{rbuf} = ""; |
1858 | |
2216 | |
1859 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
2217 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
1860 | |
2218 | |
1861 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
2219 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
1862 | if $self->{on_starttls}; |
2220 | if $self->{on_starttls}; |
… | |
… | |
1867 | |
2225 | |
1868 | =item $handle->stoptls |
2226 | =item $handle->stoptls |
1869 | |
2227 | |
1870 | Shuts down the SSL connection - this makes a proper EOF handshake by |
2228 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1871 | sending a close notify to the other side, but since OpenSSL doesn't |
2229 | sending a close notify to the other side, but since OpenSSL doesn't |
1872 | support non-blocking shut downs, it is not guarenteed that you can re-use |
2230 | support non-blocking shut downs, it is not guaranteed that you can re-use |
1873 | the stream afterwards. |
2231 | the stream afterwards. |
|
|
2232 | |
|
|
2233 | This method may invoke callbacks (and therefore the handle might be |
|
|
2234 | destroyed after it returns). |
1874 | |
2235 | |
1875 | =cut |
2236 | =cut |
1876 | |
2237 | |
1877 | sub stoptls { |
2238 | sub stoptls { |
1878 | my ($self) = @_; |
2239 | my ($self) = @_; |
1879 | |
2240 | |
1880 | if ($self->{tls}) { |
2241 | if ($self->{tls} && $self->{fh}) { |
1881 | Net::SSLeay::shutdown ($self->{tls}); |
2242 | Net::SSLeay::shutdown ($self->{tls}); |
1882 | |
2243 | |
1883 | &_dotls; |
2244 | &_dotls; |
1884 | |
2245 | |
1885 | # # we don't give a shit. no, we do, but we can't. no...#d# |
2246 | # # we don't give a shit. no, we do, but we can't. no...#d# |
… | |
… | |
1897 | if $self->{tls} > 0; |
2258 | if $self->{tls} > 0; |
1898 | |
2259 | |
1899 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
2260 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
1900 | } |
2261 | } |
1901 | |
2262 | |
|
|
2263 | =item $handle->resettls |
|
|
2264 | |
|
|
2265 | This rarely-used method simply resets and TLS state on the handle, usually |
|
|
2266 | causing data loss. |
|
|
2267 | |
|
|
2268 | One case where it may be useful is when you want to skip over the data in |
|
|
2269 | the stream but you are not interested in interpreting it, so data loss is |
|
|
2270 | no concern. |
|
|
2271 | |
|
|
2272 | =cut |
|
|
2273 | |
|
|
2274 | *resettls = \&_freetls; |
|
|
2275 | |
1902 | sub DESTROY { |
2276 | sub DESTROY { |
1903 | my ($self) = @_; |
2277 | my ($self) = @_; |
1904 | |
2278 | |
1905 | &_freetls; |
2279 | &_freetls; |
1906 | |
2280 | |
… | |
… | |
1915 | push @linger, AE::io $fh, 1, sub { |
2289 | push @linger, AE::io $fh, 1, sub { |
1916 | my $len = syswrite $fh, $wbuf, length $wbuf; |
2290 | my $len = syswrite $fh, $wbuf, length $wbuf; |
1917 | |
2291 | |
1918 | if ($len > 0) { |
2292 | if ($len > 0) { |
1919 | substr $wbuf, 0, $len, ""; |
2293 | substr $wbuf, 0, $len, ""; |
1920 | } else { |
2294 | } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) { |
1921 | @linger = (); # end |
2295 | @linger = (); # end |
1922 | } |
2296 | } |
1923 | }; |
2297 | }; |
1924 | push @linger, AE::timer $linger, 0, sub { |
2298 | push @linger, AE::timer $linger, 0, sub { |
1925 | @linger = (); |
2299 | @linger = (); |
… | |
… | |
1962 | |
2336 | |
1963 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
2337 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
1964 | #nop |
2338 | #nop |
1965 | } |
2339 | } |
1966 | |
2340 | |
|
|
2341 | =item $handle->destroyed |
|
|
2342 | |
|
|
2343 | Returns false as long as the handle hasn't been destroyed by a call to C<< |
|
|
2344 | ->destroy >>, true otherwise. |
|
|
2345 | |
|
|
2346 | Can be useful to decide whether the handle is still valid after some |
|
|
2347 | callback possibly destroyed the handle. For example, C<< ->push_write >>, |
|
|
2348 | C<< ->starttls >> and other methods can call user callbacks, which in turn |
|
|
2349 | can destroy the handle, so work can be avoided by checking sometimes: |
|
|
2350 | |
|
|
2351 | $hdl->starttls ("accept"); |
|
|
2352 | return if $hdl->destroyed; |
|
|
2353 | $hdl->push_write (... |
|
|
2354 | |
|
|
2355 | Note that the call to C<push_write> will silently be ignored if the handle |
|
|
2356 | has been destroyed, so often you can just ignore the possibility of the |
|
|
2357 | handle being destroyed. |
|
|
2358 | |
|
|
2359 | =cut |
|
|
2360 | |
|
|
2361 | sub destroyed { 0 } |
|
|
2362 | sub AnyEvent::Handle::destroyed::destroyed { 1 } |
|
|
2363 | |
1967 | =item AnyEvent::Handle::TLS_CTX |
2364 | =item AnyEvent::Handle::TLS_CTX |
1968 | |
2365 | |
1969 | This function creates and returns the AnyEvent::TLS object used by default |
2366 | This function creates and returns the AnyEvent::TLS object used by default |
1970 | for TLS mode. |
2367 | for TLS mode. |
1971 | |
2368 | |
… | |
… | |
1998 | |
2395 | |
1999 | It is only safe to "forget" the reference inside EOF or error callbacks, |
2396 | It is only safe to "forget" the reference inside EOF or error callbacks, |
2000 | from within all other callbacks, you need to explicitly call the C<< |
2397 | from within all other callbacks, you need to explicitly call the C<< |
2001 | ->destroy >> method. |
2398 | ->destroy >> method. |
2002 | |
2399 | |
|
|
2400 | =item Why is my C<on_eof> callback never called? |
|
|
2401 | |
|
|
2402 | Probably because your C<on_error> callback is being called instead: When |
|
|
2403 | you have outstanding requests in your read queue, then an EOF is |
|
|
2404 | considered an error as you clearly expected some data. |
|
|
2405 | |
|
|
2406 | To avoid this, make sure you have an empty read queue whenever your handle |
|
|
2407 | is supposed to be "idle" (i.e. connection closes are O.K.). You can set |
|
|
2408 | an C<on_read> handler that simply pushes the first read requests in the |
|
|
2409 | queue. |
|
|
2410 | |
|
|
2411 | See also the next question, which explains this in a bit more detail. |
|
|
2412 | |
|
|
2413 | =item How can I serve requests in a loop? |
|
|
2414 | |
|
|
2415 | Most protocols consist of some setup phase (authentication for example) |
|
|
2416 | followed by a request handling phase, where the server waits for requests |
|
|
2417 | and handles them, in a loop. |
|
|
2418 | |
|
|
2419 | There are two important variants: The first (traditional, better) variant |
|
|
2420 | handles requests until the server gets some QUIT command, causing it to |
|
|
2421 | close the connection first (highly desirable for a busy TCP server). A |
|
|
2422 | client dropping the connection is an error, which means this variant can |
|
|
2423 | detect an unexpected detection close. |
|
|
2424 | |
|
|
2425 | To handle this case, always make sure you have a non-empty read queue, by |
|
|
2426 | pushing the "read request start" handler on it: |
|
|
2427 | |
|
|
2428 | # we assume a request starts with a single line |
|
|
2429 | my @start_request; @start_request = (line => sub { |
|
|
2430 | my ($hdl, $line) = @_; |
|
|
2431 | |
|
|
2432 | ... handle request |
|
|
2433 | |
|
|
2434 | # push next request read, possibly from a nested callback |
|
|
2435 | $hdl->push_read (@start_request); |
|
|
2436 | }); |
|
|
2437 | |
|
|
2438 | # auth done, now go into request handling loop |
|
|
2439 | # now push the first @start_request |
|
|
2440 | $hdl->push_read (@start_request); |
|
|
2441 | |
|
|
2442 | By always having an outstanding C<push_read>, the handle always expects |
|
|
2443 | some data and raises the C<EPIPE> error when the connction is dropped |
|
|
2444 | unexpectedly. |
|
|
2445 | |
|
|
2446 | The second variant is a protocol where the client can drop the connection |
|
|
2447 | at any time. For TCP, this means that the server machine may run out of |
|
|
2448 | sockets easier, and in general, it means you cannot distinguish a protocl |
|
|
2449 | failure/client crash from a normal connection close. Nevertheless, these |
|
|
2450 | kinds of protocols are common (and sometimes even the best solution to the |
|
|
2451 | problem). |
|
|
2452 | |
|
|
2453 | Having an outstanding read request at all times is possible if you ignore |
|
|
2454 | C<EPIPE> errors, but this doesn't help with when the client drops the |
|
|
2455 | connection during a request, which would still be an error. |
|
|
2456 | |
|
|
2457 | A better solution is to push the initial request read in an C<on_read> |
|
|
2458 | callback. This avoids an error, as when the server doesn't expect data |
|
|
2459 | (i.e. is idly waiting for the next request, an EOF will not raise an |
|
|
2460 | error, but simply result in an C<on_eof> callback. It is also a bit slower |
|
|
2461 | and simpler: |
|
|
2462 | |
|
|
2463 | # auth done, now go into request handling loop |
|
|
2464 | $hdl->on_read (sub { |
|
|
2465 | my ($hdl) = @_; |
|
|
2466 | |
|
|
2467 | # called each time we receive data but the read queue is empty |
|
|
2468 | # simply start read the request |
|
|
2469 | |
|
|
2470 | $hdl->push_read (line => sub { |
|
|
2471 | my ($hdl, $line) = @_; |
|
|
2472 | |
|
|
2473 | ... handle request |
|
|
2474 | |
|
|
2475 | # do nothing special when the request has been handled, just |
|
|
2476 | # let the request queue go empty. |
|
|
2477 | }); |
|
|
2478 | }); |
|
|
2479 | |
2003 | =item I get different callback invocations in TLS mode/Why can't I pause |
2480 | =item I get different callback invocations in TLS mode/Why can't I pause |
2004 | reading? |
2481 | reading? |
2005 | |
2482 | |
2006 | Unlike, say, TCP, TLS connections do not consist of two independent |
2483 | Unlike, say, TCP, TLS connections do not consist of two independent |
2007 | communication channels, one for each direction. Or put differently. The |
2484 | communication channels, one for each direction. Or put differently, the |
2008 | read and write directions are not independent of each other: you cannot |
2485 | read and write directions are not independent of each other: you cannot |
2009 | write data unless you are also prepared to read, and vice versa. |
2486 | write data unless you are also prepared to read, and vice versa. |
2010 | |
2487 | |
2011 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
2488 | This means that, in TLS mode, you might get C<on_error> or C<on_eof> |
2012 | callback invocations when you are not expecting any read data - the reason |
2489 | callback invocations when you are not expecting any read data - the reason |
2013 | is that AnyEvent::Handle always reads in TLS mode. |
2490 | is that AnyEvent::Handle always reads in TLS mode. |
2014 | |
2491 | |
2015 | During the connection, you have to make sure that you always have a |
2492 | During the connection, you have to make sure that you always have a |
2016 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
2493 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
… | |
… | |
2028 | $handle->on_eof (undef); |
2505 | $handle->on_eof (undef); |
2029 | $handle->on_error (sub { |
2506 | $handle->on_error (sub { |
2030 | my $data = delete $_[0]{rbuf}; |
2507 | my $data = delete $_[0]{rbuf}; |
2031 | }); |
2508 | }); |
2032 | |
2509 | |
|
|
2510 | Note that this example removes the C<rbuf> member from the handle object, |
|
|
2511 | which is not normally allowed by the API. It is expressly permitted in |
|
|
2512 | this case only, as the handle object needs to be destroyed afterwards. |
|
|
2513 | |
2033 | The reason to use C<on_error> is that TCP connections, due to latencies |
2514 | The reason to use C<on_error> is that TCP connections, due to latencies |
2034 | and packets loss, might get closed quite violently with an error, when in |
2515 | and packets loss, might get closed quite violently with an error, when in |
2035 | fact, all data has been received. |
2516 | fact all data has been received. |
2036 | |
2517 | |
2037 | It is usually better to use acknowledgements when transferring data, |
2518 | It is usually better to use acknowledgements when transferring data, |
2038 | to make sure the other side hasn't just died and you got the data |
2519 | to make sure the other side hasn't just died and you got the data |
2039 | intact. This is also one reason why so many internet protocols have an |
2520 | intact. This is also one reason why so many internet protocols have an |
2040 | explicit QUIT command. |
2521 | explicit QUIT command. |
… | |
… | |
2047 | C<low_water_mark> this will be called precisely when all data has been |
2528 | C<low_water_mark> this will be called precisely when all data has been |
2048 | written to the socket: |
2529 | written to the socket: |
2049 | |
2530 | |
2050 | $handle->push_write (...); |
2531 | $handle->push_write (...); |
2051 | $handle->on_drain (sub { |
2532 | $handle->on_drain (sub { |
2052 | warn "all data submitted to the kernel\n"; |
2533 | AE::log debug => "All data submitted to the kernel."; |
2053 | undef $handle; |
2534 | undef $handle; |
2054 | }); |
2535 | }); |
2055 | |
2536 | |
2056 | If you just want to queue some data and then signal EOF to the other side, |
2537 | If you just want to queue some data and then signal EOF to the other side, |
2057 | consider using C<< ->push_shutdown >> instead. |
2538 | consider using C<< ->push_shutdown >> instead. |
2058 | |
2539 | |
2059 | =item I want to contact a TLS/SSL server, I don't care about security. |
2540 | =item I want to contact a TLS/SSL server, I don't care about security. |
2060 | |
2541 | |
2061 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2542 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2062 | simply connect to it and then create the AnyEvent::Handle with the C<tls> |
2543 | connect to it and then create the AnyEvent::Handle with the C<tls> |
2063 | parameter: |
2544 | parameter: |
2064 | |
2545 | |
2065 | tcp_connect $host, $port, sub { |
2546 | tcp_connect $host, $port, sub { |
2066 | my ($fh) = @_; |
2547 | my ($fh) = @_; |
2067 | |
2548 | |
… | |
… | |
2141 | When you have intermediate CA certificates that your clients might not |
2622 | When you have intermediate CA certificates that your clients might not |
2142 | know about, just append them to the C<cert_file>. |
2623 | know about, just append them to the C<cert_file>. |
2143 | |
2624 | |
2144 | =back |
2625 | =back |
2145 | |
2626 | |
2146 | |
|
|
2147 | =head1 SUBCLASSING AnyEvent::Handle |
2627 | =head1 SUBCLASSING AnyEvent::Handle |
2148 | |
2628 | |
2149 | In many cases, you might want to subclass AnyEvent::Handle. |
2629 | In many cases, you might want to subclass AnyEvent::Handle. |
2150 | |
2630 | |
2151 | To make this easier, a given version of AnyEvent::Handle uses these |
2631 | To make this easier, a given version of AnyEvent::Handle uses these |
… | |
… | |
2167 | |
2647 | |
2168 | =item * all members not documented here and not prefixed with an underscore |
2648 | =item * all members not documented here and not prefixed with an underscore |
2169 | are free to use in subclasses. |
2649 | are free to use in subclasses. |
2170 | |
2650 | |
2171 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2651 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2172 | member variables, but thats just life, at least it is documented. |
2652 | member variables, but that's just life. At least it is documented. |
2173 | |
2653 | |
2174 | =back |
2654 | =back |
2175 | |
2655 | |
2176 | =head1 AUTHOR |
2656 | =head1 AUTHOR |
2177 | |
2657 | |
2178 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2658 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2179 | |
2659 | |
2180 | =cut |
2660 | =cut |
2181 | |
2661 | |
2182 | 1; # End of AnyEvent::Handle |
2662 | 1 |
|
|
2663 | |