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