1 | package AnyEvent::Handle; |
1 | package AnyEvent::Handle; |
2 | |
2 | |
3 | no warnings; |
3 | no warnings; |
4 | use strict; |
4 | use strict qw(subs vars); |
5 | |
5 | |
6 | use AnyEvent (); |
6 | use AnyEvent (); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
… | |
… | |
14 | |
14 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
16 | |
17 | =cut |
17 | =cut |
18 | |
18 | |
19 | our $VERSION = 4.1; |
19 | our $VERSION = 4.3; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
49 | |
49 | |
50 | This module is a helper module to make it easier to do event-based I/O on |
50 | This module is a helper module to make it easier to do event-based I/O on |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
52 | on sockets see L<AnyEvent::Util>. |
52 | on sockets see L<AnyEvent::Util>. |
53 | |
53 | |
|
|
54 | The L<AnyEvent::Intro> tutorial contains some well-documented |
|
|
55 | AnyEvent::Handle examples. |
|
|
56 | |
54 | In the following, when the documentation refers to of "bytes" then this |
57 | In the following, when the documentation refers to of "bytes" then this |
55 | means characters. As sysread and syswrite are used for all I/O, their |
58 | means characters. As sysread and syswrite are used for all I/O, their |
56 | treatment of characters applies to this module as well. |
59 | treatment of characters applies to this module as well. |
57 | |
60 | |
58 | All callbacks will be invoked with the handle object as their first |
61 | All callbacks will be invoked with the handle object as their first |
59 | argument. |
62 | argument. |
60 | |
63 | |
|
|
64 | =head2 SIGPIPE is not handled by this module |
|
|
65 | |
|
|
66 | SIGPIPE is not handled by this module, so one of the practical |
|
|
67 | requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} = |
|
|
68 | 'IGNORE'>). At least, this is highly recommend in a networked program: If |
|
|
69 | you use AnyEvent::Handle in a filter program (like sort), exiting on |
|
|
70 | SIGPIPE is probably the right thing to do. |
|
|
71 | |
61 | =head1 METHODS |
72 | =head1 METHODS |
62 | |
73 | |
63 | =over 4 |
74 | =over 4 |
64 | |
75 | |
65 | =item B<new (%args)> |
76 | =item B<new (%args)> |
… | |
… | |
70 | |
81 | |
71 | =item fh => $filehandle [MANDATORY] |
82 | =item fh => $filehandle [MANDATORY] |
72 | |
83 | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
84 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
85 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
86 | NOTE: The filehandle will be set to non-blocking mode (using |
76 | AnyEvent::Util::fh_nonblocking). |
87 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
88 | that mode. |
77 | |
89 | |
78 | =item on_eof => $cb->($handle) |
90 | =item on_eof => $cb->($handle) |
79 | |
91 | |
80 | Set the callback to be called when an end-of-file condition is detcted, |
92 | Set the callback to be called when an end-of-file condition is detected, |
81 | i.e. in the case of a socket, when the other side has closed the |
93 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
94 | connection cleanly. |
83 | |
95 | |
|
|
96 | For sockets, this just means that the other side has stopped sending data, |
|
|
97 | you can still try to write data, and, in fact, one can return from the eof |
|
|
98 | callback and continue writing data, as only the read part has been shut |
|
|
99 | down. |
|
|
100 | |
84 | While not mandatory, it is highly recommended to set an eof callback, |
101 | While not mandatory, it is I<highly> recommended to set an eof callback, |
85 | otherwise you might end up with a closed socket while you are still |
102 | otherwise you might end up with a closed socket while you are still |
86 | waiting for data. |
103 | waiting for data. |
|
|
104 | |
|
|
105 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
106 | set, then a fatal error will be raised with C<$!> set to <0>. |
87 | |
107 | |
88 | =item on_error => $cb->($handle, $fatal) |
108 | =item on_error => $cb->($handle, $fatal) |
89 | |
109 | |
90 | This is the error callback, which is called when, well, some error |
110 | This is the error callback, which is called when, well, some error |
91 | occured, such as not being able to resolve the hostname, failure to |
111 | occured, such as not being able to resolve the hostname, failure to |
92 | connect or a read error. |
112 | connect or a read error. |
93 | |
113 | |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
114 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
95 | fatal errors the handle object will be shut down and will not be |
115 | fatal errors the handle object will be shut down and will not be usable |
|
|
116 | (but you are free to look at the current C<< ->rbuf >>). Examples of fatal |
|
|
117 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
118 | (C<EPIPE>) or I/O errors. |
|
|
119 | |
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
120 | Non-fatal errors can be retried by simply returning, but it is recommended |
97 | recommended to simply ignore this parameter and instead abondon the handle |
121 | to simply ignore this parameter and instead abondon the handle object |
98 | object when this callback is invoked. |
122 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
123 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
99 | |
124 | |
100 | On callback entrance, the value of C<$!> contains the operating system |
125 | On callback entrance, the value of C<$!> contains the operating system |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
126 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
102 | |
127 | |
103 | While not mandatory, it is I<highly> recommended to set this callback, as |
128 | While not mandatory, it is I<highly> recommended to set this callback, as |
… | |
… | |
105 | C<croak>. |
130 | C<croak>. |
106 | |
131 | |
107 | =item on_read => $cb->($handle) |
132 | =item on_read => $cb->($handle) |
108 | |
133 | |
109 | This sets the default read callback, which is called when data arrives |
134 | This sets the default read callback, which is called when data arrives |
110 | and no read request is in the queue. |
135 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
136 | callback will only be called when at least one octet of data is in the |
|
|
137 | read buffer). |
111 | |
138 | |
112 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
139 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
113 | method or access the C<$handle->{rbuf}> member directly. |
140 | method or access the C<$handle->{rbuf}> member directly. |
114 | |
141 | |
115 | When an EOF condition is detected then AnyEvent::Handle will first try to |
142 | When an EOF condition is detected then AnyEvent::Handle will first try to |
… | |
… | |
122 | This sets the callback that is called when the write buffer becomes empty |
149 | This sets the callback that is called when the write buffer becomes empty |
123 | (or when the callback is set and the buffer is empty already). |
150 | (or when the callback is set and the buffer is empty already). |
124 | |
151 | |
125 | To append to the write buffer, use the C<< ->push_write >> method. |
152 | To append to the write buffer, use the C<< ->push_write >> method. |
126 | |
153 | |
|
|
154 | This callback is useful when you don't want to put all of your write data |
|
|
155 | into the queue at once, for example, when you want to write the contents |
|
|
156 | of some file to the socket you might not want to read the whole file into |
|
|
157 | memory and push it into the queue, but instead only read more data from |
|
|
158 | the file when the write queue becomes empty. |
|
|
159 | |
127 | =item timeout => $fractional_seconds |
160 | =item timeout => $fractional_seconds |
128 | |
161 | |
129 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
162 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
130 | seconds pass without a successful read or write on the underlying file |
163 | seconds pass without a successful read or write on the underlying file |
131 | handle, the C<on_timeout> callback will be invoked (and if that one is |
164 | handle, the C<on_timeout> callback will be invoked (and if that one is |
132 | missing, an C<ETIMEDOUT> error will be raised). |
165 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
133 | |
166 | |
134 | Note that timeout processing is also active when you currently do not have |
167 | Note that timeout processing is also active when you currently do not have |
135 | any outstanding read or write requests: If you plan to keep the connection |
168 | any outstanding read or write requests: If you plan to keep the connection |
136 | idle then you should disable the timout temporarily or ignore the timeout |
169 | idle then you should disable the timout temporarily or ignore the timeout |
137 | in the C<on_timeout> callback. |
170 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
|
|
171 | restart the timeout. |
138 | |
172 | |
139 | Zero (the default) disables this timeout. |
173 | Zero (the default) disables this timeout. |
140 | |
174 | |
141 | =item on_timeout => $cb->($handle) |
175 | =item on_timeout => $cb->($handle) |
142 | |
176 | |
… | |
… | |
146 | |
180 | |
147 | =item rbuf_max => <bytes> |
181 | =item rbuf_max => <bytes> |
148 | |
182 | |
149 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
183 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
150 | when the read buffer ever (strictly) exceeds this size. This is useful to |
184 | when the read buffer ever (strictly) exceeds this size. This is useful to |
151 | avoid denial-of-service attacks. |
185 | avoid some forms of denial-of-service attacks. |
152 | |
186 | |
153 | For example, a server accepting connections from untrusted sources should |
187 | For example, a server accepting connections from untrusted sources should |
154 | be configured to accept only so-and-so much data that it cannot act on |
188 | be configured to accept only so-and-so much data that it cannot act on |
155 | (for example, when expecting a line, an attacker could send an unlimited |
189 | (for example, when expecting a line, an attacker could send an unlimited |
156 | amount of data without a callback ever being called as long as the line |
190 | amount of data without a callback ever being called as long as the line |
157 | isn't finished). |
191 | isn't finished). |
158 | |
192 | |
|
|
193 | =item autocork => <boolean> |
|
|
194 | |
|
|
195 | When disabled (the default), then C<push_write> will try to immediately |
|
|
196 | write the data to the handle, if possible. This avoids having to register |
|
|
197 | a write watcher and wait for the next event loop iteration, but can |
|
|
198 | be inefficient if you write multiple small chunks (on the wire, this |
|
|
199 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
|
|
200 | C<no_delay>, but this option can save costly syscalls). |
|
|
201 | |
|
|
202 | When enabled, then writes will always be queued till the next event loop |
|
|
203 | iteration. This is efficient when you do many small writes per iteration, |
|
|
204 | but less efficient when you do a single write only per iteration (or when |
|
|
205 | the write buffer often is full). It also increases write latency. |
|
|
206 | |
|
|
207 | =item no_delay => <boolean> |
|
|
208 | |
|
|
209 | When doing small writes on sockets, your operating system kernel might |
|
|
210 | wait a bit for more data before actually sending it out. This is called |
|
|
211 | the Nagle algorithm, and usually it is beneficial. |
|
|
212 | |
|
|
213 | In some situations you want as low a delay as possible, which can be |
|
|
214 | accomplishd by setting this option to a true value. |
|
|
215 | |
|
|
216 | The default is your opertaing system's default behaviour (most likely |
|
|
217 | enabled), this option explicitly enables or disables it, if possible. |
|
|
218 | |
159 | =item read_size => <bytes> |
219 | =item read_size => <bytes> |
160 | |
220 | |
161 | The default read block size (the amount of bytes this module will try to read |
221 | The default read block size (the amount of bytes this module will |
162 | during each (loop iteration). Default: C<8192>. |
222 | try to read during each loop iteration, which affects memory |
|
|
223 | requirements). Default: C<8192>. |
163 | |
224 | |
164 | =item low_water_mark => <bytes> |
225 | =item low_water_mark => <bytes> |
165 | |
226 | |
166 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
227 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
167 | buffer: If the write reaches this size or gets even samller it is |
228 | buffer: If the write reaches this size or gets even samller it is |
168 | considered empty. |
229 | considered empty. |
169 | |
230 | |
|
|
231 | Sometimes it can be beneficial (for performance reasons) to add data to |
|
|
232 | the write buffer before it is fully drained, but this is a rare case, as |
|
|
233 | the operating system kernel usually buffers data as well, so the default |
|
|
234 | is good in almost all cases. |
|
|
235 | |
|
|
236 | =item linger => <seconds> |
|
|
237 | |
|
|
238 | If non-zero (default: C<3600>), then the destructor of the |
|
|
239 | AnyEvent::Handle object will check whether there is still outstanding |
|
|
240 | write data and will install a watcher that will write this data to the |
|
|
241 | socket. No errors will be reported (this mostly matches how the operating |
|
|
242 | system treats outstanding data at socket close time). |
|
|
243 | |
|
|
244 | This will not work for partial TLS data that could not be encoded |
|
|
245 | yet. This data will be lost. Calling the C<stoptls> method in time might |
|
|
246 | help. |
|
|
247 | |
170 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
248 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
171 | |
249 | |
172 | When this parameter is given, it enables TLS (SSL) mode, that means it |
250 | When this parameter is given, it enables TLS (SSL) mode, that means |
173 | will start making tls handshake and will transparently encrypt/decrypt |
251 | AnyEvent will start a TLS handshake as soon as the conenction has been |
174 | data. |
252 | established and will transparently encrypt/decrypt data afterwards. |
175 | |
253 | |
176 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
254 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
177 | automatically when you try to create a TLS handle). |
255 | automatically when you try to create a TLS handle): this module doesn't |
|
|
256 | have a dependency on that module, so if your module requires it, you have |
|
|
257 | to add the dependency yourself. |
178 | |
258 | |
179 | For the TLS server side, use C<accept>, and for the TLS client side of a |
259 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
180 | connection, use C<connect> mode. |
260 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
261 | mode. |
181 | |
262 | |
182 | You can also provide your own TLS connection object, but you have |
263 | You can also provide your own TLS connection object, but you have |
183 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
264 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
184 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
265 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
185 | AnyEvent::Handle. |
266 | AnyEvent::Handle. |
186 | |
267 | |
187 | See the C<starttls> method if you need to start TLs negotiation later. |
268 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
188 | |
269 | |
189 | =item tls_ctx => $ssl_ctx |
270 | =item tls_ctx => $ssl_ctx |
190 | |
271 | |
191 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
272 | Use the given C<Net::SSLeay::CTX> object to create the new TLS connection |
192 | (unless a connection object was specified directly). If this parameter is |
273 | (unless a connection object was specified directly). If this parameter is |
193 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
274 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
194 | |
275 | |
195 | =item json => JSON or JSON::XS object |
276 | =item json => JSON or JSON::XS object |
196 | |
277 | |
197 | This is the json coder object used by the C<json> read and write types. |
278 | This is the json coder object used by the C<json> read and write types. |
198 | |
279 | |
199 | If you don't supply it, then AnyEvent::Handle will create and use a |
280 | If you don't supply it, then AnyEvent::Handle will create and use a |
200 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
281 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
282 | texts. |
201 | |
283 | |
202 | Note that you are responsible to depend on the JSON module if you want to |
284 | Note that you are responsible to depend on the JSON module if you want to |
203 | use this functionality, as AnyEvent does not have a dependency itself. |
285 | use this functionality, as AnyEvent does not have a dependency itself. |
204 | |
|
|
205 | =item filter_r => $cb |
|
|
206 | |
|
|
207 | =item filter_w => $cb |
|
|
208 | |
|
|
209 | These exist, but are undocumented at this time. |
|
|
210 | |
286 | |
211 | =back |
287 | =back |
212 | |
288 | |
213 | =cut |
289 | =cut |
214 | |
290 | |
… | |
… | |
224 | if ($self->{tls}) { |
300 | if ($self->{tls}) { |
225 | require Net::SSLeay; |
301 | require Net::SSLeay; |
226 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
302 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
227 | } |
303 | } |
228 | |
304 | |
229 | # $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop |
|
|
230 | # $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop |
|
|
231 | # $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop |
|
|
232 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
|
|
233 | |
|
|
234 | $self->{_activity} = AnyEvent->now; |
305 | $self->{_activity} = AnyEvent->now; |
235 | $self->_timeout; |
306 | $self->_timeout; |
236 | |
307 | |
|
|
308 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
|
|
309 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
310 | |
237 | $self->start_read; |
311 | $self->start_read |
|
|
312 | if $self->{on_read}; |
238 | |
313 | |
239 | $self |
314 | $self |
240 | } |
315 | } |
241 | |
316 | |
242 | sub _shutdown { |
317 | sub _shutdown { |
… | |
… | |
245 | delete $self->{_tw}; |
320 | delete $self->{_tw}; |
246 | delete $self->{_rw}; |
321 | delete $self->{_rw}; |
247 | delete $self->{_ww}; |
322 | delete $self->{_ww}; |
248 | delete $self->{fh}; |
323 | delete $self->{fh}; |
249 | |
324 | |
250 | $self->stoptls; |
325 | &_freetls; |
|
|
326 | |
|
|
327 | delete $self->{on_read}; |
|
|
328 | delete $self->{_queue}; |
251 | } |
329 | } |
252 | |
330 | |
253 | sub _error { |
331 | sub _error { |
254 | my ($self, $errno, $fatal) = @_; |
332 | my ($self, $errno, $fatal) = @_; |
255 | |
333 | |
… | |
… | |
265 | } |
343 | } |
266 | } |
344 | } |
267 | |
345 | |
268 | =item $fh = $handle->fh |
346 | =item $fh = $handle->fh |
269 | |
347 | |
270 | This method returns the file handle of the L<AnyEvent::Handle> object. |
348 | This method returns the file handle used to create the L<AnyEvent::Handle> object. |
271 | |
349 | |
272 | =cut |
350 | =cut |
273 | |
351 | |
274 | sub fh { $_[0]{fh} } |
352 | sub fh { $_[0]{fh} } |
275 | |
353 | |
… | |
… | |
293 | $_[0]{on_eof} = $_[1]; |
371 | $_[0]{on_eof} = $_[1]; |
294 | } |
372 | } |
295 | |
373 | |
296 | =item $handle->on_timeout ($cb) |
374 | =item $handle->on_timeout ($cb) |
297 | |
375 | |
298 | Replace the current C<on_timeout> callback, or disables the callback |
376 | Replace the current C<on_timeout> callback, or disables the callback (but |
299 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
377 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
300 | argument. |
378 | argument and method. |
301 | |
379 | |
302 | =cut |
380 | =cut |
303 | |
381 | |
304 | sub on_timeout { |
382 | sub on_timeout { |
305 | $_[0]{on_timeout} = $_[1]; |
383 | $_[0]{on_timeout} = $_[1]; |
|
|
384 | } |
|
|
385 | |
|
|
386 | =item $handle->autocork ($boolean) |
|
|
387 | |
|
|
388 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
389 | constructor argument). |
|
|
390 | |
|
|
391 | =cut |
|
|
392 | |
|
|
393 | =item $handle->no_delay ($boolean) |
|
|
394 | |
|
|
395 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
396 | the same name for details). |
|
|
397 | |
|
|
398 | =cut |
|
|
399 | |
|
|
400 | sub no_delay { |
|
|
401 | $_[0]{no_delay} = $_[1]; |
|
|
402 | |
|
|
403 | eval { |
|
|
404 | local $SIG{__DIE__}; |
|
|
405 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
406 | }; |
306 | } |
407 | } |
307 | |
408 | |
308 | ############################################################################# |
409 | ############################################################################# |
309 | |
410 | |
310 | =item $handle->timeout ($seconds) |
411 | =item $handle->timeout ($seconds) |
… | |
… | |
339 | $self->{on_timeout}($self); |
440 | $self->{on_timeout}($self); |
340 | } else { |
441 | } else { |
341 | $self->_error (&Errno::ETIMEDOUT); |
442 | $self->_error (&Errno::ETIMEDOUT); |
342 | } |
443 | } |
343 | |
444 | |
344 | # callbakx could have changed timeout value, optimise |
445 | # callback could have changed timeout value, optimise |
345 | return unless $self->{timeout}; |
446 | return unless $self->{timeout}; |
346 | |
447 | |
347 | # calculate new after |
448 | # calculate new after |
348 | $after = $self->{timeout}; |
449 | $after = $self->{timeout}; |
349 | } |
450 | } |
350 | |
451 | |
351 | Scalar::Util::weaken $self; |
452 | Scalar::Util::weaken $self; |
|
|
453 | return unless $self; # ->error could have destroyed $self |
352 | |
454 | |
353 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
455 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
354 | delete $self->{_tw}; |
456 | delete $self->{_tw}; |
355 | $self->_timeout; |
457 | $self->_timeout; |
356 | }); |
458 | }); |
… | |
… | |
387 | my ($self, $cb) = @_; |
489 | my ($self, $cb) = @_; |
388 | |
490 | |
389 | $self->{on_drain} = $cb; |
491 | $self->{on_drain} = $cb; |
390 | |
492 | |
391 | $cb->($self) |
493 | $cb->($self) |
392 | if $cb && $self->{low_water_mark} >= length $self->{wbuf}; |
494 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
393 | } |
495 | } |
394 | |
496 | |
395 | =item $handle->push_write ($data) |
497 | =item $handle->push_write ($data) |
396 | |
498 | |
397 | Queues the given scalar to be written. You can push as much data as you |
499 | Queues the given scalar to be written. You can push as much data as you |
… | |
… | |
414 | substr $self->{wbuf}, 0, $len, ""; |
516 | substr $self->{wbuf}, 0, $len, ""; |
415 | |
517 | |
416 | $self->{_activity} = AnyEvent->now; |
518 | $self->{_activity} = AnyEvent->now; |
417 | |
519 | |
418 | $self->{on_drain}($self) |
520 | $self->{on_drain}($self) |
419 | if $self->{low_water_mark} >= length $self->{wbuf} |
521 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
420 | && $self->{on_drain}; |
522 | && $self->{on_drain}; |
421 | |
523 | |
422 | delete $self->{_ww} unless length $self->{wbuf}; |
524 | delete $self->{_ww} unless length $self->{wbuf}; |
423 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
525 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
424 | $self->_error ($!, 1); |
526 | $self->_error ($!, 1); |
425 | } |
527 | } |
426 | }; |
528 | }; |
427 | |
529 | |
428 | # try to write data immediately |
530 | # try to write data immediately |
429 | $cb->(); |
531 | $cb->() unless $self->{autocork}; |
430 | |
532 | |
431 | # if still data left in wbuf, we need to poll |
533 | # if still data left in wbuf, we need to poll |
432 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
534 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
433 | if length $self->{wbuf}; |
535 | if length $self->{wbuf}; |
434 | }; |
536 | }; |
… | |
… | |
448 | |
550 | |
449 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
551 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
450 | ->($self, @_); |
552 | ->($self, @_); |
451 | } |
553 | } |
452 | |
554 | |
453 | if ($self->{filter_w}) { |
555 | if ($self->{tls}) { |
454 | $self->{filter_w}($self, \$_[0]); |
556 | $self->{_tls_wbuf} .= $_[0]; |
|
|
557 | &_dotls ($self); |
455 | } else { |
558 | } else { |
456 | $self->{wbuf} .= $_[0]; |
559 | $self->{wbuf} .= $_[0]; |
457 | $self->_drain_wbuf; |
560 | $self->_drain_wbuf; |
458 | } |
561 | } |
459 | } |
562 | } |
… | |
… | |
477 | |
580 | |
478 | register_write_type netstring => sub { |
581 | register_write_type netstring => sub { |
479 | my ($self, $string) = @_; |
582 | my ($self, $string) = @_; |
480 | |
583 | |
481 | sprintf "%d:%s,", (length $string), $string |
584 | sprintf "%d:%s,", (length $string), $string |
|
|
585 | }; |
|
|
586 | |
|
|
587 | =item packstring => $format, $data |
|
|
588 | |
|
|
589 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
590 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
591 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
592 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
593 | |
|
|
594 | =cut |
|
|
595 | |
|
|
596 | register_write_type packstring => sub { |
|
|
597 | my ($self, $format, $string) = @_; |
|
|
598 | |
|
|
599 | pack "$format/a*", $string |
482 | }; |
600 | }; |
483 | |
601 | |
484 | =item json => $array_or_hashref |
602 | =item json => $array_or_hashref |
485 | |
603 | |
486 | Encodes the given hash or array reference into a JSON object. Unless you |
604 | Encodes the given hash or array reference into a JSON object. Unless you |
… | |
… | |
520 | |
638 | |
521 | $self->{json} ? $self->{json}->encode ($ref) |
639 | $self->{json} ? $self->{json}->encode ($ref) |
522 | : JSON::encode_json ($ref) |
640 | : JSON::encode_json ($ref) |
523 | }; |
641 | }; |
524 | |
642 | |
|
|
643 | =item storable => $reference |
|
|
644 | |
|
|
645 | Freezes the given reference using L<Storable> and writes it to the |
|
|
646 | handle. Uses the C<nfreeze> format. |
|
|
647 | |
|
|
648 | =cut |
|
|
649 | |
|
|
650 | register_write_type storable => sub { |
|
|
651 | my ($self, $ref) = @_; |
|
|
652 | |
|
|
653 | require Storable; |
|
|
654 | |
|
|
655 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
656 | }; |
|
|
657 | |
|
|
658 | =back |
|
|
659 | |
525 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
660 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
526 | |
661 | |
527 | This function (not method) lets you add your own types to C<push_write>. |
662 | This function (not method) lets you add your own types to C<push_write>. |
528 | Whenever the given C<type> is used, C<push_write> will invoke the code |
663 | Whenever the given C<type> is used, C<push_write> will invoke the code |
529 | reference with the handle object and the remaining arguments. |
664 | reference with the handle object and the remaining arguments. |
… | |
… | |
532 | be appended to the write buffer. |
667 | be appended to the write buffer. |
533 | |
668 | |
534 | Note that this is a function, and all types registered this way will be |
669 | Note that this is a function, and all types registered this way will be |
535 | global, so try to use unique names. |
670 | global, so try to use unique names. |
536 | |
671 | |
537 | =back |
|
|
538 | |
|
|
539 | =cut |
672 | =cut |
540 | |
673 | |
541 | ############################################################################# |
674 | ############################################################################# |
542 | |
675 | |
543 | =back |
676 | =back |
… | |
… | |
551 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
684 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
552 | a queue. |
685 | a queue. |
553 | |
686 | |
554 | In the simple case, you just install an C<on_read> callback and whenever |
687 | In the simple case, you just install an C<on_read> callback and whenever |
555 | new data arrives, it will be called. You can then remove some data (if |
688 | new data arrives, it will be called. You can then remove some data (if |
556 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
689 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
557 | or not. |
690 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
691 | partial message has been received so far). |
558 | |
692 | |
559 | In the more complex case, you want to queue multiple callbacks. In this |
693 | In the more complex case, you want to queue multiple callbacks. In this |
560 | case, AnyEvent::Handle will call the first queued callback each time new |
694 | case, AnyEvent::Handle will call the first queued callback each time new |
561 | data arrives and removes it when it has done its job (see C<push_read>, |
695 | data arrives (also the first time it is queued) and removes it when it has |
562 | below). |
696 | done its job (see C<push_read>, below). |
563 | |
697 | |
564 | This way you can, for example, push three line-reads, followed by reading |
698 | This way you can, for example, push three line-reads, followed by reading |
565 | a chunk of data, and AnyEvent::Handle will execute them in order. |
699 | a chunk of data, and AnyEvent::Handle will execute them in order. |
566 | |
700 | |
567 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
701 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
… | |
… | |
580 | # handle xml |
714 | # handle xml |
581 | }); |
715 | }); |
582 | }); |
716 | }); |
583 | }); |
717 | }); |
584 | |
718 | |
585 | Example 2: Implement a client for a protocol that replies either with |
719 | Example 2: Implement a client for a protocol that replies either with "OK" |
586 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
720 | and another line or "ERROR" for the first request that is sent, and 64 |
587 | second request. Due tot he availability of a full queue, we can just |
721 | bytes for the second request. Due to the availability of a queue, we can |
588 | pipeline sending both requests and manipulate the queue as necessary in |
722 | just pipeline sending both requests and manipulate the queue as necessary |
589 | the callbacks: |
723 | in the callbacks. |
590 | |
724 | |
591 | # request one |
725 | When the first callback is called and sees an "OK" response, it will |
|
|
726 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
727 | 64-byte chunk callback. |
|
|
728 | |
|
|
729 | # request one, returns either "OK + extra line" or "ERROR" |
592 | $handle->push_write ("request 1\015\012"); |
730 | $handle->push_write ("request 1\015\012"); |
593 | |
731 | |
594 | # we expect "ERROR" or "OK" as response, so push a line read |
732 | # we expect "ERROR" or "OK" as response, so push a line read |
595 | $handle->push_read (line => sub { |
733 | $handle->push_read (line => sub { |
596 | # if we got an "OK", we have to _prepend_ another line, |
734 | # if we got an "OK", we have to _prepend_ another line, |
… | |
… | |
603 | ... |
741 | ... |
604 | }); |
742 | }); |
605 | } |
743 | } |
606 | }); |
744 | }); |
607 | |
745 | |
608 | # request two |
746 | # request two, simply returns 64 octets |
609 | $handle->push_write ("request 2\015\012"); |
747 | $handle->push_write ("request 2\015\012"); |
610 | |
748 | |
611 | # simply read 64 bytes, always |
749 | # simply read 64 bytes, always |
612 | $handle->push_read (chunk => 64, sub { |
750 | $handle->push_read (chunk => 64, sub { |
613 | my $response = $_[1]; |
751 | my $response = $_[1]; |
… | |
… | |
619 | =cut |
757 | =cut |
620 | |
758 | |
621 | sub _drain_rbuf { |
759 | sub _drain_rbuf { |
622 | my ($self) = @_; |
760 | my ($self) = @_; |
623 | |
761 | |
|
|
762 | local $self->{_in_drain} = 1; |
|
|
763 | |
624 | if ( |
764 | if ( |
625 | defined $self->{rbuf_max} |
765 | defined $self->{rbuf_max} |
626 | && $self->{rbuf_max} < length $self->{rbuf} |
766 | && $self->{rbuf_max} < length $self->{rbuf} |
627 | ) { |
767 | ) { |
628 | return $self->_error (&Errno::ENOSPC, 1); |
768 | $self->_error (&Errno::ENOSPC, 1), return; |
629 | } |
769 | } |
630 | |
770 | |
631 | return if $self->{in_drain}; |
771 | while () { |
632 | local $self->{in_drain} = 1; |
|
|
633 | |
|
|
634 | while (my $len = length $self->{rbuf}) { |
772 | my $len = length $self->{rbuf}; |
635 | no strict 'refs'; |
773 | |
636 | if (my $cb = shift @{ $self->{_queue} }) { |
774 | if (my $cb = shift @{ $self->{_queue} }) { |
637 | unless ($cb->($self)) { |
775 | unless ($cb->($self)) { |
638 | if ($self->{_eof}) { |
776 | if ($self->{_eof}) { |
639 | # no progress can be made (not enough data and no data forthcoming) |
777 | # no progress can be made (not enough data and no data forthcoming) |
640 | return $self->_error (&Errno::EPIPE, 1); |
778 | $self->_error (&Errno::EPIPE, 1), return; |
641 | } |
779 | } |
642 | |
780 | |
643 | unshift @{ $self->{_queue} }, $cb; |
781 | unshift @{ $self->{_queue} }, $cb; |
644 | return; |
782 | last; |
645 | } |
783 | } |
646 | } elsif ($self->{on_read}) { |
784 | } elsif ($self->{on_read}) { |
|
|
785 | last unless $len; |
|
|
786 | |
647 | $self->{on_read}($self); |
787 | $self->{on_read}($self); |
648 | |
788 | |
649 | if ( |
789 | if ( |
650 | $self->{_eof} # if no further data will arrive |
|
|
651 | && $len == length $self->{rbuf} # and no data has been consumed |
790 | $len == length $self->{rbuf} # if no data has been consumed |
652 | && !@{ $self->{_queue} } # and the queue is still empty |
791 | && !@{ $self->{_queue} } # and the queue is still empty |
653 | && $self->{on_read} # and we still want to read data |
792 | && $self->{on_read} # but we still have on_read |
654 | ) { |
793 | ) { |
|
|
794 | # no further data will arrive |
655 | # then no progress can be made |
795 | # so no progress can be made |
656 | return $self->_error (&Errno::EPIPE, 1); |
796 | $self->_error (&Errno::EPIPE, 1), return |
|
|
797 | if $self->{_eof}; |
|
|
798 | |
|
|
799 | last; # more data might arrive |
657 | } |
800 | } |
658 | } else { |
801 | } else { |
659 | # read side becomes idle |
802 | # read side becomes idle |
660 | delete $self->{_rw}; |
803 | delete $self->{_rw} unless $self->{tls}; |
661 | return; |
804 | last; |
662 | } |
805 | } |
663 | } |
806 | } |
664 | |
807 | |
|
|
808 | if ($self->{_eof}) { |
|
|
809 | if ($self->{on_eof}) { |
665 | $self->{on_eof}($self) |
810 | $self->{on_eof}($self) |
666 | if $self->{_eof} && $self->{on_eof}; |
811 | } else { |
|
|
812 | $self->_error (0, 1); |
|
|
813 | } |
|
|
814 | } |
|
|
815 | |
|
|
816 | # may need to restart read watcher |
|
|
817 | unless ($self->{_rw}) { |
|
|
818 | $self->start_read |
|
|
819 | if $self->{on_read} || @{ $self->{_queue} }; |
|
|
820 | } |
667 | } |
821 | } |
668 | |
822 | |
669 | =item $handle->on_read ($cb) |
823 | =item $handle->on_read ($cb) |
670 | |
824 | |
671 | This replaces the currently set C<on_read> callback, or clears it (when |
825 | This replaces the currently set C<on_read> callback, or clears it (when |
… | |
… | |
676 | |
830 | |
677 | sub on_read { |
831 | sub on_read { |
678 | my ($self, $cb) = @_; |
832 | my ($self, $cb) = @_; |
679 | |
833 | |
680 | $self->{on_read} = $cb; |
834 | $self->{on_read} = $cb; |
|
|
835 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
681 | } |
836 | } |
682 | |
837 | |
683 | =item $handle->rbuf |
838 | =item $handle->rbuf |
684 | |
839 | |
685 | Returns the read buffer (as a modifiable lvalue). |
840 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
734 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
889 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
735 | ->($self, $cb, @_); |
890 | ->($self, $cb, @_); |
736 | } |
891 | } |
737 | |
892 | |
738 | push @{ $self->{_queue} }, $cb; |
893 | push @{ $self->{_queue} }, $cb; |
739 | $self->_drain_rbuf; |
894 | $self->_drain_rbuf unless $self->{_in_drain}; |
740 | } |
895 | } |
741 | |
896 | |
742 | sub unshift_read { |
897 | sub unshift_read { |
743 | my $self = shift; |
898 | my $self = shift; |
744 | my $cb = pop; |
899 | my $cb = pop; |
… | |
… | |
750 | ->($self, $cb, @_); |
905 | ->($self, $cb, @_); |
751 | } |
906 | } |
752 | |
907 | |
753 | |
908 | |
754 | unshift @{ $self->{_queue} }, $cb; |
909 | unshift @{ $self->{_queue} }, $cb; |
755 | $self->_drain_rbuf; |
910 | $self->_drain_rbuf unless $self->{_in_drain}; |
756 | } |
911 | } |
757 | |
912 | |
758 | =item $handle->push_read (type => @args, $cb) |
913 | =item $handle->push_read (type => @args, $cb) |
759 | |
914 | |
760 | =item $handle->unshift_read (type => @args, $cb) |
915 | =item $handle->unshift_read (type => @args, $cb) |
… | |
… | |
790 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
945 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
791 | 1 |
946 | 1 |
792 | } |
947 | } |
793 | }; |
948 | }; |
794 | |
949 | |
795 | # compatibility with older API |
|
|
796 | sub push_read_chunk { |
|
|
797 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
798 | } |
|
|
799 | |
|
|
800 | sub unshift_read_chunk { |
|
|
801 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
802 | } |
|
|
803 | |
|
|
804 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
950 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
805 | |
951 | |
806 | The callback will be called only once a full line (including the end of |
952 | The callback will be called only once a full line (including the end of |
807 | line marker, C<$eol>) has been read. This line (excluding the end of line |
953 | line marker, C<$eol>) has been read. This line (excluding the end of line |
808 | marker) will be passed to the callback as second argument (C<$line>), and |
954 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
823 | =cut |
969 | =cut |
824 | |
970 | |
825 | register_read_type line => sub { |
971 | register_read_type line => sub { |
826 | my ($self, $cb, $eol) = @_; |
972 | my ($self, $cb, $eol) = @_; |
827 | |
973 | |
828 | $eol = qr|(\015?\012)| if @_ < 3; |
974 | if (@_ < 3) { |
829 | $eol = quotemeta $eol unless ref $eol; |
975 | # this is more than twice as fast as the generic code below |
830 | $eol = qr|^(.*?)($eol)|s; |
|
|
831 | |
|
|
832 | sub { |
976 | sub { |
833 | $_[0]{rbuf} =~ s/$eol// or return; |
977 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
834 | |
978 | |
835 | $cb->($_[0], $1, $2); |
979 | $cb->($_[0], $1, $2); |
836 | 1 |
|
|
837 | } |
|
|
838 | }; |
|
|
839 | |
|
|
840 | # compatibility with older API |
|
|
841 | sub push_read_line { |
|
|
842 | my $self = shift; |
|
|
843 | $self->push_read (line => @_); |
|
|
844 | } |
|
|
845 | |
|
|
846 | sub unshift_read_line { |
|
|
847 | my $self = shift; |
|
|
848 | $self->unshift_read (line => @_); |
|
|
849 | } |
|
|
850 | |
|
|
851 | =item netstring => $cb->($handle, $string) |
|
|
852 | |
|
|
853 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
854 | |
|
|
855 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
856 | |
|
|
857 | =cut |
|
|
858 | |
|
|
859 | register_read_type netstring => sub { |
|
|
860 | my ($self, $cb) = @_; |
|
|
861 | |
|
|
862 | sub { |
|
|
863 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
864 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
865 | $self->_error (&Errno::EBADMSG); |
|
|
866 | } |
980 | 1 |
867 | return; |
|
|
868 | } |
981 | } |
|
|
982 | } else { |
|
|
983 | $eol = quotemeta $eol unless ref $eol; |
|
|
984 | $eol = qr|^(.*?)($eol)|s; |
869 | |
985 | |
870 | my $len = $1; |
986 | sub { |
|
|
987 | $_[0]{rbuf} =~ s/$eol// or return; |
871 | |
988 | |
872 | $self->unshift_read (chunk => $len, sub { |
989 | $cb->($_[0], $1, $2); |
873 | my $string = $_[1]; |
|
|
874 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
875 | if ($_[1] eq ",") { |
|
|
876 | $cb->($_[0], $string); |
|
|
877 | } else { |
|
|
878 | $self->_error (&Errno::EBADMSG); |
|
|
879 | } |
|
|
880 | }); |
990 | 1 |
881 | }); |
991 | } |
882 | |
|
|
883 | 1 |
|
|
884 | } |
992 | } |
885 | }; |
993 | }; |
886 | |
994 | |
887 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
995 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
888 | |
996 | |
… | |
… | |
952 | |
1060 | |
953 | () |
1061 | () |
954 | } |
1062 | } |
955 | }; |
1063 | }; |
956 | |
1064 | |
|
|
1065 | =item netstring => $cb->($handle, $string) |
|
|
1066 | |
|
|
1067 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
1068 | |
|
|
1069 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
1070 | |
|
|
1071 | =cut |
|
|
1072 | |
|
|
1073 | register_read_type netstring => sub { |
|
|
1074 | my ($self, $cb) = @_; |
|
|
1075 | |
|
|
1076 | sub { |
|
|
1077 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
1078 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
1079 | $self->_error (&Errno::EBADMSG); |
|
|
1080 | } |
|
|
1081 | return; |
|
|
1082 | } |
|
|
1083 | |
|
|
1084 | my $len = $1; |
|
|
1085 | |
|
|
1086 | $self->unshift_read (chunk => $len, sub { |
|
|
1087 | my $string = $_[1]; |
|
|
1088 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
1089 | if ($_[1] eq ",") { |
|
|
1090 | $cb->($_[0], $string); |
|
|
1091 | } else { |
|
|
1092 | $self->_error (&Errno::EBADMSG); |
|
|
1093 | } |
|
|
1094 | }); |
|
|
1095 | }); |
|
|
1096 | |
|
|
1097 | 1 |
|
|
1098 | } |
|
|
1099 | }; |
|
|
1100 | |
|
|
1101 | =item packstring => $format, $cb->($handle, $string) |
|
|
1102 | |
|
|
1103 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1104 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1105 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1106 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1107 | |
|
|
1108 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
1109 | |
|
|
1110 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1111 | format (very efficient). |
|
|
1112 | |
|
|
1113 | $handle->push_read (packstring => "w", sub { |
|
|
1114 | my ($handle, $data) = @_; |
|
|
1115 | }); |
|
|
1116 | |
|
|
1117 | =cut |
|
|
1118 | |
|
|
1119 | register_read_type packstring => sub { |
|
|
1120 | my ($self, $cb, $format) = @_; |
|
|
1121 | |
|
|
1122 | sub { |
|
|
1123 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1124 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
|
|
1125 | or return; |
|
|
1126 | |
|
|
1127 | $format = length pack $format, $len; |
|
|
1128 | |
|
|
1129 | # bypass unshift if we already have the remaining chunk |
|
|
1130 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1131 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1132 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1133 | $cb->($_[0], $data); |
|
|
1134 | } else { |
|
|
1135 | # remove prefix |
|
|
1136 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1137 | |
|
|
1138 | # read remaining chunk |
|
|
1139 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1140 | } |
|
|
1141 | |
|
|
1142 | 1 |
|
|
1143 | } |
|
|
1144 | }; |
|
|
1145 | |
957 | =item json => $cb->($handle, $hash_or_arrayref) |
1146 | =item json => $cb->($handle, $hash_or_arrayref) |
958 | |
1147 | |
959 | Reads a JSON object or array, decodes it and passes it to the callback. |
1148 | Reads a JSON object or array, decodes it and passes it to the callback. |
960 | |
1149 | |
961 | If a C<json> object was passed to the constructor, then that will be used |
1150 | If a C<json> object was passed to the constructor, then that will be used |
… | |
… | |
971 | the C<json> write type description, above, for an actual example. |
1160 | the C<json> write type description, above, for an actual example. |
972 | |
1161 | |
973 | =cut |
1162 | =cut |
974 | |
1163 | |
975 | register_read_type json => sub { |
1164 | register_read_type json => sub { |
976 | my ($self, $cb, $accept, $reject, $skip) = @_; |
1165 | my ($self, $cb) = @_; |
977 | |
1166 | |
978 | require JSON; |
1167 | require JSON; |
979 | |
1168 | |
980 | my $data; |
1169 | my $data; |
981 | my $rbuf = \$self->{rbuf}; |
1170 | my $rbuf = \$self->{rbuf}; |
… | |
… | |
996 | () |
1185 | () |
997 | } |
1186 | } |
998 | } |
1187 | } |
999 | }; |
1188 | }; |
1000 | |
1189 | |
|
|
1190 | =item storable => $cb->($handle, $ref) |
|
|
1191 | |
|
|
1192 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1193 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1194 | data). |
|
|
1195 | |
|
|
1196 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1197 | |
|
|
1198 | =cut |
|
|
1199 | |
|
|
1200 | register_read_type storable => sub { |
|
|
1201 | my ($self, $cb) = @_; |
|
|
1202 | |
|
|
1203 | require Storable; |
|
|
1204 | |
|
|
1205 | sub { |
|
|
1206 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1207 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1208 | or return; |
|
|
1209 | |
|
|
1210 | my $format = length pack "w", $len; |
|
|
1211 | |
|
|
1212 | # bypass unshift if we already have the remaining chunk |
|
|
1213 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1214 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1215 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1216 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1217 | } else { |
|
|
1218 | # remove prefix |
|
|
1219 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1220 | |
|
|
1221 | # read remaining chunk |
|
|
1222 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1223 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1224 | $cb->($_[0], $ref); |
|
|
1225 | } else { |
|
|
1226 | $self->_error (&Errno::EBADMSG); |
|
|
1227 | } |
|
|
1228 | }); |
|
|
1229 | } |
|
|
1230 | |
|
|
1231 | 1 |
|
|
1232 | } |
|
|
1233 | }; |
|
|
1234 | |
1001 | =back |
1235 | =back |
1002 | |
1236 | |
1003 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1237 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1004 | |
1238 | |
1005 | This function (not method) lets you add your own types to C<push_read>. |
1239 | This function (not method) lets you add your own types to C<push_read>. |
… | |
… | |
1023 | =item $handle->stop_read |
1257 | =item $handle->stop_read |
1024 | |
1258 | |
1025 | =item $handle->start_read |
1259 | =item $handle->start_read |
1026 | |
1260 | |
1027 | In rare cases you actually do not want to read anything from the |
1261 | In rare cases you actually do not want to read anything from the |
1028 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
1262 | socket. In this case you can call C<stop_read>. Neither C<on_read> nor |
1029 | any queued callbacks will be executed then. To start reading again, call |
1263 | any queued callbacks will be executed then. To start reading again, call |
1030 | C<start_read>. |
1264 | C<start_read>. |
1031 | |
1265 | |
|
|
1266 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
|
|
1267 | you change the C<on_read> callback or push/unshift a read callback, and it |
|
|
1268 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
|
|
1269 | there are any read requests in the queue. |
|
|
1270 | |
|
|
1271 | These methods will have no effect when in TLS mode (as TLS doesn't support |
|
|
1272 | half-duplex connections). |
|
|
1273 | |
1032 | =cut |
1274 | =cut |
1033 | |
1275 | |
1034 | sub stop_read { |
1276 | sub stop_read { |
1035 | my ($self) = @_; |
1277 | my ($self) = @_; |
1036 | |
1278 | |
1037 | delete $self->{_rw}; |
1279 | delete $self->{_rw} unless $self->{tls}; |
1038 | } |
1280 | } |
1039 | |
1281 | |
1040 | sub start_read { |
1282 | sub start_read { |
1041 | my ($self) = @_; |
1283 | my ($self) = @_; |
1042 | |
1284 | |
1043 | unless ($self->{_rw} || $self->{_eof}) { |
1285 | unless ($self->{_rw} || $self->{_eof}) { |
1044 | Scalar::Util::weaken $self; |
1286 | Scalar::Util::weaken $self; |
1045 | |
1287 | |
1046 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1288 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1047 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1289 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1048 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1290 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1049 | |
1291 | |
1050 | if ($len > 0) { |
1292 | if ($len > 0) { |
1051 | $self->{_activity} = AnyEvent->now; |
1293 | $self->{_activity} = AnyEvent->now; |
1052 | |
1294 | |
1053 | $self->{filter_r} |
1295 | if ($self->{tls}) { |
1054 | ? $self->{filter_r}($self, $rbuf) |
1296 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1055 | : $self->_drain_rbuf; |
1297 | &_dotls ($self); |
|
|
1298 | } else { |
|
|
1299 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1300 | } |
1056 | |
1301 | |
1057 | } elsif (defined $len) { |
1302 | } elsif (defined $len) { |
1058 | delete $self->{_rw}; |
1303 | delete $self->{_rw}; |
1059 | $self->{_eof} = 1; |
1304 | $self->{_eof} = 1; |
1060 | $self->_drain_rbuf; |
1305 | $self->_drain_rbuf unless $self->{_in_drain}; |
1061 | |
1306 | |
1062 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1307 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1063 | return $self->_error ($!, 1); |
1308 | return $self->_error ($!, 1); |
1064 | } |
1309 | } |
1065 | }); |
1310 | }); |
… | |
… | |
1067 | } |
1312 | } |
1068 | |
1313 | |
1069 | sub _dotls { |
1314 | sub _dotls { |
1070 | my ($self) = @_; |
1315 | my ($self) = @_; |
1071 | |
1316 | |
|
|
1317 | my $buf; |
|
|
1318 | |
1072 | if (length $self->{_tls_wbuf}) { |
1319 | if (length $self->{_tls_wbuf}) { |
1073 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1320 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1074 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1321 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1075 | } |
1322 | } |
1076 | } |
1323 | } |
1077 | |
1324 | |
1078 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1079 | $self->{wbuf} .= $buf; |
|
|
1080 | $self->_drain_wbuf; |
|
|
1081 | } |
|
|
1082 | |
|
|
1083 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
1325 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
1326 | unless (length $buf) { |
|
|
1327 | # let's treat SSL-eof as we treat normal EOF |
|
|
1328 | delete $self->{_rw}; |
|
|
1329 | $self->{_eof} = 1; |
|
|
1330 | &_freetls; |
|
|
1331 | } |
|
|
1332 | |
1084 | $self->{rbuf} .= $buf; |
1333 | $self->{rbuf} .= $buf; |
1085 | $self->_drain_rbuf; |
1334 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1335 | $self->{tls} or return; # tls session might have gone away in callback |
1086 | } |
1336 | } |
1087 | |
1337 | |
1088 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1338 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1089 | |
1339 | |
1090 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1340 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
… | |
… | |
1094 | return $self->_error (&Errno::EIO, 1); |
1344 | return $self->_error (&Errno::EIO, 1); |
1095 | } |
1345 | } |
1096 | |
1346 | |
1097 | # all others are fine for our purposes |
1347 | # all others are fine for our purposes |
1098 | } |
1348 | } |
|
|
1349 | |
|
|
1350 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1351 | $self->{wbuf} .= $buf; |
|
|
1352 | $self->_drain_wbuf; |
|
|
1353 | } |
1099 | } |
1354 | } |
1100 | |
1355 | |
1101 | =item $handle->starttls ($tls[, $tls_ctx]) |
1356 | =item $handle->starttls ($tls[, $tls_ctx]) |
1102 | |
1357 | |
1103 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1358 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
… | |
… | |
1112 | |
1367 | |
1113 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1368 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1114 | call and can be used or changed to your liking. Note that the handshake |
1369 | call and can be used or changed to your liking. Note that the handshake |
1115 | might have already started when this function returns. |
1370 | might have already started when this function returns. |
1116 | |
1371 | |
|
|
1372 | If it an error to start a TLS handshake more than once per |
|
|
1373 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
|
|
1374 | |
1117 | =cut |
1375 | =cut |
1118 | |
1376 | |
1119 | sub starttls { |
1377 | sub starttls { |
1120 | my ($self, $ssl, $ctx) = @_; |
1378 | my ($self, $ssl, $ctx) = @_; |
1121 | |
1379 | |
1122 | $self->stoptls; |
1380 | Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object" |
1123 | |
1381 | if $self->{tls}; |
|
|
1382 | |
1124 | if ($ssl eq "accept") { |
1383 | if ($ssl eq "accept") { |
1125 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1384 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1126 | Net::SSLeay::set_accept_state ($ssl); |
1385 | Net::SSLeay::set_accept_state ($ssl); |
1127 | } elsif ($ssl eq "connect") { |
1386 | } elsif ($ssl eq "connect") { |
1128 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1387 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
… | |
… | |
1134 | # basically, this is deep magic (because SSL_read should have the same issues) |
1393 | # basically, this is deep magic (because SSL_read should have the same issues) |
1135 | # but the openssl maintainers basically said: "trust us, it just works". |
1394 | # but the openssl maintainers basically said: "trust us, it just works". |
1136 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1395 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1137 | # and mismaintained ssleay-module doesn't even offer them). |
1396 | # and mismaintained ssleay-module doesn't even offer them). |
1138 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1397 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1398 | # |
|
|
1399 | # in short: this is a mess. |
|
|
1400 | # |
|
|
1401 | # note that we do not try to keep the length constant between writes as we are required to do. |
|
|
1402 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
|
|
1403 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
|
|
1404 | # have identity issues in that area. |
1139 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1405 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1140 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1406 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1141 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1407 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1142 | |
1408 | |
1143 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1409 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1144 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1410 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1145 | |
1411 | |
1146 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1412 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1147 | |
1413 | |
1148 | $self->{filter_w} = sub { |
1414 | &_dotls; # need to trigger the initial handshake |
1149 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
1415 | $self->start_read; # make sure we actually do read |
1150 | &_dotls; |
|
|
1151 | }; |
|
|
1152 | $self->{filter_r} = sub { |
|
|
1153 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
|
|
1154 | &_dotls; |
|
|
1155 | }; |
|
|
1156 | } |
1416 | } |
1157 | |
1417 | |
1158 | =item $handle->stoptls |
1418 | =item $handle->stoptls |
1159 | |
1419 | |
1160 | Destroys the SSL connection, if any. Partial read or write data will be |
1420 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1161 | lost. |
1421 | sending a close notify to the other side, but since OpenSSL doesn't |
|
|
1422 | support non-blocking shut downs, it is not possible to re-use the stream |
|
|
1423 | afterwards. |
1162 | |
1424 | |
1163 | =cut |
1425 | =cut |
1164 | |
1426 | |
1165 | sub stoptls { |
1427 | sub stoptls { |
1166 | my ($self) = @_; |
1428 | my ($self) = @_; |
1167 | |
1429 | |
|
|
1430 | if ($self->{tls}) { |
|
|
1431 | Net::SSLeay::shutdown $self->{tls}; |
|
|
1432 | |
|
|
1433 | &_dotls; |
|
|
1434 | |
|
|
1435 | # we don't give a shit. no, we do, but we can't. no... |
|
|
1436 | # we, we... have to use openssl :/ |
|
|
1437 | &_freetls; |
|
|
1438 | } |
|
|
1439 | } |
|
|
1440 | |
|
|
1441 | sub _freetls { |
|
|
1442 | my ($self) = @_; |
|
|
1443 | |
|
|
1444 | return unless $self->{tls}; |
|
|
1445 | |
1168 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1446 | Net::SSLeay::free (delete $self->{tls}); |
1169 | |
1447 | |
1170 | delete $self->{_rbio}; |
1448 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1171 | delete $self->{_wbio}; |
|
|
1172 | delete $self->{_tls_wbuf}; |
|
|
1173 | delete $self->{filter_r}; |
|
|
1174 | delete $self->{filter_w}; |
|
|
1175 | } |
1449 | } |
1176 | |
1450 | |
1177 | sub DESTROY { |
1451 | sub DESTROY { |
1178 | my $self = shift; |
1452 | my $self = shift; |
1179 | |
1453 | |
1180 | $self->stoptls; |
1454 | &_freetls; |
|
|
1455 | |
|
|
1456 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1457 | |
|
|
1458 | if ($linger && length $self->{wbuf}) { |
|
|
1459 | my $fh = delete $self->{fh}; |
|
|
1460 | my $wbuf = delete $self->{wbuf}; |
|
|
1461 | |
|
|
1462 | my @linger; |
|
|
1463 | |
|
|
1464 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1465 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1466 | |
|
|
1467 | if ($len > 0) { |
|
|
1468 | substr $wbuf, 0, $len, ""; |
|
|
1469 | } else { |
|
|
1470 | @linger = (); # end |
|
|
1471 | } |
|
|
1472 | }); |
|
|
1473 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1474 | @linger = (); |
|
|
1475 | }); |
|
|
1476 | } |
1181 | } |
1477 | } |
1182 | |
1478 | |
1183 | =item AnyEvent::Handle::TLS_CTX |
1479 | =item AnyEvent::Handle::TLS_CTX |
1184 | |
1480 | |
1185 | This function creates and returns the Net::SSLeay::CTX object used by |
1481 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
1227 | =over 4 |
1523 | =over 4 |
1228 | |
1524 | |
1229 | =item * all constructor arguments become object members. |
1525 | =item * all constructor arguments become object members. |
1230 | |
1526 | |
1231 | At least initially, when you pass a C<tls>-argument to the constructor it |
1527 | At least initially, when you pass a C<tls>-argument to the constructor it |
1232 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1528 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1233 | mutated later on (for example C<tls> will hold the TLS connection object). |
1529 | mutated later on (for example C<tls> will hold the TLS connection object). |
1234 | |
1530 | |
1235 | =item * other object member names are prefixed with an C<_>. |
1531 | =item * other object member names are prefixed with an C<_>. |
1236 | |
1532 | |
1237 | All object members not explicitly documented (internal use) are prefixed |
1533 | All object members not explicitly documented (internal use) are prefixed |