1 | package AnyEvent::Handle; |
|
|
2 | |
|
|
3 | no warnings; |
|
|
4 | use strict qw(subs vars); |
|
|
5 | |
|
|
6 | use AnyEvent (); |
|
|
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
|
|
8 | use Scalar::Util (); |
|
|
9 | use Carp (); |
|
|
10 | use Fcntl (); |
|
|
11 | use Errno qw(EAGAIN EINTR); |
|
|
12 | |
|
|
13 | =head1 NAME |
1 | =head1 NAME |
14 | |
2 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
3 | AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent |
16 | |
|
|
17 | =cut |
|
|
18 | |
|
|
19 | our $VERSION = 4.82; |
|
|
20 | |
4 | |
21 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
22 | |
6 | |
23 | use AnyEvent; |
7 | use AnyEvent; |
24 | use AnyEvent::Handle; |
8 | use AnyEvent::Handle; |
… | |
… | |
26 | my $cv = AnyEvent->condvar; |
10 | my $cv = AnyEvent->condvar; |
27 | |
11 | |
28 | my $hdl; $hdl = new AnyEvent::Handle |
12 | my $hdl; $hdl = new AnyEvent::Handle |
29 | fh => \*STDIN, |
13 | fh => \*STDIN, |
30 | on_error => sub { |
14 | on_error => sub { |
|
|
15 | my ($hdl, $fatal, $msg) = @_; |
31 | warn "got error $_[2]\n"; |
16 | warn "got error $msg\n"; |
|
|
17 | $hdl->destroy; |
32 | $cv->send; |
18 | $cv->send; |
33 | ); |
19 | }; |
34 | |
20 | |
35 | # send some request line |
21 | # send some request line |
36 | $hdl->push_write ("getinfo\015\012"); |
22 | $hdl->push_write ("getinfo\015\012"); |
37 | |
23 | |
38 | # read the response line |
24 | # read the response line |
… | |
… | |
44 | |
30 | |
45 | $cv->recv; |
31 | $cv->recv; |
46 | |
32 | |
47 | =head1 DESCRIPTION |
33 | =head1 DESCRIPTION |
48 | |
34 | |
49 | 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 |
50 | filehandles. For utility functions for doing non-blocking connects and accepts |
36 | stream-based filehandles (sockets, pipes, and other stream things). |
51 | on sockets see L<AnyEvent::Util>. |
|
|
52 | |
37 | |
53 | The L<AnyEvent::Intro> tutorial contains some well-documented |
38 | The L<AnyEvent::Intro> tutorial contains some well-documented |
54 | AnyEvent::Handle examples. |
39 | AnyEvent::Handle examples. |
55 | |
40 | |
56 | In the following, when the documentation refers to of "bytes" then this |
41 | In the following, where the documentation refers to "bytes", it means |
57 | 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 |
58 | treatment of characters applies to this module as well. |
43 | treatment of characters applies to this module as well. |
|
|
44 | |
|
|
45 | At the very minimum, you should specify C<fh> or C<connect>, and the |
|
|
46 | C<on_error> callback. |
59 | |
47 | |
60 | 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 |
61 | argument. |
49 | argument. |
62 | |
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 | |
63 | =head1 METHODS |
82 | =head1 METHODS |
64 | |
83 | |
65 | =over 4 |
84 | =over 4 |
66 | |
85 | |
67 | =item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... |
86 | =item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value... |
68 | |
87 | |
69 | The constructor supports these arguments (all as C<< key => value >> pairs). |
88 | The constructor supports these arguments (all as C<< key => value >> pairs). |
70 | |
89 | |
71 | =over 4 |
90 | =over 4 |
72 | |
91 | |
73 | =item fh => $filehandle [MANDATORY] |
92 | =item fh => $filehandle [C<fh> or C<connect> MANDATORY] |
74 | |
93 | |
75 | The filehandle this L<AnyEvent::Handle> object will operate on. |
94 | The filehandle this L<AnyEvent::Handle> object will operate on. |
76 | |
|
|
77 | NOTE: The filehandle will be set to non-blocking mode (using |
95 | NOTE: The filehandle will be set to non-blocking mode (using |
78 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
96 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
79 | that mode. |
97 | that mode. |
80 | |
98 | |
|
|
99 | =item connect => [$host, $service] [C<fh> or C<connect> MANDATORY] |
|
|
100 | |
|
|
101 | Try to connect to the specified host and service (port), using |
|
|
102 | C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the |
|
|
103 | default C<peername>. |
|
|
104 | |
|
|
105 | You have to specify either this parameter, or C<fh>, above. |
|
|
106 | |
|
|
107 | It is possible to push requests on the read and write queues, and modify |
|
|
108 | properties of the stream, even while AnyEvent::Handle is connecting. |
|
|
109 | |
|
|
110 | When this parameter is specified, then the C<on_prepare>, |
|
|
111 | C<on_connect_error> and C<on_connect> callbacks will be called under the |
|
|
112 | appropriate circumstances: |
|
|
113 | |
|
|
114 | =over 4 |
|
|
115 | |
|
|
116 | =item on_prepare => $cb->($handle) |
|
|
117 | |
|
|
118 | This (rarely used) callback is called before a new connection is |
|
|
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 |
|
|
121 | file handle with parameters required for the actual connect (as opposed to |
|
|
122 | settings that can be changed when the connection is already established). |
|
|
123 | |
|
|
124 | The return value of this callback should be the connect timeout value in |
|
|
125 | seconds (or C<0>, or C<undef>, or the empty list, to indicate that the |
|
|
126 | default timeout is to be used). |
|
|
127 | |
|
|
128 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
|
|
129 | |
|
|
130 | This callback is called when a connection has been successfully established. |
|
|
131 | |
|
|
132 | The peer's numeric host and port (the socket peername) are passed as |
|
|
133 | parameters, together with a retry callback. |
|
|
134 | |
|
|
135 | If, for some reason, the handle is not acceptable, calling C<$retry> |
|
|
136 | will continue with the next connection target (in case of multi-homed |
|
|
137 | hosts or SRV records there can be multiple connection endpoints). At the |
|
|
138 | time it is called the read and write queues, eof status, tls status and |
|
|
139 | similar properties of the handle will have been reset. |
|
|
140 | |
|
|
141 | In most cases, you should ignore the C<$retry> parameter. |
|
|
142 | |
|
|
143 | =item on_connect_error => $cb->($handle, $message) |
|
|
144 | |
|
|
145 | This callback is called when the connection could not be |
|
|
146 | established. C<$!> will contain the relevant error code, and C<$message> a |
|
|
147 | message describing it (usually the same as C<"$!">). |
|
|
148 | |
|
|
149 | If this callback isn't specified, then C<on_error> will be called with a |
|
|
150 | fatal error instead. |
|
|
151 | |
|
|
152 | =back |
|
|
153 | |
|
|
154 | =item on_error => $cb->($handle, $fatal, $message) |
|
|
155 | |
|
|
156 | This is the error callback, which is called when, well, some error |
|
|
157 | occured, such as not being able to resolve the hostname, failure to |
|
|
158 | connect, or a read error. |
|
|
159 | |
|
|
160 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
|
|
161 | fatal errors the handle object will be destroyed (by a call to C<< -> |
|
|
162 | destroy >>) after invoking the error callback (which means you are free to |
|
|
163 | examine the handle object). Examples of fatal errors are an EOF condition |
|
|
164 | with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In |
|
|
165 | cases where the other side can close the connection at will, it is |
|
|
166 | often easiest to not report C<EPIPE> errors in this callback. |
|
|
167 | |
|
|
168 | AnyEvent::Handle tries to find an appropriate error code for you to check |
|
|
169 | against, but in some cases (TLS errors), this does not work well. It is |
|
|
170 | recommended to always output the C<$message> argument in human-readable |
|
|
171 | error messages (it's usually the same as C<"$!">). |
|
|
172 | |
|
|
173 | Non-fatal errors can be retried by returning, but it is recommended |
|
|
174 | to simply ignore this parameter and instead abondon the handle object |
|
|
175 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
176 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
|
|
177 | |
|
|
178 | On entry to the callback, the value of C<$!> contains the operating |
|
|
179 | system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
|
|
180 | C<EPROTO>). |
|
|
181 | |
|
|
182 | While not mandatory, it is I<highly> recommended to set this callback, as |
|
|
183 | you will not be notified of errors otherwise. The default just calls |
|
|
184 | C<croak>. |
|
|
185 | |
|
|
186 | =item on_read => $cb->($handle) |
|
|
187 | |
|
|
188 | This sets the default read callback, which is called when data arrives |
|
|
189 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
190 | callback will only be called when at least one octet of data is in the |
|
|
191 | read buffer). |
|
|
192 | |
|
|
193 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
|
|
194 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
|
|
195 | must not enlarge or modify the read buffer, you can only remove data at |
|
|
196 | the beginning from it. |
|
|
197 | |
|
|
198 | You can also call C<< ->push_read (...) >> or any other function that |
|
|
199 | modifies the read queue. Or do both. Or ... |
|
|
200 | |
|
|
201 | When an EOF condition is detected, AnyEvent::Handle will first try to |
|
|
202 | feed all the remaining data to the queued callbacks and C<on_read> before |
|
|
203 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
|
|
204 | error will be raised (with C<$!> set to C<EPIPE>). |
|
|
205 | |
|
|
206 | Note that, unlike requests in the read queue, an C<on_read> callback |
|
|
207 | doesn't mean you I<require> some data: if there is an EOF and there |
|
|
208 | are outstanding read requests then an error will be flagged. With an |
|
|
209 | C<on_read> callback, the C<on_eof> callback will be invoked. |
|
|
210 | |
81 | =item on_eof => $cb->($handle) |
211 | =item on_eof => $cb->($handle) |
82 | |
212 | |
83 | Set the callback to be called when an end-of-file condition is detected, |
213 | Set the callback to be called when an end-of-file condition is detected, |
84 | i.e. in the case of a socket, when the other side has closed the |
214 | i.e. in the case of a socket, when the other side has closed the |
85 | connection cleanly. |
215 | connection cleanly, and there are no outstanding read requests in the |
|
|
216 | queue (if there are read requests, then an EOF counts as an unexpected |
|
|
217 | connection close and will be flagged as an error). |
86 | |
218 | |
87 | For sockets, this just means that the other side has stopped sending data, |
219 | For sockets, this just means that the other side has stopped sending data, |
88 | you can still try to write data, and, in fact, one can return from the EOF |
220 | you can still try to write data, and, in fact, one can return from the EOF |
89 | callback and continue writing data, as only the read part has been shut |
221 | callback and continue writing data, as only the read part has been shut |
90 | down. |
222 | down. |
91 | |
223 | |
92 | While not mandatory, it is I<highly> recommended to set an EOF callback, |
|
|
93 | otherwise you might end up with a closed socket while you are still |
|
|
94 | waiting for data. |
|
|
95 | |
|
|
96 | If an EOF condition has been detected but no C<on_eof> callback has been |
224 | If an EOF condition has been detected but no C<on_eof> callback has been |
97 | 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>. |
98 | |
226 | |
99 | =item on_error => $cb->($handle, $fatal, $message) |
|
|
100 | |
|
|
101 | This is the error callback, which is called when, well, some error |
|
|
102 | occured, such as not being able to resolve the hostname, failure to |
|
|
103 | connect or a read error. |
|
|
104 | |
|
|
105 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
|
|
106 | fatal errors the handle object will be destroyed (by a call to C<< -> |
|
|
107 | destroy >>) after invoking the error callback (which means you are free to |
|
|
108 | examine the handle object). Examples of fatal errors are an EOF condition |
|
|
109 | with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. |
|
|
110 | |
|
|
111 | AnyEvent::Handle tries to find an appropriate error code for you to check |
|
|
112 | against, but in some cases (TLS errors), this does not work well. It is |
|
|
113 | recommended to always output the C<$message> argument in human-readable |
|
|
114 | error messages (it's usually the same as C<"$!">). |
|
|
115 | |
|
|
116 | Non-fatal errors can be retried by simply returning, but it is recommended |
|
|
117 | to simply ignore this parameter and instead abondon the handle object |
|
|
118 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
119 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
|
|
120 | |
|
|
121 | On callback entrance, the value of C<$!> contains the operating system |
|
|
122 | error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
|
|
123 | C<EPROTO>). |
|
|
124 | |
|
|
125 | While not mandatory, it is I<highly> recommended to set this callback, as |
|
|
126 | you will not be notified of errors otherwise. The default simply calls |
|
|
127 | C<croak>. |
|
|
128 | |
|
|
129 | =item on_read => $cb->($handle) |
|
|
130 | |
|
|
131 | This sets the default read callback, which is called when data arrives |
|
|
132 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
133 | callback will only be called when at least one octet of data is in the |
|
|
134 | read buffer). |
|
|
135 | |
|
|
136 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
|
|
137 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
|
|
138 | must not enlarge or modify the read buffer, you can only remove data at |
|
|
139 | the beginning from it. |
|
|
140 | |
|
|
141 | When an EOF condition is detected then AnyEvent::Handle will first try to |
|
|
142 | feed all the remaining data to the queued callbacks and C<on_read> before |
|
|
143 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
|
|
144 | error will be raised (with C<$!> set to C<EPIPE>). |
|
|
145 | |
|
|
146 | =item on_drain => $cb->($handle) |
227 | =item on_drain => $cb->($handle) |
147 | |
228 | |
148 | 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 |
149 | (or when the callback is set and the buffer is empty already). |
230 | (or immediately if the buffer is empty already). |
150 | |
231 | |
151 | 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. |
152 | |
233 | |
153 | 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 |
154 | 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 |
… | |
… | |
156 | 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 |
157 | the file when the write queue becomes empty. |
238 | the file when the write queue becomes empty. |
158 | |
239 | |
159 | =item timeout => $fractional_seconds |
240 | =item timeout => $fractional_seconds |
160 | |
241 | |
|
|
242 | =item rtimeout => $fractional_seconds |
|
|
243 | |
|
|
244 | =item wtimeout => $fractional_seconds |
|
|
245 | |
161 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
246 | If non-zero, then these enables an "inactivity" timeout: whenever this |
162 | 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 |
163 | 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 |
164 | 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). |
165 | |
251 | |
|
|
252 | There are three variants of the timeouts that work independently of each |
|
|
253 | other, for both read and write (triggered when nothing was read I<OR> |
|
|
254 | written), just read (triggered when nothing was read), and just write: |
|
|
255 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
|
|
256 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
|
|
257 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
|
|
258 | |
166 | Note that timeout processing is also active when you currently do not have |
259 | Note that timeout processing is active even when you do not have any |
167 | any outstanding read or write requests: If you plan to keep the connection |
260 | outstanding read or write requests: If you plan to keep the connection |
168 | idle then you should disable the timout temporarily or ignore the timeout |
261 | idle then you should disable the timeout temporarily or ignore the |
169 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
262 | timeout in the corresponding C<on_timeout> callback, in which case |
170 | restart the timeout. |
263 | AnyEvent::Handle will simply restart the timeout. |
171 | |
264 | |
172 | Zero (the default) disables this timeout. |
265 | Zero (the default) disables the corresponding timeout. |
173 | |
266 | |
174 | =item on_timeout => $cb->($handle) |
267 | =item on_timeout => $cb->($handle) |
|
|
268 | |
|
|
269 | =item on_rtimeout => $cb->($handle) |
|
|
270 | |
|
|
271 | =item on_wtimeout => $cb->($handle) |
175 | |
272 | |
176 | Called whenever the inactivity timeout passes. If you return from this |
273 | Called whenever the inactivity timeout passes. If you return from this |
177 | callback, then the timeout will be reset as if some activity had happened, |
274 | callback, then the timeout will be reset as if some activity had happened, |
178 | so this condition is not fatal in any way. |
275 | so this condition is not fatal in any way. |
179 | |
276 | |
… | |
… | |
187 | be configured to accept only so-and-so much data that it cannot act on |
284 | be configured to accept only so-and-so much data that it cannot act on |
188 | (for example, when expecting a line, an attacker could send an unlimited |
285 | (for example, when expecting a line, an attacker could send an unlimited |
189 | amount of data without a callback ever being called as long as the line |
286 | amount of data without a callback ever being called as long as the line |
190 | isn't finished). |
287 | isn't finished). |
191 | |
288 | |
|
|
289 | =item wbuf_max => <bytes> |
|
|
290 | |
|
|
291 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
|
|
292 | when the write buffer ever (strictly) exceeds this size. This is useful to |
|
|
293 | avoid some forms of denial-of-service attacks. |
|
|
294 | |
|
|
295 | Although the units of this parameter is bytes, this is the I<raw> number |
|
|
296 | of bytes not yet accepted by the kernel. This can make a difference when |
|
|
297 | you e.g. use TLS, as TLS typically makes your write data larger (but it |
|
|
298 | can also make it smaller due to compression). |
|
|
299 | |
|
|
300 | As an example of when this limit is useful, take a chat server that sends |
|
|
301 | chat messages to a client. If the client does not read those in a timely |
|
|
302 | manner then the send buffer in the server would grow unbounded. |
|
|
303 | |
192 | =item autocork => <boolean> |
304 | =item autocork => <boolean> |
193 | |
305 | |
194 | When disabled (the default), then C<push_write> will try to immediately |
306 | When disabled (the default), C<push_write> will try to immediately |
195 | write the data to the handle, if possible. This avoids having to register |
307 | write the data to the handle if possible. This avoids having to register |
196 | a write watcher and wait for the next event loop iteration, but can |
308 | a write watcher and wait for the next event loop iteration, but can |
197 | be inefficient if you write multiple small chunks (on the wire, this |
309 | be inefficient if you write multiple small chunks (on the wire, this |
198 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
310 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
199 | C<no_delay>, but this option can save costly syscalls). |
311 | C<no_delay>, but this option can save costly syscalls). |
200 | |
312 | |
201 | When enabled, then writes will always be queued till the next event loop |
313 | When enabled, writes will always be queued till the next event loop |
202 | iteration. This is efficient when you do many small writes per iteration, |
314 | iteration. This is efficient when you do many small writes per iteration, |
203 | but less efficient when you do a single write only per iteration (or when |
315 | but less efficient when you do a single write only per iteration (or when |
204 | the write buffer often is full). It also increases write latency. |
316 | the write buffer often is full). It also increases write latency. |
205 | |
317 | |
206 | =item no_delay => <boolean> |
318 | =item no_delay => <boolean> |
… | |
… | |
210 | the Nagle algorithm, and usually it is beneficial. |
322 | the Nagle algorithm, and usually it is beneficial. |
211 | |
323 | |
212 | In some situations you want as low a delay as possible, which can be |
324 | In some situations you want as low a delay as possible, which can be |
213 | accomplishd by setting this option to a true value. |
325 | accomplishd by setting this option to a true value. |
214 | |
326 | |
215 | The default is your opertaing system's default behaviour (most likely |
327 | The default is your operating system's default behaviour (most likely |
216 | enabled), this option explicitly enables or disables it, if possible. |
328 | enabled). This option explicitly enables or disables it, if possible. |
|
|
329 | |
|
|
330 | =item keepalive => <boolean> |
|
|
331 | |
|
|
332 | Enables (default disable) the SO_KEEPALIVE option on the stream socket: |
|
|
333 | normally, TCP connections have no time-out once established, so TCP |
|
|
334 | connections, once established, can stay alive forever even when the other |
|
|
335 | side has long gone. TCP keepalives are a cheap way to take down long-lived |
|
|
336 | TCP connections when the other side becomes unreachable. While the default |
|
|
337 | is OS-dependent, TCP keepalives usually kick in after around two hours, |
|
|
338 | and, if the other side doesn't reply, take down the TCP connection some 10 |
|
|
339 | to 15 minutes later. |
|
|
340 | |
|
|
341 | It is harmless to specify this option for file handles that do not support |
|
|
342 | keepalives, and enabling it on connections that are potentially long-lived |
|
|
343 | is usually a good idea. |
|
|
344 | |
|
|
345 | =item oobinline => <boolean> |
|
|
346 | |
|
|
347 | BSD majorly fucked up the implementation of TCP urgent data. The result |
|
|
348 | is that almost no OS implements TCP according to the specs, and every OS |
|
|
349 | implements it slightly differently. |
|
|
350 | |
|
|
351 | If you want to handle TCP urgent data, then setting this flag (the default |
|
|
352 | is enabled) gives you the most portable way of getting urgent data, by |
|
|
353 | putting it into the stream. |
|
|
354 | |
|
|
355 | Since BSD emulation of OOB data on top of TCP's urgent data can have |
|
|
356 | security implications, AnyEvent::Handle sets this flag automatically |
|
|
357 | unless explicitly specified. Note that setting this flag after |
|
|
358 | establishing a connection I<may> be a bit too late (data loss could |
|
|
359 | already have occured on BSD systems), but at least it will protect you |
|
|
360 | from most attacks. |
217 | |
361 | |
218 | =item read_size => <bytes> |
362 | =item read_size => <bytes> |
219 | |
363 | |
220 | The default read block size (the amount of bytes this module will |
364 | The initial read block size, the number of bytes this module will try to |
221 | try to read during each loop iteration, which affects memory |
365 | read during each loop iteration. Each handle object will consume at least |
222 | requirements). Default: C<8192>. |
366 | this amount of memory for the read buffer as well, so when handling many |
|
|
367 | connections requirements). See also C<max_read_size>. Default: C<2048>. |
|
|
368 | |
|
|
369 | =item max_read_size => <bytes> |
|
|
370 | |
|
|
371 | The maximum read buffer size used by the dynamic adjustment |
|
|
372 | algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in |
|
|
373 | one go it will double C<read_size> up to the maximum given by this |
|
|
374 | option. Default: C<131072> or C<read_size>, whichever is higher. |
223 | |
375 | |
224 | =item low_water_mark => <bytes> |
376 | =item low_water_mark => <bytes> |
225 | |
377 | |
226 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
378 | Sets the number of bytes (default: C<0>) that make up an "empty" write |
227 | buffer: If the write reaches this size or gets even samller it is |
379 | buffer: If the buffer reaches this size or gets even samller it is |
228 | considered empty. |
380 | considered empty. |
229 | |
381 | |
230 | Sometimes it can be beneficial (for performance reasons) to add data to |
382 | Sometimes it can be beneficial (for performance reasons) to add data to |
231 | the write buffer before it is fully drained, but this is a rare case, as |
383 | the write buffer before it is fully drained, but this is a rare case, as |
232 | the operating system kernel usually buffers data as well, so the default |
384 | the operating system kernel usually buffers data as well, so the default |
233 | is good in almost all cases. |
385 | is good in almost all cases. |
234 | |
386 | |
235 | =item linger => <seconds> |
387 | =item linger => <seconds> |
236 | |
388 | |
237 | If non-zero (default: C<3600>), then the destructor of the |
389 | If this is non-zero (default: C<3600>), the destructor of the |
238 | AnyEvent::Handle object will check whether there is still outstanding |
390 | AnyEvent::Handle object will check whether there is still outstanding |
239 | write data and will install a watcher that will write this data to the |
391 | write data and will install a watcher that will write this data to the |
240 | socket. No errors will be reported (this mostly matches how the operating |
392 | socket. No errors will be reported (this mostly matches how the operating |
241 | system treats outstanding data at socket close time). |
393 | system treats outstanding data at socket close time). |
242 | |
394 | |
… | |
… | |
249 | A string used to identify the remote site - usually the DNS hostname |
401 | A string used to identify the remote site - usually the DNS hostname |
250 | (I<not> IDN!) used to create the connection, rarely the IP address. |
402 | (I<not> IDN!) used to create the connection, rarely the IP address. |
251 | |
403 | |
252 | Apart from being useful in error messages, this string is also used in TLS |
404 | Apart from being useful in error messages, this string is also used in TLS |
253 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
405 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
254 | verification will be skipped when C<peername> is not specified or |
406 | verification will be skipped when C<peername> is not specified or is |
255 | C<undef>. |
407 | C<undef>. |
256 | |
408 | |
257 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
409 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
258 | |
410 | |
259 | When this parameter is given, it enables TLS (SSL) mode, that means |
411 | When this parameter is given, it enables TLS (SSL) mode, that means |
260 | AnyEvent will start a TLS handshake as soon as the conenction has been |
412 | AnyEvent will start a TLS handshake as soon as the connection has been |
261 | established and will transparently encrypt/decrypt data afterwards. |
413 | established and will transparently encrypt/decrypt data afterwards. |
262 | |
414 | |
263 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
415 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
264 | appropriate error message. |
416 | appropriate error message. |
265 | |
417 | |
… | |
… | |
285 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
437 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
286 | passing in the wrong integer will lead to certain crash. This most often |
438 | passing in the wrong integer will lead to certain crash. This most often |
287 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
439 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
288 | segmentation fault. |
440 | segmentation fault. |
289 | |
441 | |
290 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
442 | Use the C<< ->starttls >> method if you need to start TLS negotiation later. |
291 | |
443 | |
292 | =item tls_ctx => $anyevent_tls |
444 | =item tls_ctx => $anyevent_tls |
293 | |
445 | |
294 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
446 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
295 | (unless a connection object was specified directly). If this parameter is |
447 | (unless a connection object was specified directly). If this |
296 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
448 | parameter is missing (or C<undef>), then AnyEvent::Handle will use |
|
|
449 | C<AnyEvent::Handle::TLS_CTX>. |
297 | |
450 | |
298 | Instead of an object, you can also specify a hash reference with C<< key |
451 | Instead of an object, you can also specify a hash reference with C<< key |
299 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
452 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
300 | new TLS context object. |
453 | new TLS context object. |
301 | |
454 | |
… | |
… | |
310 | |
463 | |
311 | TLS handshake failures will not cause C<on_error> to be invoked when this |
464 | TLS handshake failures will not cause C<on_error> to be invoked when this |
312 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
465 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
313 | |
466 | |
314 | Without this callback, handshake failures lead to C<on_error> being |
467 | Without this callback, handshake failures lead to C<on_error> being |
315 | called, as normal. |
468 | called as usual. |
316 | |
469 | |
317 | Note that you cannot call C<starttls> right again in this callback. If you |
470 | Note that you cannot just call C<starttls> again in this callback. If you |
318 | need to do that, start an zero-second timer instead whose callback can |
471 | need to do that, start an zero-second timer instead whose callback can |
319 | then call C<< ->starttls >> again. |
472 | then call C<< ->starttls >> again. |
320 | |
473 | |
321 | =item on_stoptls => $cb->($handle) |
474 | =item on_stoptls => $cb->($handle) |
322 | |
475 | |
… | |
… | |
348 | |
501 | |
349 | sub new { |
502 | sub new { |
350 | my $class = shift; |
503 | my $class = shift; |
351 | my $self = bless { @_ }, $class; |
504 | my $self = bless { @_ }, $class; |
352 | |
505 | |
353 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
506 | if ($self->{fh}) { |
|
|
507 | $self->_start; |
|
|
508 | return unless $self->{fh}; # could be gone by now |
|
|
509 | |
|
|
510 | } elsif ($self->{connect}) { |
|
|
511 | require AnyEvent::Socket; |
|
|
512 | |
|
|
513 | $self->{peername} = $self->{connect}[0] |
|
|
514 | unless exists $self->{peername}; |
|
|
515 | |
|
|
516 | $self->{_skip_drain_rbuf} = 1; |
|
|
517 | |
|
|
518 | { |
|
|
519 | Scalar::Util::weaken (my $self = $self); |
|
|
520 | |
|
|
521 | $self->{_connect} = |
|
|
522 | AnyEvent::Socket::tcp_connect ( |
|
|
523 | $self->{connect}[0], |
|
|
524 | $self->{connect}[1], |
|
|
525 | sub { |
|
|
526 | my ($fh, $host, $port, $retry) = @_; |
|
|
527 | |
|
|
528 | delete $self->{_connect}; # no longer needed |
|
|
529 | |
|
|
530 | if ($fh) { |
|
|
531 | $self->{fh} = $fh; |
|
|
532 | |
|
|
533 | delete $self->{_skip_drain_rbuf}; |
|
|
534 | $self->_start; |
|
|
535 | |
|
|
536 | $self->{on_connect} |
|
|
537 | and $self->{on_connect}($self, $host, $port, sub { |
|
|
538 | delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)}; |
|
|
539 | $self->{_skip_drain_rbuf} = 1; |
|
|
540 | &$retry; |
|
|
541 | }); |
|
|
542 | |
|
|
543 | } else { |
|
|
544 | if ($self->{on_connect_error}) { |
|
|
545 | $self->{on_connect_error}($self, "$!"); |
|
|
546 | $self->destroy if $self; |
|
|
547 | } else { |
|
|
548 | $self->_error ($!, 1); |
|
|
549 | } |
|
|
550 | } |
|
|
551 | }, |
|
|
552 | sub { |
|
|
553 | local $self->{fh} = $_[0]; |
|
|
554 | |
|
|
555 | $self->{on_prepare} |
|
|
556 | ? $self->{on_prepare}->($self) |
|
|
557 | : () |
|
|
558 | } |
|
|
559 | ); |
|
|
560 | } |
|
|
561 | |
|
|
562 | } else { |
|
|
563 | Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified"; |
|
|
564 | } |
|
|
565 | |
|
|
566 | $self |
|
|
567 | } |
|
|
568 | |
|
|
569 | sub _start { |
|
|
570 | my ($self) = @_; |
|
|
571 | |
|
|
572 | # too many clueless people try to use udp and similar sockets |
|
|
573 | # with AnyEvent::Handle, do them a favour. |
|
|
574 | my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE (); |
|
|
575 | Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!" |
|
|
576 | if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type; |
354 | |
577 | |
355 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
578 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
356 | |
579 | |
|
|
580 | $self->{_activity} = |
|
|
581 | $self->{_ractivity} = |
357 | $self->{_activity} = AnyEvent->now; |
582 | $self->{_wactivity} = AE::now; |
358 | $self->_timeout; |
|
|
359 | |
583 | |
|
|
584 | $self->{read_size} ||= 2048; |
|
|
585 | $self->{max_read_size} = $self->{read_size} |
|
|
586 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
|
|
587 | |
|
|
588 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
|
|
589 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
|
|
590 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
|
|
591 | |
360 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
592 | $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; |
|
|
593 | $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive}; |
361 | |
594 | |
|
|
595 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
|
|
596 | |
362 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
597 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
363 | if $self->{tls}; |
598 | if $self->{tls}; |
364 | |
599 | |
365 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
600 | $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain}; |
366 | |
601 | |
367 | $self->start_read |
602 | $self->start_read |
368 | if $self->{on_read}; |
603 | if $self->{on_read} || @{ $self->{_queue} }; |
369 | |
604 | |
370 | $self->{fh} && $self |
605 | $self->_drain_wbuf; |
371 | } |
606 | } |
372 | |
|
|
373 | #sub _shutdown { |
|
|
374 | # my ($self) = @_; |
|
|
375 | # |
|
|
376 | # delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
|
|
377 | # $self->{_eof} = 1; # tell starttls et. al to stop trying |
|
|
378 | # |
|
|
379 | # &_freetls; |
|
|
380 | #} |
|
|
381 | |
607 | |
382 | sub _error { |
608 | sub _error { |
383 | my ($self, $errno, $fatal, $message) = @_; |
609 | my ($self, $errno, $fatal, $message) = @_; |
384 | |
610 | |
385 | $! = $errno; |
611 | $! = $errno; |
386 | $message ||= "$!"; |
612 | $message ||= "$!"; |
387 | |
613 | |
388 | if ($self->{on_error}) { |
614 | if ($self->{on_error}) { |
389 | $self->{on_error}($self, $fatal, $message); |
615 | $self->{on_error}($self, $fatal, $message); |
390 | $self->destroy; |
616 | $self->destroy if $fatal; |
391 | } elsif ($self->{fh}) { |
617 | } elsif ($self->{fh} || $self->{connect}) { |
392 | $self->destroy; |
618 | $self->destroy; |
393 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
619 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
394 | } |
620 | } |
395 | } |
621 | } |
396 | |
622 | |
… | |
… | |
422 | $_[0]{on_eof} = $_[1]; |
648 | $_[0]{on_eof} = $_[1]; |
423 | } |
649 | } |
424 | |
650 | |
425 | =item $handle->on_timeout ($cb) |
651 | =item $handle->on_timeout ($cb) |
426 | |
652 | |
427 | Replace the current C<on_timeout> callback, or disables the callback (but |
653 | =item $handle->on_rtimeout ($cb) |
428 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
|
|
429 | argument and method. |
|
|
430 | |
654 | |
431 | =cut |
655 | =item $handle->on_wtimeout ($cb) |
432 | |
656 | |
433 | sub on_timeout { |
657 | Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout> |
434 | $_[0]{on_timeout} = $_[1]; |
658 | callback, or disables the callback (but not the timeout) if C<$cb> = |
435 | } |
659 | C<undef>. See the C<timeout> constructor argument and method. |
|
|
660 | |
|
|
661 | =cut |
|
|
662 | |
|
|
663 | # see below |
436 | |
664 | |
437 | =item $handle->autocork ($boolean) |
665 | =item $handle->autocork ($boolean) |
438 | |
666 | |
439 | Enables or disables the current autocork behaviour (see C<autocork> |
667 | Enables or disables the current autocork behaviour (see C<autocork> |
440 | constructor argument). Changes will only take effect on the next write. |
668 | constructor argument). Changes will only take effect on the next write. |
… | |
… | |
453 | =cut |
681 | =cut |
454 | |
682 | |
455 | sub no_delay { |
683 | sub no_delay { |
456 | $_[0]{no_delay} = $_[1]; |
684 | $_[0]{no_delay} = $_[1]; |
457 | |
685 | |
|
|
686 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
|
|
687 | if $_[0]{fh}; |
|
|
688 | } |
|
|
689 | |
|
|
690 | =item $handle->keepalive ($boolean) |
|
|
691 | |
|
|
692 | Enables or disables the C<keepalive> setting (see constructor argument of |
|
|
693 | the same name for details). |
|
|
694 | |
|
|
695 | =cut |
|
|
696 | |
|
|
697 | sub keepalive { |
|
|
698 | $_[0]{keepalive} = $_[1]; |
|
|
699 | |
458 | eval { |
700 | eval { |
459 | local $SIG{__DIE__}; |
701 | local $SIG{__DIE__}; |
460 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
702 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1] |
|
|
703 | if $_[0]{fh}; |
|
|
704 | }; |
|
|
705 | } |
|
|
706 | |
|
|
707 | =item $handle->oobinline ($boolean) |
|
|
708 | |
|
|
709 | Enables or disables the C<oobinline> setting (see constructor argument of |
|
|
710 | the same name for details). |
|
|
711 | |
|
|
712 | =cut |
|
|
713 | |
|
|
714 | sub oobinline { |
|
|
715 | $_[0]{oobinline} = $_[1]; |
|
|
716 | |
|
|
717 | eval { |
|
|
718 | local $SIG{__DIE__}; |
|
|
719 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1] |
|
|
720 | if $_[0]{fh}; |
|
|
721 | }; |
|
|
722 | } |
|
|
723 | |
|
|
724 | =item $handle->keepalive ($boolean) |
|
|
725 | |
|
|
726 | Enables or disables the C<keepalive> setting (see constructor argument of |
|
|
727 | the same name for details). |
|
|
728 | |
|
|
729 | =cut |
|
|
730 | |
|
|
731 | sub keepalive { |
|
|
732 | $_[0]{keepalive} = $_[1]; |
|
|
733 | |
|
|
734 | eval { |
|
|
735 | local $SIG{__DIE__}; |
|
|
736 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1] |
|
|
737 | if $_[0]{fh}; |
461 | }; |
738 | }; |
462 | } |
739 | } |
463 | |
740 | |
464 | =item $handle->on_starttls ($cb) |
741 | =item $handle->on_starttls ($cb) |
465 | |
742 | |
… | |
… | |
475 | |
752 | |
476 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
753 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
477 | |
754 | |
478 | =cut |
755 | =cut |
479 | |
756 | |
480 | sub on_starttls { |
757 | sub on_stoptls { |
481 | $_[0]{on_stoptls} = $_[1]; |
758 | $_[0]{on_stoptls} = $_[1]; |
482 | } |
759 | } |
483 | |
760 | |
|
|
761 | =item $handle->rbuf_max ($max_octets) |
|
|
762 | |
|
|
763 | Configures the C<rbuf_max> setting (C<undef> disables it). |
|
|
764 | |
|
|
765 | =item $handle->wbuf_max ($max_octets) |
|
|
766 | |
|
|
767 | Configures the C<wbuf_max> setting (C<undef> disables it). |
|
|
768 | |
|
|
769 | =cut |
|
|
770 | |
|
|
771 | sub rbuf_max { |
|
|
772 | $_[0]{rbuf_max} = $_[1]; |
|
|
773 | } |
|
|
774 | |
|
|
775 | sub wbuf_max { |
|
|
776 | $_[0]{wbuf_max} = $_[1]; |
|
|
777 | } |
|
|
778 | |
484 | ############################################################################# |
779 | ############################################################################# |
485 | |
780 | |
486 | =item $handle->timeout ($seconds) |
781 | =item $handle->timeout ($seconds) |
487 | |
782 | |
|
|
783 | =item $handle->rtimeout ($seconds) |
|
|
784 | |
|
|
785 | =item $handle->wtimeout ($seconds) |
|
|
786 | |
488 | Configures (or disables) the inactivity timeout. |
787 | Configures (or disables) the inactivity timeout. |
489 | |
788 | |
490 | =cut |
789 | The timeout will be checked instantly, so this method might destroy the |
|
|
790 | handle before it returns. |
491 | |
791 | |
492 | sub timeout { |
792 | =item $handle->timeout_reset |
|
|
793 | |
|
|
794 | =item $handle->rtimeout_reset |
|
|
795 | |
|
|
796 | =item $handle->wtimeout_reset |
|
|
797 | |
|
|
798 | Reset the activity timeout, as if data was received or sent. |
|
|
799 | |
|
|
800 | These methods are cheap to call. |
|
|
801 | |
|
|
802 | =cut |
|
|
803 | |
|
|
804 | for my $dir ("", "r", "w") { |
|
|
805 | my $timeout = "${dir}timeout"; |
|
|
806 | my $tw = "_${dir}tw"; |
|
|
807 | my $on_timeout = "on_${dir}timeout"; |
|
|
808 | my $activity = "_${dir}activity"; |
|
|
809 | my $cb; |
|
|
810 | |
|
|
811 | *$on_timeout = sub { |
|
|
812 | $_[0]{$on_timeout} = $_[1]; |
|
|
813 | }; |
|
|
814 | |
|
|
815 | *$timeout = sub { |
493 | my ($self, $timeout) = @_; |
816 | my ($self, $new_value) = @_; |
494 | |
817 | |
|
|
818 | $new_value >= 0 |
|
|
819 | or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught"; |
|
|
820 | |
495 | $self->{timeout} = $timeout; |
821 | $self->{$timeout} = $new_value; |
496 | $self->_timeout; |
822 | delete $self->{$tw}; &$cb; |
497 | } |
823 | }; |
498 | |
824 | |
|
|
825 | *{"${dir}timeout_reset"} = sub { |
|
|
826 | $_[0]{$activity} = AE::now; |
|
|
827 | }; |
|
|
828 | |
|
|
829 | # main workhorse: |
499 | # reset the timeout watcher, as neccessary |
830 | # reset the timeout watcher, as neccessary |
500 | # also check for time-outs |
831 | # also check for time-outs |
501 | sub _timeout { |
832 | $cb = sub { |
502 | my ($self) = @_; |
833 | my ($self) = @_; |
503 | |
834 | |
504 | if ($self->{timeout}) { |
835 | if ($self->{$timeout} && $self->{fh}) { |
505 | my $NOW = AnyEvent->now; |
836 | my $NOW = AE::now; |
506 | |
837 | |
507 | # when would the timeout trigger? |
838 | # when would the timeout trigger? |
508 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
839 | my $after = $self->{$activity} + $self->{$timeout} - $NOW; |
509 | |
840 | |
510 | # now or in the past already? |
841 | # now or in the past already? |
511 | if ($after <= 0) { |
842 | if ($after <= 0) { |
512 | $self->{_activity} = $NOW; |
843 | $self->{$activity} = $NOW; |
513 | |
844 | |
514 | if ($self->{on_timeout}) { |
845 | if ($self->{$on_timeout}) { |
515 | $self->{on_timeout}($self); |
846 | $self->{$on_timeout}($self); |
516 | } else { |
847 | } else { |
517 | $self->_error (&Errno::ETIMEDOUT); |
848 | $self->_error (Errno::ETIMEDOUT); |
|
|
849 | } |
|
|
850 | |
|
|
851 | # callback could have changed timeout value, optimise |
|
|
852 | return unless $self->{$timeout}; |
|
|
853 | |
|
|
854 | # calculate new after |
|
|
855 | $after = $self->{$timeout}; |
518 | } |
856 | } |
519 | |
857 | |
520 | # callback could have changed timeout value, optimise |
858 | Scalar::Util::weaken $self; |
521 | return unless $self->{timeout}; |
859 | return unless $self; # ->error could have destroyed $self |
522 | |
860 | |
523 | # calculate new after |
861 | $self->{$tw} ||= AE::timer $after, 0, sub { |
524 | $after = $self->{timeout}; |
862 | delete $self->{$tw}; |
|
|
863 | $cb->($self); |
|
|
864 | }; |
|
|
865 | } else { |
|
|
866 | delete $self->{$tw}; |
525 | } |
867 | } |
526 | |
|
|
527 | Scalar::Util::weaken $self; |
|
|
528 | return unless $self; # ->error could have destroyed $self |
|
|
529 | |
|
|
530 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
|
|
531 | delete $self->{_tw}; |
|
|
532 | $self->_timeout; |
|
|
533 | }); |
|
|
534 | } else { |
|
|
535 | delete $self->{_tw}; |
|
|
536 | } |
868 | } |
537 | } |
869 | } |
538 | |
870 | |
539 | ############################################################################# |
871 | ############################################################################# |
540 | |
872 | |
… | |
… | |
556 | =item $handle->on_drain ($cb) |
888 | =item $handle->on_drain ($cb) |
557 | |
889 | |
558 | Sets the C<on_drain> callback or clears it (see the description of |
890 | Sets the C<on_drain> callback or clears it (see the description of |
559 | C<on_drain> in the constructor). |
891 | C<on_drain> in the constructor). |
560 | |
892 | |
|
|
893 | This method may invoke callbacks (and therefore the handle might be |
|
|
894 | destroyed after it returns). |
|
|
895 | |
561 | =cut |
896 | =cut |
562 | |
897 | |
563 | sub on_drain { |
898 | sub on_drain { |
564 | my ($self, $cb) = @_; |
899 | my ($self, $cb) = @_; |
565 | |
900 | |
… | |
… | |
569 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
904 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
570 | } |
905 | } |
571 | |
906 | |
572 | =item $handle->push_write ($data) |
907 | =item $handle->push_write ($data) |
573 | |
908 | |
574 | Queues the given scalar to be written. You can push as much data as you |
909 | Queues the given scalar to be written. You can push as much data as |
575 | want (only limited by the available memory), as C<AnyEvent::Handle> |
910 | you want (only limited by the available memory and C<wbuf_max>), as |
576 | buffers it independently of the kernel. |
911 | C<AnyEvent::Handle> buffers it independently of the kernel. |
|
|
912 | |
|
|
913 | This method may invoke callbacks (and therefore the handle might be |
|
|
914 | destroyed after it returns). |
577 | |
915 | |
578 | =cut |
916 | =cut |
579 | |
917 | |
580 | sub _drain_wbuf { |
918 | sub _drain_wbuf { |
581 | my ($self) = @_; |
919 | my ($self) = @_; |
… | |
… | |
588 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
926 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
589 | |
927 | |
590 | if (defined $len) { |
928 | if (defined $len) { |
591 | substr $self->{wbuf}, 0, $len, ""; |
929 | substr $self->{wbuf}, 0, $len, ""; |
592 | |
930 | |
593 | $self->{_activity} = AnyEvent->now; |
931 | $self->{_activity} = $self->{_wactivity} = AE::now; |
594 | |
932 | |
595 | $self->{on_drain}($self) |
933 | $self->{on_drain}($self) |
596 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
934 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
597 | && $self->{on_drain}; |
935 | && $self->{on_drain}; |
598 | |
936 | |
… | |
… | |
604 | |
942 | |
605 | # try to write data immediately |
943 | # try to write data immediately |
606 | $cb->() unless $self->{autocork}; |
944 | $cb->() unless $self->{autocork}; |
607 | |
945 | |
608 | # if still data left in wbuf, we need to poll |
946 | # if still data left in wbuf, we need to poll |
609 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
947 | $self->{_ww} = AE::io $self->{fh}, 1, $cb |
610 | if length $self->{wbuf}; |
948 | if length $self->{wbuf}; |
|
|
949 | |
|
|
950 | if ( |
|
|
951 | defined $self->{wbuf_max} |
|
|
952 | && $self->{wbuf_max} < length $self->{wbuf} |
|
|
953 | ) { |
|
|
954 | $self->_error (Errno::ENOSPC, 1), return; |
|
|
955 | } |
611 | }; |
956 | }; |
612 | } |
957 | } |
613 | |
958 | |
614 | our %WH; |
959 | our %WH; |
615 | |
960 | |
|
|
961 | # deprecated |
616 | sub register_write_type($$) { |
962 | sub register_write_type($$) { |
617 | $WH{$_[0]} = $_[1]; |
963 | $WH{$_[0]} = $_[1]; |
618 | } |
964 | } |
619 | |
965 | |
620 | sub push_write { |
966 | sub push_write { |
621 | my $self = shift; |
967 | my $self = shift; |
622 | |
968 | |
623 | if (@_ > 1) { |
969 | if (@_ > 1) { |
624 | my $type = shift; |
970 | my $type = shift; |
625 | |
971 | |
|
|
972 | @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" |
626 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
973 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") |
627 | ->($self, @_); |
974 | ->($self, @_); |
628 | } |
975 | } |
629 | |
976 | |
|
|
977 | # we downgrade here to avoid hard-to-track-down bugs, |
|
|
978 | # and diagnose the problem earlier and better. |
|
|
979 | |
630 | if ($self->{tls}) { |
980 | if ($self->{tls}) { |
631 | $self->{_tls_wbuf} .= $_[0]; |
981 | utf8::downgrade $self->{_tls_wbuf} .= $_[0]; |
632 | |
982 | &_dotls ($self) if $self->{fh}; |
633 | &_dotls ($self); |
|
|
634 | } else { |
983 | } else { |
635 | $self->{wbuf} .= $_[0]; |
984 | utf8::downgrade $self->{wbuf} .= $_[0]; |
636 | $self->_drain_wbuf; |
985 | $self->_drain_wbuf if $self->{fh}; |
637 | } |
986 | } |
638 | } |
987 | } |
639 | |
988 | |
640 | =item $handle->push_write (type => @args) |
989 | =item $handle->push_write (type => @args) |
641 | |
990 | |
642 | Instead of formatting your data yourself, you can also let this module do |
991 | Instead of formatting your data yourself, you can also let this module |
643 | the job by specifying a type and type-specific arguments. |
992 | do the job by specifying a type and type-specific arguments. You |
|
|
993 | can also specify the (fully qualified) name of a package, in which |
|
|
994 | case AnyEvent tries to load the package and then expects to find the |
|
|
995 | C<anyevent_write_type> function inside (see "custom write types", below). |
644 | |
996 | |
645 | Predefined types are (if you have ideas for additional types, feel free to |
997 | Predefined types are (if you have ideas for additional types, feel free to |
646 | drop by and tell us): |
998 | drop by and tell us): |
647 | |
999 | |
648 | =over 4 |
1000 | =over 4 |
… | |
… | |
705 | Other languages could read single lines terminated by a newline and pass |
1057 | Other languages could read single lines terminated by a newline and pass |
706 | this line into their JSON decoder of choice. |
1058 | this line into their JSON decoder of choice. |
707 | |
1059 | |
708 | =cut |
1060 | =cut |
709 | |
1061 | |
|
|
1062 | sub json_coder() { |
|
|
1063 | eval { require JSON::XS; JSON::XS->new->utf8 } |
|
|
1064 | || do { require JSON; JSON->new->utf8 } |
|
|
1065 | } |
|
|
1066 | |
710 | register_write_type json => sub { |
1067 | register_write_type json => sub { |
711 | my ($self, $ref) = @_; |
1068 | my ($self, $ref) = @_; |
712 | |
1069 | |
713 | require JSON; |
1070 | my $json = $self->{json} ||= json_coder; |
714 | |
1071 | |
715 | $self->{json} ? $self->{json}->encode ($ref) |
1072 | $json->encode ($ref) |
716 | : JSON::encode_json ($ref) |
|
|
717 | }; |
1073 | }; |
718 | |
1074 | |
719 | =item storable => $reference |
1075 | =item storable => $reference |
720 | |
1076 | |
721 | Freezes the given reference using L<Storable> and writes it to the |
1077 | Freezes the given reference using L<Storable> and writes it to the |
… | |
… | |
739 | before it was actually written. One way to do that is to replace your |
1095 | before it was actually written. One way to do that is to replace your |
740 | C<on_drain> handler by a callback that shuts down the socket (and set |
1096 | C<on_drain> handler by a callback that shuts down the socket (and set |
741 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
1097 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
742 | replaces the C<on_drain> callback with: |
1098 | replaces the C<on_drain> callback with: |
743 | |
1099 | |
744 | sub { shutdown $_[0]{fh}, 1 } # for push_shutdown |
1100 | sub { shutdown $_[0]{fh}, 1 } |
745 | |
1101 | |
746 | This simply shuts down the write side and signals an EOF condition to the |
1102 | This simply shuts down the write side and signals an EOF condition to the |
747 | the peer. |
1103 | the peer. |
748 | |
1104 | |
749 | You can rely on the normal read queue and C<on_eof> handling |
1105 | You can rely on the normal read queue and C<on_eof> handling |
750 | afterwards. This is the cleanest way to close a connection. |
1106 | afterwards. This is the cleanest way to close a connection. |
751 | |
1107 | |
|
|
1108 | This method may invoke callbacks (and therefore the handle might be |
|
|
1109 | destroyed after it returns). |
|
|
1110 | |
752 | =cut |
1111 | =cut |
753 | |
1112 | |
754 | sub push_shutdown { |
1113 | sub push_shutdown { |
755 | my ($self) = @_; |
1114 | my ($self) = @_; |
756 | |
1115 | |
757 | delete $self->{low_water_mark}; |
1116 | delete $self->{low_water_mark}; |
758 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
1117 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
759 | } |
1118 | } |
760 | |
1119 | |
761 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
1120 | =item custom write types - Package::anyevent_write_type $handle, @args |
762 | |
1121 | |
763 | This function (not method) lets you add your own types to C<push_write>. |
1122 | Instead of one of the predefined types, you can also specify the name of |
|
|
1123 | a package. AnyEvent will try to load the package and then expects to find |
|
|
1124 | a function named C<anyevent_write_type> inside. If it isn't found, it |
|
|
1125 | progressively tries to load the parent package until it either finds the |
|
|
1126 | function (good) or runs out of packages (bad). |
|
|
1127 | |
764 | Whenever the given C<type> is used, C<push_write> will invoke the code |
1128 | Whenever the given C<type> is used, C<push_write> will the function with |
765 | reference with the handle object and the remaining arguments. |
1129 | the handle object and the remaining arguments. |
766 | |
1130 | |
767 | The code reference is supposed to return a single octet string that will |
1131 | The function is supposed to return a single octet string that will be |
768 | be appended to the write buffer. |
1132 | appended to the write buffer, so you cna mentally treat this function as a |
|
|
1133 | "arguments to on-the-wire-format" converter. |
769 | |
1134 | |
770 | Note that this is a function, and all types registered this way will be |
1135 | Example: implement a custom write type C<join> that joins the remaining |
771 | global, so try to use unique names. |
1136 | arguments using the first one. |
|
|
1137 | |
|
|
1138 | $handle->push_write (My::Type => " ", 1,2,3); |
|
|
1139 | |
|
|
1140 | # uses the following package, which can be defined in the "My::Type" or in |
|
|
1141 | # the "My" modules to be auto-loaded, or just about anywhere when the |
|
|
1142 | # My::Type::anyevent_write_type is defined before invoking it. |
|
|
1143 | |
|
|
1144 | package My::Type; |
|
|
1145 | |
|
|
1146 | sub anyevent_write_type { |
|
|
1147 | my ($handle, $delim, @args) = @_; |
|
|
1148 | |
|
|
1149 | join $delim, @args |
|
|
1150 | } |
772 | |
1151 | |
773 | =cut |
1152 | =cut |
774 | |
1153 | |
775 | ############################################################################# |
1154 | ############################################################################# |
776 | |
1155 | |
… | |
… | |
785 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1164 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
786 | a queue. |
1165 | a queue. |
787 | |
1166 | |
788 | In the simple case, you just install an C<on_read> callback and whenever |
1167 | In the simple case, you just install an C<on_read> callback and whenever |
789 | new data arrives, it will be called. You can then remove some data (if |
1168 | new data arrives, it will be called. You can then remove some data (if |
790 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
1169 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can |
791 | leave the data there if you want to accumulate more (e.g. when only a |
1170 | leave the data there if you want to accumulate more (e.g. when only a |
792 | partial message has been received so far). |
1171 | partial message has been received so far), or change the read queue with |
|
|
1172 | e.g. C<push_read>. |
793 | |
1173 | |
794 | In the more complex case, you want to queue multiple callbacks. In this |
1174 | In the more complex case, you want to queue multiple callbacks. In this |
795 | case, AnyEvent::Handle will call the first queued callback each time new |
1175 | case, AnyEvent::Handle will call the first queued callback each time new |
796 | data arrives (also the first time it is queued) and removes it when it has |
1176 | data arrives (also the first time it is queued) and remove it when it has |
797 | done its job (see C<push_read>, below). |
1177 | done its job (see C<push_read>, below). |
798 | |
1178 | |
799 | This way you can, for example, push three line-reads, followed by reading |
1179 | This way you can, for example, push three line-reads, followed by reading |
800 | a chunk of data, and AnyEvent::Handle will execute them in order. |
1180 | a chunk of data, and AnyEvent::Handle will execute them in order. |
801 | |
1181 | |
… | |
… | |
858 | =cut |
1238 | =cut |
859 | |
1239 | |
860 | sub _drain_rbuf { |
1240 | sub _drain_rbuf { |
861 | my ($self) = @_; |
1241 | my ($self) = @_; |
862 | |
1242 | |
|
|
1243 | # avoid recursion |
|
|
1244 | return if $self->{_skip_drain_rbuf}; |
863 | local $self->{_in_drain} = 1; |
1245 | local $self->{_skip_drain_rbuf} = 1; |
864 | |
|
|
865 | if ( |
|
|
866 | defined $self->{rbuf_max} |
|
|
867 | && $self->{rbuf_max} < length $self->{rbuf} |
|
|
868 | ) { |
|
|
869 | $self->_error (&Errno::ENOSPC, 1), return; |
|
|
870 | } |
|
|
871 | |
1246 | |
872 | while () { |
1247 | while () { |
873 | # we need to use a separate tls read buffer, as we must not receive data while |
1248 | # we need to use a separate tls read buffer, as we must not receive data while |
874 | # we are draining the buffer, and this can only happen with TLS. |
1249 | # we are draining the buffer, and this can only happen with TLS. |
875 | $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf}; |
1250 | $self->{rbuf} .= delete $self->{_tls_rbuf} |
|
|
1251 | if exists $self->{_tls_rbuf}; |
876 | |
1252 | |
877 | my $len = length $self->{rbuf}; |
1253 | my $len = length $self->{rbuf}; |
878 | |
1254 | |
879 | if (my $cb = shift @{ $self->{_queue} }) { |
1255 | if (my $cb = shift @{ $self->{_queue} }) { |
880 | unless ($cb->($self)) { |
1256 | unless ($cb->($self)) { |
881 | if ($self->{_eof}) { |
1257 | # no progress can be made |
882 | # no progress can be made (not enough data and no data forthcoming) |
1258 | # (not enough data and no data forthcoming) |
883 | $self->_error (&Errno::EPIPE, 1), return; |
1259 | $self->_error (Errno::EPIPE, 1), return |
884 | } |
1260 | if $self->{_eof}; |
885 | |
1261 | |
886 | unshift @{ $self->{_queue} }, $cb; |
1262 | unshift @{ $self->{_queue} }, $cb; |
887 | last; |
1263 | last; |
888 | } |
1264 | } |
889 | } elsif ($self->{on_read}) { |
1265 | } elsif ($self->{on_read}) { |
… | |
… | |
896 | && !@{ $self->{_queue} } # and the queue is still empty |
1272 | && !@{ $self->{_queue} } # and the queue is still empty |
897 | && $self->{on_read} # but we still have on_read |
1273 | && $self->{on_read} # but we still have on_read |
898 | ) { |
1274 | ) { |
899 | # no further data will arrive |
1275 | # no further data will arrive |
900 | # so no progress can be made |
1276 | # so no progress can be made |
901 | $self->_error (&Errno::EPIPE, 1), return |
1277 | $self->_error (Errno::EPIPE, 1), return |
902 | if $self->{_eof}; |
1278 | if $self->{_eof}; |
903 | |
1279 | |
904 | last; # more data might arrive |
1280 | last; # more data might arrive |
905 | } |
1281 | } |
906 | } else { |
1282 | } else { |
… | |
… | |
909 | last; |
1285 | last; |
910 | } |
1286 | } |
911 | } |
1287 | } |
912 | |
1288 | |
913 | if ($self->{_eof}) { |
1289 | if ($self->{_eof}) { |
914 | if ($self->{on_eof}) { |
1290 | $self->{on_eof} |
915 | $self->{on_eof}($self) |
1291 | ? $self->{on_eof}($self) |
916 | } else { |
|
|
917 | $self->_error (0, 1, "Unexpected end-of-file"); |
1292 | : $self->_error (0, 1, "Unexpected end-of-file"); |
918 | } |
1293 | |
|
|
1294 | return; |
|
|
1295 | } |
|
|
1296 | |
|
|
1297 | if ( |
|
|
1298 | defined $self->{rbuf_max} |
|
|
1299 | && $self->{rbuf_max} < length $self->{rbuf} |
|
|
1300 | ) { |
|
|
1301 | $self->_error (Errno::ENOSPC, 1), return; |
919 | } |
1302 | } |
920 | |
1303 | |
921 | # may need to restart read watcher |
1304 | # may need to restart read watcher |
922 | unless ($self->{_rw}) { |
1305 | unless ($self->{_rw}) { |
923 | $self->start_read |
1306 | $self->start_read |
… | |
… | |
929 | |
1312 | |
930 | This replaces the currently set C<on_read> callback, or clears it (when |
1313 | This replaces the currently set C<on_read> callback, or clears it (when |
931 | the new callback is C<undef>). See the description of C<on_read> in the |
1314 | the new callback is C<undef>). See the description of C<on_read> in the |
932 | constructor. |
1315 | constructor. |
933 | |
1316 | |
|
|
1317 | This method may invoke callbacks (and therefore the handle might be |
|
|
1318 | destroyed after it returns). |
|
|
1319 | |
934 | =cut |
1320 | =cut |
935 | |
1321 | |
936 | sub on_read { |
1322 | sub on_read { |
937 | my ($self, $cb) = @_; |
1323 | my ($self, $cb) = @_; |
938 | |
1324 | |
939 | $self->{on_read} = $cb; |
1325 | $self->{on_read} = $cb; |
940 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
1326 | $self->_drain_rbuf if $cb; |
941 | } |
1327 | } |
942 | |
1328 | |
943 | =item $handle->rbuf |
1329 | =item $handle->rbuf |
944 | |
1330 | |
945 | Returns the read buffer (as a modifiable lvalue). |
1331 | Returns the read buffer (as a modifiable lvalue). You can also access the |
|
|
1332 | read buffer directly as the C<< ->{rbuf} >> member, if you want (this is |
|
|
1333 | much faster, and no less clean). |
946 | |
1334 | |
947 | You can access the read buffer directly as the C<< ->{rbuf} >> |
1335 | The only operation allowed on the read buffer (apart from looking at it) |
948 | member, if you want. However, the only operation allowed on the |
1336 | is removing data from its beginning. Otherwise modifying or appending to |
949 | read buffer (apart from looking at it) is removing data from its |
1337 | it is not allowed and will lead to hard-to-track-down bugs. |
950 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
951 | lead to hard-to-track-down bugs. |
|
|
952 | |
1338 | |
953 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
1339 | NOTE: The read buffer should only be used or modified in the C<on_read> |
954 | C<push_read> or C<unshift_read> methods are used. The other read methods |
1340 | callback or when C<push_read> or C<unshift_read> are used with a single |
955 | automatically manage the read buffer. |
1341 | callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods |
|
|
1342 | will manage the read buffer on their own. |
956 | |
1343 | |
957 | =cut |
1344 | =cut |
958 | |
1345 | |
959 | sub rbuf : lvalue { |
1346 | sub rbuf : lvalue { |
960 | $_[0]{rbuf} |
1347 | $_[0]{rbuf} |
… | |
… | |
977 | |
1364 | |
978 | If enough data was available, then the callback must remove all data it is |
1365 | If enough data was available, then the callback must remove all data it is |
979 | interested in (which can be none at all) and return a true value. After returning |
1366 | interested in (which can be none at all) and return a true value. After returning |
980 | true, it will be removed from the queue. |
1367 | true, it will be removed from the queue. |
981 | |
1368 | |
|
|
1369 | These methods may invoke callbacks (and therefore the handle might be |
|
|
1370 | destroyed after it returns). |
|
|
1371 | |
982 | =cut |
1372 | =cut |
983 | |
1373 | |
984 | our %RH; |
1374 | our %RH; |
985 | |
1375 | |
986 | sub register_read_type($$) { |
1376 | sub register_read_type($$) { |
… | |
… | |
992 | my $cb = pop; |
1382 | my $cb = pop; |
993 | |
1383 | |
994 | if (@_) { |
1384 | if (@_) { |
995 | my $type = shift; |
1385 | my $type = shift; |
996 | |
1386 | |
|
|
1387 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
997 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
1388 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read") |
998 | ->($self, $cb, @_); |
1389 | ->($self, $cb, @_); |
999 | } |
1390 | } |
1000 | |
1391 | |
1001 | push @{ $self->{_queue} }, $cb; |
1392 | push @{ $self->{_queue} }, $cb; |
1002 | $self->_drain_rbuf unless $self->{_in_drain}; |
1393 | $self->_drain_rbuf; |
1003 | } |
1394 | } |
1004 | |
1395 | |
1005 | sub unshift_read { |
1396 | sub unshift_read { |
1006 | my $self = shift; |
1397 | my $self = shift; |
1007 | my $cb = pop; |
1398 | my $cb = pop; |
1008 | |
1399 | |
1009 | if (@_) { |
1400 | if (@_) { |
1010 | my $type = shift; |
1401 | my $type = shift; |
1011 | |
1402 | |
|
|
1403 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1012 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
1404 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read") |
1013 | ->($self, $cb, @_); |
1405 | ->($self, $cb, @_); |
1014 | } |
1406 | } |
1015 | |
1407 | |
1016 | |
|
|
1017 | unshift @{ $self->{_queue} }, $cb; |
1408 | unshift @{ $self->{_queue} }, $cb; |
1018 | $self->_drain_rbuf unless $self->{_in_drain}; |
1409 | $self->_drain_rbuf; |
1019 | } |
1410 | } |
1020 | |
1411 | |
1021 | =item $handle->push_read (type => @args, $cb) |
1412 | =item $handle->push_read (type => @args, $cb) |
1022 | |
1413 | |
1023 | =item $handle->unshift_read (type => @args, $cb) |
1414 | =item $handle->unshift_read (type => @args, $cb) |
1024 | |
1415 | |
1025 | Instead of providing a callback that parses the data itself you can chose |
1416 | Instead of providing a callback that parses the data itself you can chose |
1026 | between a number of predefined parsing formats, for chunks of data, lines |
1417 | between a number of predefined parsing formats, for chunks of data, lines |
1027 | etc. |
1418 | etc. You can also specify the (fully qualified) name of a package, in |
|
|
1419 | which case AnyEvent tries to load the package and then expects to find the |
|
|
1420 | C<anyevent_read_type> function inside (see "custom read types", below). |
1028 | |
1421 | |
1029 | Predefined types are (if you have ideas for additional types, feel free to |
1422 | Predefined types are (if you have ideas for additional types, feel free to |
1030 | drop by and tell us): |
1423 | drop by and tell us): |
1031 | |
1424 | |
1032 | =over 4 |
1425 | =over 4 |
… | |
… | |
1124 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1517 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1125 | and everything preceding and including the match will be accepted |
1518 | and everything preceding and including the match will be accepted |
1126 | unconditionally. This is useful to skip large amounts of data that you |
1519 | unconditionally. This is useful to skip large amounts of data that you |
1127 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1520 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1128 | have to start matching from the beginning. This is purely an optimisation |
1521 | have to start matching from the beginning. This is purely an optimisation |
1129 | and is usually worth only when you expect more than a few kilobytes. |
1522 | and is usually worth it only when you expect more than a few kilobytes. |
1130 | |
1523 | |
1131 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1524 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1132 | expect the header to be very large (it isn't in practise, but...), we use |
1525 | expect the header to be very large (it isn't in practice, but...), we use |
1133 | a skip regex to skip initial portions. The skip regex is tricky in that |
1526 | a skip regex to skip initial portions. The skip regex is tricky in that |
1134 | it only accepts something not ending in either \015 or \012, as these are |
1527 | it only accepts something not ending in either \015 or \012, as these are |
1135 | required for the accept regex. |
1528 | required for the accept regex. |
1136 | |
1529 | |
1137 | $handle->push_read (regex => |
1530 | $handle->push_read (regex => |
… | |
… | |
1156 | return 1; |
1549 | return 1; |
1157 | } |
1550 | } |
1158 | |
1551 | |
1159 | # reject |
1552 | # reject |
1160 | if ($reject && $$rbuf =~ $reject) { |
1553 | if ($reject && $$rbuf =~ $reject) { |
1161 | $self->_error (&Errno::EBADMSG); |
1554 | $self->_error (Errno::EBADMSG); |
1162 | } |
1555 | } |
1163 | |
1556 | |
1164 | # skip |
1557 | # skip |
1165 | if ($skip && $$rbuf =~ $skip) { |
1558 | if ($skip && $$rbuf =~ $skip) { |
1166 | $data .= substr $$rbuf, 0, $+[0], ""; |
1559 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
1182 | my ($self, $cb) = @_; |
1575 | my ($self, $cb) = @_; |
1183 | |
1576 | |
1184 | sub { |
1577 | sub { |
1185 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1578 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1186 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1579 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1187 | $self->_error (&Errno::EBADMSG); |
1580 | $self->_error (Errno::EBADMSG); |
1188 | } |
1581 | } |
1189 | return; |
1582 | return; |
1190 | } |
1583 | } |
1191 | |
1584 | |
1192 | my $len = $1; |
1585 | my $len = $1; |
… | |
… | |
1195 | my $string = $_[1]; |
1588 | my $string = $_[1]; |
1196 | $_[0]->unshift_read (chunk => 1, sub { |
1589 | $_[0]->unshift_read (chunk => 1, sub { |
1197 | if ($_[1] eq ",") { |
1590 | if ($_[1] eq ",") { |
1198 | $cb->($_[0], $string); |
1591 | $cb->($_[0], $string); |
1199 | } else { |
1592 | } else { |
1200 | $self->_error (&Errno::EBADMSG); |
1593 | $self->_error (Errno::EBADMSG); |
1201 | } |
1594 | } |
1202 | }); |
1595 | }); |
1203 | }); |
1596 | }); |
1204 | |
1597 | |
1205 | 1 |
1598 | 1 |
… | |
… | |
1272 | =cut |
1665 | =cut |
1273 | |
1666 | |
1274 | register_read_type json => sub { |
1667 | register_read_type json => sub { |
1275 | my ($self, $cb) = @_; |
1668 | my ($self, $cb) = @_; |
1276 | |
1669 | |
1277 | my $json = $self->{json} ||= |
1670 | my $json = $self->{json} ||= json_coder; |
1278 | eval { require JSON::XS; JSON::XS->new->utf8 } |
|
|
1279 | || do { require JSON; JSON->new->utf8 }; |
|
|
1280 | |
1671 | |
1281 | my $data; |
1672 | my $data; |
1282 | my $rbuf = \$self->{rbuf}; |
1673 | my $rbuf = \$self->{rbuf}; |
1283 | |
1674 | |
1284 | sub { |
1675 | sub { |
… | |
… | |
1295 | $json->incr_skip; |
1686 | $json->incr_skip; |
1296 | |
1687 | |
1297 | $self->{rbuf} = $json->incr_text; |
1688 | $self->{rbuf} = $json->incr_text; |
1298 | $json->incr_text = ""; |
1689 | $json->incr_text = ""; |
1299 | |
1690 | |
1300 | $self->_error (&Errno::EBADMSG); |
1691 | $self->_error (Errno::EBADMSG); |
1301 | |
1692 | |
1302 | () |
1693 | () |
1303 | } else { |
1694 | } else { |
1304 | $self->{rbuf} = ""; |
1695 | $self->{rbuf} = ""; |
1305 | |
1696 | |
… | |
… | |
1342 | # read remaining chunk |
1733 | # read remaining chunk |
1343 | $_[0]->unshift_read (chunk => $len, sub { |
1734 | $_[0]->unshift_read (chunk => $len, sub { |
1344 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1735 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1345 | $cb->($_[0], $ref); |
1736 | $cb->($_[0], $ref); |
1346 | } else { |
1737 | } else { |
1347 | $self->_error (&Errno::EBADMSG); |
1738 | $self->_error (Errno::EBADMSG); |
1348 | } |
1739 | } |
1349 | }); |
1740 | }); |
1350 | } |
1741 | } |
1351 | |
1742 | |
1352 | 1 |
1743 | 1 |
1353 | } |
1744 | } |
1354 | }; |
1745 | }; |
1355 | |
1746 | |
1356 | =back |
1747 | =back |
1357 | |
1748 | |
1358 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1749 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
1359 | |
1750 | |
1360 | This function (not method) lets you add your own types to C<push_read>. |
1751 | Instead of one of the predefined types, you can also specify the name |
|
|
1752 | of a package. AnyEvent will try to load the package and then expects to |
|
|
1753 | find a function named C<anyevent_read_type> inside. If it isn't found, it |
|
|
1754 | progressively tries to load the parent package until it either finds the |
|
|
1755 | function (good) or runs out of packages (bad). |
1361 | |
1756 | |
1362 | Whenever the given C<type> is used, C<push_read> will invoke the code |
1757 | Whenever this type is used, C<push_read> will invoke the function with the |
1363 | reference with the handle object, the callback and the remaining |
1758 | handle object, the original callback and the remaining arguments. |
1364 | arguments. |
|
|
1365 | |
1759 | |
1366 | The code reference is supposed to return a callback (usually a closure) |
1760 | The function is supposed to return a callback (usually a closure) that |
1367 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
1761 | works as a plain read callback (see C<< ->push_read ($cb) >>), so you can |
|
|
1762 | mentally treat the function as a "configurable read type to read callback" |
|
|
1763 | converter. |
1368 | |
1764 | |
1369 | It should invoke the passed callback when it is done reading (remember to |
1765 | It should invoke the original callback when it is done reading (remember |
1370 | pass C<$handle> as first argument as all other callbacks do that). |
1766 | to pass C<$handle> as first argument as all other callbacks do that, |
|
|
1767 | although there is no strict requirement on this). |
1371 | |
1768 | |
1372 | Note that this is a function, and all types registered this way will be |
|
|
1373 | global, so try to use unique names. |
|
|
1374 | |
|
|
1375 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
1769 | For examples, see the source of this module (F<perldoc -m |
1376 | search for C<register_read_type>)). |
1770 | AnyEvent::Handle>, search for C<register_read_type>)). |
1377 | |
1771 | |
1378 | =item $handle->stop_read |
1772 | =item $handle->stop_read |
1379 | |
1773 | |
1380 | =item $handle->start_read |
1774 | =item $handle->start_read |
1381 | |
1775 | |
… | |
… | |
1387 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1781 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1388 | you change the C<on_read> callback or push/unshift a read callback, and it |
1782 | you change the C<on_read> callback or push/unshift a read callback, and it |
1389 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1783 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1390 | there are any read requests in the queue. |
1784 | there are any read requests in the queue. |
1391 | |
1785 | |
1392 | These methods will have no effect when in TLS mode (as TLS doesn't support |
1786 | In older versions of this module (<= 5.3), these methods had no effect, |
1393 | half-duplex connections). |
1787 | as TLS does not support half-duplex connections. In current versions they |
|
|
1788 | work as expected, as this behaviour is required to avoid certain resource |
|
|
1789 | attacks, where the program would be forced to read (and buffer) arbitrary |
|
|
1790 | amounts of data before being able to send some data. The drawback is that |
|
|
1791 | some readings of the the SSL/TLS specifications basically require this |
|
|
1792 | attack to be working, as SSL/TLS implementations might stall sending data |
|
|
1793 | during a rehandshake. |
|
|
1794 | |
|
|
1795 | As a guideline, during the initial handshake, you should not stop reading, |
|
|
1796 | and as a client, it might cause problems, depending on your applciation. |
1394 | |
1797 | |
1395 | =cut |
1798 | =cut |
1396 | |
1799 | |
1397 | sub stop_read { |
1800 | sub stop_read { |
1398 | my ($self) = @_; |
1801 | my ($self) = @_; |
1399 | |
1802 | |
1400 | delete $self->{_rw} unless $self->{tls}; |
1803 | delete $self->{_rw}; |
1401 | } |
1804 | } |
1402 | |
1805 | |
1403 | sub start_read { |
1806 | sub start_read { |
1404 | my ($self) = @_; |
1807 | my ($self) = @_; |
1405 | |
1808 | |
1406 | unless ($self->{_rw} || $self->{_eof}) { |
1809 | unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) { |
1407 | Scalar::Util::weaken $self; |
1810 | Scalar::Util::weaken $self; |
1408 | |
1811 | |
1409 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1812 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1410 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1813 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1411 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1814 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf; |
1412 | |
1815 | |
1413 | if ($len > 0) { |
1816 | if ($len > 0) { |
1414 | $self->{_activity} = AnyEvent->now; |
1817 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1415 | |
1818 | |
1416 | if ($self->{tls}) { |
1819 | if ($self->{tls}) { |
1417 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1820 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1418 | |
1821 | |
1419 | &_dotls ($self); |
1822 | &_dotls ($self); |
1420 | } else { |
1823 | } else { |
1421 | $self->_drain_rbuf unless $self->{_in_drain}; |
1824 | $self->_drain_rbuf; |
|
|
1825 | } |
|
|
1826 | |
|
|
1827 | if ($len == $self->{read_size}) { |
|
|
1828 | $self->{read_size} *= 2; |
|
|
1829 | $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE |
|
|
1830 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
1422 | } |
1831 | } |
1423 | |
1832 | |
1424 | } elsif (defined $len) { |
1833 | } elsif (defined $len) { |
1425 | delete $self->{_rw}; |
1834 | delete $self->{_rw}; |
1426 | $self->{_eof} = 1; |
1835 | $self->{_eof} = 1; |
1427 | $self->_drain_rbuf unless $self->{_in_drain}; |
1836 | $self->_drain_rbuf; |
1428 | |
1837 | |
1429 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1838 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1430 | return $self->_error ($!, 1); |
1839 | return $self->_error ($!, 1); |
1431 | } |
1840 | } |
1432 | }); |
1841 | }; |
1433 | } |
1842 | } |
1434 | } |
1843 | } |
1435 | |
1844 | |
1436 | our $ERROR_SYSCALL; |
1845 | our $ERROR_SYSCALL; |
1437 | our $ERROR_WANT_READ; |
1846 | our $ERROR_WANT_READ; |
… | |
… | |
1450 | if ($self->{_on_starttls}) { |
1859 | if ($self->{_on_starttls}) { |
1451 | (delete $self->{_on_starttls})->($self, undef, $err); |
1860 | (delete $self->{_on_starttls})->($self, undef, $err); |
1452 | &_freetls; |
1861 | &_freetls; |
1453 | } else { |
1862 | } else { |
1454 | &_freetls; |
1863 | &_freetls; |
1455 | $self->_error (&Errno::EPROTO, 1, $err); |
1864 | $self->_error (Errno::EPROTO, 1, $err); |
1456 | } |
1865 | } |
1457 | } |
1866 | } |
1458 | |
1867 | |
1459 | # poll the write BIO and send the data if applicable |
1868 | # poll the write BIO and send the data if applicable |
1460 | # also decode read data if possible |
1869 | # also decode read data if possible |
… | |
… | |
1492 | $self->{_eof} = 1; |
1901 | $self->{_eof} = 1; |
1493 | } |
1902 | } |
1494 | } |
1903 | } |
1495 | |
1904 | |
1496 | $self->{_tls_rbuf} .= $tmp; |
1905 | $self->{_tls_rbuf} .= $tmp; |
1497 | $self->_drain_rbuf unless $self->{_in_drain}; |
1906 | $self->_drain_rbuf; |
1498 | $self->{tls} or return; # tls session might have gone away in callback |
1907 | $self->{tls} or return; # tls session might have gone away in callback |
1499 | } |
1908 | } |
1500 | |
1909 | |
1501 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1910 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1502 | return $self->_tls_error ($tmp) |
1911 | return $self->_tls_error ($tmp) |
… | |
… | |
1504 | && ($tmp != $ERROR_SYSCALL || $!); |
1913 | && ($tmp != $ERROR_SYSCALL || $!); |
1505 | |
1914 | |
1506 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1915 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1507 | $self->{wbuf} .= $tmp; |
1916 | $self->{wbuf} .= $tmp; |
1508 | $self->_drain_wbuf; |
1917 | $self->_drain_wbuf; |
|
|
1918 | $self->{tls} or return; # tls session might have gone away in callback |
1509 | } |
1919 | } |
1510 | |
1920 | |
1511 | $self->{_on_starttls} |
1921 | $self->{_on_starttls} |
1512 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1922 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1513 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
1923 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
… | |
… | |
1516 | =item $handle->starttls ($tls[, $tls_ctx]) |
1926 | =item $handle->starttls ($tls[, $tls_ctx]) |
1517 | |
1927 | |
1518 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1928 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1519 | object is created, you can also do that at a later time by calling |
1929 | object is created, you can also do that at a later time by calling |
1520 | C<starttls>. |
1930 | C<starttls>. |
|
|
1931 | |
|
|
1932 | Starting TLS is currently an asynchronous operation - when you push some |
|
|
1933 | write data and then call C<< ->starttls >> then TLS negotiation will start |
|
|
1934 | immediately, after which the queued write data is then sent. |
1521 | |
1935 | |
1522 | The first argument is the same as the C<tls> constructor argument (either |
1936 | The first argument is the same as the C<tls> constructor argument (either |
1523 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1937 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1524 | |
1938 | |
1525 | The second argument is the optional C<AnyEvent::TLS> object that is used |
1939 | The second argument is the optional C<AnyEvent::TLS> object that is used |
… | |
… | |
1530 | The TLS connection object will end up in C<< $handle->{tls} >>, the TLS |
1944 | The TLS connection object will end up in C<< $handle->{tls} >>, the TLS |
1531 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1945 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1532 | changed to your liking. Note that the handshake might have already started |
1946 | changed to your liking. Note that the handshake might have already started |
1533 | when this function returns. |
1947 | when this function returns. |
1534 | |
1948 | |
1535 | If it an error to start a TLS handshake more than once per |
1949 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1536 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
1950 | handshakes on the same stream. It is best to not attempt to use the |
|
|
1951 | stream after stopping TLS. |
|
|
1952 | |
|
|
1953 | This method may invoke callbacks (and therefore the handle might be |
|
|
1954 | destroyed after it returns). |
1537 | |
1955 | |
1538 | =cut |
1956 | =cut |
1539 | |
1957 | |
1540 | our %TLS_CACHE; #TODO not yet documented, should we? |
1958 | our %TLS_CACHE; #TODO not yet documented, should we? |
1541 | |
1959 | |
1542 | sub starttls { |
1960 | sub starttls { |
1543 | my ($self, $ssl, $ctx) = @_; |
1961 | my ($self, $tls, $ctx) = @_; |
|
|
1962 | |
|
|
1963 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
|
|
1964 | if $self->{tls}; |
|
|
1965 | |
|
|
1966 | $self->{tls} = $tls; |
|
|
1967 | $self->{tls_ctx} = $ctx if @_ > 2; |
|
|
1968 | |
|
|
1969 | return unless $self->{fh}; |
1544 | |
1970 | |
1545 | require Net::SSLeay; |
1971 | require Net::SSLeay; |
1546 | |
|
|
1547 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
|
|
1548 | if $self->{tls}; |
|
|
1549 | |
1972 | |
1550 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1973 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1551 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1974 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1552 | |
1975 | |
|
|
1976 | $tls = delete $self->{tls}; |
1553 | $ctx ||= $self->{tls_ctx}; |
1977 | $ctx = $self->{tls_ctx}; |
|
|
1978 | |
|
|
1979 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1554 | |
1980 | |
1555 | if ("HASH" eq ref $ctx) { |
1981 | if ("HASH" eq ref $ctx) { |
1556 | require AnyEvent::TLS; |
1982 | require AnyEvent::TLS; |
1557 | |
|
|
1558 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context |
|
|
1559 | |
1983 | |
1560 | if ($ctx->{cache}) { |
1984 | if ($ctx->{cache}) { |
1561 | my $key = $ctx+0; |
1985 | my $key = $ctx+0; |
1562 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
1986 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
1563 | } else { |
1987 | } else { |
1564 | $ctx = new AnyEvent::TLS %$ctx; |
1988 | $ctx = new AnyEvent::TLS %$ctx; |
1565 | } |
1989 | } |
1566 | } |
1990 | } |
1567 | |
1991 | |
1568 | $self->{tls_ctx} = $ctx || TLS_CTX (); |
1992 | $self->{tls_ctx} = $ctx || TLS_CTX (); |
1569 | $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername}); |
1993 | $self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername}); |
1570 | |
1994 | |
1571 | # basically, this is deep magic (because SSL_read should have the same issues) |
1995 | # basically, this is deep magic (because SSL_read should have the same issues) |
1572 | # but the openssl maintainers basically said: "trust us, it just works". |
1996 | # but the openssl maintainers basically said: "trust us, it just works". |
1573 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1997 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1574 | # and mismaintained ssleay-module doesn't even offer them). |
1998 | # and mismaintained ssleay-module doesn't even offer them). |
… | |
… | |
1581 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
2005 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
1582 | # have identity issues in that area. |
2006 | # have identity issues in that area. |
1583 | # Net::SSLeay::CTX_set_mode ($ssl, |
2007 | # Net::SSLeay::CTX_set_mode ($ssl, |
1584 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
2008 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1585 | # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
2009 | # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1586 | Net::SSLeay::CTX_set_mode ($ssl, 1|2); |
2010 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
1587 | |
2011 | |
1588 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2012 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1589 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2013 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1590 | |
2014 | |
|
|
2015 | Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); |
|
|
2016 | |
1591 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
2017 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
1592 | |
2018 | |
1593 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
2019 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
1594 | if $self->{on_starttls}; |
2020 | if $self->{on_starttls}; |
1595 | |
2021 | |
1596 | &_dotls; # need to trigger the initial handshake |
2022 | &_dotls; # need to trigger the initial handshake |
… | |
… | |
1599 | |
2025 | |
1600 | =item $handle->stoptls |
2026 | =item $handle->stoptls |
1601 | |
2027 | |
1602 | Shuts down the SSL connection - this makes a proper EOF handshake by |
2028 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1603 | sending a close notify to the other side, but since OpenSSL doesn't |
2029 | sending a close notify to the other side, but since OpenSSL doesn't |
1604 | support non-blocking shut downs, it is not possible to re-use the stream |
2030 | support non-blocking shut downs, it is not guaranteed that you can re-use |
1605 | afterwards. |
2031 | the stream afterwards. |
|
|
2032 | |
|
|
2033 | This method may invoke callbacks (and therefore the handle might be |
|
|
2034 | destroyed after it returns). |
1606 | |
2035 | |
1607 | =cut |
2036 | =cut |
1608 | |
2037 | |
1609 | sub stoptls { |
2038 | sub stoptls { |
1610 | my ($self) = @_; |
2039 | my ($self) = @_; |
1611 | |
2040 | |
1612 | if ($self->{tls}) { |
2041 | if ($self->{tls} && $self->{fh}) { |
1613 | Net::SSLeay::shutdown ($self->{tls}); |
2042 | Net::SSLeay::shutdown ($self->{tls}); |
1614 | |
2043 | |
1615 | &_dotls; |
2044 | &_dotls; |
1616 | |
2045 | |
1617 | # # we don't give a shit. no, we do, but we can't. no...#d# |
2046 | # # we don't give a shit. no, we do, but we can't. no...#d# |
… | |
… | |
1623 | sub _freetls { |
2052 | sub _freetls { |
1624 | my ($self) = @_; |
2053 | my ($self) = @_; |
1625 | |
2054 | |
1626 | return unless $self->{tls}; |
2055 | return unless $self->{tls}; |
1627 | |
2056 | |
1628 | $self->{tls_ctx}->_put_session (delete $self->{tls}); |
2057 | $self->{tls_ctx}->_put_session (delete $self->{tls}) |
|
|
2058 | if $self->{tls} > 0; |
1629 | |
2059 | |
1630 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
2060 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
1631 | } |
2061 | } |
1632 | |
2062 | |
|
|
2063 | =item $handle->resettls |
|
|
2064 | |
|
|
2065 | This rarely-used method simply resets and TLS state on the handle, usually |
|
|
2066 | causing data loss. |
|
|
2067 | |
|
|
2068 | One case where it may be useful is when you want to skip over the data in |
|
|
2069 | the stream but you are not interested in interpreting it, so data loss is |
|
|
2070 | no concern. |
|
|
2071 | |
|
|
2072 | =cut |
|
|
2073 | |
|
|
2074 | *resettls = \&_freetls; |
|
|
2075 | |
1633 | sub DESTROY { |
2076 | sub DESTROY { |
1634 | my ($self) = @_; |
2077 | my ($self) = @_; |
1635 | |
2078 | |
1636 | &_freetls; |
2079 | &_freetls; |
1637 | |
2080 | |
1638 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
2081 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1639 | |
2082 | |
1640 | if ($linger && length $self->{wbuf}) { |
2083 | if ($linger && length $self->{wbuf} && $self->{fh}) { |
1641 | my $fh = delete $self->{fh}; |
2084 | my $fh = delete $self->{fh}; |
1642 | my $wbuf = delete $self->{wbuf}; |
2085 | my $wbuf = delete $self->{wbuf}; |
1643 | |
2086 | |
1644 | my @linger; |
2087 | my @linger; |
1645 | |
2088 | |
1646 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
2089 | push @linger, AE::io $fh, 1, sub { |
1647 | my $len = syswrite $fh, $wbuf, length $wbuf; |
2090 | my $len = syswrite $fh, $wbuf, length $wbuf; |
1648 | |
2091 | |
1649 | if ($len > 0) { |
2092 | if ($len > 0) { |
1650 | substr $wbuf, 0, $len, ""; |
2093 | substr $wbuf, 0, $len, ""; |
1651 | } else { |
2094 | } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) { |
1652 | @linger = (); # end |
2095 | @linger = (); # end |
1653 | } |
2096 | } |
1654 | }); |
2097 | }; |
1655 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
2098 | push @linger, AE::timer $linger, 0, sub { |
1656 | @linger = (); |
2099 | @linger = (); |
1657 | }); |
2100 | }; |
1658 | } |
2101 | } |
1659 | } |
2102 | } |
1660 | |
2103 | |
1661 | =item $handle->destroy |
2104 | =item $handle->destroy |
1662 | |
2105 | |
1663 | Shuts down the handle object as much as possible - this call ensures that |
2106 | Shuts down the handle object as much as possible - this call ensures that |
1664 | no further callbacks will be invoked and as many resources as possible |
2107 | no further callbacks will be invoked and as many resources as possible |
1665 | will be freed. You must not call any methods on the object afterwards. |
2108 | will be freed. Any method you will call on the handle object after |
|
|
2109 | destroying it in this way will be silently ignored (and it will return the |
|
|
2110 | empty list). |
1666 | |
2111 | |
1667 | Normally, you can just "forget" any references to an AnyEvent::Handle |
2112 | Normally, you can just "forget" any references to an AnyEvent::Handle |
1668 | object and it will simply shut down. This works in fatal error and EOF |
2113 | object and it will simply shut down. This works in fatal error and EOF |
1669 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
2114 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
1670 | callback, so when you want to destroy the AnyEvent::Handle object from |
2115 | callback, so when you want to destroy the AnyEvent::Handle object from |
… | |
… | |
1684 | sub destroy { |
2129 | sub destroy { |
1685 | my ($self) = @_; |
2130 | my ($self) = @_; |
1686 | |
2131 | |
1687 | $self->DESTROY; |
2132 | $self->DESTROY; |
1688 | %$self = (); |
2133 | %$self = (); |
|
|
2134 | bless $self, "AnyEvent::Handle::destroyed"; |
1689 | } |
2135 | } |
|
|
2136 | |
|
|
2137 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
|
|
2138 | #nop |
|
|
2139 | } |
|
|
2140 | |
|
|
2141 | =item $handle->destroyed |
|
|
2142 | |
|
|
2143 | Returns false as long as the handle hasn't been destroyed by a call to C<< |
|
|
2144 | ->destroy >>, true otherwise. |
|
|
2145 | |
|
|
2146 | Can be useful to decide whether the handle is still valid after some |
|
|
2147 | callback possibly destroyed the handle. For example, C<< ->push_write >>, |
|
|
2148 | C<< ->starttls >> and other methods can call user callbacks, which in turn |
|
|
2149 | can destroy the handle, so work can be avoided by checking sometimes: |
|
|
2150 | |
|
|
2151 | $hdl->starttls ("accept"); |
|
|
2152 | return if $hdl->destroyed; |
|
|
2153 | $hdl->push_write (... |
|
|
2154 | |
|
|
2155 | Note that the call to C<push_write> will silently be ignored if the handle |
|
|
2156 | has been destroyed, so often you can just ignore the possibility of the |
|
|
2157 | handle being destroyed. |
|
|
2158 | |
|
|
2159 | =cut |
|
|
2160 | |
|
|
2161 | sub destroyed { 0 } |
|
|
2162 | sub AnyEvent::Handle::destroyed::destroyed { 1 } |
1690 | |
2163 | |
1691 | =item AnyEvent::Handle::TLS_CTX |
2164 | =item AnyEvent::Handle::TLS_CTX |
1692 | |
2165 | |
1693 | This function creates and returns the AnyEvent::TLS object used by default |
2166 | This function creates and returns the AnyEvent::TLS object used by default |
1694 | for TLS mode. |
2167 | for TLS mode. |
… | |
… | |
1722 | |
2195 | |
1723 | It is only safe to "forget" the reference inside EOF or error callbacks, |
2196 | It is only safe to "forget" the reference inside EOF or error callbacks, |
1724 | from within all other callbacks, you need to explicitly call the C<< |
2197 | from within all other callbacks, you need to explicitly call the C<< |
1725 | ->destroy >> method. |
2198 | ->destroy >> method. |
1726 | |
2199 | |
|
|
2200 | =item Why is my C<on_eof> callback never called? |
|
|
2201 | |
|
|
2202 | Probably because your C<on_error> callback is being called instead: When |
|
|
2203 | you have outstanding requests in your read queue, then an EOF is |
|
|
2204 | considered an error as you clearly expected some data. |
|
|
2205 | |
|
|
2206 | To avoid this, make sure you have an empty read queue whenever your handle |
|
|
2207 | is supposed to be "idle" (i.e. connection closes are O.K.). You cna set |
|
|
2208 | an C<on_read> handler that simply pushes the first read requests in the |
|
|
2209 | queue. |
|
|
2210 | |
|
|
2211 | See also the next question, which explains this in a bit more detail. |
|
|
2212 | |
|
|
2213 | =item How can I serve requests in a loop? |
|
|
2214 | |
|
|
2215 | Most protocols consist of some setup phase (authentication for example) |
|
|
2216 | followed by a request handling phase, where the server waits for requests |
|
|
2217 | and handles them, in a loop. |
|
|
2218 | |
|
|
2219 | There are two important variants: The first (traditional, better) variant |
|
|
2220 | handles requests until the server gets some QUIT command, causing it to |
|
|
2221 | close the connection first (highly desirable for a busy TCP server). A |
|
|
2222 | client dropping the connection is an error, which means this variant can |
|
|
2223 | detect an unexpected detection close. |
|
|
2224 | |
|
|
2225 | To handle this case, always make sure you have a on-empty read queue, by |
|
|
2226 | pushing the "read request start" handler on it: |
|
|
2227 | |
|
|
2228 | # we assume a request starts with a single line |
|
|
2229 | my @start_request; @start_request = (line => sub { |
|
|
2230 | my ($hdl, $line) = @_; |
|
|
2231 | |
|
|
2232 | ... handle request |
|
|
2233 | |
|
|
2234 | # push next request read, possibly from a nested callback |
|
|
2235 | $hdl->push_read (@start_request); |
|
|
2236 | }); |
|
|
2237 | |
|
|
2238 | # auth done, now go into request handling loop |
|
|
2239 | # now push the first @start_request |
|
|
2240 | $hdl->push_read (@start_request); |
|
|
2241 | |
|
|
2242 | By always having an outstanding C<push_read>, the handle always expects |
|
|
2243 | some data and raises the C<EPIPE> error when the connction is dropped |
|
|
2244 | unexpectedly. |
|
|
2245 | |
|
|
2246 | The second variant is a protocol where the client can drop the connection |
|
|
2247 | at any time. For TCP, this means that the server machine may run out of |
|
|
2248 | sockets easier, and in general, it means you cnanot distinguish a protocl |
|
|
2249 | failure/client crash from a normal connection close. Nevertheless, these |
|
|
2250 | kinds of protocols are common (and sometimes even the best solution to the |
|
|
2251 | problem). |
|
|
2252 | |
|
|
2253 | Having an outstanding read request at all times is possible if you ignore |
|
|
2254 | C<EPIPE> errors, but this doesn't help with when the client drops the |
|
|
2255 | connection during a request, which would still be an error. |
|
|
2256 | |
|
|
2257 | A better solution is to push the initial request read in an C<on_read> |
|
|
2258 | callback. This avoids an error, as when the server doesn't expect data |
|
|
2259 | (i.e. is idly waiting for the next request, an EOF will not raise an |
|
|
2260 | error, but simply result in an C<on_eof> callback. It is also a bit slower |
|
|
2261 | and simpler: |
|
|
2262 | |
|
|
2263 | # auth done, now go into request handling loop |
|
|
2264 | $hdl->on_read (sub { |
|
|
2265 | my ($hdl) = @_; |
|
|
2266 | |
|
|
2267 | # called each time we receive data but the read queue is empty |
|
|
2268 | # simply start read the request |
|
|
2269 | |
|
|
2270 | $hdl->push_read (line => sub { |
|
|
2271 | my ($hdl, $line) = @_; |
|
|
2272 | |
|
|
2273 | ... handle request |
|
|
2274 | |
|
|
2275 | # do nothing special when the request has been handled, just |
|
|
2276 | # let the request queue go empty. |
|
|
2277 | }); |
|
|
2278 | }); |
|
|
2279 | |
1727 | =item I get different callback invocations in TLS mode/Why can't I pause |
2280 | =item I get different callback invocations in TLS mode/Why can't I pause |
1728 | reading? |
2281 | reading? |
1729 | |
2282 | |
1730 | Unlike, say, TCP, TLS connections do not consist of two independent |
2283 | Unlike, say, TCP, TLS connections do not consist of two independent |
1731 | communication channels, one for each direction. Or put differently. The |
2284 | communication channels, one for each direction. Or put differently, the |
1732 | read and write directions are not independent of each other: you cannot |
2285 | read and write directions are not independent of each other: you cannot |
1733 | write data unless you are also prepared to read, and vice versa. |
2286 | write data unless you are also prepared to read, and vice versa. |
1734 | |
2287 | |
1735 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
2288 | This means that, in TLS mode, you might get C<on_error> or C<on_eof> |
1736 | callback invocations when you are not expecting any read data - the reason |
2289 | callback invocations when you are not expecting any read data - the reason |
1737 | is that AnyEvent::Handle always reads in TLS mode. |
2290 | is that AnyEvent::Handle always reads in TLS mode. |
1738 | |
2291 | |
1739 | During the connection, you have to make sure that you always have a |
2292 | During the connection, you have to make sure that you always have a |
1740 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
2293 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
… | |
… | |
1754 | my $data = delete $_[0]{rbuf}; |
2307 | my $data = delete $_[0]{rbuf}; |
1755 | }); |
2308 | }); |
1756 | |
2309 | |
1757 | The reason to use C<on_error> is that TCP connections, due to latencies |
2310 | The reason to use C<on_error> is that TCP connections, due to latencies |
1758 | and packets loss, might get closed quite violently with an error, when in |
2311 | and packets loss, might get closed quite violently with an error, when in |
1759 | fact, all data has been received. |
2312 | fact all data has been received. |
1760 | |
2313 | |
1761 | It is usually better to use acknowledgements when transferring data, |
2314 | It is usually better to use acknowledgements when transferring data, |
1762 | to make sure the other side hasn't just died and you got the data |
2315 | to make sure the other side hasn't just died and you got the data |
1763 | intact. This is also one reason why so many internet protocols have an |
2316 | intact. This is also one reason why so many internet protocols have an |
1764 | explicit QUIT command. |
2317 | explicit QUIT command. |
… | |
… | |
1781 | consider using C<< ->push_shutdown >> instead. |
2334 | consider using C<< ->push_shutdown >> instead. |
1782 | |
2335 | |
1783 | =item I want to contact a TLS/SSL server, I don't care about security. |
2336 | =item I want to contact a TLS/SSL server, I don't care about security. |
1784 | |
2337 | |
1785 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2338 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
1786 | simply connect to it and then create the AnyEvent::Handle with the C<tls> |
2339 | connect to it and then create the AnyEvent::Handle with the C<tls> |
1787 | parameter: |
2340 | parameter: |
1788 | |
2341 | |
1789 | tcp_connect $host, $port, sub { |
2342 | tcp_connect $host, $port, sub { |
1790 | my ($fh) = @_; |
2343 | my ($fh) = @_; |
1791 | |
2344 | |
… | |
… | |
1891 | |
2444 | |
1892 | =item * all members not documented here and not prefixed with an underscore |
2445 | =item * all members not documented here and not prefixed with an underscore |
1893 | are free to use in subclasses. |
2446 | are free to use in subclasses. |
1894 | |
2447 | |
1895 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2448 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
1896 | member variables, but thats just life, at least it is documented. |
2449 | member variables, but that's just life. At least it is documented. |
1897 | |
2450 | |
1898 | =back |
2451 | =back |
1899 | |
2452 | |
1900 | =head1 AUTHOR |
2453 | =head1 AUTHOR |
1901 | |
2454 | |