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