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.452; |
|
|
20 | |
4 | |
21 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
22 | |
6 | |
23 | use AnyEvent; |
7 | use AnyEvent; |
24 | use AnyEvent::Handle; |
8 | use AnyEvent::Handle; |
25 | |
9 | |
26 | my $cv = AnyEvent->condvar; |
10 | my $cv = AnyEvent->condvar; |
27 | |
11 | |
28 | my $handle = |
12 | my $hdl; $hdl = new AnyEvent::Handle |
29 | AnyEvent::Handle->new ( |
|
|
30 | fh => \*STDIN, |
13 | fh => \*STDIN, |
31 | on_eof => sub { |
14 | on_error => sub { |
|
|
15 | my ($hdl, $fatal, $msg) = @_; |
|
|
16 | AE::log error => $msg; |
|
|
17 | $hdl->destroy; |
32 | $cv->send; |
18 | $cv->send; |
33 | }, |
|
|
34 | ); |
19 | }; |
35 | |
20 | |
36 | # send some request line |
21 | # send some request line |
37 | $handle->push_write ("getinfo\015\012"); |
22 | $hdl->push_write ("getinfo\015\012"); |
38 | |
23 | |
39 | # read the response line |
24 | # read the response line |
40 | $handle->push_read (line => sub { |
25 | $hdl->push_read (line => sub { |
41 | my ($handle, $line) = @_; |
26 | my ($hdl, $line) = @_; |
42 | warn "read line <$line>\n"; |
27 | say "got line <$line>"; |
43 | $cv->send; |
28 | $cv->send; |
44 | }); |
29 | }); |
45 | |
30 | |
46 | $cv->recv; |
31 | $cv->recv; |
47 | |
32 | |
48 | =head1 DESCRIPTION |
33 | =head1 DESCRIPTION |
49 | |
34 | |
50 | 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 |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
36 | stream-based filehandles (sockets, pipes, and other stream things). |
52 | on sockets see L<AnyEvent::Util>. |
|
|
53 | |
37 | |
54 | The L<AnyEvent::Intro> tutorial contains some well-documented |
38 | The L<AnyEvent::Intro> tutorial contains some well-documented |
55 | AnyEvent::Handle examples. |
39 | AnyEvent::Handle examples. |
56 | |
40 | |
57 | In the following, when the documentation refers to of "bytes" then this |
41 | In the following, where the documentation refers to "bytes", it means |
58 | 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 |
59 | 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. |
60 | |
47 | |
61 | All callbacks will be invoked with the handle object as their first |
48 | All callbacks will be invoked with the handle object as their first |
62 | argument. |
49 | argument. |
63 | |
50 | |
|
|
51 | =cut |
|
|
52 | |
|
|
53 | package AnyEvent::Handle; |
|
|
54 | |
|
|
55 | use Scalar::Util (); |
|
|
56 | use List::Util (); |
|
|
57 | use Carp (); |
|
|
58 | use Errno qw(EAGAIN EWOULDBLOCK EINTR); |
|
|
59 | |
|
|
60 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
|
|
61 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
|
|
62 | |
|
|
63 | our $VERSION = $AnyEvent::VERSION; |
|
|
64 | |
|
|
65 | sub _load_func($) { |
|
|
66 | my $func = $_[0]; |
|
|
67 | |
|
|
68 | unless (defined &$func) { |
|
|
69 | my $pkg = $func; |
|
|
70 | do { |
|
|
71 | $pkg =~ s/::[^:]+$// |
|
|
72 | or return; |
|
|
73 | eval "require $pkg"; |
|
|
74 | } until defined &$func; |
|
|
75 | } |
|
|
76 | |
|
|
77 | \&$func |
|
|
78 | } |
|
|
79 | |
|
|
80 | sub MAX_READ_SIZE() { 131072 } |
|
|
81 | |
64 | =head1 METHODS |
82 | =head1 METHODS |
65 | |
83 | |
66 | =over 4 |
84 | =over 4 |
67 | |
85 | |
68 | =item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... |
86 | =item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value... |
69 | |
87 | |
70 | The constructor supports these arguments (all as C<< key => value >> pairs). |
88 | The constructor supports these arguments (all as C<< key => value >> pairs). |
71 | |
89 | |
72 | =over 4 |
90 | =over 4 |
73 | |
91 | |
74 | =item fh => $filehandle [MANDATORY] |
92 | =item fh => $filehandle [C<fh> or C<connect> MANDATORY] |
75 | |
93 | |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
94 | The filehandle this L<AnyEvent::Handle> object will operate on. |
77 | |
|
|
78 | NOTE: The filehandle will be set to non-blocking mode (using |
95 | NOTE: The filehandle will be set to non-blocking mode (using |
79 | 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 |
80 | that mode. |
97 | that mode. |
81 | |
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. At the time it is called the |
|
|
134 | read and write queues, EOF status, TLS status and similar properties of |
|
|
135 | the handle will have been reset. |
|
|
136 | |
|
|
137 | If, for some reason, the handle is not acceptable, calling C<$retry> will |
|
|
138 | continue with the next connection target (in case of multi-homed hosts or |
|
|
139 | SRV records there can be multiple connection endpoints). The C<$retry> |
|
|
140 | callback can be invoked after the connect callback returns, i.e. one can |
|
|
141 | start a handshake and then decide to retry with the next host if the |
|
|
142 | handshake fails. |
|
|
143 | |
|
|
144 | In most cases, you should ignore the C<$retry> parameter. |
|
|
145 | |
|
|
146 | =item on_connect_error => $cb->($handle, $message) |
|
|
147 | |
|
|
148 | This callback is called when the connection could not be |
|
|
149 | established. C<$!> will contain the relevant error code, and C<$message> a |
|
|
150 | message describing it (usually the same as C<"$!">). |
|
|
151 | |
|
|
152 | If this callback isn't specified, then C<on_error> will be called with a |
|
|
153 | fatal error instead. |
|
|
154 | |
|
|
155 | =back |
|
|
156 | |
|
|
157 | =item on_error => $cb->($handle, $fatal, $message) |
|
|
158 | |
|
|
159 | This is the error callback, which is called when, well, some error |
|
|
160 | occured, such as not being able to resolve the hostname, failure to |
|
|
161 | connect, or a read error. |
|
|
162 | |
|
|
163 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
|
|
164 | fatal errors the handle object will be destroyed (by a call to C<< -> |
|
|
165 | destroy >>) after invoking the error callback (which means you are free to |
|
|
166 | examine the handle object). Examples of fatal errors are an EOF condition |
|
|
167 | with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In |
|
|
168 | cases where the other side can close the connection at will, it is |
|
|
169 | often easiest to not report C<EPIPE> errors in this callback. |
|
|
170 | |
|
|
171 | AnyEvent::Handle tries to find an appropriate error code for you to check |
|
|
172 | against, but in some cases (TLS errors), this does not work well. |
|
|
173 | |
|
|
174 | If you report the error to the user, it is recommended to always output |
|
|
175 | the C<$message> argument in human-readable error messages (you don't need |
|
|
176 | to report C<"$!"> if you report C<$message>). |
|
|
177 | |
|
|
178 | If you want to react programmatically to the error, then looking at C<$!> |
|
|
179 | and comparing it against some of the documented C<Errno> values is usually |
|
|
180 | better than looking at the C<$message>. |
|
|
181 | |
|
|
182 | Non-fatal errors can be retried by returning, but it is recommended |
|
|
183 | to simply ignore this parameter and instead abondon the handle object |
|
|
184 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
185 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
|
|
186 | |
|
|
187 | On entry to the callback, the value of C<$!> contains the operating |
|
|
188 | system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
|
|
189 | C<EPROTO>). |
|
|
190 | |
|
|
191 | While not mandatory, it is I<highly> recommended to set this callback, as |
|
|
192 | you will not be notified of errors otherwise. The default just calls |
|
|
193 | C<croak>. |
|
|
194 | |
|
|
195 | =item on_read => $cb->($handle) |
|
|
196 | |
|
|
197 | This sets the default read callback, which is called when data arrives |
|
|
198 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
199 | callback will only be called when at least one octet of data is in the |
|
|
200 | read buffer). |
|
|
201 | |
|
|
202 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
|
|
203 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
|
|
204 | must not enlarge or modify the read buffer, you can only remove data at |
|
|
205 | the beginning from it. |
|
|
206 | |
|
|
207 | You can also call C<< ->push_read (...) >> or any other function that |
|
|
208 | modifies the read queue. Or do both. Or ... |
|
|
209 | |
|
|
210 | When an EOF condition is detected, AnyEvent::Handle will first try to |
|
|
211 | feed all the remaining data to the queued callbacks and C<on_read> before |
|
|
212 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
|
|
213 | error will be raised (with C<$!> set to C<EPIPE>). |
|
|
214 | |
|
|
215 | Note that, unlike requests in the read queue, an C<on_read> callback |
|
|
216 | doesn't mean you I<require> some data: if there is an EOF and there |
|
|
217 | are outstanding read requests then an error will be flagged. With an |
|
|
218 | C<on_read> callback, the C<on_eof> callback will be invoked. |
|
|
219 | |
82 | =item on_eof => $cb->($handle) |
220 | =item on_eof => $cb->($handle) |
83 | |
221 | |
84 | Set the callback to be called when an end-of-file condition is detected, |
222 | Set the callback to be called when an end-of-file condition is detected, |
85 | i.e. in the case of a socket, when the other side has closed the |
223 | i.e. in the case of a socket, when the other side has closed the |
86 | connection cleanly. |
224 | connection cleanly, and there are no outstanding read requests in the |
|
|
225 | queue (if there are read requests, then an EOF counts as an unexpected |
|
|
226 | connection close and will be flagged as an error). |
87 | |
227 | |
88 | For sockets, this just means that the other side has stopped sending data, |
228 | For sockets, this just means that the other side has stopped sending data, |
89 | you can still try to write data, and, in fact, one can return from the EOF |
229 | you can still try to write data, and, in fact, one can return from the EOF |
90 | callback and continue writing data, as only the read part has been shut |
230 | callback and continue writing data, as only the read part has been shut |
91 | down. |
231 | down. |
92 | |
232 | |
93 | While not mandatory, it is I<highly> recommended to set an EOF callback, |
|
|
94 | otherwise you might end up with a closed socket while you are still |
|
|
95 | waiting for data. |
|
|
96 | |
|
|
97 | If an EOF condition has been detected but no C<on_eof> callback has been |
233 | If an EOF condition has been detected but no C<on_eof> callback has been |
98 | set, then a fatal error will be raised with C<$!> set to <0>. |
234 | set, then a fatal error will be raised with C<$!> set to <0>. |
99 | |
235 | |
100 | =item on_error => $cb->($handle, $fatal, $message) |
|
|
101 | |
|
|
102 | This is the error callback, which is called when, well, some error |
|
|
103 | occured, such as not being able to resolve the hostname, failure to |
|
|
104 | connect or a read error. |
|
|
105 | |
|
|
106 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
|
|
107 | fatal errors the handle object will be shut down and will not be usable |
|
|
108 | (but you are free to look at the current C<< ->rbuf >>). Examples of fatal |
|
|
109 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
110 | (C<EPIPE>) or I/O errors. |
|
|
111 | |
|
|
112 | AnyEvent::Handle tries to find an appropriate error code for you to check |
|
|
113 | against, but in some cases (TLS errors), this does not work well. It is |
|
|
114 | recommended to always output the C<$message> argument in human-readable |
|
|
115 | error messages (it's usually the same as C<"$!">). |
|
|
116 | |
|
|
117 | Non-fatal errors can be retried by simply returning, but it is recommended |
|
|
118 | to simply ignore this parameter and instead abondon the handle object |
|
|
119 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
120 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
|
|
121 | |
|
|
122 | On callback entrance, the value of C<$!> contains the operating system |
|
|
123 | error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
|
|
124 | C<EPROTO>). |
|
|
125 | |
|
|
126 | While not mandatory, it is I<highly> recommended to set this callback, as |
|
|
127 | you will not be notified of errors otherwise. The default simply calls |
|
|
128 | C<croak>. |
|
|
129 | |
|
|
130 | =item on_read => $cb->($handle) |
|
|
131 | |
|
|
132 | This sets the default read callback, which is called when data arrives |
|
|
133 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
134 | callback will only be called when at least one octet of data is in the |
|
|
135 | read buffer). |
|
|
136 | |
|
|
137 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
|
|
138 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
|
|
139 | must not enlarge or modify the read buffer, you can only remove data at |
|
|
140 | the beginning from it. |
|
|
141 | |
|
|
142 | When an EOF condition is detected then AnyEvent::Handle will first try to |
|
|
143 | feed all the remaining data to the queued callbacks and C<on_read> before |
|
|
144 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
|
|
145 | error will be raised (with C<$!> set to C<EPIPE>). |
|
|
146 | |
|
|
147 | =item on_drain => $cb->($handle) |
236 | =item on_drain => $cb->($handle) |
148 | |
237 | |
149 | This sets the callback that is called when the write buffer becomes empty |
238 | This sets the callback that is called once when the write buffer becomes |
150 | (or when the callback is set and the buffer is empty already). |
239 | empty (and immediately when the handle object is created). |
151 | |
240 | |
152 | To append to the write buffer, use the C<< ->push_write >> method. |
241 | To append to the write buffer, use the C<< ->push_write >> method. |
153 | |
242 | |
154 | This callback is useful when you don't want to put all of your write data |
243 | This callback is useful when you don't want to put all of your write data |
155 | into the queue at once, for example, when you want to write the contents |
244 | into the queue at once, for example, when you want to write the contents |
… | |
… | |
157 | memory and push it into the queue, but instead only read more data from |
246 | memory and push it into the queue, but instead only read more data from |
158 | the file when the write queue becomes empty. |
247 | the file when the write queue becomes empty. |
159 | |
248 | |
160 | =item timeout => $fractional_seconds |
249 | =item timeout => $fractional_seconds |
161 | |
250 | |
|
|
251 | =item rtimeout => $fractional_seconds |
|
|
252 | |
|
|
253 | =item wtimeout => $fractional_seconds |
|
|
254 | |
162 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
255 | If non-zero, then these enables an "inactivity" timeout: whenever this |
163 | seconds pass without a successful read or write on the underlying file |
256 | many seconds pass without a successful read or write on the underlying |
164 | handle, the C<on_timeout> callback will be invoked (and if that one is |
257 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
165 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
258 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
|
|
259 | error will be raised). |
166 | |
260 | |
|
|
261 | There are three variants of the timeouts that work independently of each |
|
|
262 | other, for both read and write (triggered when nothing was read I<OR> |
|
|
263 | written), just read (triggered when nothing was read), and just write: |
|
|
264 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
|
|
265 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
|
|
266 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
|
|
267 | |
167 | Note that timeout processing is also active when you currently do not have |
268 | Note that timeout processing is active even when you do not have any |
168 | any outstanding read or write requests: If you plan to keep the connection |
269 | outstanding read or write requests: If you plan to keep the connection |
169 | idle then you should disable the timout temporarily or ignore the timeout |
270 | idle then you should disable the timeout temporarily or ignore the |
170 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
271 | timeout in the corresponding C<on_timeout> callback, in which case |
171 | restart the timeout. |
272 | AnyEvent::Handle will simply restart the timeout. |
172 | |
273 | |
173 | Zero (the default) disables this timeout. |
274 | Zero (the default) disables the corresponding timeout. |
174 | |
275 | |
175 | =item on_timeout => $cb->($handle) |
276 | =item on_timeout => $cb->($handle) |
|
|
277 | |
|
|
278 | =item on_rtimeout => $cb->($handle) |
|
|
279 | |
|
|
280 | =item on_wtimeout => $cb->($handle) |
176 | |
281 | |
177 | Called whenever the inactivity timeout passes. If you return from this |
282 | Called whenever the inactivity timeout passes. If you return from this |
178 | callback, then the timeout will be reset as if some activity had happened, |
283 | callback, then the timeout will be reset as if some activity had happened, |
179 | so this condition is not fatal in any way. |
284 | so this condition is not fatal in any way. |
180 | |
285 | |
… | |
… | |
188 | be configured to accept only so-and-so much data that it cannot act on |
293 | be configured to accept only so-and-so much data that it cannot act on |
189 | (for example, when expecting a line, an attacker could send an unlimited |
294 | (for example, when expecting a line, an attacker could send an unlimited |
190 | amount of data without a callback ever being called as long as the line |
295 | amount of data without a callback ever being called as long as the line |
191 | isn't finished). |
296 | isn't finished). |
192 | |
297 | |
|
|
298 | =item wbuf_max => <bytes> |
|
|
299 | |
|
|
300 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
|
|
301 | when the write buffer ever (strictly) exceeds this size. This is useful to |
|
|
302 | avoid some forms of denial-of-service attacks. |
|
|
303 | |
|
|
304 | Although the units of this parameter is bytes, this is the I<raw> number |
|
|
305 | of bytes not yet accepted by the kernel. This can make a difference when |
|
|
306 | you e.g. use TLS, as TLS typically makes your write data larger (but it |
|
|
307 | can also make it smaller due to compression). |
|
|
308 | |
|
|
309 | As an example of when this limit is useful, take a chat server that sends |
|
|
310 | chat messages to a client. If the client does not read those in a timely |
|
|
311 | manner then the send buffer in the server would grow unbounded. |
|
|
312 | |
193 | =item autocork => <boolean> |
313 | =item autocork => <boolean> |
194 | |
314 | |
195 | When disabled (the default), then C<push_write> will try to immediately |
315 | When disabled (the default), C<push_write> will try to immediately |
196 | write the data to the handle, if possible. This avoids having to register |
316 | write the data to the handle if possible. This avoids having to register |
197 | a write watcher and wait for the next event loop iteration, but can |
317 | a write watcher and wait for the next event loop iteration, but can |
198 | be inefficient if you write multiple small chunks (on the wire, this |
318 | be inefficient if you write multiple small chunks (on the wire, this |
199 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
319 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
200 | C<no_delay>, but this option can save costly syscalls). |
320 | C<no_delay>, but this option can save costly syscalls). |
201 | |
321 | |
202 | When enabled, then writes will always be queued till the next event loop |
322 | When enabled, writes will always be queued till the next event loop |
203 | iteration. This is efficient when you do many small writes per iteration, |
323 | iteration. This is efficient when you do many small writes per iteration, |
204 | but less efficient when you do a single write only per iteration (or when |
324 | but less efficient when you do a single write only per iteration (or when |
205 | the write buffer often is full). It also increases write latency. |
325 | the write buffer often is full). It also increases write latency. |
206 | |
326 | |
207 | =item no_delay => <boolean> |
327 | =item no_delay => <boolean> |
… | |
… | |
211 | the Nagle algorithm, and usually it is beneficial. |
331 | the Nagle algorithm, and usually it is beneficial. |
212 | |
332 | |
213 | In some situations you want as low a delay as possible, which can be |
333 | In some situations you want as low a delay as possible, which can be |
214 | accomplishd by setting this option to a true value. |
334 | accomplishd by setting this option to a true value. |
215 | |
335 | |
216 | The default is your opertaing system's default behaviour (most likely |
336 | The default is your operating system's default behaviour (most likely |
217 | enabled), this option explicitly enables or disables it, if possible. |
337 | enabled). This option explicitly enables or disables it, if possible. |
|
|
338 | |
|
|
339 | =item keepalive => <boolean> |
|
|
340 | |
|
|
341 | Enables (default disable) the SO_KEEPALIVE option on the stream socket: |
|
|
342 | normally, TCP connections have no time-out once established, so TCP |
|
|
343 | connections, once established, can stay alive forever even when the other |
|
|
344 | side has long gone. TCP keepalives are a cheap way to take down long-lived |
|
|
345 | TCP connections when the other side becomes unreachable. While the default |
|
|
346 | is OS-dependent, TCP keepalives usually kick in after around two hours, |
|
|
347 | and, if the other side doesn't reply, take down the TCP connection some 10 |
|
|
348 | to 15 minutes later. |
|
|
349 | |
|
|
350 | It is harmless to specify this option for file handles that do not support |
|
|
351 | keepalives, and enabling it on connections that are potentially long-lived |
|
|
352 | is usually a good idea. |
|
|
353 | |
|
|
354 | =item oobinline => <boolean> |
|
|
355 | |
|
|
356 | BSD majorly fucked up the implementation of TCP urgent data. The result |
|
|
357 | is that almost no OS implements TCP according to the specs, and every OS |
|
|
358 | implements it slightly differently. |
|
|
359 | |
|
|
360 | If you want to handle TCP urgent data, then setting this flag (the default |
|
|
361 | is enabled) gives you the most portable way of getting urgent data, by |
|
|
362 | putting it into the stream. |
|
|
363 | |
|
|
364 | Since BSD emulation of OOB data on top of TCP's urgent data can have |
|
|
365 | security implications, AnyEvent::Handle sets this flag automatically |
|
|
366 | unless explicitly specified. Note that setting this flag after |
|
|
367 | establishing a connection I<may> be a bit too late (data loss could |
|
|
368 | already have occured on BSD systems), but at least it will protect you |
|
|
369 | from most attacks. |
218 | |
370 | |
219 | =item read_size => <bytes> |
371 | =item read_size => <bytes> |
220 | |
372 | |
221 | The default read block size (the amount of bytes this module will |
373 | The initial read block size, the number of bytes this module will try |
222 | try to read during each loop iteration, which affects memory |
374 | to read during each loop iteration. Each handle object will consume |
223 | requirements). Default: C<8192>. |
375 | at least this amount of memory for the read buffer as well, so when |
|
|
376 | handling many connections watch out for memory requirements). See also |
|
|
377 | C<max_read_size>. Default: C<2048>. |
|
|
378 | |
|
|
379 | =item max_read_size => <bytes> |
|
|
380 | |
|
|
381 | The maximum read buffer size used by the dynamic adjustment |
|
|
382 | algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in |
|
|
383 | one go it will double C<read_size> up to the maximum given by this |
|
|
384 | option. Default: C<131072> or C<read_size>, whichever is higher. |
224 | |
385 | |
225 | =item low_water_mark => <bytes> |
386 | =item low_water_mark => <bytes> |
226 | |
387 | |
227 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
388 | Sets the number of bytes (default: C<0>) that make up an "empty" write |
228 | buffer: If the write reaches this size or gets even samller it is |
389 | buffer: If the buffer reaches this size or gets even samller it is |
229 | considered empty. |
390 | considered empty. |
230 | |
391 | |
231 | Sometimes it can be beneficial (for performance reasons) to add data to |
392 | Sometimes it can be beneficial (for performance reasons) to add data to |
232 | the write buffer before it is fully drained, but this is a rare case, as |
393 | the write buffer before it is fully drained, but this is a rare case, as |
233 | the operating system kernel usually buffers data as well, so the default |
394 | the operating system kernel usually buffers data as well, so the default |
234 | is good in almost all cases. |
395 | is good in almost all cases. |
235 | |
396 | |
236 | =item linger => <seconds> |
397 | =item linger => <seconds> |
237 | |
398 | |
238 | If non-zero (default: C<3600>), then the destructor of the |
399 | If this is non-zero (default: C<3600>), the destructor of the |
239 | AnyEvent::Handle object will check whether there is still outstanding |
400 | AnyEvent::Handle object will check whether there is still outstanding |
240 | write data and will install a watcher that will write this data to the |
401 | write data and will install a watcher that will write this data to the |
241 | socket. No errors will be reported (this mostly matches how the operating |
402 | socket. No errors will be reported (this mostly matches how the operating |
242 | system treats outstanding data at socket close time). |
403 | system treats outstanding data at socket close time). |
243 | |
404 | |
… | |
… | |
249 | |
410 | |
250 | A string used to identify the remote site - usually the DNS hostname |
411 | A string used to identify the remote site - usually the DNS hostname |
251 | (I<not> IDN!) used to create the connection, rarely the IP address. |
412 | (I<not> IDN!) used to create the connection, rarely the IP address. |
252 | |
413 | |
253 | Apart from being useful in error messages, this string is also used in TLS |
414 | Apart from being useful in error messages, this string is also used in TLS |
254 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). |
415 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
|
|
416 | verification will be skipped when C<peername> is not specified or is |
|
|
417 | C<undef>. |
255 | |
418 | |
256 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
419 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
257 | |
420 | |
258 | When this parameter is given, it enables TLS (SSL) mode, that means |
421 | When this parameter is given, it enables TLS (SSL) mode, that means |
259 | AnyEvent will start a TLS handshake as soon as the conenction has been |
422 | AnyEvent will start a TLS handshake as soon as the connection has been |
260 | established and will transparently encrypt/decrypt data afterwards. |
423 | established and will transparently encrypt/decrypt data afterwards. |
261 | |
424 | |
262 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
425 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
263 | appropriate error message. |
426 | appropriate error message. |
264 | |
427 | |
265 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
428 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
266 | automatically when you try to create a TLS handle): this module doesn't |
429 | automatically when you try to create a TLS handle): this module doesn't |
267 | have a dependency on that module, so if your module requires it, you have |
430 | have a dependency on that module, so if your module requires it, you have |
268 | to add the dependency yourself. |
431 | to add the dependency yourself. If Net::SSLeay cannot be loaded or is too |
|
|
432 | old, you get an C<EPROTO> error. |
269 | |
433 | |
270 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
434 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
271 | C<accept>, and for the TLS client side of a connection, use C<connect> |
435 | C<accept>, and for the TLS client side of a connection, use C<connect> |
272 | mode. |
436 | mode. |
273 | |
437 | |
… | |
… | |
284 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
448 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
285 | passing in the wrong integer will lead to certain crash. This most often |
449 | passing in the wrong integer will lead to certain crash. This most often |
286 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
450 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
287 | segmentation fault. |
451 | segmentation fault. |
288 | |
452 | |
289 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
453 | Use the C<< ->starttls >> method if you need to start TLS negotiation later. |
290 | |
454 | |
291 | =item tls_ctx => $anyevent_tls |
455 | =item tls_ctx => $anyevent_tls |
292 | |
456 | |
293 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
457 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
294 | (unless a connection object was specified directly). If this parameter is |
458 | (unless a connection object was specified directly). If this |
295 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
459 | parameter is missing (or C<undef>), then AnyEvent::Handle will use |
|
|
460 | C<AnyEvent::Handle::TLS_CTX>. |
296 | |
461 | |
297 | Instead of an object, you can also specify a hash reference with C<< key |
462 | Instead of an object, you can also specify a hash reference with C<< key |
298 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
463 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
299 | new TLS context object. |
464 | new TLS context object. |
300 | |
465 | |
|
|
466 | =item on_starttls => $cb->($handle, $success[, $error_message]) |
|
|
467 | |
|
|
468 | This callback will be invoked when the TLS/SSL handshake has finished. If |
|
|
469 | C<$success> is true, then the TLS handshake succeeded, otherwise it failed |
|
|
470 | (C<on_stoptls> will not be called in this case). |
|
|
471 | |
|
|
472 | The session in C<< $handle->{tls} >> can still be examined in this |
|
|
473 | callback, even when the handshake was not successful. |
|
|
474 | |
|
|
475 | TLS handshake failures will not cause C<on_error> to be invoked when this |
|
|
476 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
|
|
477 | |
|
|
478 | Without this callback, handshake failures lead to C<on_error> being |
|
|
479 | called as usual. |
|
|
480 | |
|
|
481 | Note that you cannot just call C<starttls> again in this callback. If you |
|
|
482 | need to do that, start an zero-second timer instead whose callback can |
|
|
483 | then call C<< ->starttls >> again. |
|
|
484 | |
|
|
485 | =item on_stoptls => $cb->($handle) |
|
|
486 | |
|
|
487 | When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is |
|
|
488 | set, then it will be invoked after freeing the TLS session. If it is not, |
|
|
489 | then a TLS shutdown condition will be treated like a normal EOF condition |
|
|
490 | on the handle. |
|
|
491 | |
|
|
492 | The session in C<< $handle->{tls} >> can still be examined in this |
|
|
493 | callback. |
|
|
494 | |
|
|
495 | This callback will only be called on TLS shutdowns, not when the |
|
|
496 | underlying handle signals EOF. |
|
|
497 | |
301 | =item json => JSON or JSON::XS object |
498 | =item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object |
302 | |
499 | |
303 | This is the json coder object used by the C<json> read and write types. |
500 | This is the json coder object used by the C<json> read and write types. |
304 | |
501 | |
305 | If you don't supply it, then AnyEvent::Handle will create and use a |
502 | If you don't supply it, then AnyEvent::Handle will create and use a |
306 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
503 | suitable one (on demand), which will write and expect UTF-8 encoded |
|
|
504 | JSON texts (either using L<JSON::XS> or L<JSON>). The written texts are |
|
|
505 | guaranteed not to contain any newline character. |
|
|
506 | |
|
|
507 | For security reasons, this encoder will likely I<not> handle numbers and |
|
|
508 | strings, only arrays and objects/hashes. The reason is that originally |
|
|
509 | JSON was self-delimited, but Dougles Crockford thought it was a splendid |
|
|
510 | idea to redefine JSON incompatibly, so this is no longer true. |
|
|
511 | |
|
|
512 | For protocols that used back-to-back JSON texts, this might lead to |
|
|
513 | run-ins, where two or more JSON texts will be interpreted as one JSON |
307 | texts. |
514 | text. |
308 | |
515 | |
|
|
516 | For this reason, if the default encoder uses L<JSON::XS>, it will default |
|
|
517 | to not allowing anything but arrays and objects/hashes, at least for the |
|
|
518 | forseeable future (it will change at some point). This might or might not |
|
|
519 | be true for the L<JSON> module, so this might cause a security issue. |
|
|
520 | |
|
|
521 | If you depend on either behaviour, you should create your own json object |
|
|
522 | and pass it in explicitly. |
|
|
523 | |
|
|
524 | =item cbor => L<CBOR::XS> object |
|
|
525 | |
|
|
526 | This is the cbor coder object used by the C<cbor> read and write types. |
|
|
527 | |
|
|
528 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
529 | suitable one (on demand), which will write CBOR without using extensions, |
|
|
530 | if possible. |
|
|
531 | |
309 | Note that you are responsible to depend on the JSON module if you want to |
532 | Note that you are responsible to depend on the L<CBOR::XS> module if you |
310 | use this functionality, as AnyEvent does not have a dependency itself. |
533 | want to use this functionality, as AnyEvent does not have a dependency on |
|
|
534 | it itself. |
311 | |
535 | |
312 | =back |
536 | =back |
313 | |
537 | |
314 | =cut |
538 | =cut |
315 | |
539 | |
316 | sub new { |
540 | sub new { |
317 | my $class = shift; |
541 | my $class = shift; |
318 | my $self = bless { @_ }, $class; |
542 | my $self = bless { @_ }, $class; |
319 | |
543 | |
320 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
544 | if ($self->{fh}) { |
|
|
545 | $self->_start; |
|
|
546 | return unless $self->{fh}; # could be gone by now |
|
|
547 | |
|
|
548 | } elsif ($self->{connect}) { |
|
|
549 | require AnyEvent::Socket; |
|
|
550 | |
|
|
551 | $self->{peername} = $self->{connect}[0] |
|
|
552 | unless exists $self->{peername}; |
|
|
553 | |
|
|
554 | $self->{_skip_drain_rbuf} = 1; |
|
|
555 | |
|
|
556 | { |
|
|
557 | Scalar::Util::weaken (my $self = $self); |
|
|
558 | |
|
|
559 | $self->{_connect} = |
|
|
560 | AnyEvent::Socket::tcp_connect ( |
|
|
561 | $self->{connect}[0], |
|
|
562 | $self->{connect}[1], |
|
|
563 | sub { |
|
|
564 | my ($fh, $host, $port, $retry) = @_; |
|
|
565 | |
|
|
566 | delete $self->{_connect}; # no longer needed |
|
|
567 | |
|
|
568 | if ($fh) { |
|
|
569 | $self->{fh} = $fh; |
|
|
570 | |
|
|
571 | delete $self->{_skip_drain_rbuf}; |
|
|
572 | $self->_start; |
|
|
573 | |
|
|
574 | $self->{on_connect} |
|
|
575 | and $self->{on_connect}($self, $host, $port, sub { |
|
|
576 | delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)}; |
|
|
577 | $self->{_skip_drain_rbuf} = 1; |
|
|
578 | &$retry; |
|
|
579 | }); |
|
|
580 | |
|
|
581 | } else { |
|
|
582 | if ($self->{on_connect_error}) { |
|
|
583 | $self->{on_connect_error}($self, "$!"); |
|
|
584 | $self->destroy if $self; |
|
|
585 | } else { |
|
|
586 | $self->_error ($!, 1); |
|
|
587 | } |
|
|
588 | } |
|
|
589 | }, |
|
|
590 | sub { |
|
|
591 | local $self->{fh} = $_[0]; |
|
|
592 | |
|
|
593 | $self->{on_prepare} |
|
|
594 | ? $self->{on_prepare}->($self) |
|
|
595 | : () |
|
|
596 | } |
|
|
597 | ); |
|
|
598 | } |
|
|
599 | |
|
|
600 | } else { |
|
|
601 | Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified"; |
|
|
602 | } |
|
|
603 | |
|
|
604 | $self |
|
|
605 | } |
|
|
606 | |
|
|
607 | sub _start { |
|
|
608 | my ($self) = @_; |
|
|
609 | |
|
|
610 | # too many clueless people try to use udp and similar sockets |
|
|
611 | # with AnyEvent::Handle, do them a favour. |
|
|
612 | my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE (); |
|
|
613 | Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!" |
|
|
614 | if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type; |
321 | |
615 | |
322 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
616 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
323 | |
617 | |
|
|
618 | $self->{_activity} = |
|
|
619 | $self->{_ractivity} = |
324 | $self->{_activity} = AnyEvent->now; |
620 | $self->{_wactivity} = AE::now; |
325 | $self->_timeout; |
|
|
326 | |
621 | |
|
|
622 | $self->{read_size} ||= 2048; |
|
|
623 | $self->{max_read_size} = $self->{read_size} |
|
|
624 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
|
|
625 | |
|
|
626 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
|
|
627 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
|
|
628 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
|
|
629 | |
327 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
630 | $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; |
|
|
631 | $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive}; |
328 | |
632 | |
|
|
633 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
|
|
634 | |
329 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
635 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
330 | if $self->{tls}; |
636 | if $self->{tls}; |
331 | |
637 | |
332 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
638 | $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain}; |
333 | |
639 | |
334 | $self->start_read |
640 | $self->start_read |
335 | if $self->{on_read}; |
641 | if $self->{on_read} || @{ $self->{_queue} }; |
336 | |
642 | |
337 | $self->{fh} && $self |
643 | $self->_drain_wbuf; |
338 | } |
|
|
339 | |
|
|
340 | sub _shutdown { |
|
|
341 | my ($self) = @_; |
|
|
342 | |
|
|
343 | delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
|
|
344 | $self->{_eof} = 1; # tell starttls et. al to stop trying |
|
|
345 | |
|
|
346 | &_freetls; |
|
|
347 | } |
644 | } |
348 | |
645 | |
349 | sub _error { |
646 | sub _error { |
350 | my ($self, $errno, $fatal, $message) = @_; |
647 | my ($self, $errno, $fatal, $message) = @_; |
351 | |
648 | |
352 | $self->_shutdown |
|
|
353 | if $fatal; |
|
|
354 | |
|
|
355 | $! = $errno; |
649 | $! = $errno; |
356 | $message ||= "$!"; |
650 | $message ||= "$!"; |
357 | |
651 | |
358 | if ($self->{on_error}) { |
652 | if ($self->{on_error}) { |
359 | $self->{on_error}($self, $fatal, $message); |
653 | $self->{on_error}($self, $fatal, $message); |
360 | } elsif ($self->{fh}) { |
654 | $self->destroy if $fatal; |
|
|
655 | } elsif ($self->{fh} || $self->{connect}) { |
|
|
656 | $self->destroy; |
361 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
657 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
362 | } |
658 | } |
363 | } |
659 | } |
364 | |
660 | |
365 | =item $fh = $handle->fh |
661 | =item $fh = $handle->fh |
… | |
… | |
390 | $_[0]{on_eof} = $_[1]; |
686 | $_[0]{on_eof} = $_[1]; |
391 | } |
687 | } |
392 | |
688 | |
393 | =item $handle->on_timeout ($cb) |
689 | =item $handle->on_timeout ($cb) |
394 | |
690 | |
395 | Replace the current C<on_timeout> callback, or disables the callback (but |
691 | =item $handle->on_rtimeout ($cb) |
396 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
|
|
397 | argument and method. |
|
|
398 | |
692 | |
399 | =cut |
693 | =item $handle->on_wtimeout ($cb) |
400 | |
694 | |
401 | sub on_timeout { |
695 | Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout> |
402 | $_[0]{on_timeout} = $_[1]; |
696 | callback, or disables the callback (but not the timeout) if C<$cb> = |
403 | } |
697 | C<undef>. See the C<timeout> constructor argument and method. |
|
|
698 | |
|
|
699 | =cut |
|
|
700 | |
|
|
701 | # see below |
404 | |
702 | |
405 | =item $handle->autocork ($boolean) |
703 | =item $handle->autocork ($boolean) |
406 | |
704 | |
407 | Enables or disables the current autocork behaviour (see C<autocork> |
705 | Enables or disables the current autocork behaviour (see C<autocork> |
408 | constructor argument). Changes will only take effect on the next write. |
706 | constructor argument). Changes will only take effect on the next write. |
… | |
… | |
421 | =cut |
719 | =cut |
422 | |
720 | |
423 | sub no_delay { |
721 | sub no_delay { |
424 | $_[0]{no_delay} = $_[1]; |
722 | $_[0]{no_delay} = $_[1]; |
425 | |
723 | |
|
|
724 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
|
|
725 | if $_[0]{fh}; |
|
|
726 | } |
|
|
727 | |
|
|
728 | =item $handle->keepalive ($boolean) |
|
|
729 | |
|
|
730 | Enables or disables the C<keepalive> setting (see constructor argument of |
|
|
731 | the same name for details). |
|
|
732 | |
|
|
733 | =cut |
|
|
734 | |
|
|
735 | sub keepalive { |
|
|
736 | $_[0]{keepalive} = $_[1]; |
|
|
737 | |
426 | eval { |
738 | eval { |
427 | local $SIG{__DIE__}; |
739 | local $SIG{__DIE__}; |
428 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
740 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1] |
|
|
741 | if $_[0]{fh}; |
429 | }; |
742 | }; |
430 | } |
743 | } |
431 | |
744 | |
|
|
745 | =item $handle->oobinline ($boolean) |
|
|
746 | |
|
|
747 | Enables or disables the C<oobinline> setting (see constructor argument of |
|
|
748 | the same name for details). |
|
|
749 | |
|
|
750 | =cut |
|
|
751 | |
|
|
752 | sub oobinline { |
|
|
753 | $_[0]{oobinline} = $_[1]; |
|
|
754 | |
|
|
755 | eval { |
|
|
756 | local $SIG{__DIE__}; |
|
|
757 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1] |
|
|
758 | if $_[0]{fh}; |
|
|
759 | }; |
|
|
760 | } |
|
|
761 | |
|
|
762 | =item $handle->keepalive ($boolean) |
|
|
763 | |
|
|
764 | Enables or disables the C<keepalive> setting (see constructor argument of |
|
|
765 | the same name for details). |
|
|
766 | |
|
|
767 | =cut |
|
|
768 | |
|
|
769 | sub keepalive { |
|
|
770 | $_[0]{keepalive} = $_[1]; |
|
|
771 | |
|
|
772 | eval { |
|
|
773 | local $SIG{__DIE__}; |
|
|
774 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1] |
|
|
775 | if $_[0]{fh}; |
|
|
776 | }; |
|
|
777 | } |
|
|
778 | |
|
|
779 | =item $handle->on_starttls ($cb) |
|
|
780 | |
|
|
781 | Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). |
|
|
782 | |
|
|
783 | =cut |
|
|
784 | |
|
|
785 | sub on_starttls { |
|
|
786 | $_[0]{on_starttls} = $_[1]; |
|
|
787 | } |
|
|
788 | |
|
|
789 | =item $handle->on_stoptls ($cb) |
|
|
790 | |
|
|
791 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
|
|
792 | |
|
|
793 | =cut |
|
|
794 | |
|
|
795 | sub on_stoptls { |
|
|
796 | $_[0]{on_stoptls} = $_[1]; |
|
|
797 | } |
|
|
798 | |
|
|
799 | =item $handle->rbuf_max ($max_octets) |
|
|
800 | |
|
|
801 | Configures the C<rbuf_max> setting (C<undef> disables it). |
|
|
802 | |
|
|
803 | =item $handle->wbuf_max ($max_octets) |
|
|
804 | |
|
|
805 | Configures the C<wbuf_max> setting (C<undef> disables it). |
|
|
806 | |
|
|
807 | =cut |
|
|
808 | |
|
|
809 | sub rbuf_max { |
|
|
810 | $_[0]{rbuf_max} = $_[1]; |
|
|
811 | } |
|
|
812 | |
|
|
813 | sub wbuf_max { |
|
|
814 | $_[0]{wbuf_max} = $_[1]; |
|
|
815 | } |
|
|
816 | |
432 | ############################################################################# |
817 | ############################################################################# |
433 | |
818 | |
434 | =item $handle->timeout ($seconds) |
819 | =item $handle->timeout ($seconds) |
435 | |
820 | |
|
|
821 | =item $handle->rtimeout ($seconds) |
|
|
822 | |
|
|
823 | =item $handle->wtimeout ($seconds) |
|
|
824 | |
436 | Configures (or disables) the inactivity timeout. |
825 | Configures (or disables) the inactivity timeout. |
437 | |
826 | |
438 | =cut |
827 | The timeout will be checked instantly, so this method might destroy the |
|
|
828 | handle before it returns. |
439 | |
829 | |
440 | sub timeout { |
830 | =item $handle->timeout_reset |
|
|
831 | |
|
|
832 | =item $handle->rtimeout_reset |
|
|
833 | |
|
|
834 | =item $handle->wtimeout_reset |
|
|
835 | |
|
|
836 | Reset the activity timeout, as if data was received or sent. |
|
|
837 | |
|
|
838 | These methods are cheap to call. |
|
|
839 | |
|
|
840 | =cut |
|
|
841 | |
|
|
842 | for my $dir ("", "r", "w") { |
|
|
843 | my $timeout = "${dir}timeout"; |
|
|
844 | my $tw = "_${dir}tw"; |
|
|
845 | my $on_timeout = "on_${dir}timeout"; |
|
|
846 | my $activity = "_${dir}activity"; |
|
|
847 | my $cb; |
|
|
848 | |
|
|
849 | *$on_timeout = sub { |
|
|
850 | $_[0]{$on_timeout} = $_[1]; |
|
|
851 | }; |
|
|
852 | |
|
|
853 | *$timeout = sub { |
441 | my ($self, $timeout) = @_; |
854 | my ($self, $new_value) = @_; |
442 | |
855 | |
|
|
856 | $new_value >= 0 |
|
|
857 | or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught"; |
|
|
858 | |
443 | $self->{timeout} = $timeout; |
859 | $self->{$timeout} = $new_value; |
444 | $self->_timeout; |
860 | delete $self->{$tw}; &$cb; |
445 | } |
861 | }; |
446 | |
862 | |
|
|
863 | *{"${dir}timeout_reset"} = sub { |
|
|
864 | $_[0]{$activity} = AE::now; |
|
|
865 | }; |
|
|
866 | |
|
|
867 | # main workhorse: |
447 | # reset the timeout watcher, as neccessary |
868 | # reset the timeout watcher, as neccessary |
448 | # also check for time-outs |
869 | # also check for time-outs |
449 | sub _timeout { |
870 | $cb = sub { |
450 | my ($self) = @_; |
871 | my ($self) = @_; |
451 | |
872 | |
452 | if ($self->{timeout}) { |
873 | if ($self->{$timeout} && $self->{fh}) { |
453 | my $NOW = AnyEvent->now; |
874 | my $NOW = AE::now; |
454 | |
875 | |
455 | # when would the timeout trigger? |
876 | # when would the timeout trigger? |
456 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
877 | my $after = $self->{$activity} + $self->{$timeout} - $NOW; |
457 | |
878 | |
458 | # now or in the past already? |
879 | # now or in the past already? |
459 | if ($after <= 0) { |
880 | if ($after <= 0) { |
460 | $self->{_activity} = $NOW; |
881 | $self->{$activity} = $NOW; |
461 | |
882 | |
462 | if ($self->{on_timeout}) { |
883 | if ($self->{$on_timeout}) { |
463 | $self->{on_timeout}($self); |
884 | $self->{$on_timeout}($self); |
464 | } else { |
885 | } else { |
465 | $self->_error (&Errno::ETIMEDOUT); |
886 | $self->_error (Errno::ETIMEDOUT); |
|
|
887 | } |
|
|
888 | |
|
|
889 | # callback could have changed timeout value, optimise |
|
|
890 | return unless $self->{$timeout}; |
|
|
891 | |
|
|
892 | # calculate new after |
|
|
893 | $after = $self->{$timeout}; |
466 | } |
894 | } |
467 | |
895 | |
468 | # callback could have changed timeout value, optimise |
896 | Scalar::Util::weaken $self; |
469 | return unless $self->{timeout}; |
897 | return unless $self; # ->error could have destroyed $self |
470 | |
898 | |
471 | # calculate new after |
899 | $self->{$tw} ||= AE::timer $after, 0, sub { |
472 | $after = $self->{timeout}; |
900 | delete $self->{$tw}; |
|
|
901 | $cb->($self); |
|
|
902 | }; |
|
|
903 | } else { |
|
|
904 | delete $self->{$tw}; |
473 | } |
905 | } |
474 | |
|
|
475 | Scalar::Util::weaken $self; |
|
|
476 | return unless $self; # ->error could have destroyed $self |
|
|
477 | |
|
|
478 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
|
|
479 | delete $self->{_tw}; |
|
|
480 | $self->_timeout; |
|
|
481 | }); |
|
|
482 | } else { |
|
|
483 | delete $self->{_tw}; |
|
|
484 | } |
906 | } |
485 | } |
907 | } |
486 | |
908 | |
487 | ############################################################################# |
909 | ############################################################################# |
488 | |
910 | |
… | |
… | |
495 | |
917 | |
496 | The write queue is very simple: you can add data to its end, and |
918 | The write queue is very simple: you can add data to its end, and |
497 | AnyEvent::Handle will automatically try to get rid of it for you. |
919 | AnyEvent::Handle will automatically try to get rid of it for you. |
498 | |
920 | |
499 | When data could be written and the write buffer is shorter then the low |
921 | When data could be written and the write buffer is shorter then the low |
500 | water mark, the C<on_drain> callback will be invoked. |
922 | water mark, the C<on_drain> callback will be invoked once. |
501 | |
923 | |
502 | =over 4 |
924 | =over 4 |
503 | |
925 | |
504 | =item $handle->on_drain ($cb) |
926 | =item $handle->on_drain ($cb) |
505 | |
927 | |
506 | Sets the C<on_drain> callback or clears it (see the description of |
928 | Sets the C<on_drain> callback or clears it (see the description of |
507 | C<on_drain> in the constructor). |
929 | C<on_drain> in the constructor). |
508 | |
930 | |
|
|
931 | This method may invoke callbacks (and therefore the handle might be |
|
|
932 | destroyed after it returns). |
|
|
933 | |
509 | =cut |
934 | =cut |
510 | |
935 | |
511 | sub on_drain { |
936 | sub on_drain { |
512 | my ($self, $cb) = @_; |
937 | my ($self, $cb) = @_; |
513 | |
938 | |
… | |
… | |
517 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
942 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
518 | } |
943 | } |
519 | |
944 | |
520 | =item $handle->push_write ($data) |
945 | =item $handle->push_write ($data) |
521 | |
946 | |
522 | Queues the given scalar to be written. You can push as much data as you |
947 | Queues the given scalar to be written. You can push as much data as |
523 | want (only limited by the available memory), as C<AnyEvent::Handle> |
948 | you want (only limited by the available memory and C<wbuf_max>), as |
524 | buffers it independently of the kernel. |
949 | C<AnyEvent::Handle> buffers it independently of the kernel. |
|
|
950 | |
|
|
951 | This method may invoke callbacks (and therefore the handle might be |
|
|
952 | destroyed after it returns). |
525 | |
953 | |
526 | =cut |
954 | =cut |
527 | |
955 | |
528 | sub _drain_wbuf { |
956 | sub _drain_wbuf { |
529 | my ($self) = @_; |
957 | my ($self) = @_; |
… | |
… | |
533 | Scalar::Util::weaken $self; |
961 | Scalar::Util::weaken $self; |
534 | |
962 | |
535 | my $cb = sub { |
963 | my $cb = sub { |
536 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
964 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
537 | |
965 | |
538 | if ($len >= 0) { |
966 | if (defined $len) { |
539 | substr $self->{wbuf}, 0, $len, ""; |
967 | substr $self->{wbuf}, 0, $len, ""; |
540 | |
968 | |
541 | $self->{_activity} = AnyEvent->now; |
969 | $self->{_activity} = $self->{_wactivity} = AE::now; |
542 | |
970 | |
543 | $self->{on_drain}($self) |
971 | $self->{on_drain}($self) |
544 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
972 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
545 | && $self->{on_drain}; |
973 | && $self->{on_drain}; |
546 | |
974 | |
547 | delete $self->{_ww} unless length $self->{wbuf}; |
975 | delete $self->{_ww} unless length $self->{wbuf}; |
548 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
976 | } elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) { |
549 | $self->_error ($!, 1); |
977 | $self->_error ($!, 1); |
550 | } |
978 | } |
551 | }; |
979 | }; |
552 | |
980 | |
553 | # try to write data immediately |
981 | # try to write data immediately |
554 | $cb->() unless $self->{autocork}; |
982 | $cb->() unless $self->{autocork}; |
555 | |
983 | |
556 | # if still data left in wbuf, we need to poll |
984 | # if still data left in wbuf, we need to poll |
557 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
985 | $self->{_ww} = AE::io $self->{fh}, 1, $cb |
558 | if length $self->{wbuf}; |
986 | if length $self->{wbuf}; |
|
|
987 | |
|
|
988 | if ( |
|
|
989 | defined $self->{wbuf_max} |
|
|
990 | && $self->{wbuf_max} < length $self->{wbuf} |
|
|
991 | ) { |
|
|
992 | $self->_error (Errno::ENOSPC, 1), return; |
|
|
993 | } |
559 | }; |
994 | }; |
560 | } |
995 | } |
561 | |
996 | |
562 | our %WH; |
997 | our %WH; |
563 | |
998 | |
|
|
999 | # deprecated |
564 | sub register_write_type($$) { |
1000 | sub register_write_type($$) { |
565 | $WH{$_[0]} = $_[1]; |
1001 | $WH{$_[0]} = $_[1]; |
566 | } |
1002 | } |
567 | |
1003 | |
568 | sub push_write { |
1004 | sub push_write { |
569 | my $self = shift; |
1005 | my $self = shift; |
570 | |
1006 | |
571 | if (@_ > 1) { |
1007 | if (@_ > 1) { |
572 | my $type = shift; |
1008 | my $type = shift; |
573 | |
1009 | |
|
|
1010 | @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" |
574 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
1011 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") |
575 | ->($self, @_); |
1012 | ->($self, @_); |
576 | } |
1013 | } |
577 | |
1014 | |
|
|
1015 | # we downgrade here to avoid hard-to-track-down bugs, |
|
|
1016 | # and diagnose the problem earlier and better. |
|
|
1017 | |
578 | if ($self->{tls}) { |
1018 | if ($self->{tls}) { |
579 | $self->{_tls_wbuf} .= $_[0]; |
1019 | utf8::downgrade $self->{_tls_wbuf} .= $_[0]; |
580 | |
1020 | &_dotls ($self) if $self->{fh}; |
581 | &_dotls ($self); |
|
|
582 | } else { |
1021 | } else { |
583 | $self->{wbuf} .= $_[0]; |
1022 | utf8::downgrade $self->{wbuf} .= $_[0]; |
584 | $self->_drain_wbuf; |
1023 | $self->_drain_wbuf if $self->{fh}; |
585 | } |
1024 | } |
586 | } |
1025 | } |
587 | |
1026 | |
588 | =item $handle->push_write (type => @args) |
1027 | =item $handle->push_write (type => @args) |
589 | |
1028 | |
590 | Instead of formatting your data yourself, you can also let this module do |
1029 | Instead of formatting your data yourself, you can also let this module |
591 | the job by specifying a type and type-specific arguments. |
1030 | do the job by specifying a type and type-specific arguments. You |
|
|
1031 | can also specify the (fully qualified) name of a package, in which |
|
|
1032 | case AnyEvent tries to load the package and then expects to find the |
|
|
1033 | C<anyevent_write_type> function inside (see "custom write types", below). |
592 | |
1034 | |
593 | Predefined types are (if you have ideas for additional types, feel free to |
1035 | Predefined types are (if you have ideas for additional types, feel free to |
594 | drop by and tell us): |
1036 | drop by and tell us): |
595 | |
1037 | |
596 | =over 4 |
1038 | =over 4 |
… | |
… | |
627 | |
1069 | |
628 | Encodes the given hash or array reference into a JSON object. Unless you |
1070 | Encodes the given hash or array reference into a JSON object. Unless you |
629 | provide your own JSON object, this means it will be encoded to JSON text |
1071 | provide your own JSON object, this means it will be encoded to JSON text |
630 | in UTF-8. |
1072 | in UTF-8. |
631 | |
1073 | |
|
|
1074 | The default encoder might or might not handle every type of JSON value - |
|
|
1075 | it might be limited to arrays and objects for security reasons. See the |
|
|
1076 | C<json> constructor attribute for more details. |
|
|
1077 | |
632 | JSON objects (and arrays) are self-delimiting, so you can write JSON at |
1078 | JSON objects (and arrays) are self-delimiting, so if you only use arrays |
633 | one end of a handle and read them at the other end without using any |
1079 | and hashes, you can write JSON at one end of a handle and read them at the |
634 | additional framing. |
1080 | other end without using any additional framing. |
635 | |
1081 | |
636 | The generated JSON text is guaranteed not to contain any newlines: While |
1082 | The JSON text generated by the default encoder is guaranteed not to |
637 | this module doesn't need delimiters after or between JSON texts to be |
1083 | contain any newlines: While this module doesn't need delimiters after or |
638 | able to read them, many other languages depend on that. |
1084 | between JSON texts to be able to read them, many other languages depend on |
|
|
1085 | them. |
639 | |
1086 | |
640 | A simple RPC protocol that interoperates easily with others is to send |
1087 | A simple RPC protocol that interoperates easily with other languages is |
641 | JSON arrays (or objects, although arrays are usually the better choice as |
1088 | to send JSON arrays (or objects, although arrays are usually the better |
642 | they mimic how function argument passing works) and a newline after each |
1089 | choice as they mimic how function argument passing works) and a newline |
643 | JSON text: |
1090 | after each JSON text: |
644 | |
1091 | |
645 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
1092 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
646 | $handle->push_write ("\012"); |
1093 | $handle->push_write ("\012"); |
647 | |
1094 | |
648 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
1095 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
… | |
… | |
651 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
1098 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
652 | |
1099 | |
653 | Other languages could read single lines terminated by a newline and pass |
1100 | Other languages could read single lines terminated by a newline and pass |
654 | this line into their JSON decoder of choice. |
1101 | this line into their JSON decoder of choice. |
655 | |
1102 | |
|
|
1103 | =item cbor => $perl_scalar |
|
|
1104 | |
|
|
1105 | Encodes the given scalar into a CBOR value. Unless you provide your own |
|
|
1106 | L<CBOR::XS> object, this means it will be encoded to a CBOR string not |
|
|
1107 | using any extensions, if possible. |
|
|
1108 | |
|
|
1109 | CBOR values are self-delimiting, so you can write CBOR at one end of |
|
|
1110 | a handle and read them at the other end without using any additional |
|
|
1111 | framing. |
|
|
1112 | |
|
|
1113 | A simple nd very very fast RPC protocol that interoperates with |
|
|
1114 | other languages is to send CBOR and receive CBOR values (arrays are |
|
|
1115 | recommended): |
|
|
1116 | |
|
|
1117 | $handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever |
|
|
1118 | |
|
|
1119 | An AnyEvent::Handle receiver would simply use the C<cbor> read type: |
|
|
1120 | |
|
|
1121 | $handle->push_read (cbor => sub { my $array = $_[1]; ... }); |
|
|
1122 | |
656 | =cut |
1123 | =cut |
|
|
1124 | |
|
|
1125 | sub json_coder() { |
|
|
1126 | eval { require JSON::XS; JSON::XS->new->utf8 } |
|
|
1127 | || do { require JSON::PP; JSON::PP->new->utf8 } |
|
|
1128 | } |
657 | |
1129 | |
658 | register_write_type json => sub { |
1130 | register_write_type json => sub { |
659 | my ($self, $ref) = @_; |
1131 | my ($self, $ref) = @_; |
660 | |
1132 | |
661 | require JSON; |
1133 | ($self->{json} ||= json_coder) |
|
|
1134 | ->encode ($ref) |
|
|
1135 | }; |
662 | |
1136 | |
663 | $self->{json} ? $self->{json}->encode ($ref) |
1137 | sub cbor_coder() { |
664 | : JSON::encode_json ($ref) |
1138 | require CBOR::XS; |
|
|
1139 | CBOR::XS->new |
|
|
1140 | } |
|
|
1141 | |
|
|
1142 | register_write_type cbor => sub { |
|
|
1143 | my ($self, $scalar) = @_; |
|
|
1144 | |
|
|
1145 | ($self->{cbor} ||= cbor_coder) |
|
|
1146 | ->encode ($scalar) |
665 | }; |
1147 | }; |
666 | |
1148 | |
667 | =item storable => $reference |
1149 | =item storable => $reference |
668 | |
1150 | |
669 | Freezes the given reference using L<Storable> and writes it to the |
1151 | Freezes the given reference using L<Storable> and writes it to the |
… | |
… | |
672 | =cut |
1154 | =cut |
673 | |
1155 | |
674 | register_write_type storable => sub { |
1156 | register_write_type storable => sub { |
675 | my ($self, $ref) = @_; |
1157 | my ($self, $ref) = @_; |
676 | |
1158 | |
677 | require Storable; |
1159 | require Storable unless $Storable::VERSION; |
678 | |
1160 | |
679 | pack "w/a*", Storable::nfreeze ($ref) |
1161 | pack "w/a*", Storable::nfreeze ($ref) |
680 | }; |
1162 | }; |
681 | |
1163 | |
682 | =back |
1164 | =back |
683 | |
1165 | |
684 | =item $handle->push_shutdown |
1166 | =item $handle->push_shutdown |
685 | |
1167 | |
686 | Sometimes you know you want to close the socket after writing your data |
1168 | Sometimes you know you want to close the socket after writing your data |
687 | before it was actually written. One way to do that is to replace your |
1169 | before it was actually written. One way to do that is to replace your |
688 | C<on_drain> handler by a callback that shuts down the socket. This method |
1170 | C<on_drain> handler by a callback that shuts down the socket (and set |
689 | is a shorthand for just that, and replaces the C<on_drain> callback with: |
1171 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
|
|
1172 | replaces the C<on_drain> callback with: |
690 | |
1173 | |
691 | sub { shutdown $_[0]{fh}, 1 } # for push_shutdown |
1174 | sub { shutdown $_[0]{fh}, 1 } |
692 | |
1175 | |
693 | This simply shuts down the write side and signals an EOF condition to the |
1176 | This simply shuts down the write side and signals an EOF condition to the |
694 | the peer. |
1177 | the peer. |
695 | |
1178 | |
696 | You can rely on the normal read queue and C<on_eof> handling |
1179 | You can rely on the normal read queue and C<on_eof> handling |
697 | afterwards. This is the cleanest way to close a connection. |
1180 | afterwards. This is the cleanest way to close a connection. |
698 | |
1181 | |
|
|
1182 | This method may invoke callbacks (and therefore the handle might be |
|
|
1183 | destroyed after it returns). |
|
|
1184 | |
699 | =cut |
1185 | =cut |
700 | |
1186 | |
701 | sub push_shutdown { |
1187 | sub push_shutdown { |
|
|
1188 | my ($self) = @_; |
|
|
1189 | |
|
|
1190 | delete $self->{low_water_mark}; |
702 | $_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 }; |
1191 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
703 | } |
1192 | } |
704 | |
1193 | |
705 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
1194 | =item custom write types - Package::anyevent_write_type $handle, @args |
706 | |
1195 | |
707 | This function (not method) lets you add your own types to C<push_write>. |
1196 | Instead of one of the predefined types, you can also specify the name of |
|
|
1197 | a package. AnyEvent will try to load the package and then expects to find |
|
|
1198 | a function named C<anyevent_write_type> inside. If it isn't found, it |
|
|
1199 | progressively tries to load the parent package until it either finds the |
|
|
1200 | function (good) or runs out of packages (bad). |
|
|
1201 | |
708 | Whenever the given C<type> is used, C<push_write> will invoke the code |
1202 | Whenever the given C<type> is used, C<push_write> will the function with |
709 | reference with the handle object and the remaining arguments. |
1203 | the handle object and the remaining arguments. |
710 | |
1204 | |
711 | The code reference is supposed to return a single octet string that will |
1205 | The function is supposed to return a single octet string that will be |
712 | be appended to the write buffer. |
1206 | appended to the write buffer, so you can mentally treat this function as a |
|
|
1207 | "arguments to on-the-wire-format" converter. |
713 | |
1208 | |
714 | Note that this is a function, and all types registered this way will be |
1209 | Example: implement a custom write type C<join> that joins the remaining |
715 | global, so try to use unique names. |
1210 | arguments using the first one. |
|
|
1211 | |
|
|
1212 | $handle->push_write (My::Type => " ", 1,2,3); |
|
|
1213 | |
|
|
1214 | # uses the following package, which can be defined in the "My::Type" or in |
|
|
1215 | # the "My" modules to be auto-loaded, or just about anywhere when the |
|
|
1216 | # My::Type::anyevent_write_type is defined before invoking it. |
|
|
1217 | |
|
|
1218 | package My::Type; |
|
|
1219 | |
|
|
1220 | sub anyevent_write_type { |
|
|
1221 | my ($handle, $delim, @args) = @_; |
|
|
1222 | |
|
|
1223 | join $delim, @args |
|
|
1224 | } |
716 | |
1225 | |
717 | =cut |
1226 | =cut |
718 | |
1227 | |
719 | ############################################################################# |
1228 | ############################################################################# |
720 | |
1229 | |
… | |
… | |
729 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1238 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
730 | a queue. |
1239 | a queue. |
731 | |
1240 | |
732 | In the simple case, you just install an C<on_read> callback and whenever |
1241 | In the simple case, you just install an C<on_read> callback and whenever |
733 | new data arrives, it will be called. You can then remove some data (if |
1242 | new data arrives, it will be called. You can then remove some data (if |
734 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
1243 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can |
735 | leave the data there if you want to accumulate more (e.g. when only a |
1244 | leave the data there if you want to accumulate more (e.g. when only a |
736 | partial message has been received so far). |
1245 | partial message has been received so far), or change the read queue with |
|
|
1246 | e.g. C<push_read>. |
737 | |
1247 | |
738 | In the more complex case, you want to queue multiple callbacks. In this |
1248 | In the more complex case, you want to queue multiple callbacks. In this |
739 | case, AnyEvent::Handle will call the first queued callback each time new |
1249 | case, AnyEvent::Handle will call the first queued callback each time new |
740 | data arrives (also the first time it is queued) and removes it when it has |
1250 | data arrives (also the first time it is queued) and remove it when it has |
741 | done its job (see C<push_read>, below). |
1251 | done its job (see C<push_read>, below). |
742 | |
1252 | |
743 | This way you can, for example, push three line-reads, followed by reading |
1253 | This way you can, for example, push three line-reads, followed by reading |
744 | a chunk of data, and AnyEvent::Handle will execute them in order. |
1254 | a chunk of data, and AnyEvent::Handle will execute them in order. |
745 | |
1255 | |
… | |
… | |
802 | =cut |
1312 | =cut |
803 | |
1313 | |
804 | sub _drain_rbuf { |
1314 | sub _drain_rbuf { |
805 | my ($self) = @_; |
1315 | my ($self) = @_; |
806 | |
1316 | |
|
|
1317 | # avoid recursion |
|
|
1318 | return if $self->{_skip_drain_rbuf}; |
807 | local $self->{_in_drain} = 1; |
1319 | local $self->{_skip_drain_rbuf} = 1; |
808 | |
|
|
809 | if ( |
|
|
810 | defined $self->{rbuf_max} |
|
|
811 | && $self->{rbuf_max} < length $self->{rbuf} |
|
|
812 | ) { |
|
|
813 | $self->_error (&Errno::ENOSPC, 1), return; |
|
|
814 | } |
|
|
815 | |
1320 | |
816 | while () { |
1321 | while () { |
817 | # we need to use a separate tls read buffer, as we must not receive data while |
1322 | # we need to use a separate tls read buffer, as we must not receive data while |
818 | # we are draining the buffer, and this can only happen with TLS. |
1323 | # we are draining the buffer, and this can only happen with TLS. |
819 | $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf}; |
1324 | $self->{rbuf} .= delete $self->{_tls_rbuf} |
|
|
1325 | if exists $self->{_tls_rbuf}; |
820 | |
1326 | |
821 | my $len = length $self->{rbuf}; |
1327 | my $len = length $self->{rbuf}; |
822 | |
1328 | |
823 | if (my $cb = shift @{ $self->{_queue} }) { |
1329 | if (my $cb = shift @{ $self->{_queue} }) { |
824 | unless ($cb->($self)) { |
1330 | unless ($cb->($self)) { |
825 | if ($self->{_eof}) { |
1331 | # no progress can be made |
826 | # no progress can be made (not enough data and no data forthcoming) |
1332 | # (not enough data and no data forthcoming) |
827 | $self->_error (&Errno::EPIPE, 1), return; |
1333 | $self->_error (Errno::EPIPE, 1), return |
828 | } |
1334 | if $self->{_eof}; |
829 | |
1335 | |
830 | unshift @{ $self->{_queue} }, $cb; |
1336 | unshift @{ $self->{_queue} }, $cb; |
831 | last; |
1337 | last; |
832 | } |
1338 | } |
833 | } elsif ($self->{on_read}) { |
1339 | } elsif ($self->{on_read}) { |
… | |
… | |
840 | && !@{ $self->{_queue} } # and the queue is still empty |
1346 | && !@{ $self->{_queue} } # and the queue is still empty |
841 | && $self->{on_read} # but we still have on_read |
1347 | && $self->{on_read} # but we still have on_read |
842 | ) { |
1348 | ) { |
843 | # no further data will arrive |
1349 | # no further data will arrive |
844 | # so no progress can be made |
1350 | # so no progress can be made |
845 | $self->_error (&Errno::EPIPE, 1), return |
1351 | $self->_error (Errno::EPIPE, 1), return |
846 | if $self->{_eof}; |
1352 | if $self->{_eof}; |
847 | |
1353 | |
848 | last; # more data might arrive |
1354 | last; # more data might arrive |
849 | } |
1355 | } |
850 | } else { |
1356 | } else { |
… | |
… | |
853 | last; |
1359 | last; |
854 | } |
1360 | } |
855 | } |
1361 | } |
856 | |
1362 | |
857 | if ($self->{_eof}) { |
1363 | if ($self->{_eof}) { |
858 | if ($self->{on_eof}) { |
1364 | $self->{on_eof} |
859 | $self->{on_eof}($self) |
1365 | ? $self->{on_eof}($self) |
860 | } else { |
|
|
861 | $self->_error (0, 1, "Unexpected end-of-file"); |
1366 | : $self->_error (0, 1, "Unexpected end-of-file"); |
862 | } |
1367 | |
|
|
1368 | return; |
|
|
1369 | } |
|
|
1370 | |
|
|
1371 | if ( |
|
|
1372 | defined $self->{rbuf_max} |
|
|
1373 | && $self->{rbuf_max} < length $self->{rbuf} |
|
|
1374 | ) { |
|
|
1375 | $self->_error (Errno::ENOSPC, 1), return; |
863 | } |
1376 | } |
864 | |
1377 | |
865 | # may need to restart read watcher |
1378 | # may need to restart read watcher |
866 | unless ($self->{_rw}) { |
1379 | unless ($self->{_rw}) { |
867 | $self->start_read |
1380 | $self->start_read |
… | |
… | |
873 | |
1386 | |
874 | This replaces the currently set C<on_read> callback, or clears it (when |
1387 | This replaces the currently set C<on_read> callback, or clears it (when |
875 | the new callback is C<undef>). See the description of C<on_read> in the |
1388 | the new callback is C<undef>). See the description of C<on_read> in the |
876 | constructor. |
1389 | constructor. |
877 | |
1390 | |
|
|
1391 | This method may invoke callbacks (and therefore the handle might be |
|
|
1392 | destroyed after it returns). |
|
|
1393 | |
878 | =cut |
1394 | =cut |
879 | |
1395 | |
880 | sub on_read { |
1396 | sub on_read { |
881 | my ($self, $cb) = @_; |
1397 | my ($self, $cb) = @_; |
882 | |
1398 | |
883 | $self->{on_read} = $cb; |
1399 | $self->{on_read} = $cb; |
884 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
1400 | $self->_drain_rbuf if $cb; |
885 | } |
1401 | } |
886 | |
1402 | |
887 | =item $handle->rbuf |
1403 | =item $handle->rbuf |
888 | |
1404 | |
889 | Returns the read buffer (as a modifiable lvalue). |
1405 | Returns the read buffer (as a modifiable lvalue). You can also access the |
|
|
1406 | read buffer directly as the C<< ->{rbuf} >> member, if you want (this is |
|
|
1407 | much faster, and no less clean). |
890 | |
1408 | |
891 | You can access the read buffer directly as the C<< ->{rbuf} >> |
1409 | The only operation allowed on the read buffer (apart from looking at it) |
892 | member, if you want. However, the only operation allowed on the |
1410 | is removing data from its beginning. Otherwise modifying or appending to |
893 | read buffer (apart from looking at it) is removing data from its |
1411 | it is not allowed and will lead to hard-to-track-down bugs. |
894 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
895 | lead to hard-to-track-down bugs. |
|
|
896 | |
1412 | |
897 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
1413 | NOTE: The read buffer should only be used or modified in the C<on_read> |
898 | C<push_read> or C<unshift_read> methods are used. The other read methods |
1414 | callback or when C<push_read> or C<unshift_read> are used with a single |
899 | automatically manage the read buffer. |
1415 | callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods |
|
|
1416 | will manage the read buffer on their own. |
900 | |
1417 | |
901 | =cut |
1418 | =cut |
902 | |
1419 | |
903 | sub rbuf : lvalue { |
1420 | sub rbuf : lvalue { |
904 | $_[0]{rbuf} |
1421 | $_[0]{rbuf} |
… | |
… | |
921 | |
1438 | |
922 | If enough data was available, then the callback must remove all data it is |
1439 | If enough data was available, then the callback must remove all data it is |
923 | interested in (which can be none at all) and return a true value. After returning |
1440 | interested in (which can be none at all) and return a true value. After returning |
924 | true, it will be removed from the queue. |
1441 | true, it will be removed from the queue. |
925 | |
1442 | |
|
|
1443 | These methods may invoke callbacks (and therefore the handle might be |
|
|
1444 | destroyed after it returns). |
|
|
1445 | |
926 | =cut |
1446 | =cut |
927 | |
1447 | |
928 | our %RH; |
1448 | our %RH; |
929 | |
1449 | |
930 | sub register_read_type($$) { |
1450 | sub register_read_type($$) { |
… | |
… | |
936 | my $cb = pop; |
1456 | my $cb = pop; |
937 | |
1457 | |
938 | if (@_) { |
1458 | if (@_) { |
939 | my $type = shift; |
1459 | my $type = shift; |
940 | |
1460 | |
|
|
1461 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
941 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
1462 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read") |
942 | ->($self, $cb, @_); |
1463 | ->($self, $cb, @_); |
943 | } |
1464 | } |
944 | |
1465 | |
945 | push @{ $self->{_queue} }, $cb; |
1466 | push @{ $self->{_queue} }, $cb; |
946 | $self->_drain_rbuf unless $self->{_in_drain}; |
1467 | $self->_drain_rbuf; |
947 | } |
1468 | } |
948 | |
1469 | |
949 | sub unshift_read { |
1470 | sub unshift_read { |
950 | my $self = shift; |
1471 | my $self = shift; |
951 | my $cb = pop; |
1472 | my $cb = pop; |
952 | |
1473 | |
953 | if (@_) { |
1474 | if (@_) { |
954 | my $type = shift; |
1475 | my $type = shift; |
955 | |
1476 | |
|
|
1477 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
956 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
1478 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read") |
957 | ->($self, $cb, @_); |
1479 | ->($self, $cb, @_); |
958 | } |
1480 | } |
959 | |
1481 | |
960 | |
|
|
961 | unshift @{ $self->{_queue} }, $cb; |
1482 | unshift @{ $self->{_queue} }, $cb; |
962 | $self->_drain_rbuf unless $self->{_in_drain}; |
1483 | $self->_drain_rbuf; |
963 | } |
1484 | } |
964 | |
1485 | |
965 | =item $handle->push_read (type => @args, $cb) |
1486 | =item $handle->push_read (type => @args, $cb) |
966 | |
1487 | |
967 | =item $handle->unshift_read (type => @args, $cb) |
1488 | =item $handle->unshift_read (type => @args, $cb) |
968 | |
1489 | |
969 | Instead of providing a callback that parses the data itself you can chose |
1490 | Instead of providing a callback that parses the data itself you can chose |
970 | between a number of predefined parsing formats, for chunks of data, lines |
1491 | between a number of predefined parsing formats, for chunks of data, lines |
971 | etc. |
1492 | etc. You can also specify the (fully qualified) name of a package, in |
|
|
1493 | which case AnyEvent tries to load the package and then expects to find the |
|
|
1494 | C<anyevent_read_type> function inside (see "custom read types", below). |
972 | |
1495 | |
973 | Predefined types are (if you have ideas for additional types, feel free to |
1496 | Predefined types are (if you have ideas for additional types, feel free to |
974 | drop by and tell us): |
1497 | drop by and tell us): |
975 | |
1498 | |
976 | =over 4 |
1499 | =over 4 |
… | |
… | |
982 | data. |
1505 | data. |
983 | |
1506 | |
984 | Example: read 2 bytes. |
1507 | Example: read 2 bytes. |
985 | |
1508 | |
986 | $handle->push_read (chunk => 2, sub { |
1509 | $handle->push_read (chunk => 2, sub { |
987 | warn "yay ", unpack "H*", $_[1]; |
1510 | say "yay " . unpack "H*", $_[1]; |
988 | }); |
1511 | }); |
989 | |
1512 | |
990 | =cut |
1513 | =cut |
991 | |
1514 | |
992 | register_read_type chunk => sub { |
1515 | register_read_type chunk => sub { |
… | |
… | |
1022 | |
1545 | |
1023 | register_read_type line => sub { |
1546 | register_read_type line => sub { |
1024 | my ($self, $cb, $eol) = @_; |
1547 | my ($self, $cb, $eol) = @_; |
1025 | |
1548 | |
1026 | if (@_ < 3) { |
1549 | if (@_ < 3) { |
1027 | # this is more than twice as fast as the generic code below |
1550 | # this is faster then the generic code below |
1028 | sub { |
1551 | sub { |
1029 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1552 | (my $pos = index $_[0]{rbuf}, "\012") >= 0 |
|
|
1553 | or return; |
1030 | |
1554 | |
|
|
1555 | (my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die; |
1031 | $cb->($_[0], $1, $2); |
1556 | $cb->($_[0], $str, "$1"); |
1032 | 1 |
1557 | 1 |
1033 | } |
1558 | } |
1034 | } else { |
1559 | } else { |
1035 | $eol = quotemeta $eol unless ref $eol; |
1560 | $eol = quotemeta $eol unless ref $eol; |
1036 | $eol = qr|^(.*?)($eol)|s; |
1561 | $eol = qr|^(.*?)($eol)|s; |
1037 | |
1562 | |
1038 | sub { |
1563 | sub { |
1039 | $_[0]{rbuf} =~ s/$eol// or return; |
1564 | $_[0]{rbuf} =~ s/$eol// or return; |
1040 | |
1565 | |
1041 | $cb->($_[0], $1, $2); |
1566 | $cb->($_[0], "$1", "$2"); |
1042 | 1 |
1567 | 1 |
1043 | } |
1568 | } |
1044 | } |
1569 | } |
1045 | }; |
1570 | }; |
1046 | |
1571 | |
… | |
… | |
1068 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1593 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1069 | and everything preceding and including the match will be accepted |
1594 | and everything preceding and including the match will be accepted |
1070 | unconditionally. This is useful to skip large amounts of data that you |
1595 | unconditionally. This is useful to skip large amounts of data that you |
1071 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1596 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1072 | have to start matching from the beginning. This is purely an optimisation |
1597 | have to start matching from the beginning. This is purely an optimisation |
1073 | and is usually worth only when you expect more than a few kilobytes. |
1598 | and is usually worth it only when you expect more than a few kilobytes. |
1074 | |
1599 | |
1075 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1600 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1076 | expect the header to be very large (it isn't in practise, but...), we use |
1601 | expect the header to be very large (it isn't in practice, but...), we use |
1077 | a skip regex to skip initial portions. The skip regex is tricky in that |
1602 | a skip regex to skip initial portions. The skip regex is tricky in that |
1078 | it only accepts something not ending in either \015 or \012, as these are |
1603 | it only accepts something not ending in either \015 or \012, as these are |
1079 | required for the accept regex. |
1604 | required for the accept regex. |
1080 | |
1605 | |
1081 | $handle->push_read (regex => |
1606 | $handle->push_read (regex => |
… | |
… | |
1094 | |
1619 | |
1095 | sub { |
1620 | sub { |
1096 | # accept |
1621 | # accept |
1097 | if ($$rbuf =~ $accept) { |
1622 | if ($$rbuf =~ $accept) { |
1098 | $data .= substr $$rbuf, 0, $+[0], ""; |
1623 | $data .= substr $$rbuf, 0, $+[0], ""; |
1099 | $cb->($self, $data); |
1624 | $cb->($_[0], $data); |
1100 | return 1; |
1625 | return 1; |
1101 | } |
1626 | } |
1102 | |
1627 | |
1103 | # reject |
1628 | # reject |
1104 | if ($reject && $$rbuf =~ $reject) { |
1629 | if ($reject && $$rbuf =~ $reject) { |
1105 | $self->_error (&Errno::EBADMSG); |
1630 | $_[0]->_error (Errno::EBADMSG); |
1106 | } |
1631 | } |
1107 | |
1632 | |
1108 | # skip |
1633 | # skip |
1109 | if ($skip && $$rbuf =~ $skip) { |
1634 | if ($skip && $$rbuf =~ $skip) { |
1110 | $data .= substr $$rbuf, 0, $+[0], ""; |
1635 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
1126 | my ($self, $cb) = @_; |
1651 | my ($self, $cb) = @_; |
1127 | |
1652 | |
1128 | sub { |
1653 | sub { |
1129 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1654 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1130 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1655 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1131 | $self->_error (&Errno::EBADMSG); |
1656 | $_[0]->_error (Errno::EBADMSG); |
1132 | } |
1657 | } |
1133 | return; |
1658 | return; |
1134 | } |
1659 | } |
1135 | |
1660 | |
1136 | my $len = $1; |
1661 | my $len = $1; |
1137 | |
1662 | |
1138 | $self->unshift_read (chunk => $len, sub { |
1663 | $_[0]->unshift_read (chunk => $len, sub { |
1139 | my $string = $_[1]; |
1664 | my $string = $_[1]; |
1140 | $_[0]->unshift_read (chunk => 1, sub { |
1665 | $_[0]->unshift_read (chunk => 1, sub { |
1141 | if ($_[1] eq ",") { |
1666 | if ($_[1] eq ",") { |
1142 | $cb->($_[0], $string); |
1667 | $cb->($_[0], $string); |
1143 | } else { |
1668 | } else { |
1144 | $self->_error (&Errno::EBADMSG); |
1669 | $_[0]->_error (Errno::EBADMSG); |
1145 | } |
1670 | } |
1146 | }); |
1671 | }); |
1147 | }); |
1672 | }); |
1148 | |
1673 | |
1149 | 1 |
1674 | 1 |
… | |
… | |
1199 | =item json => $cb->($handle, $hash_or_arrayref) |
1724 | =item json => $cb->($handle, $hash_or_arrayref) |
1200 | |
1725 | |
1201 | Reads a JSON object or array, decodes it and passes it to the |
1726 | Reads a JSON object or array, decodes it and passes it to the |
1202 | callback. When a parse error occurs, an C<EBADMSG> error will be raised. |
1727 | callback. When a parse error occurs, an C<EBADMSG> error will be raised. |
1203 | |
1728 | |
1204 | If a C<json> object was passed to the constructor, then that will be used |
1729 | If a C<json> object was passed to the constructor, then that will be |
1205 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1730 | used for the final decode, otherwise it will create a L<JSON::XS> or |
|
|
1731 | L<JSON::PP> coder object expecting UTF-8. |
1206 | |
1732 | |
1207 | This read type uses the incremental parser available with JSON version |
1733 | This read type uses the incremental parser available with JSON version |
1208 | 2.09 (and JSON::XS version 2.2) and above. You have to provide a |
1734 | 2.09 (and JSON::XS version 2.2) and above. |
1209 | dependency on your own: this module will load the JSON module, but |
|
|
1210 | AnyEvent does not depend on it itself. |
|
|
1211 | |
1735 | |
1212 | Since JSON texts are fully self-delimiting, the C<json> read and write |
1736 | Since JSON texts are fully self-delimiting, the C<json> read and write |
1213 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
1737 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
1214 | the C<json> write type description, above, for an actual example. |
1738 | the C<json> write type description, above, for an actual example. |
1215 | |
1739 | |
1216 | =cut |
1740 | =cut |
1217 | |
1741 | |
1218 | register_read_type json => sub { |
1742 | register_read_type json => sub { |
1219 | my ($self, $cb) = @_; |
1743 | my ($self, $cb) = @_; |
1220 | |
1744 | |
1221 | my $json = $self->{json} ||= |
1745 | my $json = $self->{json} ||= json_coder; |
1222 | eval { require JSON::XS; JSON::XS->new->utf8 } |
|
|
1223 | || do { require JSON; JSON->new->utf8 }; |
|
|
1224 | |
1746 | |
1225 | my $data; |
1747 | my $data; |
1226 | my $rbuf = \$self->{rbuf}; |
|
|
1227 | |
1748 | |
1228 | sub { |
1749 | sub { |
1229 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1750 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1230 | |
1751 | |
1231 | if ($ref) { |
1752 | if ($ref) { |
1232 | $self->{rbuf} = $json->incr_text; |
1753 | $_[0]{rbuf} = $json->incr_text; |
1233 | $json->incr_text = ""; |
1754 | $json->incr_text = ""; |
1234 | $cb->($self, $ref); |
1755 | $cb->($_[0], $ref); |
1235 | |
1756 | |
1236 | 1 |
1757 | 1 |
1237 | } elsif ($@) { |
1758 | } elsif ($@) { |
1238 | # error case |
1759 | # error case |
1239 | $json->incr_skip; |
1760 | $json->incr_skip; |
1240 | |
1761 | |
1241 | $self->{rbuf} = $json->incr_text; |
1762 | $_[0]{rbuf} = $json->incr_text; |
1242 | $json->incr_text = ""; |
1763 | $json->incr_text = ""; |
1243 | |
1764 | |
1244 | $self->_error (&Errno::EBADMSG); |
1765 | $_[0]->_error (Errno::EBADMSG); |
1245 | |
1766 | |
1246 | () |
1767 | () |
1247 | } else { |
1768 | } else { |
1248 | $self->{rbuf} = ""; |
1769 | $_[0]{rbuf} = ""; |
1249 | |
1770 | |
|
|
1771 | () |
|
|
1772 | } |
|
|
1773 | } |
|
|
1774 | }; |
|
|
1775 | |
|
|
1776 | =item cbor => $cb->($handle, $scalar) |
|
|
1777 | |
|
|
1778 | Reads a CBOR value, decodes it and passes it to the callback. When a parse |
|
|
1779 | error occurs, an C<EBADMSG> error will be raised. |
|
|
1780 | |
|
|
1781 | If a L<CBOR::XS> object was passed to the constructor, then that will be |
|
|
1782 | used for the final decode, otherwise it will create a CBOR coder without |
|
|
1783 | enabling any options. |
|
|
1784 | |
|
|
1785 | You have to provide a dependency to L<CBOR::XS> on your own: this module |
|
|
1786 | will load the L<CBOR::XS> module, but AnyEvent does not depend on it |
|
|
1787 | itself. |
|
|
1788 | |
|
|
1789 | Since CBOR values are fully self-delimiting, the C<cbor> read and write |
|
|
1790 | types are an ideal simple RPC protocol: just exchange CBOR datagrams. See |
|
|
1791 | the C<cbor> write type description, above, for an actual example. |
|
|
1792 | |
|
|
1793 | =cut |
|
|
1794 | |
|
|
1795 | register_read_type cbor => sub { |
|
|
1796 | my ($self, $cb) = @_; |
|
|
1797 | |
|
|
1798 | my $cbor = $self->{cbor} ||= cbor_coder; |
|
|
1799 | |
|
|
1800 | my $data; |
|
|
1801 | |
|
|
1802 | sub { |
|
|
1803 | my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) }; |
|
|
1804 | |
|
|
1805 | if (@value) { |
|
|
1806 | $cb->($_[0], @value); |
|
|
1807 | |
|
|
1808 | 1 |
|
|
1809 | } elsif ($@) { |
|
|
1810 | # error case |
|
|
1811 | $cbor->incr_reset; |
|
|
1812 | |
|
|
1813 | $_[0]->_error (Errno::EBADMSG); |
|
|
1814 | |
|
|
1815 | () |
|
|
1816 | } else { |
1250 | () |
1817 | () |
1251 | } |
1818 | } |
1252 | } |
1819 | } |
1253 | }; |
1820 | }; |
1254 | |
1821 | |
… | |
… | |
1263 | =cut |
1830 | =cut |
1264 | |
1831 | |
1265 | register_read_type storable => sub { |
1832 | register_read_type storable => sub { |
1266 | my ($self, $cb) = @_; |
1833 | my ($self, $cb) = @_; |
1267 | |
1834 | |
1268 | require Storable; |
1835 | require Storable unless $Storable::VERSION; |
1269 | |
1836 | |
1270 | sub { |
1837 | sub { |
1271 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1838 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1272 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1839 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1273 | or return; |
1840 | or return; |
… | |
… | |
1276 | |
1843 | |
1277 | # bypass unshift if we already have the remaining chunk |
1844 | # bypass unshift if we already have the remaining chunk |
1278 | if ($format + $len <= length $_[0]{rbuf}) { |
1845 | if ($format + $len <= length $_[0]{rbuf}) { |
1279 | my $data = substr $_[0]{rbuf}, $format, $len; |
1846 | my $data = substr $_[0]{rbuf}, $format, $len; |
1280 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
1847 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1848 | |
1281 | $cb->($_[0], Storable::thaw ($data)); |
1849 | eval { $cb->($_[0], Storable::thaw ($data)); 1 } |
|
|
1850 | or return $_[0]->_error (Errno::EBADMSG); |
1282 | } else { |
1851 | } else { |
1283 | # remove prefix |
1852 | # remove prefix |
1284 | substr $_[0]{rbuf}, 0, $format, ""; |
1853 | substr $_[0]{rbuf}, 0, $format, ""; |
1285 | |
1854 | |
1286 | # read remaining chunk |
1855 | # read remaining chunk |
1287 | $_[0]->unshift_read (chunk => $len, sub { |
1856 | $_[0]->unshift_read (chunk => $len, sub { |
1288 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1857 | eval { $cb->($_[0], Storable::thaw ($_[1])); 1 } |
1289 | $cb->($_[0], $ref); |
|
|
1290 | } else { |
|
|
1291 | $self->_error (&Errno::EBADMSG); |
1858 | or $_[0]->_error (Errno::EBADMSG); |
1292 | } |
|
|
1293 | }); |
1859 | }); |
1294 | } |
1860 | } |
1295 | |
1861 | |
1296 | 1 |
1862 | 1 |
1297 | } |
1863 | } |
1298 | }; |
1864 | }; |
1299 | |
1865 | |
|
|
1866 | =item tls_detect => $cb->($handle, $detect, $major, $minor) |
|
|
1867 | |
|
|
1868 | Checks the input stream for a valid SSL or TLS handshake TLSPaintext |
|
|
1869 | record without consuming anything. Only SSL version 3 or higher |
|
|
1870 | is handled, up to the fictituous protocol 4.x (but both SSL3+ and |
|
|
1871 | SSL2-compatible framing is supported). |
|
|
1872 | |
|
|
1873 | If it detects that the input data is likely TLS, it calls the callback |
|
|
1874 | with a true value for C<$detect> and the (on-wire) TLS version as second |
|
|
1875 | and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL |
|
|
1876 | 3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to |
|
|
1877 | be definitely not TLS, it calls the callback with a false value for |
|
|
1878 | C<$detect>. |
|
|
1879 | |
|
|
1880 | The callback could use this information to decide whether or not to start |
|
|
1881 | TLS negotiation. |
|
|
1882 | |
|
|
1883 | In all cases the data read so far is passed to the following read |
|
|
1884 | handlers. |
|
|
1885 | |
|
|
1886 | Usually you want to use the C<tls_autostart> read type instead. |
|
|
1887 | |
|
|
1888 | If you want to design a protocol that works in the presence of TLS |
|
|
1889 | dtection, make sure that any non-TLS data doesn't start with the octet 22 |
|
|
1890 | (ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this |
|
|
1891 | read type does are a bit more strict, but might losen in the future to |
|
|
1892 | accomodate protocol changes. |
|
|
1893 | |
|
|
1894 | This read type does not rely on L<AnyEvent::TLS> (and thus, not on |
|
|
1895 | L<Net::SSLeay>). |
|
|
1896 | |
|
|
1897 | =item tls_autostart => $tls[, $tls_ctx] |
|
|
1898 | |
|
|
1899 | Tries to detect a valid SSL or TLS handshake. If one is detected, it tries |
|
|
1900 | to start tls by calling C<starttls> with the given arguments. |
|
|
1901 | |
|
|
1902 | In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has |
|
|
1903 | been configured to accept, as servers do not normally send a handshake on |
|
|
1904 | their own and ths cannot be detected in this way. |
|
|
1905 | |
|
|
1906 | See C<tls_detect> above for more details. |
|
|
1907 | |
|
|
1908 | Example: give the client a chance to start TLS before accepting a text |
|
|
1909 | line. |
|
|
1910 | |
|
|
1911 | $hdl->push_read (tls_detect => "accept"); |
|
|
1912 | $hdl->push_read (line => sub { |
|
|
1913 | print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n"; |
|
|
1914 | }); |
|
|
1915 | |
|
|
1916 | =cut |
|
|
1917 | |
|
|
1918 | register_read_type tls_detect => sub { |
|
|
1919 | my ($self, $cb) = @_; |
|
|
1920 | |
|
|
1921 | sub { |
|
|
1922 | # this regex matches a full or partial tls record |
|
|
1923 | if ( |
|
|
1924 | # ssl3+: type(22=handshake) major(=3) minor(any) length_hi |
|
|
1925 | $self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs |
|
|
1926 | # ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength) |
|
|
1927 | or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs |
|
|
1928 | ) { |
|
|
1929 | return if 3 != length $1; # partial match, can't decide yet |
|
|
1930 | |
|
|
1931 | # full match, valid TLS record |
|
|
1932 | my ($major, $minor) = unpack "CC", $1; |
|
|
1933 | $cb->($self, "accept", $major + $minor * 0.1); |
|
|
1934 | } else { |
|
|
1935 | # mismatch == guaranteed not TLS |
|
|
1936 | $cb->($self, undef); |
|
|
1937 | } |
|
|
1938 | |
|
|
1939 | 1 |
|
|
1940 | } |
|
|
1941 | }; |
|
|
1942 | |
|
|
1943 | register_read_type tls_autostart => sub { |
|
|
1944 | my ($self, @tls) = @_; |
|
|
1945 | |
|
|
1946 | $RH{tls_detect}($self, sub { |
|
|
1947 | return unless $_[1]; |
|
|
1948 | $_[0]->starttls (@tls); |
|
|
1949 | }) |
|
|
1950 | }; |
|
|
1951 | |
1300 | =back |
1952 | =back |
1301 | |
1953 | |
1302 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1954 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
1303 | |
1955 | |
1304 | This function (not method) lets you add your own types to C<push_read>. |
1956 | Instead of one of the predefined types, you can also specify the name |
|
|
1957 | of a package. AnyEvent will try to load the package and then expects to |
|
|
1958 | find a function named C<anyevent_read_type> inside. If it isn't found, it |
|
|
1959 | progressively tries to load the parent package until it either finds the |
|
|
1960 | function (good) or runs out of packages (bad). |
1305 | |
1961 | |
1306 | Whenever the given C<type> is used, C<push_read> will invoke the code |
1962 | Whenever this type is used, C<push_read> will invoke the function with the |
1307 | reference with the handle object, the callback and the remaining |
1963 | handle object, the original callback and the remaining arguments. |
1308 | arguments. |
|
|
1309 | |
1964 | |
1310 | The code reference is supposed to return a callback (usually a closure) |
1965 | The function is supposed to return a callback (usually a closure) that |
1311 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
1966 | works as a plain read callback (see C<< ->push_read ($cb) >>), so you can |
|
|
1967 | mentally treat the function as a "configurable read type to read callback" |
|
|
1968 | converter. |
1312 | |
1969 | |
1313 | It should invoke the passed callback when it is done reading (remember to |
1970 | It should invoke the original callback when it is done reading (remember |
1314 | pass C<$handle> as first argument as all other callbacks do that). |
1971 | to pass C<$handle> as first argument as all other callbacks do that, |
|
|
1972 | although there is no strict requirement on this). |
1315 | |
1973 | |
1316 | Note that this is a function, and all types registered this way will be |
|
|
1317 | global, so try to use unique names. |
|
|
1318 | |
|
|
1319 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
1974 | For examples, see the source of this module (F<perldoc -m |
1320 | search for C<register_read_type>)). |
1975 | AnyEvent::Handle>, search for C<register_read_type>)). |
1321 | |
1976 | |
1322 | =item $handle->stop_read |
1977 | =item $handle->stop_read |
1323 | |
1978 | |
1324 | =item $handle->start_read |
1979 | =item $handle->start_read |
1325 | |
1980 | |
… | |
… | |
1331 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1986 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1332 | you change the C<on_read> callback or push/unshift a read callback, and it |
1987 | you change the C<on_read> callback or push/unshift a read callback, and it |
1333 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1988 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1334 | there are any read requests in the queue. |
1989 | there are any read requests in the queue. |
1335 | |
1990 | |
1336 | These methods will have no effect when in TLS mode (as TLS doesn't support |
1991 | In older versions of this module (<= 5.3), these methods had no effect, |
1337 | half-duplex connections). |
1992 | as TLS does not support half-duplex connections. In current versions they |
|
|
1993 | work as expected, as this behaviour is required to avoid certain resource |
|
|
1994 | attacks, where the program would be forced to read (and buffer) arbitrary |
|
|
1995 | amounts of data before being able to send some data. The drawback is that |
|
|
1996 | some readings of the the SSL/TLS specifications basically require this |
|
|
1997 | attack to be working, as SSL/TLS implementations might stall sending data |
|
|
1998 | during a rehandshake. |
|
|
1999 | |
|
|
2000 | As a guideline, during the initial handshake, you should not stop reading, |
|
|
2001 | and as a client, it might cause problems, depending on your application. |
1338 | |
2002 | |
1339 | =cut |
2003 | =cut |
1340 | |
2004 | |
1341 | sub stop_read { |
2005 | sub stop_read { |
1342 | my ($self) = @_; |
2006 | my ($self) = @_; |
1343 | |
2007 | |
1344 | delete $self->{_rw} unless $self->{tls}; |
2008 | delete $self->{_rw}; |
1345 | } |
2009 | } |
1346 | |
2010 | |
1347 | sub start_read { |
2011 | sub start_read { |
1348 | my ($self) = @_; |
2012 | my ($self) = @_; |
1349 | |
2013 | |
1350 | unless ($self->{_rw} || $self->{_eof}) { |
2014 | unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) { |
1351 | Scalar::Util::weaken $self; |
2015 | Scalar::Util::weaken $self; |
1352 | |
2016 | |
1353 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
2017 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1354 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
2018 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1355 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
2019 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf; |
1356 | |
2020 | |
1357 | if ($len > 0) { |
2021 | if ($len > 0) { |
1358 | $self->{_activity} = AnyEvent->now; |
2022 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1359 | |
2023 | |
1360 | if ($self->{tls}) { |
2024 | if ($self->{tls}) { |
1361 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
2025 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1362 | |
2026 | |
1363 | &_dotls ($self); |
2027 | &_dotls ($self); |
1364 | } else { |
2028 | } else { |
1365 | $self->_drain_rbuf unless $self->{_in_drain}; |
2029 | $self->_drain_rbuf; |
|
|
2030 | } |
|
|
2031 | |
|
|
2032 | if ($len == $self->{read_size}) { |
|
|
2033 | $self->{read_size} *= 2; |
|
|
2034 | $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE |
|
|
2035 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
1366 | } |
2036 | } |
1367 | |
2037 | |
1368 | } elsif (defined $len) { |
2038 | } elsif (defined $len) { |
1369 | delete $self->{_rw}; |
2039 | delete $self->{_rw}; |
1370 | $self->{_eof} = 1; |
2040 | $self->{_eof} = 1; |
1371 | $self->_drain_rbuf unless $self->{_in_drain}; |
2041 | $self->_drain_rbuf; |
1372 | |
2042 | |
1373 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
2043 | } elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) { |
1374 | return $self->_error ($!, 1); |
2044 | return $self->_error ($!, 1); |
1375 | } |
2045 | } |
1376 | }); |
2046 | }; |
1377 | } |
2047 | } |
1378 | } |
2048 | } |
1379 | |
2049 | |
1380 | our $ERROR_SYSCALL; |
2050 | our $ERROR_SYSCALL; |
1381 | our $ERROR_WANT_READ; |
2051 | our $ERROR_WANT_READ; |
1382 | our $ERROR_ZERO_RETURN; |
|
|
1383 | |
2052 | |
1384 | sub _tls_error { |
2053 | sub _tls_error { |
1385 | my ($self, $err) = @_; |
2054 | my ($self, $err) = @_; |
1386 | |
2055 | |
1387 | return $self->_error ($!, 1) |
2056 | return $self->_error ($!, 1) |
1388 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
2057 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
1389 | |
2058 | |
1390 | my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
2059 | my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
1391 | |
2060 | |
1392 | # reduce error string to look less scary |
2061 | # reduce error string to look less scary |
1393 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
2062 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
1394 | |
2063 | |
|
|
2064 | if ($self->{_on_starttls}) { |
|
|
2065 | (delete $self->{_on_starttls})->($self, undef, $err); |
|
|
2066 | &_freetls; |
|
|
2067 | } else { |
|
|
2068 | &_freetls; |
1395 | $self->_error (&Errno::EPROTO, 1, $err); |
2069 | $self->_error (Errno::EPROTO, 1, $err); |
|
|
2070 | } |
1396 | } |
2071 | } |
1397 | |
2072 | |
1398 | # poll the write BIO and send the data if applicable |
2073 | # poll the write BIO and send the data if applicable |
1399 | # also decode read data if possible |
2074 | # also decode read data if possible |
1400 | # this is basiclaly our TLS state machine |
2075 | # this is basiclaly our TLS state machine |
… | |
… | |
1403 | sub _dotls { |
2078 | sub _dotls { |
1404 | my ($self) = @_; |
2079 | my ($self) = @_; |
1405 | |
2080 | |
1406 | my $tmp; |
2081 | my $tmp; |
1407 | |
2082 | |
1408 | if (length $self->{_tls_wbuf}) { |
2083 | while (length $self->{_tls_wbuf}) { |
1409 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
2084 | if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) { |
1410 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
2085 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
|
|
2086 | |
|
|
2087 | return $self->_tls_error ($tmp) |
|
|
2088 | if $tmp != $ERROR_WANT_READ |
|
|
2089 | && ($tmp != $ERROR_SYSCALL || $!); |
|
|
2090 | |
|
|
2091 | last; |
1411 | } |
2092 | } |
1412 | |
2093 | |
1413 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
2094 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1414 | return $self->_tls_error ($tmp) |
|
|
1415 | if $tmp != $ERROR_WANT_READ |
|
|
1416 | && ($tmp != $ERROR_SYSCALL || $!) |
|
|
1417 | && $tmp != $ERROR_ZERO_RETURN; |
|
|
1418 | } |
2095 | } |
1419 | |
2096 | |
1420 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
2097 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1421 | unless (length $tmp) { |
2098 | unless (length $tmp) { |
1422 | # let's treat SSL-eof as we treat normal EOF |
2099 | $self->{_on_starttls} |
1423 | delete $self->{_rw}; |
2100 | and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ??? |
1424 | $self->{_eof} = 1; |
|
|
1425 | &_freetls; |
2101 | &_freetls; |
|
|
2102 | |
|
|
2103 | if ($self->{on_stoptls}) { |
|
|
2104 | $self->{on_stoptls}($self); |
|
|
2105 | return; |
|
|
2106 | } else { |
|
|
2107 | # let's treat SSL-eof as we treat normal EOF |
|
|
2108 | delete $self->{_rw}; |
|
|
2109 | $self->{_eof} = 1; |
|
|
2110 | } |
1426 | } |
2111 | } |
1427 | |
2112 | |
1428 | $self->{_tls_rbuf} .= $tmp; |
2113 | $self->{_tls_rbuf} .= $tmp; |
1429 | $self->_drain_rbuf unless $self->{_in_drain}; |
2114 | $self->_drain_rbuf; |
1430 | $self->{tls} or return; # tls session might have gone away in callback |
2115 | $self->{tls} or return; # tls session might have gone away in callback |
1431 | } |
2116 | } |
1432 | |
2117 | |
1433 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
2118 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us |
1434 | return $self->_tls_error ($tmp) |
2119 | return $self->_tls_error ($tmp) |
1435 | if $tmp != $ERROR_WANT_READ |
2120 | if $tmp != $ERROR_WANT_READ |
1436 | && ($tmp != $ERROR_SYSCALL || $!) |
2121 | && ($tmp != $ERROR_SYSCALL || $!); |
1437 | && $tmp != $ERROR_ZERO_RETURN; |
|
|
1438 | |
2122 | |
1439 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
2123 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1440 | $self->{wbuf} .= $tmp; |
2124 | $self->{wbuf} .= $tmp; |
1441 | $self->_drain_wbuf; |
2125 | $self->_drain_wbuf; |
|
|
2126 | $self->{tls} or return; # tls session might have gone away in callback |
1442 | } |
2127 | } |
|
|
2128 | |
|
|
2129 | $self->{_on_starttls} |
|
|
2130 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
|
|
2131 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
1443 | } |
2132 | } |
1444 | |
2133 | |
1445 | =item $handle->starttls ($tls[, $tls_ctx]) |
2134 | =item $handle->starttls ($tls[, $tls_ctx]) |
1446 | |
2135 | |
1447 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
2136 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1448 | object is created, you can also do that at a later time by calling |
2137 | object is created, you can also do that at a later time by calling |
1449 | C<starttls>. |
2138 | C<starttls>. See the C<tls> constructor argument for general info. |
|
|
2139 | |
|
|
2140 | Starting TLS is currently an asynchronous operation - when you push some |
|
|
2141 | write data and then call C<< ->starttls >> then TLS negotiation will start |
|
|
2142 | immediately, after which the queued write data is then sent. This might |
|
|
2143 | change in future versions, so best make sure you have no outstanding write |
|
|
2144 | data when calling this method. |
1450 | |
2145 | |
1451 | The first argument is the same as the C<tls> constructor argument (either |
2146 | The first argument is the same as the C<tls> constructor argument (either |
1452 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
2147 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1453 | |
2148 | |
1454 | The second argument is the optional C<AnyEvent::TLS> object that is used |
2149 | The second argument is the optional C<AnyEvent::TLS> object that is used |
… | |
… | |
1459 | The TLS connection object will end up in C<< $handle->{tls} >>, the TLS |
2154 | The TLS connection object will end up in C<< $handle->{tls} >>, the TLS |
1460 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
2155 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1461 | changed to your liking. Note that the handshake might have already started |
2156 | changed to your liking. Note that the handshake might have already started |
1462 | when this function returns. |
2157 | when this function returns. |
1463 | |
2158 | |
1464 | If it an error to start a TLS handshake more than once per |
2159 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1465 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
2160 | handshakes on the same stream. It is best to not attempt to use the |
|
|
2161 | stream after stopping TLS. |
|
|
2162 | |
|
|
2163 | This method may invoke callbacks (and therefore the handle might be |
|
|
2164 | destroyed after it returns). |
1466 | |
2165 | |
1467 | =cut |
2166 | =cut |
1468 | |
2167 | |
1469 | our %TLS_CACHE; #TODO not yet documented, should we? |
2168 | our %TLS_CACHE; #TODO not yet documented, should we? |
1470 | |
2169 | |
1471 | sub starttls { |
2170 | sub starttls { |
1472 | my ($self, $ssl, $ctx) = @_; |
2171 | my ($self, $tls, $ctx) = @_; |
1473 | |
2172 | |
1474 | require Net::SSLeay; |
2173 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
1475 | |
|
|
1476 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
|
|
1477 | if $self->{tls}; |
2174 | if $self->{tls}; |
1478 | |
2175 | |
|
|
2176 | unless (defined $AnyEvent::TLS::VERSION) { |
|
|
2177 | eval { |
|
|
2178 | require Net::SSLeay; |
|
|
2179 | require AnyEvent::TLS; |
|
|
2180 | 1 |
|
|
2181 | } or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system"); |
|
|
2182 | } |
|
|
2183 | |
|
|
2184 | $self->{tls} = $tls; |
|
|
2185 | $self->{tls_ctx} = $ctx if @_ > 2; |
|
|
2186 | |
|
|
2187 | return unless $self->{fh}; |
|
|
2188 | |
1479 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
2189 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1480 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
2190 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1481 | $ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN (); |
|
|
1482 | |
2191 | |
|
|
2192 | $tls = delete $self->{tls}; |
1483 | $ctx ||= $self->{tls_ctx}; |
2193 | $ctx = $self->{tls_ctx}; |
|
|
2194 | |
|
|
2195 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1484 | |
2196 | |
1485 | if ("HASH" eq ref $ctx) { |
2197 | if ("HASH" eq ref $ctx) { |
1486 | require AnyEvent::TLS; |
|
|
1487 | |
|
|
1488 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context |
|
|
1489 | |
|
|
1490 | if ($ctx->{cache}) { |
2198 | if ($ctx->{cache}) { |
1491 | my $key = $ctx+0; |
2199 | my $key = $ctx+0; |
1492 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
2200 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
1493 | } else { |
2201 | } else { |
1494 | $ctx = new AnyEvent::TLS %$ctx; |
2202 | $ctx = new AnyEvent::TLS %$ctx; |
1495 | } |
2203 | } |
1496 | } |
2204 | } |
1497 | |
2205 | |
1498 | $self->{tls_ctx} = $ctx || TLS_CTX (); |
2206 | $self->{tls_ctx} = $ctx || TLS_CTX (); |
1499 | $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername}); |
2207 | $self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername}); |
1500 | |
2208 | |
1501 | # basically, this is deep magic (because SSL_read should have the same issues) |
2209 | # basically, this is deep magic (because SSL_read should have the same issues) |
1502 | # but the openssl maintainers basically said: "trust us, it just works". |
2210 | # but the openssl maintainers basically said: "trust us, it just works". |
1503 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
2211 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1504 | # and mismaintained ssleay-module doesn't even offer them). |
2212 | # and mismaintained ssleay-module doesn't even offer them). |
… | |
… | |
1511 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
2219 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
1512 | # have identity issues in that area. |
2220 | # have identity issues in that area. |
1513 | # Net::SSLeay::CTX_set_mode ($ssl, |
2221 | # Net::SSLeay::CTX_set_mode ($ssl, |
1514 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
2222 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1515 | # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
2223 | # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1516 | Net::SSLeay::CTX_set_mode ($ssl, 1|2); |
2224 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
1517 | |
2225 | |
1518 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2226 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1519 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2227 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1520 | |
2228 | |
|
|
2229 | Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf}); |
|
|
2230 | $self->{rbuf} = ""; |
|
|
2231 | |
1521 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
2232 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
|
|
2233 | |
|
|
2234 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
|
|
2235 | if $self->{on_starttls}; |
1522 | |
2236 | |
1523 | &_dotls; # need to trigger the initial handshake |
2237 | &_dotls; # need to trigger the initial handshake |
1524 | $self->start_read; # make sure we actually do read |
2238 | $self->start_read; # make sure we actually do read |
1525 | } |
2239 | } |
1526 | |
2240 | |
1527 | =item $handle->stoptls |
2241 | =item $handle->stoptls |
1528 | |
2242 | |
1529 | Shuts down the SSL connection - this makes a proper EOF handshake by |
2243 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1530 | sending a close notify to the other side, but since OpenSSL doesn't |
2244 | sending a close notify to the other side, but since OpenSSL doesn't |
1531 | support non-blocking shut downs, it is not possible to re-use the stream |
2245 | support non-blocking shut downs, it is not guaranteed that you can re-use |
1532 | afterwards. |
2246 | the stream afterwards. |
|
|
2247 | |
|
|
2248 | This method may invoke callbacks (and therefore the handle might be |
|
|
2249 | destroyed after it returns). |
1533 | |
2250 | |
1534 | =cut |
2251 | =cut |
1535 | |
2252 | |
1536 | sub stoptls { |
2253 | sub stoptls { |
1537 | my ($self) = @_; |
2254 | my ($self) = @_; |
1538 | |
2255 | |
1539 | if ($self->{tls}) { |
2256 | if ($self->{tls} && $self->{fh}) { |
1540 | Net::SSLeay::shutdown ($self->{tls}); |
2257 | Net::SSLeay::shutdown ($self->{tls}); |
1541 | |
2258 | |
1542 | &_dotls; |
2259 | &_dotls; |
1543 | |
2260 | |
1544 | # we don't give a shit. no, we do, but we can't. no... |
2261 | # # we don't give a shit. no, we do, but we can't. no...#d# |
1545 | # we, we... have to use openssl :/ |
2262 | # # we, we... have to use openssl :/#d# |
1546 | &_freetls; |
2263 | # &_freetls;#d# |
1547 | } |
2264 | } |
1548 | } |
2265 | } |
1549 | |
2266 | |
1550 | sub _freetls { |
2267 | sub _freetls { |
1551 | my ($self) = @_; |
2268 | my ($self) = @_; |
1552 | |
2269 | |
1553 | return unless $self->{tls}; |
2270 | return unless $self->{tls}; |
1554 | |
2271 | |
1555 | $self->{tls_ctx}->_put_session (delete $self->{tls}); |
2272 | $self->{tls_ctx}->_put_session (delete $self->{tls}) |
|
|
2273 | if $self->{tls} > 0; |
1556 | |
2274 | |
1557 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
2275 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
1558 | } |
2276 | } |
|
|
2277 | |
|
|
2278 | =item $handle->resettls |
|
|
2279 | |
|
|
2280 | This rarely-used method simply resets and TLS state on the handle, usually |
|
|
2281 | causing data loss. |
|
|
2282 | |
|
|
2283 | One case where it may be useful is when you want to skip over the data in |
|
|
2284 | the stream but you are not interested in interpreting it, so data loss is |
|
|
2285 | no concern. |
|
|
2286 | |
|
|
2287 | =cut |
|
|
2288 | |
|
|
2289 | *resettls = \&_freetls; |
1559 | |
2290 | |
1560 | sub DESTROY { |
2291 | sub DESTROY { |
1561 | my ($self) = @_; |
2292 | my ($self) = @_; |
1562 | |
2293 | |
1563 | &_freetls; |
2294 | &_freetls; |
1564 | |
2295 | |
1565 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
2296 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1566 | |
2297 | |
1567 | if ($linger && length $self->{wbuf}) { |
2298 | if ($linger && length $self->{wbuf} && $self->{fh}) { |
1568 | my $fh = delete $self->{fh}; |
2299 | my $fh = delete $self->{fh}; |
1569 | my $wbuf = delete $self->{wbuf}; |
2300 | my $wbuf = delete $self->{wbuf}; |
1570 | |
2301 | |
1571 | my @linger; |
2302 | my @linger; |
1572 | |
2303 | |
1573 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
2304 | push @linger, AE::io $fh, 1, sub { |
1574 | my $len = syswrite $fh, $wbuf, length $wbuf; |
2305 | my $len = syswrite $fh, $wbuf, length $wbuf; |
1575 | |
2306 | |
1576 | if ($len > 0) { |
2307 | if ($len > 0) { |
1577 | substr $wbuf, 0, $len, ""; |
2308 | substr $wbuf, 0, $len, ""; |
1578 | } else { |
2309 | } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) { |
1579 | @linger = (); # end |
2310 | @linger = (); # end |
1580 | } |
2311 | } |
1581 | }); |
2312 | }; |
1582 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
2313 | push @linger, AE::timer $linger, 0, sub { |
1583 | @linger = (); |
2314 | @linger = (); |
1584 | }); |
2315 | }; |
1585 | } |
2316 | } |
1586 | } |
2317 | } |
1587 | |
2318 | |
1588 | =item $handle->destroy |
2319 | =item $handle->destroy |
1589 | |
2320 | |
1590 | Shuts down the handle object as much as possible - this call ensures that |
2321 | Shuts down the handle object as much as possible - this call ensures that |
1591 | no further callbacks will be invoked and resources will be freed as much |
2322 | no further callbacks will be invoked and as many resources as possible |
1592 | as possible. You must not call any methods on the object afterwards. |
2323 | will be freed. Any method you will call on the handle object after |
|
|
2324 | destroying it in this way will be silently ignored (and it will return the |
|
|
2325 | empty list). |
1593 | |
2326 | |
1594 | Normally, you can just "forget" any references to an AnyEvent::Handle |
2327 | Normally, you can just "forget" any references to an AnyEvent::Handle |
1595 | object and it will simply shut down. This works in fatal error and EOF |
2328 | object and it will simply shut down. This works in fatal error and EOF |
1596 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
2329 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
1597 | callback, so when you want to destroy the AnyEvent::Handle object from |
2330 | callback, so when you want to destroy the AnyEvent::Handle object from |
1598 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
2331 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
1599 | that case. |
2332 | that case. |
1600 | |
2333 | |
|
|
2334 | Destroying the handle object in this way has the advantage that callbacks |
|
|
2335 | will be removed as well, so if those are the only reference holders (as |
|
|
2336 | is common), then one doesn't need to do anything special to break any |
|
|
2337 | reference cycles. |
|
|
2338 | |
1601 | The handle might still linger in the background and write out remaining |
2339 | The handle might still linger in the background and write out remaining |
1602 | data, as specified by the C<linger> option, however. |
2340 | data, as specified by the C<linger> option, however. |
1603 | |
2341 | |
1604 | =cut |
2342 | =cut |
1605 | |
2343 | |
1606 | sub destroy { |
2344 | sub destroy { |
1607 | my ($self) = @_; |
2345 | my ($self) = @_; |
1608 | |
2346 | |
1609 | $self->DESTROY; |
2347 | $self->DESTROY; |
1610 | %$self = (); |
2348 | %$self = (); |
|
|
2349 | bless $self, "AnyEvent::Handle::destroyed"; |
1611 | } |
2350 | } |
|
|
2351 | |
|
|
2352 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
|
|
2353 | #nop |
|
|
2354 | } |
|
|
2355 | |
|
|
2356 | =item $handle->destroyed |
|
|
2357 | |
|
|
2358 | Returns false as long as the handle hasn't been destroyed by a call to C<< |
|
|
2359 | ->destroy >>, true otherwise. |
|
|
2360 | |
|
|
2361 | Can be useful to decide whether the handle is still valid after some |
|
|
2362 | callback possibly destroyed the handle. For example, C<< ->push_write >>, |
|
|
2363 | C<< ->starttls >> and other methods can call user callbacks, which in turn |
|
|
2364 | can destroy the handle, so work can be avoided by checking sometimes: |
|
|
2365 | |
|
|
2366 | $hdl->starttls ("accept"); |
|
|
2367 | return if $hdl->destroyed; |
|
|
2368 | $hdl->push_write (... |
|
|
2369 | |
|
|
2370 | Note that the call to C<push_write> will silently be ignored if the handle |
|
|
2371 | has been destroyed, so often you can just ignore the possibility of the |
|
|
2372 | handle being destroyed. |
|
|
2373 | |
|
|
2374 | =cut |
|
|
2375 | |
|
|
2376 | sub destroyed { 0 } |
|
|
2377 | sub AnyEvent::Handle::destroyed::destroyed { 1 } |
1612 | |
2378 | |
1613 | =item AnyEvent::Handle::TLS_CTX |
2379 | =item AnyEvent::Handle::TLS_CTX |
1614 | |
2380 | |
1615 | This function creates and returns the AnyEvent::TLS object used by default |
2381 | This function creates and returns the AnyEvent::TLS object used by default |
1616 | for TLS mode. |
2382 | for TLS mode. |
… | |
… | |
1644 | |
2410 | |
1645 | It is only safe to "forget" the reference inside EOF or error callbacks, |
2411 | It is only safe to "forget" the reference inside EOF or error callbacks, |
1646 | from within all other callbacks, you need to explicitly call the C<< |
2412 | from within all other callbacks, you need to explicitly call the C<< |
1647 | ->destroy >> method. |
2413 | ->destroy >> method. |
1648 | |
2414 | |
|
|
2415 | =item Why is my C<on_eof> callback never called? |
|
|
2416 | |
|
|
2417 | Probably because your C<on_error> callback is being called instead: When |
|
|
2418 | you have outstanding requests in your read queue, then an EOF is |
|
|
2419 | considered an error as you clearly expected some data. |
|
|
2420 | |
|
|
2421 | To avoid this, make sure you have an empty read queue whenever your handle |
|
|
2422 | is supposed to be "idle" (i.e. connection closes are O.K.). You can set |
|
|
2423 | an C<on_read> handler that simply pushes the first read requests in the |
|
|
2424 | queue. |
|
|
2425 | |
|
|
2426 | See also the next question, which explains this in a bit more detail. |
|
|
2427 | |
|
|
2428 | =item How can I serve requests in a loop? |
|
|
2429 | |
|
|
2430 | Most protocols consist of some setup phase (authentication for example) |
|
|
2431 | followed by a request handling phase, where the server waits for requests |
|
|
2432 | and handles them, in a loop. |
|
|
2433 | |
|
|
2434 | There are two important variants: The first (traditional, better) variant |
|
|
2435 | handles requests until the server gets some QUIT command, causing it to |
|
|
2436 | close the connection first (highly desirable for a busy TCP server). A |
|
|
2437 | client dropping the connection is an error, which means this variant can |
|
|
2438 | detect an unexpected detection close. |
|
|
2439 | |
|
|
2440 | To handle this case, always make sure you have a non-empty read queue, by |
|
|
2441 | pushing the "read request start" handler on it: |
|
|
2442 | |
|
|
2443 | # we assume a request starts with a single line |
|
|
2444 | my @start_request; @start_request = (line => sub { |
|
|
2445 | my ($hdl, $line) = @_; |
|
|
2446 | |
|
|
2447 | ... handle request |
|
|
2448 | |
|
|
2449 | # push next request read, possibly from a nested callback |
|
|
2450 | $hdl->push_read (@start_request); |
|
|
2451 | }); |
|
|
2452 | |
|
|
2453 | # auth done, now go into request handling loop |
|
|
2454 | # now push the first @start_request |
|
|
2455 | $hdl->push_read (@start_request); |
|
|
2456 | |
|
|
2457 | By always having an outstanding C<push_read>, the handle always expects |
|
|
2458 | some data and raises the C<EPIPE> error when the connction is dropped |
|
|
2459 | unexpectedly. |
|
|
2460 | |
|
|
2461 | The second variant is a protocol where the client can drop the connection |
|
|
2462 | at any time. For TCP, this means that the server machine may run out of |
|
|
2463 | sockets easier, and in general, it means you cannot distinguish a protocl |
|
|
2464 | failure/client crash from a normal connection close. Nevertheless, these |
|
|
2465 | kinds of protocols are common (and sometimes even the best solution to the |
|
|
2466 | problem). |
|
|
2467 | |
|
|
2468 | Having an outstanding read request at all times is possible if you ignore |
|
|
2469 | C<EPIPE> errors, but this doesn't help with when the client drops the |
|
|
2470 | connection during a request, which would still be an error. |
|
|
2471 | |
|
|
2472 | A better solution is to push the initial request read in an C<on_read> |
|
|
2473 | callback. This avoids an error, as when the server doesn't expect data |
|
|
2474 | (i.e. is idly waiting for the next request, an EOF will not raise an |
|
|
2475 | error, but simply result in an C<on_eof> callback. It is also a bit slower |
|
|
2476 | and simpler: |
|
|
2477 | |
|
|
2478 | # auth done, now go into request handling loop |
|
|
2479 | $hdl->on_read (sub { |
|
|
2480 | my ($hdl) = @_; |
|
|
2481 | |
|
|
2482 | # called each time we receive data but the read queue is empty |
|
|
2483 | # simply start read the request |
|
|
2484 | |
|
|
2485 | $hdl->push_read (line => sub { |
|
|
2486 | my ($hdl, $line) = @_; |
|
|
2487 | |
|
|
2488 | ... handle request |
|
|
2489 | |
|
|
2490 | # do nothing special when the request has been handled, just |
|
|
2491 | # let the request queue go empty. |
|
|
2492 | }); |
|
|
2493 | }); |
|
|
2494 | |
1649 | =item I get different callback invocations in TLS mode/Why can't I pause |
2495 | =item I get different callback invocations in TLS mode/Why can't I pause |
1650 | reading? |
2496 | reading? |
1651 | |
2497 | |
1652 | Unlike, say, TCP, TLS connections do not consist of two independent |
2498 | Unlike, say, TCP, TLS connections do not consist of two independent |
1653 | communication channels, one for each direction. Or put differently. The |
2499 | communication channels, one for each direction. Or put differently, the |
1654 | read and write directions are not independent of each other: you cannot |
2500 | read and write directions are not independent of each other: you cannot |
1655 | write data unless you are also prepared to read, and vice versa. |
2501 | write data unless you are also prepared to read, and vice versa. |
1656 | |
2502 | |
1657 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
2503 | This means that, in TLS mode, you might get C<on_error> or C<on_eof> |
1658 | callback invocations when you are not expecting any read data - the reason |
2504 | callback invocations when you are not expecting any read data - the reason |
1659 | is that AnyEvent::Handle always reads in TLS mode. |
2505 | is that AnyEvent::Handle always reads in TLS mode. |
1660 | |
2506 | |
1661 | During the connection, you have to make sure that you always have a |
2507 | During the connection, you have to make sure that you always have a |
1662 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
2508 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
… | |
… | |
1672 | |
2518 | |
1673 | $handle->on_read (sub { }); |
2519 | $handle->on_read (sub { }); |
1674 | $handle->on_eof (undef); |
2520 | $handle->on_eof (undef); |
1675 | $handle->on_error (sub { |
2521 | $handle->on_error (sub { |
1676 | my $data = delete $_[0]{rbuf}; |
2522 | my $data = delete $_[0]{rbuf}; |
1677 | undef $handle; |
|
|
1678 | }); |
2523 | }); |
|
|
2524 | |
|
|
2525 | Note that this example removes the C<rbuf> member from the handle object, |
|
|
2526 | which is not normally allowed by the API. It is expressly permitted in |
|
|
2527 | this case only, as the handle object needs to be destroyed afterwards. |
1679 | |
2528 | |
1680 | The reason to use C<on_error> is that TCP connections, due to latencies |
2529 | The reason to use C<on_error> is that TCP connections, due to latencies |
1681 | and packets loss, might get closed quite violently with an error, when in |
2530 | and packets loss, might get closed quite violently with an error, when in |
1682 | fact, all data has been received. |
2531 | fact all data has been received. |
1683 | |
2532 | |
1684 | It is usually better to use acknowledgements when transferring data, |
2533 | It is usually better to use acknowledgements when transferring data, |
1685 | to make sure the other side hasn't just died and you got the data |
2534 | to make sure the other side hasn't just died and you got the data |
1686 | intact. This is also one reason why so many internet protocols have an |
2535 | intact. This is also one reason why so many internet protocols have an |
1687 | explicit QUIT command. |
2536 | explicit QUIT command. |
… | |
… | |
1694 | C<low_water_mark> this will be called precisely when all data has been |
2543 | C<low_water_mark> this will be called precisely when all data has been |
1695 | written to the socket: |
2544 | written to the socket: |
1696 | |
2545 | |
1697 | $handle->push_write (...); |
2546 | $handle->push_write (...); |
1698 | $handle->on_drain (sub { |
2547 | $handle->on_drain (sub { |
1699 | warn "all data submitted to the kernel\n"; |
2548 | AE::log debug => "All data submitted to the kernel."; |
1700 | undef $handle; |
2549 | undef $handle; |
1701 | }); |
2550 | }); |
1702 | |
2551 | |
|
|
2552 | If you just want to queue some data and then signal EOF to the other side, |
|
|
2553 | consider using C<< ->push_shutdown >> instead. |
|
|
2554 | |
|
|
2555 | =item I want to contact a TLS/SSL server, I don't care about security. |
|
|
2556 | |
|
|
2557 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
|
|
2558 | connect to it and then create the AnyEvent::Handle with the C<tls> |
|
|
2559 | parameter: |
|
|
2560 | |
|
|
2561 | tcp_connect $host, $port, sub { |
|
|
2562 | my ($fh) = @_; |
|
|
2563 | |
|
|
2564 | my $handle = new AnyEvent::Handle |
|
|
2565 | fh => $fh, |
|
|
2566 | tls => "connect", |
|
|
2567 | on_error => sub { ... }; |
|
|
2568 | |
|
|
2569 | $handle->push_write (...); |
|
|
2570 | }; |
|
|
2571 | |
|
|
2572 | =item I want to contact a TLS/SSL server, I do care about security. |
|
|
2573 | |
|
|
2574 | Then you should additionally enable certificate verification, including |
|
|
2575 | peername verification, if the protocol you use supports it (see |
|
|
2576 | L<AnyEvent::TLS>, C<verify_peername>). |
|
|
2577 | |
|
|
2578 | E.g. for HTTPS: |
|
|
2579 | |
|
|
2580 | tcp_connect $host, $port, sub { |
|
|
2581 | my ($fh) = @_; |
|
|
2582 | |
|
|
2583 | my $handle = new AnyEvent::Handle |
|
|
2584 | fh => $fh, |
|
|
2585 | peername => $host, |
|
|
2586 | tls => "connect", |
|
|
2587 | tls_ctx => { verify => 1, verify_peername => "https" }, |
|
|
2588 | ... |
|
|
2589 | |
|
|
2590 | Note that you must specify the hostname you connected to (or whatever |
|
|
2591 | "peername" the protocol needs) as the C<peername> argument, otherwise no |
|
|
2592 | peername verification will be done. |
|
|
2593 | |
|
|
2594 | The above will use the system-dependent default set of trusted CA |
|
|
2595 | certificates. If you want to check against a specific CA, add the |
|
|
2596 | C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>: |
|
|
2597 | |
|
|
2598 | tls_ctx => { |
|
|
2599 | verify => 1, |
|
|
2600 | verify_peername => "https", |
|
|
2601 | ca_file => "my-ca-cert.pem", |
|
|
2602 | }, |
|
|
2603 | |
|
|
2604 | =item I want to create a TLS/SSL server, how do I do that? |
|
|
2605 | |
|
|
2606 | Well, you first need to get a server certificate and key. You have |
|
|
2607 | three options: a) ask a CA (buy one, use cacert.org etc.) b) create a |
|
|
2608 | self-signed certificate (cheap. check the search engine of your choice, |
|
|
2609 | there are many tutorials on the net) or c) make your own CA (tinyca2 is a |
|
|
2610 | nice program for that purpose). |
|
|
2611 | |
|
|
2612 | Then create a file with your private key (in PEM format, see |
|
|
2613 | L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The |
|
|
2614 | file should then look like this: |
|
|
2615 | |
|
|
2616 | -----BEGIN RSA PRIVATE KEY----- |
|
|
2617 | ...header data |
|
|
2618 | ... lots of base64'y-stuff |
|
|
2619 | -----END RSA PRIVATE KEY----- |
|
|
2620 | |
|
|
2621 | -----BEGIN CERTIFICATE----- |
|
|
2622 | ... lots of base64'y-stuff |
|
|
2623 | -----END CERTIFICATE----- |
|
|
2624 | |
|
|
2625 | The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then |
|
|
2626 | specify this file as C<cert_file>: |
|
|
2627 | |
|
|
2628 | tcp_server undef, $port, sub { |
|
|
2629 | my ($fh) = @_; |
|
|
2630 | |
|
|
2631 | my $handle = new AnyEvent::Handle |
|
|
2632 | fh => $fh, |
|
|
2633 | tls => "accept", |
|
|
2634 | tls_ctx => { cert_file => "my-server-keycert.pem" }, |
|
|
2635 | ... |
|
|
2636 | |
|
|
2637 | When you have intermediate CA certificates that your clients might not |
|
|
2638 | know about, just append them to the C<cert_file>. |
|
|
2639 | |
1703 | =back |
2640 | =back |
1704 | |
|
|
1705 | |
2641 | |
1706 | =head1 SUBCLASSING AnyEvent::Handle |
2642 | =head1 SUBCLASSING AnyEvent::Handle |
1707 | |
2643 | |
1708 | In many cases, you might want to subclass AnyEvent::Handle. |
2644 | In many cases, you might want to subclass AnyEvent::Handle. |
1709 | |
2645 | |
… | |
… | |
1726 | |
2662 | |
1727 | =item * all members not documented here and not prefixed with an underscore |
2663 | =item * all members not documented here and not prefixed with an underscore |
1728 | are free to use in subclasses. |
2664 | are free to use in subclasses. |
1729 | |
2665 | |
1730 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2666 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
1731 | member variables, but thats just life, at least it is documented. |
2667 | member variables, but that's just life. At least it is documented. |
1732 | |
2668 | |
1733 | =back |
2669 | =back |
1734 | |
2670 | |
1735 | =head1 AUTHOR |
2671 | =head1 AUTHOR |
1736 | |
2672 | |
1737 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2673 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
1738 | |
2674 | |
1739 | =cut |
2675 | =cut |
1740 | |
2676 | |
1741 | 1; # End of AnyEvent::Handle |
2677 | 1 |
|
|
2678 | |