1 | package AnyEvent::Handle; |
1 | package AnyEvent::Handle; |
2 | |
2 | |
3 | no warnings; |
|
|
4 | use strict qw(subs vars); |
|
|
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.232; |
16 | our $VERSION = 4.86; |
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 | |
|
|
74 | #=item fh => $filehandle [C<fh> or C<connect> MANDATORY] |
|
|
75 | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
|
|
75 | NOTE: The filehandle will be set to non-blocking (using |
77 | NOTE: The filehandle will be set to non-blocking mode (using |
76 | AnyEvent::Util::fh_nonblocking). |
78 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
79 | that mode. |
|
|
80 | |
|
|
81 | #=item connect => [$host, $service] |
|
|
82 | # |
|
|
83 | # You have to specify either this parameter, or C<connect>, below. |
|
|
84 | #Try to connect to the specified host and service (port), using |
|
|
85 | #C<AnyEvent::Socket::tcp_connect>. |
|
|
86 | # |
|
|
87 | #When this |
77 | |
88 | |
78 | =item on_eof => $cb->($handle) |
89 | =item on_eof => $cb->($handle) |
79 | |
90 | |
80 | Set the callback to be called when an end-of-file condition is detected, |
91 | 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 |
92 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
93 | connection cleanly, and there are no outstanding read requests in the |
|
|
94 | queue (if there are read requests, then an EOF counts as an unexpected |
|
|
95 | connection close and will be flagged as an error). |
83 | |
96 | |
84 | For sockets, this just means that the other side has stopped sending data, |
97 | For sockets, this just means that the other side has stopped sending data, |
85 | you can still try to write data, and, in fact, one can return from the eof |
98 | you can still try to write data, and, in fact, one can return from the EOF |
86 | callback and continue writing data, as only the read part has been shut |
99 | callback and continue writing data, as only the read part has been shut |
87 | down. |
100 | down. |
88 | |
101 | |
89 | While not mandatory, it is I<highly> recommended to set an eof callback, |
|
|
90 | otherwise you might end up with a closed socket while you are still |
|
|
91 | waiting for data. |
|
|
92 | |
|
|
93 | If an EOF condition has been detected but no C<on_eof> callback has been |
102 | 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>. |
103 | set, then a fatal error will be raised with C<$!> set to <0>. |
95 | |
104 | |
96 | =item on_error => $cb->($handle, $fatal) |
105 | =item on_error => $cb->($handle, $fatal, $message) |
97 | |
106 | |
98 | This is the error callback, which is called when, well, some error |
107 | This is the error callback, which is called when, well, some error |
99 | occured, such as not being able to resolve the hostname, failure to |
108 | occured, such as not being able to resolve the hostname, failure to |
100 | connect or a read error. |
109 | connect or a read error. |
101 | |
110 | |
102 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
111 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
103 | fatal errors the handle object will be shut down and will not be usable |
112 | fatal errors the handle object will be destroyed (by a call to C<< -> |
104 | (but you are free to look at the current C< ->rbuf >). Examples of fatal |
113 | destroy >>) after invoking the error callback (which means you are free to |
105 | errors are an EOF condition with active (but unsatisifable) read watchers |
114 | examine the handle object). Examples of fatal errors are an EOF condition |
106 | (C<EPIPE>) or I/O errors. |
115 | with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. |
|
|
116 | |
|
|
117 | AnyEvent::Handle tries to find an appropriate error code for you to check |
|
|
118 | against, but in some cases (TLS errors), this does not work well. It is |
|
|
119 | recommended to always output the C<$message> argument in human-readable |
|
|
120 | error messages (it's usually the same as C<"$!">). |
107 | |
121 | |
108 | Non-fatal errors can be retried by simply returning, but it is recommended |
122 | Non-fatal errors can be retried by simply returning, but it is recommended |
109 | to simply ignore this parameter and instead abondon the handle object |
123 | to simply ignore this parameter and instead abondon the handle object |
110 | when this callback is invoked. Examples of non-fatal errors are timeouts |
124 | when this callback is invoked. Examples of non-fatal errors are timeouts |
111 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
125 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
112 | |
126 | |
113 | On callback entrance, the value of C<$!> contains the operating system |
127 | On callback entrance, the value of C<$!> contains the operating system |
114 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
128 | error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
|
|
129 | C<EPROTO>). |
115 | |
130 | |
116 | While not mandatory, it is I<highly> recommended to set this callback, as |
131 | While not mandatory, it is I<highly> recommended to set this callback, as |
117 | you will not be notified of errors otherwise. The default simply calls |
132 | you will not be notified of errors otherwise. The default simply calls |
118 | C<croak>. |
133 | C<croak>. |
119 | |
134 | |
… | |
… | |
123 | and no read request is in the queue (unlike read queue callbacks, this |
138 | and no read request is in the queue (unlike read queue callbacks, this |
124 | callback will only be called when at least one octet of data is in the |
139 | callback will only be called when at least one octet of data is in the |
125 | read buffer). |
140 | read buffer). |
126 | |
141 | |
127 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
142 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
128 | method or access the C<$handle->{rbuf}> member directly. |
143 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
|
|
144 | must not enlarge or modify the read buffer, you can only remove data at |
|
|
145 | the beginning from it. |
129 | |
146 | |
130 | When an EOF condition is detected then AnyEvent::Handle will first try to |
147 | When an EOF condition is detected then AnyEvent::Handle will first try to |
131 | feed all the remaining data to the queued callbacks and C<on_read> before |
148 | feed all the remaining data to the queued callbacks and C<on_read> before |
132 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
149 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
133 | error will be raised (with C<$!> set to C<EPIPE>). |
150 | error will be raised (with C<$!> set to C<EPIPE>). |
|
|
151 | |
|
|
152 | Note that, unlike requests in the read queue, an C<on_read> callback |
|
|
153 | doesn't mean you I<require> some data: if there is an EOF and there |
|
|
154 | are outstanding read requests then an error will be flagged. With an |
|
|
155 | C<on_read> callback, the C<on_eof> callback will be invoked. |
134 | |
156 | |
135 | =item on_drain => $cb->($handle) |
157 | =item on_drain => $cb->($handle) |
136 | |
158 | |
137 | This sets the callback that is called when the write buffer becomes empty |
159 | This sets the callback that is called when the write buffer becomes empty |
138 | (or when the callback is set and the buffer is empty already). |
160 | (or when the callback is set and the buffer is empty already). |
… | |
… | |
148 | =item timeout => $fractional_seconds |
170 | =item timeout => $fractional_seconds |
149 | |
171 | |
150 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
172 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
151 | seconds pass without a successful read or write on the underlying file |
173 | seconds pass without a successful read or write on the underlying file |
152 | handle, the C<on_timeout> callback will be invoked (and if that one is |
174 | handle, the C<on_timeout> callback will be invoked (and if that one is |
153 | missing, an C<ETIMEDOUT> error will be raised). |
175 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
154 | |
176 | |
155 | Note that timeout processing is also active when you currently do not have |
177 | Note that timeout processing is also active when you currently do not have |
156 | any outstanding read or write requests: If you plan to keep the connection |
178 | any outstanding read or write requests: If you plan to keep the connection |
157 | idle then you should disable the timout temporarily or ignore the timeout |
179 | idle then you should disable the timout temporarily or ignore the timeout |
158 | in the C<on_timeout> callback. |
180 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
|
|
181 | restart the timeout. |
159 | |
182 | |
160 | Zero (the default) disables this timeout. |
183 | Zero (the default) disables this timeout. |
161 | |
184 | |
162 | =item on_timeout => $cb->($handle) |
185 | =item on_timeout => $cb->($handle) |
163 | |
186 | |
… | |
… | |
167 | |
190 | |
168 | =item rbuf_max => <bytes> |
191 | =item rbuf_max => <bytes> |
169 | |
192 | |
170 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
193 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
171 | when the read buffer ever (strictly) exceeds this size. This is useful to |
194 | when the read buffer ever (strictly) exceeds this size. This is useful to |
172 | avoid denial-of-service attacks. |
195 | avoid some forms of denial-of-service attacks. |
173 | |
196 | |
174 | For example, a server accepting connections from untrusted sources should |
197 | For example, a server accepting connections from untrusted sources should |
175 | be configured to accept only so-and-so much data that it cannot act on |
198 | be configured to accept only so-and-so much data that it cannot act on |
176 | (for example, when expecting a line, an attacker could send an unlimited |
199 | (for example, when expecting a line, an attacker could send an unlimited |
177 | amount of data without a callback ever being called as long as the line |
200 | amount of data without a callback ever being called as long as the line |
178 | isn't finished). |
201 | isn't finished). |
179 | |
202 | |
180 | =item autocork => <boolean> |
203 | =item autocork => <boolean> |
181 | |
204 | |
182 | When disabled (the default), then C<push_write> will try to immediately |
205 | When disabled (the default), then C<push_write> will try to immediately |
183 | write the data to the handle if possible. This avoids having to register |
206 | write the data to the handle, if possible. This avoids having to register |
184 | a write watcher and wait for the next event loop iteration, but can be |
207 | a write watcher and wait for the next event loop iteration, but can |
185 | inefficient if you write multiple small chunks (this disadvantage is |
208 | be inefficient if you write multiple small chunks (on the wire, this |
186 | usually avoided by your kernel's nagle algorithm, see C<low_delay>). |
209 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
|
|
210 | C<no_delay>, but this option can save costly syscalls). |
187 | |
211 | |
188 | When enabled, then writes will always be queued till the next event loop |
212 | When enabled, then writes will always be queued till the next event loop |
189 | iteration. This is efficient when you do many small writes per iteration, |
213 | iteration. This is efficient when you do many small writes per iteration, |
190 | but less efficient when you do a single write only. |
214 | but less efficient when you do a single write only per iteration (or when |
|
|
215 | the write buffer often is full). It also increases write latency. |
191 | |
216 | |
192 | =item no_delay => <boolean> |
217 | =item no_delay => <boolean> |
193 | |
218 | |
194 | When doing small writes on sockets, your operating system kernel might |
219 | When doing small writes on sockets, your operating system kernel might |
195 | wait a bit for more data before actually sending it out. This is called |
220 | wait a bit for more data before actually sending it out. This is called |
196 | the Nagle algorithm, and usually it is beneficial. |
221 | the Nagle algorithm, and usually it is beneficial. |
197 | |
222 | |
198 | In some situations you want as low a delay as possible, which cna be |
223 | In some situations you want as low a delay as possible, which can be |
199 | accomplishd by setting this option to true. |
224 | accomplishd by setting this option to a true value. |
200 | |
225 | |
201 | The default is your opertaing system's default behaviour, this option |
226 | The default is your opertaing system's default behaviour (most likely |
202 | explicitly enables or disables it, if possible. |
227 | enabled), this option explicitly enables or disables it, if possible. |
203 | |
228 | |
204 | =item read_size => <bytes> |
229 | =item read_size => <bytes> |
205 | |
230 | |
206 | The default read block size (the amount of bytes this module will try to read |
231 | The default read block size (the amount of bytes this module will |
207 | during each (loop iteration). Default: C<8192>. |
232 | try to read during each loop iteration, which affects memory |
|
|
233 | requirements). Default: C<8192>. |
208 | |
234 | |
209 | =item low_water_mark => <bytes> |
235 | =item low_water_mark => <bytes> |
210 | |
236 | |
211 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
237 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
212 | buffer: If the write reaches this size or gets even samller it is |
238 | buffer: If the write reaches this size or gets even samller it is |
213 | considered empty. |
239 | considered empty. |
214 | |
240 | |
|
|
241 | Sometimes it can be beneficial (for performance reasons) to add data to |
|
|
242 | the write buffer before it is fully drained, but this is a rare case, as |
|
|
243 | the operating system kernel usually buffers data as well, so the default |
|
|
244 | is good in almost all cases. |
|
|
245 | |
215 | =item linger => <seconds> |
246 | =item linger => <seconds> |
216 | |
247 | |
217 | If non-zero (default: C<3600>), then the destructor of the |
248 | If non-zero (default: C<3600>), then the destructor of the |
218 | AnyEvent::Handle object will check wether there is still outstanding write |
249 | AnyEvent::Handle object will check whether there is still outstanding |
219 | data and will install a watcher that will write out this data. No errors |
250 | write data and will install a watcher that will write this data to the |
220 | will be reported (this mostly matches how the operating system treats |
251 | socket. No errors will be reported (this mostly matches how the operating |
221 | outstanding data at socket close time). |
252 | system treats outstanding data at socket close time). |
222 | |
253 | |
223 | This will not work for partial TLS data that could not yet been |
254 | This will not work for partial TLS data that could not be encoded |
224 | encoded. This data will be lost. |
255 | yet. This data will be lost. Calling the C<stoptls> method in time might |
|
|
256 | help. |
|
|
257 | |
|
|
258 | =item peername => $string |
|
|
259 | |
|
|
260 | A string used to identify the remote site - usually the DNS hostname |
|
|
261 | (I<not> IDN!) used to create the connection, rarely the IP address. |
|
|
262 | |
|
|
263 | Apart from being useful in error messages, this string is also used in TLS |
|
|
264 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
|
|
265 | verification will be skipped when C<peername> is not specified or |
|
|
266 | C<undef>. |
225 | |
267 | |
226 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
268 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
227 | |
269 | |
228 | When this parameter is given, it enables TLS (SSL) mode, that means it |
270 | When this parameter is given, it enables TLS (SSL) mode, that means |
229 | will start making tls handshake and will transparently encrypt/decrypt |
271 | AnyEvent will start a TLS handshake as soon as the conenction has been |
230 | data. |
272 | established and will transparently encrypt/decrypt data afterwards. |
|
|
273 | |
|
|
274 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
|
|
275 | appropriate error message. |
231 | |
276 | |
232 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
277 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
233 | automatically when you try to create a TLS handle). |
278 | automatically when you try to create a TLS handle): this module doesn't |
|
|
279 | have a dependency on that module, so if your module requires it, you have |
|
|
280 | to add the dependency yourself. |
234 | |
281 | |
235 | For the TLS server side, use C<accept>, and for the TLS client side of a |
282 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
236 | connection, use C<connect> mode. |
283 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
284 | mode. |
237 | |
285 | |
238 | You can also provide your own TLS connection object, but you have |
286 | You can also provide your own TLS connection object, but you have |
239 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
287 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
240 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
288 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
241 | AnyEvent::Handle. |
289 | AnyEvent::Handle. Also, this module will take ownership of this connection |
|
|
290 | object. |
242 | |
291 | |
|
|
292 | At some future point, AnyEvent::Handle might switch to another TLS |
|
|
293 | implementation, then the option to use your own session object will go |
|
|
294 | away. |
|
|
295 | |
|
|
296 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
|
|
297 | passing in the wrong integer will lead to certain crash. This most often |
|
|
298 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
|
|
299 | segmentation fault. |
|
|
300 | |
243 | See the C<starttls> method if you need to start TLS negotiation later. |
301 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
244 | |
302 | |
245 | =item tls_ctx => $ssl_ctx |
303 | =item tls_ctx => $anyevent_tls |
246 | |
304 | |
247 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
305 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
248 | (unless a connection object was specified directly). If this parameter is |
306 | (unless a connection object was specified directly). If this parameter is |
249 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
307 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
250 | |
308 | |
|
|
309 | Instead of an object, you can also specify a hash reference with C<< key |
|
|
310 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
|
|
311 | new TLS context object. |
|
|
312 | |
|
|
313 | =item on_starttls => $cb->($handle, $success[, $error_message]) |
|
|
314 | |
|
|
315 | This callback will be invoked when the TLS/SSL handshake has finished. If |
|
|
316 | C<$success> is true, then the TLS handshake succeeded, otherwise it failed |
|
|
317 | (C<on_stoptls> will not be called in this case). |
|
|
318 | |
|
|
319 | The session in C<< $handle->{tls} >> can still be examined in this |
|
|
320 | callback, even when the handshake was not successful. |
|
|
321 | |
|
|
322 | TLS handshake failures will not cause C<on_error> to be invoked when this |
|
|
323 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
|
|
324 | |
|
|
325 | Without this callback, handshake failures lead to C<on_error> being |
|
|
326 | called, as normal. |
|
|
327 | |
|
|
328 | Note that you cannot call C<starttls> right again in this callback. If you |
|
|
329 | need to do that, start an zero-second timer instead whose callback can |
|
|
330 | then call C<< ->starttls >> again. |
|
|
331 | |
|
|
332 | =item on_stoptls => $cb->($handle) |
|
|
333 | |
|
|
334 | When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is |
|
|
335 | set, then it will be invoked after freeing the TLS session. If it is not, |
|
|
336 | then a TLS shutdown condition will be treated like a normal EOF condition |
|
|
337 | on the handle. |
|
|
338 | |
|
|
339 | The session in C<< $handle->{tls} >> can still be examined in this |
|
|
340 | callback. |
|
|
341 | |
|
|
342 | This callback will only be called on TLS shutdowns, not when the |
|
|
343 | underlying handle signals EOF. |
|
|
344 | |
251 | =item json => JSON or JSON::XS object |
345 | =item json => JSON or JSON::XS object |
252 | |
346 | |
253 | This is the json coder object used by the C<json> read and write types. |
347 | This is the json coder object used by the C<json> read and write types. |
254 | |
348 | |
255 | If you don't supply it, then AnyEvent::Handle will create and use a |
349 | If you don't supply it, then AnyEvent::Handle will create and use a |
256 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
350 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
351 | texts. |
257 | |
352 | |
258 | Note that you are responsible to depend on the JSON module if you want to |
353 | Note that you are responsible to depend on the JSON module if you want to |
259 | use this functionality, as AnyEvent does not have a dependency itself. |
354 | use this functionality, as AnyEvent does not have a dependency itself. |
260 | |
355 | |
261 | =item filter_r => $cb |
|
|
262 | |
|
|
263 | =item filter_w => $cb |
|
|
264 | |
|
|
265 | These exist, but are undocumented at this time. |
|
|
266 | |
|
|
267 | =back |
356 | =back |
268 | |
357 | |
269 | =cut |
358 | =cut |
270 | |
359 | |
271 | sub new { |
360 | sub new { |
272 | my $class = shift; |
361 | my $class = shift; |
273 | |
|
|
274 | my $self = bless { @_ }, $class; |
362 | my $self = bless { @_ }, $class; |
275 | |
363 | |
276 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
364 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
277 | |
365 | |
278 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
366 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
279 | |
|
|
280 | if ($self->{tls}) { |
|
|
281 | require Net::SSLeay; |
|
|
282 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
|
|
283 | } |
|
|
284 | |
367 | |
285 | $self->{_activity} = AnyEvent->now; |
368 | $self->{_activity} = AnyEvent->now; |
286 | $self->_timeout; |
369 | $self->_timeout; |
287 | |
370 | |
288 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
|
|
289 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
371 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
372 | |
|
|
373 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
|
|
374 | if $self->{tls}; |
|
|
375 | |
|
|
376 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
290 | |
377 | |
291 | $self->start_read |
378 | $self->start_read |
292 | if $self->{on_read}; |
379 | if $self->{on_read}; |
293 | |
380 | |
294 | $self |
381 | $self->{fh} && $self |
295 | } |
382 | } |
296 | |
383 | |
297 | sub _shutdown { |
384 | #sub _shutdown { |
298 | my ($self) = @_; |
385 | # my ($self) = @_; |
299 | |
386 | # |
300 | delete $self->{_tw}; |
387 | # delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
301 | delete $self->{_rw}; |
388 | # $self->{_eof} = 1; # tell starttls et. al to stop trying |
302 | delete $self->{_ww}; |
389 | # |
303 | delete $self->{fh}; |
390 | # &_freetls; |
304 | |
391 | #} |
305 | $self->stoptls; |
|
|
306 | |
|
|
307 | delete $self->{on_read}; |
|
|
308 | delete $self->{_queue}; |
|
|
309 | } |
|
|
310 | |
392 | |
311 | sub _error { |
393 | sub _error { |
312 | my ($self, $errno, $fatal) = @_; |
394 | my ($self, $errno, $fatal, $message) = @_; |
313 | |
|
|
314 | $self->_shutdown |
|
|
315 | if $fatal; |
|
|
316 | |
395 | |
317 | $! = $errno; |
396 | $! = $errno; |
|
|
397 | $message ||= "$!"; |
318 | |
398 | |
319 | if ($self->{on_error}) { |
399 | if ($self->{on_error}) { |
320 | $self->{on_error}($self, $fatal); |
400 | $self->{on_error}($self, $fatal, $message); |
321 | } else { |
401 | $self->destroy if $fatal; |
|
|
402 | } elsif ($self->{fh}) { |
|
|
403 | $self->destroy; |
322 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
404 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
323 | } |
405 | } |
324 | } |
406 | } |
325 | |
407 | |
326 | =item $fh = $handle->fh |
408 | =item $fh = $handle->fh |
327 | |
409 | |
328 | This method returns the file handle of the L<AnyEvent::Handle> object. |
410 | This method returns the file handle used to create the L<AnyEvent::Handle> object. |
329 | |
411 | |
330 | =cut |
412 | =cut |
331 | |
413 | |
332 | sub fh { $_[0]{fh} } |
414 | sub fh { $_[0]{fh} } |
333 | |
415 | |
… | |
… | |
351 | $_[0]{on_eof} = $_[1]; |
433 | $_[0]{on_eof} = $_[1]; |
352 | } |
434 | } |
353 | |
435 | |
354 | =item $handle->on_timeout ($cb) |
436 | =item $handle->on_timeout ($cb) |
355 | |
437 | |
356 | Replace the current C<on_timeout> callback, or disables the callback |
438 | Replace the current C<on_timeout> callback, or disables the callback (but |
357 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
439 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
358 | argument. |
440 | argument and method. |
359 | |
441 | |
360 | =cut |
442 | =cut |
361 | |
443 | |
362 | sub on_timeout { |
444 | sub on_timeout { |
363 | $_[0]{on_timeout} = $_[1]; |
445 | $_[0]{on_timeout} = $_[1]; |
364 | } |
446 | } |
365 | |
447 | |
366 | =item $handle->autocork ($boolean) |
448 | =item $handle->autocork ($boolean) |
367 | |
449 | |
368 | Enables or disables the current autocork behaviour (see C<autocork> |
450 | Enables or disables the current autocork behaviour (see C<autocork> |
369 | constructor argument). |
451 | constructor argument). Changes will only take effect on the next write. |
370 | |
452 | |
371 | =cut |
453 | =cut |
|
|
454 | |
|
|
455 | sub autocork { |
|
|
456 | $_[0]{autocork} = $_[1]; |
|
|
457 | } |
372 | |
458 | |
373 | =item $handle->no_delay ($boolean) |
459 | =item $handle->no_delay ($boolean) |
374 | |
460 | |
375 | Enables or disables the C<no_delay> setting (see constructor argument of |
461 | Enables or disables the C<no_delay> setting (see constructor argument of |
376 | the same name for details). |
462 | the same name for details). |
… | |
… | |
384 | local $SIG{__DIE__}; |
470 | local $SIG{__DIE__}; |
385 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
471 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
386 | }; |
472 | }; |
387 | } |
473 | } |
388 | |
474 | |
|
|
475 | =item $handle->on_starttls ($cb) |
|
|
476 | |
|
|
477 | Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). |
|
|
478 | |
|
|
479 | =cut |
|
|
480 | |
|
|
481 | sub on_starttls { |
|
|
482 | $_[0]{on_starttls} = $_[1]; |
|
|
483 | } |
|
|
484 | |
|
|
485 | =item $handle->on_stoptls ($cb) |
|
|
486 | |
|
|
487 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
|
|
488 | |
|
|
489 | =cut |
|
|
490 | |
|
|
491 | sub on_starttls { |
|
|
492 | $_[0]{on_stoptls} = $_[1]; |
|
|
493 | } |
|
|
494 | |
389 | ############################################################################# |
495 | ############################################################################# |
390 | |
496 | |
391 | =item $handle->timeout ($seconds) |
497 | =item $handle->timeout ($seconds) |
392 | |
498 | |
393 | Configures (or disables) the inactivity timeout. |
499 | Configures (or disables) the inactivity timeout. |
… | |
… | |
417 | $self->{_activity} = $NOW; |
523 | $self->{_activity} = $NOW; |
418 | |
524 | |
419 | if ($self->{on_timeout}) { |
525 | if ($self->{on_timeout}) { |
420 | $self->{on_timeout}($self); |
526 | $self->{on_timeout}($self); |
421 | } else { |
527 | } else { |
422 | $self->_error (&Errno::ETIMEDOUT); |
528 | $self->_error (Errno::ETIMEDOUT); |
423 | } |
529 | } |
424 | |
530 | |
425 | # callback could have changed timeout value, optimise |
531 | # callback could have changed timeout value, optimise |
426 | return unless $self->{timeout}; |
532 | return unless $self->{timeout}; |
427 | |
533 | |
… | |
… | |
469 | my ($self, $cb) = @_; |
575 | my ($self, $cb) = @_; |
470 | |
576 | |
471 | $self->{on_drain} = $cb; |
577 | $self->{on_drain} = $cb; |
472 | |
578 | |
473 | $cb->($self) |
579 | $cb->($self) |
474 | if $cb && $self->{low_water_mark} >= length $self->{wbuf}; |
580 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
475 | } |
581 | } |
476 | |
582 | |
477 | =item $handle->push_write ($data) |
583 | =item $handle->push_write ($data) |
478 | |
584 | |
479 | Queues the given scalar to be written. You can push as much data as you |
585 | Queues the given scalar to be written. You can push as much data as you |
… | |
… | |
490 | Scalar::Util::weaken $self; |
596 | Scalar::Util::weaken $self; |
491 | |
597 | |
492 | my $cb = sub { |
598 | my $cb = sub { |
493 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
599 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
494 | |
600 | |
495 | if ($len >= 0) { |
601 | if (defined $len) { |
496 | substr $self->{wbuf}, 0, $len, ""; |
602 | substr $self->{wbuf}, 0, $len, ""; |
497 | |
603 | |
498 | $self->{_activity} = AnyEvent->now; |
604 | $self->{_activity} = AnyEvent->now; |
499 | |
605 | |
500 | $self->{on_drain}($self) |
606 | $self->{on_drain}($self) |
501 | if $self->{low_water_mark} >= length $self->{wbuf} |
607 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
502 | && $self->{on_drain}; |
608 | && $self->{on_drain}; |
503 | |
609 | |
504 | delete $self->{_ww} unless length $self->{wbuf}; |
610 | delete $self->{_ww} unless length $self->{wbuf}; |
505 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
611 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
506 | $self->_error ($!, 1); |
612 | $self->_error ($!, 1); |
… | |
… | |
530 | |
636 | |
531 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
637 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
532 | ->($self, @_); |
638 | ->($self, @_); |
533 | } |
639 | } |
534 | |
640 | |
535 | if ($self->{filter_w}) { |
641 | if ($self->{tls}) { |
536 | $self->{filter_w}($self, \$_[0]); |
642 | $self->{_tls_wbuf} .= $_[0]; |
|
|
643 | |
|
|
644 | &_dotls ($self); |
537 | } else { |
645 | } else { |
538 | $self->{wbuf} .= $_[0]; |
646 | $self->{wbuf} .= $_[0]; |
539 | $self->_drain_wbuf; |
647 | $self->_drain_wbuf; |
540 | } |
648 | } |
541 | } |
649 | } |
… | |
… | |
558 | =cut |
666 | =cut |
559 | |
667 | |
560 | register_write_type netstring => sub { |
668 | register_write_type netstring => sub { |
561 | my ($self, $string) = @_; |
669 | my ($self, $string) = @_; |
562 | |
670 | |
563 | sprintf "%d:%s,", (length $string), $string |
671 | (length $string) . ":$string," |
564 | }; |
672 | }; |
565 | |
673 | |
566 | =item packstring => $format, $data |
674 | =item packstring => $format, $data |
567 | |
675 | |
568 | An octet string prefixed with an encoded length. The encoding C<$format> |
676 | An octet string prefixed with an encoded length. The encoding C<$format> |
… | |
… | |
633 | |
741 | |
634 | pack "w/a*", Storable::nfreeze ($ref) |
742 | pack "w/a*", Storable::nfreeze ($ref) |
635 | }; |
743 | }; |
636 | |
744 | |
637 | =back |
745 | =back |
|
|
746 | |
|
|
747 | =item $handle->push_shutdown |
|
|
748 | |
|
|
749 | Sometimes you know you want to close the socket after writing your data |
|
|
750 | before it was actually written. One way to do that is to replace your |
|
|
751 | C<on_drain> handler by a callback that shuts down the socket (and set |
|
|
752 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
|
|
753 | replaces the C<on_drain> callback with: |
|
|
754 | |
|
|
755 | sub { shutdown $_[0]{fh}, 1 } # for push_shutdown |
|
|
756 | |
|
|
757 | This simply shuts down the write side and signals an EOF condition to the |
|
|
758 | the peer. |
|
|
759 | |
|
|
760 | You can rely on the normal read queue and C<on_eof> handling |
|
|
761 | afterwards. This is the cleanest way to close a connection. |
|
|
762 | |
|
|
763 | =cut |
|
|
764 | |
|
|
765 | sub push_shutdown { |
|
|
766 | my ($self) = @_; |
|
|
767 | |
|
|
768 | delete $self->{low_water_mark}; |
|
|
769 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
|
|
770 | } |
638 | |
771 | |
639 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
772 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
640 | |
773 | |
641 | This function (not method) lets you add your own types to C<push_write>. |
774 | This function (not method) lets you add your own types to C<push_write>. |
642 | Whenever the given C<type> is used, C<push_write> will invoke the code |
775 | Whenever the given C<type> is used, C<push_write> will invoke the code |
… | |
… | |
742 | |
875 | |
743 | if ( |
876 | if ( |
744 | defined $self->{rbuf_max} |
877 | defined $self->{rbuf_max} |
745 | && $self->{rbuf_max} < length $self->{rbuf} |
878 | && $self->{rbuf_max} < length $self->{rbuf} |
746 | ) { |
879 | ) { |
747 | $self->_error (&Errno::ENOSPC, 1), return; |
880 | $self->_error (Errno::ENOSPC, 1), return; |
748 | } |
881 | } |
749 | |
882 | |
750 | while () { |
883 | while () { |
|
|
884 | # we need to use a separate tls read buffer, as we must not receive data while |
|
|
885 | # we are draining the buffer, and this can only happen with TLS. |
|
|
886 | $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf}; |
|
|
887 | |
751 | my $len = length $self->{rbuf}; |
888 | my $len = length $self->{rbuf}; |
752 | |
889 | |
753 | if (my $cb = shift @{ $self->{_queue} }) { |
890 | if (my $cb = shift @{ $self->{_queue} }) { |
754 | unless ($cb->($self)) { |
891 | unless ($cb->($self)) { |
755 | if ($self->{_eof}) { |
892 | if ($self->{_eof}) { |
756 | # no progress can be made (not enough data and no data forthcoming) |
893 | # no progress can be made (not enough data and no data forthcoming) |
757 | $self->_error (&Errno::EPIPE, 1), return; |
894 | $self->_error (Errno::EPIPE, 1), return; |
758 | } |
895 | } |
759 | |
896 | |
760 | unshift @{ $self->{_queue} }, $cb; |
897 | unshift @{ $self->{_queue} }, $cb; |
761 | last; |
898 | last; |
762 | } |
899 | } |
… | |
… | |
770 | && !@{ $self->{_queue} } # and the queue is still empty |
907 | && !@{ $self->{_queue} } # and the queue is still empty |
771 | && $self->{on_read} # but we still have on_read |
908 | && $self->{on_read} # but we still have on_read |
772 | ) { |
909 | ) { |
773 | # no further data will arrive |
910 | # no further data will arrive |
774 | # so no progress can be made |
911 | # so no progress can be made |
775 | $self->_error (&Errno::EPIPE, 1), return |
912 | $self->_error (Errno::EPIPE, 1), return |
776 | if $self->{_eof}; |
913 | if $self->{_eof}; |
777 | |
914 | |
778 | last; # more data might arrive |
915 | last; # more data might arrive |
779 | } |
916 | } |
780 | } else { |
917 | } else { |
781 | # read side becomes idle |
918 | # read side becomes idle |
782 | delete $self->{_rw}; |
919 | delete $self->{_rw} unless $self->{tls}; |
783 | last; |
920 | last; |
784 | } |
921 | } |
785 | } |
922 | } |
786 | |
923 | |
787 | if ($self->{_eof}) { |
924 | if ($self->{_eof}) { |
788 | if ($self->{on_eof}) { |
925 | if ($self->{on_eof}) { |
789 | $self->{on_eof}($self) |
926 | $self->{on_eof}($self) |
790 | } else { |
927 | } else { |
791 | $self->_error (0, 1); |
928 | $self->_error (0, 1, "Unexpected end-of-file"); |
792 | } |
929 | } |
793 | } |
930 | } |
794 | |
931 | |
795 | # may need to restart read watcher |
932 | # may need to restart read watcher |
796 | unless ($self->{_rw}) { |
933 | unless ($self->{_rw}) { |
… | |
… | |
816 | |
953 | |
817 | =item $handle->rbuf |
954 | =item $handle->rbuf |
818 | |
955 | |
819 | Returns the read buffer (as a modifiable lvalue). |
956 | Returns the read buffer (as a modifiable lvalue). |
820 | |
957 | |
821 | You can access the read buffer directly as the C<< ->{rbuf} >> member, if |
958 | You can access the read buffer directly as the C<< ->{rbuf} >> |
822 | you want. |
959 | member, if you want. However, the only operation allowed on the |
|
|
960 | read buffer (apart from looking at it) is removing data from its |
|
|
961 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
962 | lead to hard-to-track-down bugs. |
823 | |
963 | |
824 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
964 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
825 | C<push_read> or C<unshift_read> methods are used. The other read methods |
965 | C<push_read> or C<unshift_read> methods are used. The other read methods |
826 | automatically manage the read buffer. |
966 | automatically manage the read buffer. |
827 | |
967 | |
… | |
… | |
1027 | return 1; |
1167 | return 1; |
1028 | } |
1168 | } |
1029 | |
1169 | |
1030 | # reject |
1170 | # reject |
1031 | if ($reject && $$rbuf =~ $reject) { |
1171 | if ($reject && $$rbuf =~ $reject) { |
1032 | $self->_error (&Errno::EBADMSG); |
1172 | $self->_error (Errno::EBADMSG); |
1033 | } |
1173 | } |
1034 | |
1174 | |
1035 | # skip |
1175 | # skip |
1036 | if ($skip && $$rbuf =~ $skip) { |
1176 | if ($skip && $$rbuf =~ $skip) { |
1037 | $data .= substr $$rbuf, 0, $+[0], ""; |
1177 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
1053 | my ($self, $cb) = @_; |
1193 | my ($self, $cb) = @_; |
1054 | |
1194 | |
1055 | sub { |
1195 | sub { |
1056 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1196 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1057 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1197 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1058 | $self->_error (&Errno::EBADMSG); |
1198 | $self->_error (Errno::EBADMSG); |
1059 | } |
1199 | } |
1060 | return; |
1200 | return; |
1061 | } |
1201 | } |
1062 | |
1202 | |
1063 | my $len = $1; |
1203 | my $len = $1; |
… | |
… | |
1066 | my $string = $_[1]; |
1206 | my $string = $_[1]; |
1067 | $_[0]->unshift_read (chunk => 1, sub { |
1207 | $_[0]->unshift_read (chunk => 1, sub { |
1068 | if ($_[1] eq ",") { |
1208 | if ($_[1] eq ",") { |
1069 | $cb->($_[0], $string); |
1209 | $cb->($_[0], $string); |
1070 | } else { |
1210 | } else { |
1071 | $self->_error (&Errno::EBADMSG); |
1211 | $self->_error (Errno::EBADMSG); |
1072 | } |
1212 | } |
1073 | }); |
1213 | }); |
1074 | }); |
1214 | }); |
1075 | |
1215 | |
1076 | 1 |
1216 | 1 |
… | |
… | |
1082 | An octet string prefixed with an encoded length. The encoding C<$format> |
1222 | An octet string prefixed with an encoded length. The encoding C<$format> |
1083 | uses the same format as a Perl C<pack> format, but must specify a single |
1223 | uses the same format as a Perl C<pack> format, but must specify a single |
1084 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1224 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1085 | optional C<!>, C<< < >> or C<< > >> modifier). |
1225 | optional C<!>, C<< < >> or C<< > >> modifier). |
1086 | |
1226 | |
1087 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
1227 | For example, DNS over TCP uses a prefix of C<n> (2 octet network order), |
|
|
1228 | EPP uses a prefix of C<N> (4 octtes). |
1088 | |
1229 | |
1089 | Example: read a block of data prefixed by its length in BER-encoded |
1230 | Example: read a block of data prefixed by its length in BER-encoded |
1090 | format (very efficient). |
1231 | format (very efficient). |
1091 | |
1232 | |
1092 | $handle->push_read (packstring => "w", sub { |
1233 | $handle->push_read (packstring => "w", sub { |
… | |
… | |
1122 | } |
1263 | } |
1123 | }; |
1264 | }; |
1124 | |
1265 | |
1125 | =item json => $cb->($handle, $hash_or_arrayref) |
1266 | =item json => $cb->($handle, $hash_or_arrayref) |
1126 | |
1267 | |
1127 | Reads a JSON object or array, decodes it and passes it to the callback. |
1268 | Reads a JSON object or array, decodes it and passes it to the |
|
|
1269 | callback. When a parse error occurs, an C<EBADMSG> error will be raised. |
1128 | |
1270 | |
1129 | If a C<json> object was passed to the constructor, then that will be used |
1271 | If a C<json> object was passed to the constructor, then that will be used |
1130 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1272 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1131 | |
1273 | |
1132 | This read type uses the incremental parser available with JSON version |
1274 | This read type uses the incremental parser available with JSON version |
… | |
… | |
1141 | =cut |
1283 | =cut |
1142 | |
1284 | |
1143 | register_read_type json => sub { |
1285 | register_read_type json => sub { |
1144 | my ($self, $cb) = @_; |
1286 | my ($self, $cb) = @_; |
1145 | |
1287 | |
1146 | require JSON; |
1288 | my $json = $self->{json} ||= |
|
|
1289 | eval { require JSON::XS; JSON::XS->new->utf8 } |
|
|
1290 | || do { require JSON; JSON->new->utf8 }; |
1147 | |
1291 | |
1148 | my $data; |
1292 | my $data; |
1149 | my $rbuf = \$self->{rbuf}; |
1293 | my $rbuf = \$self->{rbuf}; |
1150 | |
1294 | |
1151 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
1152 | |
|
|
1153 | sub { |
1295 | sub { |
1154 | my $ref = $json->incr_parse ($self->{rbuf}); |
1296 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1155 | |
1297 | |
1156 | if ($ref) { |
1298 | if ($ref) { |
1157 | $self->{rbuf} = $json->incr_text; |
1299 | $self->{rbuf} = $json->incr_text; |
1158 | $json->incr_text = ""; |
1300 | $json->incr_text = ""; |
1159 | $cb->($self, $ref); |
1301 | $cb->($self, $ref); |
1160 | |
1302 | |
1161 | 1 |
1303 | 1 |
|
|
1304 | } elsif ($@) { |
|
|
1305 | # error case |
|
|
1306 | $json->incr_skip; |
|
|
1307 | |
|
|
1308 | $self->{rbuf} = $json->incr_text; |
|
|
1309 | $json->incr_text = ""; |
|
|
1310 | |
|
|
1311 | $self->_error (Errno::EBADMSG); |
|
|
1312 | |
|
|
1313 | () |
1162 | } else { |
1314 | } else { |
1163 | $self->{rbuf} = ""; |
1315 | $self->{rbuf} = ""; |
|
|
1316 | |
1164 | () |
1317 | () |
1165 | } |
1318 | } |
1166 | } |
1319 | } |
1167 | }; |
1320 | }; |
1168 | |
1321 | |
… | |
… | |
1200 | # read remaining chunk |
1353 | # read remaining chunk |
1201 | $_[0]->unshift_read (chunk => $len, sub { |
1354 | $_[0]->unshift_read (chunk => $len, sub { |
1202 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1355 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1203 | $cb->($_[0], $ref); |
1356 | $cb->($_[0], $ref); |
1204 | } else { |
1357 | } else { |
1205 | $self->_error (&Errno::EBADMSG); |
1358 | $self->_error (Errno::EBADMSG); |
1206 | } |
1359 | } |
1207 | }); |
1360 | }); |
1208 | } |
1361 | } |
1209 | |
1362 | |
1210 | 1 |
1363 | 1 |
… | |
… | |
1245 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1398 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1246 | you change the C<on_read> callback or push/unshift a read callback, and it |
1399 | you change the C<on_read> callback or push/unshift a read callback, and it |
1247 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1400 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1248 | there are any read requests in the queue. |
1401 | there are any read requests in the queue. |
1249 | |
1402 | |
|
|
1403 | These methods will have no effect when in TLS mode (as TLS doesn't support |
|
|
1404 | half-duplex connections). |
|
|
1405 | |
1250 | =cut |
1406 | =cut |
1251 | |
1407 | |
1252 | sub stop_read { |
1408 | sub stop_read { |
1253 | my ($self) = @_; |
1409 | my ($self) = @_; |
1254 | |
1410 | |
1255 | delete $self->{_rw}; |
1411 | delete $self->{_rw} unless $self->{tls}; |
1256 | } |
1412 | } |
1257 | |
1413 | |
1258 | sub start_read { |
1414 | sub start_read { |
1259 | my ($self) = @_; |
1415 | my ($self) = @_; |
1260 | |
1416 | |
1261 | unless ($self->{_rw} || $self->{_eof}) { |
1417 | unless ($self->{_rw} || $self->{_eof}) { |
1262 | Scalar::Util::weaken $self; |
1418 | Scalar::Util::weaken $self; |
1263 | |
1419 | |
1264 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1420 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1265 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1421 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1266 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1422 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1267 | |
1423 | |
1268 | if ($len > 0) { |
1424 | if ($len > 0) { |
1269 | $self->{_activity} = AnyEvent->now; |
1425 | $self->{_activity} = AnyEvent->now; |
1270 | |
1426 | |
1271 | $self->{filter_r} |
1427 | if ($self->{tls}) { |
1272 | ? $self->{filter_r}($self, $rbuf) |
1428 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1273 | : $self->{_in_drain} || $self->_drain_rbuf; |
1429 | |
|
|
1430 | &_dotls ($self); |
|
|
1431 | } else { |
|
|
1432 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1433 | } |
1274 | |
1434 | |
1275 | } elsif (defined $len) { |
1435 | } elsif (defined $len) { |
1276 | delete $self->{_rw}; |
1436 | delete $self->{_rw}; |
1277 | $self->{_eof} = 1; |
1437 | $self->{_eof} = 1; |
1278 | $self->_drain_rbuf unless $self->{_in_drain}; |
1438 | $self->_drain_rbuf unless $self->{_in_drain}; |
… | |
… | |
1282 | } |
1442 | } |
1283 | }); |
1443 | }); |
1284 | } |
1444 | } |
1285 | } |
1445 | } |
1286 | |
1446 | |
|
|
1447 | our $ERROR_SYSCALL; |
|
|
1448 | our $ERROR_WANT_READ; |
|
|
1449 | |
|
|
1450 | sub _tls_error { |
|
|
1451 | my ($self, $err) = @_; |
|
|
1452 | |
|
|
1453 | return $self->_error ($!, 1) |
|
|
1454 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
|
|
1455 | |
|
|
1456 | my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
|
|
1457 | |
|
|
1458 | # reduce error string to look less scary |
|
|
1459 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
|
|
1460 | |
|
|
1461 | if ($self->{_on_starttls}) { |
|
|
1462 | (delete $self->{_on_starttls})->($self, undef, $err); |
|
|
1463 | &_freetls; |
|
|
1464 | } else { |
|
|
1465 | &_freetls; |
|
|
1466 | $self->_error (Errno::EPROTO, 1, $err); |
|
|
1467 | } |
|
|
1468 | } |
|
|
1469 | |
|
|
1470 | # poll the write BIO and send the data if applicable |
|
|
1471 | # also decode read data if possible |
|
|
1472 | # this is basiclaly our TLS state machine |
|
|
1473 | # more efficient implementations are possible with openssl, |
|
|
1474 | # but not with the buggy and incomplete Net::SSLeay. |
1287 | sub _dotls { |
1475 | sub _dotls { |
1288 | my ($self) = @_; |
1476 | my ($self) = @_; |
1289 | |
1477 | |
1290 | my $buf; |
1478 | my $tmp; |
1291 | |
1479 | |
1292 | if (length $self->{_tls_wbuf}) { |
1480 | if (length $self->{_tls_wbuf}) { |
1293 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1481 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1294 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1482 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1295 | } |
1483 | } |
1296 | } |
|
|
1297 | |
1484 | |
|
|
1485 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
|
|
1486 | return $self->_tls_error ($tmp) |
|
|
1487 | if $tmp != $ERROR_WANT_READ |
|
|
1488 | && ($tmp != $ERROR_SYSCALL || $!); |
|
|
1489 | } |
|
|
1490 | |
|
|
1491 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
|
|
1492 | unless (length $tmp) { |
|
|
1493 | $self->{_on_starttls} |
|
|
1494 | and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ??? |
|
|
1495 | &_freetls; |
|
|
1496 | |
|
|
1497 | if ($self->{on_stoptls}) { |
|
|
1498 | $self->{on_stoptls}($self); |
|
|
1499 | return; |
|
|
1500 | } else { |
|
|
1501 | # let's treat SSL-eof as we treat normal EOF |
|
|
1502 | delete $self->{_rw}; |
|
|
1503 | $self->{_eof} = 1; |
|
|
1504 | } |
|
|
1505 | } |
|
|
1506 | |
|
|
1507 | $self->{_tls_rbuf} .= $tmp; |
|
|
1508 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1509 | $self->{tls} or return; # tls session might have gone away in callback |
|
|
1510 | } |
|
|
1511 | |
|
|
1512 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
|
|
1513 | return $self->_tls_error ($tmp) |
|
|
1514 | if $tmp != $ERROR_WANT_READ |
|
|
1515 | && ($tmp != $ERROR_SYSCALL || $!); |
|
|
1516 | |
1298 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1517 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1299 | $self->{wbuf} .= $buf; |
1518 | $self->{wbuf} .= $tmp; |
1300 | $self->_drain_wbuf; |
1519 | $self->_drain_wbuf; |
1301 | } |
1520 | } |
1302 | |
1521 | |
1303 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1522 | $self->{_on_starttls} |
1304 | if (length $buf) { |
1523 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1305 | $self->{rbuf} .= $buf; |
1524 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
1306 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1307 | } else { |
|
|
1308 | # let's treat SSL-eof as we treat normal EOF |
|
|
1309 | $self->{_eof} = 1; |
|
|
1310 | $self->_shutdown; |
|
|
1311 | return; |
|
|
1312 | } |
|
|
1313 | } |
|
|
1314 | |
|
|
1315 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
|
|
1316 | |
|
|
1317 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
|
|
1318 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
|
|
1319 | return $self->_error ($!, 1); |
|
|
1320 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
|
|
1321 | return $self->_error (&Errno::EIO, 1); |
|
|
1322 | } |
|
|
1323 | |
|
|
1324 | # all others are fine for our purposes |
|
|
1325 | } |
|
|
1326 | } |
1525 | } |
1327 | |
1526 | |
1328 | =item $handle->starttls ($tls[, $tls_ctx]) |
1527 | =item $handle->starttls ($tls[, $tls_ctx]) |
1329 | |
1528 | |
1330 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1529 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1331 | object is created, you can also do that at a later time by calling |
1530 | object is created, you can also do that at a later time by calling |
1332 | C<starttls>. |
1531 | C<starttls>. |
1333 | |
1532 | |
|
|
1533 | Starting TLS is currently an asynchronous operation - when you push some |
|
|
1534 | write data and then call C<< ->starttls >> then TLS negotiation will start |
|
|
1535 | immediately, after which the queued write data is then sent. |
|
|
1536 | |
1334 | The first argument is the same as the C<tls> constructor argument (either |
1537 | The first argument is the same as the C<tls> constructor argument (either |
1335 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1538 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1336 | |
1539 | |
1337 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
1540 | The second argument is the optional C<AnyEvent::TLS> object that is used |
1338 | used when AnyEvent::Handle has to create its own TLS connection object. |
1541 | when AnyEvent::Handle has to create its own TLS connection object, or |
|
|
1542 | a hash reference with C<< key => value >> pairs that will be used to |
|
|
1543 | construct a new context. |
1339 | |
1544 | |
1340 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1545 | The TLS connection object will end up in C<< $handle->{tls} >>, the TLS |
1341 | call and can be used or changed to your liking. Note that the handshake |
1546 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1342 | might have already started when this function returns. |
1547 | changed to your liking. Note that the handshake might have already started |
|
|
1548 | when this function returns. |
1343 | |
1549 | |
|
|
1550 | If it an error to start a TLS handshake more than once per |
|
|
1551 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
|
|
1552 | |
1344 | =cut |
1553 | =cut |
|
|
1554 | |
|
|
1555 | our %TLS_CACHE; #TODO not yet documented, should we? |
1345 | |
1556 | |
1346 | sub starttls { |
1557 | sub starttls { |
1347 | my ($self, $ssl, $ctx) = @_; |
1558 | my ($self, $ssl, $ctx) = @_; |
1348 | |
1559 | |
1349 | $self->stoptls; |
1560 | require Net::SSLeay; |
1350 | |
1561 | |
1351 | if ($ssl eq "accept") { |
1562 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
1352 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1563 | if $self->{tls}; |
1353 | Net::SSLeay::set_accept_state ($ssl); |
1564 | |
1354 | } elsif ($ssl eq "connect") { |
1565 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1355 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1566 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1356 | Net::SSLeay::set_connect_state ($ssl); |
1567 | |
|
|
1568 | $ctx ||= $self->{tls_ctx}; |
|
|
1569 | |
|
|
1570 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
|
|
1571 | |
|
|
1572 | if ("HASH" eq ref $ctx) { |
|
|
1573 | require AnyEvent::TLS; |
|
|
1574 | |
|
|
1575 | if ($ctx->{cache}) { |
|
|
1576 | my $key = $ctx+0; |
|
|
1577 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
|
|
1578 | } else { |
|
|
1579 | $ctx = new AnyEvent::TLS %$ctx; |
|
|
1580 | } |
|
|
1581 | } |
1357 | } |
1582 | |
1358 | |
1583 | $self->{tls_ctx} = $ctx || TLS_CTX (); |
1359 | $self->{tls} = $ssl; |
1584 | $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername}); |
1360 | |
1585 | |
1361 | # basically, this is deep magic (because SSL_read should have the same issues) |
1586 | # basically, this is deep magic (because SSL_read should have the same issues) |
1362 | # but the openssl maintainers basically said: "trust us, it just works". |
1587 | # but the openssl maintainers basically said: "trust us, it just works". |
1363 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1588 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1364 | # and mismaintained ssleay-module doesn't even offer them). |
1589 | # and mismaintained ssleay-module doesn't even offer them). |
1365 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1590 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1591 | # |
|
|
1592 | # in short: this is a mess. |
|
|
1593 | # |
|
|
1594 | # note that we do not try to keep the length constant between writes as we are required to do. |
|
|
1595 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
|
|
1596 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
|
|
1597 | # have identity issues in that area. |
1366 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1598 | # Net::SSLeay::CTX_set_mode ($ssl, |
1367 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1599 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1368 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1600 | # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
|
|
1601 | Net::SSLeay::CTX_set_mode ($ssl, 1|2); |
1369 | |
1602 | |
1370 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1603 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1371 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1604 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1372 | |
1605 | |
1373 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1606 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1374 | |
1607 | |
1375 | $self->{filter_w} = sub { |
1608 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
1376 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
1609 | if $self->{on_starttls}; |
1377 | &_dotls; |
1610 | |
1378 | }; |
1611 | &_dotls; # need to trigger the initial handshake |
1379 | $self->{filter_r} = sub { |
1612 | $self->start_read; # make sure we actually do read |
1380 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
|
|
1381 | &_dotls; |
|
|
1382 | }; |
|
|
1383 | } |
1613 | } |
1384 | |
1614 | |
1385 | =item $handle->stoptls |
1615 | =item $handle->stoptls |
1386 | |
1616 | |
1387 | Destroys the SSL connection, if any. Partial read or write data will be |
1617 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1388 | lost. |
1618 | sending a close notify to the other side, but since OpenSSL doesn't |
|
|
1619 | support non-blocking shut downs, it is not possible to re-use the stream |
|
|
1620 | afterwards. |
1389 | |
1621 | |
1390 | =cut |
1622 | =cut |
1391 | |
1623 | |
1392 | sub stoptls { |
1624 | sub stoptls { |
1393 | my ($self) = @_; |
1625 | my ($self) = @_; |
1394 | |
1626 | |
1395 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1627 | if ($self->{tls}) { |
|
|
1628 | Net::SSLeay::shutdown ($self->{tls}); |
1396 | |
1629 | |
1397 | delete $self->{_rbio}; |
1630 | &_dotls; |
1398 | delete $self->{_wbio}; |
1631 | |
1399 | delete $self->{_tls_wbuf}; |
1632 | # # we don't give a shit. no, we do, but we can't. no...#d# |
1400 | delete $self->{filter_r}; |
1633 | # # we, we... have to use openssl :/#d# |
1401 | delete $self->{filter_w}; |
1634 | # &_freetls;#d# |
|
|
1635 | } |
|
|
1636 | } |
|
|
1637 | |
|
|
1638 | sub _freetls { |
|
|
1639 | my ($self) = @_; |
|
|
1640 | |
|
|
1641 | return unless $self->{tls}; |
|
|
1642 | |
|
|
1643 | $self->{tls_ctx}->_put_session (delete $self->{tls}); |
|
|
1644 | |
|
|
1645 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
1402 | } |
1646 | } |
1403 | |
1647 | |
1404 | sub DESTROY { |
1648 | sub DESTROY { |
1405 | my $self = shift; |
1649 | my ($self) = @_; |
1406 | |
1650 | |
1407 | $self->stoptls; |
1651 | &_freetls; |
1408 | |
1652 | |
1409 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1653 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1410 | |
1654 | |
1411 | if ($linger && length $self->{wbuf}) { |
1655 | if ($linger && length $self->{wbuf} && $self->{fh}) { |
1412 | my $fh = delete $self->{fh}; |
1656 | my $fh = delete $self->{fh}; |
1413 | my $wbuf = delete $self->{wbuf}; |
1657 | my $wbuf = delete $self->{wbuf}; |
1414 | |
1658 | |
1415 | my @linger; |
1659 | my @linger; |
1416 | |
1660 | |
… | |
… | |
1427 | @linger = (); |
1671 | @linger = (); |
1428 | }); |
1672 | }); |
1429 | } |
1673 | } |
1430 | } |
1674 | } |
1431 | |
1675 | |
|
|
1676 | =item $handle->destroy |
|
|
1677 | |
|
|
1678 | Shuts down the handle object as much as possible - this call ensures that |
|
|
1679 | no further callbacks will be invoked and as many resources as possible |
|
|
1680 | will be freed. You must not call any methods on the object afterwards. |
|
|
1681 | |
|
|
1682 | Normally, you can just "forget" any references to an AnyEvent::Handle |
|
|
1683 | object and it will simply shut down. This works in fatal error and EOF |
|
|
1684 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
|
|
1685 | callback, so when you want to destroy the AnyEvent::Handle object from |
|
|
1686 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
|
|
1687 | that case. |
|
|
1688 | |
|
|
1689 | Destroying the handle object in this way has the advantage that callbacks |
|
|
1690 | will be removed as well, so if those are the only reference holders (as |
|
|
1691 | is common), then one doesn't need to do anything special to break any |
|
|
1692 | reference cycles. |
|
|
1693 | |
|
|
1694 | The handle might still linger in the background and write out remaining |
|
|
1695 | data, as specified by the C<linger> option, however. |
|
|
1696 | |
|
|
1697 | =cut |
|
|
1698 | |
|
|
1699 | sub destroy { |
|
|
1700 | my ($self) = @_; |
|
|
1701 | |
|
|
1702 | $self->DESTROY; |
|
|
1703 | %$self = (); |
|
|
1704 | } |
|
|
1705 | |
1432 | =item AnyEvent::Handle::TLS_CTX |
1706 | =item AnyEvent::Handle::TLS_CTX |
1433 | |
1707 | |
1434 | This function creates and returns the Net::SSLeay::CTX object used by |
1708 | This function creates and returns the AnyEvent::TLS object used by default |
1435 | default for TLS mode. |
1709 | for TLS mode. |
1436 | |
1710 | |
1437 | The context is created like this: |
1711 | The context is created by calling L<AnyEvent::TLS> without any arguments. |
1438 | |
|
|
1439 | Net::SSLeay::load_error_strings; |
|
|
1440 | Net::SSLeay::SSLeay_add_ssl_algorithms; |
|
|
1441 | Net::SSLeay::randomize; |
|
|
1442 | |
|
|
1443 | my $CTX = Net::SSLeay::CTX_new; |
|
|
1444 | |
|
|
1445 | Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL |
|
|
1446 | |
1712 | |
1447 | =cut |
1713 | =cut |
1448 | |
1714 | |
1449 | our $TLS_CTX; |
1715 | our $TLS_CTX; |
1450 | |
1716 | |
1451 | sub TLS_CTX() { |
1717 | sub TLS_CTX() { |
1452 | $TLS_CTX || do { |
1718 | $TLS_CTX ||= do { |
1453 | require Net::SSLeay; |
1719 | require AnyEvent::TLS; |
1454 | |
1720 | |
1455 | Net::SSLeay::load_error_strings (); |
1721 | new AnyEvent::TLS |
1456 | Net::SSLeay::SSLeay_add_ssl_algorithms (); |
|
|
1457 | Net::SSLeay::randomize (); |
|
|
1458 | |
|
|
1459 | $TLS_CTX = Net::SSLeay::CTX_new (); |
|
|
1460 | |
|
|
1461 | Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ()); |
|
|
1462 | |
|
|
1463 | $TLS_CTX |
|
|
1464 | } |
1722 | } |
1465 | } |
1723 | } |
1466 | |
1724 | |
1467 | =back |
1725 | =back |
|
|
1726 | |
|
|
1727 | |
|
|
1728 | =head1 NONFREQUENTLY ASKED QUESTIONS |
|
|
1729 | |
|
|
1730 | =over 4 |
|
|
1731 | |
|
|
1732 | =item I C<undef> the AnyEvent::Handle reference inside my callback and |
|
|
1733 | still get further invocations! |
|
|
1734 | |
|
|
1735 | That's because AnyEvent::Handle keeps a reference to itself when handling |
|
|
1736 | read or write callbacks. |
|
|
1737 | |
|
|
1738 | It is only safe to "forget" the reference inside EOF or error callbacks, |
|
|
1739 | from within all other callbacks, you need to explicitly call the C<< |
|
|
1740 | ->destroy >> method. |
|
|
1741 | |
|
|
1742 | =item I get different callback invocations in TLS mode/Why can't I pause |
|
|
1743 | reading? |
|
|
1744 | |
|
|
1745 | Unlike, say, TCP, TLS connections do not consist of two independent |
|
|
1746 | communication channels, one for each direction. Or put differently. The |
|
|
1747 | read and write directions are not independent of each other: you cannot |
|
|
1748 | write data unless you are also prepared to read, and vice versa. |
|
|
1749 | |
|
|
1750 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
|
|
1751 | callback invocations when you are not expecting any read data - the reason |
|
|
1752 | is that AnyEvent::Handle always reads in TLS mode. |
|
|
1753 | |
|
|
1754 | During the connection, you have to make sure that you always have a |
|
|
1755 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
|
|
1756 | connection (or when you no longer want to use it) you can call the |
|
|
1757 | C<destroy> method. |
|
|
1758 | |
|
|
1759 | =item How do I read data until the other side closes the connection? |
|
|
1760 | |
|
|
1761 | If you just want to read your data into a perl scalar, the easiest way |
|
|
1762 | to achieve this is by setting an C<on_read> callback that does nothing, |
|
|
1763 | clearing the C<on_eof> callback and in the C<on_error> callback, the data |
|
|
1764 | will be in C<$_[0]{rbuf}>: |
|
|
1765 | |
|
|
1766 | $handle->on_read (sub { }); |
|
|
1767 | $handle->on_eof (undef); |
|
|
1768 | $handle->on_error (sub { |
|
|
1769 | my $data = delete $_[0]{rbuf}; |
|
|
1770 | }); |
|
|
1771 | |
|
|
1772 | The reason to use C<on_error> is that TCP connections, due to latencies |
|
|
1773 | and packets loss, might get closed quite violently with an error, when in |
|
|
1774 | fact, all data has been received. |
|
|
1775 | |
|
|
1776 | It is usually better to use acknowledgements when transferring data, |
|
|
1777 | to make sure the other side hasn't just died and you got the data |
|
|
1778 | intact. This is also one reason why so many internet protocols have an |
|
|
1779 | explicit QUIT command. |
|
|
1780 | |
|
|
1781 | =item I don't want to destroy the handle too early - how do I wait until |
|
|
1782 | all data has been written? |
|
|
1783 | |
|
|
1784 | After writing your last bits of data, set the C<on_drain> callback |
|
|
1785 | and destroy the handle in there - with the default setting of |
|
|
1786 | C<low_water_mark> this will be called precisely when all data has been |
|
|
1787 | written to the socket: |
|
|
1788 | |
|
|
1789 | $handle->push_write (...); |
|
|
1790 | $handle->on_drain (sub { |
|
|
1791 | warn "all data submitted to the kernel\n"; |
|
|
1792 | undef $handle; |
|
|
1793 | }); |
|
|
1794 | |
|
|
1795 | If you just want to queue some data and then signal EOF to the other side, |
|
|
1796 | consider using C<< ->push_shutdown >> instead. |
|
|
1797 | |
|
|
1798 | =item I want to contact a TLS/SSL server, I don't care about security. |
|
|
1799 | |
|
|
1800 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
|
|
1801 | simply connect to it and then create the AnyEvent::Handle with the C<tls> |
|
|
1802 | parameter: |
|
|
1803 | |
|
|
1804 | tcp_connect $host, $port, sub { |
|
|
1805 | my ($fh) = @_; |
|
|
1806 | |
|
|
1807 | my $handle = new AnyEvent::Handle |
|
|
1808 | fh => $fh, |
|
|
1809 | tls => "connect", |
|
|
1810 | on_error => sub { ... }; |
|
|
1811 | |
|
|
1812 | $handle->push_write (...); |
|
|
1813 | }; |
|
|
1814 | |
|
|
1815 | =item I want to contact a TLS/SSL server, I do care about security. |
|
|
1816 | |
|
|
1817 | Then you should additionally enable certificate verification, including |
|
|
1818 | peername verification, if the protocol you use supports it (see |
|
|
1819 | L<AnyEvent::TLS>, C<verify_peername>). |
|
|
1820 | |
|
|
1821 | E.g. for HTTPS: |
|
|
1822 | |
|
|
1823 | tcp_connect $host, $port, sub { |
|
|
1824 | my ($fh) = @_; |
|
|
1825 | |
|
|
1826 | my $handle = new AnyEvent::Handle |
|
|
1827 | fh => $fh, |
|
|
1828 | peername => $host, |
|
|
1829 | tls => "connect", |
|
|
1830 | tls_ctx => { verify => 1, verify_peername => "https" }, |
|
|
1831 | ... |
|
|
1832 | |
|
|
1833 | Note that you must specify the hostname you connected to (or whatever |
|
|
1834 | "peername" the protocol needs) as the C<peername> argument, otherwise no |
|
|
1835 | peername verification will be done. |
|
|
1836 | |
|
|
1837 | The above will use the system-dependent default set of trusted CA |
|
|
1838 | certificates. If you want to check against a specific CA, add the |
|
|
1839 | C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>: |
|
|
1840 | |
|
|
1841 | tls_ctx => { |
|
|
1842 | verify => 1, |
|
|
1843 | verify_peername => "https", |
|
|
1844 | ca_file => "my-ca-cert.pem", |
|
|
1845 | }, |
|
|
1846 | |
|
|
1847 | =item I want to create a TLS/SSL server, how do I do that? |
|
|
1848 | |
|
|
1849 | Well, you first need to get a server certificate and key. You have |
|
|
1850 | three options: a) ask a CA (buy one, use cacert.org etc.) b) create a |
|
|
1851 | self-signed certificate (cheap. check the search engine of your choice, |
|
|
1852 | there are many tutorials on the net) or c) make your own CA (tinyca2 is a |
|
|
1853 | nice program for that purpose). |
|
|
1854 | |
|
|
1855 | Then create a file with your private key (in PEM format, see |
|
|
1856 | L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The |
|
|
1857 | file should then look like this: |
|
|
1858 | |
|
|
1859 | -----BEGIN RSA PRIVATE KEY----- |
|
|
1860 | ...header data |
|
|
1861 | ... lots of base64'y-stuff |
|
|
1862 | -----END RSA PRIVATE KEY----- |
|
|
1863 | |
|
|
1864 | -----BEGIN CERTIFICATE----- |
|
|
1865 | ... lots of base64'y-stuff |
|
|
1866 | -----END CERTIFICATE----- |
|
|
1867 | |
|
|
1868 | The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then |
|
|
1869 | specify this file as C<cert_file>: |
|
|
1870 | |
|
|
1871 | tcp_server undef, $port, sub { |
|
|
1872 | my ($fh) = @_; |
|
|
1873 | |
|
|
1874 | my $handle = new AnyEvent::Handle |
|
|
1875 | fh => $fh, |
|
|
1876 | tls => "accept", |
|
|
1877 | tls_ctx => { cert_file => "my-server-keycert.pem" }, |
|
|
1878 | ... |
|
|
1879 | |
|
|
1880 | When you have intermediate CA certificates that your clients might not |
|
|
1881 | know about, just append them to the C<cert_file>. |
|
|
1882 | |
|
|
1883 | =back |
|
|
1884 | |
1468 | |
1885 | |
1469 | =head1 SUBCLASSING AnyEvent::Handle |
1886 | =head1 SUBCLASSING AnyEvent::Handle |
1470 | |
1887 | |
1471 | In many cases, you might want to subclass AnyEvent::Handle. |
1888 | In many cases, you might want to subclass AnyEvent::Handle. |
1472 | |
1889 | |