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 (); |
10 | use Fcntl (); |
10 | use Fcntl (); |
11 | use Errno qw/EAGAIN EINTR/; |
11 | use Errno qw(EAGAIN EINTR); |
12 | |
12 | |
13 | =head1 NAME |
13 | =head1 NAME |
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 = '0.04'; |
19 | our $VERSION = 4.234; |
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 |
… | |
… | |
70 | |
73 | |
71 | =item fh => $filehandle [MANDATORY] |
74 | =item fh => $filehandle [MANDATORY] |
72 | |
75 | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
77 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
78 | NOTE: The filehandle will be set to non-blocking mode (using |
76 | AnyEvent::Util::fh_nonblocking). |
79 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
80 | that mode. |
77 | |
81 | |
78 | =item on_eof => $cb->($handle) |
82 | =item on_eof => $cb->($handle) |
79 | |
83 | |
80 | Set the callback to be called on EOF. |
84 | Set the callback to be called when an end-of-file condition is detected, |
|
|
85 | i.e. in the case of a socket, when the other side has closed the |
|
|
86 | connection cleanly. |
81 | |
87 | |
|
|
88 | For sockets, this just means that the other side has stopped sending data, |
|
|
89 | you can still try to write data, and, in fact, one can return from the eof |
|
|
90 | callback and continue writing data, as only the read part has been shut |
|
|
91 | down. |
|
|
92 | |
82 | While not mandatory, it is highly recommended to set an eof callback, |
93 | While not mandatory, it is I<highly> recommended to set an eof callback, |
83 | otherwise you might end up with a closed socket while you are still |
94 | otherwise you might end up with a closed socket while you are still |
84 | waiting for data. |
95 | waiting for data. |
85 | |
96 | |
|
|
97 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
98 | set, then a fatal error will be raised with C<$!> set to <0>. |
|
|
99 | |
86 | =item on_error => $cb->($handle) |
100 | =item on_error => $cb->($handle, $fatal) |
87 | |
101 | |
88 | This is the fatal error callback, that is called when, well, a fatal error |
102 | This is the error callback, which is called when, well, some error |
89 | occurs, such as not being able to resolve the hostname, failure to connect |
103 | occured, such as not being able to resolve the hostname, failure to |
90 | or a read error. |
104 | connect or a read error. |
91 | |
105 | |
92 | The object will not be in a usable state when this callback has been |
106 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
93 | called. |
107 | fatal errors the handle object will be shut down and will not be usable |
|
|
108 | (but you are free to look at the current C<< ->rbuf >>). Examples of fatal |
|
|
109 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
110 | (C<EPIPE>) or I/O errors. |
|
|
111 | |
|
|
112 | Non-fatal errors can be retried by simply returning, but it is recommended |
|
|
113 | to simply ignore this parameter and instead abondon the handle object |
|
|
114 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
115 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
94 | |
116 | |
95 | On callback entrance, the value of C<$!> contains the operating system |
117 | On callback entrance, the value of C<$!> contains the operating system |
96 | error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>). |
118 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
97 | |
|
|
98 | The callback should throw an exception. If it returns, then |
|
|
99 | AnyEvent::Handle will C<croak> for you. |
|
|
100 | |
119 | |
101 | While not mandatory, it is I<highly> recommended to set this callback, as |
120 | While not mandatory, it is I<highly> recommended to set this callback, as |
102 | you will not be notified of errors otherwise. The default simply calls |
121 | you will not be notified of errors otherwise. The default simply calls |
103 | die. |
122 | C<croak>. |
104 | |
123 | |
105 | =item on_read => $cb->($handle) |
124 | =item on_read => $cb->($handle) |
106 | |
125 | |
107 | This sets the default read callback, which is called when data arrives |
126 | This sets the default read callback, which is called when data arrives |
108 | and no read request is in the queue. |
127 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
128 | callback will only be called when at least one octet of data is in the |
|
|
129 | read buffer). |
109 | |
130 | |
110 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
131 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
111 | method or access the C<$handle->{rbuf}> member directly. |
132 | method or access the C<$handle->{rbuf}> member directly. |
112 | |
133 | |
113 | When an EOF condition is detected then AnyEvent::Handle will first try to |
134 | When an EOF condition is detected then AnyEvent::Handle will first try to |
… | |
… | |
120 | This sets the callback that is called when the write buffer becomes empty |
141 | This sets the callback that is called when the write buffer becomes empty |
121 | (or when the callback is set and the buffer is empty already). |
142 | (or when the callback is set and the buffer is empty already). |
122 | |
143 | |
123 | To append to the write buffer, use the C<< ->push_write >> method. |
144 | To append to the write buffer, use the C<< ->push_write >> method. |
124 | |
145 | |
|
|
146 | This callback is useful when you don't want to put all of your write data |
|
|
147 | into the queue at once, for example, when you want to write the contents |
|
|
148 | of some file to the socket you might not want to read the whole file into |
|
|
149 | memory and push it into the queue, but instead only read more data from |
|
|
150 | the file when the write queue becomes empty. |
|
|
151 | |
|
|
152 | =item timeout => $fractional_seconds |
|
|
153 | |
|
|
154 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
|
|
155 | seconds pass without a successful read or write on the underlying file |
|
|
156 | handle, the C<on_timeout> callback will be invoked (and if that one is |
|
|
157 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
|
|
158 | |
|
|
159 | Note that timeout processing is also active when you currently do not have |
|
|
160 | any outstanding read or write requests: If you plan to keep the connection |
|
|
161 | idle then you should disable the timout temporarily or ignore the timeout |
|
|
162 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
|
|
163 | restart the timeout. |
|
|
164 | |
|
|
165 | Zero (the default) disables this timeout. |
|
|
166 | |
|
|
167 | =item on_timeout => $cb->($handle) |
|
|
168 | |
|
|
169 | Called whenever the inactivity timeout passes. If you return from this |
|
|
170 | callback, then the timeout will be reset as if some activity had happened, |
|
|
171 | so this condition is not fatal in any way. |
|
|
172 | |
125 | =item rbuf_max => <bytes> |
173 | =item rbuf_max => <bytes> |
126 | |
174 | |
127 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
175 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
128 | when the read buffer ever (strictly) exceeds this size. This is useful to |
176 | when the read buffer ever (strictly) exceeds this size. This is useful to |
129 | avoid denial-of-service attacks. |
177 | avoid some forms of denial-of-service attacks. |
130 | |
178 | |
131 | For example, a server accepting connections from untrusted sources should |
179 | For example, a server accepting connections from untrusted sources should |
132 | be configured to accept only so-and-so much data that it cannot act on |
180 | be configured to accept only so-and-so much data that it cannot act on |
133 | (for example, when expecting a line, an attacker could send an unlimited |
181 | (for example, when expecting a line, an attacker could send an unlimited |
134 | amount of data without a callback ever being called as long as the line |
182 | amount of data without a callback ever being called as long as the line |
135 | isn't finished). |
183 | isn't finished). |
136 | |
184 | |
|
|
185 | =item autocork => <boolean> |
|
|
186 | |
|
|
187 | When disabled (the default), then C<push_write> will try to immediately |
|
|
188 | write the data to the handle, if possible. This avoids having to register |
|
|
189 | a write watcher and wait for the next event loop iteration, but can |
|
|
190 | be inefficient if you write multiple small chunks (on the wire, this |
|
|
191 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
|
|
192 | C<no_delay>, but this option can save costly syscalls). |
|
|
193 | |
|
|
194 | When enabled, then writes will always be queued till the next event loop |
|
|
195 | iteration. This is efficient when you do many small writes per iteration, |
|
|
196 | but less efficient when you do a single write only per iteration (or when |
|
|
197 | the write buffer often is full). It also increases write latency. |
|
|
198 | |
|
|
199 | =item no_delay => <boolean> |
|
|
200 | |
|
|
201 | When doing small writes on sockets, your operating system kernel might |
|
|
202 | wait a bit for more data before actually sending it out. This is called |
|
|
203 | the Nagle algorithm, and usually it is beneficial. |
|
|
204 | |
|
|
205 | In some situations you want as low a delay as possible, which can be |
|
|
206 | accomplishd by setting this option to a true value. |
|
|
207 | |
|
|
208 | The default is your opertaing system's default behaviour (most likely |
|
|
209 | enabled), this option explicitly enables or disables it, if possible. |
|
|
210 | |
137 | =item read_size => <bytes> |
211 | =item read_size => <bytes> |
138 | |
212 | |
139 | The default read block size (the amount of bytes this module will try to read |
213 | The default read block size (the amount of bytes this module will |
140 | on each [loop iteration). Default: C<4096>. |
214 | try to read during each loop iteration, which affects memory |
|
|
215 | requirements). Default: C<8192>. |
141 | |
216 | |
142 | =item low_water_mark => <bytes> |
217 | =item low_water_mark => <bytes> |
143 | |
218 | |
144 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
219 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
145 | buffer: If the write reaches this size or gets even samller it is |
220 | buffer: If the write reaches this size or gets even samller it is |
146 | considered empty. |
221 | considered empty. |
147 | |
222 | |
|
|
223 | Sometimes it can be beneficial (for performance reasons) to add data to |
|
|
224 | the write buffer before it is fully drained, but this is a rare case, as |
|
|
225 | the operating system kernel usually buffers data as well, so the default |
|
|
226 | is good in almost all cases. |
|
|
227 | |
|
|
228 | =item linger => <seconds> |
|
|
229 | |
|
|
230 | If non-zero (default: C<3600>), then the destructor of the |
|
|
231 | AnyEvent::Handle object will check whether there is still outstanding |
|
|
232 | write data and will install a watcher that will write this data to the |
|
|
233 | socket. No errors will be reported (this mostly matches how the operating |
|
|
234 | system treats outstanding data at socket close time). |
|
|
235 | |
|
|
236 | This will not work for partial TLS data that could not be encoded |
|
|
237 | yet. This data will be lost. |
|
|
238 | |
148 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
239 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
149 | |
240 | |
150 | When this parameter is given, it enables TLS (SSL) mode, that means it |
241 | When this parameter is given, it enables TLS (SSL) mode, that means |
151 | will start making tls handshake and will transparently encrypt/decrypt |
242 | AnyEvent will start a TLS handshake as soon as the conenction has been |
152 | data. |
243 | established and will transparently encrypt/decrypt data afterwards. |
153 | |
244 | |
154 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
245 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
155 | automatically when you try to create a TLS handle). |
246 | automatically when you try to create a TLS handle): this module doesn't |
|
|
247 | have a dependency on that module, so if your module requires it, you have |
|
|
248 | to add the dependency yourself. |
156 | |
249 | |
157 | For the TLS server side, use C<accept>, and for the TLS client side of a |
250 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
158 | connection, use C<connect> mode. |
251 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
252 | mode. |
159 | |
253 | |
160 | You can also provide your own TLS connection object, but you have |
254 | You can also provide your own TLS connection object, but you have |
161 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
255 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
162 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
256 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
163 | AnyEvent::Handle. |
257 | AnyEvent::Handle. |
164 | |
258 | |
165 | See the C<starttls> method if you need to start TLs negotiation later. |
259 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
166 | |
260 | |
167 | =item tls_ctx => $ssl_ctx |
261 | =item tls_ctx => $ssl_ctx |
168 | |
262 | |
169 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
263 | Use the given C<Net::SSLeay::CTX> object to create the new TLS connection |
170 | (unless a connection object was specified directly). If this parameter is |
264 | (unless a connection object was specified directly). If this parameter is |
171 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
265 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
172 | |
266 | |
173 | =item json => JSON or JSON::XS object |
267 | =item json => JSON or JSON::XS object |
174 | |
268 | |
175 | This is the json coder object used by the C<json> read and write types. |
269 | This is the json coder object used by the C<json> read and write types. |
176 | |
270 | |
177 | If you don't supply it, then AnyEvent::Handle will create and use a |
271 | If you don't supply it, then AnyEvent::Handle will create and use a |
178 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
272 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
273 | texts. |
179 | |
274 | |
180 | Note that you are responsible to depend on the JSON module if you want to |
275 | Note that you are responsible to depend on the JSON module if you want to |
181 | use this functionality, as AnyEvent does not have a dependency itself. |
276 | use this functionality, as AnyEvent does not have a dependency itself. |
182 | |
277 | |
183 | =item filter_r => $cb |
278 | =item filter_r => $cb |
184 | |
279 | |
185 | =item filter_w => $cb |
280 | =item filter_w => $cb |
186 | |
281 | |
187 | These exist, but are undocumented at this time. |
282 | These exist, but are undocumented at this time. (They are used internally |
|
|
283 | by the TLS code). |
188 | |
284 | |
189 | =back |
285 | =back |
190 | |
286 | |
191 | =cut |
287 | =cut |
192 | |
288 | |
… | |
… | |
202 | if ($self->{tls}) { |
298 | if ($self->{tls}) { |
203 | require Net::SSLeay; |
299 | require Net::SSLeay; |
204 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
300 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
205 | } |
301 | } |
206 | |
302 | |
207 | $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; |
303 | $self->{_activity} = AnyEvent->now; |
208 | $self->on_error (delete $self->{on_error}) if $self->{on_error}; |
304 | $self->_timeout; |
|
|
305 | |
209 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
306 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
210 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
307 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
211 | |
308 | |
212 | $self->start_read; |
309 | $self->start_read |
|
|
310 | if $self->{on_read}; |
213 | |
311 | |
214 | $self |
312 | $self |
215 | } |
313 | } |
216 | |
314 | |
217 | sub _shutdown { |
315 | sub _shutdown { |
218 | my ($self) = @_; |
316 | my ($self) = @_; |
219 | |
317 | |
|
|
318 | delete $self->{_tw}; |
220 | delete $self->{_rw}; |
319 | delete $self->{_rw}; |
221 | delete $self->{_ww}; |
320 | delete $self->{_ww}; |
222 | delete $self->{fh}; |
321 | delete $self->{fh}; |
223 | } |
|
|
224 | |
322 | |
|
|
323 | $self->stoptls; |
|
|
324 | |
|
|
325 | delete $self->{on_read}; |
|
|
326 | delete $self->{_queue}; |
|
|
327 | } |
|
|
328 | |
225 | sub error { |
329 | sub _error { |
226 | my ($self) = @_; |
330 | my ($self, $errno, $fatal) = @_; |
227 | |
331 | |
228 | { |
|
|
229 | local $!; |
|
|
230 | $self->_shutdown; |
332 | $self->_shutdown |
231 | } |
333 | if $fatal; |
232 | |
334 | |
233 | $self->{on_error}($self) |
335 | $! = $errno; |
|
|
336 | |
234 | if $self->{on_error}; |
337 | if ($self->{on_error}) { |
235 | |
338 | $self->{on_error}($self, $fatal); |
|
|
339 | } else { |
236 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
340 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
|
|
341 | } |
237 | } |
342 | } |
238 | |
343 | |
239 | =item $fh = $handle->fh |
344 | =item $fh = $handle->fh |
240 | |
345 | |
241 | This method returns the file handle of the L<AnyEvent::Handle> object. |
346 | This method returns the file handle used to create the L<AnyEvent::Handle> object. |
242 | |
347 | |
243 | =cut |
348 | =cut |
244 | |
349 | |
245 | sub fh { $_[0]{fh} } |
350 | sub fh { $_[0]{fh} } |
246 | |
351 | |
… | |
… | |
260 | |
365 | |
261 | =cut |
366 | =cut |
262 | |
367 | |
263 | sub on_eof { |
368 | sub on_eof { |
264 | $_[0]{on_eof} = $_[1]; |
369 | $_[0]{on_eof} = $_[1]; |
|
|
370 | } |
|
|
371 | |
|
|
372 | =item $handle->on_timeout ($cb) |
|
|
373 | |
|
|
374 | Replace the current C<on_timeout> callback, or disables the callback (but |
|
|
375 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
|
|
376 | argument and method. |
|
|
377 | |
|
|
378 | =cut |
|
|
379 | |
|
|
380 | sub on_timeout { |
|
|
381 | $_[0]{on_timeout} = $_[1]; |
|
|
382 | } |
|
|
383 | |
|
|
384 | =item $handle->autocork ($boolean) |
|
|
385 | |
|
|
386 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
387 | constructor argument). |
|
|
388 | |
|
|
389 | =cut |
|
|
390 | |
|
|
391 | =item $handle->no_delay ($boolean) |
|
|
392 | |
|
|
393 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
394 | the same name for details). |
|
|
395 | |
|
|
396 | =cut |
|
|
397 | |
|
|
398 | sub no_delay { |
|
|
399 | $_[0]{no_delay} = $_[1]; |
|
|
400 | |
|
|
401 | eval { |
|
|
402 | local $SIG{__DIE__}; |
|
|
403 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
404 | }; |
|
|
405 | } |
|
|
406 | |
|
|
407 | ############################################################################# |
|
|
408 | |
|
|
409 | =item $handle->timeout ($seconds) |
|
|
410 | |
|
|
411 | Configures (or disables) the inactivity timeout. |
|
|
412 | |
|
|
413 | =cut |
|
|
414 | |
|
|
415 | sub timeout { |
|
|
416 | my ($self, $timeout) = @_; |
|
|
417 | |
|
|
418 | $self->{timeout} = $timeout; |
|
|
419 | $self->_timeout; |
|
|
420 | } |
|
|
421 | |
|
|
422 | # reset the timeout watcher, as neccessary |
|
|
423 | # also check for time-outs |
|
|
424 | sub _timeout { |
|
|
425 | my ($self) = @_; |
|
|
426 | |
|
|
427 | if ($self->{timeout}) { |
|
|
428 | my $NOW = AnyEvent->now; |
|
|
429 | |
|
|
430 | # when would the timeout trigger? |
|
|
431 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
|
|
432 | |
|
|
433 | # now or in the past already? |
|
|
434 | if ($after <= 0) { |
|
|
435 | $self->{_activity} = $NOW; |
|
|
436 | |
|
|
437 | if ($self->{on_timeout}) { |
|
|
438 | $self->{on_timeout}($self); |
|
|
439 | } else { |
|
|
440 | $self->_error (&Errno::ETIMEDOUT); |
|
|
441 | } |
|
|
442 | |
|
|
443 | # callback could have changed timeout value, optimise |
|
|
444 | return unless $self->{timeout}; |
|
|
445 | |
|
|
446 | # calculate new after |
|
|
447 | $after = $self->{timeout}; |
|
|
448 | } |
|
|
449 | |
|
|
450 | Scalar::Util::weaken $self; |
|
|
451 | return unless $self; # ->error could have destroyed $self |
|
|
452 | |
|
|
453 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
|
|
454 | delete $self->{_tw}; |
|
|
455 | $self->_timeout; |
|
|
456 | }); |
|
|
457 | } else { |
|
|
458 | delete $self->{_tw}; |
|
|
459 | } |
265 | } |
460 | } |
266 | |
461 | |
267 | ############################################################################# |
462 | ############################################################################# |
268 | |
463 | |
269 | =back |
464 | =back |
… | |
… | |
316 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
511 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
317 | |
512 | |
318 | if ($len >= 0) { |
513 | if ($len >= 0) { |
319 | substr $self->{wbuf}, 0, $len, ""; |
514 | substr $self->{wbuf}, 0, $len, ""; |
320 | |
515 | |
|
|
516 | $self->{_activity} = AnyEvent->now; |
|
|
517 | |
321 | $self->{on_drain}($self) |
518 | $self->{on_drain}($self) |
322 | if $self->{low_water_mark} >= length $self->{wbuf} |
519 | if $self->{low_water_mark} >= length $self->{wbuf} |
323 | && $self->{on_drain}; |
520 | && $self->{on_drain}; |
324 | |
521 | |
325 | delete $self->{_ww} unless length $self->{wbuf}; |
522 | delete $self->{_ww} unless length $self->{wbuf}; |
326 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
523 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
327 | $self->error; |
524 | $self->_error ($!, 1); |
328 | } |
525 | } |
329 | }; |
526 | }; |
330 | |
527 | |
331 | # try to write data immediately |
528 | # try to write data immediately |
332 | $cb->(); |
529 | $cb->() unless $self->{autocork}; |
333 | |
530 | |
334 | # if still data left in wbuf, we need to poll |
531 | # if still data left in wbuf, we need to poll |
335 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
532 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
336 | if length $self->{wbuf}; |
533 | if length $self->{wbuf}; |
337 | }; |
534 | }; |
… | |
… | |
352 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
549 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
353 | ->($self, @_); |
550 | ->($self, @_); |
354 | } |
551 | } |
355 | |
552 | |
356 | if ($self->{filter_w}) { |
553 | if ($self->{filter_w}) { |
357 | $self->{filter_w}->($self, \$_[0]); |
554 | $self->{filter_w}($self, \$_[0]); |
358 | } else { |
555 | } else { |
359 | $self->{wbuf} .= $_[0]; |
556 | $self->{wbuf} .= $_[0]; |
360 | $self->_drain_wbuf; |
557 | $self->_drain_wbuf; |
361 | } |
558 | } |
362 | } |
559 | } |
363 | |
560 | |
364 | =item $handle->push_write (type => @args) |
561 | =item $handle->push_write (type => @args) |
365 | |
562 | |
366 | =item $handle->unshift_write (type => @args) |
|
|
367 | |
|
|
368 | Instead of formatting your data yourself, you can also let this module do |
563 | Instead of formatting your data yourself, you can also let this module do |
369 | the job by specifying a type and type-specific arguments. |
564 | the job by specifying a type and type-specific arguments. |
370 | |
565 | |
371 | Predefined types are (if you have ideas for additional types, feel free to |
566 | Predefined types are (if you have ideas for additional types, feel free to |
372 | drop by and tell us): |
567 | drop by and tell us): |
… | |
… | |
376 | =item netstring => $string |
571 | =item netstring => $string |
377 | |
572 | |
378 | Formats the given value as netstring |
573 | Formats the given value as netstring |
379 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
574 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
380 | |
575 | |
381 | =back |
|
|
382 | |
|
|
383 | =cut |
576 | =cut |
384 | |
577 | |
385 | register_write_type netstring => sub { |
578 | register_write_type netstring => sub { |
386 | my ($self, $string) = @_; |
579 | my ($self, $string) = @_; |
387 | |
580 | |
388 | sprintf "%d:%s,", (length $string), $string |
581 | sprintf "%d:%s,", (length $string), $string |
|
|
582 | }; |
|
|
583 | |
|
|
584 | =item packstring => $format, $data |
|
|
585 | |
|
|
586 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
587 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
588 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
589 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
590 | |
|
|
591 | =cut |
|
|
592 | |
|
|
593 | register_write_type packstring => sub { |
|
|
594 | my ($self, $format, $string) = @_; |
|
|
595 | |
|
|
596 | pack "$format/a*", $string |
389 | }; |
597 | }; |
390 | |
598 | |
391 | =item json => $array_or_hashref |
599 | =item json => $array_or_hashref |
392 | |
600 | |
393 | Encodes the given hash or array reference into a JSON object. Unless you |
601 | Encodes the given hash or array reference into a JSON object. Unless you |
… | |
… | |
427 | |
635 | |
428 | $self->{json} ? $self->{json}->encode ($ref) |
636 | $self->{json} ? $self->{json}->encode ($ref) |
429 | : JSON::encode_json ($ref) |
637 | : JSON::encode_json ($ref) |
430 | }; |
638 | }; |
431 | |
639 | |
|
|
640 | =item storable => $reference |
|
|
641 | |
|
|
642 | Freezes the given reference using L<Storable> and writes it to the |
|
|
643 | handle. Uses the C<nfreeze> format. |
|
|
644 | |
|
|
645 | =cut |
|
|
646 | |
|
|
647 | register_write_type storable => sub { |
|
|
648 | my ($self, $ref) = @_; |
|
|
649 | |
|
|
650 | require Storable; |
|
|
651 | |
|
|
652 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
653 | }; |
|
|
654 | |
|
|
655 | =back |
|
|
656 | |
432 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
657 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
433 | |
658 | |
434 | This function (not method) lets you add your own types to C<push_write>. |
659 | This function (not method) lets you add your own types to C<push_write>. |
435 | Whenever the given C<type> is used, C<push_write> will invoke the code |
660 | Whenever the given C<type> is used, C<push_write> will invoke the code |
436 | reference with the handle object and the remaining arguments. |
661 | reference with the handle object and the remaining arguments. |
… | |
… | |
456 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
681 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
457 | a queue. |
682 | a queue. |
458 | |
683 | |
459 | In the simple case, you just install an C<on_read> callback and whenever |
684 | In the simple case, you just install an C<on_read> callback and whenever |
460 | new data arrives, it will be called. You can then remove some data (if |
685 | new data arrives, it will be called. You can then remove some data (if |
461 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
686 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
462 | or not. |
687 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
688 | partial message has been received so far). |
463 | |
689 | |
464 | In the more complex case, you want to queue multiple callbacks. In this |
690 | In the more complex case, you want to queue multiple callbacks. In this |
465 | case, AnyEvent::Handle will call the first queued callback each time new |
691 | case, AnyEvent::Handle will call the first queued callback each time new |
466 | data arrives and removes it when it has done its job (see C<push_read>, |
692 | data arrives (also the first time it is queued) and removes it when it has |
467 | below). |
693 | done its job (see C<push_read>, below). |
468 | |
694 | |
469 | This way you can, for example, push three line-reads, followed by reading |
695 | This way you can, for example, push three line-reads, followed by reading |
470 | a chunk of data, and AnyEvent::Handle will execute them in order. |
696 | a chunk of data, and AnyEvent::Handle will execute them in order. |
471 | |
697 | |
472 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
698 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
473 | the specified number of bytes which give an XML datagram. |
699 | the specified number of bytes which give an XML datagram. |
474 | |
700 | |
475 | # in the default state, expect some header bytes |
701 | # in the default state, expect some header bytes |
476 | $handle->on_read (sub { |
702 | $handle->on_read (sub { |
477 | # some data is here, now queue the length-header-read (4 octets) |
703 | # some data is here, now queue the length-header-read (4 octets) |
478 | shift->unshift_read_chunk (4, sub { |
704 | shift->unshift_read (chunk => 4, sub { |
479 | # header arrived, decode |
705 | # header arrived, decode |
480 | my $len = unpack "N", $_[1]; |
706 | my $len = unpack "N", $_[1]; |
481 | |
707 | |
482 | # now read the payload |
708 | # now read the payload |
483 | shift->unshift_read_chunk ($len, sub { |
709 | shift->unshift_read (chunk => $len, sub { |
484 | my $xml = $_[1]; |
710 | my $xml = $_[1]; |
485 | # handle xml |
711 | # handle xml |
486 | }); |
712 | }); |
487 | }); |
713 | }); |
488 | }); |
714 | }); |
489 | |
715 | |
490 | Example 2: Implement a client for a protocol that replies either with |
716 | Example 2: Implement a client for a protocol that replies either with "OK" |
491 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
717 | and another line or "ERROR" for the first request that is sent, and 64 |
492 | second request. Due tot he availability of a full queue, we can just |
718 | bytes for the second request. Due to the availability of a queue, we can |
493 | pipeline sending both requests and manipulate the queue as necessary in |
719 | just pipeline sending both requests and manipulate the queue as necessary |
494 | the callbacks: |
720 | in the callbacks. |
495 | |
721 | |
496 | # request one |
722 | When the first callback is called and sees an "OK" response, it will |
|
|
723 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
724 | 64-byte chunk callback. |
|
|
725 | |
|
|
726 | # request one, returns either "OK + extra line" or "ERROR" |
497 | $handle->push_write ("request 1\015\012"); |
727 | $handle->push_write ("request 1\015\012"); |
498 | |
728 | |
499 | # we expect "ERROR" or "OK" as response, so push a line read |
729 | # we expect "ERROR" or "OK" as response, so push a line read |
500 | $handle->push_read_line (sub { |
730 | $handle->push_read (line => sub { |
501 | # if we got an "OK", we have to _prepend_ another line, |
731 | # if we got an "OK", we have to _prepend_ another line, |
502 | # so it will be read before the second request reads its 64 bytes |
732 | # so it will be read before the second request reads its 64 bytes |
503 | # which are already in the queue when this callback is called |
733 | # which are already in the queue when this callback is called |
504 | # we don't do this in case we got an error |
734 | # we don't do this in case we got an error |
505 | if ($_[1] eq "OK") { |
735 | if ($_[1] eq "OK") { |
506 | $_[0]->unshift_read_line (sub { |
736 | $_[0]->unshift_read (line => sub { |
507 | my $response = $_[1]; |
737 | my $response = $_[1]; |
508 | ... |
738 | ... |
509 | }); |
739 | }); |
510 | } |
740 | } |
511 | }); |
741 | }); |
512 | |
742 | |
513 | # request two |
743 | # request two, simply returns 64 octets |
514 | $handle->push_write ("request 2\015\012"); |
744 | $handle->push_write ("request 2\015\012"); |
515 | |
745 | |
516 | # simply read 64 bytes, always |
746 | # simply read 64 bytes, always |
517 | $handle->push_read_chunk (64, sub { |
747 | $handle->push_read (chunk => 64, sub { |
518 | my $response = $_[1]; |
748 | my $response = $_[1]; |
519 | ... |
749 | ... |
520 | }); |
750 | }); |
521 | |
751 | |
522 | =over 4 |
752 | =over 4 |
523 | |
753 | |
524 | =cut |
754 | =cut |
525 | |
755 | |
526 | sub _drain_rbuf { |
756 | sub _drain_rbuf { |
527 | my ($self) = @_; |
757 | my ($self) = @_; |
|
|
758 | |
|
|
759 | local $self->{_in_drain} = 1; |
528 | |
760 | |
529 | if ( |
761 | if ( |
530 | defined $self->{rbuf_max} |
762 | defined $self->{rbuf_max} |
531 | && $self->{rbuf_max} < length $self->{rbuf} |
763 | && $self->{rbuf_max} < length $self->{rbuf} |
532 | ) { |
764 | ) { |
533 | $! = &Errno::ENOSPC; |
765 | $self->_error (&Errno::ENOSPC, 1), return; |
534 | $self->error; |
|
|
535 | } |
766 | } |
536 | |
767 | |
537 | return if $self->{in_drain}; |
768 | while () { |
538 | local $self->{in_drain} = 1; |
|
|
539 | |
|
|
540 | while (my $len = length $self->{rbuf}) { |
769 | my $len = length $self->{rbuf}; |
541 | no strict 'refs'; |
770 | |
542 | if (my $cb = shift @{ $self->{_queue} }) { |
771 | if (my $cb = shift @{ $self->{_queue} }) { |
543 | unless ($cb->($self)) { |
772 | unless ($cb->($self)) { |
544 | if ($self->{_eof}) { |
773 | if ($self->{_eof}) { |
545 | # no progress can be made (not enough data and no data forthcoming) |
774 | # no progress can be made (not enough data and no data forthcoming) |
546 | $! = &Errno::EPIPE; |
775 | $self->_error (&Errno::EPIPE, 1), return; |
547 | $self->error; |
|
|
548 | } |
776 | } |
549 | |
777 | |
550 | unshift @{ $self->{_queue} }, $cb; |
778 | unshift @{ $self->{_queue} }, $cb; |
551 | return; |
779 | last; |
552 | } |
780 | } |
553 | } elsif ($self->{on_read}) { |
781 | } elsif ($self->{on_read}) { |
|
|
782 | last unless $len; |
|
|
783 | |
554 | $self->{on_read}($self); |
784 | $self->{on_read}($self); |
555 | |
785 | |
556 | if ( |
786 | if ( |
557 | $self->{_eof} # if no further data will arrive |
|
|
558 | && $len == length $self->{rbuf} # and no data has been consumed |
787 | $len == length $self->{rbuf} # if no data has been consumed |
559 | && !@{ $self->{_queue} } # and the queue is still empty |
788 | && !@{ $self->{_queue} } # and the queue is still empty |
560 | && $self->{on_read} # and we still want to read data |
789 | && $self->{on_read} # but we still have on_read |
561 | ) { |
790 | ) { |
|
|
791 | # no further data will arrive |
562 | # then no progress can be made |
792 | # so no progress can be made |
563 | $! = &Errno::EPIPE; |
793 | $self->_error (&Errno::EPIPE, 1), return |
564 | $self->error; |
794 | if $self->{_eof}; |
|
|
795 | |
|
|
796 | last; # more data might arrive |
565 | } |
797 | } |
566 | } else { |
798 | } else { |
567 | # read side becomes idle |
799 | # read side becomes idle |
568 | delete $self->{_rw}; |
800 | delete $self->{_rw}; |
569 | return; |
801 | last; |
570 | } |
802 | } |
571 | } |
803 | } |
572 | |
804 | |
573 | if ($self->{_eof}) { |
805 | if ($self->{_eof}) { |
574 | $self->_shutdown; |
806 | if ($self->{on_eof}) { |
575 | $self->{on_eof}($self) |
807 | $self->{on_eof}($self) |
576 | if $self->{on_eof}; |
808 | } else { |
|
|
809 | $self->_error (0, 1); |
|
|
810 | } |
|
|
811 | } |
|
|
812 | |
|
|
813 | # may need to restart read watcher |
|
|
814 | unless ($self->{_rw}) { |
|
|
815 | $self->start_read |
|
|
816 | if $self->{on_read} || @{ $self->{_queue} }; |
577 | } |
817 | } |
578 | } |
818 | } |
579 | |
819 | |
580 | =item $handle->on_read ($cb) |
820 | =item $handle->on_read ($cb) |
581 | |
821 | |
… | |
… | |
587 | |
827 | |
588 | sub on_read { |
828 | sub on_read { |
589 | my ($self, $cb) = @_; |
829 | my ($self, $cb) = @_; |
590 | |
830 | |
591 | $self->{on_read} = $cb; |
831 | $self->{on_read} = $cb; |
|
|
832 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
592 | } |
833 | } |
593 | |
834 | |
594 | =item $handle->rbuf |
835 | =item $handle->rbuf |
595 | |
836 | |
596 | Returns the read buffer (as a modifiable lvalue). |
837 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
645 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
886 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
646 | ->($self, $cb, @_); |
887 | ->($self, $cb, @_); |
647 | } |
888 | } |
648 | |
889 | |
649 | push @{ $self->{_queue} }, $cb; |
890 | push @{ $self->{_queue} }, $cb; |
650 | $self->_drain_rbuf; |
891 | $self->_drain_rbuf unless $self->{_in_drain}; |
651 | } |
892 | } |
652 | |
893 | |
653 | sub unshift_read { |
894 | sub unshift_read { |
654 | my $self = shift; |
895 | my $self = shift; |
655 | my $cb = pop; |
896 | my $cb = pop; |
… | |
… | |
661 | ->($self, $cb, @_); |
902 | ->($self, $cb, @_); |
662 | } |
903 | } |
663 | |
904 | |
664 | |
905 | |
665 | unshift @{ $self->{_queue} }, $cb; |
906 | unshift @{ $self->{_queue} }, $cb; |
666 | $self->_drain_rbuf; |
907 | $self->_drain_rbuf unless $self->{_in_drain}; |
667 | } |
908 | } |
668 | |
909 | |
669 | =item $handle->push_read (type => @args, $cb) |
910 | =item $handle->push_read (type => @args, $cb) |
670 | |
911 | |
671 | =item $handle->unshift_read (type => @args, $cb) |
912 | =item $handle->unshift_read (type => @args, $cb) |
… | |
… | |
701 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
942 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
702 | 1 |
943 | 1 |
703 | } |
944 | } |
704 | }; |
945 | }; |
705 | |
946 | |
706 | # compatibility with older API |
|
|
707 | sub push_read_chunk { |
|
|
708 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
709 | } |
|
|
710 | |
|
|
711 | sub unshift_read_chunk { |
|
|
712 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
713 | } |
|
|
714 | |
|
|
715 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
947 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
716 | |
948 | |
717 | The callback will be called only once a full line (including the end of |
949 | The callback will be called only once a full line (including the end of |
718 | line marker, C<$eol>) has been read. This line (excluding the end of line |
950 | line marker, C<$eol>) has been read. This line (excluding the end of line |
719 | marker) will be passed to the callback as second argument (C<$line>), and |
951 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
734 | =cut |
966 | =cut |
735 | |
967 | |
736 | register_read_type line => sub { |
968 | register_read_type line => sub { |
737 | my ($self, $cb, $eol) = @_; |
969 | my ($self, $cb, $eol) = @_; |
738 | |
970 | |
739 | $eol = qr|(\015?\012)| if @_ < 3; |
971 | if (@_ < 3) { |
740 | $eol = quotemeta $eol unless ref $eol; |
972 | # this is more than twice as fast as the generic code below |
741 | $eol = qr|^(.*?)($eol)|s; |
|
|
742 | |
|
|
743 | sub { |
973 | sub { |
744 | $_[0]{rbuf} =~ s/$eol// or return; |
974 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
745 | |
975 | |
746 | $cb->($_[0], $1, $2); |
976 | $cb->($_[0], $1, $2); |
747 | 1 |
|
|
748 | } |
|
|
749 | }; |
|
|
750 | |
|
|
751 | # compatibility with older API |
|
|
752 | sub push_read_line { |
|
|
753 | my $self = shift; |
|
|
754 | $self->push_read (line => @_); |
|
|
755 | } |
|
|
756 | |
|
|
757 | sub unshift_read_line { |
|
|
758 | my $self = shift; |
|
|
759 | $self->unshift_read (line => @_); |
|
|
760 | } |
|
|
761 | |
|
|
762 | =item netstring => $cb->($handle, $string) |
|
|
763 | |
|
|
764 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
765 | |
|
|
766 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
767 | |
|
|
768 | =cut |
|
|
769 | |
|
|
770 | register_read_type netstring => sub { |
|
|
771 | my ($self, $cb) = @_; |
|
|
772 | |
|
|
773 | sub { |
|
|
774 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
775 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
776 | $! = &Errno::EBADMSG; |
|
|
777 | $self->error; |
|
|
778 | } |
977 | 1 |
779 | return; |
|
|
780 | } |
978 | } |
|
|
979 | } else { |
|
|
980 | $eol = quotemeta $eol unless ref $eol; |
|
|
981 | $eol = qr|^(.*?)($eol)|s; |
781 | |
982 | |
782 | my $len = $1; |
983 | sub { |
|
|
984 | $_[0]{rbuf} =~ s/$eol// or return; |
783 | |
985 | |
784 | $self->unshift_read (chunk => $len, sub { |
986 | $cb->($_[0], $1, $2); |
785 | my $string = $_[1]; |
|
|
786 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
787 | if ($_[1] eq ",") { |
|
|
788 | $cb->($_[0], $string); |
|
|
789 | } else { |
|
|
790 | $! = &Errno::EBADMSG; |
|
|
791 | $self->error; |
|
|
792 | } |
|
|
793 | }); |
987 | 1 |
794 | }); |
988 | } |
795 | |
|
|
796 | 1 |
|
|
797 | } |
989 | } |
798 | }; |
990 | }; |
799 | |
991 | |
800 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
992 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
801 | |
993 | |
… | |
… | |
853 | return 1; |
1045 | return 1; |
854 | } |
1046 | } |
855 | |
1047 | |
856 | # reject |
1048 | # reject |
857 | if ($reject && $$rbuf =~ $reject) { |
1049 | if ($reject && $$rbuf =~ $reject) { |
858 | $! = &Errno::EBADMSG; |
1050 | $self->_error (&Errno::EBADMSG); |
859 | $self->error; |
|
|
860 | } |
1051 | } |
861 | |
1052 | |
862 | # skip |
1053 | # skip |
863 | if ($skip && $$rbuf =~ $skip) { |
1054 | if ($skip && $$rbuf =~ $skip) { |
864 | $data .= substr $$rbuf, 0, $+[0], ""; |
1055 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
866 | |
1057 | |
867 | () |
1058 | () |
868 | } |
1059 | } |
869 | }; |
1060 | }; |
870 | |
1061 | |
|
|
1062 | =item netstring => $cb->($handle, $string) |
|
|
1063 | |
|
|
1064 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
1065 | |
|
|
1066 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
1067 | |
|
|
1068 | =cut |
|
|
1069 | |
|
|
1070 | register_read_type netstring => sub { |
|
|
1071 | my ($self, $cb) = @_; |
|
|
1072 | |
|
|
1073 | sub { |
|
|
1074 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
1075 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
1076 | $self->_error (&Errno::EBADMSG); |
|
|
1077 | } |
|
|
1078 | return; |
|
|
1079 | } |
|
|
1080 | |
|
|
1081 | my $len = $1; |
|
|
1082 | |
|
|
1083 | $self->unshift_read (chunk => $len, sub { |
|
|
1084 | my $string = $_[1]; |
|
|
1085 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
1086 | if ($_[1] eq ",") { |
|
|
1087 | $cb->($_[0], $string); |
|
|
1088 | } else { |
|
|
1089 | $self->_error (&Errno::EBADMSG); |
|
|
1090 | } |
|
|
1091 | }); |
|
|
1092 | }); |
|
|
1093 | |
|
|
1094 | 1 |
|
|
1095 | } |
|
|
1096 | }; |
|
|
1097 | |
|
|
1098 | =item packstring => $format, $cb->($handle, $string) |
|
|
1099 | |
|
|
1100 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1101 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1102 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1103 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1104 | |
|
|
1105 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
1106 | |
|
|
1107 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1108 | format (very efficient). |
|
|
1109 | |
|
|
1110 | $handle->push_read (packstring => "w", sub { |
|
|
1111 | my ($handle, $data) = @_; |
|
|
1112 | }); |
|
|
1113 | |
|
|
1114 | =cut |
|
|
1115 | |
|
|
1116 | register_read_type packstring => sub { |
|
|
1117 | my ($self, $cb, $format) = @_; |
|
|
1118 | |
|
|
1119 | sub { |
|
|
1120 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1121 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
|
|
1122 | or return; |
|
|
1123 | |
|
|
1124 | $format = length pack $format, $len; |
|
|
1125 | |
|
|
1126 | # bypass unshift if we already have the remaining chunk |
|
|
1127 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1128 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1129 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1130 | $cb->($_[0], $data); |
|
|
1131 | } else { |
|
|
1132 | # remove prefix |
|
|
1133 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1134 | |
|
|
1135 | # read remaining chunk |
|
|
1136 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1137 | } |
|
|
1138 | |
|
|
1139 | 1 |
|
|
1140 | } |
|
|
1141 | }; |
|
|
1142 | |
871 | =item json => $cb->($handle, $hash_or_arrayref) |
1143 | =item json => $cb->($handle, $hash_or_arrayref) |
872 | |
1144 | |
873 | Reads a JSON object or array, decodes it and passes it to the callback. |
1145 | Reads a JSON object or array, decodes it and passes it to the callback. |
874 | |
1146 | |
875 | If a C<json> object was passed to the constructor, then that will be used |
1147 | If a C<json> object was passed to the constructor, then that will be used |
… | |
… | |
885 | the C<json> write type description, above, for an actual example. |
1157 | the C<json> write type description, above, for an actual example. |
886 | |
1158 | |
887 | =cut |
1159 | =cut |
888 | |
1160 | |
889 | register_read_type json => sub { |
1161 | register_read_type json => sub { |
890 | my ($self, $cb, $accept, $reject, $skip) = @_; |
1162 | my ($self, $cb) = @_; |
891 | |
1163 | |
892 | require JSON; |
1164 | require JSON; |
893 | |
1165 | |
894 | my $data; |
1166 | my $data; |
895 | my $rbuf = \$self->{rbuf}; |
1167 | my $rbuf = \$self->{rbuf}; |
… | |
… | |
910 | () |
1182 | () |
911 | } |
1183 | } |
912 | } |
1184 | } |
913 | }; |
1185 | }; |
914 | |
1186 | |
|
|
1187 | =item storable => $cb->($handle, $ref) |
|
|
1188 | |
|
|
1189 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1190 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1191 | data). |
|
|
1192 | |
|
|
1193 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1194 | |
|
|
1195 | =cut |
|
|
1196 | |
|
|
1197 | register_read_type storable => sub { |
|
|
1198 | my ($self, $cb) = @_; |
|
|
1199 | |
|
|
1200 | require Storable; |
|
|
1201 | |
|
|
1202 | sub { |
|
|
1203 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1204 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1205 | or return; |
|
|
1206 | |
|
|
1207 | my $format = length pack "w", $len; |
|
|
1208 | |
|
|
1209 | # bypass unshift if we already have the remaining chunk |
|
|
1210 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1211 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1212 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1213 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1214 | } else { |
|
|
1215 | # remove prefix |
|
|
1216 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1217 | |
|
|
1218 | # read remaining chunk |
|
|
1219 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1220 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1221 | $cb->($_[0], $ref); |
|
|
1222 | } else { |
|
|
1223 | $self->_error (&Errno::EBADMSG); |
|
|
1224 | } |
|
|
1225 | }); |
|
|
1226 | } |
|
|
1227 | |
|
|
1228 | 1 |
|
|
1229 | } |
|
|
1230 | }; |
|
|
1231 | |
915 | =back |
1232 | =back |
916 | |
1233 | |
917 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1234 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
918 | |
1235 | |
919 | This function (not method) lets you add your own types to C<push_read>. |
1236 | This function (not method) lets you add your own types to C<push_read>. |
… | |
… | |
937 | =item $handle->stop_read |
1254 | =item $handle->stop_read |
938 | |
1255 | |
939 | =item $handle->start_read |
1256 | =item $handle->start_read |
940 | |
1257 | |
941 | In rare cases you actually do not want to read anything from the |
1258 | In rare cases you actually do not want to read anything from the |
942 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
1259 | socket. In this case you can call C<stop_read>. Neither C<on_read> nor |
943 | any queued callbacks will be executed then. To start reading again, call |
1260 | any queued callbacks will be executed then. To start reading again, call |
944 | C<start_read>. |
1261 | C<start_read>. |
|
|
1262 | |
|
|
1263 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
|
|
1264 | you change the C<on_read> callback or push/unshift a read callback, and it |
|
|
1265 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
|
|
1266 | there are any read requests in the queue. |
945 | |
1267 | |
946 | =cut |
1268 | =cut |
947 | |
1269 | |
948 | sub stop_read { |
1270 | sub stop_read { |
949 | my ($self) = @_; |
1271 | my ($self) = @_; |
… | |
… | |
960 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1282 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
961 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1283 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
962 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1284 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
963 | |
1285 | |
964 | if ($len > 0) { |
1286 | if ($len > 0) { |
|
|
1287 | $self->{_activity} = AnyEvent->now; |
|
|
1288 | |
965 | $self->{filter_r} |
1289 | $self->{filter_r} |
966 | ? $self->{filter_r}->($self, $rbuf) |
1290 | ? $self->{filter_r}($self, $rbuf) |
967 | : $self->_drain_rbuf; |
1291 | : $self->{_in_drain} || $self->_drain_rbuf; |
968 | |
1292 | |
969 | } elsif (defined $len) { |
1293 | } elsif (defined $len) { |
970 | delete $self->{_rw}; |
1294 | delete $self->{_rw}; |
971 | $self->{_eof} = 1; |
1295 | $self->{_eof} = 1; |
972 | $self->_drain_rbuf; |
1296 | $self->_drain_rbuf unless $self->{_in_drain}; |
973 | |
1297 | |
974 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1298 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
975 | return $self->error; |
1299 | return $self->_error ($!, 1); |
976 | } |
1300 | } |
977 | }); |
1301 | }); |
978 | } |
1302 | } |
979 | } |
1303 | } |
980 | |
1304 | |
981 | sub _dotls { |
1305 | sub _dotls { |
982 | my ($self) = @_; |
1306 | my ($self) = @_; |
|
|
1307 | |
|
|
1308 | my $buf; |
983 | |
1309 | |
984 | if (length $self->{_tls_wbuf}) { |
1310 | if (length $self->{_tls_wbuf}) { |
985 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1311 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
986 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1312 | substr $self->{_tls_wbuf}, 0, $len, ""; |
987 | } |
1313 | } |
988 | } |
1314 | } |
989 | |
1315 | |
990 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1316 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
991 | $self->{wbuf} .= $buf; |
1317 | $self->{wbuf} .= $buf; |
992 | $self->_drain_wbuf; |
1318 | $self->_drain_wbuf; |
993 | } |
1319 | } |
994 | |
1320 | |
995 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
1321 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
1322 | if (length $buf) { |
996 | $self->{rbuf} .= $buf; |
1323 | $self->{rbuf} .= $buf; |
997 | $self->_drain_rbuf; |
1324 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1325 | } else { |
|
|
1326 | # let's treat SSL-eof as we treat normal EOF |
|
|
1327 | $self->{_eof} = 1; |
|
|
1328 | $self->_shutdown; |
|
|
1329 | return; |
|
|
1330 | } |
998 | } |
1331 | } |
999 | |
1332 | |
1000 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1333 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1001 | |
1334 | |
1002 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1335 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1003 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1336 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1004 | $self->error; |
1337 | return $self->_error ($!, 1); |
1005 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1338 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1006 | $! = &Errno::EIO; |
1339 | return $self->_error (&Errno::EIO, 1); |
1007 | $self->error; |
|
|
1008 | } |
1340 | } |
1009 | |
1341 | |
1010 | # all others are fine for our purposes |
1342 | # all others are fine for our purposes |
1011 | } |
1343 | } |
1012 | } |
1344 | } |
… | |
… | |
1027 | call and can be used or changed to your liking. Note that the handshake |
1359 | call and can be used or changed to your liking. Note that the handshake |
1028 | might have already started when this function returns. |
1360 | might have already started when this function returns. |
1029 | |
1361 | |
1030 | =cut |
1362 | =cut |
1031 | |
1363 | |
1032 | # TODO: maybe document... |
|
|
1033 | sub starttls { |
1364 | sub starttls { |
1034 | my ($self, $ssl, $ctx) = @_; |
1365 | my ($self, $ssl, $ctx) = @_; |
1035 | |
1366 | |
1036 | $self->stoptls; |
1367 | $self->stoptls; |
1037 | |
1368 | |
… | |
… | |
1048 | # basically, this is deep magic (because SSL_read should have the same issues) |
1379 | # basically, this is deep magic (because SSL_read should have the same issues) |
1049 | # but the openssl maintainers basically said: "trust us, it just works". |
1380 | # but the openssl maintainers basically said: "trust us, it just works". |
1050 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1381 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1051 | # and mismaintained ssleay-module doesn't even offer them). |
1382 | # and mismaintained ssleay-module doesn't even offer them). |
1052 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1383 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1384 | # |
|
|
1385 | # in short: this is a mess. |
|
|
1386 | # |
|
|
1387 | # note that we do not try to kepe the length constant between writes as we are required to do. |
|
|
1388 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
|
|
1389 | # and we drive openssl fully in blocking mode here. |
1053 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1390 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1054 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1391 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1055 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1392 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1056 | |
1393 | |
1057 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1394 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
… | |
… | |
1090 | |
1427 | |
1091 | sub DESTROY { |
1428 | sub DESTROY { |
1092 | my $self = shift; |
1429 | my $self = shift; |
1093 | |
1430 | |
1094 | $self->stoptls; |
1431 | $self->stoptls; |
|
|
1432 | |
|
|
1433 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1434 | |
|
|
1435 | if ($linger && length $self->{wbuf}) { |
|
|
1436 | my $fh = delete $self->{fh}; |
|
|
1437 | my $wbuf = delete $self->{wbuf}; |
|
|
1438 | |
|
|
1439 | my @linger; |
|
|
1440 | |
|
|
1441 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1442 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1443 | |
|
|
1444 | if ($len > 0) { |
|
|
1445 | substr $wbuf, 0, $len, ""; |
|
|
1446 | } else { |
|
|
1447 | @linger = (); # end |
|
|
1448 | } |
|
|
1449 | }); |
|
|
1450 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1451 | @linger = (); |
|
|
1452 | }); |
|
|
1453 | } |
1095 | } |
1454 | } |
1096 | |
1455 | |
1097 | =item AnyEvent::Handle::TLS_CTX |
1456 | =item AnyEvent::Handle::TLS_CTX |
1098 | |
1457 | |
1099 | This function creates and returns the Net::SSLeay::CTX object used by |
1458 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
1141 | =over 4 |
1500 | =over 4 |
1142 | |
1501 | |
1143 | =item * all constructor arguments become object members. |
1502 | =item * all constructor arguments become object members. |
1144 | |
1503 | |
1145 | At least initially, when you pass a C<tls>-argument to the constructor it |
1504 | At least initially, when you pass a C<tls>-argument to the constructor it |
1146 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1505 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1147 | mutated later on (for example C<tls> will hold the TLS connection object). |
1506 | mutated later on (for example C<tls> will hold the TLS connection object). |
1148 | |
1507 | |
1149 | =item * other object member names are prefixed with an C<_>. |
1508 | =item * other object member names are prefixed with an C<_>. |
1150 | |
1509 | |
1151 | All object members not explicitly documented (internal use) are prefixed |
1510 | All object members not explicitly documented (internal use) are prefixed |