1 | package AnyEvent::Handle; |
|
|
2 | |
|
|
3 | use Scalar::Util (); |
|
|
4 | use Carp (); |
|
|
5 | use Errno qw(EAGAIN EINTR); |
|
|
6 | |
|
|
7 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
|
|
8 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
|
|
9 | |
|
|
10 | =head1 NAME |
1 | =head1 NAME |
11 | |
2 | |
12 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
3 | AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent |
13 | |
|
|
14 | =cut |
|
|
15 | |
|
|
16 | our $VERSION = 4.86; |
|
|
17 | |
4 | |
18 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
19 | |
6 | |
20 | use AnyEvent; |
7 | use AnyEvent; |
21 | use AnyEvent::Handle; |
8 | use AnyEvent::Handle; |
… | |
… | |
24 | |
11 | |
25 | my $hdl; $hdl = new AnyEvent::Handle |
12 | my $hdl; $hdl = new AnyEvent::Handle |
26 | fh => \*STDIN, |
13 | fh => \*STDIN, |
27 | on_error => sub { |
14 | on_error => sub { |
28 | my ($hdl, $fatal, $msg) = @_; |
15 | my ($hdl, $fatal, $msg) = @_; |
29 | warn "got error $msg\n"; |
16 | AE::log warn => "got error $msg\n"; |
30 | $hdl->destroy; |
17 | $hdl->destroy; |
31 | $cv->send; |
18 | $cv->send; |
32 | ); |
19 | }; |
33 | |
20 | |
34 | # send some request line |
21 | # send some request line |
35 | $hdl->push_write ("getinfo\015\012"); |
22 | $hdl->push_write ("getinfo\015\012"); |
36 | |
23 | |
37 | # read the response line |
24 | # read the response line |
38 | $hdl->push_read (line => sub { |
25 | $hdl->push_read (line => sub { |
39 | my ($hdl, $line) = @_; |
26 | my ($hdl, $line) = @_; |
40 | warn "got line <$line>\n"; |
27 | AE::log warn => "got line <$line>\n"; |
41 | $cv->send; |
28 | $cv->send; |
42 | }); |
29 | }); |
43 | |
30 | |
44 | $cv->recv; |
31 | $cv->recv; |
45 | |
32 | |
46 | =head1 DESCRIPTION |
33 | =head1 DESCRIPTION |
47 | |
34 | |
48 | 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 |
49 | filehandles. |
36 | stream-based filehandles (sockets, pipes, and other stream things). |
50 | |
37 | |
51 | The L<AnyEvent::Intro> tutorial contains some well-documented |
38 | The L<AnyEvent::Intro> tutorial contains some well-documented |
52 | AnyEvent::Handle examples. |
39 | AnyEvent::Handle examples. |
53 | |
40 | |
54 | In the following, when the documentation refers to of "bytes" then this |
41 | In the following, where the documentation refers to "bytes", it means |
55 | means characters. As sysread and syswrite are used for all I/O, their |
42 | characters. As sysread and syswrite are used for all I/O, their |
56 | treatment of characters applies to this module as well. |
43 | treatment of characters applies to this module as well. |
57 | |
44 | |
58 | At the very minimum, you should specify C<fh> or C<connect>, and the |
45 | At the very minimum, you should specify C<fh> or C<connect>, and the |
59 | C<on_error> callback. |
46 | C<on_error> callback. |
60 | |
47 | |
61 | All callbacks will be invoked with the handle object as their first |
48 | All callbacks will be invoked with the handle object as their first |
62 | argument. |
49 | argument. |
63 | |
50 | |
|
|
51 | =cut |
|
|
52 | |
|
|
53 | package AnyEvent::Handle; |
|
|
54 | |
|
|
55 | use Scalar::Util (); |
|
|
56 | use List::Util (); |
|
|
57 | use Carp (); |
|
|
58 | use Errno qw(EAGAIN EINTR); |
|
|
59 | |
|
|
60 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
|
|
61 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
|
|
62 | |
|
|
63 | our $VERSION = $AnyEvent::VERSION; |
|
|
64 | |
|
|
65 | sub _load_func($) { |
|
|
66 | my $func = $_[0]; |
|
|
67 | |
|
|
68 | unless (defined &$func) { |
|
|
69 | my $pkg = $func; |
|
|
70 | do { |
|
|
71 | $pkg =~ s/::[^:]+$// |
|
|
72 | or return; |
|
|
73 | eval "require $pkg"; |
|
|
74 | } until defined &$func; |
|
|
75 | } |
|
|
76 | |
|
|
77 | \&$func |
|
|
78 | } |
|
|
79 | |
|
|
80 | sub MAX_READ_SIZE() { 131072 } |
|
|
81 | |
64 | =head1 METHODS |
82 | =head1 METHODS |
65 | |
83 | |
66 | =over 4 |
84 | =over 4 |
67 | |
85 | |
68 | =item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... |
86 | =item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value... |
69 | |
87 | |
70 | The constructor supports these arguments (all as C<< key => value >> pairs). |
88 | The constructor supports these arguments (all as C<< key => value >> pairs). |
71 | |
89 | |
72 | =over 4 |
90 | =over 4 |
73 | |
91 | |
… | |
… | |
96 | =over 4 |
114 | =over 4 |
97 | |
115 | |
98 | =item on_prepare => $cb->($handle) |
116 | =item on_prepare => $cb->($handle) |
99 | |
117 | |
100 | This (rarely used) callback is called before a new connection is |
118 | This (rarely used) callback is called before a new connection is |
101 | attempted, but after the file handle has been created. It could be used to |
119 | attempted, but after the file handle has been created (you can access that |
|
|
120 | file handle via C<< $handle->{fh} >>). It could be used to prepare the |
102 | prepare the file handle with parameters required for the actual connect |
121 | file handle with parameters required for the actual connect (as opposed to |
103 | (as opposed to settings that can be changed when the connection is already |
122 | settings that can be changed when the connection is already established). |
104 | established). |
123 | |
|
|
124 | The return value of this callback should be the connect timeout value in |
|
|
125 | seconds (or C<0>, or C<undef>, or the empty list, to indicate that the |
|
|
126 | default timeout is to be used). |
105 | |
127 | |
106 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
128 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
107 | |
129 | |
108 | This callback is called when a connection has been successfully established. |
130 | This callback is called when a connection has been successfully established. |
109 | |
131 | |
110 | The actual numeric host and port (the socket peername) are passed as |
132 | The peer's numeric host and port (the socket peername) are passed as |
111 | parameters, together with a retry callback. |
133 | parameters, together with a retry callback. |
112 | |
134 | |
113 | When, for some reason, the handle is not acceptable, then calling |
135 | If, for some reason, the handle is not acceptable, calling C<$retry> |
114 | C<$retry> will continue with the next conenction target (in case of |
136 | will continue with the next connection target (in case of multi-homed |
115 | multi-homed hosts or SRV records there can be multiple connection |
137 | hosts or SRV records there can be multiple connection endpoints). At the |
116 | endpoints). When it is called then the read and write queues, eof status, |
138 | time it is called the read and write queues, eof status, tls status and |
117 | tls status and similar properties of the handle are being reset. |
139 | similar properties of the handle will have been reset. |
118 | |
140 | |
119 | In most cases, ignoring the C<$retry> parameter is the way to go. |
141 | In most cases, you should ignore the C<$retry> parameter. |
120 | |
142 | |
121 | =item on_connect_error => $cb->($handle, $message) |
143 | =item on_connect_error => $cb->($handle, $message) |
122 | |
144 | |
123 | This callback is called when the conenction could not be |
145 | This callback is called when the connection could not be |
124 | established. C<$!> will contain the relevant error code, and C<$message> a |
146 | established. C<$!> will contain the relevant error code, and C<$message> a |
125 | message describing it (usually the same as C<"$!">). |
147 | message describing it (usually the same as C<"$!">). |
126 | |
148 | |
127 | If this callback isn't specified, then C<on_error> will be called with a |
149 | If this callback isn't specified, then C<on_error> will be called with a |
128 | fatal error instead. |
150 | fatal error instead. |
… | |
… | |
131 | |
153 | |
132 | =item on_error => $cb->($handle, $fatal, $message) |
154 | =item on_error => $cb->($handle, $fatal, $message) |
133 | |
155 | |
134 | This is the error callback, which is called when, well, some error |
156 | This is the error callback, which is called when, well, some error |
135 | occured, such as not being able to resolve the hostname, failure to |
157 | occured, such as not being able to resolve the hostname, failure to |
136 | connect or a read error. |
158 | connect, or a read error. |
137 | |
159 | |
138 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
160 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
139 | fatal errors the handle object will be destroyed (by a call to C<< -> |
161 | fatal errors the handle object will be destroyed (by a call to C<< -> |
140 | destroy >>) after invoking the error callback (which means you are free to |
162 | destroy >>) after invoking the error callback (which means you are free to |
141 | examine the handle object). Examples of fatal errors are an EOF condition |
163 | examine the handle object). Examples of fatal errors are an EOF condition |
142 | with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In |
164 | with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In |
143 | cases where the other side can close the connection at their will it is |
165 | cases where the other side can close the connection at will, it is |
144 | often easiest to not report C<EPIPE> errors in this callback. |
166 | often easiest to not report C<EPIPE> errors in this callback. |
145 | |
167 | |
146 | AnyEvent::Handle tries to find an appropriate error code for you to check |
168 | AnyEvent::Handle tries to find an appropriate error code for you to check |
147 | against, but in some cases (TLS errors), this does not work well. It is |
169 | against, but in some cases (TLS errors), this does not work well. It is |
148 | recommended to always output the C<$message> argument in human-readable |
170 | recommended to always output the C<$message> argument in human-readable |
149 | error messages (it's usually the same as C<"$!">). |
171 | error messages (it's usually the same as C<"$!">). |
150 | |
172 | |
151 | Non-fatal errors can be retried by simply returning, but it is recommended |
173 | Non-fatal errors can be retried by returning, but it is recommended |
152 | to simply ignore this parameter and instead abondon the handle object |
174 | to simply ignore this parameter and instead abondon the handle object |
153 | when this callback is invoked. Examples of non-fatal errors are timeouts |
175 | when this callback is invoked. Examples of non-fatal errors are timeouts |
154 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
176 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
155 | |
177 | |
156 | On callback entrance, the value of C<$!> contains the operating system |
178 | On entry to the callback, the value of C<$!> contains the operating |
157 | error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
179 | system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
158 | C<EPROTO>). |
180 | C<EPROTO>). |
159 | |
181 | |
160 | While not mandatory, it is I<highly> recommended to set this callback, as |
182 | While not mandatory, it is I<highly> recommended to set this callback, as |
161 | you will not be notified of errors otherwise. The default simply calls |
183 | you will not be notified of errors otherwise. The default just calls |
162 | C<croak>. |
184 | C<croak>. |
163 | |
185 | |
164 | =item on_read => $cb->($handle) |
186 | =item on_read => $cb->($handle) |
165 | |
187 | |
166 | This sets the default read callback, which is called when data arrives |
188 | This sets the default read callback, which is called when data arrives |
… | |
… | |
171 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
193 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
172 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
194 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
173 | must not enlarge or modify the read buffer, you can only remove data at |
195 | must not enlarge or modify the read buffer, you can only remove data at |
174 | the beginning from it. |
196 | the beginning from it. |
175 | |
197 | |
|
|
198 | You can also call C<< ->push_read (...) >> or any other function that |
|
|
199 | modifies the read queue. Or do both. Or ... |
|
|
200 | |
176 | When an EOF condition is detected then AnyEvent::Handle will first try to |
201 | When an EOF condition is detected, AnyEvent::Handle will first try to |
177 | feed all the remaining data to the queued callbacks and C<on_read> before |
202 | feed all the remaining data to the queued callbacks and C<on_read> before |
178 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
203 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
179 | error will be raised (with C<$!> set to C<EPIPE>). |
204 | error will be raised (with C<$!> set to C<EPIPE>). |
180 | |
205 | |
181 | Note that, unlike requests in the read queue, an C<on_read> callback |
206 | Note that, unlike requests in the read queue, an C<on_read> callback |
… | |
… | |
200 | set, then a fatal error will be raised with C<$!> set to <0>. |
225 | set, then a fatal error will be raised with C<$!> set to <0>. |
201 | |
226 | |
202 | =item on_drain => $cb->($handle) |
227 | =item on_drain => $cb->($handle) |
203 | |
228 | |
204 | This sets the callback that is called when the write buffer becomes empty |
229 | This sets the callback that is called when the write buffer becomes empty |
205 | (or when the callback is set and the buffer is empty already). |
230 | (or immediately if the buffer is empty already). |
206 | |
231 | |
207 | To append to the write buffer, use the C<< ->push_write >> method. |
232 | To append to the write buffer, use the C<< ->push_write >> method. |
208 | |
233 | |
209 | This callback is useful when you don't want to put all of your write data |
234 | This callback is useful when you don't want to put all of your write data |
210 | into the queue at once, for example, when you want to write the contents |
235 | into the queue at once, for example, when you want to write the contents |
… | |
… | |
212 | memory and push it into the queue, but instead only read more data from |
237 | memory and push it into the queue, but instead only read more data from |
213 | the file when the write queue becomes empty. |
238 | the file when the write queue becomes empty. |
214 | |
239 | |
215 | =item timeout => $fractional_seconds |
240 | =item timeout => $fractional_seconds |
216 | |
241 | |
|
|
242 | =item rtimeout => $fractional_seconds |
|
|
243 | |
|
|
244 | =item wtimeout => $fractional_seconds |
|
|
245 | |
217 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
246 | If non-zero, then these enables an "inactivity" timeout: whenever this |
218 | seconds pass without a successful read or write on the underlying file |
247 | many seconds pass without a successful read or write on the underlying |
219 | handle, the C<on_timeout> callback will be invoked (and if that one is |
248 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
220 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
249 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
|
|
250 | error will be raised). |
221 | |
251 | |
|
|
252 | There are three variants of the timeouts that work independently of each |
|
|
253 | other, for both read and write (triggered when nothing was read I<OR> |
|
|
254 | written), just read (triggered when nothing was read), and just write: |
|
|
255 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
|
|
256 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
|
|
257 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
|
|
258 | |
222 | Note that timeout processing is also active when you currently do not have |
259 | Note that timeout processing is active even when you do not have any |
223 | any outstanding read or write requests: If you plan to keep the connection |
260 | outstanding read or write requests: If you plan to keep the connection |
224 | idle then you should disable the timout temporarily or ignore the timeout |
261 | idle then you should disable the timeout temporarily or ignore the |
225 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
262 | timeout in the corresponding C<on_timeout> callback, in which case |
226 | restart the timeout. |
263 | AnyEvent::Handle will simply restart the timeout. |
227 | |
264 | |
228 | Zero (the default) disables this timeout. |
265 | Zero (the default) disables the corresponding timeout. |
229 | |
266 | |
230 | =item on_timeout => $cb->($handle) |
267 | =item on_timeout => $cb->($handle) |
|
|
268 | |
|
|
269 | =item on_rtimeout => $cb->($handle) |
|
|
270 | |
|
|
271 | =item on_wtimeout => $cb->($handle) |
231 | |
272 | |
232 | Called whenever the inactivity timeout passes. If you return from this |
273 | Called whenever the inactivity timeout passes. If you return from this |
233 | callback, then the timeout will be reset as if some activity had happened, |
274 | callback, then the timeout will be reset as if some activity had happened, |
234 | so this condition is not fatal in any way. |
275 | so this condition is not fatal in any way. |
235 | |
276 | |
… | |
… | |
243 | be configured to accept only so-and-so much data that it cannot act on |
284 | be configured to accept only so-and-so much data that it cannot act on |
244 | (for example, when expecting a line, an attacker could send an unlimited |
285 | (for example, when expecting a line, an attacker could send an unlimited |
245 | amount of data without a callback ever being called as long as the line |
286 | amount of data without a callback ever being called as long as the line |
246 | isn't finished). |
287 | isn't finished). |
247 | |
288 | |
|
|
289 | =item wbuf_max => <bytes> |
|
|
290 | |
|
|
291 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
|
|
292 | when the write buffer ever (strictly) exceeds this size. This is useful to |
|
|
293 | avoid some forms of denial-of-service attacks. |
|
|
294 | |
|
|
295 | Although the units of this parameter is bytes, this is the I<raw> number |
|
|
296 | of bytes not yet accepted by the kernel. This can make a difference when |
|
|
297 | you e.g. use TLS, as TLS typically makes your write data larger (but it |
|
|
298 | can also make it smaller due to compression). |
|
|
299 | |
|
|
300 | As an example of when this limit is useful, take a chat server that sends |
|
|
301 | chat messages to a client. If the client does not read those in a timely |
|
|
302 | manner then the send buffer in the server would grow unbounded. |
|
|
303 | |
248 | =item autocork => <boolean> |
304 | =item autocork => <boolean> |
249 | |
305 | |
250 | When disabled (the default), then C<push_write> will try to immediately |
306 | When disabled (the default), C<push_write> will try to immediately |
251 | write the data to the handle, if possible. This avoids having to register |
307 | write the data to the handle if possible. This avoids having to register |
252 | a write watcher and wait for the next event loop iteration, but can |
308 | a write watcher and wait for the next event loop iteration, but can |
253 | be inefficient if you write multiple small chunks (on the wire, this |
309 | be inefficient if you write multiple small chunks (on the wire, this |
254 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
310 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
255 | C<no_delay>, but this option can save costly syscalls). |
311 | C<no_delay>, but this option can save costly syscalls). |
256 | |
312 | |
257 | When enabled, then writes will always be queued till the next event loop |
313 | When enabled, writes will always be queued till the next event loop |
258 | iteration. This is efficient when you do many small writes per iteration, |
314 | iteration. This is efficient when you do many small writes per iteration, |
259 | but less efficient when you do a single write only per iteration (or when |
315 | but less efficient when you do a single write only per iteration (or when |
260 | the write buffer often is full). It also increases write latency. |
316 | the write buffer often is full). It also increases write latency. |
261 | |
317 | |
262 | =item no_delay => <boolean> |
318 | =item no_delay => <boolean> |
… | |
… | |
266 | the Nagle algorithm, and usually it is beneficial. |
322 | the Nagle algorithm, and usually it is beneficial. |
267 | |
323 | |
268 | In some situations you want as low a delay as possible, which can be |
324 | In some situations you want as low a delay as possible, which can be |
269 | accomplishd by setting this option to a true value. |
325 | accomplishd by setting this option to a true value. |
270 | |
326 | |
271 | The default is your opertaing system's default behaviour (most likely |
327 | The default is your operating system's default behaviour (most likely |
272 | enabled), this option explicitly enables or disables it, if possible. |
328 | enabled). This option explicitly enables or disables it, if possible. |
|
|
329 | |
|
|
330 | =item keepalive => <boolean> |
|
|
331 | |
|
|
332 | Enables (default disable) the SO_KEEPALIVE option on the stream socket: |
|
|
333 | normally, TCP connections have no time-out once established, so TCP |
|
|
334 | connections, once established, can stay alive forever even when the other |
|
|
335 | side has long gone. TCP keepalives are a cheap way to take down long-lived |
|
|
336 | TCP connections when the other side becomes unreachable. While the default |
|
|
337 | is OS-dependent, TCP keepalives usually kick in after around two hours, |
|
|
338 | and, if the other side doesn't reply, take down the TCP connection some 10 |
|
|
339 | to 15 minutes later. |
|
|
340 | |
|
|
341 | It is harmless to specify this option for file handles that do not support |
|
|
342 | keepalives, and enabling it on connections that are potentially long-lived |
|
|
343 | is usually a good idea. |
|
|
344 | |
|
|
345 | =item oobinline => <boolean> |
|
|
346 | |
|
|
347 | BSD majorly fucked up the implementation of TCP urgent data. The result |
|
|
348 | is that almost no OS implements TCP according to the specs, and every OS |
|
|
349 | implements it slightly differently. |
|
|
350 | |
|
|
351 | If you want to handle TCP urgent data, then setting this flag (the default |
|
|
352 | is enabled) gives you the most portable way of getting urgent data, by |
|
|
353 | putting it into the stream. |
|
|
354 | |
|
|
355 | Since BSD emulation of OOB data on top of TCP's urgent data can have |
|
|
356 | security implications, AnyEvent::Handle sets this flag automatically |
|
|
357 | unless explicitly specified. Note that setting this flag after |
|
|
358 | establishing a connection I<may> be a bit too late (data loss could |
|
|
359 | already have occured on BSD systems), but at least it will protect you |
|
|
360 | from most attacks. |
273 | |
361 | |
274 | =item read_size => <bytes> |
362 | =item read_size => <bytes> |
275 | |
363 | |
276 | The default read block size (the amount of bytes this module will |
364 | The initial read block size, the number of bytes this module will try |
277 | try to read during each loop iteration, which affects memory |
365 | to read during each loop iteration. Each handle object will consume |
278 | requirements). Default: C<8192>. |
366 | at least this amount of memory for the read buffer as well, so when |
|
|
367 | handling many connections watch out for memory requirements). See also |
|
|
368 | C<max_read_size>. Default: C<2048>. |
|
|
369 | |
|
|
370 | =item max_read_size => <bytes> |
|
|
371 | |
|
|
372 | The maximum read buffer size used by the dynamic adjustment |
|
|
373 | algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in |
|
|
374 | one go it will double C<read_size> up to the maximum given by this |
|
|
375 | option. Default: C<131072> or C<read_size>, whichever is higher. |
279 | |
376 | |
280 | =item low_water_mark => <bytes> |
377 | =item low_water_mark => <bytes> |
281 | |
378 | |
282 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
379 | Sets the number of bytes (default: C<0>) that make up an "empty" write |
283 | buffer: If the write reaches this size or gets even samller it is |
380 | buffer: If the buffer reaches this size or gets even samller it is |
284 | considered empty. |
381 | considered empty. |
285 | |
382 | |
286 | Sometimes it can be beneficial (for performance reasons) to add data to |
383 | Sometimes it can be beneficial (for performance reasons) to add data to |
287 | the write buffer before it is fully drained, but this is a rare case, as |
384 | the write buffer before it is fully drained, but this is a rare case, as |
288 | the operating system kernel usually buffers data as well, so the default |
385 | the operating system kernel usually buffers data as well, so the default |
289 | is good in almost all cases. |
386 | is good in almost all cases. |
290 | |
387 | |
291 | =item linger => <seconds> |
388 | =item linger => <seconds> |
292 | |
389 | |
293 | If non-zero (default: C<3600>), then the destructor of the |
390 | If this is non-zero (default: C<3600>), the destructor of the |
294 | AnyEvent::Handle object will check whether there is still outstanding |
391 | AnyEvent::Handle object will check whether there is still outstanding |
295 | write data and will install a watcher that will write this data to the |
392 | write data and will install a watcher that will write this data to the |
296 | socket. No errors will be reported (this mostly matches how the operating |
393 | socket. No errors will be reported (this mostly matches how the operating |
297 | system treats outstanding data at socket close time). |
394 | system treats outstanding data at socket close time). |
298 | |
395 | |
… | |
… | |
305 | A string used to identify the remote site - usually the DNS hostname |
402 | A string used to identify the remote site - usually the DNS hostname |
306 | (I<not> IDN!) used to create the connection, rarely the IP address. |
403 | (I<not> IDN!) used to create the connection, rarely the IP address. |
307 | |
404 | |
308 | Apart from being useful in error messages, this string is also used in TLS |
405 | Apart from being useful in error messages, this string is also used in TLS |
309 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
406 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
310 | verification will be skipped when C<peername> is not specified or |
407 | verification will be skipped when C<peername> is not specified or is |
311 | C<undef>. |
408 | C<undef>. |
312 | |
409 | |
313 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
410 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
314 | |
411 | |
315 | When this parameter is given, it enables TLS (SSL) mode, that means |
412 | When this parameter is given, it enables TLS (SSL) mode, that means |
316 | AnyEvent will start a TLS handshake as soon as the conenction has been |
413 | AnyEvent will start a TLS handshake as soon as the connection has been |
317 | established and will transparently encrypt/decrypt data afterwards. |
414 | established and will transparently encrypt/decrypt data afterwards. |
318 | |
415 | |
319 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
416 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
320 | appropriate error message. |
417 | appropriate error message. |
321 | |
418 | |
… | |
… | |
341 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
438 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
342 | passing in the wrong integer will lead to certain crash. This most often |
439 | passing in the wrong integer will lead to certain crash. This most often |
343 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
440 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
344 | segmentation fault. |
441 | segmentation fault. |
345 | |
442 | |
346 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
443 | Use the C<< ->starttls >> method if you need to start TLS negotiation later. |
347 | |
444 | |
348 | =item tls_ctx => $anyevent_tls |
445 | =item tls_ctx => $anyevent_tls |
349 | |
446 | |
350 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
447 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
351 | (unless a connection object was specified directly). If this parameter is |
448 | (unless a connection object was specified directly). If this |
352 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
449 | parameter is missing (or C<undef>), then AnyEvent::Handle will use |
|
|
450 | C<AnyEvent::Handle::TLS_CTX>. |
353 | |
451 | |
354 | Instead of an object, you can also specify a hash reference with C<< key |
452 | Instead of an object, you can also specify a hash reference with C<< key |
355 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
453 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
356 | new TLS context object. |
454 | new TLS context object. |
357 | |
455 | |
… | |
… | |
366 | |
464 | |
367 | TLS handshake failures will not cause C<on_error> to be invoked when this |
465 | TLS handshake failures will not cause C<on_error> to be invoked when this |
368 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
466 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
369 | |
467 | |
370 | Without this callback, handshake failures lead to C<on_error> being |
468 | Without this callback, handshake failures lead to C<on_error> being |
371 | called, as normal. |
469 | called as usual. |
372 | |
470 | |
373 | Note that you cannot call C<starttls> right again in this callback. If you |
471 | Note that you cannot just call C<starttls> again in this callback. If you |
374 | need to do that, start an zero-second timer instead whose callback can |
472 | need to do that, start an zero-second timer instead whose callback can |
375 | then call C<< ->starttls >> again. |
473 | then call C<< ->starttls >> again. |
376 | |
474 | |
377 | =item on_stoptls => $cb->($handle) |
475 | =item on_stoptls => $cb->($handle) |
378 | |
476 | |
… | |
… | |
426 | $self->{connect}[0], |
524 | $self->{connect}[0], |
427 | $self->{connect}[1], |
525 | $self->{connect}[1], |
428 | sub { |
526 | sub { |
429 | my ($fh, $host, $port, $retry) = @_; |
527 | my ($fh, $host, $port, $retry) = @_; |
430 | |
528 | |
|
|
529 | delete $self->{_connect}; # no longer needed |
|
|
530 | |
431 | if ($fh) { |
531 | if ($fh) { |
432 | $self->{fh} = $fh; |
532 | $self->{fh} = $fh; |
433 | |
533 | |
434 | delete $self->{_skip_drain_rbuf}; |
534 | delete $self->{_skip_drain_rbuf}; |
435 | $self->_start; |
535 | $self->_start; |
436 | |
536 | |
437 | $self->{on_connect} |
537 | $self->{on_connect} |
438 | and $self->{on_connect}($self, $host, $port, sub { |
538 | and $self->{on_connect}($self, $host, $port, sub { |
439 | delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)}; |
539 | delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)}; |
440 | $self->{_skip_drain_rbuf} = 1; |
540 | $self->{_skip_drain_rbuf} = 1; |
441 | &$retry; |
541 | &$retry; |
442 | }); |
542 | }); |
443 | |
543 | |
444 | } else { |
544 | } else { |
445 | if ($self->{on_connect_error}) { |
545 | if ($self->{on_connect_error}) { |
446 | $self->{on_connect_error}($self, "$!"); |
546 | $self->{on_connect_error}($self, "$!"); |
447 | $self->destroy; |
547 | $self->destroy if $self; |
448 | } else { |
548 | } else { |
449 | $self->fatal ($!, 1); |
549 | $self->_error ($!, 1); |
450 | } |
550 | } |
451 | } |
551 | } |
452 | }, |
552 | }, |
453 | sub { |
553 | sub { |
454 | local $self->{fh} = $_[0]; |
554 | local $self->{fh} = $_[0]; |
455 | |
555 | |
|
|
556 | $self->{on_prepare} |
456 | $self->{on_prepare}->($self) |
557 | ? $self->{on_prepare}->($self) |
457 | if $self->{on_prepare}; |
558 | : () |
458 | } |
559 | } |
459 | ); |
560 | ); |
460 | } |
561 | } |
461 | |
562 | |
462 | } else { |
563 | } else { |
… | |
… | |
467 | } |
568 | } |
468 | |
569 | |
469 | sub _start { |
570 | sub _start { |
470 | my ($self) = @_; |
571 | my ($self) = @_; |
471 | |
572 | |
|
|
573 | # too many clueless people try to use udp and similar sockets |
|
|
574 | # with AnyEvent::Handle, do them a favour. |
|
|
575 | my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE (); |
|
|
576 | Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!" |
|
|
577 | if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type; |
|
|
578 | |
472 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
579 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
473 | |
580 | |
|
|
581 | $self->{_activity} = |
|
|
582 | $self->{_ractivity} = |
474 | $self->{_activity} = AnyEvent->now; |
583 | $self->{_wactivity} = AE::now; |
475 | $self->_timeout; |
|
|
476 | |
584 | |
|
|
585 | $self->{read_size} ||= 2048; |
|
|
586 | $self->{max_read_size} = $self->{read_size} |
|
|
587 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
|
|
588 | |
|
|
589 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
|
|
590 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
|
|
591 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
|
|
592 | |
477 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
593 | $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; |
|
|
594 | $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive}; |
478 | |
595 | |
|
|
596 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
|
|
597 | |
479 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
598 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
480 | if $self->{tls}; |
599 | if $self->{tls}; |
481 | |
600 | |
482 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
601 | $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain}; |
483 | |
602 | |
484 | $self->start_read |
603 | $self->start_read |
485 | if $self->{on_read} || @{ $self->{_queue} }; |
604 | if $self->{on_read} || @{ $self->{_queue} }; |
486 | |
605 | |
487 | $self->_drain_wbuf; |
606 | $self->_drain_wbuf; |
488 | } |
607 | } |
489 | |
|
|
490 | #sub _shutdown { |
|
|
491 | # my ($self) = @_; |
|
|
492 | # |
|
|
493 | # delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
|
|
494 | # $self->{_eof} = 1; # tell starttls et. al to stop trying |
|
|
495 | # |
|
|
496 | # &_freetls; |
|
|
497 | #} |
|
|
498 | |
608 | |
499 | sub _error { |
609 | sub _error { |
500 | my ($self, $errno, $fatal, $message) = @_; |
610 | my ($self, $errno, $fatal, $message) = @_; |
501 | |
611 | |
502 | $! = $errno; |
612 | $! = $errno; |
503 | $message ||= "$!"; |
613 | $message ||= "$!"; |
504 | |
614 | |
505 | if ($self->{on_error}) { |
615 | if ($self->{on_error}) { |
506 | $self->{on_error}($self, $fatal, $message); |
616 | $self->{on_error}($self, $fatal, $message); |
507 | $self->destroy if $fatal; |
617 | $self->destroy if $fatal; |
508 | } elsif ($self->{fh}) { |
618 | } elsif ($self->{fh} || $self->{connect}) { |
509 | $self->destroy; |
619 | $self->destroy; |
510 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
620 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
511 | } |
621 | } |
512 | } |
622 | } |
513 | |
623 | |
… | |
… | |
539 | $_[0]{on_eof} = $_[1]; |
649 | $_[0]{on_eof} = $_[1]; |
540 | } |
650 | } |
541 | |
651 | |
542 | =item $handle->on_timeout ($cb) |
652 | =item $handle->on_timeout ($cb) |
543 | |
653 | |
544 | Replace the current C<on_timeout> callback, or disables the callback (but |
654 | =item $handle->on_rtimeout ($cb) |
545 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
|
|
546 | argument and method. |
|
|
547 | |
655 | |
548 | =cut |
656 | =item $handle->on_wtimeout ($cb) |
549 | |
657 | |
550 | sub on_timeout { |
658 | Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout> |
551 | $_[0]{on_timeout} = $_[1]; |
659 | callback, or disables the callback (but not the timeout) if C<$cb> = |
552 | } |
660 | C<undef>. See the C<timeout> constructor argument and method. |
|
|
661 | |
|
|
662 | =cut |
|
|
663 | |
|
|
664 | # see below |
553 | |
665 | |
554 | =item $handle->autocork ($boolean) |
666 | =item $handle->autocork ($boolean) |
555 | |
667 | |
556 | Enables or disables the current autocork behaviour (see C<autocork> |
668 | Enables or disables the current autocork behaviour (see C<autocork> |
557 | constructor argument). Changes will only take effect on the next write. |
669 | constructor argument). Changes will only take effect on the next write. |
… | |
… | |
570 | =cut |
682 | =cut |
571 | |
683 | |
572 | sub no_delay { |
684 | sub no_delay { |
573 | $_[0]{no_delay} = $_[1]; |
685 | $_[0]{no_delay} = $_[1]; |
574 | |
686 | |
|
|
687 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
|
|
688 | if $_[0]{fh}; |
|
|
689 | } |
|
|
690 | |
|
|
691 | =item $handle->keepalive ($boolean) |
|
|
692 | |
|
|
693 | Enables or disables the C<keepalive> setting (see constructor argument of |
|
|
694 | the same name for details). |
|
|
695 | |
|
|
696 | =cut |
|
|
697 | |
|
|
698 | sub keepalive { |
|
|
699 | $_[0]{keepalive} = $_[1]; |
|
|
700 | |
575 | eval { |
701 | eval { |
576 | local $SIG{__DIE__}; |
702 | local $SIG{__DIE__}; |
577 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1] |
703 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1] |
578 | if $_[0]{fh}; |
704 | if $_[0]{fh}; |
579 | }; |
705 | }; |
580 | } |
706 | } |
581 | |
707 | |
|
|
708 | =item $handle->oobinline ($boolean) |
|
|
709 | |
|
|
710 | Enables or disables the C<oobinline> setting (see constructor argument of |
|
|
711 | the same name for details). |
|
|
712 | |
|
|
713 | =cut |
|
|
714 | |
|
|
715 | sub oobinline { |
|
|
716 | $_[0]{oobinline} = $_[1]; |
|
|
717 | |
|
|
718 | eval { |
|
|
719 | local $SIG{__DIE__}; |
|
|
720 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1] |
|
|
721 | if $_[0]{fh}; |
|
|
722 | }; |
|
|
723 | } |
|
|
724 | |
|
|
725 | =item $handle->keepalive ($boolean) |
|
|
726 | |
|
|
727 | Enables or disables the C<keepalive> setting (see constructor argument of |
|
|
728 | the same name for details). |
|
|
729 | |
|
|
730 | =cut |
|
|
731 | |
|
|
732 | sub keepalive { |
|
|
733 | $_[0]{keepalive} = $_[1]; |
|
|
734 | |
|
|
735 | eval { |
|
|
736 | local $SIG{__DIE__}; |
|
|
737 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1] |
|
|
738 | if $_[0]{fh}; |
|
|
739 | }; |
|
|
740 | } |
|
|
741 | |
582 | =item $handle->on_starttls ($cb) |
742 | =item $handle->on_starttls ($cb) |
583 | |
743 | |
584 | Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). |
744 | Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). |
585 | |
745 | |
586 | =cut |
746 | =cut |
… | |
… | |
593 | |
753 | |
594 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
754 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
595 | |
755 | |
596 | =cut |
756 | =cut |
597 | |
757 | |
598 | sub on_starttls { |
758 | sub on_stoptls { |
599 | $_[0]{on_stoptls} = $_[1]; |
759 | $_[0]{on_stoptls} = $_[1]; |
600 | } |
760 | } |
601 | |
761 | |
|
|
762 | =item $handle->rbuf_max ($max_octets) |
|
|
763 | |
|
|
764 | Configures the C<rbuf_max> setting (C<undef> disables it). |
|
|
765 | |
|
|
766 | =item $handle->wbuf_max ($max_octets) |
|
|
767 | |
|
|
768 | Configures the C<wbuf_max> setting (C<undef> disables it). |
|
|
769 | |
|
|
770 | =cut |
|
|
771 | |
|
|
772 | sub rbuf_max { |
|
|
773 | $_[0]{rbuf_max} = $_[1]; |
|
|
774 | } |
|
|
775 | |
|
|
776 | sub wbuf_max { |
|
|
777 | $_[0]{wbuf_max} = $_[1]; |
|
|
778 | } |
|
|
779 | |
602 | ############################################################################# |
780 | ############################################################################# |
603 | |
781 | |
604 | =item $handle->timeout ($seconds) |
782 | =item $handle->timeout ($seconds) |
605 | |
783 | |
|
|
784 | =item $handle->rtimeout ($seconds) |
|
|
785 | |
|
|
786 | =item $handle->wtimeout ($seconds) |
|
|
787 | |
606 | Configures (or disables) the inactivity timeout. |
788 | Configures (or disables) the inactivity timeout. |
607 | |
789 | |
608 | =cut |
790 | The timeout will be checked instantly, so this method might destroy the |
|
|
791 | handle before it returns. |
609 | |
792 | |
610 | sub timeout { |
793 | =item $handle->timeout_reset |
|
|
794 | |
|
|
795 | =item $handle->rtimeout_reset |
|
|
796 | |
|
|
797 | =item $handle->wtimeout_reset |
|
|
798 | |
|
|
799 | Reset the activity timeout, as if data was received or sent. |
|
|
800 | |
|
|
801 | These methods are cheap to call. |
|
|
802 | |
|
|
803 | =cut |
|
|
804 | |
|
|
805 | for my $dir ("", "r", "w") { |
|
|
806 | my $timeout = "${dir}timeout"; |
|
|
807 | my $tw = "_${dir}tw"; |
|
|
808 | my $on_timeout = "on_${dir}timeout"; |
|
|
809 | my $activity = "_${dir}activity"; |
|
|
810 | my $cb; |
|
|
811 | |
|
|
812 | *$on_timeout = sub { |
|
|
813 | $_[0]{$on_timeout} = $_[1]; |
|
|
814 | }; |
|
|
815 | |
|
|
816 | *$timeout = sub { |
611 | my ($self, $timeout) = @_; |
817 | my ($self, $new_value) = @_; |
612 | |
818 | |
|
|
819 | $new_value >= 0 |
|
|
820 | or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught"; |
|
|
821 | |
613 | $self->{timeout} = $timeout; |
822 | $self->{$timeout} = $new_value; |
614 | $self->_timeout; |
823 | delete $self->{$tw}; &$cb; |
615 | } |
824 | }; |
616 | |
825 | |
|
|
826 | *{"${dir}timeout_reset"} = sub { |
|
|
827 | $_[0]{$activity} = AE::now; |
|
|
828 | }; |
|
|
829 | |
|
|
830 | # main workhorse: |
617 | # reset the timeout watcher, as neccessary |
831 | # reset the timeout watcher, as neccessary |
618 | # also check for time-outs |
832 | # also check for time-outs |
619 | sub _timeout { |
833 | $cb = sub { |
620 | my ($self) = @_; |
834 | my ($self) = @_; |
621 | |
835 | |
622 | if ($self->{timeout} && $self->{fh}) { |
836 | if ($self->{$timeout} && $self->{fh}) { |
623 | my $NOW = AnyEvent->now; |
837 | my $NOW = AE::now; |
624 | |
838 | |
625 | # when would the timeout trigger? |
839 | # when would the timeout trigger? |
626 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
840 | my $after = $self->{$activity} + $self->{$timeout} - $NOW; |
627 | |
841 | |
628 | # now or in the past already? |
842 | # now or in the past already? |
629 | if ($after <= 0) { |
843 | if ($after <= 0) { |
630 | $self->{_activity} = $NOW; |
844 | $self->{$activity} = $NOW; |
631 | |
845 | |
632 | if ($self->{on_timeout}) { |
846 | if ($self->{$on_timeout}) { |
633 | $self->{on_timeout}($self); |
847 | $self->{$on_timeout}($self); |
634 | } else { |
848 | } else { |
635 | $self->_error (Errno::ETIMEDOUT); |
849 | $self->_error (Errno::ETIMEDOUT); |
|
|
850 | } |
|
|
851 | |
|
|
852 | # callback could have changed timeout value, optimise |
|
|
853 | return unless $self->{$timeout}; |
|
|
854 | |
|
|
855 | # calculate new after |
|
|
856 | $after = $self->{$timeout}; |
636 | } |
857 | } |
637 | |
858 | |
638 | # callback could have changed timeout value, optimise |
859 | Scalar::Util::weaken $self; |
639 | return unless $self->{timeout}; |
860 | return unless $self; # ->error could have destroyed $self |
640 | |
861 | |
641 | # calculate new after |
862 | $self->{$tw} ||= AE::timer $after, 0, sub { |
642 | $after = $self->{timeout}; |
863 | delete $self->{$tw}; |
|
|
864 | $cb->($self); |
|
|
865 | }; |
|
|
866 | } else { |
|
|
867 | delete $self->{$tw}; |
643 | } |
868 | } |
644 | |
|
|
645 | Scalar::Util::weaken $self; |
|
|
646 | return unless $self; # ->error could have destroyed $self |
|
|
647 | |
|
|
648 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
|
|
649 | delete $self->{_tw}; |
|
|
650 | $self->_timeout; |
|
|
651 | }); |
|
|
652 | } else { |
|
|
653 | delete $self->{_tw}; |
|
|
654 | } |
869 | } |
655 | } |
870 | } |
656 | |
871 | |
657 | ############################################################################# |
872 | ############################################################################# |
658 | |
873 | |
… | |
… | |
674 | =item $handle->on_drain ($cb) |
889 | =item $handle->on_drain ($cb) |
675 | |
890 | |
676 | Sets the C<on_drain> callback or clears it (see the description of |
891 | Sets the C<on_drain> callback or clears it (see the description of |
677 | C<on_drain> in the constructor). |
892 | C<on_drain> in the constructor). |
678 | |
893 | |
|
|
894 | This method may invoke callbacks (and therefore the handle might be |
|
|
895 | destroyed after it returns). |
|
|
896 | |
679 | =cut |
897 | =cut |
680 | |
898 | |
681 | sub on_drain { |
899 | sub on_drain { |
682 | my ($self, $cb) = @_; |
900 | my ($self, $cb) = @_; |
683 | |
901 | |
… | |
… | |
687 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
905 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
688 | } |
906 | } |
689 | |
907 | |
690 | =item $handle->push_write ($data) |
908 | =item $handle->push_write ($data) |
691 | |
909 | |
692 | Queues the given scalar to be written. You can push as much data as you |
910 | Queues the given scalar to be written. You can push as much data as |
693 | want (only limited by the available memory), as C<AnyEvent::Handle> |
911 | you want (only limited by the available memory and C<wbuf_max>), as |
694 | buffers it independently of the kernel. |
912 | C<AnyEvent::Handle> buffers it independently of the kernel. |
|
|
913 | |
|
|
914 | This method may invoke callbacks (and therefore the handle might be |
|
|
915 | destroyed after it returns). |
695 | |
916 | |
696 | =cut |
917 | =cut |
697 | |
918 | |
698 | sub _drain_wbuf { |
919 | sub _drain_wbuf { |
699 | my ($self) = @_; |
920 | my ($self) = @_; |
… | |
… | |
706 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
927 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
707 | |
928 | |
708 | if (defined $len) { |
929 | if (defined $len) { |
709 | substr $self->{wbuf}, 0, $len, ""; |
930 | substr $self->{wbuf}, 0, $len, ""; |
710 | |
931 | |
711 | $self->{_activity} = AnyEvent->now; |
932 | $self->{_activity} = $self->{_wactivity} = AE::now; |
712 | |
933 | |
713 | $self->{on_drain}($self) |
934 | $self->{on_drain}($self) |
714 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
935 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
715 | && $self->{on_drain}; |
936 | && $self->{on_drain}; |
716 | |
937 | |
… | |
… | |
722 | |
943 | |
723 | # try to write data immediately |
944 | # try to write data immediately |
724 | $cb->() unless $self->{autocork}; |
945 | $cb->() unless $self->{autocork}; |
725 | |
946 | |
726 | # if still data left in wbuf, we need to poll |
947 | # if still data left in wbuf, we need to poll |
727 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
948 | $self->{_ww} = AE::io $self->{fh}, 1, $cb |
728 | if length $self->{wbuf}; |
949 | if length $self->{wbuf}; |
|
|
950 | |
|
|
951 | if ( |
|
|
952 | defined $self->{wbuf_max} |
|
|
953 | && $self->{wbuf_max} < length $self->{wbuf} |
|
|
954 | ) { |
|
|
955 | $self->_error (Errno::ENOSPC, 1), return; |
|
|
956 | } |
729 | }; |
957 | }; |
730 | } |
958 | } |
731 | |
959 | |
732 | our %WH; |
960 | our %WH; |
733 | |
961 | |
|
|
962 | # deprecated |
734 | sub register_write_type($$) { |
963 | sub register_write_type($$) { |
735 | $WH{$_[0]} = $_[1]; |
964 | $WH{$_[0]} = $_[1]; |
736 | } |
965 | } |
737 | |
966 | |
738 | sub push_write { |
967 | sub push_write { |
739 | my $self = shift; |
968 | my $self = shift; |
740 | |
969 | |
741 | if (@_ > 1) { |
970 | if (@_ > 1) { |
742 | my $type = shift; |
971 | my $type = shift; |
743 | |
972 | |
|
|
973 | @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" |
744 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
974 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") |
745 | ->($self, @_); |
975 | ->($self, @_); |
746 | } |
976 | } |
747 | |
977 | |
|
|
978 | # we downgrade here to avoid hard-to-track-down bugs, |
|
|
979 | # and diagnose the problem earlier and better. |
|
|
980 | |
748 | if ($self->{tls}) { |
981 | if ($self->{tls}) { |
749 | $self->{_tls_wbuf} .= $_[0]; |
982 | utf8::downgrade $self->{_tls_wbuf} .= $_[0]; |
750 | &_dotls ($self) if $self->{fh}; |
983 | &_dotls ($self) if $self->{fh}; |
751 | } else { |
984 | } else { |
752 | $self->{wbuf} .= $_[0]; |
985 | utf8::downgrade $self->{wbuf} .= $_[0]; |
753 | $self->_drain_wbuf if $self->{fh}; |
986 | $self->_drain_wbuf if $self->{fh}; |
754 | } |
987 | } |
755 | } |
988 | } |
756 | |
989 | |
757 | =item $handle->push_write (type => @args) |
990 | =item $handle->push_write (type => @args) |
758 | |
991 | |
759 | Instead of formatting your data yourself, you can also let this module do |
992 | Instead of formatting your data yourself, you can also let this module |
760 | the job by specifying a type and type-specific arguments. |
993 | do the job by specifying a type and type-specific arguments. You |
|
|
994 | can also specify the (fully qualified) name of a package, in which |
|
|
995 | case AnyEvent tries to load the package and then expects to find the |
|
|
996 | C<anyevent_write_type> function inside (see "custom write types", below). |
761 | |
997 | |
762 | Predefined types are (if you have ideas for additional types, feel free to |
998 | Predefined types are (if you have ideas for additional types, feel free to |
763 | drop by and tell us): |
999 | drop by and tell us): |
764 | |
1000 | |
765 | =over 4 |
1001 | =over 4 |
… | |
… | |
822 | Other languages could read single lines terminated by a newline and pass |
1058 | Other languages could read single lines terminated by a newline and pass |
823 | this line into their JSON decoder of choice. |
1059 | this line into their JSON decoder of choice. |
824 | |
1060 | |
825 | =cut |
1061 | =cut |
826 | |
1062 | |
|
|
1063 | sub json_coder() { |
|
|
1064 | eval { require JSON::XS; JSON::XS->new->utf8 } |
|
|
1065 | || do { require JSON; JSON->new->utf8 } |
|
|
1066 | } |
|
|
1067 | |
827 | register_write_type json => sub { |
1068 | register_write_type json => sub { |
828 | my ($self, $ref) = @_; |
1069 | my ($self, $ref) = @_; |
829 | |
1070 | |
830 | require JSON; |
1071 | my $json = $self->{json} ||= json_coder; |
831 | |
1072 | |
832 | $self->{json} ? $self->{json}->encode ($ref) |
1073 | $json->encode ($ref) |
833 | : JSON::encode_json ($ref) |
|
|
834 | }; |
1074 | }; |
835 | |
1075 | |
836 | =item storable => $reference |
1076 | =item storable => $reference |
837 | |
1077 | |
838 | Freezes the given reference using L<Storable> and writes it to the |
1078 | Freezes the given reference using L<Storable> and writes it to the |
… | |
… | |
856 | before it was actually written. One way to do that is to replace your |
1096 | before it was actually written. One way to do that is to replace your |
857 | C<on_drain> handler by a callback that shuts down the socket (and set |
1097 | C<on_drain> handler by a callback that shuts down the socket (and set |
858 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
1098 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
859 | replaces the C<on_drain> callback with: |
1099 | replaces the C<on_drain> callback with: |
860 | |
1100 | |
861 | sub { shutdown $_[0]{fh}, 1 } # for push_shutdown |
1101 | sub { shutdown $_[0]{fh}, 1 } |
862 | |
1102 | |
863 | This simply shuts down the write side and signals an EOF condition to the |
1103 | This simply shuts down the write side and signals an EOF condition to the |
864 | the peer. |
1104 | the peer. |
865 | |
1105 | |
866 | You can rely on the normal read queue and C<on_eof> handling |
1106 | You can rely on the normal read queue and C<on_eof> handling |
867 | afterwards. This is the cleanest way to close a connection. |
1107 | afterwards. This is the cleanest way to close a connection. |
868 | |
1108 | |
|
|
1109 | This method may invoke callbacks (and therefore the handle might be |
|
|
1110 | destroyed after it returns). |
|
|
1111 | |
869 | =cut |
1112 | =cut |
870 | |
1113 | |
871 | sub push_shutdown { |
1114 | sub push_shutdown { |
872 | my ($self) = @_; |
1115 | my ($self) = @_; |
873 | |
1116 | |
874 | delete $self->{low_water_mark}; |
1117 | delete $self->{low_water_mark}; |
875 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
1118 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
876 | } |
1119 | } |
877 | |
1120 | |
878 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
1121 | =item custom write types - Package::anyevent_write_type $handle, @args |
879 | |
1122 | |
880 | This function (not method) lets you add your own types to C<push_write>. |
1123 | Instead of one of the predefined types, you can also specify the name of |
|
|
1124 | a package. AnyEvent will try to load the package and then expects to find |
|
|
1125 | a function named C<anyevent_write_type> inside. If it isn't found, it |
|
|
1126 | progressively tries to load the parent package until it either finds the |
|
|
1127 | function (good) or runs out of packages (bad). |
|
|
1128 | |
881 | Whenever the given C<type> is used, C<push_write> will invoke the code |
1129 | Whenever the given C<type> is used, C<push_write> will the function with |
882 | reference with the handle object and the remaining arguments. |
1130 | the handle object and the remaining arguments. |
883 | |
1131 | |
884 | The code reference is supposed to return a single octet string that will |
1132 | The function is supposed to return a single octet string that will be |
885 | be appended to the write buffer. |
1133 | appended to the write buffer, so you cna mentally treat this function as a |
|
|
1134 | "arguments to on-the-wire-format" converter. |
886 | |
1135 | |
887 | Note that this is a function, and all types registered this way will be |
1136 | Example: implement a custom write type C<join> that joins the remaining |
888 | global, so try to use unique names. |
1137 | arguments using the first one. |
|
|
1138 | |
|
|
1139 | $handle->push_write (My::Type => " ", 1,2,3); |
|
|
1140 | |
|
|
1141 | # uses the following package, which can be defined in the "My::Type" or in |
|
|
1142 | # the "My" modules to be auto-loaded, or just about anywhere when the |
|
|
1143 | # My::Type::anyevent_write_type is defined before invoking it. |
|
|
1144 | |
|
|
1145 | package My::Type; |
|
|
1146 | |
|
|
1147 | sub anyevent_write_type { |
|
|
1148 | my ($handle, $delim, @args) = @_; |
|
|
1149 | |
|
|
1150 | join $delim, @args |
|
|
1151 | } |
889 | |
1152 | |
890 | =cut |
1153 | =cut |
891 | |
1154 | |
892 | ############################################################################# |
1155 | ############################################################################# |
893 | |
1156 | |
… | |
… | |
902 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1165 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
903 | a queue. |
1166 | a queue. |
904 | |
1167 | |
905 | In the simple case, you just install an C<on_read> callback and whenever |
1168 | In the simple case, you just install an C<on_read> callback and whenever |
906 | new data arrives, it will be called. You can then remove some data (if |
1169 | new data arrives, it will be called. You can then remove some data (if |
907 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
1170 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can |
908 | leave the data there if you want to accumulate more (e.g. when only a |
1171 | leave the data there if you want to accumulate more (e.g. when only a |
909 | partial message has been received so far). |
1172 | partial message has been received so far), or change the read queue with |
|
|
1173 | e.g. C<push_read>. |
910 | |
1174 | |
911 | In the more complex case, you want to queue multiple callbacks. In this |
1175 | In the more complex case, you want to queue multiple callbacks. In this |
912 | case, AnyEvent::Handle will call the first queued callback each time new |
1176 | case, AnyEvent::Handle will call the first queued callback each time new |
913 | data arrives (also the first time it is queued) and removes it when it has |
1177 | data arrives (also the first time it is queued) and remove it when it has |
914 | done its job (see C<push_read>, below). |
1178 | done its job (see C<push_read>, below). |
915 | |
1179 | |
916 | This way you can, for example, push three line-reads, followed by reading |
1180 | This way you can, for example, push three line-reads, followed by reading |
917 | a chunk of data, and AnyEvent::Handle will execute them in order. |
1181 | a chunk of data, and AnyEvent::Handle will execute them in order. |
918 | |
1182 | |
… | |
… | |
976 | |
1240 | |
977 | sub _drain_rbuf { |
1241 | sub _drain_rbuf { |
978 | my ($self) = @_; |
1242 | my ($self) = @_; |
979 | |
1243 | |
980 | # avoid recursion |
1244 | # avoid recursion |
981 | return if exists $self->{_skip_drain_rbuf}; |
1245 | return if $self->{_skip_drain_rbuf}; |
982 | local $self->{_skip_drain_rbuf} = 1; |
1246 | local $self->{_skip_drain_rbuf} = 1; |
983 | |
|
|
984 | if ( |
|
|
985 | defined $self->{rbuf_max} |
|
|
986 | && $self->{rbuf_max} < length $self->{rbuf} |
|
|
987 | ) { |
|
|
988 | $self->_error (Errno::ENOSPC, 1), return; |
|
|
989 | } |
|
|
990 | |
1247 | |
991 | while () { |
1248 | while () { |
992 | # we need to use a separate tls read buffer, as we must not receive data while |
1249 | # we need to use a separate tls read buffer, as we must not receive data while |
993 | # we are draining the buffer, and this can only happen with TLS. |
1250 | # we are draining the buffer, and this can only happen with TLS. |
994 | $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf}; |
1251 | $self->{rbuf} .= delete $self->{_tls_rbuf} |
|
|
1252 | if exists $self->{_tls_rbuf}; |
995 | |
1253 | |
996 | my $len = length $self->{rbuf}; |
1254 | my $len = length $self->{rbuf}; |
997 | |
1255 | |
998 | if (my $cb = shift @{ $self->{_queue} }) { |
1256 | if (my $cb = shift @{ $self->{_queue} }) { |
999 | unless ($cb->($self)) { |
1257 | unless ($cb->($self)) { |
1000 | if ($self->{_eof}) { |
1258 | # no progress can be made |
1001 | # no progress can be made (not enough data and no data forthcoming) |
1259 | # (not enough data and no data forthcoming) |
1002 | $self->_error (Errno::EPIPE, 1), return; |
1260 | $self->_error (Errno::EPIPE, 1), return |
1003 | } |
1261 | if $self->{_eof}; |
1004 | |
1262 | |
1005 | unshift @{ $self->{_queue} }, $cb; |
1263 | unshift @{ $self->{_queue} }, $cb; |
1006 | last; |
1264 | last; |
1007 | } |
1265 | } |
1008 | } elsif ($self->{on_read}) { |
1266 | } elsif ($self->{on_read}) { |
… | |
… | |
1028 | last; |
1286 | last; |
1029 | } |
1287 | } |
1030 | } |
1288 | } |
1031 | |
1289 | |
1032 | if ($self->{_eof}) { |
1290 | if ($self->{_eof}) { |
1033 | if ($self->{on_eof}) { |
1291 | $self->{on_eof} |
1034 | $self->{on_eof}($self) |
1292 | ? $self->{on_eof}($self) |
1035 | } else { |
|
|
1036 | $self->_error (0, 1, "Unexpected end-of-file"); |
1293 | : $self->_error (0, 1, "Unexpected end-of-file"); |
1037 | } |
1294 | |
|
|
1295 | return; |
|
|
1296 | } |
|
|
1297 | |
|
|
1298 | if ( |
|
|
1299 | defined $self->{rbuf_max} |
|
|
1300 | && $self->{rbuf_max} < length $self->{rbuf} |
|
|
1301 | ) { |
|
|
1302 | $self->_error (Errno::ENOSPC, 1), return; |
1038 | } |
1303 | } |
1039 | |
1304 | |
1040 | # may need to restart read watcher |
1305 | # may need to restart read watcher |
1041 | unless ($self->{_rw}) { |
1306 | unless ($self->{_rw}) { |
1042 | $self->start_read |
1307 | $self->start_read |
… | |
… | |
1048 | |
1313 | |
1049 | This replaces the currently set C<on_read> callback, or clears it (when |
1314 | This replaces the currently set C<on_read> callback, or clears it (when |
1050 | the new callback is C<undef>). See the description of C<on_read> in the |
1315 | the new callback is C<undef>). See the description of C<on_read> in the |
1051 | constructor. |
1316 | constructor. |
1052 | |
1317 | |
|
|
1318 | This method may invoke callbacks (and therefore the handle might be |
|
|
1319 | destroyed after it returns). |
|
|
1320 | |
1053 | =cut |
1321 | =cut |
1054 | |
1322 | |
1055 | sub on_read { |
1323 | sub on_read { |
1056 | my ($self, $cb) = @_; |
1324 | my ($self, $cb) = @_; |
1057 | |
1325 | |
… | |
… | |
1059 | $self->_drain_rbuf if $cb; |
1327 | $self->_drain_rbuf if $cb; |
1060 | } |
1328 | } |
1061 | |
1329 | |
1062 | =item $handle->rbuf |
1330 | =item $handle->rbuf |
1063 | |
1331 | |
1064 | Returns the read buffer (as a modifiable lvalue). |
1332 | Returns the read buffer (as a modifiable lvalue). You can also access the |
|
|
1333 | read buffer directly as the C<< ->{rbuf} >> member, if you want (this is |
|
|
1334 | much faster, and no less clean). |
1065 | |
1335 | |
1066 | You can access the read buffer directly as the C<< ->{rbuf} >> |
1336 | The only operation allowed on the read buffer (apart from looking at it) |
1067 | member, if you want. However, the only operation allowed on the |
1337 | is removing data from its beginning. Otherwise modifying or appending to |
1068 | read buffer (apart from looking at it) is removing data from its |
1338 | it is not allowed and will lead to hard-to-track-down bugs. |
1069 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
1070 | lead to hard-to-track-down bugs. |
|
|
1071 | |
1339 | |
1072 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
1340 | NOTE: The read buffer should only be used or modified in the C<on_read> |
1073 | C<push_read> or C<unshift_read> methods are used. The other read methods |
1341 | callback or when C<push_read> or C<unshift_read> are used with a single |
1074 | automatically manage the read buffer. |
1342 | callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods |
|
|
1343 | will manage the read buffer on their own. |
1075 | |
1344 | |
1076 | =cut |
1345 | =cut |
1077 | |
1346 | |
1078 | sub rbuf : lvalue { |
1347 | sub rbuf : lvalue { |
1079 | $_[0]{rbuf} |
1348 | $_[0]{rbuf} |
… | |
… | |
1096 | |
1365 | |
1097 | If enough data was available, then the callback must remove all data it is |
1366 | If enough data was available, then the callback must remove all data it is |
1098 | interested in (which can be none at all) and return a true value. After returning |
1367 | interested in (which can be none at all) and return a true value. After returning |
1099 | true, it will be removed from the queue. |
1368 | true, it will be removed from the queue. |
1100 | |
1369 | |
|
|
1370 | These methods may invoke callbacks (and therefore the handle might be |
|
|
1371 | destroyed after it returns). |
|
|
1372 | |
1101 | =cut |
1373 | =cut |
1102 | |
1374 | |
1103 | our %RH; |
1375 | our %RH; |
1104 | |
1376 | |
1105 | sub register_read_type($$) { |
1377 | sub register_read_type($$) { |
… | |
… | |
1111 | my $cb = pop; |
1383 | my $cb = pop; |
1112 | |
1384 | |
1113 | if (@_) { |
1385 | if (@_) { |
1114 | my $type = shift; |
1386 | my $type = shift; |
1115 | |
1387 | |
|
|
1388 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1116 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
1389 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read") |
1117 | ->($self, $cb, @_); |
1390 | ->($self, $cb, @_); |
1118 | } |
1391 | } |
1119 | |
1392 | |
1120 | push @{ $self->{_queue} }, $cb; |
1393 | push @{ $self->{_queue} }, $cb; |
1121 | $self->_drain_rbuf; |
1394 | $self->_drain_rbuf; |
… | |
… | |
1126 | my $cb = pop; |
1399 | my $cb = pop; |
1127 | |
1400 | |
1128 | if (@_) { |
1401 | if (@_) { |
1129 | my $type = shift; |
1402 | my $type = shift; |
1130 | |
1403 | |
|
|
1404 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1131 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
1405 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read") |
1132 | ->($self, $cb, @_); |
1406 | ->($self, $cb, @_); |
1133 | } |
1407 | } |
1134 | |
|
|
1135 | |
1408 | |
1136 | unshift @{ $self->{_queue} }, $cb; |
1409 | unshift @{ $self->{_queue} }, $cb; |
1137 | $self->_drain_rbuf; |
1410 | $self->_drain_rbuf; |
1138 | } |
1411 | } |
1139 | |
1412 | |
… | |
… | |
1141 | |
1414 | |
1142 | =item $handle->unshift_read (type => @args, $cb) |
1415 | =item $handle->unshift_read (type => @args, $cb) |
1143 | |
1416 | |
1144 | Instead of providing a callback that parses the data itself you can chose |
1417 | Instead of providing a callback that parses the data itself you can chose |
1145 | between a number of predefined parsing formats, for chunks of data, lines |
1418 | between a number of predefined parsing formats, for chunks of data, lines |
1146 | etc. |
1419 | etc. You can also specify the (fully qualified) name of a package, in |
|
|
1420 | which case AnyEvent tries to load the package and then expects to find the |
|
|
1421 | C<anyevent_read_type> function inside (see "custom read types", below). |
1147 | |
1422 | |
1148 | Predefined types are (if you have ideas for additional types, feel free to |
1423 | Predefined types are (if you have ideas for additional types, feel free to |
1149 | drop by and tell us): |
1424 | drop by and tell us): |
1150 | |
1425 | |
1151 | =over 4 |
1426 | =over 4 |
… | |
… | |
1157 | data. |
1432 | data. |
1158 | |
1433 | |
1159 | Example: read 2 bytes. |
1434 | Example: read 2 bytes. |
1160 | |
1435 | |
1161 | $handle->push_read (chunk => 2, sub { |
1436 | $handle->push_read (chunk => 2, sub { |
1162 | warn "yay ", unpack "H*", $_[1]; |
1437 | AE::log debug => "yay " . unpack "H*", $_[1]; |
1163 | }); |
1438 | }); |
1164 | |
1439 | |
1165 | =cut |
1440 | =cut |
1166 | |
1441 | |
1167 | register_read_type chunk => sub { |
1442 | register_read_type chunk => sub { |
… | |
… | |
1243 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1518 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1244 | and everything preceding and including the match will be accepted |
1519 | and everything preceding and including the match will be accepted |
1245 | unconditionally. This is useful to skip large amounts of data that you |
1520 | unconditionally. This is useful to skip large amounts of data that you |
1246 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1521 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1247 | have to start matching from the beginning. This is purely an optimisation |
1522 | have to start matching from the beginning. This is purely an optimisation |
1248 | and is usually worth only when you expect more than a few kilobytes. |
1523 | and is usually worth it only when you expect more than a few kilobytes. |
1249 | |
1524 | |
1250 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1525 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1251 | expect the header to be very large (it isn't in practise, but...), we use |
1526 | expect the header to be very large (it isn't in practice, but...), we use |
1252 | a skip regex to skip initial portions. The skip regex is tricky in that |
1527 | a skip regex to skip initial portions. The skip regex is tricky in that |
1253 | it only accepts something not ending in either \015 or \012, as these are |
1528 | it only accepts something not ending in either \015 or \012, as these are |
1254 | required for the accept regex. |
1529 | required for the accept regex. |
1255 | |
1530 | |
1256 | $handle->push_read (regex => |
1531 | $handle->push_read (regex => |
… | |
… | |
1269 | |
1544 | |
1270 | sub { |
1545 | sub { |
1271 | # accept |
1546 | # accept |
1272 | if ($$rbuf =~ $accept) { |
1547 | if ($$rbuf =~ $accept) { |
1273 | $data .= substr $$rbuf, 0, $+[0], ""; |
1548 | $data .= substr $$rbuf, 0, $+[0], ""; |
1274 | $cb->($self, $data); |
1549 | $cb->($_[0], $data); |
1275 | return 1; |
1550 | return 1; |
1276 | } |
1551 | } |
1277 | |
1552 | |
1278 | # reject |
1553 | # reject |
1279 | if ($reject && $$rbuf =~ $reject) { |
1554 | if ($reject && $$rbuf =~ $reject) { |
1280 | $self->_error (Errno::EBADMSG); |
1555 | $_[0]->_error (Errno::EBADMSG); |
1281 | } |
1556 | } |
1282 | |
1557 | |
1283 | # skip |
1558 | # skip |
1284 | if ($skip && $$rbuf =~ $skip) { |
1559 | if ($skip && $$rbuf =~ $skip) { |
1285 | $data .= substr $$rbuf, 0, $+[0], ""; |
1560 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
1301 | my ($self, $cb) = @_; |
1576 | my ($self, $cb) = @_; |
1302 | |
1577 | |
1303 | sub { |
1578 | sub { |
1304 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1579 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1305 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1580 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1306 | $self->_error (Errno::EBADMSG); |
1581 | $_[0]->_error (Errno::EBADMSG); |
1307 | } |
1582 | } |
1308 | return; |
1583 | return; |
1309 | } |
1584 | } |
1310 | |
1585 | |
1311 | my $len = $1; |
1586 | my $len = $1; |
1312 | |
1587 | |
1313 | $self->unshift_read (chunk => $len, sub { |
1588 | $_[0]->unshift_read (chunk => $len, sub { |
1314 | my $string = $_[1]; |
1589 | my $string = $_[1]; |
1315 | $_[0]->unshift_read (chunk => 1, sub { |
1590 | $_[0]->unshift_read (chunk => 1, sub { |
1316 | if ($_[1] eq ",") { |
1591 | if ($_[1] eq ",") { |
1317 | $cb->($_[0], $string); |
1592 | $cb->($_[0], $string); |
1318 | } else { |
1593 | } else { |
1319 | $self->_error (Errno::EBADMSG); |
1594 | $_[0]->_error (Errno::EBADMSG); |
1320 | } |
1595 | } |
1321 | }); |
1596 | }); |
1322 | }); |
1597 | }); |
1323 | |
1598 | |
1324 | 1 |
1599 | 1 |
… | |
… | |
1391 | =cut |
1666 | =cut |
1392 | |
1667 | |
1393 | register_read_type json => sub { |
1668 | register_read_type json => sub { |
1394 | my ($self, $cb) = @_; |
1669 | my ($self, $cb) = @_; |
1395 | |
1670 | |
1396 | my $json = $self->{json} ||= |
1671 | my $json = $self->{json} ||= json_coder; |
1397 | eval { require JSON::XS; JSON::XS->new->utf8 } |
|
|
1398 | || do { require JSON; JSON->new->utf8 }; |
|
|
1399 | |
1672 | |
1400 | my $data; |
1673 | my $data; |
1401 | my $rbuf = \$self->{rbuf}; |
1674 | my $rbuf = \$self->{rbuf}; |
1402 | |
1675 | |
1403 | sub { |
1676 | sub { |
1404 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1677 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1405 | |
1678 | |
1406 | if ($ref) { |
1679 | if ($ref) { |
1407 | $self->{rbuf} = $json->incr_text; |
1680 | $_[0]{rbuf} = $json->incr_text; |
1408 | $json->incr_text = ""; |
1681 | $json->incr_text = ""; |
1409 | $cb->($self, $ref); |
1682 | $cb->($_[0], $ref); |
1410 | |
1683 | |
1411 | 1 |
1684 | 1 |
1412 | } elsif ($@) { |
1685 | } elsif ($@) { |
1413 | # error case |
1686 | # error case |
1414 | $json->incr_skip; |
1687 | $json->incr_skip; |
1415 | |
1688 | |
1416 | $self->{rbuf} = $json->incr_text; |
1689 | $_[0]{rbuf} = $json->incr_text; |
1417 | $json->incr_text = ""; |
1690 | $json->incr_text = ""; |
1418 | |
1691 | |
1419 | $self->_error (Errno::EBADMSG); |
1692 | $_[0]->_error (Errno::EBADMSG); |
1420 | |
1693 | |
1421 | () |
1694 | () |
1422 | } else { |
1695 | } else { |
1423 | $self->{rbuf} = ""; |
1696 | $_[0]{rbuf} = ""; |
1424 | |
1697 | |
1425 | () |
1698 | () |
1426 | } |
1699 | } |
1427 | } |
1700 | } |
1428 | }; |
1701 | }; |
… | |
… | |
1461 | # read remaining chunk |
1734 | # read remaining chunk |
1462 | $_[0]->unshift_read (chunk => $len, sub { |
1735 | $_[0]->unshift_read (chunk => $len, sub { |
1463 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1736 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1464 | $cb->($_[0], $ref); |
1737 | $cb->($_[0], $ref); |
1465 | } else { |
1738 | } else { |
1466 | $self->_error (Errno::EBADMSG); |
1739 | $_[0]->_error (Errno::EBADMSG); |
1467 | } |
1740 | } |
1468 | }); |
1741 | }); |
1469 | } |
1742 | } |
1470 | |
1743 | |
1471 | 1 |
1744 | 1 |
1472 | } |
1745 | } |
1473 | }; |
1746 | }; |
1474 | |
1747 | |
1475 | =back |
1748 | =back |
1476 | |
1749 | |
1477 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1750 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
1478 | |
1751 | |
1479 | This function (not method) lets you add your own types to C<push_read>. |
1752 | Instead of one of the predefined types, you can also specify the name |
|
|
1753 | of a package. AnyEvent will try to load the package and then expects to |
|
|
1754 | find a function named C<anyevent_read_type> inside. If it isn't found, it |
|
|
1755 | progressively tries to load the parent package until it either finds the |
|
|
1756 | function (good) or runs out of packages (bad). |
1480 | |
1757 | |
1481 | Whenever the given C<type> is used, C<push_read> will invoke the code |
1758 | Whenever this type is used, C<push_read> will invoke the function with the |
1482 | reference with the handle object, the callback and the remaining |
1759 | handle object, the original callback and the remaining arguments. |
1483 | arguments. |
|
|
1484 | |
1760 | |
1485 | The code reference is supposed to return a callback (usually a closure) |
1761 | The function is supposed to return a callback (usually a closure) that |
1486 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
1762 | works as a plain read callback (see C<< ->push_read ($cb) >>), so you can |
|
|
1763 | mentally treat the function as a "configurable read type to read callback" |
|
|
1764 | converter. |
1487 | |
1765 | |
1488 | It should invoke the passed callback when it is done reading (remember to |
1766 | It should invoke the original callback when it is done reading (remember |
1489 | pass C<$handle> as first argument as all other callbacks do that). |
1767 | to pass C<$handle> as first argument as all other callbacks do that, |
|
|
1768 | although there is no strict requirement on this). |
1490 | |
1769 | |
1491 | Note that this is a function, and all types registered this way will be |
|
|
1492 | global, so try to use unique names. |
|
|
1493 | |
|
|
1494 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
1770 | For examples, see the source of this module (F<perldoc -m |
1495 | search for C<register_read_type>)). |
1771 | AnyEvent::Handle>, search for C<register_read_type>)). |
1496 | |
1772 | |
1497 | =item $handle->stop_read |
1773 | =item $handle->stop_read |
1498 | |
1774 | |
1499 | =item $handle->start_read |
1775 | =item $handle->start_read |
1500 | |
1776 | |
… | |
… | |
1506 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1782 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1507 | you change the C<on_read> callback or push/unshift a read callback, and it |
1783 | you change the C<on_read> callback or push/unshift a read callback, and it |
1508 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1784 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1509 | there are any read requests in the queue. |
1785 | there are any read requests in the queue. |
1510 | |
1786 | |
1511 | These methods will have no effect when in TLS mode (as TLS doesn't support |
1787 | In older versions of this module (<= 5.3), these methods had no effect, |
1512 | half-duplex connections). |
1788 | as TLS does not support half-duplex connections. In current versions they |
|
|
1789 | work as expected, as this behaviour is required to avoid certain resource |
|
|
1790 | attacks, where the program would be forced to read (and buffer) arbitrary |
|
|
1791 | amounts of data before being able to send some data. The drawback is that |
|
|
1792 | some readings of the the SSL/TLS specifications basically require this |
|
|
1793 | attack to be working, as SSL/TLS implementations might stall sending data |
|
|
1794 | during a rehandshake. |
|
|
1795 | |
|
|
1796 | As a guideline, during the initial handshake, you should not stop reading, |
|
|
1797 | and as a client, it might cause problems, depending on your applciation. |
1513 | |
1798 | |
1514 | =cut |
1799 | =cut |
1515 | |
1800 | |
1516 | sub stop_read { |
1801 | sub stop_read { |
1517 | my ($self) = @_; |
1802 | my ($self) = @_; |
1518 | |
1803 | |
1519 | delete $self->{_rw} unless $self->{tls}; |
1804 | delete $self->{_rw}; |
1520 | } |
1805 | } |
1521 | |
1806 | |
1522 | sub start_read { |
1807 | sub start_read { |
1523 | my ($self) = @_; |
1808 | my ($self) = @_; |
1524 | |
1809 | |
1525 | unless ($self->{_rw} || $self->{_eof}) { |
1810 | unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) { |
1526 | Scalar::Util::weaken $self; |
1811 | Scalar::Util::weaken $self; |
1527 | |
1812 | |
1528 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1813 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1529 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1814 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1530 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1815 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf; |
1531 | |
1816 | |
1532 | if ($len > 0) { |
1817 | if ($len > 0) { |
1533 | $self->{_activity} = AnyEvent->now; |
1818 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1534 | |
1819 | |
1535 | if ($self->{tls}) { |
1820 | if ($self->{tls}) { |
1536 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1821 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1537 | |
1822 | |
1538 | &_dotls ($self); |
1823 | &_dotls ($self); |
1539 | } else { |
1824 | } else { |
1540 | $self->_drain_rbuf; |
1825 | $self->_drain_rbuf; |
1541 | } |
1826 | } |
1542 | |
1827 | |
|
|
1828 | if ($len == $self->{read_size}) { |
|
|
1829 | $self->{read_size} *= 2; |
|
|
1830 | $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE |
|
|
1831 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
|
|
1832 | } |
|
|
1833 | |
1543 | } elsif (defined $len) { |
1834 | } elsif (defined $len) { |
1544 | delete $self->{_rw}; |
1835 | delete $self->{_rw}; |
1545 | $self->{_eof} = 1; |
1836 | $self->{_eof} = 1; |
1546 | $self->_drain_rbuf; |
1837 | $self->_drain_rbuf; |
1547 | |
1838 | |
1548 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1839 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1549 | return $self->_error ($!, 1); |
1840 | return $self->_error ($!, 1); |
1550 | } |
1841 | } |
1551 | }); |
1842 | }; |
1552 | } |
1843 | } |
1553 | } |
1844 | } |
1554 | |
1845 | |
1555 | our $ERROR_SYSCALL; |
1846 | our $ERROR_SYSCALL; |
1556 | our $ERROR_WANT_READ; |
1847 | our $ERROR_WANT_READ; |
… | |
… | |
1623 | && ($tmp != $ERROR_SYSCALL || $!); |
1914 | && ($tmp != $ERROR_SYSCALL || $!); |
1624 | |
1915 | |
1625 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1916 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1626 | $self->{wbuf} .= $tmp; |
1917 | $self->{wbuf} .= $tmp; |
1627 | $self->_drain_wbuf; |
1918 | $self->_drain_wbuf; |
|
|
1919 | $self->{tls} or return; # tls session might have gone away in callback |
1628 | } |
1920 | } |
1629 | |
1921 | |
1630 | $self->{_on_starttls} |
1922 | $self->{_on_starttls} |
1631 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1923 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1632 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
1924 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
… | |
… | |
1654 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1946 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1655 | changed to your liking. Note that the handshake might have already started |
1947 | changed to your liking. Note that the handshake might have already started |
1656 | when this function returns. |
1948 | when this function returns. |
1657 | |
1949 | |
1658 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1950 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1659 | handshakes on the same stream. Best do not attempt to use the stream after |
1951 | handshakes on the same stream. It is best to not attempt to use the |
1660 | stopping TLS. |
1952 | stream after stopping TLS. |
|
|
1953 | |
|
|
1954 | This method may invoke callbacks (and therefore the handle might be |
|
|
1955 | destroyed after it returns). |
1661 | |
1956 | |
1662 | =cut |
1957 | =cut |
1663 | |
1958 | |
1664 | our %TLS_CACHE; #TODO not yet documented, should we? |
1959 | our %TLS_CACHE; #TODO not yet documented, should we? |
1665 | |
1960 | |
… | |
… | |
1677 | require Net::SSLeay; |
1972 | require Net::SSLeay; |
1678 | |
1973 | |
1679 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1974 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1680 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1975 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1681 | |
1976 | |
1682 | $tls = $self->{tls}; |
1977 | $tls = delete $self->{tls}; |
1683 | $ctx = $self->{tls_ctx}; |
1978 | $ctx = $self->{tls_ctx}; |
1684 | |
1979 | |
1685 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1980 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1686 | |
1981 | |
1687 | if ("HASH" eq ref $ctx) { |
1982 | if ("HASH" eq ref $ctx) { |
… | |
… | |
1716 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
2011 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
1717 | |
2012 | |
1718 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2013 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1719 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2014 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1720 | |
2015 | |
|
|
2016 | Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf}); |
|
|
2017 | $self->{rbuf} = ""; |
|
|
2018 | |
1721 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
2019 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
1722 | |
2020 | |
1723 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
2021 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
1724 | if $self->{on_starttls}; |
2022 | if $self->{on_starttls}; |
1725 | |
2023 | |
… | |
… | |
1729 | |
2027 | |
1730 | =item $handle->stoptls |
2028 | =item $handle->stoptls |
1731 | |
2029 | |
1732 | Shuts down the SSL connection - this makes a proper EOF handshake by |
2030 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1733 | sending a close notify to the other side, but since OpenSSL doesn't |
2031 | sending a close notify to the other side, but since OpenSSL doesn't |
1734 | support non-blocking shut downs, it is not guarenteed that you can re-use |
2032 | support non-blocking shut downs, it is not guaranteed that you can re-use |
1735 | the stream afterwards. |
2033 | the stream afterwards. |
|
|
2034 | |
|
|
2035 | This method may invoke callbacks (and therefore the handle might be |
|
|
2036 | destroyed after it returns). |
1736 | |
2037 | |
1737 | =cut |
2038 | =cut |
1738 | |
2039 | |
1739 | sub stoptls { |
2040 | sub stoptls { |
1740 | my ($self) = @_; |
2041 | my ($self) = @_; |
1741 | |
2042 | |
1742 | if ($self->{tls}) { |
2043 | if ($self->{tls} && $self->{fh}) { |
1743 | Net::SSLeay::shutdown ($self->{tls}); |
2044 | Net::SSLeay::shutdown ($self->{tls}); |
1744 | |
2045 | |
1745 | &_dotls; |
2046 | &_dotls; |
1746 | |
2047 | |
1747 | # # we don't give a shit. no, we do, but we can't. no...#d# |
2048 | # # we don't give a shit. no, we do, but we can't. no...#d# |
… | |
… | |
1754 | my ($self) = @_; |
2055 | my ($self) = @_; |
1755 | |
2056 | |
1756 | return unless $self->{tls}; |
2057 | return unless $self->{tls}; |
1757 | |
2058 | |
1758 | $self->{tls_ctx}->_put_session (delete $self->{tls}) |
2059 | $self->{tls_ctx}->_put_session (delete $self->{tls}) |
1759 | if ref $self->{tls}; |
2060 | if $self->{tls} > 0; |
1760 | |
2061 | |
1761 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
2062 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
1762 | } |
2063 | } |
|
|
2064 | |
|
|
2065 | =item $handle->resettls |
|
|
2066 | |
|
|
2067 | This rarely-used method simply resets and TLS state on the handle, usually |
|
|
2068 | causing data loss. |
|
|
2069 | |
|
|
2070 | One case where it may be useful is when you want to skip over the data in |
|
|
2071 | the stream but you are not interested in interpreting it, so data loss is |
|
|
2072 | no concern. |
|
|
2073 | |
|
|
2074 | =cut |
|
|
2075 | |
|
|
2076 | *resettls = \&_freetls; |
1763 | |
2077 | |
1764 | sub DESTROY { |
2078 | sub DESTROY { |
1765 | my ($self) = @_; |
2079 | my ($self) = @_; |
1766 | |
2080 | |
1767 | &_freetls; |
2081 | &_freetls; |
… | |
… | |
1772 | my $fh = delete $self->{fh}; |
2086 | my $fh = delete $self->{fh}; |
1773 | my $wbuf = delete $self->{wbuf}; |
2087 | my $wbuf = delete $self->{wbuf}; |
1774 | |
2088 | |
1775 | my @linger; |
2089 | my @linger; |
1776 | |
2090 | |
1777 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
2091 | push @linger, AE::io $fh, 1, sub { |
1778 | my $len = syswrite $fh, $wbuf, length $wbuf; |
2092 | my $len = syswrite $fh, $wbuf, length $wbuf; |
1779 | |
2093 | |
1780 | if ($len > 0) { |
2094 | if ($len > 0) { |
1781 | substr $wbuf, 0, $len, ""; |
2095 | substr $wbuf, 0, $len, ""; |
1782 | } else { |
2096 | } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) { |
1783 | @linger = (); # end |
2097 | @linger = (); # end |
1784 | } |
2098 | } |
1785 | }); |
2099 | }; |
1786 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
2100 | push @linger, AE::timer $linger, 0, sub { |
1787 | @linger = (); |
2101 | @linger = (); |
1788 | }); |
2102 | }; |
1789 | } |
2103 | } |
1790 | } |
2104 | } |
1791 | |
2105 | |
1792 | =item $handle->destroy |
2106 | =item $handle->destroy |
1793 | |
2107 | |
1794 | Shuts down the handle object as much as possible - this call ensures that |
2108 | Shuts down the handle object as much as possible - this call ensures that |
1795 | no further callbacks will be invoked and as many resources as possible |
2109 | no further callbacks will be invoked and as many resources as possible |
1796 | will be freed. You must not call any methods on the object afterwards. |
2110 | will be freed. Any method you will call on the handle object after |
|
|
2111 | destroying it in this way will be silently ignored (and it will return the |
|
|
2112 | empty list). |
1797 | |
2113 | |
1798 | Normally, you can just "forget" any references to an AnyEvent::Handle |
2114 | Normally, you can just "forget" any references to an AnyEvent::Handle |
1799 | object and it will simply shut down. This works in fatal error and EOF |
2115 | object and it will simply shut down. This works in fatal error and EOF |
1800 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
2116 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
1801 | callback, so when you want to destroy the AnyEvent::Handle object from |
2117 | callback, so when you want to destroy the AnyEvent::Handle object from |
… | |
… | |
1815 | sub destroy { |
2131 | sub destroy { |
1816 | my ($self) = @_; |
2132 | my ($self) = @_; |
1817 | |
2133 | |
1818 | $self->DESTROY; |
2134 | $self->DESTROY; |
1819 | %$self = (); |
2135 | %$self = (); |
|
|
2136 | bless $self, "AnyEvent::Handle::destroyed"; |
1820 | } |
2137 | } |
|
|
2138 | |
|
|
2139 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
|
|
2140 | #nop |
|
|
2141 | } |
|
|
2142 | |
|
|
2143 | =item $handle->destroyed |
|
|
2144 | |
|
|
2145 | Returns false as long as the handle hasn't been destroyed by a call to C<< |
|
|
2146 | ->destroy >>, true otherwise. |
|
|
2147 | |
|
|
2148 | Can be useful to decide whether the handle is still valid after some |
|
|
2149 | callback possibly destroyed the handle. For example, C<< ->push_write >>, |
|
|
2150 | C<< ->starttls >> and other methods can call user callbacks, which in turn |
|
|
2151 | can destroy the handle, so work can be avoided by checking sometimes: |
|
|
2152 | |
|
|
2153 | $hdl->starttls ("accept"); |
|
|
2154 | return if $hdl->destroyed; |
|
|
2155 | $hdl->push_write (... |
|
|
2156 | |
|
|
2157 | Note that the call to C<push_write> will silently be ignored if the handle |
|
|
2158 | has been destroyed, so often you can just ignore the possibility of the |
|
|
2159 | handle being destroyed. |
|
|
2160 | |
|
|
2161 | =cut |
|
|
2162 | |
|
|
2163 | sub destroyed { 0 } |
|
|
2164 | sub AnyEvent::Handle::destroyed::destroyed { 1 } |
1821 | |
2165 | |
1822 | =item AnyEvent::Handle::TLS_CTX |
2166 | =item AnyEvent::Handle::TLS_CTX |
1823 | |
2167 | |
1824 | This function creates and returns the AnyEvent::TLS object used by default |
2168 | This function creates and returns the AnyEvent::TLS object used by default |
1825 | for TLS mode. |
2169 | for TLS mode. |
… | |
… | |
1853 | |
2197 | |
1854 | It is only safe to "forget" the reference inside EOF or error callbacks, |
2198 | It is only safe to "forget" the reference inside EOF or error callbacks, |
1855 | from within all other callbacks, you need to explicitly call the C<< |
2199 | from within all other callbacks, you need to explicitly call the C<< |
1856 | ->destroy >> method. |
2200 | ->destroy >> method. |
1857 | |
2201 | |
|
|
2202 | =item Why is my C<on_eof> callback never called? |
|
|
2203 | |
|
|
2204 | Probably because your C<on_error> callback is being called instead: When |
|
|
2205 | you have outstanding requests in your read queue, then an EOF is |
|
|
2206 | considered an error as you clearly expected some data. |
|
|
2207 | |
|
|
2208 | To avoid this, make sure you have an empty read queue whenever your handle |
|
|
2209 | is supposed to be "idle" (i.e. connection closes are O.K.). You cna set |
|
|
2210 | an C<on_read> handler that simply pushes the first read requests in the |
|
|
2211 | queue. |
|
|
2212 | |
|
|
2213 | See also the next question, which explains this in a bit more detail. |
|
|
2214 | |
|
|
2215 | =item How can I serve requests in a loop? |
|
|
2216 | |
|
|
2217 | Most protocols consist of some setup phase (authentication for example) |
|
|
2218 | followed by a request handling phase, where the server waits for requests |
|
|
2219 | and handles them, in a loop. |
|
|
2220 | |
|
|
2221 | There are two important variants: The first (traditional, better) variant |
|
|
2222 | handles requests until the server gets some QUIT command, causing it to |
|
|
2223 | close the connection first (highly desirable for a busy TCP server). A |
|
|
2224 | client dropping the connection is an error, which means this variant can |
|
|
2225 | detect an unexpected detection close. |
|
|
2226 | |
|
|
2227 | To handle this case, always make sure you have a on-empty read queue, by |
|
|
2228 | pushing the "read request start" handler on it: |
|
|
2229 | |
|
|
2230 | # we assume a request starts with a single line |
|
|
2231 | my @start_request; @start_request = (line => sub { |
|
|
2232 | my ($hdl, $line) = @_; |
|
|
2233 | |
|
|
2234 | ... handle request |
|
|
2235 | |
|
|
2236 | # push next request read, possibly from a nested callback |
|
|
2237 | $hdl->push_read (@start_request); |
|
|
2238 | }); |
|
|
2239 | |
|
|
2240 | # auth done, now go into request handling loop |
|
|
2241 | # now push the first @start_request |
|
|
2242 | $hdl->push_read (@start_request); |
|
|
2243 | |
|
|
2244 | By always having an outstanding C<push_read>, the handle always expects |
|
|
2245 | some data and raises the C<EPIPE> error when the connction is dropped |
|
|
2246 | unexpectedly. |
|
|
2247 | |
|
|
2248 | The second variant is a protocol where the client can drop the connection |
|
|
2249 | at any time. For TCP, this means that the server machine may run out of |
|
|
2250 | sockets easier, and in general, it means you cnanot distinguish a protocl |
|
|
2251 | failure/client crash from a normal connection close. Nevertheless, these |
|
|
2252 | kinds of protocols are common (and sometimes even the best solution to the |
|
|
2253 | problem). |
|
|
2254 | |
|
|
2255 | Having an outstanding read request at all times is possible if you ignore |
|
|
2256 | C<EPIPE> errors, but this doesn't help with when the client drops the |
|
|
2257 | connection during a request, which would still be an error. |
|
|
2258 | |
|
|
2259 | A better solution is to push the initial request read in an C<on_read> |
|
|
2260 | callback. This avoids an error, as when the server doesn't expect data |
|
|
2261 | (i.e. is idly waiting for the next request, an EOF will not raise an |
|
|
2262 | error, but simply result in an C<on_eof> callback. It is also a bit slower |
|
|
2263 | and simpler: |
|
|
2264 | |
|
|
2265 | # auth done, now go into request handling loop |
|
|
2266 | $hdl->on_read (sub { |
|
|
2267 | my ($hdl) = @_; |
|
|
2268 | |
|
|
2269 | # called each time we receive data but the read queue is empty |
|
|
2270 | # simply start read the request |
|
|
2271 | |
|
|
2272 | $hdl->push_read (line => sub { |
|
|
2273 | my ($hdl, $line) = @_; |
|
|
2274 | |
|
|
2275 | ... handle request |
|
|
2276 | |
|
|
2277 | # do nothing special when the request has been handled, just |
|
|
2278 | # let the request queue go empty. |
|
|
2279 | }); |
|
|
2280 | }); |
|
|
2281 | |
1858 | =item I get different callback invocations in TLS mode/Why can't I pause |
2282 | =item I get different callback invocations in TLS mode/Why can't I pause |
1859 | reading? |
2283 | reading? |
1860 | |
2284 | |
1861 | Unlike, say, TCP, TLS connections do not consist of two independent |
2285 | Unlike, say, TCP, TLS connections do not consist of two independent |
1862 | communication channels, one for each direction. Or put differently. The |
2286 | communication channels, one for each direction. Or put differently, the |
1863 | read and write directions are not independent of each other: you cannot |
2287 | read and write directions are not independent of each other: you cannot |
1864 | write data unless you are also prepared to read, and vice versa. |
2288 | write data unless you are also prepared to read, and vice versa. |
1865 | |
2289 | |
1866 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
2290 | This means that, in TLS mode, you might get C<on_error> or C<on_eof> |
1867 | callback invocations when you are not expecting any read data - the reason |
2291 | callback invocations when you are not expecting any read data - the reason |
1868 | is that AnyEvent::Handle always reads in TLS mode. |
2292 | is that AnyEvent::Handle always reads in TLS mode. |
1869 | |
2293 | |
1870 | During the connection, you have to make sure that you always have a |
2294 | During the connection, you have to make sure that you always have a |
1871 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
2295 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
… | |
… | |
1883 | $handle->on_eof (undef); |
2307 | $handle->on_eof (undef); |
1884 | $handle->on_error (sub { |
2308 | $handle->on_error (sub { |
1885 | my $data = delete $_[0]{rbuf}; |
2309 | my $data = delete $_[0]{rbuf}; |
1886 | }); |
2310 | }); |
1887 | |
2311 | |
|
|
2312 | Note that this example removes the C<rbuf> member from the handle object, |
|
|
2313 | which is not normally allowed by the API. It is expressly permitted in |
|
|
2314 | this case only, as the handle object needs to be destroyed afterwards. |
|
|
2315 | |
1888 | The reason to use C<on_error> is that TCP connections, due to latencies |
2316 | The reason to use C<on_error> is that TCP connections, due to latencies |
1889 | and packets loss, might get closed quite violently with an error, when in |
2317 | and packets loss, might get closed quite violently with an error, when in |
1890 | fact, all data has been received. |
2318 | fact all data has been received. |
1891 | |
2319 | |
1892 | It is usually better to use acknowledgements when transferring data, |
2320 | It is usually better to use acknowledgements when transferring data, |
1893 | to make sure the other side hasn't just died and you got the data |
2321 | to make sure the other side hasn't just died and you got the data |
1894 | intact. This is also one reason why so many internet protocols have an |
2322 | intact. This is also one reason why so many internet protocols have an |
1895 | explicit QUIT command. |
2323 | explicit QUIT command. |
… | |
… | |
1902 | C<low_water_mark> this will be called precisely when all data has been |
2330 | C<low_water_mark> this will be called precisely when all data has been |
1903 | written to the socket: |
2331 | written to the socket: |
1904 | |
2332 | |
1905 | $handle->push_write (...); |
2333 | $handle->push_write (...); |
1906 | $handle->on_drain (sub { |
2334 | $handle->on_drain (sub { |
1907 | warn "all data submitted to the kernel\n"; |
2335 | AE::log debug => "all data submitted to the kernel\n"; |
1908 | undef $handle; |
2336 | undef $handle; |
1909 | }); |
2337 | }); |
1910 | |
2338 | |
1911 | If you just want to queue some data and then signal EOF to the other side, |
2339 | If you just want to queue some data and then signal EOF to the other side, |
1912 | consider using C<< ->push_shutdown >> instead. |
2340 | consider using C<< ->push_shutdown >> instead. |
1913 | |
2341 | |
1914 | =item I want to contact a TLS/SSL server, I don't care about security. |
2342 | =item I want to contact a TLS/SSL server, I don't care about security. |
1915 | |
2343 | |
1916 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2344 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
1917 | simply connect to it and then create the AnyEvent::Handle with the C<tls> |
2345 | connect to it and then create the AnyEvent::Handle with the C<tls> |
1918 | parameter: |
2346 | parameter: |
1919 | |
2347 | |
1920 | tcp_connect $host, $port, sub { |
2348 | tcp_connect $host, $port, sub { |
1921 | my ($fh) = @_; |
2349 | my ($fh) = @_; |
1922 | |
2350 | |
… | |
… | |
2022 | |
2450 | |
2023 | =item * all members not documented here and not prefixed with an underscore |
2451 | =item * all members not documented here and not prefixed with an underscore |
2024 | are free to use in subclasses. |
2452 | are free to use in subclasses. |
2025 | |
2453 | |
2026 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2454 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2027 | member variables, but thats just life, at least it is documented. |
2455 | member variables, but that's just life. At least it is documented. |
2028 | |
2456 | |
2029 | =back |
2457 | =back |
2030 | |
2458 | |
2031 | =head1 AUTHOR |
2459 | =head1 AUTHOR |
2032 | |
2460 | |