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 |
… | |
… | |
312 | is enabled) gives you the most portable way of getting urgent data, by |
364 | is enabled) gives you the most portable way of getting urgent data, by |
313 | putting it into the stream. |
365 | putting it into the stream. |
314 | |
366 | |
315 | Since BSD emulation of OOB data on top of TCP's urgent data can have |
367 | Since BSD emulation of OOB data on top of TCP's urgent data can have |
316 | security implications, AnyEvent::Handle sets this flag automatically |
368 | security implications, AnyEvent::Handle sets this flag automatically |
317 | unless explicitly specified. |
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. |
318 | |
373 | |
319 | =item read_size => <bytes> |
374 | =item read_size => <bytes> |
320 | |
375 | |
321 | 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 |
322 | try to read during each loop iteration, which affects memory |
377 | to read during each loop iteration. Each handle object will consume |
323 | 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. |
324 | |
388 | |
325 | =item low_water_mark => <bytes> |
389 | =item low_water_mark => <bytes> |
326 | |
390 | |
327 | 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 |
328 | 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 |
329 | considered empty. |
393 | considered empty. |
330 | |
394 | |
331 | 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 |
332 | 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 |
333 | 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 |
334 | is good in almost all cases. |
398 | is good in almost all cases. |
335 | |
399 | |
336 | =item linger => <seconds> |
400 | =item linger => <seconds> |
337 | |
401 | |
338 | If non-zero (default: C<3600>), then the destructor of the |
402 | If this is non-zero (default: C<3600>), the destructor of the |
339 | AnyEvent::Handle object will check whether there is still outstanding |
403 | AnyEvent::Handle object will check whether there is still outstanding |
340 | 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 |
341 | 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 |
342 | system treats outstanding data at socket close time). |
406 | system treats outstanding data at socket close time). |
343 | |
407 | |
… | |
… | |
350 | 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 |
351 | (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. |
352 | |
416 | |
353 | 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 |
354 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
418 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
355 | verification will be skipped when C<peername> is not specified or |
419 | verification will be skipped when C<peername> is not specified or is |
356 | C<undef>. |
420 | C<undef>. |
357 | |
421 | |
358 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
422 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
359 | |
423 | |
360 | 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 |
361 | 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 |
362 | established and will transparently encrypt/decrypt data afterwards. |
426 | established and will transparently encrypt/decrypt data afterwards. |
363 | |
427 | |
364 | 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 |
365 | appropriate error message. |
429 | appropriate error message. |
366 | |
430 | |
367 | 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 |
368 | 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 |
369 | 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 |
370 | 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. |
371 | |
436 | |
372 | 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 |
373 | 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> |
374 | mode. |
439 | mode. |
375 | |
440 | |
… | |
… | |
386 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
451 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
387 | 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 |
388 | 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 |
389 | segmentation fault. |
454 | segmentation fault. |
390 | |
455 | |
391 | 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. |
392 | |
457 | |
393 | =item tls_ctx => $anyevent_tls |
458 | =item tls_ctx => $anyevent_tls |
394 | |
459 | |
395 | 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 |
396 | (unless a connection object was specified directly). If this parameter is |
461 | (unless a connection object was specified directly). If this |
397 | 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>. |
398 | |
464 | |
399 | 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 |
400 | => 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 |
401 | new TLS context object. |
467 | new TLS context object. |
402 | |
468 | |
… | |
… | |
411 | |
477 | |
412 | 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 |
413 | 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>. |
414 | |
480 | |
415 | Without this callback, handshake failures lead to C<on_error> being |
481 | Without this callback, handshake failures lead to C<on_error> being |
416 | called, as normal. |
482 | called as usual. |
417 | |
483 | |
418 | 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 |
419 | 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 |
420 | then call C<< ->starttls >> again. |
486 | then call C<< ->starttls >> again. |
421 | |
487 | |
422 | =item on_stoptls => $cb->($handle) |
488 | =item on_stoptls => $cb->($handle) |
423 | |
489 | |
… | |
… | |
471 | $self->{connect}[0], |
537 | $self->{connect}[0], |
472 | $self->{connect}[1], |
538 | $self->{connect}[1], |
473 | sub { |
539 | sub { |
474 | my ($fh, $host, $port, $retry) = @_; |
540 | my ($fh, $host, $port, $retry) = @_; |
475 | |
541 | |
|
|
542 | delete $self->{_connect}; # no longer needed |
|
|
543 | |
476 | if ($fh) { |
544 | if ($fh) { |
477 | $self->{fh} = $fh; |
545 | $self->{fh} = $fh; |
478 | |
546 | |
479 | delete $self->{_skip_drain_rbuf}; |
547 | delete $self->{_skip_drain_rbuf}; |
480 | $self->_start; |
548 | $self->_start; |
… | |
… | |
487 | }); |
555 | }); |
488 | |
556 | |
489 | } else { |
557 | } else { |
490 | if ($self->{on_connect_error}) { |
558 | if ($self->{on_connect_error}) { |
491 | $self->{on_connect_error}($self, "$!"); |
559 | $self->{on_connect_error}($self, "$!"); |
492 | $self->destroy; |
560 | $self->destroy if $self; |
493 | } else { |
561 | } else { |
494 | $self->_error ($!, 1); |
562 | $self->_error ($!, 1); |
495 | } |
563 | } |
496 | } |
564 | } |
497 | }, |
565 | }, |
498 | sub { |
566 | sub { |
499 | local $self->{fh} = $_[0]; |
567 | local $self->{fh} = $_[0]; |
500 | |
568 | |
501 | $self->{on_prepare} |
569 | $self->{on_prepare} |
502 | ? $self->{on_prepare}->($self) |
570 | ? $self->{on_prepare}->($self) |
503 | : () |
571 | : () |
504 | } |
572 | } |
505 | ); |
573 | ); |
506 | } |
574 | } |
507 | |
575 | |
… | |
… | |
513 | } |
581 | } |
514 | |
582 | |
515 | sub _start { |
583 | sub _start { |
516 | my ($self) = @_; |
584 | my ($self) = @_; |
517 | |
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 | |
518 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
592 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
519 | |
593 | |
520 | $self->{_activity} = |
594 | $self->{_activity} = |
521 | $self->{_ractivity} = |
595 | $self->{_ractivity} = |
522 | $self->{_wactivity} = AE::now; |
596 | $self->{_wactivity} = AE::now; |
523 | |
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 | |
524 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
602 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
525 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
603 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
526 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
604 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
527 | |
605 | |
528 | $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}; |
… | |
… | |
531 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
609 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
532 | |
610 | |
533 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
611 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
534 | if $self->{tls}; |
612 | if $self->{tls}; |
535 | |
613 | |
536 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
614 | $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain}; |
537 | |
615 | |
538 | $self->start_read |
616 | $self->start_read |
539 | if $self->{on_read} || @{ $self->{_queue} }; |
617 | if $self->{on_read} || @{ $self->{_queue} }; |
540 | |
618 | |
541 | $self->_drain_wbuf; |
619 | $self->_drain_wbuf; |
… | |
… | |
548 | $message ||= "$!"; |
626 | $message ||= "$!"; |
549 | |
627 | |
550 | if ($self->{on_error}) { |
628 | if ($self->{on_error}) { |
551 | $self->{on_error}($self, $fatal, $message); |
629 | $self->{on_error}($self, $fatal, $message); |
552 | $self->destroy if $fatal; |
630 | $self->destroy if $fatal; |
553 | } elsif ($self->{fh}) { |
631 | } elsif ($self->{fh} || $self->{connect}) { |
554 | $self->destroy; |
632 | $self->destroy; |
555 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
633 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
556 | } |
634 | } |
557 | } |
635 | } |
558 | |
636 | |
… | |
… | |
617 | =cut |
695 | =cut |
618 | |
696 | |
619 | sub no_delay { |
697 | sub no_delay { |
620 | $_[0]{no_delay} = $_[1]; |
698 | $_[0]{no_delay} = $_[1]; |
621 | |
699 | |
622 | eval { |
|
|
623 | local $SIG{__DIE__}; |
|
|
624 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
700 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
625 | if $_[0]{fh}; |
701 | if $_[0]{fh}; |
626 | }; |
|
|
627 | } |
702 | } |
628 | |
703 | |
629 | =item $handle->keepalive ($boolean) |
704 | =item $handle->keepalive ($boolean) |
630 | |
705 | |
631 | Enables or disables the C<keepalive> setting (see constructor argument of |
706 | Enables or disables the C<keepalive> setting (see constructor argument of |
… | |
… | |
691 | |
766 | |
692 | 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). |
693 | |
768 | |
694 | =cut |
769 | =cut |
695 | |
770 | |
696 | sub on_starttls { |
771 | sub on_stoptls { |
697 | $_[0]{on_stoptls} = $_[1]; |
772 | $_[0]{on_stoptls} = $_[1]; |
698 | } |
773 | } |
699 | |
774 | |
700 | =item $handle->rbuf_max ($max_octets) |
775 | =item $handle->rbuf_max ($max_octets) |
701 | |
776 | |
702 | 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). |
703 | |
782 | |
704 | =cut |
783 | =cut |
705 | |
784 | |
706 | sub rbuf_max { |
785 | sub rbuf_max { |
707 | $_[0]{rbuf_max} = $_[1]; |
786 | $_[0]{rbuf_max} = $_[1]; |
708 | } |
787 | } |
709 | |
788 | |
|
|
789 | sub wbuf_max { |
|
|
790 | $_[0]{wbuf_max} = $_[1]; |
|
|
791 | } |
|
|
792 | |
710 | ############################################################################# |
793 | ############################################################################# |
711 | |
794 | |
712 | =item $handle->timeout ($seconds) |
795 | =item $handle->timeout ($seconds) |
713 | |
796 | |
714 | =item $handle->rtimeout ($seconds) |
797 | =item $handle->rtimeout ($seconds) |
715 | |
798 | |
716 | =item $handle->wtimeout ($seconds) |
799 | =item $handle->wtimeout ($seconds) |
717 | |
800 | |
718 | 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. |
719 | |
805 | |
720 | =item $handle->timeout_reset |
806 | =item $handle->timeout_reset |
721 | |
807 | |
722 | =item $handle->rtimeout_reset |
808 | =item $handle->rtimeout_reset |
723 | |
809 | |
… | |
… | |
740 | $_[0]{$on_timeout} = $_[1]; |
826 | $_[0]{$on_timeout} = $_[1]; |
741 | }; |
827 | }; |
742 | |
828 | |
743 | *$timeout = sub { |
829 | *$timeout = sub { |
744 | 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"; |
745 | |
834 | |
746 | $self->{$timeout} = $new_value; |
835 | $self->{$timeout} = $new_value; |
747 | delete $self->{$tw}; &$cb; |
836 | delete $self->{$tw}; &$cb; |
748 | }; |
837 | }; |
749 | |
838 | |
… | |
… | |
804 | |
893 | |
805 | 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 |
806 | 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. |
807 | |
896 | |
808 | 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 |
809 | water mark, the C<on_drain> callback will be invoked. |
898 | water mark, the C<on_drain> callback will be invoked once. |
810 | |
899 | |
811 | =over 4 |
900 | =over 4 |
812 | |
901 | |
813 | =item $handle->on_drain ($cb) |
902 | =item $handle->on_drain ($cb) |
814 | |
903 | |
815 | 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 |
816 | C<on_drain> in the constructor). |
905 | C<on_drain> in the constructor). |
817 | |
906 | |
|
|
907 | This method may invoke callbacks (and therefore the handle might be |
|
|
908 | destroyed after it returns). |
|
|
909 | |
818 | =cut |
910 | =cut |
819 | |
911 | |
820 | sub on_drain { |
912 | sub on_drain { |
821 | my ($self, $cb) = @_; |
913 | my ($self, $cb) = @_; |
822 | |
914 | |
… | |
… | |
826 | 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}); |
827 | } |
919 | } |
828 | |
920 | |
829 | =item $handle->push_write ($data) |
921 | =item $handle->push_write ($data) |
830 | |
922 | |
831 | 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 |
832 | 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 |
833 | 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). |
834 | |
929 | |
835 | =cut |
930 | =cut |
836 | |
931 | |
837 | sub _drain_wbuf { |
932 | sub _drain_wbuf { |
838 | my ($self) = @_; |
933 | my ($self) = @_; |
… | |
… | |
863 | $cb->() unless $self->{autocork}; |
958 | $cb->() unless $self->{autocork}; |
864 | |
959 | |
865 | # if still data left in wbuf, we need to poll |
960 | # if still data left in wbuf, we need to poll |
866 | $self->{_ww} = AE::io $self->{fh}, 1, $cb |
961 | $self->{_ww} = AE::io $self->{fh}, 1, $cb |
867 | 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 | } |
868 | }; |
970 | }; |
869 | } |
971 | } |
870 | |
972 | |
871 | our %WH; |
973 | our %WH; |
872 | |
974 | |
|
|
975 | # deprecated |
873 | sub register_write_type($$) { |
976 | sub register_write_type($$) { |
874 | $WH{$_[0]} = $_[1]; |
977 | $WH{$_[0]} = $_[1]; |
875 | } |
978 | } |
876 | |
979 | |
877 | sub push_write { |
980 | sub push_write { |
878 | my $self = shift; |
981 | my $self = shift; |
879 | |
982 | |
880 | if (@_ > 1) { |
983 | if (@_ > 1) { |
881 | my $type = shift; |
984 | my $type = shift; |
882 | |
985 | |
|
|
986 | @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" |
883 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
987 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") |
884 | ->($self, @_); |
988 | ->($self, @_); |
885 | } |
989 | } |
886 | |
990 | |
|
|
991 | # we downgrade here to avoid hard-to-track-down bugs, |
|
|
992 | # and diagnose the problem earlier and better. |
|
|
993 | |
887 | if ($self->{tls}) { |
994 | if ($self->{tls}) { |
888 | $self->{_tls_wbuf} .= $_[0]; |
995 | utf8::downgrade $self->{_tls_wbuf} .= $_[0]; |
889 | &_dotls ($self) if $self->{fh}; |
996 | &_dotls ($self) if $self->{fh}; |
890 | } else { |
997 | } else { |
891 | $self->{wbuf} .= $_[0]; |
998 | utf8::downgrade $self->{wbuf} .= $_[0]; |
892 | $self->_drain_wbuf if $self->{fh}; |
999 | $self->_drain_wbuf if $self->{fh}; |
893 | } |
1000 | } |
894 | } |
1001 | } |
895 | |
1002 | |
896 | =item $handle->push_write (type => @args) |
1003 | =item $handle->push_write (type => @args) |
897 | |
1004 | |
898 | Instead of formatting your data yourself, you can also let this module do |
1005 | Instead of formatting your data yourself, you can also let this module |
899 | the job by specifying a type and type-specific arguments. |
1006 | do the job by specifying a type and type-specific arguments. You |
|
|
1007 | can also specify the (fully qualified) name of a package, in which |
|
|
1008 | case AnyEvent tries to load the package and then expects to find the |
|
|
1009 | C<anyevent_write_type> function inside (see "custom write types", below). |
900 | |
1010 | |
901 | 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 |
902 | drop by and tell us): |
1012 | drop by and tell us): |
903 | |
1013 | |
904 | =over 4 |
1014 | =over 4 |
… | |
… | |
984 | =cut |
1094 | =cut |
985 | |
1095 | |
986 | register_write_type storable => sub { |
1096 | register_write_type storable => sub { |
987 | my ($self, $ref) = @_; |
1097 | my ($self, $ref) = @_; |
988 | |
1098 | |
989 | require Storable; |
1099 | require Storable unless $Storable::VERSION; |
990 | |
1100 | |
991 | pack "w/a*", Storable::nfreeze ($ref) |
1101 | pack "w/a*", Storable::nfreeze ($ref) |
992 | }; |
1102 | }; |
993 | |
1103 | |
994 | =back |
1104 | =back |
… | |
… | |
999 | 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 |
1000 | 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 |
1001 | 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 |
1002 | replaces the C<on_drain> callback with: |
1112 | replaces the C<on_drain> callback with: |
1003 | |
1113 | |
1004 | sub { shutdown $_[0]{fh}, 1 } # for push_shutdown |
1114 | sub { shutdown $_[0]{fh}, 1 } |
1005 | |
1115 | |
1006 | 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 |
1007 | the peer. |
1117 | the peer. |
1008 | |
1118 | |
1009 | 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 |
1010 | afterwards. This is the cleanest way to close a connection. |
1120 | afterwards. This is the cleanest way to close a connection. |
1011 | |
1121 | |
|
|
1122 | This method may invoke callbacks (and therefore the handle might be |
|
|
1123 | destroyed after it returns). |
|
|
1124 | |
1012 | =cut |
1125 | =cut |
1013 | |
1126 | |
1014 | sub push_shutdown { |
1127 | sub push_shutdown { |
1015 | my ($self) = @_; |
1128 | my ($self) = @_; |
1016 | |
1129 | |
1017 | delete $self->{low_water_mark}; |
1130 | delete $self->{low_water_mark}; |
1018 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
1131 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
1019 | } |
1132 | } |
1020 | |
1133 | |
1021 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
1134 | =item custom write types - Package::anyevent_write_type $handle, @args |
1022 | |
1135 | |
1023 | This function (not method) lets you add your own types to C<push_write>. |
1136 | Instead of one of the predefined types, you can also specify the name of |
|
|
1137 | a package. AnyEvent will try to load the package and then expects to find |
|
|
1138 | a function named C<anyevent_write_type> inside. If it isn't found, it |
|
|
1139 | progressively tries to load the parent package until it either finds the |
|
|
1140 | function (good) or runs out of packages (bad). |
|
|
1141 | |
1024 | Whenever the given C<type> is used, C<push_write> will invoke the code |
1142 | Whenever the given C<type> is used, C<push_write> will the function with |
1025 | reference with the handle object and the remaining arguments. |
1143 | the handle object and the remaining arguments. |
1026 | |
1144 | |
1027 | The code reference is supposed to return a single octet string that will |
1145 | The function is supposed to return a single octet string that will be |
1028 | be appended to the write buffer. |
1146 | appended to the write buffer, so you can mentally treat this function as a |
|
|
1147 | "arguments to on-the-wire-format" converter. |
1029 | |
1148 | |
1030 | Note that this is a function, and all types registered this way will be |
1149 | Example: implement a custom write type C<join> that joins the remaining |
1031 | global, so try to use unique names. |
1150 | arguments using the first one. |
|
|
1151 | |
|
|
1152 | $handle->push_write (My::Type => " ", 1,2,3); |
|
|
1153 | |
|
|
1154 | # uses the following package, which can be defined in the "My::Type" or in |
|
|
1155 | # the "My" modules to be auto-loaded, or just about anywhere when the |
|
|
1156 | # My::Type::anyevent_write_type is defined before invoking it. |
|
|
1157 | |
|
|
1158 | package My::Type; |
|
|
1159 | |
|
|
1160 | sub anyevent_write_type { |
|
|
1161 | my ($handle, $delim, @args) = @_; |
|
|
1162 | |
|
|
1163 | join $delim, @args |
|
|
1164 | } |
1032 | |
1165 | |
1033 | =cut |
1166 | =cut |
1034 | |
1167 | |
1035 | ############################################################################# |
1168 | ############################################################################# |
1036 | |
1169 | |
… | |
… | |
1045 | 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 |
1046 | a queue. |
1179 | a queue. |
1047 | |
1180 | |
1048 | 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 |
1049 | 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 |
1050 | 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 |
1051 | 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 |
1052 | 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>. |
1053 | |
1187 | |
1054 | 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 |
1055 | 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 |
1056 | 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 |
1057 | done its job (see C<push_read>, below). |
1191 | done its job (see C<push_read>, below). |
1058 | |
1192 | |
1059 | 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 |
1060 | 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. |
1061 | |
1195 | |
… | |
… | |
1192 | |
1326 | |
1193 | 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 |
1194 | 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 |
1195 | constructor. |
1329 | constructor. |
1196 | |
1330 | |
|
|
1331 | This method may invoke callbacks (and therefore the handle might be |
|
|
1332 | destroyed after it returns). |
|
|
1333 | |
1197 | =cut |
1334 | =cut |
1198 | |
1335 | |
1199 | sub on_read { |
1336 | sub on_read { |
1200 | my ($self, $cb) = @_; |
1337 | my ($self, $cb) = @_; |
1201 | |
1338 | |
… | |
… | |
1203 | $self->_drain_rbuf if $cb; |
1340 | $self->_drain_rbuf if $cb; |
1204 | } |
1341 | } |
1205 | |
1342 | |
1206 | =item $handle->rbuf |
1343 | =item $handle->rbuf |
1207 | |
1344 | |
1208 | 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). |
1209 | |
1348 | |
1210 | 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) |
1211 | member, if you want. However, the only operation allowed on the |
1350 | is removing data from its beginning. Otherwise modifying or appending to |
1212 | 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. |
1213 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
1214 | lead to hard-to-track-down bugs. |
|
|
1215 | |
1352 | |
1216 | 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> |
1217 | 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 |
1218 | 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. |
1219 | |
1357 | |
1220 | =cut |
1358 | =cut |
1221 | |
1359 | |
1222 | sub rbuf : lvalue { |
1360 | sub rbuf : lvalue { |
1223 | $_[0]{rbuf} |
1361 | $_[0]{rbuf} |
… | |
… | |
1240 | |
1378 | |
1241 | 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 |
1242 | 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 |
1243 | true, it will be removed from the queue. |
1381 | true, it will be removed from the queue. |
1244 | |
1382 | |
|
|
1383 | These methods may invoke callbacks (and therefore the handle might be |
|
|
1384 | destroyed after it returns). |
|
|
1385 | |
1245 | =cut |
1386 | =cut |
1246 | |
1387 | |
1247 | our %RH; |
1388 | our %RH; |
1248 | |
1389 | |
1249 | sub register_read_type($$) { |
1390 | sub register_read_type($$) { |
… | |
… | |
1255 | my $cb = pop; |
1396 | my $cb = pop; |
1256 | |
1397 | |
1257 | if (@_) { |
1398 | if (@_) { |
1258 | my $type = shift; |
1399 | my $type = shift; |
1259 | |
1400 | |
|
|
1401 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1260 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
1402 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read") |
1261 | ->($self, $cb, @_); |
1403 | ->($self, $cb, @_); |
1262 | } |
1404 | } |
1263 | |
1405 | |
1264 | push @{ $self->{_queue} }, $cb; |
1406 | push @{ $self->{_queue} }, $cb; |
1265 | $self->_drain_rbuf; |
1407 | $self->_drain_rbuf; |
… | |
… | |
1270 | my $cb = pop; |
1412 | my $cb = pop; |
1271 | |
1413 | |
1272 | if (@_) { |
1414 | if (@_) { |
1273 | my $type = shift; |
1415 | my $type = shift; |
1274 | |
1416 | |
|
|
1417 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1275 | $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") |
1276 | ->($self, $cb, @_); |
1419 | ->($self, $cb, @_); |
1277 | } |
1420 | } |
1278 | |
1421 | |
1279 | unshift @{ $self->{_queue} }, $cb; |
1422 | unshift @{ $self->{_queue} }, $cb; |
1280 | $self->_drain_rbuf; |
1423 | $self->_drain_rbuf; |
… | |
… | |
1284 | |
1427 | |
1285 | =item $handle->unshift_read (type => @args, $cb) |
1428 | =item $handle->unshift_read (type => @args, $cb) |
1286 | |
1429 | |
1287 | Instead of providing a callback that parses the data itself you can chose |
1430 | Instead of providing a callback that parses the data itself you can chose |
1288 | between a number of predefined parsing formats, for chunks of data, lines |
1431 | between a number of predefined parsing formats, for chunks of data, lines |
1289 | etc. |
1432 | etc. You can also specify the (fully qualified) name of a package, in |
|
|
1433 | which case AnyEvent tries to load the package and then expects to find the |
|
|
1434 | C<anyevent_read_type> function inside (see "custom read types", below). |
1290 | |
1435 | |
1291 | Predefined types are (if you have ideas for additional types, feel free to |
1436 | Predefined types are (if you have ideas for additional types, feel free to |
1292 | drop by and tell us): |
1437 | drop by and tell us): |
1293 | |
1438 | |
1294 | =over 4 |
1439 | =over 4 |
… | |
… | |
1300 | data. |
1445 | data. |
1301 | |
1446 | |
1302 | Example: read 2 bytes. |
1447 | Example: read 2 bytes. |
1303 | |
1448 | |
1304 | $handle->push_read (chunk => 2, sub { |
1449 | $handle->push_read (chunk => 2, sub { |
1305 | warn "yay ", unpack "H*", $_[1]; |
1450 | say "yay " . unpack "H*", $_[1]; |
1306 | }); |
1451 | }); |
1307 | |
1452 | |
1308 | =cut |
1453 | =cut |
1309 | |
1454 | |
1310 | register_read_type chunk => sub { |
1455 | register_read_type chunk => sub { |
… | |
… | |
1344 | if (@_ < 3) { |
1489 | if (@_ < 3) { |
1345 | # 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 |
1346 | sub { |
1491 | sub { |
1347 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1492 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1348 | |
1493 | |
1349 | $cb->($_[0], $1, $2); |
1494 | $cb->($_[0], "$1", "$2"); |
1350 | 1 |
1495 | 1 |
1351 | } |
1496 | } |
1352 | } else { |
1497 | } else { |
1353 | $eol = quotemeta $eol unless ref $eol; |
1498 | $eol = quotemeta $eol unless ref $eol; |
1354 | $eol = qr|^(.*?)($eol)|s; |
1499 | $eol = qr|^(.*?)($eol)|s; |
1355 | |
1500 | |
1356 | sub { |
1501 | sub { |
1357 | $_[0]{rbuf} =~ s/$eol// or return; |
1502 | $_[0]{rbuf} =~ s/$eol// or return; |
1358 | |
1503 | |
1359 | $cb->($_[0], $1, $2); |
1504 | $cb->($_[0], "$1", "$2"); |
1360 | 1 |
1505 | 1 |
1361 | } |
1506 | } |
1362 | } |
1507 | } |
1363 | }; |
1508 | }; |
1364 | |
1509 | |
… | |
… | |
1386 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1531 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1387 | and everything preceding and including the match will be accepted |
1532 | and everything preceding and including the match will be accepted |
1388 | 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 |
1389 | 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 |
1390 | 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 |
1391 | 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. |
1392 | |
1537 | |
1393 | 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 |
1394 | 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 |
1395 | 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 |
1396 | 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 |
1397 | required for the accept regex. |
1542 | required for the accept regex. |
1398 | |
1543 | |
1399 | $handle->push_read (regex => |
1544 | $handle->push_read (regex => |
… | |
… | |
1412 | |
1557 | |
1413 | sub { |
1558 | sub { |
1414 | # accept |
1559 | # accept |
1415 | if ($$rbuf =~ $accept) { |
1560 | if ($$rbuf =~ $accept) { |
1416 | $data .= substr $$rbuf, 0, $+[0], ""; |
1561 | $data .= substr $$rbuf, 0, $+[0], ""; |
1417 | $cb->($self, $data); |
1562 | $cb->($_[0], $data); |
1418 | return 1; |
1563 | return 1; |
1419 | } |
1564 | } |
1420 | |
1565 | |
1421 | # reject |
1566 | # reject |
1422 | if ($reject && $$rbuf =~ $reject) { |
1567 | if ($reject && $$rbuf =~ $reject) { |
1423 | $self->_error (Errno::EBADMSG); |
1568 | $_[0]->_error (Errno::EBADMSG); |
1424 | } |
1569 | } |
1425 | |
1570 | |
1426 | # skip |
1571 | # skip |
1427 | if ($skip && $$rbuf =~ $skip) { |
1572 | if ($skip && $$rbuf =~ $skip) { |
1428 | $data .= substr $$rbuf, 0, $+[0], ""; |
1573 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
1444 | my ($self, $cb) = @_; |
1589 | my ($self, $cb) = @_; |
1445 | |
1590 | |
1446 | sub { |
1591 | sub { |
1447 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1592 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1448 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1593 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1449 | $self->_error (Errno::EBADMSG); |
1594 | $_[0]->_error (Errno::EBADMSG); |
1450 | } |
1595 | } |
1451 | return; |
1596 | return; |
1452 | } |
1597 | } |
1453 | |
1598 | |
1454 | my $len = $1; |
1599 | my $len = $1; |
1455 | |
1600 | |
1456 | $self->unshift_read (chunk => $len, sub { |
1601 | $_[0]->unshift_read (chunk => $len, sub { |
1457 | my $string = $_[1]; |
1602 | my $string = $_[1]; |
1458 | $_[0]->unshift_read (chunk => 1, sub { |
1603 | $_[0]->unshift_read (chunk => 1, sub { |
1459 | if ($_[1] eq ",") { |
1604 | if ($_[1] eq ",") { |
1460 | $cb->($_[0], $string); |
1605 | $cb->($_[0], $string); |
1461 | } else { |
1606 | } else { |
1462 | $self->_error (Errno::EBADMSG); |
1607 | $_[0]->_error (Errno::EBADMSG); |
1463 | } |
1608 | } |
1464 | }); |
1609 | }); |
1465 | }); |
1610 | }); |
1466 | |
1611 | |
1467 | 1 |
1612 | 1 |
… | |
… | |
1540 | |
1685 | |
1541 | my $data; |
1686 | my $data; |
1542 | my $rbuf = \$self->{rbuf}; |
1687 | my $rbuf = \$self->{rbuf}; |
1543 | |
1688 | |
1544 | sub { |
1689 | sub { |
1545 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1690 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1546 | |
1691 | |
1547 | if ($ref) { |
1692 | if ($ref) { |
1548 | $self->{rbuf} = $json->incr_text; |
1693 | $_[0]{rbuf} = $json->incr_text; |
1549 | $json->incr_text = ""; |
1694 | $json->incr_text = ""; |
1550 | $cb->($self, $ref); |
1695 | $cb->($_[0], $ref); |
1551 | |
1696 | |
1552 | 1 |
1697 | 1 |
1553 | } elsif ($@) { |
1698 | } elsif ($@) { |
1554 | # error case |
1699 | # error case |
1555 | $json->incr_skip; |
1700 | $json->incr_skip; |
1556 | |
1701 | |
1557 | $self->{rbuf} = $json->incr_text; |
1702 | $_[0]{rbuf} = $json->incr_text; |
1558 | $json->incr_text = ""; |
1703 | $json->incr_text = ""; |
1559 | |
1704 | |
1560 | $self->_error (Errno::EBADMSG); |
1705 | $_[0]->_error (Errno::EBADMSG); |
1561 | |
1706 | |
1562 | () |
1707 | () |
1563 | } else { |
1708 | } else { |
1564 | $self->{rbuf} = ""; |
1709 | $_[0]{rbuf} = ""; |
1565 | |
1710 | |
1566 | () |
1711 | () |
1567 | } |
1712 | } |
1568 | } |
1713 | } |
1569 | }; |
1714 | }; |
… | |
… | |
1579 | =cut |
1724 | =cut |
1580 | |
1725 | |
1581 | register_read_type storable => sub { |
1726 | register_read_type storable => sub { |
1582 | my ($self, $cb) = @_; |
1727 | my ($self, $cb) = @_; |
1583 | |
1728 | |
1584 | require Storable; |
1729 | require Storable unless $Storable::VERSION; |
1585 | |
1730 | |
1586 | sub { |
1731 | sub { |
1587 | # 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 |
1588 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1733 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1589 | or return; |
1734 | or return; |
… | |
… | |
1592 | |
1737 | |
1593 | # bypass unshift if we already have the remaining chunk |
1738 | # bypass unshift if we already have the remaining chunk |
1594 | if ($format + $len <= length $_[0]{rbuf}) { |
1739 | if ($format + $len <= length $_[0]{rbuf}) { |
1595 | my $data = substr $_[0]{rbuf}, $format, $len; |
1740 | my $data = substr $_[0]{rbuf}, $format, $len; |
1596 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
1741 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1742 | |
1597 | $cb->($_[0], Storable::thaw ($data)); |
1743 | eval { $cb->($_[0], Storable::thaw ($data)); 1 } |
|
|
1744 | or return $_[0]->_error (Errno::EBADMSG); |
1598 | } else { |
1745 | } else { |
1599 | # remove prefix |
1746 | # remove prefix |
1600 | substr $_[0]{rbuf}, 0, $format, ""; |
1747 | substr $_[0]{rbuf}, 0, $format, ""; |
1601 | |
1748 | |
1602 | # read remaining chunk |
1749 | # read remaining chunk |
1603 | $_[0]->unshift_read (chunk => $len, sub { |
1750 | $_[0]->unshift_read (chunk => $len, sub { |
1604 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1751 | eval { $cb->($_[0], Storable::thaw ($_[1])); 1 } |
1605 | $cb->($_[0], $ref); |
|
|
1606 | } else { |
|
|
1607 | $self->_error (Errno::EBADMSG); |
1752 | or $_[0]->_error (Errno::EBADMSG); |
1608 | } |
|
|
1609 | }); |
1753 | }); |
1610 | } |
1754 | } |
1611 | |
1755 | |
1612 | 1 |
1756 | 1 |
1613 | } |
1757 | } |
1614 | }; |
1758 | }; |
1615 | |
1759 | |
|
|
1760 | =item tls_detect => $cb->($handle, $detect, $major, $minor) |
|
|
1761 | |
|
|
1762 | Checks the input stream for a valid SSL or TLS handshake TLSPaintext |
|
|
1763 | record without consuming anything. Only SSL version 3 or higher |
|
|
1764 | is handled, up to the fictituous protocol 4.x (but both SSL3+ and |
|
|
1765 | SSL2-compatible framing is supported). |
|
|
1766 | |
|
|
1767 | If it detects that the input data is likely TLS, it calls the callback |
|
|
1768 | with a true value for C<$detect> and the (on-wire) TLS version as second |
|
|
1769 | and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL |
|
|
1770 | 3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to |
|
|
1771 | be definitely not TLS, it calls the callback with a false value for |
|
|
1772 | C<$detect>. |
|
|
1773 | |
|
|
1774 | The callback could use this information to decide whether or not to start |
|
|
1775 | TLS negotiation. |
|
|
1776 | |
|
|
1777 | In all cases the data read so far is passed to the following read |
|
|
1778 | handlers. |
|
|
1779 | |
|
|
1780 | Usually you want to use the C<tls_autostart> read type instead. |
|
|
1781 | |
|
|
1782 | If you want to design a protocol that works in the presence of TLS |
|
|
1783 | dtection, make sure that any non-TLS data doesn't start with the octet 22 |
|
|
1784 | (ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this |
|
|
1785 | read type does are a bit more strict, but might losen in the future to |
|
|
1786 | accomodate protocol changes. |
|
|
1787 | |
|
|
1788 | This read type does not rely on L<AnyEvent::TLS> (and thus, not on |
|
|
1789 | L<Net::SSLeay>). |
|
|
1790 | |
|
|
1791 | =item tls_autostart => $tls[, $tls_ctx] |
|
|
1792 | |
|
|
1793 | Tries to detect a valid SSL or TLS handshake. If one is detected, it tries |
|
|
1794 | to start tls by calling C<starttls> with the given arguments. |
|
|
1795 | |
|
|
1796 | In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has |
|
|
1797 | been configured to accept, as servers do not normally send a handshake on |
|
|
1798 | their own and ths cannot be detected in this way. |
|
|
1799 | |
|
|
1800 | See C<tls_detect> above for more details. |
|
|
1801 | |
|
|
1802 | Example: give the client a chance to start TLS before accepting a text |
|
|
1803 | line. |
|
|
1804 | |
|
|
1805 | $hdl->push_read (tls_detect => "accept"); |
|
|
1806 | $hdl->push_read (line => sub { |
|
|
1807 | print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n"; |
|
|
1808 | }); |
|
|
1809 | |
|
|
1810 | =cut |
|
|
1811 | |
|
|
1812 | register_read_type tls_detect => sub { |
|
|
1813 | my ($self, $cb) = @_; |
|
|
1814 | |
|
|
1815 | sub { |
|
|
1816 | # this regex matches a full or partial tls record |
|
|
1817 | if ( |
|
|
1818 | # ssl3+: type(22=handshake) major(=3) minor(any) length_hi |
|
|
1819 | $self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs |
|
|
1820 | # ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength) |
|
|
1821 | or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs |
|
|
1822 | ) { |
|
|
1823 | return if 3 != length $1; # partial match, can't decide yet |
|
|
1824 | |
|
|
1825 | # full match, valid TLS record |
|
|
1826 | my ($major, $minor) = unpack "CC", $1; |
|
|
1827 | $cb->($self, "accept", $major + $minor * 0.1); |
|
|
1828 | } else { |
|
|
1829 | # mismatch == guaranteed not TLS |
|
|
1830 | $cb->($self, undef); |
|
|
1831 | } |
|
|
1832 | |
|
|
1833 | 1 |
|
|
1834 | } |
|
|
1835 | }; |
|
|
1836 | |
|
|
1837 | register_read_type tls_autostart => sub { |
|
|
1838 | my ($self, @tls) = @_; |
|
|
1839 | |
|
|
1840 | $RH{tls_detect}($self, sub { |
|
|
1841 | return unless $_[1]; |
|
|
1842 | $_[0]->starttls (@tls); |
|
|
1843 | }) |
|
|
1844 | }; |
|
|
1845 | |
1616 | =back |
1846 | =back |
1617 | |
1847 | |
1618 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1848 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
1619 | |
1849 | |
1620 | This function (not method) lets you add your own types to C<push_read>. |
1850 | Instead of one of the predefined types, you can also specify the name |
|
|
1851 | of a package. AnyEvent will try to load the package and then expects to |
|
|
1852 | find a function named C<anyevent_read_type> inside. If it isn't found, it |
|
|
1853 | progressively tries to load the parent package until it either finds the |
|
|
1854 | function (good) or runs out of packages (bad). |
1621 | |
1855 | |
1622 | Whenever the given C<type> is used, C<push_read> will invoke the code |
1856 | Whenever this type is used, C<push_read> will invoke the function with the |
1623 | reference with the handle object, the callback and the remaining |
1857 | handle object, the original callback and the remaining arguments. |
1624 | arguments. |
|
|
1625 | |
1858 | |
1626 | The code reference is supposed to return a callback (usually a closure) |
1859 | The function is supposed to return a callback (usually a closure) that |
1627 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
1860 | works as a plain read callback (see C<< ->push_read ($cb) >>), so you can |
|
|
1861 | mentally treat the function as a "configurable read type to read callback" |
|
|
1862 | converter. |
1628 | |
1863 | |
1629 | It should invoke the passed callback when it is done reading (remember to |
1864 | It should invoke the original callback when it is done reading (remember |
1630 | pass C<$handle> as first argument as all other callbacks do that). |
1865 | to pass C<$handle> as first argument as all other callbacks do that, |
|
|
1866 | although there is no strict requirement on this). |
1631 | |
1867 | |
1632 | Note that this is a function, and all types registered this way will be |
|
|
1633 | global, so try to use unique names. |
|
|
1634 | |
|
|
1635 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
1868 | For examples, see the source of this module (F<perldoc -m |
1636 | search for C<register_read_type>)). |
1869 | AnyEvent::Handle>, search for C<register_read_type>)). |
1637 | |
1870 | |
1638 | =item $handle->stop_read |
1871 | =item $handle->stop_read |
1639 | |
1872 | |
1640 | =item $handle->start_read |
1873 | =item $handle->start_read |
1641 | |
1874 | |
… | |
… | |
1647 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1880 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1648 | you change the C<on_read> callback or push/unshift a read callback, and it |
1881 | you change the C<on_read> callback or push/unshift a read callback, and it |
1649 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1882 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1650 | there are any read requests in the queue. |
1883 | there are any read requests in the queue. |
1651 | |
1884 | |
1652 | These methods will have no effect when in TLS mode (as TLS doesn't support |
1885 | In older versions of this module (<= 5.3), these methods had no effect, |
1653 | half-duplex connections). |
1886 | as TLS does not support half-duplex connections. In current versions they |
|
|
1887 | work as expected, as this behaviour is required to avoid certain resource |
|
|
1888 | attacks, where the program would be forced to read (and buffer) arbitrary |
|
|
1889 | amounts of data before being able to send some data. The drawback is that |
|
|
1890 | some readings of the the SSL/TLS specifications basically require this |
|
|
1891 | attack to be working, as SSL/TLS implementations might stall sending data |
|
|
1892 | during a rehandshake. |
|
|
1893 | |
|
|
1894 | As a guideline, during the initial handshake, you should not stop reading, |
|
|
1895 | and as a client, it might cause problems, depending on your application. |
1654 | |
1896 | |
1655 | =cut |
1897 | =cut |
1656 | |
1898 | |
1657 | sub stop_read { |
1899 | sub stop_read { |
1658 | my ($self) = @_; |
1900 | my ($self) = @_; |
1659 | |
1901 | |
1660 | delete $self->{_rw} unless $self->{tls}; |
1902 | delete $self->{_rw}; |
1661 | } |
1903 | } |
1662 | |
1904 | |
1663 | sub start_read { |
1905 | sub start_read { |
1664 | my ($self) = @_; |
1906 | my ($self) = @_; |
1665 | |
1907 | |
1666 | unless ($self->{_rw} || $self->{_eof}) { |
1908 | unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) { |
1667 | Scalar::Util::weaken $self; |
1909 | Scalar::Util::weaken $self; |
1668 | |
1910 | |
1669 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1911 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1670 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1912 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1671 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1913 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf; |
1672 | |
1914 | |
1673 | if ($len > 0) { |
1915 | if ($len > 0) { |
1674 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1916 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1675 | |
1917 | |
1676 | if ($self->{tls}) { |
1918 | if ($self->{tls}) { |
… | |
… | |
1679 | &_dotls ($self); |
1921 | &_dotls ($self); |
1680 | } else { |
1922 | } else { |
1681 | $self->_drain_rbuf; |
1923 | $self->_drain_rbuf; |
1682 | } |
1924 | } |
1683 | |
1925 | |
|
|
1926 | if ($len == $self->{read_size}) { |
|
|
1927 | $self->{read_size} *= 2; |
|
|
1928 | $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE |
|
|
1929 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
|
|
1930 | } |
|
|
1931 | |
1684 | } elsif (defined $len) { |
1932 | } elsif (defined $len) { |
1685 | delete $self->{_rw}; |
1933 | delete $self->{_rw}; |
1686 | $self->{_eof} = 1; |
1934 | $self->{_eof} = 1; |
1687 | $self->_drain_rbuf; |
1935 | $self->_drain_rbuf; |
1688 | |
1936 | |
… | |
… | |
1700 | my ($self, $err) = @_; |
1948 | my ($self, $err) = @_; |
1701 | |
1949 | |
1702 | return $self->_error ($!, 1) |
1950 | return $self->_error ($!, 1) |
1703 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
1951 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
1704 | |
1952 | |
1705 | my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
1953 | my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
1706 | |
1954 | |
1707 | # reduce error string to look less scary |
1955 | # reduce error string to look less scary |
1708 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
1956 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
1709 | |
1957 | |
1710 | if ($self->{_on_starttls}) { |
1958 | if ($self->{_on_starttls}) { |
… | |
… | |
1764 | && ($tmp != $ERROR_SYSCALL || $!); |
2012 | && ($tmp != $ERROR_SYSCALL || $!); |
1765 | |
2013 | |
1766 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
2014 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1767 | $self->{wbuf} .= $tmp; |
2015 | $self->{wbuf} .= $tmp; |
1768 | $self->_drain_wbuf; |
2016 | $self->_drain_wbuf; |
|
|
2017 | $self->{tls} or return; # tls session might have gone away in callback |
1769 | } |
2018 | } |
1770 | |
2019 | |
1771 | $self->{_on_starttls} |
2020 | $self->{_on_starttls} |
1772 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
2021 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1773 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
2022 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
… | |
… | |
1775 | |
2024 | |
1776 | =item $handle->starttls ($tls[, $tls_ctx]) |
2025 | =item $handle->starttls ($tls[, $tls_ctx]) |
1777 | |
2026 | |
1778 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
2027 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1779 | object is created, you can also do that at a later time by calling |
2028 | object is created, you can also do that at a later time by calling |
1780 | C<starttls>. |
2029 | C<starttls>. See the C<tls> constructor argument for general info. |
1781 | |
2030 | |
1782 | Starting TLS is currently an asynchronous operation - when you push some |
2031 | Starting TLS is currently an asynchronous operation - when you push some |
1783 | write data and then call C<< ->starttls >> then TLS negotiation will start |
2032 | write data and then call C<< ->starttls >> then TLS negotiation will start |
1784 | immediately, after which the queued write data is then sent. |
2033 | immediately, after which the queued write data is then sent. This might |
|
|
2034 | change in future versions, so best make sure you have no outstanding write |
|
|
2035 | data when calling this method. |
1785 | |
2036 | |
1786 | The first argument is the same as the C<tls> constructor argument (either |
2037 | The first argument is the same as the C<tls> constructor argument (either |
1787 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
2038 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1788 | |
2039 | |
1789 | The second argument is the optional C<AnyEvent::TLS> object that is used |
2040 | The second argument is the optional C<AnyEvent::TLS> object that is used |
… | |
… | |
1795 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
2046 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1796 | changed to your liking. Note that the handshake might have already started |
2047 | changed to your liking. Note that the handshake might have already started |
1797 | when this function returns. |
2048 | when this function returns. |
1798 | |
2049 | |
1799 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
2050 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1800 | handshakes on the same stream. Best do not attempt to use the stream after |
2051 | handshakes on the same stream. It is best to not attempt to use the |
1801 | stopping TLS. |
2052 | stream after stopping TLS. |
|
|
2053 | |
|
|
2054 | This method may invoke callbacks (and therefore the handle might be |
|
|
2055 | destroyed after it returns). |
1802 | |
2056 | |
1803 | =cut |
2057 | =cut |
1804 | |
2058 | |
1805 | our %TLS_CACHE; #TODO not yet documented, should we? |
2059 | our %TLS_CACHE; #TODO not yet documented, should we? |
1806 | |
2060 | |
… | |
… | |
1808 | my ($self, $tls, $ctx) = @_; |
2062 | my ($self, $tls, $ctx) = @_; |
1809 | |
2063 | |
1810 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
2064 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
1811 | if $self->{tls}; |
2065 | if $self->{tls}; |
1812 | |
2066 | |
|
|
2067 | unless (defined $AnyEvent::TLS::VERSION) { |
|
|
2068 | eval { |
|
|
2069 | require Net::SSLeay; |
|
|
2070 | require AnyEvent::TLS; |
|
|
2071 | 1 |
|
|
2072 | } or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system"); |
|
|
2073 | } |
|
|
2074 | |
1813 | $self->{tls} = $tls; |
2075 | $self->{tls} = $tls; |
1814 | $self->{tls_ctx} = $ctx if @_ > 2; |
2076 | $self->{tls_ctx} = $ctx if @_ > 2; |
1815 | |
2077 | |
1816 | return unless $self->{fh}; |
2078 | return unless $self->{fh}; |
1817 | |
2079 | |
1818 | require Net::SSLeay; |
|
|
1819 | |
|
|
1820 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
2080 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1821 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
2081 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1822 | |
2082 | |
1823 | $tls = delete $self->{tls}; |
2083 | $tls = delete $self->{tls}; |
1824 | $ctx = $self->{tls_ctx}; |
2084 | $ctx = $self->{tls_ctx}; |
1825 | |
2085 | |
1826 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
2086 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1827 | |
2087 | |
1828 | if ("HASH" eq ref $ctx) { |
2088 | if ("HASH" eq ref $ctx) { |
1829 | require AnyEvent::TLS; |
|
|
1830 | |
|
|
1831 | if ($ctx->{cache}) { |
2089 | if ($ctx->{cache}) { |
1832 | my $key = $ctx+0; |
2090 | my $key = $ctx+0; |
1833 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
2091 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
1834 | } else { |
2092 | } else { |
1835 | $ctx = new AnyEvent::TLS %$ctx; |
2093 | $ctx = new AnyEvent::TLS %$ctx; |
… | |
… | |
1857 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
2115 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
1858 | |
2116 | |
1859 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2117 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1860 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2118 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1861 | |
2119 | |
1862 | Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); |
2120 | Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf}); |
|
|
2121 | $self->{rbuf} = ""; |
1863 | |
2122 | |
1864 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
2123 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
1865 | |
2124 | |
1866 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
2125 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
1867 | if $self->{on_starttls}; |
2126 | if $self->{on_starttls}; |
… | |
… | |
1872 | |
2131 | |
1873 | =item $handle->stoptls |
2132 | =item $handle->stoptls |
1874 | |
2133 | |
1875 | Shuts down the SSL connection - this makes a proper EOF handshake by |
2134 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1876 | sending a close notify to the other side, but since OpenSSL doesn't |
2135 | sending a close notify to the other side, but since OpenSSL doesn't |
1877 | support non-blocking shut downs, it is not guarenteed that you can re-use |
2136 | support non-blocking shut downs, it is not guaranteed that you can re-use |
1878 | the stream afterwards. |
2137 | the stream afterwards. |
|
|
2138 | |
|
|
2139 | This method may invoke callbacks (and therefore the handle might be |
|
|
2140 | destroyed after it returns). |
1879 | |
2141 | |
1880 | =cut |
2142 | =cut |
1881 | |
2143 | |
1882 | sub stoptls { |
2144 | sub stoptls { |
1883 | my ($self) = @_; |
2145 | my ($self) = @_; |
1884 | |
2146 | |
1885 | if ($self->{tls}) { |
2147 | if ($self->{tls} && $self->{fh}) { |
1886 | Net::SSLeay::shutdown ($self->{tls}); |
2148 | Net::SSLeay::shutdown ($self->{tls}); |
1887 | |
2149 | |
1888 | &_dotls; |
2150 | &_dotls; |
1889 | |
2151 | |
1890 | # # we don't give a shit. no, we do, but we can't. no...#d# |
2152 | # # we don't give a shit. no, we do, but we can't. no...#d# |
… | |
… | |
1902 | if $self->{tls} > 0; |
2164 | if $self->{tls} > 0; |
1903 | |
2165 | |
1904 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
2166 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
1905 | } |
2167 | } |
1906 | |
2168 | |
|
|
2169 | =item $handle->resettls |
|
|
2170 | |
|
|
2171 | This rarely-used method simply resets and TLS state on the handle, usually |
|
|
2172 | causing data loss. |
|
|
2173 | |
|
|
2174 | One case where it may be useful is when you want to skip over the data in |
|
|
2175 | the stream but you are not interested in interpreting it, so data loss is |
|
|
2176 | no concern. |
|
|
2177 | |
|
|
2178 | =cut |
|
|
2179 | |
|
|
2180 | *resettls = \&_freetls; |
|
|
2181 | |
1907 | sub DESTROY { |
2182 | sub DESTROY { |
1908 | my ($self) = @_; |
2183 | my ($self) = @_; |
1909 | |
2184 | |
1910 | &_freetls; |
2185 | &_freetls; |
1911 | |
2186 | |
… | |
… | |
1920 | push @linger, AE::io $fh, 1, sub { |
2195 | push @linger, AE::io $fh, 1, sub { |
1921 | my $len = syswrite $fh, $wbuf, length $wbuf; |
2196 | my $len = syswrite $fh, $wbuf, length $wbuf; |
1922 | |
2197 | |
1923 | if ($len > 0) { |
2198 | if ($len > 0) { |
1924 | substr $wbuf, 0, $len, ""; |
2199 | substr $wbuf, 0, $len, ""; |
1925 | } else { |
2200 | } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) { |
1926 | @linger = (); # end |
2201 | @linger = (); # end |
1927 | } |
2202 | } |
1928 | }; |
2203 | }; |
1929 | push @linger, AE::timer $linger, 0, sub { |
2204 | push @linger, AE::timer $linger, 0, sub { |
1930 | @linger = (); |
2205 | @linger = (); |
… | |
… | |
1967 | |
2242 | |
1968 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
2243 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
1969 | #nop |
2244 | #nop |
1970 | } |
2245 | } |
1971 | |
2246 | |
|
|
2247 | =item $handle->destroyed |
|
|
2248 | |
|
|
2249 | Returns false as long as the handle hasn't been destroyed by a call to C<< |
|
|
2250 | ->destroy >>, true otherwise. |
|
|
2251 | |
|
|
2252 | Can be useful to decide whether the handle is still valid after some |
|
|
2253 | callback possibly destroyed the handle. For example, C<< ->push_write >>, |
|
|
2254 | C<< ->starttls >> and other methods can call user callbacks, which in turn |
|
|
2255 | can destroy the handle, so work can be avoided by checking sometimes: |
|
|
2256 | |
|
|
2257 | $hdl->starttls ("accept"); |
|
|
2258 | return if $hdl->destroyed; |
|
|
2259 | $hdl->push_write (... |
|
|
2260 | |
|
|
2261 | Note that the call to C<push_write> will silently be ignored if the handle |
|
|
2262 | has been destroyed, so often you can just ignore the possibility of the |
|
|
2263 | handle being destroyed. |
|
|
2264 | |
|
|
2265 | =cut |
|
|
2266 | |
|
|
2267 | sub destroyed { 0 } |
|
|
2268 | sub AnyEvent::Handle::destroyed::destroyed { 1 } |
|
|
2269 | |
1972 | =item AnyEvent::Handle::TLS_CTX |
2270 | =item AnyEvent::Handle::TLS_CTX |
1973 | |
2271 | |
1974 | This function creates and returns the AnyEvent::TLS object used by default |
2272 | This function creates and returns the AnyEvent::TLS object used by default |
1975 | for TLS mode. |
2273 | for TLS mode. |
1976 | |
2274 | |
… | |
… | |
2003 | |
2301 | |
2004 | It is only safe to "forget" the reference inside EOF or error callbacks, |
2302 | It is only safe to "forget" the reference inside EOF or error callbacks, |
2005 | from within all other callbacks, you need to explicitly call the C<< |
2303 | from within all other callbacks, you need to explicitly call the C<< |
2006 | ->destroy >> method. |
2304 | ->destroy >> method. |
2007 | |
2305 | |
|
|
2306 | =item Why is my C<on_eof> callback never called? |
|
|
2307 | |
|
|
2308 | Probably because your C<on_error> callback is being called instead: When |
|
|
2309 | you have outstanding requests in your read queue, then an EOF is |
|
|
2310 | considered an error as you clearly expected some data. |
|
|
2311 | |
|
|
2312 | To avoid this, make sure you have an empty read queue whenever your handle |
|
|
2313 | is supposed to be "idle" (i.e. connection closes are O.K.). You can set |
|
|
2314 | an C<on_read> handler that simply pushes the first read requests in the |
|
|
2315 | queue. |
|
|
2316 | |
|
|
2317 | See also the next question, which explains this in a bit more detail. |
|
|
2318 | |
|
|
2319 | =item How can I serve requests in a loop? |
|
|
2320 | |
|
|
2321 | Most protocols consist of some setup phase (authentication for example) |
|
|
2322 | followed by a request handling phase, where the server waits for requests |
|
|
2323 | and handles them, in a loop. |
|
|
2324 | |
|
|
2325 | There are two important variants: The first (traditional, better) variant |
|
|
2326 | handles requests until the server gets some QUIT command, causing it to |
|
|
2327 | close the connection first (highly desirable for a busy TCP server). A |
|
|
2328 | client dropping the connection is an error, which means this variant can |
|
|
2329 | detect an unexpected detection close. |
|
|
2330 | |
|
|
2331 | To handle this case, always make sure you have a non-empty read queue, by |
|
|
2332 | pushing the "read request start" handler on it: |
|
|
2333 | |
|
|
2334 | # we assume a request starts with a single line |
|
|
2335 | my @start_request; @start_request = (line => sub { |
|
|
2336 | my ($hdl, $line) = @_; |
|
|
2337 | |
|
|
2338 | ... handle request |
|
|
2339 | |
|
|
2340 | # push next request read, possibly from a nested callback |
|
|
2341 | $hdl->push_read (@start_request); |
|
|
2342 | }); |
|
|
2343 | |
|
|
2344 | # auth done, now go into request handling loop |
|
|
2345 | # now push the first @start_request |
|
|
2346 | $hdl->push_read (@start_request); |
|
|
2347 | |
|
|
2348 | By always having an outstanding C<push_read>, the handle always expects |
|
|
2349 | some data and raises the C<EPIPE> error when the connction is dropped |
|
|
2350 | unexpectedly. |
|
|
2351 | |
|
|
2352 | The second variant is a protocol where the client can drop the connection |
|
|
2353 | at any time. For TCP, this means that the server machine may run out of |
|
|
2354 | sockets easier, and in general, it means you cannot distinguish a protocl |
|
|
2355 | failure/client crash from a normal connection close. Nevertheless, these |
|
|
2356 | kinds of protocols are common (and sometimes even the best solution to the |
|
|
2357 | problem). |
|
|
2358 | |
|
|
2359 | Having an outstanding read request at all times is possible if you ignore |
|
|
2360 | C<EPIPE> errors, but this doesn't help with when the client drops the |
|
|
2361 | connection during a request, which would still be an error. |
|
|
2362 | |
|
|
2363 | A better solution is to push the initial request read in an C<on_read> |
|
|
2364 | callback. This avoids an error, as when the server doesn't expect data |
|
|
2365 | (i.e. is idly waiting for the next request, an EOF will not raise an |
|
|
2366 | error, but simply result in an C<on_eof> callback. It is also a bit slower |
|
|
2367 | and simpler: |
|
|
2368 | |
|
|
2369 | # auth done, now go into request handling loop |
|
|
2370 | $hdl->on_read (sub { |
|
|
2371 | my ($hdl) = @_; |
|
|
2372 | |
|
|
2373 | # called each time we receive data but the read queue is empty |
|
|
2374 | # simply start read the request |
|
|
2375 | |
|
|
2376 | $hdl->push_read (line => sub { |
|
|
2377 | my ($hdl, $line) = @_; |
|
|
2378 | |
|
|
2379 | ... handle request |
|
|
2380 | |
|
|
2381 | # do nothing special when the request has been handled, just |
|
|
2382 | # let the request queue go empty. |
|
|
2383 | }); |
|
|
2384 | }); |
|
|
2385 | |
2008 | =item I get different callback invocations in TLS mode/Why can't I pause |
2386 | =item I get different callback invocations in TLS mode/Why can't I pause |
2009 | reading? |
2387 | reading? |
2010 | |
2388 | |
2011 | Unlike, say, TCP, TLS connections do not consist of two independent |
2389 | Unlike, say, TCP, TLS connections do not consist of two independent |
2012 | communication channels, one for each direction. Or put differently. The |
2390 | communication channels, one for each direction. Or put differently, the |
2013 | read and write directions are not independent of each other: you cannot |
2391 | read and write directions are not independent of each other: you cannot |
2014 | write data unless you are also prepared to read, and vice versa. |
2392 | write data unless you are also prepared to read, and vice versa. |
2015 | |
2393 | |
2016 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
2394 | This means that, in TLS mode, you might get C<on_error> or C<on_eof> |
2017 | callback invocations when you are not expecting any read data - the reason |
2395 | callback invocations when you are not expecting any read data - the reason |
2018 | is that AnyEvent::Handle always reads in TLS mode. |
2396 | is that AnyEvent::Handle always reads in TLS mode. |
2019 | |
2397 | |
2020 | During the connection, you have to make sure that you always have a |
2398 | During the connection, you have to make sure that you always have a |
2021 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
2399 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
… | |
… | |
2033 | $handle->on_eof (undef); |
2411 | $handle->on_eof (undef); |
2034 | $handle->on_error (sub { |
2412 | $handle->on_error (sub { |
2035 | my $data = delete $_[0]{rbuf}; |
2413 | my $data = delete $_[0]{rbuf}; |
2036 | }); |
2414 | }); |
2037 | |
2415 | |
|
|
2416 | Note that this example removes the C<rbuf> member from the handle object, |
|
|
2417 | which is not normally allowed by the API. It is expressly permitted in |
|
|
2418 | this case only, as the handle object needs to be destroyed afterwards. |
|
|
2419 | |
2038 | The reason to use C<on_error> is that TCP connections, due to latencies |
2420 | The reason to use C<on_error> is that TCP connections, due to latencies |
2039 | and packets loss, might get closed quite violently with an error, when in |
2421 | and packets loss, might get closed quite violently with an error, when in |
2040 | fact, all data has been received. |
2422 | fact all data has been received. |
2041 | |
2423 | |
2042 | It is usually better to use acknowledgements when transferring data, |
2424 | It is usually better to use acknowledgements when transferring data, |
2043 | to make sure the other side hasn't just died and you got the data |
2425 | to make sure the other side hasn't just died and you got the data |
2044 | intact. This is also one reason why so many internet protocols have an |
2426 | intact. This is also one reason why so many internet protocols have an |
2045 | explicit QUIT command. |
2427 | explicit QUIT command. |
… | |
… | |
2052 | C<low_water_mark> this will be called precisely when all data has been |
2434 | C<low_water_mark> this will be called precisely when all data has been |
2053 | written to the socket: |
2435 | written to the socket: |
2054 | |
2436 | |
2055 | $handle->push_write (...); |
2437 | $handle->push_write (...); |
2056 | $handle->on_drain (sub { |
2438 | $handle->on_drain (sub { |
2057 | warn "all data submitted to the kernel\n"; |
2439 | AE::log debug => "All data submitted to the kernel."; |
2058 | undef $handle; |
2440 | undef $handle; |
2059 | }); |
2441 | }); |
2060 | |
2442 | |
2061 | If you just want to queue some data and then signal EOF to the other side, |
2443 | If you just want to queue some data and then signal EOF to the other side, |
2062 | consider using C<< ->push_shutdown >> instead. |
2444 | consider using C<< ->push_shutdown >> instead. |
2063 | |
2445 | |
2064 | =item I want to contact a TLS/SSL server, I don't care about security. |
2446 | =item I want to contact a TLS/SSL server, I don't care about security. |
2065 | |
2447 | |
2066 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2448 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2067 | simply connect to it and then create the AnyEvent::Handle with the C<tls> |
2449 | connect to it and then create the AnyEvent::Handle with the C<tls> |
2068 | parameter: |
2450 | parameter: |
2069 | |
2451 | |
2070 | tcp_connect $host, $port, sub { |
2452 | tcp_connect $host, $port, sub { |
2071 | my ($fh) = @_; |
2453 | my ($fh) = @_; |
2072 | |
2454 | |
… | |
… | |
2146 | When you have intermediate CA certificates that your clients might not |
2528 | When you have intermediate CA certificates that your clients might not |
2147 | know about, just append them to the C<cert_file>. |
2529 | know about, just append them to the C<cert_file>. |
2148 | |
2530 | |
2149 | =back |
2531 | =back |
2150 | |
2532 | |
2151 | |
|
|
2152 | =head1 SUBCLASSING AnyEvent::Handle |
2533 | =head1 SUBCLASSING AnyEvent::Handle |
2153 | |
2534 | |
2154 | In many cases, you might want to subclass AnyEvent::Handle. |
2535 | In many cases, you might want to subclass AnyEvent::Handle. |
2155 | |
2536 | |
2156 | To make this easier, a given version of AnyEvent::Handle uses these |
2537 | To make this easier, a given version of AnyEvent::Handle uses these |
… | |
… | |
2172 | |
2553 | |
2173 | =item * all members not documented here and not prefixed with an underscore |
2554 | =item * all members not documented here and not prefixed with an underscore |
2174 | are free to use in subclasses. |
2555 | are free to use in subclasses. |
2175 | |
2556 | |
2176 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2557 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2177 | member variables, but thats just life, at least it is documented. |
2558 | member variables, but that's just life. At least it is documented. |
2178 | |
2559 | |
2179 | =back |
2560 | =back |
2180 | |
2561 | |
2181 | =head1 AUTHOR |
2562 | =head1 AUTHOR |
2182 | |
2563 | |
2183 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2564 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2184 | |
2565 | |
2185 | =cut |
2566 | =cut |
2186 | |
2567 | |
2187 | 1; # End of AnyEvent::Handle |
2568 | 1 |
|
|
2569 | |