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