1 | package AnyEvent::Handle; |
|
|
2 | |
|
|
3 | use Scalar::Util (); |
|
|
4 | use Carp (); |
|
|
5 | use Errno qw(EAGAIN EINTR); |
|
|
6 | |
|
|
7 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
|
|
8 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
|
|
9 | |
|
|
10 | =head1 NAME |
1 | =head1 NAME |
11 | |
2 | |
12 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
3 | AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent |
13 | |
|
|
14 | =cut |
|
|
15 | |
|
|
16 | our $VERSION = 4.9; |
|
|
17 | |
4 | |
18 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
19 | |
6 | |
20 | use AnyEvent; |
7 | use AnyEvent; |
21 | use AnyEvent::Handle; |
8 | use AnyEvent::Handle; |
… | |
… | |
27 | on_error => sub { |
14 | on_error => sub { |
28 | my ($hdl, $fatal, $msg) = @_; |
15 | my ($hdl, $fatal, $msg) = @_; |
29 | warn "got error $msg\n"; |
16 | warn "got error $msg\n"; |
30 | $hdl->destroy; |
17 | $hdl->destroy; |
31 | $cv->send; |
18 | $cv->send; |
32 | ); |
19 | }; |
33 | |
20 | |
34 | # send some request line |
21 | # send some request line |
35 | $hdl->push_write ("getinfo\015\012"); |
22 | $hdl->push_write ("getinfo\015\012"); |
36 | |
23 | |
37 | # read the response line |
24 | # read the response line |
… | |
… | |
43 | |
30 | |
44 | $cv->recv; |
31 | $cv->recv; |
45 | |
32 | |
46 | =head1 DESCRIPTION |
33 | =head1 DESCRIPTION |
47 | |
34 | |
48 | 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 |
49 | filehandles. |
36 | stream-based filehandles (sockets, pipes, and other stream things). |
50 | |
37 | |
51 | The L<AnyEvent::Intro> tutorial contains some well-documented |
38 | The L<AnyEvent::Intro> tutorial contains some well-documented |
52 | AnyEvent::Handle examples. |
39 | AnyEvent::Handle examples. |
53 | |
40 | |
54 | In the following, when the documentation refers to of "bytes" then this |
41 | In the following, where the documentation refers to "bytes", it means |
55 | 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 |
56 | treatment of characters applies to this module as well. |
43 | treatment of characters applies to this module as well. |
57 | |
44 | |
58 | 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 |
59 | C<on_error> callback. |
46 | C<on_error> callback. |
60 | |
47 | |
61 | All callbacks will be invoked with the handle object as their first |
48 | All callbacks will be invoked with the handle object as their first |
62 | argument. |
49 | argument. |
63 | |
50 | |
|
|
51 | =cut |
|
|
52 | |
|
|
53 | package AnyEvent::Handle; |
|
|
54 | |
|
|
55 | use Scalar::Util (); |
|
|
56 | use List::Util (); |
|
|
57 | use Carp (); |
|
|
58 | use Errno qw(EAGAIN EINTR); |
|
|
59 | |
|
|
60 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
|
|
61 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
|
|
62 | |
|
|
63 | our $VERSION = $AnyEvent::VERSION; |
|
|
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 | |
64 | =head1 METHODS |
82 | =head1 METHODS |
65 | |
83 | |
66 | =over 4 |
84 | =over 4 |
67 | |
85 | |
68 | =item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... |
86 | =item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value... |
69 | |
87 | |
70 | The constructor supports these arguments (all as C<< key => value >> pairs). |
88 | The constructor supports these arguments (all as C<< key => value >> pairs). |
71 | |
89 | |
72 | =over 4 |
90 | =over 4 |
73 | |
91 | |
… | |
… | |
96 | =over 4 |
114 | =over 4 |
97 | |
115 | |
98 | =item on_prepare => $cb->($handle) |
116 | =item on_prepare => $cb->($handle) |
99 | |
117 | |
100 | This (rarely used) callback is called before a new connection is |
118 | This (rarely used) callback is called before a new connection is |
101 | 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 |
102 | prepare the file handle with parameters required for the actual connect |
121 | file handle with parameters required for the actual connect (as opposed to |
103 | (as opposed to settings that can be changed when the connection is already |
122 | settings that can be changed when the connection is already established). |
104 | established). |
|
|
105 | |
123 | |
106 | 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 |
107 | 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 |
108 | timeout is to be used). |
126 | default timeout is to be used). |
109 | |
127 | |
110 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
128 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
111 | |
129 | |
112 | This callback is called when a connection has been successfully established. |
130 | This callback is called when a connection has been successfully established. |
113 | |
131 | |
114 | 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 |
115 | parameters, together with a retry callback. |
133 | parameters, together with a retry callback. |
116 | |
134 | |
117 | When, for some reason, the handle is not acceptable, then calling |
135 | If, for some reason, the handle is not acceptable, calling C<$retry> |
118 | C<$retry> will continue with the next conenction target (in case of |
136 | will continue with the next connection target (in case of multi-homed |
119 | multi-homed hosts or SRV records there can be multiple connection |
137 | hosts or SRV records there can be multiple connection endpoints). At the |
120 | endpoints). When it is called then the read and write queues, eof status, |
138 | time it is called the read and write queues, eof status, tls status and |
121 | tls status and similar properties of the handle are being reset. |
139 | similar properties of the handle will have been reset. |
122 | |
140 | |
123 | In most cases, ignoring the C<$retry> parameter is the way to go. |
141 | In most cases, you should ignore the C<$retry> parameter. |
124 | |
142 | |
125 | =item on_connect_error => $cb->($handle, $message) |
143 | =item on_connect_error => $cb->($handle, $message) |
126 | |
144 | |
127 | This callback is called when the conenction could not be |
145 | This callback is called when the connection could not be |
128 | established. C<$!> will contain the relevant error code, and C<$message> a |
146 | established. C<$!> will contain the relevant error code, and C<$message> a |
129 | message describing it (usually the same as C<"$!">). |
147 | message describing it (usually the same as C<"$!">). |
130 | |
148 | |
131 | If this callback isn't specified, then C<on_error> will be called with a |
149 | If this callback isn't specified, then C<on_error> will be called with a |
132 | fatal error instead. |
150 | fatal error instead. |
… | |
… | |
135 | |
153 | |
136 | =item on_error => $cb->($handle, $fatal, $message) |
154 | =item on_error => $cb->($handle, $fatal, $message) |
137 | |
155 | |
138 | This is the error callback, which is called when, well, some error |
156 | This is the error callback, which is called when, well, some error |
139 | occured, such as not being able to resolve the hostname, failure to |
157 | occured, such as not being able to resolve the hostname, failure to |
140 | connect or a read error. |
158 | connect, or a read error. |
141 | |
159 | |
142 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
160 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
143 | fatal errors the handle object will be destroyed (by a call to C<< -> |
161 | fatal errors the handle object will be destroyed (by a call to C<< -> |
144 | destroy >>) after invoking the error callback (which means you are free to |
162 | destroy >>) after invoking the error callback (which means you are free to |
145 | examine the handle object). Examples of fatal errors are an EOF condition |
163 | examine the handle object). Examples of fatal errors are an EOF condition |
146 | with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In |
164 | with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In |
147 | cases where the other side can close the connection at their will it is |
165 | cases where the other side can close the connection at will, it is |
148 | often easiest to not report C<EPIPE> errors in this callback. |
166 | often easiest to not report C<EPIPE> errors in this callback. |
149 | |
167 | |
150 | AnyEvent::Handle tries to find an appropriate error code for you to check |
168 | AnyEvent::Handle tries to find an appropriate error code for you to check |
151 | against, but in some cases (TLS errors), this does not work well. It is |
169 | against, but in some cases (TLS errors), this does not work well. It is |
152 | recommended to always output the C<$message> argument in human-readable |
170 | recommended to always output the C<$message> argument in human-readable |
153 | error messages (it's usually the same as C<"$!">). |
171 | error messages (it's usually the same as C<"$!">). |
154 | |
172 | |
155 | Non-fatal errors can be retried by simply returning, but it is recommended |
173 | Non-fatal errors can be retried by returning, but it is recommended |
156 | to simply ignore this parameter and instead abondon the handle object |
174 | to simply ignore this parameter and instead abondon the handle object |
157 | when this callback is invoked. Examples of non-fatal errors are timeouts |
175 | when this callback is invoked. Examples of non-fatal errors are timeouts |
158 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
176 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
159 | |
177 | |
160 | On callback entrance, the value of C<$!> contains the operating system |
178 | On entry to the callback, the value of C<$!> contains the operating |
161 | error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
179 | system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
162 | C<EPROTO>). |
180 | C<EPROTO>). |
163 | |
181 | |
164 | While not mandatory, it is I<highly> recommended to set this callback, as |
182 | While not mandatory, it is I<highly> recommended to set this callback, as |
165 | you will not be notified of errors otherwise. The default simply calls |
183 | you will not be notified of errors otherwise. The default just calls |
166 | C<croak>. |
184 | C<croak>. |
167 | |
185 | |
168 | =item on_read => $cb->($handle) |
186 | =item on_read => $cb->($handle) |
169 | |
187 | |
170 | This sets the default read callback, which is called when data arrives |
188 | This sets the default read callback, which is called when data arrives |
… | |
… | |
175 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
193 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
176 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
194 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
177 | must not enlarge or modify the read buffer, you can only remove data at |
195 | must not enlarge or modify the read buffer, you can only remove data at |
178 | the beginning from it. |
196 | the beginning from it. |
179 | |
197 | |
|
|
198 | You can also call C<< ->push_read (...) >> or any other function that |
|
|
199 | modifies the read queue. Or do both. Or ... |
|
|
200 | |
180 | When an EOF condition is detected then AnyEvent::Handle will first try to |
201 | When an EOF condition is detected, AnyEvent::Handle will first try to |
181 | feed all the remaining data to the queued callbacks and C<on_read> before |
202 | feed all the remaining data to the queued callbacks and C<on_read> before |
182 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
203 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
183 | error will be raised (with C<$!> set to C<EPIPE>). |
204 | error will be raised (with C<$!> set to C<EPIPE>). |
184 | |
205 | |
185 | Note that, unlike requests in the read queue, an C<on_read> callback |
206 | Note that, unlike requests in the read queue, an C<on_read> callback |
… | |
… | |
204 | set, then a fatal error will be raised with C<$!> set to <0>. |
225 | set, then a fatal error will be raised with C<$!> set to <0>. |
205 | |
226 | |
206 | =item on_drain => $cb->($handle) |
227 | =item on_drain => $cb->($handle) |
207 | |
228 | |
208 | This sets the callback that is called when the write buffer becomes empty |
229 | This sets the callback that is called when the write buffer becomes empty |
209 | (or when the callback is set and the buffer is empty already). |
230 | (or immediately if the buffer is empty already). |
210 | |
231 | |
211 | To append to the write buffer, use the C<< ->push_write >> method. |
232 | To append to the write buffer, use the C<< ->push_write >> method. |
212 | |
233 | |
213 | This callback is useful when you don't want to put all of your write data |
234 | This callback is useful when you don't want to put all of your write data |
214 | into the queue at once, for example, when you want to write the contents |
235 | into the queue at once, for example, when you want to write the contents |
… | |
… | |
216 | memory and push it into the queue, but instead only read more data from |
237 | memory and push it into the queue, but instead only read more data from |
217 | the file when the write queue becomes empty. |
238 | the file when the write queue becomes empty. |
218 | |
239 | |
219 | =item timeout => $fractional_seconds |
240 | =item timeout => $fractional_seconds |
220 | |
241 | |
|
|
242 | =item rtimeout => $fractional_seconds |
|
|
243 | |
|
|
244 | =item wtimeout => $fractional_seconds |
|
|
245 | |
221 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
246 | If non-zero, then these enables an "inactivity" timeout: whenever this |
222 | seconds pass without a successful read or write on the underlying file |
247 | many seconds pass without a successful read or write on the underlying |
223 | handle, the C<on_timeout> callback will be invoked (and if that one is |
248 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
224 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
249 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
|
|
250 | error will be raised). |
225 | |
251 | |
|
|
252 | There are three variants of the timeouts that work independently |
|
|
253 | of each other, for both read and write, just read, and just write: |
|
|
254 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
|
|
255 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
|
|
256 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
|
|
257 | |
226 | Note that timeout processing is also active when you currently do not have |
258 | Note that timeout processing is active even when you do not have |
227 | any outstanding read or write requests: If you plan to keep the connection |
259 | any outstanding read or write requests: If you plan to keep the connection |
228 | idle then you should disable the timout temporarily or ignore the timeout |
260 | idle then you should disable the timeout temporarily or ignore the timeout |
229 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
261 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
230 | restart the timeout. |
262 | restart the timeout. |
231 | |
263 | |
232 | Zero (the default) disables this timeout. |
264 | Zero (the default) disables this timeout. |
233 | |
265 | |
… | |
… | |
247 | be configured to accept only so-and-so much data that it cannot act on |
279 | be configured to accept only so-and-so much data that it cannot act on |
248 | (for example, when expecting a line, an attacker could send an unlimited |
280 | (for example, when expecting a line, an attacker could send an unlimited |
249 | amount of data without a callback ever being called as long as the line |
281 | amount of data without a callback ever being called as long as the line |
250 | isn't finished). |
282 | isn't finished). |
251 | |
283 | |
|
|
284 | =item wbuf_max => <bytes> |
|
|
285 | |
|
|
286 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
|
|
287 | when the write buffer ever (strictly) exceeds this size. This is useful to |
|
|
288 | avoid some forms of denial-of-service attacks. |
|
|
289 | |
|
|
290 | Although the units of this parameter is bytes, this is the I<raw> number |
|
|
291 | of bytes not yet accepted by the kernel. This can make a difference when |
|
|
292 | you e.g. use TLS, as TLS typically makes your write data larger (but it |
|
|
293 | can also make it smaller due to compression). |
|
|
294 | |
|
|
295 | As an example of when this limit is useful, take a chat server that sends |
|
|
296 | chat messages to a client. If the client does not read those in a timely |
|
|
297 | manner then the send buffer in the server would grow unbounded. |
|
|
298 | |
252 | =item autocork => <boolean> |
299 | =item autocork => <boolean> |
253 | |
300 | |
254 | When disabled (the default), then C<push_write> will try to immediately |
301 | When disabled (the default), C<push_write> will try to immediately |
255 | write the data to the handle, if possible. This avoids having to register |
302 | write the data to the handle if possible. This avoids having to register |
256 | a write watcher and wait for the next event loop iteration, but can |
303 | a write watcher and wait for the next event loop iteration, but can |
257 | be inefficient if you write multiple small chunks (on the wire, this |
304 | be inefficient if you write multiple small chunks (on the wire, this |
258 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
305 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
259 | C<no_delay>, but this option can save costly syscalls). |
306 | C<no_delay>, but this option can save costly syscalls). |
260 | |
307 | |
261 | When enabled, then writes will always be queued till the next event loop |
308 | When enabled, writes will always be queued till the next event loop |
262 | iteration. This is efficient when you do many small writes per iteration, |
309 | iteration. This is efficient when you do many small writes per iteration, |
263 | but less efficient when you do a single write only per iteration (or when |
310 | but less efficient when you do a single write only per iteration (or when |
264 | the write buffer often is full). It also increases write latency. |
311 | the write buffer often is full). It also increases write latency. |
265 | |
312 | |
266 | =item no_delay => <boolean> |
313 | =item no_delay => <boolean> |
… | |
… | |
270 | the Nagle algorithm, and usually it is beneficial. |
317 | the Nagle algorithm, and usually it is beneficial. |
271 | |
318 | |
272 | In some situations you want as low a delay as possible, which can be |
319 | In some situations you want as low a delay as possible, which can be |
273 | accomplishd by setting this option to a true value. |
320 | accomplishd by setting this option to a true value. |
274 | |
321 | |
275 | The default is your opertaing system's default behaviour (most likely |
322 | The default is your operating system's default behaviour (most likely |
276 | enabled), this option explicitly enables or disables it, if possible. |
323 | enabled). This option explicitly enables or disables it, if possible. |
|
|
324 | |
|
|
325 | =item keepalive => <boolean> |
|
|
326 | |
|
|
327 | Enables (default disable) the SO_KEEPALIVE option on the stream socket: |
|
|
328 | normally, TCP connections have no time-out once established, so TCP |
|
|
329 | connections, once established, can stay alive forever even when the other |
|
|
330 | side has long gone. TCP keepalives are a cheap way to take down long-lived |
|
|
331 | TCP connections when the other side becomes unreachable. While the default |
|
|
332 | is OS-dependent, TCP keepalives usually kick in after around two hours, |
|
|
333 | and, if the other side doesn't reply, take down the TCP connection some 10 |
|
|
334 | to 15 minutes later. |
|
|
335 | |
|
|
336 | It is harmless to specify this option for file handles that do not support |
|
|
337 | keepalives, and enabling it on connections that are potentially long-lived |
|
|
338 | is usually a good idea. |
|
|
339 | |
|
|
340 | =item oobinline => <boolean> |
|
|
341 | |
|
|
342 | BSD majorly fucked up the implementation of TCP urgent data. The result |
|
|
343 | is that almost no OS implements TCP according to the specs, and every OS |
|
|
344 | implements it slightly differently. |
|
|
345 | |
|
|
346 | If you want to handle TCP urgent data, then setting this flag (the default |
|
|
347 | is enabled) gives you the most portable way of getting urgent data, by |
|
|
348 | putting it into the stream. |
|
|
349 | |
|
|
350 | Since BSD emulation of OOB data on top of TCP's urgent data can have |
|
|
351 | security implications, AnyEvent::Handle sets this flag automatically |
|
|
352 | unless explicitly specified. Note that setting this flag after |
|
|
353 | establishing a connection I<may> be a bit too late (data loss could |
|
|
354 | already have occured on BSD systems), but at least it will protect you |
|
|
355 | from most attacks. |
277 | |
356 | |
278 | =item read_size => <bytes> |
357 | =item read_size => <bytes> |
279 | |
358 | |
280 | The default read block size (the amount of bytes this module will |
359 | The initial read block size, the number of bytes this module will try to |
281 | try to read during each loop iteration, which affects memory |
360 | read during each loop iteration. Each handle object will consume at least |
282 | requirements). Default: C<8192>. |
361 | this amount of memory for the read buffer as well, so when handling many |
|
|
362 | connections requirements). See also C<max_read_size>. Default: C<2048>. |
|
|
363 | |
|
|
364 | =item max_read_size => <bytes> |
|
|
365 | |
|
|
366 | The maximum read buffer size used by the dynamic adjustment |
|
|
367 | algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in |
|
|
368 | one go it will double C<read_size> up to the maximum given by this |
|
|
369 | option. Default: C<131072> or C<read_size>, whichever is higher. |
283 | |
370 | |
284 | =item low_water_mark => <bytes> |
371 | =item low_water_mark => <bytes> |
285 | |
372 | |
286 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
373 | Sets the number of bytes (default: C<0>) that make up an "empty" write |
287 | buffer: If the write reaches this size or gets even samller it is |
374 | buffer: If the buffer reaches this size or gets even samller it is |
288 | considered empty. |
375 | considered empty. |
289 | |
376 | |
290 | Sometimes it can be beneficial (for performance reasons) to add data to |
377 | Sometimes it can be beneficial (for performance reasons) to add data to |
291 | the write buffer before it is fully drained, but this is a rare case, as |
378 | the write buffer before it is fully drained, but this is a rare case, as |
292 | the operating system kernel usually buffers data as well, so the default |
379 | the operating system kernel usually buffers data as well, so the default |
293 | is good in almost all cases. |
380 | is good in almost all cases. |
294 | |
381 | |
295 | =item linger => <seconds> |
382 | =item linger => <seconds> |
296 | |
383 | |
297 | If non-zero (default: C<3600>), then the destructor of the |
384 | If this is non-zero (default: C<3600>), the destructor of the |
298 | AnyEvent::Handle object will check whether there is still outstanding |
385 | AnyEvent::Handle object will check whether there is still outstanding |
299 | write data and will install a watcher that will write this data to the |
386 | write data and will install a watcher that will write this data to the |
300 | socket. No errors will be reported (this mostly matches how the operating |
387 | socket. No errors will be reported (this mostly matches how the operating |
301 | system treats outstanding data at socket close time). |
388 | system treats outstanding data at socket close time). |
302 | |
389 | |
… | |
… | |
309 | A string used to identify the remote site - usually the DNS hostname |
396 | A string used to identify the remote site - usually the DNS hostname |
310 | (I<not> IDN!) used to create the connection, rarely the IP address. |
397 | (I<not> IDN!) used to create the connection, rarely the IP address. |
311 | |
398 | |
312 | Apart from being useful in error messages, this string is also used in TLS |
399 | Apart from being useful in error messages, this string is also used in TLS |
313 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
400 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
314 | verification will be skipped when C<peername> is not specified or |
401 | verification will be skipped when C<peername> is not specified or is |
315 | C<undef>. |
402 | C<undef>. |
316 | |
403 | |
317 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
404 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
318 | |
405 | |
319 | When this parameter is given, it enables TLS (SSL) mode, that means |
406 | When this parameter is given, it enables TLS (SSL) mode, that means |
320 | AnyEvent will start a TLS handshake as soon as the conenction has been |
407 | AnyEvent will start a TLS handshake as soon as the connection has been |
321 | established and will transparently encrypt/decrypt data afterwards. |
408 | established and will transparently encrypt/decrypt data afterwards. |
322 | |
409 | |
323 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
410 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
324 | appropriate error message. |
411 | appropriate error message. |
325 | |
412 | |
… | |
… | |
345 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
432 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
346 | passing in the wrong integer will lead to certain crash. This most often |
433 | passing in the wrong integer will lead to certain crash. This most often |
347 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
434 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
348 | segmentation fault. |
435 | segmentation fault. |
349 | |
436 | |
350 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
437 | Use the C<< ->starttls >> method if you need to start TLS negotiation later. |
351 | |
438 | |
352 | =item tls_ctx => $anyevent_tls |
439 | =item tls_ctx => $anyevent_tls |
353 | |
440 | |
354 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
441 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
355 | (unless a connection object was specified directly). If this parameter is |
442 | (unless a connection object was specified directly). If this |
356 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
443 | parameter is missing (or C<undef>), then AnyEvent::Handle will use |
|
|
444 | C<AnyEvent::Handle::TLS_CTX>. |
357 | |
445 | |
358 | Instead of an object, you can also specify a hash reference with C<< key |
446 | Instead of an object, you can also specify a hash reference with C<< key |
359 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
447 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
360 | new TLS context object. |
448 | new TLS context object. |
361 | |
449 | |
… | |
… | |
370 | |
458 | |
371 | TLS handshake failures will not cause C<on_error> to be invoked when this |
459 | TLS handshake failures will not cause C<on_error> to be invoked when this |
372 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
460 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
373 | |
461 | |
374 | Without this callback, handshake failures lead to C<on_error> being |
462 | Without this callback, handshake failures lead to C<on_error> being |
375 | called, as normal. |
463 | called as usual. |
376 | |
464 | |
377 | Note that you cannot call C<starttls> right again in this callback. If you |
465 | Note that you cannot just call C<starttls> again in this callback. If you |
378 | need to do that, start an zero-second timer instead whose callback can |
466 | need to do that, start an zero-second timer instead whose callback can |
379 | then call C<< ->starttls >> again. |
467 | then call C<< ->starttls >> again. |
380 | |
468 | |
381 | =item on_stoptls => $cb->($handle) |
469 | =item on_stoptls => $cb->($handle) |
382 | |
470 | |
… | |
… | |
430 | $self->{connect}[0], |
518 | $self->{connect}[0], |
431 | $self->{connect}[1], |
519 | $self->{connect}[1], |
432 | sub { |
520 | sub { |
433 | my ($fh, $host, $port, $retry) = @_; |
521 | my ($fh, $host, $port, $retry) = @_; |
434 | |
522 | |
|
|
523 | delete $self->{_connect}; # no longer needed |
|
|
524 | |
435 | if ($fh) { |
525 | if ($fh) { |
436 | $self->{fh} = $fh; |
526 | $self->{fh} = $fh; |
437 | |
527 | |
438 | delete $self->{_skip_drain_rbuf}; |
528 | delete $self->{_skip_drain_rbuf}; |
439 | $self->_start; |
529 | $self->_start; |
440 | |
530 | |
441 | $self->{on_connect} |
531 | $self->{on_connect} |
442 | and $self->{on_connect}($self, $host, $port, sub { |
532 | and $self->{on_connect}($self, $host, $port, sub { |
443 | delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)}; |
533 | delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)}; |
444 | $self->{_skip_drain_rbuf} = 1; |
534 | $self->{_skip_drain_rbuf} = 1; |
445 | &$retry; |
535 | &$retry; |
446 | }); |
536 | }); |
447 | |
537 | |
448 | } else { |
538 | } else { |
… | |
… | |
456 | }, |
546 | }, |
457 | sub { |
547 | sub { |
458 | local $self->{fh} = $_[0]; |
548 | local $self->{fh} = $_[0]; |
459 | |
549 | |
460 | $self->{on_prepare} |
550 | $self->{on_prepare} |
461 | ? $self->{on_prepare}->($self) |
551 | ? $self->{on_prepare}->($self) |
462 | : () |
552 | : () |
463 | } |
553 | } |
464 | ); |
554 | ); |
465 | } |
555 | } |
466 | |
556 | |
… | |
… | |
472 | } |
562 | } |
473 | |
563 | |
474 | sub _start { |
564 | sub _start { |
475 | my ($self) = @_; |
565 | my ($self) = @_; |
476 | |
566 | |
|
|
567 | # too many clueless people try to use udp and similar sockets |
|
|
568 | # with AnyEvent::Handle, do them a favour. |
|
|
569 | my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE (); |
|
|
570 | Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!" |
|
|
571 | if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type; |
|
|
572 | |
477 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
573 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
478 | |
574 | |
|
|
575 | $self->{_activity} = |
|
|
576 | $self->{_ractivity} = |
479 | $self->{_activity} = AnyEvent->now; |
577 | $self->{_wactivity} = AE::now; |
480 | $self->_timeout; |
|
|
481 | |
578 | |
|
|
579 | $self->{read_size} ||= 2048; |
|
|
580 | $self->{max_read_size} = $self->{read_size} |
|
|
581 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
|
|
582 | |
|
|
583 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
|
|
584 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
|
|
585 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
|
|
586 | |
482 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
587 | $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; |
|
|
588 | $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive}; |
483 | |
589 | |
|
|
590 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
|
|
591 | |
484 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
592 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
485 | if $self->{tls}; |
593 | if $self->{tls}; |
486 | |
594 | |
487 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
595 | $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain}; |
488 | |
596 | |
489 | $self->start_read |
597 | $self->start_read |
490 | if $self->{on_read} || @{ $self->{_queue} }; |
598 | if $self->{on_read} || @{ $self->{_queue} }; |
491 | |
599 | |
492 | $self->_drain_wbuf; |
600 | $self->_drain_wbuf; |
493 | } |
601 | } |
494 | |
|
|
495 | #sub _shutdown { |
|
|
496 | # my ($self) = @_; |
|
|
497 | # |
|
|
498 | # delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
|
|
499 | # $self->{_eof} = 1; # tell starttls et. al to stop trying |
|
|
500 | # |
|
|
501 | # &_freetls; |
|
|
502 | #} |
|
|
503 | |
602 | |
504 | sub _error { |
603 | sub _error { |
505 | my ($self, $errno, $fatal, $message) = @_; |
604 | my ($self, $errno, $fatal, $message) = @_; |
506 | |
605 | |
507 | $! = $errno; |
606 | $! = $errno; |
508 | $message ||= "$!"; |
607 | $message ||= "$!"; |
509 | |
608 | |
510 | if ($self->{on_error}) { |
609 | if ($self->{on_error}) { |
511 | $self->{on_error}($self, $fatal, $message); |
610 | $self->{on_error}($self, $fatal, $message); |
512 | $self->destroy if $fatal; |
611 | $self->destroy if $fatal; |
513 | } elsif ($self->{fh}) { |
612 | } elsif ($self->{fh} || $self->{connect}) { |
514 | $self->destroy; |
613 | $self->destroy; |
515 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
614 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
516 | } |
615 | } |
517 | } |
616 | } |
518 | |
617 | |
… | |
… | |
544 | $_[0]{on_eof} = $_[1]; |
643 | $_[0]{on_eof} = $_[1]; |
545 | } |
644 | } |
546 | |
645 | |
547 | =item $handle->on_timeout ($cb) |
646 | =item $handle->on_timeout ($cb) |
548 | |
647 | |
549 | Replace the current C<on_timeout> callback, or disables the callback (but |
648 | =item $handle->on_rtimeout ($cb) |
550 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
|
|
551 | argument and method. |
|
|
552 | |
649 | |
553 | =cut |
650 | =item $handle->on_wtimeout ($cb) |
554 | |
651 | |
555 | sub on_timeout { |
652 | Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout> |
556 | $_[0]{on_timeout} = $_[1]; |
653 | callback, or disables the callback (but not the timeout) if C<$cb> = |
557 | } |
654 | C<undef>. See the C<timeout> constructor argument and method. |
|
|
655 | |
|
|
656 | =cut |
|
|
657 | |
|
|
658 | # see below |
558 | |
659 | |
559 | =item $handle->autocork ($boolean) |
660 | =item $handle->autocork ($boolean) |
560 | |
661 | |
561 | Enables or disables the current autocork behaviour (see C<autocork> |
662 | Enables or disables the current autocork behaviour (see C<autocork> |
562 | constructor argument). Changes will only take effect on the next write. |
663 | constructor argument). Changes will only take effect on the next write. |
… | |
… | |
575 | =cut |
676 | =cut |
576 | |
677 | |
577 | sub no_delay { |
678 | sub no_delay { |
578 | $_[0]{no_delay} = $_[1]; |
679 | $_[0]{no_delay} = $_[1]; |
579 | |
680 | |
|
|
681 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
|
|
682 | if $_[0]{fh}; |
|
|
683 | } |
|
|
684 | |
|
|
685 | =item $handle->keepalive ($boolean) |
|
|
686 | |
|
|
687 | Enables or disables the C<keepalive> setting (see constructor argument of |
|
|
688 | the same name for details). |
|
|
689 | |
|
|
690 | =cut |
|
|
691 | |
|
|
692 | sub keepalive { |
|
|
693 | $_[0]{keepalive} = $_[1]; |
|
|
694 | |
580 | eval { |
695 | eval { |
581 | local $SIG{__DIE__}; |
696 | local $SIG{__DIE__}; |
582 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1] |
697 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1] |
583 | if $_[0]{fh}; |
698 | if $_[0]{fh}; |
584 | }; |
699 | }; |
585 | } |
700 | } |
586 | |
701 | |
|
|
702 | =item $handle->oobinline ($boolean) |
|
|
703 | |
|
|
704 | Enables or disables the C<oobinline> setting (see constructor argument of |
|
|
705 | the same name for details). |
|
|
706 | |
|
|
707 | =cut |
|
|
708 | |
|
|
709 | sub oobinline { |
|
|
710 | $_[0]{oobinline} = $_[1]; |
|
|
711 | |
|
|
712 | eval { |
|
|
713 | local $SIG{__DIE__}; |
|
|
714 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1] |
|
|
715 | if $_[0]{fh}; |
|
|
716 | }; |
|
|
717 | } |
|
|
718 | |
|
|
719 | =item $handle->keepalive ($boolean) |
|
|
720 | |
|
|
721 | Enables or disables the C<keepalive> setting (see constructor argument of |
|
|
722 | the same name for details). |
|
|
723 | |
|
|
724 | =cut |
|
|
725 | |
|
|
726 | sub keepalive { |
|
|
727 | $_[0]{keepalive} = $_[1]; |
|
|
728 | |
|
|
729 | eval { |
|
|
730 | local $SIG{__DIE__}; |
|
|
731 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1] |
|
|
732 | if $_[0]{fh}; |
|
|
733 | }; |
|
|
734 | } |
|
|
735 | |
587 | =item $handle->on_starttls ($cb) |
736 | =item $handle->on_starttls ($cb) |
588 | |
737 | |
589 | Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). |
738 | Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). |
590 | |
739 | |
591 | =cut |
740 | =cut |
… | |
… | |
598 | |
747 | |
599 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
748 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
600 | |
749 | |
601 | =cut |
750 | =cut |
602 | |
751 | |
603 | sub on_starttls { |
752 | sub on_stoptls { |
604 | $_[0]{on_stoptls} = $_[1]; |
753 | $_[0]{on_stoptls} = $_[1]; |
605 | } |
754 | } |
606 | |
755 | |
607 | =item $handle->rbuf_max ($max_octets) |
756 | =item $handle->rbuf_max ($max_octets) |
608 | |
757 | |
609 | Configures the C<rbuf_max> setting (C<undef> disables it). |
758 | Configures the C<rbuf_max> setting (C<undef> disables it). |
|
|
759 | |
|
|
760 | =item $handle->wbuf_max ($max_octets) |
|
|
761 | |
|
|
762 | Configures the C<wbuf_max> setting (C<undef> disables it). |
610 | |
763 | |
611 | =cut |
764 | =cut |
612 | |
765 | |
613 | sub rbuf_max { |
766 | sub rbuf_max { |
614 | $_[0]{rbuf_max} = $_[1]; |
767 | $_[0]{rbuf_max} = $_[1]; |
615 | } |
768 | } |
616 | |
769 | |
|
|
770 | sub rbuf_max { |
|
|
771 | $_[0]{wbuf_max} = $_[1]; |
|
|
772 | } |
|
|
773 | |
617 | ############################################################################# |
774 | ############################################################################# |
618 | |
775 | |
619 | =item $handle->timeout ($seconds) |
776 | =item $handle->timeout ($seconds) |
620 | |
777 | |
|
|
778 | =item $handle->rtimeout ($seconds) |
|
|
779 | |
|
|
780 | =item $handle->wtimeout ($seconds) |
|
|
781 | |
621 | Configures (or disables) the inactivity timeout. |
782 | Configures (or disables) the inactivity timeout. |
622 | |
783 | |
623 | =cut |
784 | =item $handle->timeout_reset |
624 | |
785 | |
625 | sub timeout { |
786 | =item $handle->rtimeout_reset |
|
|
787 | |
|
|
788 | =item $handle->wtimeout_reset |
|
|
789 | |
|
|
790 | Reset the activity timeout, as if data was received or sent. |
|
|
791 | |
|
|
792 | These methods are cheap to call. |
|
|
793 | |
|
|
794 | =cut |
|
|
795 | |
|
|
796 | for my $dir ("", "r", "w") { |
|
|
797 | my $timeout = "${dir}timeout"; |
|
|
798 | my $tw = "_${dir}tw"; |
|
|
799 | my $on_timeout = "on_${dir}timeout"; |
|
|
800 | my $activity = "_${dir}activity"; |
|
|
801 | my $cb; |
|
|
802 | |
|
|
803 | *$on_timeout = sub { |
|
|
804 | $_[0]{$on_timeout} = $_[1]; |
|
|
805 | }; |
|
|
806 | |
|
|
807 | *$timeout = sub { |
626 | my ($self, $timeout) = @_; |
808 | my ($self, $new_value) = @_; |
627 | |
809 | |
|
|
810 | $new_value >= 0 |
|
|
811 | or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught"; |
|
|
812 | |
628 | $self->{timeout} = $timeout; |
813 | $self->{$timeout} = $new_value; |
629 | $self->_timeout; |
814 | delete $self->{$tw}; &$cb; |
630 | } |
815 | }; |
631 | |
816 | |
|
|
817 | *{"${dir}timeout_reset"} = sub { |
|
|
818 | $_[0]{$activity} = AE::now; |
|
|
819 | }; |
|
|
820 | |
|
|
821 | # main workhorse: |
632 | # reset the timeout watcher, as neccessary |
822 | # reset the timeout watcher, as neccessary |
633 | # also check for time-outs |
823 | # also check for time-outs |
634 | sub _timeout { |
824 | $cb = sub { |
635 | my ($self) = @_; |
825 | my ($self) = @_; |
636 | |
826 | |
637 | if ($self->{timeout} && $self->{fh}) { |
827 | if ($self->{$timeout} && $self->{fh}) { |
638 | my $NOW = AnyEvent->now; |
828 | my $NOW = AE::now; |
639 | |
829 | |
640 | # when would the timeout trigger? |
830 | # when would the timeout trigger? |
641 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
831 | my $after = $self->{$activity} + $self->{$timeout} - $NOW; |
642 | |
832 | |
643 | # now or in the past already? |
833 | # now or in the past already? |
644 | if ($after <= 0) { |
834 | if ($after <= 0) { |
645 | $self->{_activity} = $NOW; |
835 | $self->{$activity} = $NOW; |
646 | |
836 | |
647 | if ($self->{on_timeout}) { |
837 | if ($self->{$on_timeout}) { |
648 | $self->{on_timeout}($self); |
838 | $self->{$on_timeout}($self); |
649 | } else { |
839 | } else { |
650 | $self->_error (Errno::ETIMEDOUT); |
840 | $self->_error (Errno::ETIMEDOUT); |
|
|
841 | } |
|
|
842 | |
|
|
843 | # callback could have changed timeout value, optimise |
|
|
844 | return unless $self->{$timeout}; |
|
|
845 | |
|
|
846 | # calculate new after |
|
|
847 | $after = $self->{$timeout}; |
651 | } |
848 | } |
652 | |
849 | |
653 | # callback could have changed timeout value, optimise |
850 | Scalar::Util::weaken $self; |
654 | return unless $self->{timeout}; |
851 | return unless $self; # ->error could have destroyed $self |
655 | |
852 | |
656 | # calculate new after |
853 | $self->{$tw} ||= AE::timer $after, 0, sub { |
657 | $after = $self->{timeout}; |
854 | delete $self->{$tw}; |
|
|
855 | $cb->($self); |
|
|
856 | }; |
|
|
857 | } else { |
|
|
858 | delete $self->{$tw}; |
658 | } |
859 | } |
659 | |
|
|
660 | Scalar::Util::weaken $self; |
|
|
661 | return unless $self; # ->error could have destroyed $self |
|
|
662 | |
|
|
663 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
|
|
664 | delete $self->{_tw}; |
|
|
665 | $self->_timeout; |
|
|
666 | }); |
|
|
667 | } else { |
|
|
668 | delete $self->{_tw}; |
|
|
669 | } |
860 | } |
670 | } |
861 | } |
671 | |
862 | |
672 | ############################################################################# |
863 | ############################################################################# |
673 | |
864 | |
… | |
… | |
689 | =item $handle->on_drain ($cb) |
880 | =item $handle->on_drain ($cb) |
690 | |
881 | |
691 | Sets the C<on_drain> callback or clears it (see the description of |
882 | Sets the C<on_drain> callback or clears it (see the description of |
692 | C<on_drain> in the constructor). |
883 | C<on_drain> in the constructor). |
693 | |
884 | |
|
|
885 | This method may invoke callbacks (and therefore the handle might be |
|
|
886 | destroyed after it returns). |
|
|
887 | |
694 | =cut |
888 | =cut |
695 | |
889 | |
696 | sub on_drain { |
890 | sub on_drain { |
697 | my ($self, $cb) = @_; |
891 | my ($self, $cb) = @_; |
698 | |
892 | |
… | |
… | |
702 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
896 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
703 | } |
897 | } |
704 | |
898 | |
705 | =item $handle->push_write ($data) |
899 | =item $handle->push_write ($data) |
706 | |
900 | |
707 | Queues the given scalar to be written. You can push as much data as you |
901 | Queues the given scalar to be written. You can push as much data as |
708 | want (only limited by the available memory), as C<AnyEvent::Handle> |
902 | you want (only limited by the available memory and C<wbuf_max>), as |
709 | buffers it independently of the kernel. |
903 | C<AnyEvent::Handle> buffers it independently of the kernel. |
|
|
904 | |
|
|
905 | This method may invoke callbacks (and therefore the handle might be |
|
|
906 | destroyed after it returns). |
710 | |
907 | |
711 | =cut |
908 | =cut |
712 | |
909 | |
713 | sub _drain_wbuf { |
910 | sub _drain_wbuf { |
714 | my ($self) = @_; |
911 | my ($self) = @_; |
… | |
… | |
721 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
918 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
722 | |
919 | |
723 | if (defined $len) { |
920 | if (defined $len) { |
724 | substr $self->{wbuf}, 0, $len, ""; |
921 | substr $self->{wbuf}, 0, $len, ""; |
725 | |
922 | |
726 | $self->{_activity} = AnyEvent->now; |
923 | $self->{_activity} = $self->{_wactivity} = AE::now; |
727 | |
924 | |
728 | $self->{on_drain}($self) |
925 | $self->{on_drain}($self) |
729 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
926 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
730 | && $self->{on_drain}; |
927 | && $self->{on_drain}; |
731 | |
928 | |
… | |
… | |
737 | |
934 | |
738 | # try to write data immediately |
935 | # try to write data immediately |
739 | $cb->() unless $self->{autocork}; |
936 | $cb->() unless $self->{autocork}; |
740 | |
937 | |
741 | # if still data left in wbuf, we need to poll |
938 | # if still data left in wbuf, we need to poll |
742 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
939 | $self->{_ww} = AE::io $self->{fh}, 1, $cb |
743 | if length $self->{wbuf}; |
940 | if length $self->{wbuf}; |
|
|
941 | |
|
|
942 | if ( |
|
|
943 | defined $self->{wbuf_max} |
|
|
944 | && $self->{wbuf_max} < length $self->{wbuf} |
|
|
945 | ) { |
|
|
946 | $self->_error (Errno::ENOSPC, 1), return; |
|
|
947 | } |
744 | }; |
948 | }; |
745 | } |
949 | } |
746 | |
950 | |
747 | our %WH; |
951 | our %WH; |
748 | |
952 | |
|
|
953 | # deprecated |
749 | sub register_write_type($$) { |
954 | sub register_write_type($$) { |
750 | $WH{$_[0]} = $_[1]; |
955 | $WH{$_[0]} = $_[1]; |
751 | } |
956 | } |
752 | |
957 | |
753 | sub push_write { |
958 | sub push_write { |
754 | my $self = shift; |
959 | my $self = shift; |
755 | |
960 | |
756 | if (@_ > 1) { |
961 | if (@_ > 1) { |
757 | my $type = shift; |
962 | my $type = shift; |
758 | |
963 | |
|
|
964 | @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" |
759 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
965 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") |
760 | ->($self, @_); |
966 | ->($self, @_); |
761 | } |
967 | } |
762 | |
968 | |
|
|
969 | # we downgrade here to avoid hard-to-track-down bugs, |
|
|
970 | # and diagnose the problem earlier and better. |
|
|
971 | |
763 | if ($self->{tls}) { |
972 | if ($self->{tls}) { |
764 | $self->{_tls_wbuf} .= $_[0]; |
973 | utf8::downgrade $self->{_tls_wbuf} .= $_[0]; |
765 | &_dotls ($self) if $self->{fh}; |
974 | &_dotls ($self) if $self->{fh}; |
766 | } else { |
975 | } else { |
767 | $self->{wbuf} .= $_[0]; |
976 | utf8::downgrade $self->{wbuf} .= $_[0]; |
768 | $self->_drain_wbuf if $self->{fh}; |
977 | $self->_drain_wbuf if $self->{fh}; |
769 | } |
978 | } |
770 | } |
979 | } |
771 | |
980 | |
772 | =item $handle->push_write (type => @args) |
981 | =item $handle->push_write (type => @args) |
773 | |
982 | |
774 | Instead of formatting your data yourself, you can also let this module do |
983 | Instead of formatting your data yourself, you can also let this module |
775 | the job by specifying a type and type-specific arguments. |
984 | do the job by specifying a type and type-specific arguments. You |
|
|
985 | can also specify the (fully qualified) name of a package, in which |
|
|
986 | case AnyEvent tries to load the package and then expects to find the |
|
|
987 | C<anyevent_write_type> function inside (see "custom write types", below). |
776 | |
988 | |
777 | Predefined types are (if you have ideas for additional types, feel free to |
989 | Predefined types are (if you have ideas for additional types, feel free to |
778 | drop by and tell us): |
990 | drop by and tell us): |
779 | |
991 | |
780 | =over 4 |
992 | =over 4 |
… | |
… | |
837 | Other languages could read single lines terminated by a newline and pass |
1049 | Other languages could read single lines terminated by a newline and pass |
838 | this line into their JSON decoder of choice. |
1050 | this line into their JSON decoder of choice. |
839 | |
1051 | |
840 | =cut |
1052 | =cut |
841 | |
1053 | |
|
|
1054 | sub json_coder() { |
|
|
1055 | eval { require JSON::XS; JSON::XS->new->utf8 } |
|
|
1056 | || do { require JSON; JSON->new->utf8 } |
|
|
1057 | } |
|
|
1058 | |
842 | register_write_type json => sub { |
1059 | register_write_type json => sub { |
843 | my ($self, $ref) = @_; |
1060 | my ($self, $ref) = @_; |
844 | |
1061 | |
845 | require JSON; |
1062 | my $json = $self->{json} ||= json_coder; |
846 | |
1063 | |
847 | $self->{json} ? $self->{json}->encode ($ref) |
1064 | $json->encode ($ref) |
848 | : JSON::encode_json ($ref) |
|
|
849 | }; |
1065 | }; |
850 | |
1066 | |
851 | =item storable => $reference |
1067 | =item storable => $reference |
852 | |
1068 | |
853 | Freezes the given reference using L<Storable> and writes it to the |
1069 | Freezes the given reference using L<Storable> and writes it to the |
… | |
… | |
879 | the peer. |
1095 | the peer. |
880 | |
1096 | |
881 | You can rely on the normal read queue and C<on_eof> handling |
1097 | You can rely on the normal read queue and C<on_eof> handling |
882 | afterwards. This is the cleanest way to close a connection. |
1098 | afterwards. This is the cleanest way to close a connection. |
883 | |
1099 | |
|
|
1100 | This method may invoke callbacks (and therefore the handle might be |
|
|
1101 | destroyed after it returns). |
|
|
1102 | |
884 | =cut |
1103 | =cut |
885 | |
1104 | |
886 | sub push_shutdown { |
1105 | sub push_shutdown { |
887 | my ($self) = @_; |
1106 | my ($self) = @_; |
888 | |
1107 | |
889 | delete $self->{low_water_mark}; |
1108 | delete $self->{low_water_mark}; |
890 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
1109 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
891 | } |
1110 | } |
892 | |
1111 | |
893 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
1112 | =item custom write types - Package::anyevent_write_type $handle, @args |
894 | |
1113 | |
895 | This function (not method) lets you add your own types to C<push_write>. |
1114 | Instead of one of the predefined types, you can also specify the name of |
|
|
1115 | a package. AnyEvent will try to load the package and then expects to find |
|
|
1116 | a function named C<anyevent_write_type> inside. If it isn't found, it |
|
|
1117 | progressively tries to load the parent package until it either finds the |
|
|
1118 | function (good) or runs out of packages (bad). |
|
|
1119 | |
896 | Whenever the given C<type> is used, C<push_write> will invoke the code |
1120 | Whenever the given C<type> is used, C<push_write> will the function with |
897 | reference with the handle object and the remaining arguments. |
1121 | the handle object and the remaining arguments. |
898 | |
1122 | |
899 | The code reference is supposed to return a single octet string that will |
1123 | The function is supposed to return a single octet string that will be |
900 | be appended to the write buffer. |
1124 | appended to the write buffer, so you cna mentally treat this function as a |
|
|
1125 | "arguments to on-the-wire-format" converter. |
901 | |
1126 | |
902 | Note that this is a function, and all types registered this way will be |
1127 | Example: implement a custom write type C<join> that joins the remaining |
903 | global, so try to use unique names. |
1128 | arguments using the first one. |
|
|
1129 | |
|
|
1130 | $handle->push_write (My::Type => " ", 1,2,3); |
|
|
1131 | |
|
|
1132 | # uses the following package, which can be defined in the "My::Type" or in |
|
|
1133 | # the "My" modules to be auto-loaded, or just about anywhere when the |
|
|
1134 | # My::Type::anyevent_write_type is defined before invoking it. |
|
|
1135 | |
|
|
1136 | package My::Type; |
|
|
1137 | |
|
|
1138 | sub anyevent_write_type { |
|
|
1139 | my ($handle, $delim, @args) = @_; |
|
|
1140 | |
|
|
1141 | join $delim, @args |
|
|
1142 | } |
904 | |
1143 | |
905 | =cut |
1144 | =cut |
906 | |
1145 | |
907 | ############################################################################# |
1146 | ############################################################################# |
908 | |
1147 | |
… | |
… | |
917 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1156 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
918 | a queue. |
1157 | a queue. |
919 | |
1158 | |
920 | In the simple case, you just install an C<on_read> callback and whenever |
1159 | In the simple case, you just install an C<on_read> callback and whenever |
921 | new data arrives, it will be called. You can then remove some data (if |
1160 | new data arrives, it will be called. You can then remove some data (if |
922 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
1161 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can |
923 | leave the data there if you want to accumulate more (e.g. when only a |
1162 | leave the data there if you want to accumulate more (e.g. when only a |
924 | partial message has been received so far). |
1163 | partial message has been received so far), or change the read queue with |
|
|
1164 | e.g. C<push_read>. |
925 | |
1165 | |
926 | In the more complex case, you want to queue multiple callbacks. In this |
1166 | In the more complex case, you want to queue multiple callbacks. In this |
927 | case, AnyEvent::Handle will call the first queued callback each time new |
1167 | case, AnyEvent::Handle will call the first queued callback each time new |
928 | data arrives (also the first time it is queued) and removes it when it has |
1168 | data arrives (also the first time it is queued) and remove it when it has |
929 | done its job (see C<push_read>, below). |
1169 | done its job (see C<push_read>, below). |
930 | |
1170 | |
931 | This way you can, for example, push three line-reads, followed by reading |
1171 | This way you can, for example, push three line-reads, followed by reading |
932 | a chunk of data, and AnyEvent::Handle will execute them in order. |
1172 | a chunk of data, and AnyEvent::Handle will execute them in order. |
933 | |
1173 | |
… | |
… | |
1064 | |
1304 | |
1065 | This replaces the currently set C<on_read> callback, or clears it (when |
1305 | This replaces the currently set C<on_read> callback, or clears it (when |
1066 | the new callback is C<undef>). See the description of C<on_read> in the |
1306 | the new callback is C<undef>). See the description of C<on_read> in the |
1067 | constructor. |
1307 | constructor. |
1068 | |
1308 | |
|
|
1309 | This method may invoke callbacks (and therefore the handle might be |
|
|
1310 | destroyed after it returns). |
|
|
1311 | |
1069 | =cut |
1312 | =cut |
1070 | |
1313 | |
1071 | sub on_read { |
1314 | sub on_read { |
1072 | my ($self, $cb) = @_; |
1315 | my ($self, $cb) = @_; |
1073 | |
1316 | |
… | |
… | |
1075 | $self->_drain_rbuf if $cb; |
1318 | $self->_drain_rbuf if $cb; |
1076 | } |
1319 | } |
1077 | |
1320 | |
1078 | =item $handle->rbuf |
1321 | =item $handle->rbuf |
1079 | |
1322 | |
1080 | Returns the read buffer (as a modifiable lvalue). |
1323 | Returns the read buffer (as a modifiable lvalue). You can also access the |
|
|
1324 | read buffer directly as the C<< ->{rbuf} >> member, if you want (this is |
|
|
1325 | much faster, and no less clean). |
1081 | |
1326 | |
1082 | You can access the read buffer directly as the C<< ->{rbuf} >> |
1327 | The only operation allowed on the read buffer (apart from looking at it) |
1083 | member, if you want. However, the only operation allowed on the |
1328 | is removing data from its beginning. Otherwise modifying or appending to |
1084 | read buffer (apart from looking at it) is removing data from its |
1329 | it is not allowed and will lead to hard-to-track-down bugs. |
1085 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
1086 | lead to hard-to-track-down bugs. |
|
|
1087 | |
1330 | |
1088 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
1331 | NOTE: The read buffer should only be used or modified in the C<on_read> |
1089 | C<push_read> or C<unshift_read> methods are used. The other read methods |
1332 | callback or when C<push_read> or C<unshift_read> are used with a single |
1090 | automatically manage the read buffer. |
1333 | callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods |
|
|
1334 | will manage the read buffer on their own. |
1091 | |
1335 | |
1092 | =cut |
1336 | =cut |
1093 | |
1337 | |
1094 | sub rbuf : lvalue { |
1338 | sub rbuf : lvalue { |
1095 | $_[0]{rbuf} |
1339 | $_[0]{rbuf} |
… | |
… | |
1112 | |
1356 | |
1113 | If enough data was available, then the callback must remove all data it is |
1357 | If enough data was available, then the callback must remove all data it is |
1114 | interested in (which can be none at all) and return a true value. After returning |
1358 | interested in (which can be none at all) and return a true value. After returning |
1115 | true, it will be removed from the queue. |
1359 | true, it will be removed from the queue. |
1116 | |
1360 | |
|
|
1361 | These methods may invoke callbacks (and therefore the handle might be |
|
|
1362 | destroyed after it returns). |
|
|
1363 | |
1117 | =cut |
1364 | =cut |
1118 | |
1365 | |
1119 | our %RH; |
1366 | our %RH; |
1120 | |
1367 | |
1121 | sub register_read_type($$) { |
1368 | sub register_read_type($$) { |
… | |
… | |
1127 | my $cb = pop; |
1374 | my $cb = pop; |
1128 | |
1375 | |
1129 | if (@_) { |
1376 | if (@_) { |
1130 | my $type = shift; |
1377 | my $type = shift; |
1131 | |
1378 | |
|
|
1379 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1132 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
1380 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read") |
1133 | ->($self, $cb, @_); |
1381 | ->($self, $cb, @_); |
1134 | } |
1382 | } |
1135 | |
1383 | |
1136 | push @{ $self->{_queue} }, $cb; |
1384 | push @{ $self->{_queue} }, $cb; |
1137 | $self->_drain_rbuf; |
1385 | $self->_drain_rbuf; |
… | |
… | |
1142 | my $cb = pop; |
1390 | my $cb = pop; |
1143 | |
1391 | |
1144 | if (@_) { |
1392 | if (@_) { |
1145 | my $type = shift; |
1393 | my $type = shift; |
1146 | |
1394 | |
|
|
1395 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1147 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
1396 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read") |
1148 | ->($self, $cb, @_); |
1397 | ->($self, $cb, @_); |
1149 | } |
1398 | } |
1150 | |
|
|
1151 | |
1399 | |
1152 | unshift @{ $self->{_queue} }, $cb; |
1400 | unshift @{ $self->{_queue} }, $cb; |
1153 | $self->_drain_rbuf; |
1401 | $self->_drain_rbuf; |
1154 | } |
1402 | } |
1155 | |
1403 | |
… | |
… | |
1157 | |
1405 | |
1158 | =item $handle->unshift_read (type => @args, $cb) |
1406 | =item $handle->unshift_read (type => @args, $cb) |
1159 | |
1407 | |
1160 | Instead of providing a callback that parses the data itself you can chose |
1408 | Instead of providing a callback that parses the data itself you can chose |
1161 | between a number of predefined parsing formats, for chunks of data, lines |
1409 | between a number of predefined parsing formats, for chunks of data, lines |
1162 | etc. |
1410 | etc. You can also specify the (fully qualified) name of a package, in |
|
|
1411 | which case AnyEvent tries to load the package and then expects to find the |
|
|
1412 | C<anyevent_read_type> function inside (see "custom read types", below). |
1163 | |
1413 | |
1164 | Predefined types are (if you have ideas for additional types, feel free to |
1414 | Predefined types are (if you have ideas for additional types, feel free to |
1165 | drop by and tell us): |
1415 | drop by and tell us): |
1166 | |
1416 | |
1167 | =over 4 |
1417 | =over 4 |
… | |
… | |
1259 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1509 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1260 | and everything preceding and including the match will be accepted |
1510 | and everything preceding and including the match will be accepted |
1261 | unconditionally. This is useful to skip large amounts of data that you |
1511 | unconditionally. This is useful to skip large amounts of data that you |
1262 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1512 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1263 | have to start matching from the beginning. This is purely an optimisation |
1513 | have to start matching from the beginning. This is purely an optimisation |
1264 | and is usually worth only when you expect more than a few kilobytes. |
1514 | and is usually worth it only when you expect more than a few kilobytes. |
1265 | |
1515 | |
1266 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1516 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1267 | expect the header to be very large (it isn't in practise, but...), we use |
1517 | expect the header to be very large (it isn't in practice, but...), we use |
1268 | a skip regex to skip initial portions. The skip regex is tricky in that |
1518 | a skip regex to skip initial portions. The skip regex is tricky in that |
1269 | it only accepts something not ending in either \015 or \012, as these are |
1519 | it only accepts something not ending in either \015 or \012, as these are |
1270 | required for the accept regex. |
1520 | required for the accept regex. |
1271 | |
1521 | |
1272 | $handle->push_read (regex => |
1522 | $handle->push_read (regex => |
… | |
… | |
1366 | sub { |
1616 | sub { |
1367 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1617 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1368 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
1618 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
1369 | or return; |
1619 | or return; |
1370 | |
1620 | |
|
|
1621 | warn "len $len\n";#d# |
1371 | $format = length pack $format, $len; |
1622 | $format = length pack $format, $len; |
|
|
1623 | warn "len2 $format\n";#d# |
1372 | |
1624 | |
1373 | # bypass unshift if we already have the remaining chunk |
1625 | # bypass unshift if we already have the remaining chunk |
1374 | if ($format + $len <= length $_[0]{rbuf}) { |
1626 | if ($format + $len <= length $_[0]{rbuf}) { |
1375 | my $data = substr $_[0]{rbuf}, $format, $len; |
1627 | my $data = substr $_[0]{rbuf}, $format, $len; |
1376 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
1628 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
… | |
… | |
1407 | =cut |
1659 | =cut |
1408 | |
1660 | |
1409 | register_read_type json => sub { |
1661 | register_read_type json => sub { |
1410 | my ($self, $cb) = @_; |
1662 | my ($self, $cb) = @_; |
1411 | |
1663 | |
1412 | my $json = $self->{json} ||= |
1664 | my $json = $self->{json} ||= json_coder; |
1413 | eval { require JSON::XS; JSON::XS->new->utf8 } |
|
|
1414 | || do { require JSON; JSON->new->utf8 }; |
|
|
1415 | |
1665 | |
1416 | my $data; |
1666 | my $data; |
1417 | my $rbuf = \$self->{rbuf}; |
1667 | my $rbuf = \$self->{rbuf}; |
1418 | |
1668 | |
1419 | sub { |
1669 | sub { |
… | |
… | |
1488 | } |
1738 | } |
1489 | }; |
1739 | }; |
1490 | |
1740 | |
1491 | =back |
1741 | =back |
1492 | |
1742 | |
1493 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1743 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
1494 | |
1744 | |
1495 | This function (not method) lets you add your own types to C<push_read>. |
1745 | Instead of one of the predefined types, you can also specify the name |
|
|
1746 | of a package. AnyEvent will try to load the package and then expects to |
|
|
1747 | find a function named C<anyevent_read_type> inside. If it isn't found, it |
|
|
1748 | progressively tries to load the parent package until it either finds the |
|
|
1749 | function (good) or runs out of packages (bad). |
1496 | |
1750 | |
1497 | Whenever the given C<type> is used, C<push_read> will invoke the code |
1751 | Whenever this type is used, C<push_read> will invoke the function with the |
1498 | reference with the handle object, the callback and the remaining |
1752 | handle object, the original callback and the remaining arguments. |
1499 | arguments. |
|
|
1500 | |
1753 | |
1501 | The code reference is supposed to return a callback (usually a closure) |
1754 | The function is supposed to return a callback (usually a closure) that |
1502 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
1755 | works as a plain read callback (see C<< ->push_read ($cb) >>), so you can |
|
|
1756 | mentally treat the function as a "configurable read type to read callback" |
|
|
1757 | converter. |
1503 | |
1758 | |
1504 | It should invoke the passed callback when it is done reading (remember to |
1759 | It should invoke the original callback when it is done reading (remember |
1505 | pass C<$handle> as first argument as all other callbacks do that). |
1760 | to pass C<$handle> as first argument as all other callbacks do that, |
|
|
1761 | although there is no strict requirement on this). |
1506 | |
1762 | |
1507 | Note that this is a function, and all types registered this way will be |
|
|
1508 | global, so try to use unique names. |
|
|
1509 | |
|
|
1510 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
1763 | For examples, see the source of this module (F<perldoc -m |
1511 | search for C<register_read_type>)). |
1764 | AnyEvent::Handle>, search for C<register_read_type>)). |
1512 | |
1765 | |
1513 | =item $handle->stop_read |
1766 | =item $handle->stop_read |
1514 | |
1767 | |
1515 | =item $handle->start_read |
1768 | =item $handle->start_read |
1516 | |
1769 | |
… | |
… | |
1536 | } |
1789 | } |
1537 | |
1790 | |
1538 | sub start_read { |
1791 | sub start_read { |
1539 | my ($self) = @_; |
1792 | my ($self) = @_; |
1540 | |
1793 | |
1541 | unless ($self->{_rw} || $self->{_eof}) { |
1794 | unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) { |
1542 | Scalar::Util::weaken $self; |
1795 | Scalar::Util::weaken $self; |
1543 | |
1796 | |
1544 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1797 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1545 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1798 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1546 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1799 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf; |
1547 | |
1800 | |
1548 | if ($len > 0) { |
1801 | if ($len > 0) { |
1549 | $self->{_activity} = AnyEvent->now; |
1802 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1550 | |
1803 | |
1551 | if ($self->{tls}) { |
1804 | if ($self->{tls}) { |
1552 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1805 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1553 | |
1806 | |
1554 | &_dotls ($self); |
1807 | &_dotls ($self); |
1555 | } else { |
1808 | } else { |
1556 | $self->_drain_rbuf; |
1809 | $self->_drain_rbuf; |
1557 | } |
1810 | } |
1558 | |
1811 | |
|
|
1812 | if ($len == $self->{read_size}) { |
|
|
1813 | $self->{read_size} *= 2; |
|
|
1814 | $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE |
|
|
1815 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
|
|
1816 | } |
|
|
1817 | |
1559 | } elsif (defined $len) { |
1818 | } elsif (defined $len) { |
1560 | delete $self->{_rw}; |
1819 | delete $self->{_rw}; |
1561 | $self->{_eof} = 1; |
1820 | $self->{_eof} = 1; |
1562 | $self->_drain_rbuf; |
1821 | $self->_drain_rbuf; |
1563 | |
1822 | |
1564 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1823 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1565 | return $self->_error ($!, 1); |
1824 | return $self->_error ($!, 1); |
1566 | } |
1825 | } |
1567 | }); |
1826 | }; |
1568 | } |
1827 | } |
1569 | } |
1828 | } |
1570 | |
1829 | |
1571 | our $ERROR_SYSCALL; |
1830 | our $ERROR_SYSCALL; |
1572 | our $ERROR_WANT_READ; |
1831 | our $ERROR_WANT_READ; |
… | |
… | |
1639 | && ($tmp != $ERROR_SYSCALL || $!); |
1898 | && ($tmp != $ERROR_SYSCALL || $!); |
1640 | |
1899 | |
1641 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1900 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1642 | $self->{wbuf} .= $tmp; |
1901 | $self->{wbuf} .= $tmp; |
1643 | $self->_drain_wbuf; |
1902 | $self->_drain_wbuf; |
|
|
1903 | $self->{tls} or return; # tls session might have gone away in callback |
1644 | } |
1904 | } |
1645 | |
1905 | |
1646 | $self->{_on_starttls} |
1906 | $self->{_on_starttls} |
1647 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1907 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1648 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
1908 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
… | |
… | |
1670 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1930 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1671 | changed to your liking. Note that the handshake might have already started |
1931 | changed to your liking. Note that the handshake might have already started |
1672 | when this function returns. |
1932 | when this function returns. |
1673 | |
1933 | |
1674 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1934 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1675 | handshakes on the same stream. Best do not attempt to use the stream after |
1935 | handshakes on the same stream. It is best to not attempt to use the |
1676 | stopping TLS. |
1936 | stream after stopping TLS. |
|
|
1937 | |
|
|
1938 | This method may invoke callbacks (and therefore the handle might be |
|
|
1939 | destroyed after it returns). |
1677 | |
1940 | |
1678 | =cut |
1941 | =cut |
1679 | |
1942 | |
1680 | our %TLS_CACHE; #TODO not yet documented, should we? |
1943 | our %TLS_CACHE; #TODO not yet documented, should we? |
1681 | |
1944 | |
… | |
… | |
1693 | require Net::SSLeay; |
1956 | require Net::SSLeay; |
1694 | |
1957 | |
1695 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1958 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1696 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1959 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1697 | |
1960 | |
1698 | $tls = $self->{tls}; |
1961 | $tls = delete $self->{tls}; |
1699 | $ctx = $self->{tls_ctx}; |
1962 | $ctx = $self->{tls_ctx}; |
1700 | |
1963 | |
1701 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1964 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1702 | |
1965 | |
1703 | if ("HASH" eq ref $ctx) { |
1966 | if ("HASH" eq ref $ctx) { |
… | |
… | |
1732 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
1995 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
1733 | |
1996 | |
1734 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1997 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1735 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1998 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1736 | |
1999 | |
|
|
2000 | Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); |
|
|
2001 | |
1737 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
2002 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
1738 | |
2003 | |
1739 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
2004 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
1740 | if $self->{on_starttls}; |
2005 | if $self->{on_starttls}; |
1741 | |
2006 | |
… | |
… | |
1745 | |
2010 | |
1746 | =item $handle->stoptls |
2011 | =item $handle->stoptls |
1747 | |
2012 | |
1748 | Shuts down the SSL connection - this makes a proper EOF handshake by |
2013 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1749 | sending a close notify to the other side, but since OpenSSL doesn't |
2014 | sending a close notify to the other side, but since OpenSSL doesn't |
1750 | support non-blocking shut downs, it is not guarenteed that you can re-use |
2015 | support non-blocking shut downs, it is not guaranteed that you can re-use |
1751 | the stream afterwards. |
2016 | the stream afterwards. |
|
|
2017 | |
|
|
2018 | This method may invoke callbacks (and therefore the handle might be |
|
|
2019 | destroyed after it returns). |
1752 | |
2020 | |
1753 | =cut |
2021 | =cut |
1754 | |
2022 | |
1755 | sub stoptls { |
2023 | sub stoptls { |
1756 | my ($self) = @_; |
2024 | my ($self) = @_; |
1757 | |
2025 | |
1758 | if ($self->{tls}) { |
2026 | if ($self->{tls} && $self->{fh}) { |
1759 | Net::SSLeay::shutdown ($self->{tls}); |
2027 | Net::SSLeay::shutdown ($self->{tls}); |
1760 | |
2028 | |
1761 | &_dotls; |
2029 | &_dotls; |
1762 | |
2030 | |
1763 | # # we don't give a shit. no, we do, but we can't. no...#d# |
2031 | # # we don't give a shit. no, we do, but we can't. no...#d# |
… | |
… | |
1788 | my $fh = delete $self->{fh}; |
2056 | my $fh = delete $self->{fh}; |
1789 | my $wbuf = delete $self->{wbuf}; |
2057 | my $wbuf = delete $self->{wbuf}; |
1790 | |
2058 | |
1791 | my @linger; |
2059 | my @linger; |
1792 | |
2060 | |
1793 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
2061 | push @linger, AE::io $fh, 1, sub { |
1794 | my $len = syswrite $fh, $wbuf, length $wbuf; |
2062 | my $len = syswrite $fh, $wbuf, length $wbuf; |
1795 | |
2063 | |
1796 | if ($len > 0) { |
2064 | if ($len > 0) { |
1797 | substr $wbuf, 0, $len, ""; |
2065 | substr $wbuf, 0, $len, ""; |
1798 | } else { |
2066 | } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) { |
1799 | @linger = (); # end |
2067 | @linger = (); # end |
1800 | } |
2068 | } |
1801 | }); |
2069 | }; |
1802 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
2070 | push @linger, AE::timer $linger, 0, sub { |
1803 | @linger = (); |
2071 | @linger = (); |
1804 | }); |
2072 | }; |
1805 | } |
2073 | } |
1806 | } |
2074 | } |
1807 | |
2075 | |
1808 | =item $handle->destroy |
2076 | =item $handle->destroy |
1809 | |
2077 | |
… | |
… | |
1840 | |
2108 | |
1841 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
2109 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
1842 | #nop |
2110 | #nop |
1843 | } |
2111 | } |
1844 | |
2112 | |
|
|
2113 | =item $handle->destroyed |
|
|
2114 | |
|
|
2115 | Returns false as long as the handle hasn't been destroyed by a call to C<< |
|
|
2116 | ->destroy >>, true otherwise. |
|
|
2117 | |
|
|
2118 | Can be useful to decide whether the handle is still valid after some |
|
|
2119 | callback possibly destroyed the handle. For example, C<< ->push_write >>, |
|
|
2120 | C<< ->starttls >> and other methods can call user callbacks, which in turn |
|
|
2121 | can destroy the handle, so work can be avoided by checking sometimes: |
|
|
2122 | |
|
|
2123 | $hdl->starttls ("accept"); |
|
|
2124 | return if $hdl->destroyed; |
|
|
2125 | $hdl->push_write (... |
|
|
2126 | |
|
|
2127 | Note that the call to C<push_write> will silently be ignored if the handle |
|
|
2128 | has been destroyed, so often you can just ignore the possibility of the |
|
|
2129 | handle being destroyed. |
|
|
2130 | |
|
|
2131 | =cut |
|
|
2132 | |
|
|
2133 | sub destroyed { 0 } |
|
|
2134 | sub AnyEvent::Handle::destroyed::destroyed { 1 } |
|
|
2135 | |
1845 | =item AnyEvent::Handle::TLS_CTX |
2136 | =item AnyEvent::Handle::TLS_CTX |
1846 | |
2137 | |
1847 | This function creates and returns the AnyEvent::TLS object used by default |
2138 | This function creates and returns the AnyEvent::TLS object used by default |
1848 | for TLS mode. |
2139 | for TLS mode. |
1849 | |
2140 | |
… | |
… | |
1876 | |
2167 | |
1877 | It is only safe to "forget" the reference inside EOF or error callbacks, |
2168 | It is only safe to "forget" the reference inside EOF or error callbacks, |
1878 | from within all other callbacks, you need to explicitly call the C<< |
2169 | from within all other callbacks, you need to explicitly call the C<< |
1879 | ->destroy >> method. |
2170 | ->destroy >> method. |
1880 | |
2171 | |
|
|
2172 | =item Why is my C<on_eof> callback never called? |
|
|
2173 | |
|
|
2174 | Probably because your C<on_error> callback is being called instead: When |
|
|
2175 | you have outstanding requests in your read queue, then an EOF is |
|
|
2176 | considered an error as you clearly expected some data. |
|
|
2177 | |
|
|
2178 | To avoid this, make sure you have an empty read queue whenever your handle |
|
|
2179 | is supposed to be "idle" (i.e. connection closes are O.K.). You cna set |
|
|
2180 | an C<on_read> handler that simply pushes the first read requests in the |
|
|
2181 | queue. |
|
|
2182 | |
|
|
2183 | See also the next question, which explains this in a bit more detail. |
|
|
2184 | |
|
|
2185 | =item How can I serve requests in a loop? |
|
|
2186 | |
|
|
2187 | Most protocols consist of some setup phase (authentication for example) |
|
|
2188 | followed by a request handling phase, where the server waits for requests |
|
|
2189 | and handles them, in a loop. |
|
|
2190 | |
|
|
2191 | There are two important variants: The first (traditional, better) variant |
|
|
2192 | handles requests until the server gets some QUIT command, causing it to |
|
|
2193 | close the connection first (highly desirable for a busy TCP server). A |
|
|
2194 | client dropping the connection is an error, which means this variant can |
|
|
2195 | detect an unexpected detection close. |
|
|
2196 | |
|
|
2197 | To handle this case, always make sure you have a on-empty read queue, by |
|
|
2198 | pushing the "read request start" handler on it: |
|
|
2199 | |
|
|
2200 | # we assume a request starts with a single line |
|
|
2201 | my @start_request; @start_request = (line => sub { |
|
|
2202 | my ($hdl, $line) = @_; |
|
|
2203 | |
|
|
2204 | ... handle request |
|
|
2205 | |
|
|
2206 | # push next request read, possibly from a nested callback |
|
|
2207 | $hdl->push_read (@start_request); |
|
|
2208 | }); |
|
|
2209 | |
|
|
2210 | # auth done, now go into request handling loop |
|
|
2211 | # now push the first @start_request |
|
|
2212 | $hdl->push_read (@start_request); |
|
|
2213 | |
|
|
2214 | By always having an outstanding C<push_read>, the handle always expects |
|
|
2215 | some data and raises the C<EPIPE> error when the connction is dropped |
|
|
2216 | unexpectedly. |
|
|
2217 | |
|
|
2218 | The second variant is a protocol where the client can drop the connection |
|
|
2219 | at any time. For TCP, this means that the server machine may run out of |
|
|
2220 | sockets easier, and in general, it means you cnanot distinguish a protocl |
|
|
2221 | failure/client crash from a normal connection close. Nevertheless, these |
|
|
2222 | kinds of protocols are common (and sometimes even the best solution to the |
|
|
2223 | problem). |
|
|
2224 | |
|
|
2225 | Having an outstanding read request at all times is possible if you ignore |
|
|
2226 | C<EPIPE> errors, but this doesn't help with when the client drops the |
|
|
2227 | connection during a request, which would still be an error. |
|
|
2228 | |
|
|
2229 | A better solution is to push the initial request read in an C<on_read> |
|
|
2230 | callback. This avoids an error, as when the server doesn't expect data |
|
|
2231 | (i.e. is idly waiting for the next request, an EOF will not raise an |
|
|
2232 | error, but simply result in an C<on_eof> callback. It is also a bit slower |
|
|
2233 | and simpler: |
|
|
2234 | |
|
|
2235 | # auth done, now go into request handling loop |
|
|
2236 | $hdl->on_read (sub { |
|
|
2237 | my ($hdl) = @_; |
|
|
2238 | |
|
|
2239 | # called each time we receive data but the read queue is empty |
|
|
2240 | # simply start read the request |
|
|
2241 | |
|
|
2242 | $hdl->push_read (line => sub { |
|
|
2243 | my ($hdl, $line) = @_; |
|
|
2244 | |
|
|
2245 | ... handle request |
|
|
2246 | |
|
|
2247 | # do nothing special when the request has been handled, just |
|
|
2248 | # let the request queue go empty. |
|
|
2249 | }); |
|
|
2250 | }); |
|
|
2251 | |
1881 | =item I get different callback invocations in TLS mode/Why can't I pause |
2252 | =item I get different callback invocations in TLS mode/Why can't I pause |
1882 | reading? |
2253 | reading? |
1883 | |
2254 | |
1884 | Unlike, say, TCP, TLS connections do not consist of two independent |
2255 | Unlike, say, TCP, TLS connections do not consist of two independent |
1885 | communication channels, one for each direction. Or put differently. The |
2256 | communication channels, one for each direction. Or put differently, the |
1886 | read and write directions are not independent of each other: you cannot |
2257 | read and write directions are not independent of each other: you cannot |
1887 | write data unless you are also prepared to read, and vice versa. |
2258 | write data unless you are also prepared to read, and vice versa. |
1888 | |
2259 | |
1889 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
2260 | This means that, in TLS mode, you might get C<on_error> or C<on_eof> |
1890 | callback invocations when you are not expecting any read data - the reason |
2261 | callback invocations when you are not expecting any read data - the reason |
1891 | is that AnyEvent::Handle always reads in TLS mode. |
2262 | is that AnyEvent::Handle always reads in TLS mode. |
1892 | |
2263 | |
1893 | During the connection, you have to make sure that you always have a |
2264 | During the connection, you have to make sure that you always have a |
1894 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
2265 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
… | |
… | |
1908 | my $data = delete $_[0]{rbuf}; |
2279 | my $data = delete $_[0]{rbuf}; |
1909 | }); |
2280 | }); |
1910 | |
2281 | |
1911 | The reason to use C<on_error> is that TCP connections, due to latencies |
2282 | The reason to use C<on_error> is that TCP connections, due to latencies |
1912 | and packets loss, might get closed quite violently with an error, when in |
2283 | and packets loss, might get closed quite violently with an error, when in |
1913 | fact, all data has been received. |
2284 | fact all data has been received. |
1914 | |
2285 | |
1915 | It is usually better to use acknowledgements when transferring data, |
2286 | It is usually better to use acknowledgements when transferring data, |
1916 | to make sure the other side hasn't just died and you got the data |
2287 | to make sure the other side hasn't just died and you got the data |
1917 | intact. This is also one reason why so many internet protocols have an |
2288 | intact. This is also one reason why so many internet protocols have an |
1918 | explicit QUIT command. |
2289 | explicit QUIT command. |
… | |
… | |
1935 | consider using C<< ->push_shutdown >> instead. |
2306 | consider using C<< ->push_shutdown >> instead. |
1936 | |
2307 | |
1937 | =item I want to contact a TLS/SSL server, I don't care about security. |
2308 | =item I want to contact a TLS/SSL server, I don't care about security. |
1938 | |
2309 | |
1939 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2310 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
1940 | simply connect to it and then create the AnyEvent::Handle with the C<tls> |
2311 | connect to it and then create the AnyEvent::Handle with the C<tls> |
1941 | parameter: |
2312 | parameter: |
1942 | |
2313 | |
1943 | tcp_connect $host, $port, sub { |
2314 | tcp_connect $host, $port, sub { |
1944 | my ($fh) = @_; |
2315 | my ($fh) = @_; |
1945 | |
2316 | |
… | |
… | |
2045 | |
2416 | |
2046 | =item * all members not documented here and not prefixed with an underscore |
2417 | =item * all members not documented here and not prefixed with an underscore |
2047 | are free to use in subclasses. |
2418 | are free to use in subclasses. |
2048 | |
2419 | |
2049 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2420 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2050 | member variables, but thats just life, at least it is documented. |
2421 | member variables, but that's just life. At least it is documented. |
2051 | |
2422 | |
2052 | =back |
2423 | =back |
2053 | |
2424 | |
2054 | =head1 AUTHOR |
2425 | =head1 AUTHOR |
2055 | |
2426 | |