1 | package AnyEvent::Handle; |
1 | package AnyEvent::Handle; |
2 | |
2 | |
3 | no warnings; |
|
|
4 | use strict; |
|
|
5 | |
|
|
6 | use AnyEvent (); |
|
|
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
|
|
8 | use Scalar::Util (); |
3 | use Scalar::Util (); |
9 | use Carp (); |
4 | use Carp (); |
10 | use Fcntl (); |
|
|
11 | use Errno qw(EAGAIN EINTR); |
5 | use Errno qw(EAGAIN EINTR); |
12 | |
6 | |
|
|
7 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
|
|
8 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
|
|
9 | |
13 | =head1 NAME |
10 | =head1 NAME |
14 | |
11 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
12 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
13 | |
17 | =cut |
14 | =cut |
18 | |
15 | |
19 | our $VERSION = 4.14; |
16 | our $VERSION = 4.85; |
20 | |
17 | |
21 | =head1 SYNOPSIS |
18 | =head1 SYNOPSIS |
22 | |
19 | |
23 | use AnyEvent; |
20 | use AnyEvent; |
24 | use AnyEvent::Handle; |
21 | use AnyEvent::Handle; |
25 | |
22 | |
26 | my $cv = AnyEvent->condvar; |
23 | my $cv = AnyEvent->condvar; |
27 | |
24 | |
28 | my $handle = |
25 | my $hdl; $hdl = new AnyEvent::Handle |
29 | AnyEvent::Handle->new ( |
|
|
30 | fh => \*STDIN, |
26 | fh => \*STDIN, |
31 | on_eof => sub { |
27 | on_error => sub { |
32 | $cv->broadcast; |
28 | my ($hdl, $fatal, $msg) = @_; |
33 | }, |
29 | warn "got error $msg\n"; |
|
|
30 | $hdl->destroy; |
|
|
31 | $cv->send; |
34 | ); |
32 | ); |
35 | |
33 | |
36 | # send some request line |
34 | # send some request line |
37 | $handle->push_write ("getinfo\015\012"); |
35 | $hdl->push_write ("getinfo\015\012"); |
38 | |
36 | |
39 | # read the response line |
37 | # read the response line |
40 | $handle->push_read (line => sub { |
38 | $hdl->push_read (line => sub { |
41 | my ($handle, $line) = @_; |
39 | my ($hdl, $line) = @_; |
42 | warn "read line <$line>\n"; |
40 | warn "got line <$line>\n"; |
43 | $cv->send; |
41 | $cv->send; |
44 | }); |
42 | }); |
45 | |
43 | |
46 | $cv->recv; |
44 | $cv->recv; |
47 | |
45 | |
… | |
… | |
49 | |
47 | |
50 | This module is a helper module to make it easier to do event-based I/O on |
48 | This module 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 |
49 | filehandles. For utility functions for doing non-blocking connects and accepts |
52 | on sockets see L<AnyEvent::Util>. |
50 | on sockets see L<AnyEvent::Util>. |
53 | |
51 | |
|
|
52 | The L<AnyEvent::Intro> tutorial contains some well-documented |
|
|
53 | AnyEvent::Handle examples. |
|
|
54 | |
54 | In the following, when the documentation refers to of "bytes" then this |
55 | In the following, when the documentation refers to of "bytes" then this |
55 | means characters. As sysread and syswrite are used for all I/O, their |
56 | means characters. As sysread and syswrite are used for all I/O, their |
56 | treatment of characters applies to this module as well. |
57 | treatment of characters applies to this module as well. |
57 | |
58 | |
58 | All callbacks will be invoked with the handle object as their first |
59 | All callbacks will be invoked with the handle object as their first |
… | |
… | |
60 | |
61 | |
61 | =head1 METHODS |
62 | =head1 METHODS |
62 | |
63 | |
63 | =over 4 |
64 | =over 4 |
64 | |
65 | |
65 | =item B<new (%args)> |
66 | =item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... |
66 | |
67 | |
67 | The constructor supports these arguments (all as key => value pairs). |
68 | The constructor supports these arguments (all as C<< key => value >> pairs). |
68 | |
69 | |
69 | =over 4 |
70 | =over 4 |
70 | |
71 | |
71 | =item fh => $filehandle [MANDATORY] |
72 | =item fh => $filehandle [MANDATORY] |
72 | |
73 | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
75 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
76 | NOTE: The filehandle will be set to non-blocking mode (using |
76 | AnyEvent::Util::fh_nonblocking). |
77 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
78 | that mode. |
77 | |
79 | |
78 | =item on_eof => $cb->($handle) |
80 | =item on_eof => $cb->($handle) |
79 | |
81 | |
80 | Set the callback to be called when an end-of-file condition is detcted, |
82 | Set the callback to be called when an end-of-file condition is detected, |
81 | i.e. in the case of a socket, when the other side has closed the |
83 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
84 | connection cleanly, and there are no outstanding read requests in the |
|
|
85 | queue (if there are read requests, then an EOF counts as an unexpected |
|
|
86 | connection close and will be flagged as an error). |
83 | |
87 | |
84 | While not mandatory, it is highly recommended to set an eof callback, |
88 | For sockets, this just means that the other side has stopped sending data, |
85 | otherwise you might end up with a closed socket while you are still |
89 | you can still try to write data, and, in fact, one can return from the EOF |
86 | waiting for data. |
90 | callback and continue writing data, as only the read part has been shut |
|
|
91 | down. |
87 | |
92 | |
|
|
93 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
94 | set, then a fatal error will be raised with C<$!> set to <0>. |
|
|
95 | |
88 | =item on_error => $cb->($handle, $fatal) |
96 | =item on_error => $cb->($handle, $fatal, $message) |
89 | |
97 | |
90 | This is the error callback, which is called when, well, some error |
98 | This is the error callback, which is called when, well, some error |
91 | occured, such as not being able to resolve the hostname, failure to |
99 | occured, such as not being able to resolve the hostname, failure to |
92 | connect or a read error. |
100 | connect or a read error. |
93 | |
101 | |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
102 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
95 | fatal errors the handle object will be shut down and will not be |
103 | fatal errors the handle object will be destroyed (by a call to C<< -> |
|
|
104 | destroy >>) after invoking the error callback (which means you are free to |
|
|
105 | examine the handle object). Examples of fatal errors are an EOF condition |
|
|
106 | with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. |
|
|
107 | |
|
|
108 | AnyEvent::Handle tries to find an appropriate error code for you to check |
|
|
109 | against, but in some cases (TLS errors), this does not work well. It is |
|
|
110 | recommended to always output the C<$message> argument in human-readable |
|
|
111 | error messages (it's usually the same as C<"$!">). |
|
|
112 | |
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
113 | Non-fatal errors can be retried by simply returning, but it is recommended |
97 | recommended to simply ignore this parameter and instead abondon the handle |
114 | to simply ignore this parameter and instead abondon the handle object |
98 | object when this callback is invoked. |
115 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
116 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
99 | |
117 | |
100 | On callback entrance, the value of C<$!> contains the operating system |
118 | On callback entrance, the value of C<$!> contains the operating system |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
119 | error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
|
|
120 | C<EPROTO>). |
102 | |
121 | |
103 | While not mandatory, it is I<highly> recommended to set this callback, as |
122 | While not mandatory, it is I<highly> recommended to set this callback, as |
104 | you will not be notified of errors otherwise. The default simply calls |
123 | you will not be notified of errors otherwise. The default simply calls |
105 | C<croak>. |
124 | C<croak>. |
106 | |
125 | |
107 | =item on_read => $cb->($handle) |
126 | =item on_read => $cb->($handle) |
108 | |
127 | |
109 | This sets the default read callback, which is called when data arrives |
128 | This sets the default read callback, which is called when data arrives |
110 | and no read request is in the queue. |
129 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
130 | callback will only be called when at least one octet of data is in the |
|
|
131 | read buffer). |
111 | |
132 | |
112 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
133 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
113 | method or access the C<$handle->{rbuf}> member directly. |
134 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
|
|
135 | must not enlarge or modify the read buffer, you can only remove data at |
|
|
136 | the beginning from it. |
114 | |
137 | |
115 | When an EOF condition is detected then AnyEvent::Handle will first try to |
138 | When an EOF condition is detected then AnyEvent::Handle will first try to |
116 | feed all the remaining data to the queued callbacks and C<on_read> before |
139 | feed all the remaining data to the queued callbacks and C<on_read> before |
117 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
140 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
118 | error will be raised (with C<$!> set to C<EPIPE>). |
141 | error will be raised (with C<$!> set to C<EPIPE>). |
119 | |
142 | |
|
|
143 | Note that, unlike requests in the read queue, an C<on_read> callback |
|
|
144 | doesn't mean you I<require> some data: if there is an EOF and there |
|
|
145 | are outstanding read requests then an error will be flagged. With an |
|
|
146 | C<on_read> callback, the C<on_eof> callback will be invoked. |
|
|
147 | |
120 | =item on_drain => $cb->($handle) |
148 | =item on_drain => $cb->($handle) |
121 | |
149 | |
122 | This sets the callback that is called when the write buffer becomes empty |
150 | This sets the callback that is called when the write buffer becomes empty |
123 | (or when the callback is set and the buffer is empty already). |
151 | (or when the callback is set and the buffer is empty already). |
124 | |
152 | |
125 | To append to the write buffer, use the C<< ->push_write >> method. |
153 | To append to the write buffer, use the C<< ->push_write >> method. |
|
|
154 | |
|
|
155 | This callback is useful when you don't want to put all of your write data |
|
|
156 | into the queue at once, for example, when you want to write the contents |
|
|
157 | of some file to the socket you might not want to read the whole file into |
|
|
158 | memory and push it into the queue, but instead only read more data from |
|
|
159 | the file when the write queue becomes empty. |
126 | |
160 | |
127 | =item timeout => $fractional_seconds |
161 | =item timeout => $fractional_seconds |
128 | |
162 | |
129 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
163 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
130 | seconds pass without a successful read or write on the underlying file |
164 | seconds pass without a successful read or write on the underlying file |
131 | handle, the C<on_timeout> callback will be invoked (and if that one is |
165 | handle, the C<on_timeout> callback will be invoked (and if that one is |
132 | missing, an C<ETIMEDOUT> error will be raised). |
166 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
133 | |
167 | |
134 | Note that timeout processing is also active when you currently do not have |
168 | Note that timeout processing is also active when you currently do not have |
135 | any outstanding read or write requests: If you plan to keep the connection |
169 | any outstanding read or write requests: If you plan to keep the connection |
136 | idle then you should disable the timout temporarily or ignore the timeout |
170 | idle then you should disable the timout temporarily or ignore the timeout |
137 | in the C<on_timeout> callback. |
171 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
|
|
172 | restart the timeout. |
138 | |
173 | |
139 | Zero (the default) disables this timeout. |
174 | Zero (the default) disables this timeout. |
140 | |
175 | |
141 | =item on_timeout => $cb->($handle) |
176 | =item on_timeout => $cb->($handle) |
142 | |
177 | |
… | |
… | |
146 | |
181 | |
147 | =item rbuf_max => <bytes> |
182 | =item rbuf_max => <bytes> |
148 | |
183 | |
149 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
184 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
150 | when the read buffer ever (strictly) exceeds this size. This is useful to |
185 | when the read buffer ever (strictly) exceeds this size. This is useful to |
151 | avoid denial-of-service attacks. |
186 | avoid some forms of denial-of-service attacks. |
152 | |
187 | |
153 | For example, a server accepting connections from untrusted sources should |
188 | For example, a server accepting connections from untrusted sources should |
154 | be configured to accept only so-and-so much data that it cannot act on |
189 | be configured to accept only so-and-so much data that it cannot act on |
155 | (for example, when expecting a line, an attacker could send an unlimited |
190 | (for example, when expecting a line, an attacker could send an unlimited |
156 | amount of data without a callback ever being called as long as the line |
191 | amount of data without a callback ever being called as long as the line |
157 | isn't finished). |
192 | isn't finished). |
158 | |
193 | |
|
|
194 | =item autocork => <boolean> |
|
|
195 | |
|
|
196 | When disabled (the default), then C<push_write> will try to immediately |
|
|
197 | write the data to the handle, if possible. This avoids having to register |
|
|
198 | a write watcher and wait for the next event loop iteration, but can |
|
|
199 | be inefficient if you write multiple small chunks (on the wire, this |
|
|
200 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
|
|
201 | C<no_delay>, but this option can save costly syscalls). |
|
|
202 | |
|
|
203 | When enabled, then writes will always be queued till the next event loop |
|
|
204 | iteration. This is efficient when you do many small writes per iteration, |
|
|
205 | but less efficient when you do a single write only per iteration (or when |
|
|
206 | the write buffer often is full). It also increases write latency. |
|
|
207 | |
|
|
208 | =item no_delay => <boolean> |
|
|
209 | |
|
|
210 | When doing small writes on sockets, your operating system kernel might |
|
|
211 | wait a bit for more data before actually sending it out. This is called |
|
|
212 | the Nagle algorithm, and usually it is beneficial. |
|
|
213 | |
|
|
214 | In some situations you want as low a delay as possible, which can be |
|
|
215 | accomplishd by setting this option to a true value. |
|
|
216 | |
|
|
217 | The default is your opertaing system's default behaviour (most likely |
|
|
218 | enabled), this option explicitly enables or disables it, if possible. |
|
|
219 | |
159 | =item read_size => <bytes> |
220 | =item read_size => <bytes> |
160 | |
221 | |
161 | The default read block size (the amount of bytes this module will try to read |
222 | The default read block size (the amount of bytes this module will |
162 | during each (loop iteration). Default: C<8192>. |
223 | try to read during each loop iteration, which affects memory |
|
|
224 | requirements). Default: C<8192>. |
163 | |
225 | |
164 | =item low_water_mark => <bytes> |
226 | =item low_water_mark => <bytes> |
165 | |
227 | |
166 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
228 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
167 | buffer: If the write reaches this size or gets even samller it is |
229 | buffer: If the write reaches this size or gets even samller it is |
168 | considered empty. |
230 | considered empty. |
169 | |
231 | |
|
|
232 | Sometimes it can be beneficial (for performance reasons) to add data to |
|
|
233 | the write buffer before it is fully drained, but this is a rare case, as |
|
|
234 | the operating system kernel usually buffers data as well, so the default |
|
|
235 | is good in almost all cases. |
|
|
236 | |
|
|
237 | =item linger => <seconds> |
|
|
238 | |
|
|
239 | If non-zero (default: C<3600>), then the destructor of the |
|
|
240 | AnyEvent::Handle object will check whether there is still outstanding |
|
|
241 | write data and will install a watcher that will write this data to the |
|
|
242 | socket. No errors will be reported (this mostly matches how the operating |
|
|
243 | system treats outstanding data at socket close time). |
|
|
244 | |
|
|
245 | This will not work for partial TLS data that could not be encoded |
|
|
246 | yet. This data will be lost. Calling the C<stoptls> method in time might |
|
|
247 | help. |
|
|
248 | |
|
|
249 | =item peername => $string |
|
|
250 | |
|
|
251 | A string used to identify the remote site - usually the DNS hostname |
|
|
252 | (I<not> IDN!) used to create the connection, rarely the IP address. |
|
|
253 | |
|
|
254 | Apart from being useful in error messages, this string is also used in TLS |
|
|
255 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
|
|
256 | verification will be skipped when C<peername> is not specified or |
|
|
257 | C<undef>. |
|
|
258 | |
170 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
259 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
171 | |
260 | |
172 | When this parameter is given, it enables TLS (SSL) mode, that means it |
261 | When this parameter is given, it enables TLS (SSL) mode, that means |
173 | will start making tls handshake and will transparently encrypt/decrypt |
262 | AnyEvent will start a TLS handshake as soon as the conenction has been |
174 | data. |
263 | established and will transparently encrypt/decrypt data afterwards. |
|
|
264 | |
|
|
265 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
|
|
266 | appropriate error message. |
175 | |
267 | |
176 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
268 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
177 | automatically when you try to create a TLS handle). |
269 | automatically when you try to create a TLS handle): this module doesn't |
|
|
270 | have a dependency on that module, so if your module requires it, you have |
|
|
271 | to add the dependency yourself. |
178 | |
272 | |
179 | For the TLS server side, use C<accept>, and for the TLS client side of a |
273 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
180 | connection, use C<connect> mode. |
274 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
275 | mode. |
181 | |
276 | |
182 | You can also provide your own TLS connection object, but you have |
277 | You can also provide your own TLS connection object, but you have |
183 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
278 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
184 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
279 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
185 | AnyEvent::Handle. |
280 | AnyEvent::Handle. Also, this module will take ownership of this connection |
|
|
281 | object. |
186 | |
282 | |
|
|
283 | At some future point, AnyEvent::Handle might switch to another TLS |
|
|
284 | implementation, then the option to use your own session object will go |
|
|
285 | away. |
|
|
286 | |
|
|
287 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
|
|
288 | passing in the wrong integer will lead to certain crash. This most often |
|
|
289 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
|
|
290 | segmentation fault. |
|
|
291 | |
187 | See the C<starttls> method if you need to start TLs negotiation later. |
292 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
188 | |
293 | |
189 | =item tls_ctx => $ssl_ctx |
294 | =item tls_ctx => $anyevent_tls |
190 | |
295 | |
191 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
296 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
192 | (unless a connection object was specified directly). If this parameter is |
297 | (unless a connection object was specified directly). If this parameter is |
193 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
298 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
194 | |
299 | |
|
|
300 | Instead of an object, you can also specify a hash reference with C<< key |
|
|
301 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
|
|
302 | new TLS context object. |
|
|
303 | |
|
|
304 | =item on_starttls => $cb->($handle, $success[, $error_message]) |
|
|
305 | |
|
|
306 | This callback will be invoked when the TLS/SSL handshake has finished. If |
|
|
307 | C<$success> is true, then the TLS handshake succeeded, otherwise it failed |
|
|
308 | (C<on_stoptls> will not be called in this case). |
|
|
309 | |
|
|
310 | The session in C<< $handle->{tls} >> can still be examined in this |
|
|
311 | callback, even when the handshake was not successful. |
|
|
312 | |
|
|
313 | TLS handshake failures will not cause C<on_error> to be invoked when this |
|
|
314 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
|
|
315 | |
|
|
316 | Without this callback, handshake failures lead to C<on_error> being |
|
|
317 | called, as normal. |
|
|
318 | |
|
|
319 | Note that you cannot call C<starttls> right again in this callback. If you |
|
|
320 | need to do that, start an zero-second timer instead whose callback can |
|
|
321 | then call C<< ->starttls >> again. |
|
|
322 | |
|
|
323 | =item on_stoptls => $cb->($handle) |
|
|
324 | |
|
|
325 | When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is |
|
|
326 | set, then it will be invoked after freeing the TLS session. If it is not, |
|
|
327 | then a TLS shutdown condition will be treated like a normal EOF condition |
|
|
328 | on the handle. |
|
|
329 | |
|
|
330 | The session in C<< $handle->{tls} >> can still be examined in this |
|
|
331 | callback. |
|
|
332 | |
|
|
333 | This callback will only be called on TLS shutdowns, not when the |
|
|
334 | underlying handle signals EOF. |
|
|
335 | |
195 | =item json => JSON or JSON::XS object |
336 | =item json => JSON or JSON::XS object |
196 | |
337 | |
197 | This is the json coder object used by the C<json> read and write types. |
338 | This is the json coder object used by the C<json> read and write types. |
198 | |
339 | |
199 | If you don't supply it, then AnyEvent::Handle will create and use a |
340 | If you don't supply it, then AnyEvent::Handle will create and use a |
200 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
341 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
342 | texts. |
201 | |
343 | |
202 | Note that you are responsible to depend on the JSON module if you want to |
344 | Note that you are responsible to depend on the JSON module if you want to |
203 | use this functionality, as AnyEvent does not have a dependency itself. |
345 | use this functionality, as AnyEvent does not have a dependency itself. |
204 | |
346 | |
205 | =item filter_r => $cb |
|
|
206 | |
|
|
207 | =item filter_w => $cb |
|
|
208 | |
|
|
209 | These exist, but are undocumented at this time. |
|
|
210 | |
|
|
211 | =back |
347 | =back |
212 | |
348 | |
213 | =cut |
349 | =cut |
214 | |
350 | |
215 | sub new { |
351 | sub new { |
216 | my $class = shift; |
352 | my $class = shift; |
217 | |
|
|
218 | my $self = bless { @_ }, $class; |
353 | my $self = bless { @_ }, $class; |
219 | |
354 | |
220 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
355 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
221 | |
356 | |
222 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
357 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
223 | |
|
|
224 | if ($self->{tls}) { |
|
|
225 | require Net::SSLeay; |
|
|
226 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
|
|
227 | } |
|
|
228 | |
358 | |
229 | $self->{_activity} = AnyEvent->now; |
359 | $self->{_activity} = AnyEvent->now; |
230 | $self->_timeout; |
360 | $self->_timeout; |
231 | |
361 | |
|
|
362 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
363 | |
|
|
364 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
|
|
365 | if $self->{tls}; |
|
|
366 | |
232 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
367 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
233 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
|
|
234 | |
368 | |
235 | $self |
369 | $self->start_read |
236 | } |
370 | if $self->{on_read}; |
237 | |
371 | |
|
|
372 | $self->{fh} && $self |
|
|
373 | } |
|
|
374 | |
238 | sub _shutdown { |
375 | #sub _shutdown { |
239 | my ($self) = @_; |
376 | # my ($self) = @_; |
240 | |
377 | # |
241 | delete $self->{_tw}; |
378 | # delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
242 | delete $self->{_rw}; |
379 | # $self->{_eof} = 1; # tell starttls et. al to stop trying |
243 | delete $self->{_ww}; |
380 | # |
244 | delete $self->{fh}; |
381 | # &_freetls; |
245 | |
382 | #} |
246 | $self->stoptls; |
|
|
247 | } |
|
|
248 | |
383 | |
249 | sub _error { |
384 | sub _error { |
250 | my ($self, $errno, $fatal) = @_; |
385 | my ($self, $errno, $fatal, $message) = @_; |
251 | |
|
|
252 | $self->_shutdown |
|
|
253 | if $fatal; |
|
|
254 | |
386 | |
255 | $! = $errno; |
387 | $! = $errno; |
|
|
388 | $message ||= "$!"; |
256 | |
389 | |
257 | if ($self->{on_error}) { |
390 | if ($self->{on_error}) { |
258 | $self->{on_error}($self, $fatal); |
391 | $self->{on_error}($self, $fatal, $message); |
259 | } else { |
392 | $self->destroy if $fatal; |
|
|
393 | } elsif ($self->{fh}) { |
|
|
394 | $self->destroy; |
260 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
395 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
261 | } |
396 | } |
262 | } |
397 | } |
263 | |
398 | |
264 | =item $fh = $handle->fh |
399 | =item $fh = $handle->fh |
265 | |
400 | |
266 | This method returns the file handle of the L<AnyEvent::Handle> object. |
401 | This method returns the file handle used to create the L<AnyEvent::Handle> object. |
267 | |
402 | |
268 | =cut |
403 | =cut |
269 | |
404 | |
270 | sub fh { $_[0]{fh} } |
405 | sub fh { $_[0]{fh} } |
271 | |
406 | |
… | |
… | |
289 | $_[0]{on_eof} = $_[1]; |
424 | $_[0]{on_eof} = $_[1]; |
290 | } |
425 | } |
291 | |
426 | |
292 | =item $handle->on_timeout ($cb) |
427 | =item $handle->on_timeout ($cb) |
293 | |
428 | |
294 | Replace the current C<on_timeout> callback, or disables the callback |
429 | Replace the current C<on_timeout> callback, or disables the callback (but |
295 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
430 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
296 | argument. |
431 | argument and method. |
297 | |
432 | |
298 | =cut |
433 | =cut |
299 | |
434 | |
300 | sub on_timeout { |
435 | sub on_timeout { |
301 | $_[0]{on_timeout} = $_[1]; |
436 | $_[0]{on_timeout} = $_[1]; |
|
|
437 | } |
|
|
438 | |
|
|
439 | =item $handle->autocork ($boolean) |
|
|
440 | |
|
|
441 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
442 | constructor argument). Changes will only take effect on the next write. |
|
|
443 | |
|
|
444 | =cut |
|
|
445 | |
|
|
446 | sub autocork { |
|
|
447 | $_[0]{autocork} = $_[1]; |
|
|
448 | } |
|
|
449 | |
|
|
450 | =item $handle->no_delay ($boolean) |
|
|
451 | |
|
|
452 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
453 | the same name for details). |
|
|
454 | |
|
|
455 | =cut |
|
|
456 | |
|
|
457 | sub no_delay { |
|
|
458 | $_[0]{no_delay} = $_[1]; |
|
|
459 | |
|
|
460 | eval { |
|
|
461 | local $SIG{__DIE__}; |
|
|
462 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
463 | }; |
|
|
464 | } |
|
|
465 | |
|
|
466 | =item $handle->on_starttls ($cb) |
|
|
467 | |
|
|
468 | Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). |
|
|
469 | |
|
|
470 | =cut |
|
|
471 | |
|
|
472 | sub on_starttls { |
|
|
473 | $_[0]{on_starttls} = $_[1]; |
|
|
474 | } |
|
|
475 | |
|
|
476 | =item $handle->on_stoptls ($cb) |
|
|
477 | |
|
|
478 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
|
|
479 | |
|
|
480 | =cut |
|
|
481 | |
|
|
482 | sub on_starttls { |
|
|
483 | $_[0]{on_stoptls} = $_[1]; |
302 | } |
484 | } |
303 | |
485 | |
304 | ############################################################################# |
486 | ############################################################################# |
305 | |
487 | |
306 | =item $handle->timeout ($seconds) |
488 | =item $handle->timeout ($seconds) |
… | |
… | |
332 | $self->{_activity} = $NOW; |
514 | $self->{_activity} = $NOW; |
333 | |
515 | |
334 | if ($self->{on_timeout}) { |
516 | if ($self->{on_timeout}) { |
335 | $self->{on_timeout}($self); |
517 | $self->{on_timeout}($self); |
336 | } else { |
518 | } else { |
337 | $self->_error (&Errno::ETIMEDOUT); |
519 | $self->_error (Errno::ETIMEDOUT); |
338 | } |
520 | } |
339 | |
521 | |
340 | # callback could have changed timeout value, optimise |
522 | # callback could have changed timeout value, optimise |
341 | return unless $self->{timeout}; |
523 | return unless $self->{timeout}; |
342 | |
524 | |
… | |
… | |
384 | my ($self, $cb) = @_; |
566 | my ($self, $cb) = @_; |
385 | |
567 | |
386 | $self->{on_drain} = $cb; |
568 | $self->{on_drain} = $cb; |
387 | |
569 | |
388 | $cb->($self) |
570 | $cb->($self) |
389 | if $cb && $self->{low_water_mark} >= length $self->{wbuf}; |
571 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
390 | } |
572 | } |
391 | |
573 | |
392 | =item $handle->push_write ($data) |
574 | =item $handle->push_write ($data) |
393 | |
575 | |
394 | Queues the given scalar to be written. You can push as much data as you |
576 | Queues the given scalar to be written. You can push as much data as you |
… | |
… | |
405 | Scalar::Util::weaken $self; |
587 | Scalar::Util::weaken $self; |
406 | |
588 | |
407 | my $cb = sub { |
589 | my $cb = sub { |
408 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
590 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
409 | |
591 | |
410 | if ($len >= 0) { |
592 | if (defined $len) { |
411 | substr $self->{wbuf}, 0, $len, ""; |
593 | substr $self->{wbuf}, 0, $len, ""; |
412 | |
594 | |
413 | $self->{_activity} = AnyEvent->now; |
595 | $self->{_activity} = AnyEvent->now; |
414 | |
596 | |
415 | $self->{on_drain}($self) |
597 | $self->{on_drain}($self) |
416 | if $self->{low_water_mark} >= length $self->{wbuf} |
598 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
417 | && $self->{on_drain}; |
599 | && $self->{on_drain}; |
418 | |
600 | |
419 | delete $self->{_ww} unless length $self->{wbuf}; |
601 | delete $self->{_ww} unless length $self->{wbuf}; |
420 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
602 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
421 | $self->_error ($!, 1); |
603 | $self->_error ($!, 1); |
422 | } |
604 | } |
423 | }; |
605 | }; |
424 | |
606 | |
425 | # try to write data immediately |
607 | # try to write data immediately |
426 | $cb->(); |
608 | $cb->() unless $self->{autocork}; |
427 | |
609 | |
428 | # if still data left in wbuf, we need to poll |
610 | # if still data left in wbuf, we need to poll |
429 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
611 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
430 | if length $self->{wbuf}; |
612 | if length $self->{wbuf}; |
431 | }; |
613 | }; |
… | |
… | |
445 | |
627 | |
446 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
628 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
447 | ->($self, @_); |
629 | ->($self, @_); |
448 | } |
630 | } |
449 | |
631 | |
450 | if ($self->{filter_w}) { |
632 | if ($self->{tls}) { |
451 | $self->{filter_w}($self, \$_[0]); |
633 | $self->{_tls_wbuf} .= $_[0]; |
|
|
634 | |
|
|
635 | &_dotls ($self); |
452 | } else { |
636 | } else { |
453 | $self->{wbuf} .= $_[0]; |
637 | $self->{wbuf} .= $_[0]; |
454 | $self->_drain_wbuf; |
638 | $self->_drain_wbuf; |
455 | } |
639 | } |
456 | } |
640 | } |
… | |
… | |
473 | =cut |
657 | =cut |
474 | |
658 | |
475 | register_write_type netstring => sub { |
659 | register_write_type netstring => sub { |
476 | my ($self, $string) = @_; |
660 | my ($self, $string) = @_; |
477 | |
661 | |
478 | sprintf "%d:%s,", (length $string), $string |
662 | (length $string) . ":$string," |
|
|
663 | }; |
|
|
664 | |
|
|
665 | =item packstring => $format, $data |
|
|
666 | |
|
|
667 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
668 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
669 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
670 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
671 | |
|
|
672 | =cut |
|
|
673 | |
|
|
674 | register_write_type packstring => sub { |
|
|
675 | my ($self, $format, $string) = @_; |
|
|
676 | |
|
|
677 | pack "$format/a*", $string |
479 | }; |
678 | }; |
480 | |
679 | |
481 | =item json => $array_or_hashref |
680 | =item json => $array_or_hashref |
482 | |
681 | |
483 | Encodes the given hash or array reference into a JSON object. Unless you |
682 | Encodes the given hash or array reference into a JSON object. Unless you |
… | |
… | |
517 | |
716 | |
518 | $self->{json} ? $self->{json}->encode ($ref) |
717 | $self->{json} ? $self->{json}->encode ($ref) |
519 | : JSON::encode_json ($ref) |
718 | : JSON::encode_json ($ref) |
520 | }; |
719 | }; |
521 | |
720 | |
|
|
721 | =item storable => $reference |
|
|
722 | |
|
|
723 | Freezes the given reference using L<Storable> and writes it to the |
|
|
724 | handle. Uses the C<nfreeze> format. |
|
|
725 | |
|
|
726 | =cut |
|
|
727 | |
|
|
728 | register_write_type storable => sub { |
|
|
729 | my ($self, $ref) = @_; |
|
|
730 | |
|
|
731 | require Storable; |
|
|
732 | |
|
|
733 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
734 | }; |
|
|
735 | |
522 | =back |
736 | =back |
|
|
737 | |
|
|
738 | =item $handle->push_shutdown |
|
|
739 | |
|
|
740 | Sometimes you know you want to close the socket after writing your data |
|
|
741 | before it was actually written. One way to do that is to replace your |
|
|
742 | C<on_drain> handler by a callback that shuts down the socket (and set |
|
|
743 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
|
|
744 | replaces the C<on_drain> callback with: |
|
|
745 | |
|
|
746 | sub { shutdown $_[0]{fh}, 1 } # for push_shutdown |
|
|
747 | |
|
|
748 | This simply shuts down the write side and signals an EOF condition to the |
|
|
749 | the peer. |
|
|
750 | |
|
|
751 | You can rely on the normal read queue and C<on_eof> handling |
|
|
752 | afterwards. This is the cleanest way to close a connection. |
|
|
753 | |
|
|
754 | =cut |
|
|
755 | |
|
|
756 | sub push_shutdown { |
|
|
757 | my ($self) = @_; |
|
|
758 | |
|
|
759 | delete $self->{low_water_mark}; |
|
|
760 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
|
|
761 | } |
523 | |
762 | |
524 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
763 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
525 | |
764 | |
526 | This function (not method) lets you add your own types to C<push_write>. |
765 | This function (not method) lets you add your own types to C<push_write>. |
527 | Whenever the given C<type> is used, C<push_write> will invoke the code |
766 | Whenever the given C<type> is used, C<push_write> will invoke the code |
… | |
… | |
548 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
787 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
549 | a queue. |
788 | a queue. |
550 | |
789 | |
551 | In the simple case, you just install an C<on_read> callback and whenever |
790 | In the simple case, you just install an C<on_read> callback and whenever |
552 | new data arrives, it will be called. You can then remove some data (if |
791 | new data arrives, it will be called. You can then remove some data (if |
553 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
792 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
554 | or not. |
793 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
794 | partial message has been received so far). |
555 | |
795 | |
556 | In the more complex case, you want to queue multiple callbacks. In this |
796 | In the more complex case, you want to queue multiple callbacks. In this |
557 | case, AnyEvent::Handle will call the first queued callback each time new |
797 | case, AnyEvent::Handle will call the first queued callback each time new |
558 | data arrives and removes it when it has done its job (see C<push_read>, |
798 | data arrives (also the first time it is queued) and removes it when it has |
559 | below). |
799 | done its job (see C<push_read>, below). |
560 | |
800 | |
561 | This way you can, for example, push three line-reads, followed by reading |
801 | This way you can, for example, push three line-reads, followed by reading |
562 | a chunk of data, and AnyEvent::Handle will execute them in order. |
802 | a chunk of data, and AnyEvent::Handle will execute them in order. |
563 | |
803 | |
564 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
804 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
… | |
… | |
577 | # handle xml |
817 | # handle xml |
578 | }); |
818 | }); |
579 | }); |
819 | }); |
580 | }); |
820 | }); |
581 | |
821 | |
582 | Example 2: Implement a client for a protocol that replies either with |
822 | Example 2: Implement a client for a protocol that replies either with "OK" |
583 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
823 | and another line or "ERROR" for the first request that is sent, and 64 |
584 | second request. Due tot he availability of a full queue, we can just |
824 | bytes for the second request. Due to the availability of a queue, we can |
585 | pipeline sending both requests and manipulate the queue as necessary in |
825 | just pipeline sending both requests and manipulate the queue as necessary |
586 | the callbacks: |
826 | in the callbacks. |
587 | |
827 | |
588 | # request one |
828 | When the first callback is called and sees an "OK" response, it will |
|
|
829 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
830 | 64-byte chunk callback. |
|
|
831 | |
|
|
832 | # request one, returns either "OK + extra line" or "ERROR" |
589 | $handle->push_write ("request 1\015\012"); |
833 | $handle->push_write ("request 1\015\012"); |
590 | |
834 | |
591 | # we expect "ERROR" or "OK" as response, so push a line read |
835 | # we expect "ERROR" or "OK" as response, so push a line read |
592 | $handle->push_read (line => sub { |
836 | $handle->push_read (line => sub { |
593 | # if we got an "OK", we have to _prepend_ another line, |
837 | # if we got an "OK", we have to _prepend_ another line, |
… | |
… | |
600 | ... |
844 | ... |
601 | }); |
845 | }); |
602 | } |
846 | } |
603 | }); |
847 | }); |
604 | |
848 | |
605 | # request two |
849 | # request two, simply returns 64 octets |
606 | $handle->push_write ("request 2\015\012"); |
850 | $handle->push_write ("request 2\015\012"); |
607 | |
851 | |
608 | # simply read 64 bytes, always |
852 | # simply read 64 bytes, always |
609 | $handle->push_read (chunk => 64, sub { |
853 | $handle->push_read (chunk => 64, sub { |
610 | my $response = $_[1]; |
854 | my $response = $_[1]; |
… | |
… | |
622 | |
866 | |
623 | if ( |
867 | if ( |
624 | defined $self->{rbuf_max} |
868 | defined $self->{rbuf_max} |
625 | && $self->{rbuf_max} < length $self->{rbuf} |
869 | && $self->{rbuf_max} < length $self->{rbuf} |
626 | ) { |
870 | ) { |
627 | return $self->_error (&Errno::ENOSPC, 1); |
871 | $self->_error (Errno::ENOSPC, 1), return; |
628 | } |
872 | } |
629 | |
873 | |
630 | while () { |
874 | while () { |
631 | no strict 'refs'; |
875 | # we need to use a separate tls read buffer, as we must not receive data while |
|
|
876 | # we are draining the buffer, and this can only happen with TLS. |
|
|
877 | $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf}; |
632 | |
878 | |
633 | my $len = length $self->{rbuf}; |
879 | my $len = length $self->{rbuf}; |
634 | |
880 | |
635 | if (my $cb = shift @{ $self->{_queue} }) { |
881 | if (my $cb = shift @{ $self->{_queue} }) { |
636 | unless ($cb->($self)) { |
882 | unless ($cb->($self)) { |
637 | if ($self->{_eof}) { |
883 | if ($self->{_eof}) { |
638 | # no progress can be made (not enough data and no data forthcoming) |
884 | # no progress can be made (not enough data and no data forthcoming) |
639 | return $self->_error (&Errno::EPIPE, 1); |
885 | $self->_error (Errno::EPIPE, 1), return; |
640 | } |
886 | } |
641 | |
887 | |
642 | unshift @{ $self->{_queue} }, $cb; |
888 | unshift @{ $self->{_queue} }, $cb; |
643 | last; |
889 | last; |
644 | } |
890 | } |
645 | } elsif ($self->{on_read}) { |
891 | } elsif ($self->{on_read}) { |
|
|
892 | last unless $len; |
|
|
893 | |
646 | $self->{on_read}($self); |
894 | $self->{on_read}($self); |
647 | |
895 | |
648 | if ( |
896 | if ( |
649 | $len == length $self->{rbuf} # if no data has been consumed |
897 | $len == length $self->{rbuf} # if no data has been consumed |
650 | && !@{ $self->{_queue} } # and the queue is still empty |
898 | && !@{ $self->{_queue} } # and the queue is still empty |
651 | && $self->{on_read} # but we still have on_read |
899 | && $self->{on_read} # but we still have on_read |
652 | ) { |
900 | ) { |
653 | # no further data will arrive |
901 | # no further data will arrive |
654 | # so no progress can be made |
902 | # so no progress can be made |
655 | return $self->_error (&Errno::EPIPE, 1) |
903 | $self->_error (Errno::EPIPE, 1), return |
656 | if $self->{_eof}; |
904 | if $self->{_eof}; |
657 | |
905 | |
658 | last; # more data might arrive |
906 | last; # more data might arrive |
659 | } |
907 | } |
660 | } else { |
908 | } else { |
661 | # read side becomes idle |
909 | # read side becomes idle |
662 | delete $self->{_rw}; |
910 | delete $self->{_rw} unless $self->{tls}; |
663 | last; |
911 | last; |
664 | } |
912 | } |
665 | } |
913 | } |
666 | |
914 | |
|
|
915 | if ($self->{_eof}) { |
|
|
916 | if ($self->{on_eof}) { |
667 | $self->{on_eof}($self) |
917 | $self->{on_eof}($self) |
668 | if $self->{_eof} && $self->{on_eof}; |
918 | } else { |
|
|
919 | $self->_error (0, 1, "Unexpected end-of-file"); |
|
|
920 | } |
|
|
921 | } |
669 | |
922 | |
670 | # may need to restart read watcher |
923 | # may need to restart read watcher |
671 | unless ($self->{_rw}) { |
924 | unless ($self->{_rw}) { |
672 | $self->start_read |
925 | $self->start_read |
673 | if $self->{on_read} || @{ $self->{_queue} }; |
926 | if $self->{on_read} || @{ $self->{_queue} }; |
… | |
… | |
691 | |
944 | |
692 | =item $handle->rbuf |
945 | =item $handle->rbuf |
693 | |
946 | |
694 | Returns the read buffer (as a modifiable lvalue). |
947 | Returns the read buffer (as a modifiable lvalue). |
695 | |
948 | |
696 | You can access the read buffer directly as the C<< ->{rbuf} >> member, if |
949 | You can access the read buffer directly as the C<< ->{rbuf} >> |
697 | you want. |
950 | member, if you want. However, the only operation allowed on the |
|
|
951 | read buffer (apart from looking at it) is removing data from its |
|
|
952 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
953 | lead to hard-to-track-down bugs. |
698 | |
954 | |
699 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
955 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
700 | C<push_read> or C<unshift_read> methods are used. The other read methods |
956 | C<push_read> or C<unshift_read> methods are used. The other read methods |
701 | automatically manage the read buffer. |
957 | automatically manage the read buffer. |
702 | |
958 | |
… | |
… | |
799 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
1055 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
800 | 1 |
1056 | 1 |
801 | } |
1057 | } |
802 | }; |
1058 | }; |
803 | |
1059 | |
804 | # compatibility with older API |
|
|
805 | sub push_read_chunk { |
|
|
806 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
807 | } |
|
|
808 | |
|
|
809 | sub unshift_read_chunk { |
|
|
810 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
811 | } |
|
|
812 | |
|
|
813 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
1060 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
814 | |
1061 | |
815 | The callback will be called only once a full line (including the end of |
1062 | The callback will be called only once a full line (including the end of |
816 | line marker, C<$eol>) has been read. This line (excluding the end of line |
1063 | line marker, C<$eol>) has been read. This line (excluding the end of line |
817 | marker) will be passed to the callback as second argument (C<$line>), and |
1064 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
832 | =cut |
1079 | =cut |
833 | |
1080 | |
834 | register_read_type line => sub { |
1081 | register_read_type line => sub { |
835 | my ($self, $cb, $eol) = @_; |
1082 | my ($self, $cb, $eol) = @_; |
836 | |
1083 | |
837 | $eol = qr|(\015?\012)| if @_ < 3; |
1084 | if (@_ < 3) { |
838 | $eol = quotemeta $eol unless ref $eol; |
1085 | # this is more than twice as fast as the generic code below |
839 | $eol = qr|^(.*?)($eol)|s; |
|
|
840 | |
|
|
841 | sub { |
1086 | sub { |
842 | $_[0]{rbuf} =~ s/$eol// or return; |
1087 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
843 | |
1088 | |
844 | $cb->($_[0], $1, $2); |
1089 | $cb->($_[0], $1, $2); |
845 | 1 |
|
|
846 | } |
|
|
847 | }; |
|
|
848 | |
|
|
849 | # compatibility with older API |
|
|
850 | sub push_read_line { |
|
|
851 | my $self = shift; |
|
|
852 | $self->push_read (line => @_); |
|
|
853 | } |
|
|
854 | |
|
|
855 | sub unshift_read_line { |
|
|
856 | my $self = shift; |
|
|
857 | $self->unshift_read (line => @_); |
|
|
858 | } |
|
|
859 | |
|
|
860 | =item netstring => $cb->($handle, $string) |
|
|
861 | |
|
|
862 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
863 | |
|
|
864 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
865 | |
|
|
866 | =cut |
|
|
867 | |
|
|
868 | register_read_type netstring => sub { |
|
|
869 | my ($self, $cb) = @_; |
|
|
870 | |
|
|
871 | sub { |
|
|
872 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
873 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
874 | $self->_error (&Errno::EBADMSG); |
|
|
875 | } |
1090 | 1 |
876 | return; |
|
|
877 | } |
1091 | } |
|
|
1092 | } else { |
|
|
1093 | $eol = quotemeta $eol unless ref $eol; |
|
|
1094 | $eol = qr|^(.*?)($eol)|s; |
878 | |
1095 | |
879 | my $len = $1; |
1096 | sub { |
|
|
1097 | $_[0]{rbuf} =~ s/$eol// or return; |
880 | |
1098 | |
881 | $self->unshift_read (chunk => $len, sub { |
1099 | $cb->($_[0], $1, $2); |
882 | my $string = $_[1]; |
|
|
883 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
884 | if ($_[1] eq ",") { |
|
|
885 | $cb->($_[0], $string); |
|
|
886 | } else { |
|
|
887 | $self->_error (&Errno::EBADMSG); |
|
|
888 | } |
|
|
889 | }); |
1100 | 1 |
890 | }); |
1101 | } |
891 | |
|
|
892 | 1 |
|
|
893 | } |
1102 | } |
894 | }; |
1103 | }; |
895 | |
1104 | |
896 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
1105 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
897 | |
1106 | |
… | |
… | |
949 | return 1; |
1158 | return 1; |
950 | } |
1159 | } |
951 | |
1160 | |
952 | # reject |
1161 | # reject |
953 | if ($reject && $$rbuf =~ $reject) { |
1162 | if ($reject && $$rbuf =~ $reject) { |
954 | $self->_error (&Errno::EBADMSG); |
1163 | $self->_error (Errno::EBADMSG); |
955 | } |
1164 | } |
956 | |
1165 | |
957 | # skip |
1166 | # skip |
958 | if ($skip && $$rbuf =~ $skip) { |
1167 | if ($skip && $$rbuf =~ $skip) { |
959 | $data .= substr $$rbuf, 0, $+[0], ""; |
1168 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
961 | |
1170 | |
962 | () |
1171 | () |
963 | } |
1172 | } |
964 | }; |
1173 | }; |
965 | |
1174 | |
|
|
1175 | =item netstring => $cb->($handle, $string) |
|
|
1176 | |
|
|
1177 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
1178 | |
|
|
1179 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
1180 | |
|
|
1181 | =cut |
|
|
1182 | |
|
|
1183 | register_read_type netstring => sub { |
|
|
1184 | my ($self, $cb) = @_; |
|
|
1185 | |
|
|
1186 | sub { |
|
|
1187 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
1188 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
1189 | $self->_error (Errno::EBADMSG); |
|
|
1190 | } |
|
|
1191 | return; |
|
|
1192 | } |
|
|
1193 | |
|
|
1194 | my $len = $1; |
|
|
1195 | |
|
|
1196 | $self->unshift_read (chunk => $len, sub { |
|
|
1197 | my $string = $_[1]; |
|
|
1198 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
1199 | if ($_[1] eq ",") { |
|
|
1200 | $cb->($_[0], $string); |
|
|
1201 | } else { |
|
|
1202 | $self->_error (Errno::EBADMSG); |
|
|
1203 | } |
|
|
1204 | }); |
|
|
1205 | }); |
|
|
1206 | |
|
|
1207 | 1 |
|
|
1208 | } |
|
|
1209 | }; |
|
|
1210 | |
|
|
1211 | =item packstring => $format, $cb->($handle, $string) |
|
|
1212 | |
|
|
1213 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1214 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1215 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1216 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1217 | |
|
|
1218 | For example, DNS over TCP uses a prefix of C<n> (2 octet network order), |
|
|
1219 | EPP uses a prefix of C<N> (4 octtes). |
|
|
1220 | |
|
|
1221 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1222 | format (very efficient). |
|
|
1223 | |
|
|
1224 | $handle->push_read (packstring => "w", sub { |
|
|
1225 | my ($handle, $data) = @_; |
|
|
1226 | }); |
|
|
1227 | |
|
|
1228 | =cut |
|
|
1229 | |
|
|
1230 | register_read_type packstring => sub { |
|
|
1231 | my ($self, $cb, $format) = @_; |
|
|
1232 | |
|
|
1233 | sub { |
|
|
1234 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1235 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
|
|
1236 | or return; |
|
|
1237 | |
|
|
1238 | $format = length pack $format, $len; |
|
|
1239 | |
|
|
1240 | # bypass unshift if we already have the remaining chunk |
|
|
1241 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1242 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1243 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1244 | $cb->($_[0], $data); |
|
|
1245 | } else { |
|
|
1246 | # remove prefix |
|
|
1247 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1248 | |
|
|
1249 | # read remaining chunk |
|
|
1250 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1251 | } |
|
|
1252 | |
|
|
1253 | 1 |
|
|
1254 | } |
|
|
1255 | }; |
|
|
1256 | |
966 | =item json => $cb->($handle, $hash_or_arrayref) |
1257 | =item json => $cb->($handle, $hash_or_arrayref) |
967 | |
1258 | |
968 | Reads a JSON object or array, decodes it and passes it to the callback. |
1259 | Reads a JSON object or array, decodes it and passes it to the |
|
|
1260 | callback. When a parse error occurs, an C<EBADMSG> error will be raised. |
969 | |
1261 | |
970 | If a C<json> object was passed to the constructor, then that will be used |
1262 | If a C<json> object was passed to the constructor, then that will be used |
971 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1263 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
972 | |
1264 | |
973 | This read type uses the incremental parser available with JSON version |
1265 | This read type uses the incremental parser available with JSON version |
… | |
… | |
980 | the C<json> write type description, above, for an actual example. |
1272 | the C<json> write type description, above, for an actual example. |
981 | |
1273 | |
982 | =cut |
1274 | =cut |
983 | |
1275 | |
984 | register_read_type json => sub { |
1276 | register_read_type json => sub { |
985 | my ($self, $cb, $accept, $reject, $skip) = @_; |
1277 | my ($self, $cb) = @_; |
986 | |
1278 | |
987 | require JSON; |
1279 | my $json = $self->{json} ||= |
|
|
1280 | eval { require JSON::XS; JSON::XS->new->utf8 } |
|
|
1281 | || do { require JSON; JSON->new->utf8 }; |
988 | |
1282 | |
989 | my $data; |
1283 | my $data; |
990 | my $rbuf = \$self->{rbuf}; |
1284 | my $rbuf = \$self->{rbuf}; |
991 | |
1285 | |
992 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
993 | |
|
|
994 | sub { |
1286 | sub { |
995 | my $ref = $json->incr_parse ($self->{rbuf}); |
1287 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
996 | |
1288 | |
997 | if ($ref) { |
1289 | if ($ref) { |
998 | $self->{rbuf} = $json->incr_text; |
1290 | $self->{rbuf} = $json->incr_text; |
999 | $json->incr_text = ""; |
1291 | $json->incr_text = ""; |
1000 | $cb->($self, $ref); |
1292 | $cb->($self, $ref); |
1001 | |
1293 | |
1002 | 1 |
1294 | 1 |
|
|
1295 | } elsif ($@) { |
|
|
1296 | # error case |
|
|
1297 | $json->incr_skip; |
|
|
1298 | |
|
|
1299 | $self->{rbuf} = $json->incr_text; |
|
|
1300 | $json->incr_text = ""; |
|
|
1301 | |
|
|
1302 | $self->_error (Errno::EBADMSG); |
|
|
1303 | |
|
|
1304 | () |
1003 | } else { |
1305 | } else { |
1004 | $self->{rbuf} = ""; |
1306 | $self->{rbuf} = ""; |
|
|
1307 | |
1005 | () |
1308 | () |
1006 | } |
1309 | } |
|
|
1310 | } |
|
|
1311 | }; |
|
|
1312 | |
|
|
1313 | =item storable => $cb->($handle, $ref) |
|
|
1314 | |
|
|
1315 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1316 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1317 | data). |
|
|
1318 | |
|
|
1319 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1320 | |
|
|
1321 | =cut |
|
|
1322 | |
|
|
1323 | register_read_type storable => sub { |
|
|
1324 | my ($self, $cb) = @_; |
|
|
1325 | |
|
|
1326 | require Storable; |
|
|
1327 | |
|
|
1328 | sub { |
|
|
1329 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1330 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1331 | or return; |
|
|
1332 | |
|
|
1333 | my $format = length pack "w", $len; |
|
|
1334 | |
|
|
1335 | # bypass unshift if we already have the remaining chunk |
|
|
1336 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1337 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1338 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1339 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1340 | } else { |
|
|
1341 | # remove prefix |
|
|
1342 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1343 | |
|
|
1344 | # read remaining chunk |
|
|
1345 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1346 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1347 | $cb->($_[0], $ref); |
|
|
1348 | } else { |
|
|
1349 | $self->_error (Errno::EBADMSG); |
|
|
1350 | } |
|
|
1351 | }); |
|
|
1352 | } |
|
|
1353 | |
|
|
1354 | 1 |
1007 | } |
1355 | } |
1008 | }; |
1356 | }; |
1009 | |
1357 | |
1010 | =back |
1358 | =back |
1011 | |
1359 | |
… | |
… | |
1041 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1389 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1042 | you change the C<on_read> callback or push/unshift a read callback, and it |
1390 | you change the C<on_read> callback or push/unshift a read callback, and it |
1043 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1391 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1044 | there are any read requests in the queue. |
1392 | there are any read requests in the queue. |
1045 | |
1393 | |
|
|
1394 | These methods will have no effect when in TLS mode (as TLS doesn't support |
|
|
1395 | half-duplex connections). |
|
|
1396 | |
1046 | =cut |
1397 | =cut |
1047 | |
1398 | |
1048 | sub stop_read { |
1399 | sub stop_read { |
1049 | my ($self) = @_; |
1400 | my ($self) = @_; |
1050 | |
1401 | |
1051 | delete $self->{_rw}; |
1402 | delete $self->{_rw} unless $self->{tls}; |
1052 | } |
1403 | } |
1053 | |
1404 | |
1054 | sub start_read { |
1405 | sub start_read { |
1055 | my ($self) = @_; |
1406 | my ($self) = @_; |
1056 | |
1407 | |
1057 | unless ($self->{_rw} || $self->{_eof}) { |
1408 | unless ($self->{_rw} || $self->{_eof}) { |
1058 | Scalar::Util::weaken $self; |
1409 | Scalar::Util::weaken $self; |
1059 | |
1410 | |
1060 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1411 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1061 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1412 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1062 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1413 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1063 | |
1414 | |
1064 | if ($len > 0) { |
1415 | if ($len > 0) { |
1065 | $self->{_activity} = AnyEvent->now; |
1416 | $self->{_activity} = AnyEvent->now; |
1066 | |
1417 | |
1067 | $self->{filter_r} |
1418 | if ($self->{tls}) { |
1068 | ? $self->{filter_r}($self, $rbuf) |
1419 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1069 | : $self->{_in_drain} || $self->_drain_rbuf; |
1420 | |
|
|
1421 | &_dotls ($self); |
|
|
1422 | } else { |
|
|
1423 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1424 | } |
1070 | |
1425 | |
1071 | } elsif (defined $len) { |
1426 | } elsif (defined $len) { |
1072 | delete $self->{_rw}; |
1427 | delete $self->{_rw}; |
1073 | $self->{_eof} = 1; |
1428 | $self->{_eof} = 1; |
1074 | $self->_drain_rbuf unless $self->{_in_drain}; |
1429 | $self->_drain_rbuf unless $self->{_in_drain}; |
… | |
… | |
1078 | } |
1433 | } |
1079 | }); |
1434 | }); |
1080 | } |
1435 | } |
1081 | } |
1436 | } |
1082 | |
1437 | |
|
|
1438 | our $ERROR_SYSCALL; |
|
|
1439 | our $ERROR_WANT_READ; |
|
|
1440 | |
|
|
1441 | sub _tls_error { |
|
|
1442 | my ($self, $err) = @_; |
|
|
1443 | |
|
|
1444 | return $self->_error ($!, 1) |
|
|
1445 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
|
|
1446 | |
|
|
1447 | my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
|
|
1448 | |
|
|
1449 | # reduce error string to look less scary |
|
|
1450 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
|
|
1451 | |
|
|
1452 | if ($self->{_on_starttls}) { |
|
|
1453 | (delete $self->{_on_starttls})->($self, undef, $err); |
|
|
1454 | &_freetls; |
|
|
1455 | } else { |
|
|
1456 | &_freetls; |
|
|
1457 | $self->_error (Errno::EPROTO, 1, $err); |
|
|
1458 | } |
|
|
1459 | } |
|
|
1460 | |
|
|
1461 | # poll the write BIO and send the data if applicable |
|
|
1462 | # also decode read data if possible |
|
|
1463 | # this is basiclaly our TLS state machine |
|
|
1464 | # more efficient implementations are possible with openssl, |
|
|
1465 | # but not with the buggy and incomplete Net::SSLeay. |
1083 | sub _dotls { |
1466 | sub _dotls { |
1084 | my ($self) = @_; |
1467 | my ($self) = @_; |
1085 | |
1468 | |
1086 | my $buf; |
1469 | my $tmp; |
1087 | |
1470 | |
1088 | if (length $self->{_tls_wbuf}) { |
1471 | if (length $self->{_tls_wbuf}) { |
1089 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1472 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1090 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1473 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1091 | } |
1474 | } |
1092 | } |
|
|
1093 | |
1475 | |
|
|
1476 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
|
|
1477 | return $self->_tls_error ($tmp) |
|
|
1478 | if $tmp != $ERROR_WANT_READ |
|
|
1479 | && ($tmp != $ERROR_SYSCALL || $!); |
|
|
1480 | } |
|
|
1481 | |
|
|
1482 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
|
|
1483 | unless (length $tmp) { |
|
|
1484 | $self->{_on_starttls} |
|
|
1485 | and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ??? |
|
|
1486 | &_freetls; |
|
|
1487 | |
|
|
1488 | if ($self->{on_stoptls}) { |
|
|
1489 | $self->{on_stoptls}($self); |
|
|
1490 | return; |
|
|
1491 | } else { |
|
|
1492 | # let's treat SSL-eof as we treat normal EOF |
|
|
1493 | delete $self->{_rw}; |
|
|
1494 | $self->{_eof} = 1; |
|
|
1495 | } |
|
|
1496 | } |
|
|
1497 | |
|
|
1498 | $self->{_tls_rbuf} .= $tmp; |
|
|
1499 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1500 | $self->{tls} or return; # tls session might have gone away in callback |
|
|
1501 | } |
|
|
1502 | |
|
|
1503 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
|
|
1504 | return $self->_tls_error ($tmp) |
|
|
1505 | if $tmp != $ERROR_WANT_READ |
|
|
1506 | && ($tmp != $ERROR_SYSCALL || $!); |
|
|
1507 | |
1094 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1508 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1095 | $self->{wbuf} .= $buf; |
1509 | $self->{wbuf} .= $tmp; |
1096 | $self->_drain_wbuf; |
1510 | $self->_drain_wbuf; |
1097 | } |
1511 | } |
1098 | |
1512 | |
1099 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1513 | $self->{_on_starttls} |
1100 | if (length $buf) { |
1514 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1101 | $self->{rbuf} .= $buf; |
1515 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
1102 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1103 | } else { |
|
|
1104 | # let's treat SSL-eof as we treat normal EOF |
|
|
1105 | $self->{_eof} = 1; |
|
|
1106 | $self->_shutdown; |
|
|
1107 | return; |
|
|
1108 | } |
|
|
1109 | } |
|
|
1110 | |
|
|
1111 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
|
|
1112 | |
|
|
1113 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
|
|
1114 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
|
|
1115 | return $self->_error ($!, 1); |
|
|
1116 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
|
|
1117 | return $self->_error (&Errno::EIO, 1); |
|
|
1118 | } |
|
|
1119 | |
|
|
1120 | # all others are fine for our purposes |
|
|
1121 | } |
|
|
1122 | } |
1516 | } |
1123 | |
1517 | |
1124 | =item $handle->starttls ($tls[, $tls_ctx]) |
1518 | =item $handle->starttls ($tls[, $tls_ctx]) |
1125 | |
1519 | |
1126 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1520 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
… | |
… | |
1128 | C<starttls>. |
1522 | C<starttls>. |
1129 | |
1523 | |
1130 | The first argument is the same as the C<tls> constructor argument (either |
1524 | The first argument is the same as the C<tls> constructor argument (either |
1131 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1525 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1132 | |
1526 | |
1133 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
1527 | The second argument is the optional C<AnyEvent::TLS> object that is used |
1134 | used when AnyEvent::Handle has to create its own TLS connection object. |
1528 | when AnyEvent::Handle has to create its own TLS connection object, or |
|
|
1529 | a hash reference with C<< key => value >> pairs that will be used to |
|
|
1530 | construct a new context. |
1135 | |
1531 | |
1136 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1532 | The TLS connection object will end up in C<< $handle->{tls} >>, the TLS |
1137 | call and can be used or changed to your liking. Note that the handshake |
1533 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1138 | might have already started when this function returns. |
1534 | changed to your liking. Note that the handshake might have already started |
|
|
1535 | when this function returns. |
1139 | |
1536 | |
|
|
1537 | If it an error to start a TLS handshake more than once per |
|
|
1538 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
|
|
1539 | |
1140 | =cut |
1540 | =cut |
|
|
1541 | |
|
|
1542 | our %TLS_CACHE; #TODO not yet documented, should we? |
1141 | |
1543 | |
1142 | sub starttls { |
1544 | sub starttls { |
1143 | my ($self, $ssl, $ctx) = @_; |
1545 | my ($self, $ssl, $ctx) = @_; |
1144 | |
1546 | |
1145 | $self->stoptls; |
1547 | require Net::SSLeay; |
1146 | |
1548 | |
1147 | if ($ssl eq "accept") { |
1549 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
1148 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1550 | if $self->{tls}; |
1149 | Net::SSLeay::set_accept_state ($ssl); |
1551 | |
1150 | } elsif ($ssl eq "connect") { |
1552 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1151 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1553 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1152 | Net::SSLeay::set_connect_state ($ssl); |
1554 | |
|
|
1555 | $ctx ||= $self->{tls_ctx}; |
|
|
1556 | |
|
|
1557 | if ("HASH" eq ref $ctx) { |
|
|
1558 | require AnyEvent::TLS; |
|
|
1559 | |
|
|
1560 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context |
|
|
1561 | |
|
|
1562 | if ($ctx->{cache}) { |
|
|
1563 | my $key = $ctx+0; |
|
|
1564 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
|
|
1565 | } else { |
|
|
1566 | $ctx = new AnyEvent::TLS %$ctx; |
|
|
1567 | } |
|
|
1568 | } |
1153 | } |
1569 | |
1154 | |
1570 | $self->{tls_ctx} = $ctx || TLS_CTX (); |
1155 | $self->{tls} = $ssl; |
1571 | $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername}); |
1156 | |
1572 | |
1157 | # basically, this is deep magic (because SSL_read should have the same issues) |
1573 | # basically, this is deep magic (because SSL_read should have the same issues) |
1158 | # but the openssl maintainers basically said: "trust us, it just works". |
1574 | # but the openssl maintainers basically said: "trust us, it just works". |
1159 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1575 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1160 | # and mismaintained ssleay-module doesn't even offer them). |
1576 | # and mismaintained ssleay-module doesn't even offer them). |
1161 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1577 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1578 | # |
|
|
1579 | # in short: this is a mess. |
|
|
1580 | # |
|
|
1581 | # note that we do not try to keep the length constant between writes as we are required to do. |
|
|
1582 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
|
|
1583 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
|
|
1584 | # have identity issues in that area. |
1162 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1585 | # Net::SSLeay::CTX_set_mode ($ssl, |
1163 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1586 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1164 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1587 | # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
|
|
1588 | Net::SSLeay::CTX_set_mode ($ssl, 1|2); |
1165 | |
1589 | |
1166 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1590 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1167 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1591 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1168 | |
1592 | |
1169 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1593 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1170 | |
1594 | |
1171 | $self->{filter_w} = sub { |
1595 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
1172 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
1596 | if $self->{on_starttls}; |
1173 | &_dotls; |
1597 | |
1174 | }; |
1598 | &_dotls; # need to trigger the initial handshake |
1175 | $self->{filter_r} = sub { |
1599 | $self->start_read; # make sure we actually do read |
1176 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
|
|
1177 | &_dotls; |
|
|
1178 | }; |
|
|
1179 | } |
1600 | } |
1180 | |
1601 | |
1181 | =item $handle->stoptls |
1602 | =item $handle->stoptls |
1182 | |
1603 | |
1183 | Destroys the SSL connection, if any. Partial read or write data will be |
1604 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1184 | lost. |
1605 | sending a close notify to the other side, but since OpenSSL doesn't |
|
|
1606 | support non-blocking shut downs, it is not possible to re-use the stream |
|
|
1607 | afterwards. |
1185 | |
1608 | |
1186 | =cut |
1609 | =cut |
1187 | |
1610 | |
1188 | sub stoptls { |
1611 | sub stoptls { |
1189 | my ($self) = @_; |
1612 | my ($self) = @_; |
1190 | |
1613 | |
1191 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1614 | if ($self->{tls}) { |
|
|
1615 | Net::SSLeay::shutdown ($self->{tls}); |
1192 | |
1616 | |
1193 | delete $self->{_rbio}; |
1617 | &_dotls; |
1194 | delete $self->{_wbio}; |
1618 | |
1195 | delete $self->{_tls_wbuf}; |
1619 | # # we don't give a shit. no, we do, but we can't. no...#d# |
1196 | delete $self->{filter_r}; |
1620 | # # we, we... have to use openssl :/#d# |
1197 | delete $self->{filter_w}; |
1621 | # &_freetls;#d# |
|
|
1622 | } |
|
|
1623 | } |
|
|
1624 | |
|
|
1625 | sub _freetls { |
|
|
1626 | my ($self) = @_; |
|
|
1627 | |
|
|
1628 | return unless $self->{tls}; |
|
|
1629 | |
|
|
1630 | $self->{tls_ctx}->_put_session (delete $self->{tls}); |
|
|
1631 | |
|
|
1632 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
1198 | } |
1633 | } |
1199 | |
1634 | |
1200 | sub DESTROY { |
1635 | sub DESTROY { |
1201 | my $self = shift; |
1636 | my ($self) = @_; |
1202 | |
1637 | |
1203 | $self->stoptls; |
1638 | &_freetls; |
|
|
1639 | |
|
|
1640 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1641 | |
|
|
1642 | if ($linger && length $self->{wbuf}) { |
|
|
1643 | my $fh = delete $self->{fh}; |
|
|
1644 | my $wbuf = delete $self->{wbuf}; |
|
|
1645 | |
|
|
1646 | my @linger; |
|
|
1647 | |
|
|
1648 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1649 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1650 | |
|
|
1651 | if ($len > 0) { |
|
|
1652 | substr $wbuf, 0, $len, ""; |
|
|
1653 | } else { |
|
|
1654 | @linger = (); # end |
|
|
1655 | } |
|
|
1656 | }); |
|
|
1657 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1658 | @linger = (); |
|
|
1659 | }); |
|
|
1660 | } |
|
|
1661 | } |
|
|
1662 | |
|
|
1663 | =item $handle->destroy |
|
|
1664 | |
|
|
1665 | Shuts down the handle object as much as possible - this call ensures that |
|
|
1666 | no further callbacks will be invoked and as many resources as possible |
|
|
1667 | will be freed. You must not call any methods on the object afterwards. |
|
|
1668 | |
|
|
1669 | Normally, you can just "forget" any references to an AnyEvent::Handle |
|
|
1670 | object and it will simply shut down. This works in fatal error and EOF |
|
|
1671 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
|
|
1672 | callback, so when you want to destroy the AnyEvent::Handle object from |
|
|
1673 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
|
|
1674 | that case. |
|
|
1675 | |
|
|
1676 | Destroying the handle object in this way has the advantage that callbacks |
|
|
1677 | will be removed as well, so if those are the only reference holders (as |
|
|
1678 | is common), then one doesn't need to do anything special to break any |
|
|
1679 | reference cycles. |
|
|
1680 | |
|
|
1681 | The handle might still linger in the background and write out remaining |
|
|
1682 | data, as specified by the C<linger> option, however. |
|
|
1683 | |
|
|
1684 | =cut |
|
|
1685 | |
|
|
1686 | sub destroy { |
|
|
1687 | my ($self) = @_; |
|
|
1688 | |
|
|
1689 | $self->DESTROY; |
|
|
1690 | %$self = (); |
1204 | } |
1691 | } |
1205 | |
1692 | |
1206 | =item AnyEvent::Handle::TLS_CTX |
1693 | =item AnyEvent::Handle::TLS_CTX |
1207 | |
1694 | |
1208 | This function creates and returns the Net::SSLeay::CTX object used by |
1695 | This function creates and returns the AnyEvent::TLS object used by default |
1209 | default for TLS mode. |
1696 | for TLS mode. |
1210 | |
1697 | |
1211 | The context is created like this: |
1698 | The context is created by calling L<AnyEvent::TLS> without any arguments. |
1212 | |
|
|
1213 | Net::SSLeay::load_error_strings; |
|
|
1214 | Net::SSLeay::SSLeay_add_ssl_algorithms; |
|
|
1215 | Net::SSLeay::randomize; |
|
|
1216 | |
|
|
1217 | my $CTX = Net::SSLeay::CTX_new; |
|
|
1218 | |
|
|
1219 | Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL |
|
|
1220 | |
1699 | |
1221 | =cut |
1700 | =cut |
1222 | |
1701 | |
1223 | our $TLS_CTX; |
1702 | our $TLS_CTX; |
1224 | |
1703 | |
1225 | sub TLS_CTX() { |
1704 | sub TLS_CTX() { |
1226 | $TLS_CTX || do { |
1705 | $TLS_CTX ||= do { |
1227 | require Net::SSLeay; |
1706 | require AnyEvent::TLS; |
1228 | |
1707 | |
1229 | Net::SSLeay::load_error_strings (); |
1708 | new AnyEvent::TLS |
1230 | Net::SSLeay::SSLeay_add_ssl_algorithms (); |
|
|
1231 | Net::SSLeay::randomize (); |
|
|
1232 | |
|
|
1233 | $TLS_CTX = Net::SSLeay::CTX_new (); |
|
|
1234 | |
|
|
1235 | Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ()); |
|
|
1236 | |
|
|
1237 | $TLS_CTX |
|
|
1238 | } |
1709 | } |
1239 | } |
1710 | } |
1240 | |
1711 | |
1241 | =back |
1712 | =back |
|
|
1713 | |
|
|
1714 | |
|
|
1715 | =head1 NONFREQUENTLY ASKED QUESTIONS |
|
|
1716 | |
|
|
1717 | =over 4 |
|
|
1718 | |
|
|
1719 | =item I C<undef> the AnyEvent::Handle reference inside my callback and |
|
|
1720 | still get further invocations! |
|
|
1721 | |
|
|
1722 | That's because AnyEvent::Handle keeps a reference to itself when handling |
|
|
1723 | read or write callbacks. |
|
|
1724 | |
|
|
1725 | It is only safe to "forget" the reference inside EOF or error callbacks, |
|
|
1726 | from within all other callbacks, you need to explicitly call the C<< |
|
|
1727 | ->destroy >> method. |
|
|
1728 | |
|
|
1729 | =item I get different callback invocations in TLS mode/Why can't I pause |
|
|
1730 | reading? |
|
|
1731 | |
|
|
1732 | Unlike, say, TCP, TLS connections do not consist of two independent |
|
|
1733 | communication channels, one for each direction. Or put differently. The |
|
|
1734 | read and write directions are not independent of each other: you cannot |
|
|
1735 | write data unless you are also prepared to read, and vice versa. |
|
|
1736 | |
|
|
1737 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
|
|
1738 | callback invocations when you are not expecting any read data - the reason |
|
|
1739 | is that AnyEvent::Handle always reads in TLS mode. |
|
|
1740 | |
|
|
1741 | During the connection, you have to make sure that you always have a |
|
|
1742 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
|
|
1743 | connection (or when you no longer want to use it) you can call the |
|
|
1744 | C<destroy> method. |
|
|
1745 | |
|
|
1746 | =item How do I read data until the other side closes the connection? |
|
|
1747 | |
|
|
1748 | If you just want to read your data into a perl scalar, the easiest way |
|
|
1749 | to achieve this is by setting an C<on_read> callback that does nothing, |
|
|
1750 | clearing the C<on_eof> callback and in the C<on_error> callback, the data |
|
|
1751 | will be in C<$_[0]{rbuf}>: |
|
|
1752 | |
|
|
1753 | $handle->on_read (sub { }); |
|
|
1754 | $handle->on_eof (undef); |
|
|
1755 | $handle->on_error (sub { |
|
|
1756 | my $data = delete $_[0]{rbuf}; |
|
|
1757 | }); |
|
|
1758 | |
|
|
1759 | The reason to use C<on_error> is that TCP connections, due to latencies |
|
|
1760 | and packets loss, might get closed quite violently with an error, when in |
|
|
1761 | fact, all data has been received. |
|
|
1762 | |
|
|
1763 | It is usually better to use acknowledgements when transferring data, |
|
|
1764 | to make sure the other side hasn't just died and you got the data |
|
|
1765 | intact. This is also one reason why so many internet protocols have an |
|
|
1766 | explicit QUIT command. |
|
|
1767 | |
|
|
1768 | =item I don't want to destroy the handle too early - how do I wait until |
|
|
1769 | all data has been written? |
|
|
1770 | |
|
|
1771 | After writing your last bits of data, set the C<on_drain> callback |
|
|
1772 | and destroy the handle in there - with the default setting of |
|
|
1773 | C<low_water_mark> this will be called precisely when all data has been |
|
|
1774 | written to the socket: |
|
|
1775 | |
|
|
1776 | $handle->push_write (...); |
|
|
1777 | $handle->on_drain (sub { |
|
|
1778 | warn "all data submitted to the kernel\n"; |
|
|
1779 | undef $handle; |
|
|
1780 | }); |
|
|
1781 | |
|
|
1782 | If you just want to queue some data and then signal EOF to the other side, |
|
|
1783 | consider using C<< ->push_shutdown >> instead. |
|
|
1784 | |
|
|
1785 | =item I want to contact a TLS/SSL server, I don't care about security. |
|
|
1786 | |
|
|
1787 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
|
|
1788 | simply connect to it and then create the AnyEvent::Handle with the C<tls> |
|
|
1789 | parameter: |
|
|
1790 | |
|
|
1791 | tcp_connect $host, $port, sub { |
|
|
1792 | my ($fh) = @_; |
|
|
1793 | |
|
|
1794 | my $handle = new AnyEvent::Handle |
|
|
1795 | fh => $fh, |
|
|
1796 | tls => "connect", |
|
|
1797 | on_error => sub { ... }; |
|
|
1798 | |
|
|
1799 | $handle->push_write (...); |
|
|
1800 | }; |
|
|
1801 | |
|
|
1802 | =item I want to contact a TLS/SSL server, I do care about security. |
|
|
1803 | |
|
|
1804 | Then you should additionally enable certificate verification, including |
|
|
1805 | peername verification, if the protocol you use supports it (see |
|
|
1806 | L<AnyEvent::TLS>, C<verify_peername>). |
|
|
1807 | |
|
|
1808 | E.g. for HTTPS: |
|
|
1809 | |
|
|
1810 | tcp_connect $host, $port, sub { |
|
|
1811 | my ($fh) = @_; |
|
|
1812 | |
|
|
1813 | my $handle = new AnyEvent::Handle |
|
|
1814 | fh => $fh, |
|
|
1815 | peername => $host, |
|
|
1816 | tls => "connect", |
|
|
1817 | tls_ctx => { verify => 1, verify_peername => "https" }, |
|
|
1818 | ... |
|
|
1819 | |
|
|
1820 | Note that you must specify the hostname you connected to (or whatever |
|
|
1821 | "peername" the protocol needs) as the C<peername> argument, otherwise no |
|
|
1822 | peername verification will be done. |
|
|
1823 | |
|
|
1824 | The above will use the system-dependent default set of trusted CA |
|
|
1825 | certificates. If you want to check against a specific CA, add the |
|
|
1826 | C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>: |
|
|
1827 | |
|
|
1828 | tls_ctx => { |
|
|
1829 | verify => 1, |
|
|
1830 | verify_peername => "https", |
|
|
1831 | ca_file => "my-ca-cert.pem", |
|
|
1832 | }, |
|
|
1833 | |
|
|
1834 | =item I want to create a TLS/SSL server, how do I do that? |
|
|
1835 | |
|
|
1836 | Well, you first need to get a server certificate and key. You have |
|
|
1837 | three options: a) ask a CA (buy one, use cacert.org etc.) b) create a |
|
|
1838 | self-signed certificate (cheap. check the search engine of your choice, |
|
|
1839 | there are many tutorials on the net) or c) make your own CA (tinyca2 is a |
|
|
1840 | nice program for that purpose). |
|
|
1841 | |
|
|
1842 | Then create a file with your private key (in PEM format, see |
|
|
1843 | L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The |
|
|
1844 | file should then look like this: |
|
|
1845 | |
|
|
1846 | -----BEGIN RSA PRIVATE KEY----- |
|
|
1847 | ...header data |
|
|
1848 | ... lots of base64'y-stuff |
|
|
1849 | -----END RSA PRIVATE KEY----- |
|
|
1850 | |
|
|
1851 | -----BEGIN CERTIFICATE----- |
|
|
1852 | ... lots of base64'y-stuff |
|
|
1853 | -----END CERTIFICATE----- |
|
|
1854 | |
|
|
1855 | The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then |
|
|
1856 | specify this file as C<cert_file>: |
|
|
1857 | |
|
|
1858 | tcp_server undef, $port, sub { |
|
|
1859 | my ($fh) = @_; |
|
|
1860 | |
|
|
1861 | my $handle = new AnyEvent::Handle |
|
|
1862 | fh => $fh, |
|
|
1863 | tls => "accept", |
|
|
1864 | tls_ctx => { cert_file => "my-server-keycert.pem" }, |
|
|
1865 | ... |
|
|
1866 | |
|
|
1867 | When you have intermediate CA certificates that your clients might not |
|
|
1868 | know about, just append them to the C<cert_file>. |
|
|
1869 | |
|
|
1870 | =back |
|
|
1871 | |
1242 | |
1872 | |
1243 | =head1 SUBCLASSING AnyEvent::Handle |
1873 | =head1 SUBCLASSING AnyEvent::Handle |
1244 | |
1874 | |
1245 | In many cases, you might want to subclass AnyEvent::Handle. |
1875 | In many cases, you might want to subclass AnyEvent::Handle. |
1246 | |
1876 | |
… | |
… | |
1250 | =over 4 |
1880 | =over 4 |
1251 | |
1881 | |
1252 | =item * all constructor arguments become object members. |
1882 | =item * all constructor arguments become object members. |
1253 | |
1883 | |
1254 | At least initially, when you pass a C<tls>-argument to the constructor it |
1884 | At least initially, when you pass a C<tls>-argument to the constructor it |
1255 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1885 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1256 | mutated later on (for example C<tls> will hold the TLS connection object). |
1886 | mutated later on (for example C<tls> will hold the TLS connection object). |
1257 | |
1887 | |
1258 | =item * other object member names are prefixed with an C<_>. |
1888 | =item * other object member names are prefixed with an C<_>. |
1259 | |
1889 | |
1260 | All object members not explicitly documented (internal use) are prefixed |
1890 | All object members not explicitly documented (internal use) are prefixed |