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 | |
… | |
… | |
75 | } |
75 | } |
76 | |
76 | |
77 | \&$func |
77 | \&$func |
78 | } |
78 | } |
79 | |
79 | |
|
|
80 | sub MAX_READ_SIZE() { 131072 } |
|
|
81 | |
80 | =head1 METHODS |
82 | =head1 METHODS |
81 | |
83 | |
82 | =over 4 |
84 | =over 4 |
83 | |
85 | |
84 | =item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... |
86 | =item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value... |
85 | |
87 | |
86 | The constructor supports these arguments (all as C<< key => value >> pairs). |
88 | The constructor supports these arguments (all as C<< key => value >> pairs). |
87 | |
89 | |
88 | =over 4 |
90 | =over 4 |
89 | |
91 | |
… | |
… | |
112 | =over 4 |
114 | =over 4 |
113 | |
115 | |
114 | =item on_prepare => $cb->($handle) |
116 | =item on_prepare => $cb->($handle) |
115 | |
117 | |
116 | This (rarely used) callback is called before a new connection is |
118 | This (rarely used) callback is called before a new connection is |
117 | 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 |
118 | prepare the file handle with parameters required for the actual connect |
121 | file handle with parameters required for the actual connect (as opposed to |
119 | (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). |
120 | established). |
|
|
121 | |
123 | |
122 | 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 |
123 | 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 |
124 | timeout is to be used). |
126 | default timeout is to be used). |
125 | |
127 | |
126 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
128 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
127 | |
129 | |
128 | This callback is called when a connection has been successfully established. |
130 | This callback is called when a connection has been successfully established. |
129 | |
131 | |
130 | 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 |
131 | 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. |
132 | |
136 | |
|
|
137 | It is not allowed to use the read or write queues while the handle object |
|
|
138 | is connecting. |
|
|
139 | |
133 | 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 |
134 | C<$retry> will continue with the next connection target (in case of |
141 | continue with the next connection target (in case of multi-homed hosts or |
135 | multi-homed hosts or SRV records there can be multiple connection |
142 | SRV records there can be multiple connection endpoints). The C<$retry> |
136 | endpoints). At the time it is called the read and write queues, eof |
143 | callback can be invoked after the connect callback returns, i.e. one can |
137 | status, tls status and similar properties of the handle will have been |
144 | start a handshake and then decide to retry with the next host if the |
138 | reset. |
145 | handshake fails. |
139 | |
146 | |
140 | In most cases, ignoring the C<$retry> parameter is the way to go. |
147 | In most cases, you should ignore the C<$retry> parameter. |
141 | |
148 | |
142 | =item on_connect_error => $cb->($handle, $message) |
149 | =item on_connect_error => $cb->($handle, $message) |
143 | |
150 | |
144 | This callback is called when the connection could not be |
151 | This callback is called when the connection could not be |
145 | 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 |
… | |
… | |
152 | |
159 | |
153 | =item on_error => $cb->($handle, $fatal, $message) |
160 | =item on_error => $cb->($handle, $fatal, $message) |
154 | |
161 | |
155 | 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 |
156 | 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 |
157 | connect or a read error. |
164 | connect, or a read error. |
158 | |
165 | |
159 | 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 |
160 | 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<< -> |
161 | 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 |
162 | 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 |
163 | 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 |
164 | 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 |
165 | often easiest to not report C<EPIPE> errors in this callback. |
172 | often easiest to not report C<EPIPE> errors in this callback. |
166 | |
173 | |
167 | 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 |
168 | 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. |
169 | recommended to always output the C<$message> argument in human-readable |
|
|
170 | error messages (it's usually the same as C<"$!">). |
|
|
171 | |
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 | |
172 | 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 |
173 | to simply ignore this parameter and instead abondon the handle object |
186 | to simply ignore this parameter and instead abondon the handle object |
174 | 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 |
175 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
188 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
176 | |
189 | |
177 | On callback entrance, the value of C<$!> contains the operating system |
190 | On entry to the callback, the value of C<$!> contains the operating |
178 | 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 |
179 | C<EPROTO>). |
192 | C<EPROTO>). |
180 | |
193 | |
181 | 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 |
182 | 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 |
183 | C<croak>. |
196 | C<croak>. |
184 | |
197 | |
185 | =item on_read => $cb->($handle) |
198 | =item on_read => $cb->($handle) |
186 | |
199 | |
187 | 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 |
… | |
… | |
192 | 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 >> |
193 | 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 |
194 | 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 |
195 | the beginning from it. |
208 | the beginning from it. |
196 | |
209 | |
|
|
210 | You can also call C<< ->push_read (...) >> or any other function that |
|
|
211 | modifies the read queue. Or do both. Or ... |
|
|
212 | |
197 | 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 |
198 | 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 |
199 | 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 |
200 | error will be raised (with C<$!> set to C<EPIPE>). |
216 | error will be raised (with C<$!> set to C<EPIPE>). |
201 | |
217 | |
202 | 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 |
… | |
… | |
220 | 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 |
221 | 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>. |
222 | |
238 | |
223 | =item on_drain => $cb->($handle) |
239 | =item on_drain => $cb->($handle) |
224 | |
240 | |
225 | 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 |
226 | (or when the callback is set and the buffer is empty already). |
242 | empty (and immediately when the handle object is created). |
227 | |
243 | |
228 | 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. |
229 | |
245 | |
230 | 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 |
231 | 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 |
… | |
… | |
243 | 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 |
244 | 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 |
245 | 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> |
246 | error will be raised). |
262 | error will be raised). |
247 | |
263 | |
248 | There are three variants of the timeouts that work fully independent |
264 | There are three variants of the timeouts that work independently of each |
249 | 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: |
250 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
267 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
251 | 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 |
252 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
269 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
253 | |
270 | |
254 | 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 |
255 | 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 |
256 | idle then you should disable the timout temporarily or ignore the timeout |
273 | idle then you should disable the timeout temporarily or ignore the |
257 | 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 |
258 | restart the timeout. |
275 | AnyEvent::Handle will simply restart the timeout. |
259 | |
276 | |
260 | Zero (the default) disables this timeout. |
277 | Zero (the default) disables the corresponding timeout. |
261 | |
278 | |
262 | =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) |
263 | |
284 | |
264 | Called whenever the inactivity timeout passes. If you return from this |
285 | Called whenever the inactivity timeout passes. If you return from this |
265 | 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, |
266 | so this condition is not fatal in any way. |
287 | so this condition is not fatal in any way. |
267 | |
288 | |
… | |
… | |
275 | 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 |
276 | (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 |
277 | 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 |
278 | isn't finished). |
299 | isn't finished). |
279 | |
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 | |
280 | =item autocork => <boolean> |
316 | =item autocork => <boolean> |
281 | |
317 | |
282 | When disabled (the default), then C<push_write> will try to immediately |
318 | When disabled (the default), C<push_write> will try to immediately |
283 | 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 |
284 | 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 |
285 | 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 |
286 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
322 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
287 | C<no_delay>, but this option can save costly syscalls). |
323 | C<no_delay>, but this option can save costly syscalls). |
288 | |
324 | |
289 | 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 |
290 | 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, |
291 | 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 |
292 | the write buffer often is full). It also increases write latency. |
328 | the write buffer often is full). It also increases write latency. |
293 | |
329 | |
294 | =item no_delay => <boolean> |
330 | =item no_delay => <boolean> |
… | |
… | |
298 | the Nagle algorithm, and usually it is beneficial. |
334 | the Nagle algorithm, and usually it is beneficial. |
299 | |
335 | |
300 | 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 |
301 | accomplishd by setting this option to a true value. |
337 | accomplishd by setting this option to a true value. |
302 | |
338 | |
303 | The default is your opertaing system's default behaviour (most likely |
339 | The default is your operating system's default behaviour (most likely |
304 | enabled), this option explicitly enables or disables it, if possible. |
340 | enabled). This option explicitly enables or disables it, if possible. |
305 | |
341 | |
306 | =item keepalive => <boolean> |
342 | =item keepalive => <boolean> |
307 | |
343 | |
308 | Enables (default disable) the SO_KEEPALIVE option on the stream socket: |
344 | Enables (default disable) the SO_KEEPALIVE option on the stream socket: |
309 | normally, TCP connections have no time-out once established, so TCP |
345 | normally, TCP connections have no time-out once established, so TCP |
310 | connections, once established, can stay alive forever even when the other |
346 | connections, once established, can stay alive forever even when the other |
311 | 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 |
312 | TCP connections whent he other side becomes unreachable. While the default |
348 | TCP connections when the other side becomes unreachable. While the default |
313 | 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, |
314 | 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 |
315 | to 15 minutes later. |
351 | to 15 minutes later. |
316 | |
352 | |
317 | 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 |
… | |
… | |
335 | already have occured on BSD systems), but at least it will protect you |
371 | already have occured on BSD systems), but at least it will protect you |
336 | from most attacks. |
372 | from most attacks. |
337 | |
373 | |
338 | =item read_size => <bytes> |
374 | =item read_size => <bytes> |
339 | |
375 | |
340 | 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 |
341 | try to read during each loop iteration, which affects memory |
377 | to read during each loop iteration. Each handle object will consume |
342 | 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. |
343 | |
388 | |
344 | =item low_water_mark => <bytes> |
389 | =item low_water_mark => <bytes> |
345 | |
390 | |
346 | 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 |
347 | 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 |
348 | considered empty. |
393 | considered empty. |
349 | |
394 | |
350 | 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 |
351 | 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 |
352 | 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 |
353 | is good in almost all cases. |
398 | is good in almost all cases. |
354 | |
399 | |
355 | =item linger => <seconds> |
400 | =item linger => <seconds> |
356 | |
401 | |
357 | If non-zero (default: C<3600>), then the destructor of the |
402 | If this is non-zero (default: C<3600>), the destructor of the |
358 | AnyEvent::Handle object will check whether there is still outstanding |
403 | AnyEvent::Handle object will check whether there is still outstanding |
359 | 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 |
360 | 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 |
361 | system treats outstanding data at socket close time). |
406 | system treats outstanding data at socket close time). |
362 | |
407 | |
… | |
… | |
369 | 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 |
370 | (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. |
371 | |
416 | |
372 | 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 |
373 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
418 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
374 | verification will be skipped when C<peername> is not specified or |
419 | verification will be skipped when C<peername> is not specified or is |
375 | C<undef>. |
420 | C<undef>. |
376 | |
421 | |
377 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
422 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
378 | |
423 | |
379 | 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 |
… | |
… | |
384 | appropriate error message. |
429 | appropriate error message. |
385 | |
430 | |
386 | 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 |
387 | 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 |
388 | 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 |
389 | 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. |
390 | |
436 | |
391 | 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 |
392 | 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> |
393 | mode. |
439 | mode. |
394 | |
440 | |
… | |
… | |
405 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
451 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
406 | 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 |
407 | 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 |
408 | segmentation fault. |
454 | segmentation fault. |
409 | |
455 | |
410 | 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. |
411 | |
457 | |
412 | =item tls_ctx => $anyevent_tls |
458 | =item tls_ctx => $anyevent_tls |
413 | |
459 | |
414 | 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 |
415 | (unless a connection object was specified directly). If this parameter is |
461 | (unless a connection object was specified directly). If this |
416 | 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>. |
417 | |
464 | |
418 | 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 |
419 | => 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 |
420 | new TLS context object. |
467 | new TLS context object. |
421 | |
468 | |
… | |
… | |
430 | |
477 | |
431 | 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 |
432 | 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>. |
433 | |
480 | |
434 | Without this callback, handshake failures lead to C<on_error> being |
481 | Without this callback, handshake failures lead to C<on_error> being |
435 | called, as normal. |
482 | called as usual. |
436 | |
483 | |
437 | 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 |
438 | 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 |
439 | then call C<< ->starttls >> again. |
486 | then call C<< ->starttls >> again. |
440 | |
487 | |
441 | =item on_stoptls => $cb->($handle) |
488 | =item on_stoptls => $cb->($handle) |
442 | |
489 | |
… | |
… | |
490 | $self->{connect}[0], |
537 | $self->{connect}[0], |
491 | $self->{connect}[1], |
538 | $self->{connect}[1], |
492 | sub { |
539 | sub { |
493 | my ($fh, $host, $port, $retry) = @_; |
540 | my ($fh, $host, $port, $retry) = @_; |
494 | |
541 | |
|
|
542 | delete $self->{_connect}; # no longer needed |
|
|
543 | |
495 | if ($fh) { |
544 | if ($fh) { |
496 | $self->{fh} = $fh; |
545 | $self->{fh} = $fh; |
497 | |
546 | |
498 | delete $self->{_skip_drain_rbuf}; |
547 | delete $self->{_skip_drain_rbuf}; |
499 | $self->_start; |
548 | $self->_start; |
… | |
… | |
506 | }); |
555 | }); |
507 | |
556 | |
508 | } else { |
557 | } else { |
509 | if ($self->{on_connect_error}) { |
558 | if ($self->{on_connect_error}) { |
510 | $self->{on_connect_error}($self, "$!"); |
559 | $self->{on_connect_error}($self, "$!"); |
511 | $self->destroy; |
560 | $self->destroy if $self; |
512 | } else { |
561 | } else { |
513 | $self->_error ($!, 1); |
562 | $self->_error ($!, 1); |
514 | } |
563 | } |
515 | } |
564 | } |
516 | }, |
565 | }, |
517 | sub { |
566 | sub { |
518 | local $self->{fh} = $_[0]; |
567 | local $self->{fh} = $_[0]; |
519 | |
568 | |
520 | $self->{on_prepare} |
569 | $self->{on_prepare} |
521 | ? $self->{on_prepare}->($self) |
570 | ? $self->{on_prepare}->($self) |
522 | : () |
571 | : () |
523 | } |
572 | } |
524 | ); |
573 | ); |
525 | } |
574 | } |
526 | |
575 | |
… | |
… | |
532 | } |
581 | } |
533 | |
582 | |
534 | sub _start { |
583 | sub _start { |
535 | my ($self) = @_; |
584 | my ($self) = @_; |
536 | |
585 | |
|
|
586 | # too many clueless people try to use udp and similar sockets |
|
|
587 | # with AnyEvent::Handle, do them a favour. |
|
|
588 | my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE (); |
|
|
589 | Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!" |
|
|
590 | if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type; |
|
|
591 | |
537 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
592 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
538 | |
593 | |
539 | $self->{_activity} = |
594 | $self->{_activity} = |
540 | $self->{_ractivity} = |
595 | $self->{_ractivity} = |
541 | $self->{_wactivity} = AE::now; |
596 | $self->{_wactivity} = AE::now; |
542 | |
597 | |
|
|
598 | $self->{read_size} ||= 2048; |
|
|
599 | $self->{max_read_size} = $self->{read_size} |
|
|
600 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
|
|
601 | |
543 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
602 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
544 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
603 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
545 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
604 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
546 | |
605 | |
547 | $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; |
606 | $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; |
… | |
… | |
550 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
609 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
551 | |
610 | |
552 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
611 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
553 | if $self->{tls}; |
612 | if $self->{tls}; |
554 | |
613 | |
555 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
614 | $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain}; |
556 | |
615 | |
557 | $self->start_read |
616 | $self->start_read |
558 | if $self->{on_read} || @{ $self->{_queue} }; |
617 | if $self->{on_read} || @{ $self->{_queue} }; |
559 | |
618 | |
560 | $self->_drain_wbuf; |
619 | $self->_drain_wbuf; |
… | |
… | |
636 | =cut |
695 | =cut |
637 | |
696 | |
638 | sub no_delay { |
697 | sub no_delay { |
639 | $_[0]{no_delay} = $_[1]; |
698 | $_[0]{no_delay} = $_[1]; |
640 | |
699 | |
641 | eval { |
|
|
642 | local $SIG{__DIE__}; |
|
|
643 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
700 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
644 | if $_[0]{fh}; |
701 | if $_[0]{fh}; |
645 | }; |
|
|
646 | } |
702 | } |
647 | |
703 | |
648 | =item $handle->keepalive ($boolean) |
704 | =item $handle->keepalive ($boolean) |
649 | |
705 | |
650 | Enables or disables the C<keepalive> setting (see constructor argument of |
706 | Enables or disables the C<keepalive> setting (see constructor argument of |
… | |
… | |
710 | |
766 | |
711 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
767 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
712 | |
768 | |
713 | =cut |
769 | =cut |
714 | |
770 | |
715 | sub on_starttls { |
771 | sub on_stoptls { |
716 | $_[0]{on_stoptls} = $_[1]; |
772 | $_[0]{on_stoptls} = $_[1]; |
717 | } |
773 | } |
718 | |
774 | |
719 | =item $handle->rbuf_max ($max_octets) |
775 | =item $handle->rbuf_max ($max_octets) |
720 | |
776 | |
721 | Configures the C<rbuf_max> setting (C<undef> disables it). |
777 | Configures the C<rbuf_max> setting (C<undef> disables it). |
|
|
778 | |
|
|
779 | =item $handle->wbuf_max ($max_octets) |
|
|
780 | |
|
|
781 | Configures the C<wbuf_max> setting (C<undef> disables it). |
722 | |
782 | |
723 | =cut |
783 | =cut |
724 | |
784 | |
725 | sub rbuf_max { |
785 | sub rbuf_max { |
726 | $_[0]{rbuf_max} = $_[1]; |
786 | $_[0]{rbuf_max} = $_[1]; |
727 | } |
787 | } |
728 | |
788 | |
|
|
789 | sub wbuf_max { |
|
|
790 | $_[0]{wbuf_max} = $_[1]; |
|
|
791 | } |
|
|
792 | |
729 | ############################################################################# |
793 | ############################################################################# |
730 | |
794 | |
731 | =item $handle->timeout ($seconds) |
795 | =item $handle->timeout ($seconds) |
732 | |
796 | |
733 | =item $handle->rtimeout ($seconds) |
797 | =item $handle->rtimeout ($seconds) |
734 | |
798 | |
735 | =item $handle->wtimeout ($seconds) |
799 | =item $handle->wtimeout ($seconds) |
736 | |
800 | |
737 | Configures (or disables) the inactivity timeout. |
801 | Configures (or disables) the inactivity timeout. |
|
|
802 | |
|
|
803 | The timeout will be checked instantly, so this method might destroy the |
|
|
804 | handle before it returns. |
738 | |
805 | |
739 | =item $handle->timeout_reset |
806 | =item $handle->timeout_reset |
740 | |
807 | |
741 | =item $handle->rtimeout_reset |
808 | =item $handle->rtimeout_reset |
742 | |
809 | |
… | |
… | |
759 | $_[0]{$on_timeout} = $_[1]; |
826 | $_[0]{$on_timeout} = $_[1]; |
760 | }; |
827 | }; |
761 | |
828 | |
762 | *$timeout = sub { |
829 | *$timeout = sub { |
763 | my ($self, $new_value) = @_; |
830 | my ($self, $new_value) = @_; |
|
|
831 | |
|
|
832 | $new_value >= 0 |
|
|
833 | or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught"; |
764 | |
834 | |
765 | $self->{$timeout} = $new_value; |
835 | $self->{$timeout} = $new_value; |
766 | delete $self->{$tw}; &$cb; |
836 | delete $self->{$tw}; &$cb; |
767 | }; |
837 | }; |
768 | |
838 | |
… | |
… | |
823 | |
893 | |
824 | The write queue is very simple: you can add data to its end, and |
894 | The write queue is very simple: you can add data to its end, and |
825 | AnyEvent::Handle will automatically try to get rid of it for you. |
895 | AnyEvent::Handle will automatically try to get rid of it for you. |
826 | |
896 | |
827 | When data could be written and the write buffer is shorter then the low |
897 | When data could be written and the write buffer is shorter then the low |
828 | water mark, the C<on_drain> callback will be invoked. |
898 | water mark, the C<on_drain> callback will be invoked once. |
829 | |
899 | |
830 | =over 4 |
900 | =over 4 |
831 | |
901 | |
832 | =item $handle->on_drain ($cb) |
902 | =item $handle->on_drain ($cb) |
833 | |
903 | |
834 | Sets the C<on_drain> callback or clears it (see the description of |
904 | Sets the C<on_drain> callback or clears it (see the description of |
835 | C<on_drain> in the constructor). |
905 | C<on_drain> in the constructor). |
836 | |
906 | |
|
|
907 | This method may invoke callbacks (and therefore the handle might be |
|
|
908 | destroyed after it returns). |
|
|
909 | |
837 | =cut |
910 | =cut |
838 | |
911 | |
839 | sub on_drain { |
912 | sub on_drain { |
840 | my ($self, $cb) = @_; |
913 | my ($self, $cb) = @_; |
841 | |
914 | |
… | |
… | |
845 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
918 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
846 | } |
919 | } |
847 | |
920 | |
848 | =item $handle->push_write ($data) |
921 | =item $handle->push_write ($data) |
849 | |
922 | |
850 | Queues the given scalar to be written. You can push as much data as you |
923 | Queues the given scalar to be written. You can push as much data as |
851 | want (only limited by the available memory), as C<AnyEvent::Handle> |
924 | you want (only limited by the available memory and C<wbuf_max>), as |
852 | buffers it independently of the kernel. |
925 | C<AnyEvent::Handle> buffers it independently of the kernel. |
|
|
926 | |
|
|
927 | This method may invoke callbacks (and therefore the handle might be |
|
|
928 | destroyed after it returns). |
853 | |
929 | |
854 | =cut |
930 | =cut |
855 | |
931 | |
856 | sub _drain_wbuf { |
932 | sub _drain_wbuf { |
857 | my ($self) = @_; |
933 | my ($self) = @_; |
… | |
… | |
882 | $cb->() unless $self->{autocork}; |
958 | $cb->() unless $self->{autocork}; |
883 | |
959 | |
884 | # if still data left in wbuf, we need to poll |
960 | # if still data left in wbuf, we need to poll |
885 | $self->{_ww} = AE::io $self->{fh}, 1, $cb |
961 | $self->{_ww} = AE::io $self->{fh}, 1, $cb |
886 | if length $self->{wbuf}; |
962 | if length $self->{wbuf}; |
|
|
963 | |
|
|
964 | if ( |
|
|
965 | defined $self->{wbuf_max} |
|
|
966 | && $self->{wbuf_max} < length $self->{wbuf} |
|
|
967 | ) { |
|
|
968 | $self->_error (Errno::ENOSPC, 1), return; |
|
|
969 | } |
887 | }; |
970 | }; |
888 | } |
971 | } |
889 | |
972 | |
890 | our %WH; |
973 | our %WH; |
891 | |
974 | |
… | |
… | |
903 | @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" |
986 | @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" |
904 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") |
987 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") |
905 | ->($self, @_); |
988 | ->($self, @_); |
906 | } |
989 | } |
907 | |
990 | |
|
|
991 | # we downgrade here to avoid hard-to-track-down bugs, |
|
|
992 | # and diagnose the problem earlier and better. |
|
|
993 | |
908 | if ($self->{tls}) { |
994 | if ($self->{tls}) { |
909 | $self->{_tls_wbuf} .= $_[0]; |
995 | utf8::downgrade $self->{_tls_wbuf} .= $_[0]; |
910 | &_dotls ($self) if $self->{fh}; |
996 | &_dotls ($self) if $self->{fh}; |
911 | } else { |
997 | } else { |
912 | $self->{wbuf} .= $_[0]; |
998 | utf8::downgrade $self->{wbuf} .= $_[0]; |
913 | $self->_drain_wbuf if $self->{fh}; |
999 | $self->_drain_wbuf if $self->{fh}; |
914 | } |
1000 | } |
915 | } |
1001 | } |
916 | |
1002 | |
917 | =item $handle->push_write (type => @args) |
1003 | =item $handle->push_write (type => @args) |
918 | |
1004 | |
919 | Instead of formatting your data yourself, you can also let this module |
1005 | Instead of formatting your data yourself, you can also let this module |
920 | do the job by specifying a type and type-specific arguments. You |
1006 | do the job by specifying a type and type-specific arguments. You |
921 | can also specify the (fully qualified) name of a package, in which |
1007 | can also specify the (fully qualified) name of a package, in which |
922 | case AnyEvent tries to load the package and then expects to find the |
1008 | case AnyEvent tries to load the package and then expects to find the |
923 | C<anyevent_read_type> function inside (see "custom write types", below). |
1009 | C<anyevent_write_type> function inside (see "custom write types", below). |
924 | |
1010 | |
925 | Predefined types are (if you have ideas for additional types, feel free to |
1011 | Predefined types are (if you have ideas for additional types, feel free to |
926 | drop by and tell us): |
1012 | drop by and tell us): |
927 | |
1013 | |
928 | =over 4 |
1014 | =over 4 |
… | |
… | |
1008 | =cut |
1094 | =cut |
1009 | |
1095 | |
1010 | register_write_type storable => sub { |
1096 | register_write_type storable => sub { |
1011 | my ($self, $ref) = @_; |
1097 | my ($self, $ref) = @_; |
1012 | |
1098 | |
1013 | require Storable; |
1099 | require Storable unless $Storable::VERSION; |
1014 | |
1100 | |
1015 | pack "w/a*", Storable::nfreeze ($ref) |
1101 | pack "w/a*", Storable::nfreeze ($ref) |
1016 | }; |
1102 | }; |
1017 | |
1103 | |
1018 | =back |
1104 | =back |
… | |
… | |
1023 | before it was actually written. One way to do that is to replace your |
1109 | before it was actually written. One way to do that is to replace your |
1024 | C<on_drain> handler by a callback that shuts down the socket (and set |
1110 | C<on_drain> handler by a callback that shuts down the socket (and set |
1025 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
1111 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
1026 | replaces the C<on_drain> callback with: |
1112 | replaces the C<on_drain> callback with: |
1027 | |
1113 | |
1028 | sub { shutdown $_[0]{fh}, 1 } # for push_shutdown |
1114 | sub { shutdown $_[0]{fh}, 1 } |
1029 | |
1115 | |
1030 | This simply shuts down the write side and signals an EOF condition to the |
1116 | This simply shuts down the write side and signals an EOF condition to the |
1031 | the peer. |
1117 | the peer. |
1032 | |
1118 | |
1033 | You can rely on the normal read queue and C<on_eof> handling |
1119 | You can rely on the normal read queue and C<on_eof> handling |
1034 | afterwards. This is the cleanest way to close a connection. |
1120 | afterwards. This is the cleanest way to close a connection. |
|
|
1121 | |
|
|
1122 | This method may invoke callbacks (and therefore the handle might be |
|
|
1123 | destroyed after it returns). |
1035 | |
1124 | |
1036 | =cut |
1125 | =cut |
1037 | |
1126 | |
1038 | sub push_shutdown { |
1127 | sub push_shutdown { |
1039 | my ($self) = @_; |
1128 | my ($self) = @_; |
… | |
… | |
1052 | |
1141 | |
1053 | Whenever the given C<type> is used, C<push_write> will the function with |
1142 | Whenever the given C<type> is used, C<push_write> will the function with |
1054 | the handle object and the remaining arguments. |
1143 | the handle object and the remaining arguments. |
1055 | |
1144 | |
1056 | The function is supposed to return a single octet string that will be |
1145 | The function is supposed to return a single octet string that will be |
1057 | appended to the write buffer, so you cna mentally treat this function as a |
1146 | appended to the write buffer, so you can mentally treat this function as a |
1058 | "arguments to on-the-wire-format" converter. |
1147 | "arguments to on-the-wire-format" converter. |
1059 | |
1148 | |
1060 | Example: implement a custom write type C<join> that joins the remaining |
1149 | Example: implement a custom write type C<join> that joins the remaining |
1061 | arguments using the first one. |
1150 | arguments using the first one. |
1062 | |
1151 | |
… | |
… | |
1089 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1178 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1090 | a queue. |
1179 | a queue. |
1091 | |
1180 | |
1092 | In the simple case, you just install an C<on_read> callback and whenever |
1181 | In the simple case, you just install an C<on_read> callback and whenever |
1093 | new data arrives, it will be called. You can then remove some data (if |
1182 | new data arrives, it will be called. You can then remove some data (if |
1094 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
1183 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can |
1095 | leave the data there if you want to accumulate more (e.g. when only a |
1184 | leave the data there if you want to accumulate more (e.g. when only a |
1096 | partial message has been received so far). |
1185 | partial message has been received so far), or change the read queue with |
|
|
1186 | e.g. C<push_read>. |
1097 | |
1187 | |
1098 | In the more complex case, you want to queue multiple callbacks. In this |
1188 | In the more complex case, you want to queue multiple callbacks. In this |
1099 | case, AnyEvent::Handle will call the first queued callback each time new |
1189 | case, AnyEvent::Handle will call the first queued callback each time new |
1100 | data arrives (also the first time it is queued) and removes it when it has |
1190 | data arrives (also the first time it is queued) and remove it when it has |
1101 | done its job (see C<push_read>, below). |
1191 | done its job (see C<push_read>, below). |
1102 | |
1192 | |
1103 | This way you can, for example, push three line-reads, followed by reading |
1193 | This way you can, for example, push three line-reads, followed by reading |
1104 | a chunk of data, and AnyEvent::Handle will execute them in order. |
1194 | a chunk of data, and AnyEvent::Handle will execute them in order. |
1105 | |
1195 | |
… | |
… | |
1236 | |
1326 | |
1237 | This replaces the currently set C<on_read> callback, or clears it (when |
1327 | This replaces the currently set C<on_read> callback, or clears it (when |
1238 | the new callback is C<undef>). See the description of C<on_read> in the |
1328 | the new callback is C<undef>). See the description of C<on_read> in the |
1239 | constructor. |
1329 | constructor. |
1240 | |
1330 | |
|
|
1331 | This method may invoke callbacks (and therefore the handle might be |
|
|
1332 | destroyed after it returns). |
|
|
1333 | |
1241 | =cut |
1334 | =cut |
1242 | |
1335 | |
1243 | sub on_read { |
1336 | sub on_read { |
1244 | my ($self, $cb) = @_; |
1337 | my ($self, $cb) = @_; |
1245 | |
1338 | |
… | |
… | |
1247 | $self->_drain_rbuf if $cb; |
1340 | $self->_drain_rbuf if $cb; |
1248 | } |
1341 | } |
1249 | |
1342 | |
1250 | =item $handle->rbuf |
1343 | =item $handle->rbuf |
1251 | |
1344 | |
1252 | Returns the read buffer (as a modifiable lvalue). |
1345 | Returns the read buffer (as a modifiable lvalue). You can also access the |
|
|
1346 | read buffer directly as the C<< ->{rbuf} >> member, if you want (this is |
|
|
1347 | much faster, and no less clean). |
1253 | |
1348 | |
1254 | You can access the read buffer directly as the C<< ->{rbuf} >> |
1349 | The only operation allowed on the read buffer (apart from looking at it) |
1255 | member, if you want. However, the only operation allowed on the |
1350 | is removing data from its beginning. Otherwise modifying or appending to |
1256 | read buffer (apart from looking at it) is removing data from its |
1351 | it is not allowed and will lead to hard-to-track-down bugs. |
1257 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
1258 | lead to hard-to-track-down bugs. |
|
|
1259 | |
1352 | |
1260 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
1353 | NOTE: The read buffer should only be used or modified in the C<on_read> |
1261 | C<push_read> or C<unshift_read> methods are used. The other read methods |
1354 | callback or when C<push_read> or C<unshift_read> are used with a single |
1262 | automatically manage the read buffer. |
1355 | callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods |
|
|
1356 | will manage the read buffer on their own. |
1263 | |
1357 | |
1264 | =cut |
1358 | =cut |
1265 | |
1359 | |
1266 | sub rbuf : lvalue { |
1360 | sub rbuf : lvalue { |
1267 | $_[0]{rbuf} |
1361 | $_[0]{rbuf} |
… | |
… | |
1284 | |
1378 | |
1285 | If enough data was available, then the callback must remove all data it is |
1379 | If enough data was available, then the callback must remove all data it is |
1286 | interested in (which can be none at all) and return a true value. After returning |
1380 | interested in (which can be none at all) and return a true value. After returning |
1287 | true, it will be removed from the queue. |
1381 | true, it will be removed from the queue. |
1288 | |
1382 | |
|
|
1383 | These methods may invoke callbacks (and therefore the handle might be |
|
|
1384 | destroyed after it returns). |
|
|
1385 | |
1289 | =cut |
1386 | =cut |
1290 | |
1387 | |
1291 | our %RH; |
1388 | our %RH; |
1292 | |
1389 | |
1293 | sub register_read_type($$) { |
1390 | sub register_read_type($$) { |
… | |
… | |
1315 | my $cb = pop; |
1412 | my $cb = pop; |
1316 | |
1413 | |
1317 | if (@_) { |
1414 | if (@_) { |
1318 | my $type = shift; |
1415 | my $type = shift; |
1319 | |
1416 | |
|
|
1417 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1320 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
1418 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read") |
1321 | ->($self, $cb, @_); |
1419 | ->($self, $cb, @_); |
1322 | } |
1420 | } |
1323 | |
1421 | |
1324 | unshift @{ $self->{_queue} }, $cb; |
1422 | unshift @{ $self->{_queue} }, $cb; |
1325 | $self->_drain_rbuf; |
1423 | $self->_drain_rbuf; |
… | |
… | |
1347 | data. |
1445 | data. |
1348 | |
1446 | |
1349 | Example: read 2 bytes. |
1447 | Example: read 2 bytes. |
1350 | |
1448 | |
1351 | $handle->push_read (chunk => 2, sub { |
1449 | $handle->push_read (chunk => 2, sub { |
1352 | warn "yay ", unpack "H*", $_[1]; |
1450 | say "yay " . unpack "H*", $_[1]; |
1353 | }); |
1451 | }); |
1354 | |
1452 | |
1355 | =cut |
1453 | =cut |
1356 | |
1454 | |
1357 | register_read_type chunk => sub { |
1455 | register_read_type chunk => sub { |
… | |
… | |
1391 | if (@_ < 3) { |
1489 | if (@_ < 3) { |
1392 | # this is more than twice as fast as the generic code below |
1490 | # this is more than twice as fast as the generic code below |
1393 | sub { |
1491 | sub { |
1394 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1492 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1395 | |
1493 | |
1396 | $cb->($_[0], $1, $2); |
1494 | $cb->($_[0], "$1", "$2"); |
1397 | 1 |
1495 | 1 |
1398 | } |
1496 | } |
1399 | } else { |
1497 | } else { |
1400 | $eol = quotemeta $eol unless ref $eol; |
1498 | $eol = quotemeta $eol unless ref $eol; |
1401 | $eol = qr|^(.*?)($eol)|s; |
1499 | $eol = qr|^(.*?)($eol)|s; |
1402 | |
1500 | |
1403 | sub { |
1501 | sub { |
1404 | $_[0]{rbuf} =~ s/$eol// or return; |
1502 | $_[0]{rbuf} =~ s/$eol// or return; |
1405 | |
1503 | |
1406 | $cb->($_[0], $1, $2); |
1504 | $cb->($_[0], "$1", "$2"); |
1407 | 1 |
1505 | 1 |
1408 | } |
1506 | } |
1409 | } |
1507 | } |
1410 | }; |
1508 | }; |
1411 | |
1509 | |
… | |
… | |
1433 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1531 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1434 | and everything preceding and including the match will be accepted |
1532 | and everything preceding and including the match will be accepted |
1435 | unconditionally. This is useful to skip large amounts of data that you |
1533 | unconditionally. This is useful to skip large amounts of data that you |
1436 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1534 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1437 | have to start matching from the beginning. This is purely an optimisation |
1535 | have to start matching from the beginning. This is purely an optimisation |
1438 | and is usually worth only when you expect more than a few kilobytes. |
1536 | and is usually worth it only when you expect more than a few kilobytes. |
1439 | |
1537 | |
1440 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1538 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1441 | expect the header to be very large (it isn't in practise, but...), we use |
1539 | expect the header to be very large (it isn't in practice, but...), we use |
1442 | a skip regex to skip initial portions. The skip regex is tricky in that |
1540 | a skip regex to skip initial portions. The skip regex is tricky in that |
1443 | it only accepts something not ending in either \015 or \012, as these are |
1541 | it only accepts something not ending in either \015 or \012, as these are |
1444 | required for the accept regex. |
1542 | required for the accept regex. |
1445 | |
1543 | |
1446 | $handle->push_read (regex => |
1544 | $handle->push_read (regex => |
… | |
… | |
1459 | |
1557 | |
1460 | sub { |
1558 | sub { |
1461 | # accept |
1559 | # accept |
1462 | if ($$rbuf =~ $accept) { |
1560 | if ($$rbuf =~ $accept) { |
1463 | $data .= substr $$rbuf, 0, $+[0], ""; |
1561 | $data .= substr $$rbuf, 0, $+[0], ""; |
1464 | $cb->($self, $data); |
1562 | $cb->($_[0], $data); |
1465 | return 1; |
1563 | return 1; |
1466 | } |
1564 | } |
1467 | |
1565 | |
1468 | # reject |
1566 | # reject |
1469 | if ($reject && $$rbuf =~ $reject) { |
1567 | if ($reject && $$rbuf =~ $reject) { |
1470 | $self->_error (Errno::EBADMSG); |
1568 | $_[0]->_error (Errno::EBADMSG); |
1471 | } |
1569 | } |
1472 | |
1570 | |
1473 | # skip |
1571 | # skip |
1474 | if ($skip && $$rbuf =~ $skip) { |
1572 | if ($skip && $$rbuf =~ $skip) { |
1475 | $data .= substr $$rbuf, 0, $+[0], ""; |
1573 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
1491 | my ($self, $cb) = @_; |
1589 | my ($self, $cb) = @_; |
1492 | |
1590 | |
1493 | sub { |
1591 | sub { |
1494 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1592 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1495 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1593 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1496 | $self->_error (Errno::EBADMSG); |
1594 | $_[0]->_error (Errno::EBADMSG); |
1497 | } |
1595 | } |
1498 | return; |
1596 | return; |
1499 | } |
1597 | } |
1500 | |
1598 | |
1501 | my $len = $1; |
1599 | my $len = $1; |
1502 | |
1600 | |
1503 | $self->unshift_read (chunk => $len, sub { |
1601 | $_[0]->unshift_read (chunk => $len, sub { |
1504 | my $string = $_[1]; |
1602 | my $string = $_[1]; |
1505 | $_[0]->unshift_read (chunk => 1, sub { |
1603 | $_[0]->unshift_read (chunk => 1, sub { |
1506 | if ($_[1] eq ",") { |
1604 | if ($_[1] eq ",") { |
1507 | $cb->($_[0], $string); |
1605 | $cb->($_[0], $string); |
1508 | } else { |
1606 | } else { |
1509 | $self->_error (Errno::EBADMSG); |
1607 | $_[0]->_error (Errno::EBADMSG); |
1510 | } |
1608 | } |
1511 | }); |
1609 | }); |
1512 | }); |
1610 | }); |
1513 | |
1611 | |
1514 | 1 |
1612 | 1 |
… | |
… | |
1587 | |
1685 | |
1588 | my $data; |
1686 | my $data; |
1589 | my $rbuf = \$self->{rbuf}; |
1687 | my $rbuf = \$self->{rbuf}; |
1590 | |
1688 | |
1591 | sub { |
1689 | sub { |
1592 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1690 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1593 | |
1691 | |
1594 | if ($ref) { |
1692 | if ($ref) { |
1595 | $self->{rbuf} = $json->incr_text; |
1693 | $_[0]{rbuf} = $json->incr_text; |
1596 | $json->incr_text = ""; |
1694 | $json->incr_text = ""; |
1597 | $cb->($self, $ref); |
1695 | $cb->($_[0], $ref); |
1598 | |
1696 | |
1599 | 1 |
1697 | 1 |
1600 | } elsif ($@) { |
1698 | } elsif ($@) { |
1601 | # error case |
1699 | # error case |
1602 | $json->incr_skip; |
1700 | $json->incr_skip; |
1603 | |
1701 | |
1604 | $self->{rbuf} = $json->incr_text; |
1702 | $_[0]{rbuf} = $json->incr_text; |
1605 | $json->incr_text = ""; |
1703 | $json->incr_text = ""; |
1606 | |
1704 | |
1607 | $self->_error (Errno::EBADMSG); |
1705 | $_[0]->_error (Errno::EBADMSG); |
1608 | |
1706 | |
1609 | () |
1707 | () |
1610 | } else { |
1708 | } else { |
1611 | $self->{rbuf} = ""; |
1709 | $_[0]{rbuf} = ""; |
1612 | |
1710 | |
1613 | () |
1711 | () |
1614 | } |
1712 | } |
1615 | } |
1713 | } |
1616 | }; |
1714 | }; |
… | |
… | |
1626 | =cut |
1724 | =cut |
1627 | |
1725 | |
1628 | register_read_type storable => sub { |
1726 | register_read_type storable => sub { |
1629 | my ($self, $cb) = @_; |
1727 | my ($self, $cb) = @_; |
1630 | |
1728 | |
1631 | require Storable; |
1729 | require Storable unless $Storable::VERSION; |
1632 | |
1730 | |
1633 | sub { |
1731 | sub { |
1634 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1732 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1635 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1733 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1636 | or return; |
1734 | or return; |
… | |
… | |
1639 | |
1737 | |
1640 | # bypass unshift if we already have the remaining chunk |
1738 | # bypass unshift if we already have the remaining chunk |
1641 | if ($format + $len <= length $_[0]{rbuf}) { |
1739 | if ($format + $len <= length $_[0]{rbuf}) { |
1642 | my $data = substr $_[0]{rbuf}, $format, $len; |
1740 | my $data = substr $_[0]{rbuf}, $format, $len; |
1643 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
1741 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1742 | |
1644 | $cb->($_[0], Storable::thaw ($data)); |
1743 | eval { $cb->($_[0], Storable::thaw ($data)); 1 } |
|
|
1744 | or return $_[0]->_error (Errno::EBADMSG); |
1645 | } else { |
1745 | } else { |
1646 | # remove prefix |
1746 | # remove prefix |
1647 | substr $_[0]{rbuf}, 0, $format, ""; |
1747 | substr $_[0]{rbuf}, 0, $format, ""; |
1648 | |
1748 | |
1649 | # read remaining chunk |
1749 | # read remaining chunk |
1650 | $_[0]->unshift_read (chunk => $len, sub { |
1750 | $_[0]->unshift_read (chunk => $len, sub { |
1651 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1751 | eval { $cb->($_[0], Storable::thaw ($_[1])); 1 } |
1652 | $cb->($_[0], $ref); |
|
|
1653 | } else { |
|
|
1654 | $self->_error (Errno::EBADMSG); |
1752 | or $_[0]->_error (Errno::EBADMSG); |
1655 | } |
|
|
1656 | }); |
1753 | }); |
1657 | } |
1754 | } |
1658 | |
1755 | |
1659 | 1 |
1756 | 1 |
1660 | } |
1757 | } |
… | |
… | |
1697 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1794 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1698 | you change the C<on_read> callback or push/unshift a read callback, and it |
1795 | you change the C<on_read> callback or push/unshift a read callback, and it |
1699 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1796 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1700 | there are any read requests in the queue. |
1797 | there are any read requests in the queue. |
1701 | |
1798 | |
1702 | These methods will have no effect when in TLS mode (as TLS doesn't support |
1799 | In older versions of this module (<= 5.3), these methods had no effect, |
1703 | half-duplex connections). |
1800 | as TLS does not support half-duplex connections. In current versions they |
|
|
1801 | work as expected, as this behaviour is required to avoid certain resource |
|
|
1802 | attacks, where the program would be forced to read (and buffer) arbitrary |
|
|
1803 | amounts of data before being able to send some data. The drawback is that |
|
|
1804 | some readings of the the SSL/TLS specifications basically require this |
|
|
1805 | attack to be working, as SSL/TLS implementations might stall sending data |
|
|
1806 | during a rehandshake. |
|
|
1807 | |
|
|
1808 | As a guideline, during the initial handshake, you should not stop reading, |
|
|
1809 | and as a client, it might cause problems, depending on your application. |
1704 | |
1810 | |
1705 | =cut |
1811 | =cut |
1706 | |
1812 | |
1707 | sub stop_read { |
1813 | sub stop_read { |
1708 | my ($self) = @_; |
1814 | my ($self) = @_; |
1709 | |
1815 | |
1710 | delete $self->{_rw} unless $self->{tls}; |
1816 | delete $self->{_rw}; |
1711 | } |
1817 | } |
1712 | |
1818 | |
1713 | sub start_read { |
1819 | sub start_read { |
1714 | my ($self) = @_; |
1820 | my ($self) = @_; |
1715 | |
1821 | |
1716 | unless ($self->{_rw} || $self->{_eof}) { |
1822 | unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) { |
1717 | Scalar::Util::weaken $self; |
1823 | Scalar::Util::weaken $self; |
1718 | |
1824 | |
1719 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1825 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1720 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1826 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1721 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1827 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf; |
1722 | |
1828 | |
1723 | if ($len > 0) { |
1829 | if ($len > 0) { |
1724 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1830 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1725 | |
1831 | |
1726 | if ($self->{tls}) { |
1832 | if ($self->{tls}) { |
… | |
… | |
1729 | &_dotls ($self); |
1835 | &_dotls ($self); |
1730 | } else { |
1836 | } else { |
1731 | $self->_drain_rbuf; |
1837 | $self->_drain_rbuf; |
1732 | } |
1838 | } |
1733 | |
1839 | |
|
|
1840 | if ($len == $self->{read_size}) { |
|
|
1841 | $self->{read_size} *= 2; |
|
|
1842 | $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE |
|
|
1843 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
|
|
1844 | } |
|
|
1845 | |
1734 | } elsif (defined $len) { |
1846 | } elsif (defined $len) { |
1735 | delete $self->{_rw}; |
1847 | delete $self->{_rw}; |
1736 | $self->{_eof} = 1; |
1848 | $self->{_eof} = 1; |
1737 | $self->_drain_rbuf; |
1849 | $self->_drain_rbuf; |
1738 | |
1850 | |
… | |
… | |
1750 | my ($self, $err) = @_; |
1862 | my ($self, $err) = @_; |
1751 | |
1863 | |
1752 | return $self->_error ($!, 1) |
1864 | return $self->_error ($!, 1) |
1753 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
1865 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
1754 | |
1866 | |
1755 | my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
1867 | my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
1756 | |
1868 | |
1757 | # reduce error string to look less scary |
1869 | # reduce error string to look less scary |
1758 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
1870 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
1759 | |
1871 | |
1760 | if ($self->{_on_starttls}) { |
1872 | if ($self->{_on_starttls}) { |
… | |
… | |
1814 | && ($tmp != $ERROR_SYSCALL || $!); |
1926 | && ($tmp != $ERROR_SYSCALL || $!); |
1815 | |
1927 | |
1816 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1928 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1817 | $self->{wbuf} .= $tmp; |
1929 | $self->{wbuf} .= $tmp; |
1818 | $self->_drain_wbuf; |
1930 | $self->_drain_wbuf; |
|
|
1931 | $self->{tls} or return; # tls session might have gone away in callback |
1819 | } |
1932 | } |
1820 | |
1933 | |
1821 | $self->{_on_starttls} |
1934 | $self->{_on_starttls} |
1822 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1935 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1823 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
1936 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
… | |
… | |
1825 | |
1938 | |
1826 | =item $handle->starttls ($tls[, $tls_ctx]) |
1939 | =item $handle->starttls ($tls[, $tls_ctx]) |
1827 | |
1940 | |
1828 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1941 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1829 | object is created, you can also do that at a later time by calling |
1942 | object is created, you can also do that at a later time by calling |
1830 | C<starttls>. |
1943 | C<starttls>. See the C<tls> constructor argument for general info. |
1831 | |
1944 | |
1832 | Starting TLS is currently an asynchronous operation - when you push some |
1945 | Starting TLS is currently an asynchronous operation - when you push some |
1833 | write data and then call C<< ->starttls >> then TLS negotiation will start |
1946 | write data and then call C<< ->starttls >> then TLS negotiation will start |
1834 | immediately, after which the queued write data is then sent. |
1947 | immediately, after which the queued write data is then sent. This might |
|
|
1948 | change in future versions, so best make sure you have no outstanding write |
|
|
1949 | data when calling this method. |
1835 | |
1950 | |
1836 | The first argument is the same as the C<tls> constructor argument (either |
1951 | The first argument is the same as the C<tls> constructor argument (either |
1837 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1952 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1838 | |
1953 | |
1839 | The second argument is the optional C<AnyEvent::TLS> object that is used |
1954 | The second argument is the optional C<AnyEvent::TLS> object that is used |
… | |
… | |
1845 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1960 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1846 | changed to your liking. Note that the handshake might have already started |
1961 | changed to your liking. Note that the handshake might have already started |
1847 | when this function returns. |
1962 | when this function returns. |
1848 | |
1963 | |
1849 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1964 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1850 | handshakes on the same stream. Best do not attempt to use the stream after |
1965 | handshakes on the same stream. It is best to not attempt to use the |
1851 | stopping TLS. |
1966 | stream after stopping TLS. |
|
|
1967 | |
|
|
1968 | This method may invoke callbacks (and therefore the handle might be |
|
|
1969 | destroyed after it returns). |
1852 | |
1970 | |
1853 | =cut |
1971 | =cut |
1854 | |
1972 | |
1855 | our %TLS_CACHE; #TODO not yet documented, should we? |
1973 | our %TLS_CACHE; #TODO not yet documented, should we? |
1856 | |
1974 | |
… | |
… | |
1858 | my ($self, $tls, $ctx) = @_; |
1976 | my ($self, $tls, $ctx) = @_; |
1859 | |
1977 | |
1860 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
1978 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
1861 | if $self->{tls}; |
1979 | if $self->{tls}; |
1862 | |
1980 | |
|
|
1981 | unless (defined $AnyEvent::TLS::VERSION) { |
|
|
1982 | eval { |
|
|
1983 | require Net::SSLeay; |
|
|
1984 | require AnyEvent::TLS; |
|
|
1985 | 1 |
|
|
1986 | } or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system"); |
|
|
1987 | } |
|
|
1988 | |
1863 | $self->{tls} = $tls; |
1989 | $self->{tls} = $tls; |
1864 | $self->{tls_ctx} = $ctx if @_ > 2; |
1990 | $self->{tls_ctx} = $ctx if @_ > 2; |
1865 | |
1991 | |
1866 | return unless $self->{fh}; |
1992 | return unless $self->{fh}; |
1867 | |
1993 | |
1868 | require Net::SSLeay; |
|
|
1869 | |
|
|
1870 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1994 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1871 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1995 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1872 | |
1996 | |
1873 | $tls = delete $self->{tls}; |
1997 | $tls = delete $self->{tls}; |
1874 | $ctx = $self->{tls_ctx}; |
1998 | $ctx = $self->{tls_ctx}; |
1875 | |
1999 | |
1876 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
2000 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1877 | |
2001 | |
1878 | if ("HASH" eq ref $ctx) { |
2002 | if ("HASH" eq ref $ctx) { |
1879 | require AnyEvent::TLS; |
|
|
1880 | |
|
|
1881 | if ($ctx->{cache}) { |
2003 | if ($ctx->{cache}) { |
1882 | my $key = $ctx+0; |
2004 | my $key = $ctx+0; |
1883 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
2005 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
1884 | } else { |
2006 | } else { |
1885 | $ctx = new AnyEvent::TLS %$ctx; |
2007 | $ctx = new AnyEvent::TLS %$ctx; |
… | |
… | |
1907 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
2029 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
1908 | |
2030 | |
1909 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2031 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1910 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2032 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1911 | |
2033 | |
1912 | Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); |
2034 | Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf}); |
|
|
2035 | $self->{rbuf} = ""; |
1913 | |
2036 | |
1914 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
2037 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
1915 | |
2038 | |
1916 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
2039 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
1917 | if $self->{on_starttls}; |
2040 | if $self->{on_starttls}; |
… | |
… | |
1922 | |
2045 | |
1923 | =item $handle->stoptls |
2046 | =item $handle->stoptls |
1924 | |
2047 | |
1925 | Shuts down the SSL connection - this makes a proper EOF handshake by |
2048 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1926 | sending a close notify to the other side, but since OpenSSL doesn't |
2049 | sending a close notify to the other side, but since OpenSSL doesn't |
1927 | support non-blocking shut downs, it is not guarenteed that you can re-use |
2050 | support non-blocking shut downs, it is not guaranteed that you can re-use |
1928 | the stream afterwards. |
2051 | the stream afterwards. |
|
|
2052 | |
|
|
2053 | This method may invoke callbacks (and therefore the handle might be |
|
|
2054 | destroyed after it returns). |
1929 | |
2055 | |
1930 | =cut |
2056 | =cut |
1931 | |
2057 | |
1932 | sub stoptls { |
2058 | sub stoptls { |
1933 | my ($self) = @_; |
2059 | my ($self) = @_; |
1934 | |
2060 | |
1935 | if ($self->{tls}) { |
2061 | if ($self->{tls} && $self->{fh}) { |
1936 | Net::SSLeay::shutdown ($self->{tls}); |
2062 | Net::SSLeay::shutdown ($self->{tls}); |
1937 | |
2063 | |
1938 | &_dotls; |
2064 | &_dotls; |
1939 | |
2065 | |
1940 | # # we don't give a shit. no, we do, but we can't. no...#d# |
2066 | # # we don't give a shit. no, we do, but we can't. no...#d# |
… | |
… | |
1952 | if $self->{tls} > 0; |
2078 | if $self->{tls} > 0; |
1953 | |
2079 | |
1954 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
2080 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
1955 | } |
2081 | } |
1956 | |
2082 | |
|
|
2083 | =item $handle->resettls |
|
|
2084 | |
|
|
2085 | This rarely-used method simply resets and TLS state on the handle, usually |
|
|
2086 | causing data loss. |
|
|
2087 | |
|
|
2088 | One case where it may be useful is when you want to skip over the data in |
|
|
2089 | the stream but you are not interested in interpreting it, so data loss is |
|
|
2090 | no concern. |
|
|
2091 | |
|
|
2092 | =cut |
|
|
2093 | |
|
|
2094 | *resettls = \&_freetls; |
|
|
2095 | |
1957 | sub DESTROY { |
2096 | sub DESTROY { |
1958 | my ($self) = @_; |
2097 | my ($self) = @_; |
1959 | |
2098 | |
1960 | &_freetls; |
2099 | &_freetls; |
1961 | |
2100 | |
… | |
… | |
1970 | push @linger, AE::io $fh, 1, sub { |
2109 | push @linger, AE::io $fh, 1, sub { |
1971 | my $len = syswrite $fh, $wbuf, length $wbuf; |
2110 | my $len = syswrite $fh, $wbuf, length $wbuf; |
1972 | |
2111 | |
1973 | if ($len > 0) { |
2112 | if ($len > 0) { |
1974 | substr $wbuf, 0, $len, ""; |
2113 | substr $wbuf, 0, $len, ""; |
1975 | } else { |
2114 | } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) { |
1976 | @linger = (); # end |
2115 | @linger = (); # end |
1977 | } |
2116 | } |
1978 | }; |
2117 | }; |
1979 | push @linger, AE::timer $linger, 0, sub { |
2118 | push @linger, AE::timer $linger, 0, sub { |
1980 | @linger = (); |
2119 | @linger = (); |
… | |
… | |
2017 | |
2156 | |
2018 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
2157 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
2019 | #nop |
2158 | #nop |
2020 | } |
2159 | } |
2021 | |
2160 | |
|
|
2161 | =item $handle->destroyed |
|
|
2162 | |
|
|
2163 | Returns false as long as the handle hasn't been destroyed by a call to C<< |
|
|
2164 | ->destroy >>, true otherwise. |
|
|
2165 | |
|
|
2166 | Can be useful to decide whether the handle is still valid after some |
|
|
2167 | callback possibly destroyed the handle. For example, C<< ->push_write >>, |
|
|
2168 | C<< ->starttls >> and other methods can call user callbacks, which in turn |
|
|
2169 | can destroy the handle, so work can be avoided by checking sometimes: |
|
|
2170 | |
|
|
2171 | $hdl->starttls ("accept"); |
|
|
2172 | return if $hdl->destroyed; |
|
|
2173 | $hdl->push_write (... |
|
|
2174 | |
|
|
2175 | Note that the call to C<push_write> will silently be ignored if the handle |
|
|
2176 | has been destroyed, so often you can just ignore the possibility of the |
|
|
2177 | handle being destroyed. |
|
|
2178 | |
|
|
2179 | =cut |
|
|
2180 | |
|
|
2181 | sub destroyed { 0 } |
|
|
2182 | sub AnyEvent::Handle::destroyed::destroyed { 1 } |
|
|
2183 | |
2022 | =item AnyEvent::Handle::TLS_CTX |
2184 | =item AnyEvent::Handle::TLS_CTX |
2023 | |
2185 | |
2024 | This function creates and returns the AnyEvent::TLS object used by default |
2186 | This function creates and returns the AnyEvent::TLS object used by default |
2025 | for TLS mode. |
2187 | for TLS mode. |
2026 | |
2188 | |
… | |
… | |
2053 | |
2215 | |
2054 | It is only safe to "forget" the reference inside EOF or error callbacks, |
2216 | It is only safe to "forget" the reference inside EOF or error callbacks, |
2055 | from within all other callbacks, you need to explicitly call the C<< |
2217 | from within all other callbacks, you need to explicitly call the C<< |
2056 | ->destroy >> method. |
2218 | ->destroy >> method. |
2057 | |
2219 | |
|
|
2220 | =item Why is my C<on_eof> callback never called? |
|
|
2221 | |
|
|
2222 | Probably because your C<on_error> callback is being called instead: When |
|
|
2223 | you have outstanding requests in your read queue, then an EOF is |
|
|
2224 | considered an error as you clearly expected some data. |
|
|
2225 | |
|
|
2226 | To avoid this, make sure you have an empty read queue whenever your handle |
|
|
2227 | is supposed to be "idle" (i.e. connection closes are O.K.). You can set |
|
|
2228 | an C<on_read> handler that simply pushes the first read requests in the |
|
|
2229 | queue. |
|
|
2230 | |
|
|
2231 | See also the next question, which explains this in a bit more detail. |
|
|
2232 | |
|
|
2233 | =item How can I serve requests in a loop? |
|
|
2234 | |
|
|
2235 | Most protocols consist of some setup phase (authentication for example) |
|
|
2236 | followed by a request handling phase, where the server waits for requests |
|
|
2237 | and handles them, in a loop. |
|
|
2238 | |
|
|
2239 | There are two important variants: The first (traditional, better) variant |
|
|
2240 | handles requests until the server gets some QUIT command, causing it to |
|
|
2241 | close the connection first (highly desirable for a busy TCP server). A |
|
|
2242 | client dropping the connection is an error, which means this variant can |
|
|
2243 | detect an unexpected detection close. |
|
|
2244 | |
|
|
2245 | To handle this case, always make sure you have a on-empty read queue, by |
|
|
2246 | pushing the "read request start" handler on it: |
|
|
2247 | |
|
|
2248 | # we assume a request starts with a single line |
|
|
2249 | my @start_request; @start_request = (line => sub { |
|
|
2250 | my ($hdl, $line) = @_; |
|
|
2251 | |
|
|
2252 | ... handle request |
|
|
2253 | |
|
|
2254 | # push next request read, possibly from a nested callback |
|
|
2255 | $hdl->push_read (@start_request); |
|
|
2256 | }); |
|
|
2257 | |
|
|
2258 | # auth done, now go into request handling loop |
|
|
2259 | # now push the first @start_request |
|
|
2260 | $hdl->push_read (@start_request); |
|
|
2261 | |
|
|
2262 | By always having an outstanding C<push_read>, the handle always expects |
|
|
2263 | some data and raises the C<EPIPE> error when the connction is dropped |
|
|
2264 | unexpectedly. |
|
|
2265 | |
|
|
2266 | The second variant is a protocol where the client can drop the connection |
|
|
2267 | at any time. For TCP, this means that the server machine may run out of |
|
|
2268 | sockets easier, and in general, it means you cannot distinguish a protocl |
|
|
2269 | failure/client crash from a normal connection close. Nevertheless, these |
|
|
2270 | kinds of protocols are common (and sometimes even the best solution to the |
|
|
2271 | problem). |
|
|
2272 | |
|
|
2273 | Having an outstanding read request at all times is possible if you ignore |
|
|
2274 | C<EPIPE> errors, but this doesn't help with when the client drops the |
|
|
2275 | connection during a request, which would still be an error. |
|
|
2276 | |
|
|
2277 | A better solution is to push the initial request read in an C<on_read> |
|
|
2278 | callback. This avoids an error, as when the server doesn't expect data |
|
|
2279 | (i.e. is idly waiting for the next request, an EOF will not raise an |
|
|
2280 | error, but simply result in an C<on_eof> callback. It is also a bit slower |
|
|
2281 | and simpler: |
|
|
2282 | |
|
|
2283 | # auth done, now go into request handling loop |
|
|
2284 | $hdl->on_read (sub { |
|
|
2285 | my ($hdl) = @_; |
|
|
2286 | |
|
|
2287 | # called each time we receive data but the read queue is empty |
|
|
2288 | # simply start read the request |
|
|
2289 | |
|
|
2290 | $hdl->push_read (line => sub { |
|
|
2291 | my ($hdl, $line) = @_; |
|
|
2292 | |
|
|
2293 | ... handle request |
|
|
2294 | |
|
|
2295 | # do nothing special when the request has been handled, just |
|
|
2296 | # let the request queue go empty. |
|
|
2297 | }); |
|
|
2298 | }); |
|
|
2299 | |
2058 | =item I get different callback invocations in TLS mode/Why can't I pause |
2300 | =item I get different callback invocations in TLS mode/Why can't I pause |
2059 | reading? |
2301 | reading? |
2060 | |
2302 | |
2061 | Unlike, say, TCP, TLS connections do not consist of two independent |
2303 | Unlike, say, TCP, TLS connections do not consist of two independent |
2062 | communication channels, one for each direction. Or put differently. The |
2304 | communication channels, one for each direction. Or put differently, the |
2063 | read and write directions are not independent of each other: you cannot |
2305 | read and write directions are not independent of each other: you cannot |
2064 | write data unless you are also prepared to read, and vice versa. |
2306 | write data unless you are also prepared to read, and vice versa. |
2065 | |
2307 | |
2066 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
2308 | This means that, in TLS mode, you might get C<on_error> or C<on_eof> |
2067 | callback invocations when you are not expecting any read data - the reason |
2309 | callback invocations when you are not expecting any read data - the reason |
2068 | is that AnyEvent::Handle always reads in TLS mode. |
2310 | is that AnyEvent::Handle always reads in TLS mode. |
2069 | |
2311 | |
2070 | During the connection, you have to make sure that you always have a |
2312 | During the connection, you have to make sure that you always have a |
2071 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
2313 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
… | |
… | |
2083 | $handle->on_eof (undef); |
2325 | $handle->on_eof (undef); |
2084 | $handle->on_error (sub { |
2326 | $handle->on_error (sub { |
2085 | my $data = delete $_[0]{rbuf}; |
2327 | my $data = delete $_[0]{rbuf}; |
2086 | }); |
2328 | }); |
2087 | |
2329 | |
|
|
2330 | Note that this example removes the C<rbuf> member from the handle object, |
|
|
2331 | which is not normally allowed by the API. It is expressly permitted in |
|
|
2332 | this case only, as the handle object needs to be destroyed afterwards. |
|
|
2333 | |
2088 | The reason to use C<on_error> is that TCP connections, due to latencies |
2334 | The reason to use C<on_error> is that TCP connections, due to latencies |
2089 | and packets loss, might get closed quite violently with an error, when in |
2335 | and packets loss, might get closed quite violently with an error, when in |
2090 | fact, all data has been received. |
2336 | fact all data has been received. |
2091 | |
2337 | |
2092 | It is usually better to use acknowledgements when transferring data, |
2338 | It is usually better to use acknowledgements when transferring data, |
2093 | to make sure the other side hasn't just died and you got the data |
2339 | to make sure the other side hasn't just died and you got the data |
2094 | intact. This is also one reason why so many internet protocols have an |
2340 | intact. This is also one reason why so many internet protocols have an |
2095 | explicit QUIT command. |
2341 | explicit QUIT command. |
… | |
… | |
2102 | C<low_water_mark> this will be called precisely when all data has been |
2348 | C<low_water_mark> this will be called precisely when all data has been |
2103 | written to the socket: |
2349 | written to the socket: |
2104 | |
2350 | |
2105 | $handle->push_write (...); |
2351 | $handle->push_write (...); |
2106 | $handle->on_drain (sub { |
2352 | $handle->on_drain (sub { |
2107 | warn "all data submitted to the kernel\n"; |
2353 | AE::log debug => "All data submitted to the kernel."; |
2108 | undef $handle; |
2354 | undef $handle; |
2109 | }); |
2355 | }); |
2110 | |
2356 | |
2111 | If you just want to queue some data and then signal EOF to the other side, |
2357 | If you just want to queue some data and then signal EOF to the other side, |
2112 | consider using C<< ->push_shutdown >> instead. |
2358 | consider using C<< ->push_shutdown >> instead. |
2113 | |
2359 | |
2114 | =item I want to contact a TLS/SSL server, I don't care about security. |
2360 | =item I want to contact a TLS/SSL server, I don't care about security. |
2115 | |
2361 | |
2116 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2362 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2117 | simply connect to it and then create the AnyEvent::Handle with the C<tls> |
2363 | connect to it and then create the AnyEvent::Handle with the C<tls> |
2118 | parameter: |
2364 | parameter: |
2119 | |
2365 | |
2120 | tcp_connect $host, $port, sub { |
2366 | tcp_connect $host, $port, sub { |
2121 | my ($fh) = @_; |
2367 | my ($fh) = @_; |
2122 | |
2368 | |
… | |
… | |
2196 | When you have intermediate CA certificates that your clients might not |
2442 | When you have intermediate CA certificates that your clients might not |
2197 | know about, just append them to the C<cert_file>. |
2443 | know about, just append them to the C<cert_file>. |
2198 | |
2444 | |
2199 | =back |
2445 | =back |
2200 | |
2446 | |
2201 | |
|
|
2202 | =head1 SUBCLASSING AnyEvent::Handle |
2447 | =head1 SUBCLASSING AnyEvent::Handle |
2203 | |
2448 | |
2204 | In many cases, you might want to subclass AnyEvent::Handle. |
2449 | In many cases, you might want to subclass AnyEvent::Handle. |
2205 | |
2450 | |
2206 | To make this easier, a given version of AnyEvent::Handle uses these |
2451 | To make this easier, a given version of AnyEvent::Handle uses these |
… | |
… | |
2222 | |
2467 | |
2223 | =item * all members not documented here and not prefixed with an underscore |
2468 | =item * all members not documented here and not prefixed with an underscore |
2224 | are free to use in subclasses. |
2469 | are free to use in subclasses. |
2225 | |
2470 | |
2226 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2471 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2227 | member variables, but thats just life, at least it is documented. |
2472 | member variables, but that's just life. At least it is documented. |
2228 | |
2473 | |
2229 | =back |
2474 | =back |
2230 | |
2475 | |
2231 | =head1 AUTHOR |
2476 | =head1 AUTHOR |
2232 | |
2477 | |
2233 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2478 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2234 | |
2479 | |
2235 | =cut |
2480 | =cut |
2236 | |
2481 | |
2237 | 1; # End of AnyEvent::Handle |
2482 | 1 |
|
|
2483 | |