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