… | |
… | |
2 | |
2 | |
3 | no warnings; |
3 | no warnings; |
4 | use strict; |
4 | use strict; |
5 | |
5 | |
6 | use AnyEvent (); |
6 | use AnyEvent (); |
7 | use AnyEvent::Util (); |
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 filehandles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
16 | |
17 | This module is experimental. |
|
|
18 | |
|
|
19 | =cut |
17 | =cut |
20 | |
18 | |
21 | our $VERSION = '0.04'; |
19 | our $VERSION = 4.14; |
22 | |
20 | |
23 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
24 | |
22 | |
25 | use AnyEvent; |
23 | use AnyEvent; |
26 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
27 | |
25 | |
28 | my $cv = AnyEvent->condvar; |
26 | my $cv = AnyEvent->condvar; |
29 | |
27 | |
30 | my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN); |
28 | my $handle = |
31 | |
|
|
32 | #TODO |
|
|
33 | |
|
|
34 | # or use the constructor to pass the callback: |
|
|
35 | |
|
|
36 | my $ae_fh2 = |
|
|
37 | AnyEvent::Handle->new ( |
29 | AnyEvent::Handle->new ( |
38 | fh => \*STDIN, |
30 | fh => \*STDIN, |
39 | on_eof => sub { |
31 | on_eof => sub { |
40 | $cv->broadcast; |
32 | $cv->broadcast; |
41 | }, |
33 | }, |
42 | #TODO |
|
|
43 | ); |
34 | ); |
44 | |
35 | |
45 | $cv->wait; |
36 | # send some request line |
|
|
37 | $handle->push_write ("getinfo\015\012"); |
|
|
38 | |
|
|
39 | # read the response line |
|
|
40 | $handle->push_read (line => sub { |
|
|
41 | my ($handle, $line) = @_; |
|
|
42 | warn "read line <$line>\n"; |
|
|
43 | $cv->send; |
|
|
44 | }); |
|
|
45 | |
|
|
46 | $cv->recv; |
46 | |
47 | |
47 | =head1 DESCRIPTION |
48 | =head1 DESCRIPTION |
48 | |
49 | |
49 | 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 |
50 | filehandles. For utility functions for doing non-blocking connects and accepts |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
… | |
… | |
72 | The filehandle this L<AnyEvent::Handle> object will operate on. |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
73 | |
74 | |
74 | NOTE: The filehandle will be set to non-blocking (using |
75 | NOTE: The filehandle will be set to non-blocking (using |
75 | AnyEvent::Util::fh_nonblocking). |
76 | AnyEvent::Util::fh_nonblocking). |
76 | |
77 | |
77 | =item on_eof => $cb->($self) |
78 | =item on_eof => $cb->($handle) |
78 | |
79 | |
79 | Set the callback to be called on EOF. |
80 | Set the callback to be called when an end-of-file condition is detcted, |
|
|
81 | i.e. in the case of a socket, when the other side has closed the |
|
|
82 | connection cleanly. |
80 | |
83 | |
81 | While not mandatory, it is highly recommended to set an eof callback, |
84 | While not mandatory, it is highly recommended to set an eof callback, |
82 | otherwise you might end up with a closed socket while you are still |
85 | otherwise you might end up with a closed socket while you are still |
83 | waiting for data. |
86 | waiting for data. |
84 | |
87 | |
85 | =item on_error => $cb->($self) |
88 | =item on_error => $cb->($handle, $fatal) |
86 | |
89 | |
87 | This is the fatal error callback, that is called when, well, a fatal error |
90 | This is the error callback, which is called when, well, some error |
88 | occurs, such as not being able to resolve the hostname, failure to connect |
91 | occured, such as not being able to resolve the hostname, failure to |
89 | or a read error. |
92 | connect or a read error. |
90 | |
93 | |
91 | The object will not be in a usable state when this callback has been |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
92 | called. |
95 | fatal errors the handle object will be shut down and will not be |
|
|
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
|
|
97 | recommended to simply ignore this parameter and instead abondon the handle |
|
|
98 | object when this callback is invoked. |
93 | |
99 | |
94 | On callback entrance, the value of C<$!> contains the operating system |
100 | On callback entrance, the value of C<$!> contains the operating system |
95 | error (or C<ENOSPC> or C<EPIPE>). |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
96 | |
102 | |
97 | While not mandatory, it is I<highly> recommended to set this callback, as |
103 | While not mandatory, it is I<highly> recommended to set this callback, as |
98 | you will not be notified of errors otherwise. The default simply calls |
104 | you will not be notified of errors otherwise. The default simply calls |
99 | die. |
105 | C<croak>. |
100 | |
106 | |
101 | =item on_read => $cb->($self) |
107 | =item on_read => $cb->($handle) |
102 | |
108 | |
103 | This sets the default read callback, which is called when data arrives |
109 | This sets the default read callback, which is called when data arrives |
104 | and no read request is in the queue. |
110 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
111 | callback will only be called when at least one octet of data is in the |
|
|
112 | read buffer). |
105 | |
113 | |
106 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
114 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
107 | method or access the C<$self->{rbuf}> member directly. |
115 | method or access the C<$handle->{rbuf}> member directly. |
108 | |
116 | |
109 | When an EOF condition is detected then AnyEvent::Handle will first try to |
117 | When an EOF condition is detected then AnyEvent::Handle will first try to |
110 | feed all the remaining data to the queued callbacks and C<on_read> before |
118 | feed all the remaining data to the queued callbacks and C<on_read> before |
111 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
119 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
112 | error will be raised (with C<$!> set to C<EPIPE>). |
120 | error will be raised (with C<$!> set to C<EPIPE>). |
113 | |
121 | |
114 | =item on_drain => $cb->() |
122 | =item on_drain => $cb->($handle) |
115 | |
123 | |
116 | This sets the callback that is called when the write buffer becomes empty |
124 | This sets the callback that is called when the write buffer becomes empty |
117 | (or when the callback is set and the buffer is empty already). |
125 | (or when the callback is set and the buffer is empty already). |
118 | |
126 | |
119 | To append to the write buffer, use the C<< ->push_write >> method. |
127 | To append to the write buffer, use the C<< ->push_write >> method. |
|
|
128 | |
|
|
129 | =item timeout => $fractional_seconds |
|
|
130 | |
|
|
131 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
|
|
132 | seconds pass without a successful read or write on the underlying file |
|
|
133 | handle, the C<on_timeout> callback will be invoked (and if that one is |
|
|
134 | missing, an C<ETIMEDOUT> error will be raised). |
|
|
135 | |
|
|
136 | Note that timeout processing is also active when you currently do not have |
|
|
137 | any outstanding read or write requests: If you plan to keep the connection |
|
|
138 | idle then you should disable the timout temporarily or ignore the timeout |
|
|
139 | in the C<on_timeout> callback. |
|
|
140 | |
|
|
141 | Zero (the default) disables this timeout. |
|
|
142 | |
|
|
143 | =item on_timeout => $cb->($handle) |
|
|
144 | |
|
|
145 | Called whenever the inactivity timeout passes. If you return from this |
|
|
146 | callback, then the timeout will be reset as if some activity had happened, |
|
|
147 | so this condition is not fatal in any way. |
120 | |
148 | |
121 | =item rbuf_max => <bytes> |
149 | =item rbuf_max => <bytes> |
122 | |
150 | |
123 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
151 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
124 | when the read buffer ever (strictly) exceeds this size. This is useful to |
152 | when the read buffer ever (strictly) exceeds this size. This is useful to |
… | |
… | |
131 | isn't finished). |
159 | isn't finished). |
132 | |
160 | |
133 | =item read_size => <bytes> |
161 | =item read_size => <bytes> |
134 | |
162 | |
135 | The default read block size (the amount of bytes this module will try to read |
163 | The default read block size (the amount of bytes this module will try to read |
136 | on each [loop iteration). Default: C<4096>. |
164 | during each (loop iteration). Default: C<8192>. |
137 | |
165 | |
138 | =item low_water_mark => <bytes> |
166 | =item low_water_mark => <bytes> |
139 | |
167 | |
140 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
168 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
141 | buffer: If the write reaches this size or gets even samller it is |
169 | buffer: If the write reaches this size or gets even samller it is |
… | |
… | |
144 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
172 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
145 | |
173 | |
146 | When this parameter is given, it enables TLS (SSL) mode, that means it |
174 | When this parameter is given, it enables TLS (SSL) mode, that means it |
147 | will start making tls handshake and will transparently encrypt/decrypt |
175 | will start making tls handshake and will transparently encrypt/decrypt |
148 | data. |
176 | data. |
|
|
177 | |
|
|
178 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
|
|
179 | automatically when you try to create a TLS handle). |
149 | |
180 | |
150 | For the TLS server side, use C<accept>, and for the TLS client side of a |
181 | For the TLS server side, use C<accept>, and for the TLS client side of a |
151 | connection, use C<connect> mode. |
182 | connection, use C<connect> mode. |
152 | |
183 | |
153 | You can also provide your own TLS connection object, but you have |
184 | You can also provide your own TLS connection object, but you have |
154 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
185 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
155 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
186 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
156 | AnyEvent::Handle. |
187 | AnyEvent::Handle. |
157 | |
188 | |
|
|
189 | See the C<starttls> method if you need to start TLs negotiation later. |
|
|
190 | |
158 | =item tls_ctx => $ssl_ctx |
191 | =item tls_ctx => $ssl_ctx |
159 | |
192 | |
160 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
193 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
161 | (unless a connection object was specified directly). If this parameter is |
194 | (unless a connection object was specified directly). If this parameter is |
162 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
195 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
163 | |
196 | |
|
|
197 | =item json => JSON or JSON::XS object |
|
|
198 | |
|
|
199 | This is the json coder object used by the C<json> read and write types. |
|
|
200 | |
|
|
201 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
202 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
|
|
203 | |
|
|
204 | Note that you are responsible to depend on the JSON module if you want to |
|
|
205 | use this functionality, as AnyEvent does not have a dependency itself. |
|
|
206 | |
|
|
207 | =item filter_r => $cb |
|
|
208 | |
|
|
209 | =item filter_w => $cb |
|
|
210 | |
|
|
211 | These exist, but are undocumented at this time. |
|
|
212 | |
164 | =back |
213 | =back |
165 | |
214 | |
166 | =cut |
215 | =cut |
167 | |
216 | |
168 | sub new { |
217 | sub new { |
… | |
… | |
177 | if ($self->{tls}) { |
226 | if ($self->{tls}) { |
178 | require Net::SSLeay; |
227 | require Net::SSLeay; |
179 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
228 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
180 | } |
229 | } |
181 | |
230 | |
182 | $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; |
231 | $self->{_activity} = AnyEvent->now; |
183 | $self->on_error (delete $self->{on_error}) if $self->{on_error}; |
232 | $self->_timeout; |
|
|
233 | |
184 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
234 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
185 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
|
|
186 | |
|
|
187 | $self->start_read; |
|
|
188 | |
235 | |
189 | $self |
236 | $self |
190 | } |
237 | } |
191 | |
238 | |
192 | sub _shutdown { |
239 | sub _shutdown { |
193 | my ($self) = @_; |
240 | my ($self) = @_; |
194 | |
241 | |
|
|
242 | delete $self->{_tw}; |
195 | delete $self->{rw}; |
243 | delete $self->{_rw}; |
196 | delete $self->{ww}; |
244 | delete $self->{_ww}; |
197 | delete $self->{fh}; |
245 | delete $self->{fh}; |
198 | } |
|
|
199 | |
246 | |
|
|
247 | $self->stoptls; |
|
|
248 | } |
|
|
249 | |
200 | sub error { |
250 | sub _error { |
201 | my ($self) = @_; |
251 | my ($self, $errno, $fatal) = @_; |
202 | |
252 | |
203 | { |
|
|
204 | local $!; |
|
|
205 | $self->_shutdown; |
253 | $self->_shutdown |
206 | } |
254 | if $fatal; |
|
|
255 | |
|
|
256 | $! = $errno; |
207 | |
257 | |
208 | if ($self->{on_error}) { |
258 | if ($self->{on_error}) { |
209 | $self->{on_error}($self); |
259 | $self->{on_error}($self, $fatal); |
210 | } else { |
260 | } else { |
211 | die "AnyEvent::Handle uncaught fatal error: $!"; |
261 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
212 | } |
262 | } |
213 | } |
263 | } |
214 | |
264 | |
215 | =item $fh = $handle->fh |
265 | =item $fh = $handle->fh |
216 | |
266 | |
217 | This method returns the filehandle of the L<AnyEvent::Handle> object. |
267 | This method returns the file handle of the L<AnyEvent::Handle> object. |
218 | |
268 | |
219 | =cut |
269 | =cut |
220 | |
270 | |
221 | sub fh { $_[0]->{fh} } |
271 | sub fh { $_[0]{fh} } |
222 | |
272 | |
223 | =item $handle->on_error ($cb) |
273 | =item $handle->on_error ($cb) |
224 | |
274 | |
225 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
275 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
226 | |
276 | |
… | |
… | |
236 | |
286 | |
237 | =cut |
287 | =cut |
238 | |
288 | |
239 | sub on_eof { |
289 | sub on_eof { |
240 | $_[0]{on_eof} = $_[1]; |
290 | $_[0]{on_eof} = $_[1]; |
|
|
291 | } |
|
|
292 | |
|
|
293 | =item $handle->on_timeout ($cb) |
|
|
294 | |
|
|
295 | Replace the current C<on_timeout> callback, or disables the callback |
|
|
296 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
|
|
297 | argument. |
|
|
298 | |
|
|
299 | =cut |
|
|
300 | |
|
|
301 | sub on_timeout { |
|
|
302 | $_[0]{on_timeout} = $_[1]; |
|
|
303 | } |
|
|
304 | |
|
|
305 | ############################################################################# |
|
|
306 | |
|
|
307 | =item $handle->timeout ($seconds) |
|
|
308 | |
|
|
309 | Configures (or disables) the inactivity timeout. |
|
|
310 | |
|
|
311 | =cut |
|
|
312 | |
|
|
313 | sub timeout { |
|
|
314 | my ($self, $timeout) = @_; |
|
|
315 | |
|
|
316 | $self->{timeout} = $timeout; |
|
|
317 | $self->_timeout; |
|
|
318 | } |
|
|
319 | |
|
|
320 | # reset the timeout watcher, as neccessary |
|
|
321 | # also check for time-outs |
|
|
322 | sub _timeout { |
|
|
323 | my ($self) = @_; |
|
|
324 | |
|
|
325 | if ($self->{timeout}) { |
|
|
326 | my $NOW = AnyEvent->now; |
|
|
327 | |
|
|
328 | # when would the timeout trigger? |
|
|
329 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
|
|
330 | |
|
|
331 | # now or in the past already? |
|
|
332 | if ($after <= 0) { |
|
|
333 | $self->{_activity} = $NOW; |
|
|
334 | |
|
|
335 | if ($self->{on_timeout}) { |
|
|
336 | $self->{on_timeout}($self); |
|
|
337 | } else { |
|
|
338 | $self->_error (&Errno::ETIMEDOUT); |
|
|
339 | } |
|
|
340 | |
|
|
341 | # callback could have changed timeout value, optimise |
|
|
342 | return unless $self->{timeout}; |
|
|
343 | |
|
|
344 | # calculate new after |
|
|
345 | $after = $self->{timeout}; |
|
|
346 | } |
|
|
347 | |
|
|
348 | Scalar::Util::weaken $self; |
|
|
349 | return unless $self; # ->error could have destroyed $self |
|
|
350 | |
|
|
351 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
|
|
352 | delete $self->{_tw}; |
|
|
353 | $self->_timeout; |
|
|
354 | }); |
|
|
355 | } else { |
|
|
356 | delete $self->{_tw}; |
|
|
357 | } |
241 | } |
358 | } |
242 | |
359 | |
243 | ############################################################################# |
360 | ############################################################################# |
244 | |
361 | |
245 | =back |
362 | =back |
… | |
… | |
282 | =cut |
399 | =cut |
283 | |
400 | |
284 | sub _drain_wbuf { |
401 | sub _drain_wbuf { |
285 | my ($self) = @_; |
402 | my ($self) = @_; |
286 | |
403 | |
287 | unless ($self->{ww}) { |
404 | if (!$self->{_ww} && length $self->{wbuf}) { |
|
|
405 | |
288 | Scalar::Util::weaken $self; |
406 | Scalar::Util::weaken $self; |
|
|
407 | |
289 | my $cb = sub { |
408 | my $cb = sub { |
290 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
409 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
291 | |
410 | |
292 | if ($len > 0) { |
411 | if ($len >= 0) { |
293 | substr $self->{wbuf}, 0, $len, ""; |
412 | substr $self->{wbuf}, 0, $len, ""; |
|
|
413 | |
|
|
414 | $self->{_activity} = AnyEvent->now; |
294 | |
415 | |
295 | $self->{on_drain}($self) |
416 | $self->{on_drain}($self) |
296 | if $self->{low_water_mark} >= length $self->{wbuf} |
417 | if $self->{low_water_mark} >= length $self->{wbuf} |
297 | && $self->{on_drain}; |
418 | && $self->{on_drain}; |
298 | |
419 | |
299 | delete $self->{ww} unless length $self->{wbuf}; |
420 | delete $self->{_ww} unless length $self->{wbuf}; |
300 | } elsif ($! != EAGAIN && $! != EINTR) { |
421 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
301 | $self->error; |
422 | $self->_error ($!, 1); |
302 | } |
423 | } |
303 | }; |
424 | }; |
304 | |
425 | |
|
|
426 | # try to write data immediately |
|
|
427 | $cb->(); |
|
|
428 | |
|
|
429 | # if still data left in wbuf, we need to poll |
305 | $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb); |
430 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
306 | |
431 | if length $self->{wbuf}; |
307 | $cb->($self); |
|
|
308 | }; |
432 | }; |
|
|
433 | } |
|
|
434 | |
|
|
435 | our %WH; |
|
|
436 | |
|
|
437 | sub register_write_type($$) { |
|
|
438 | $WH{$_[0]} = $_[1]; |
309 | } |
439 | } |
310 | |
440 | |
311 | sub push_write { |
441 | sub push_write { |
312 | my $self = shift; |
442 | my $self = shift; |
313 | |
443 | |
|
|
444 | if (@_ > 1) { |
|
|
445 | my $type = shift; |
|
|
446 | |
|
|
447 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
|
|
448 | ->($self, @_); |
|
|
449 | } |
|
|
450 | |
314 | if ($self->{filter_w}) { |
451 | if ($self->{filter_w}) { |
315 | $self->{filter_w}->($self, \$_[0]); |
452 | $self->{filter_w}($self, \$_[0]); |
316 | } else { |
453 | } else { |
317 | $self->{wbuf} .= $_[0]; |
454 | $self->{wbuf} .= $_[0]; |
318 | $self->_drain_wbuf; |
455 | $self->_drain_wbuf; |
319 | } |
456 | } |
320 | } |
457 | } |
|
|
458 | |
|
|
459 | =item $handle->push_write (type => @args) |
|
|
460 | |
|
|
461 | Instead of formatting your data yourself, you can also let this module do |
|
|
462 | the job by specifying a type and type-specific arguments. |
|
|
463 | |
|
|
464 | Predefined types are (if you have ideas for additional types, feel free to |
|
|
465 | drop by and tell us): |
|
|
466 | |
|
|
467 | =over 4 |
|
|
468 | |
|
|
469 | =item netstring => $string |
|
|
470 | |
|
|
471 | Formats the given value as netstring |
|
|
472 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
|
|
473 | |
|
|
474 | =cut |
|
|
475 | |
|
|
476 | register_write_type netstring => sub { |
|
|
477 | my ($self, $string) = @_; |
|
|
478 | |
|
|
479 | sprintf "%d:%s,", (length $string), $string |
|
|
480 | }; |
|
|
481 | |
|
|
482 | =item packstring => $format, $data |
|
|
483 | |
|
|
484 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
485 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
486 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
487 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
488 | |
|
|
489 | =cut |
|
|
490 | |
|
|
491 | register_write_type packstring => sub { |
|
|
492 | my ($self, $format, $string) = @_; |
|
|
493 | |
|
|
494 | pack "$format/a", $string |
|
|
495 | }; |
|
|
496 | |
|
|
497 | =item json => $array_or_hashref |
|
|
498 | |
|
|
499 | Encodes the given hash or array reference into a JSON object. Unless you |
|
|
500 | provide your own JSON object, this means it will be encoded to JSON text |
|
|
501 | in UTF-8. |
|
|
502 | |
|
|
503 | JSON objects (and arrays) are self-delimiting, so you can write JSON at |
|
|
504 | one end of a handle and read them at the other end without using any |
|
|
505 | additional framing. |
|
|
506 | |
|
|
507 | The generated JSON text is guaranteed not to contain any newlines: While |
|
|
508 | this module doesn't need delimiters after or between JSON texts to be |
|
|
509 | able to read them, many other languages depend on that. |
|
|
510 | |
|
|
511 | A simple RPC protocol that interoperates easily with others is to send |
|
|
512 | JSON arrays (or objects, although arrays are usually the better choice as |
|
|
513 | they mimic how function argument passing works) and a newline after each |
|
|
514 | JSON text: |
|
|
515 | |
|
|
516 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
|
|
517 | $handle->push_write ("\012"); |
|
|
518 | |
|
|
519 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
|
|
520 | rely on the fact that the newline will be skipped as leading whitespace: |
|
|
521 | |
|
|
522 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
|
|
523 | |
|
|
524 | Other languages could read single lines terminated by a newline and pass |
|
|
525 | this line into their JSON decoder of choice. |
|
|
526 | |
|
|
527 | =cut |
|
|
528 | |
|
|
529 | register_write_type json => sub { |
|
|
530 | my ($self, $ref) = @_; |
|
|
531 | |
|
|
532 | require JSON; |
|
|
533 | |
|
|
534 | $self->{json} ? $self->{json}->encode ($ref) |
|
|
535 | : JSON::encode_json ($ref) |
|
|
536 | }; |
|
|
537 | |
|
|
538 | =back |
|
|
539 | |
|
|
540 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
|
|
541 | |
|
|
542 | This function (not method) lets you add your own types to C<push_write>. |
|
|
543 | Whenever the given C<type> is used, C<push_write> will invoke the code |
|
|
544 | reference with the handle object and the remaining arguments. |
|
|
545 | |
|
|
546 | The code reference is supposed to return a single octet string that will |
|
|
547 | be appended to the write buffer. |
|
|
548 | |
|
|
549 | Note that this is a function, and all types registered this way will be |
|
|
550 | global, so try to use unique names. |
|
|
551 | |
|
|
552 | =cut |
321 | |
553 | |
322 | ############################################################################# |
554 | ############################################################################# |
323 | |
555 | |
324 | =back |
556 | =back |
325 | |
557 | |
… | |
… | |
337 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
569 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
338 | or not. |
570 | or not. |
339 | |
571 | |
340 | In the more complex case, you want to queue multiple callbacks. In this |
572 | In the more complex case, you want to queue multiple callbacks. In this |
341 | case, AnyEvent::Handle will call the first queued callback each time new |
573 | case, AnyEvent::Handle will call the first queued callback each time new |
342 | data arrives and removes it when it has done its job (see C<push_read>, |
574 | data arrives (also the first time it is queued) and removes it when it has |
343 | below). |
575 | done its job (see C<push_read>, below). |
344 | |
576 | |
345 | This way you can, for example, push three line-reads, followed by reading |
577 | This way you can, for example, push three line-reads, followed by reading |
346 | a chunk of data, and AnyEvent::Handle will execute them in order. |
578 | a chunk of data, and AnyEvent::Handle will execute them in order. |
347 | |
579 | |
348 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
580 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
349 | the specified number of bytes which give an XML datagram. |
581 | the specified number of bytes which give an XML datagram. |
350 | |
582 | |
351 | # in the default state, expect some header bytes |
583 | # in the default state, expect some header bytes |
352 | $handle->on_read (sub { |
584 | $handle->on_read (sub { |
353 | # some data is here, now queue the length-header-read (4 octets) |
585 | # some data is here, now queue the length-header-read (4 octets) |
354 | shift->unshift_read_chunk (4, sub { |
586 | shift->unshift_read (chunk => 4, sub { |
355 | # header arrived, decode |
587 | # header arrived, decode |
356 | my $len = unpack "N", $_[1]; |
588 | my $len = unpack "N", $_[1]; |
357 | |
589 | |
358 | # now read the payload |
590 | # now read the payload |
359 | shift->unshift_read_chunk ($len, sub { |
591 | shift->unshift_read (chunk => $len, sub { |
360 | my $xml = $_[1]; |
592 | my $xml = $_[1]; |
361 | # handle xml |
593 | # handle xml |
362 | }); |
594 | }); |
363 | }); |
595 | }); |
364 | }); |
596 | }); |
… | |
… | |
371 | |
603 | |
372 | # request one |
604 | # request one |
373 | $handle->push_write ("request 1\015\012"); |
605 | $handle->push_write ("request 1\015\012"); |
374 | |
606 | |
375 | # we expect "ERROR" or "OK" as response, so push a line read |
607 | # we expect "ERROR" or "OK" as response, so push a line read |
376 | $handle->push_read_line (sub { |
608 | $handle->push_read (line => sub { |
377 | # if we got an "OK", we have to _prepend_ another line, |
609 | # if we got an "OK", we have to _prepend_ another line, |
378 | # so it will be read before the second request reads its 64 bytes |
610 | # so it will be read before the second request reads its 64 bytes |
379 | # which are already in the queue when this callback is called |
611 | # which are already in the queue when this callback is called |
380 | # we don't do this in case we got an error |
612 | # we don't do this in case we got an error |
381 | if ($_[1] eq "OK") { |
613 | if ($_[1] eq "OK") { |
382 | $_[0]->unshift_read_line (sub { |
614 | $_[0]->unshift_read (line => sub { |
383 | my $response = $_[1]; |
615 | my $response = $_[1]; |
384 | ... |
616 | ... |
385 | }); |
617 | }); |
386 | } |
618 | } |
387 | }); |
619 | }); |
388 | |
620 | |
389 | # request two |
621 | # request two |
390 | $handle->push_write ("request 2\015\012"); |
622 | $handle->push_write ("request 2\015\012"); |
391 | |
623 | |
392 | # simply read 64 bytes, always |
624 | # simply read 64 bytes, always |
393 | $handle->push_read_chunk (64, sub { |
625 | $handle->push_read (chunk => 64, sub { |
394 | my $response = $_[1]; |
626 | my $response = $_[1]; |
395 | ... |
627 | ... |
396 | }); |
628 | }); |
397 | |
629 | |
398 | =over 4 |
630 | =over 4 |
399 | |
631 | |
400 | =cut |
632 | =cut |
401 | |
633 | |
402 | sub _drain_rbuf { |
634 | sub _drain_rbuf { |
403 | my ($self) = @_; |
635 | my ($self) = @_; |
|
|
636 | |
|
|
637 | local $self->{_in_drain} = 1; |
404 | |
638 | |
405 | if ( |
639 | if ( |
406 | defined $self->{rbuf_max} |
640 | defined $self->{rbuf_max} |
407 | && $self->{rbuf_max} < length $self->{rbuf} |
641 | && $self->{rbuf_max} < length $self->{rbuf} |
408 | ) { |
642 | ) { |
409 | $! = &Errno::ENOSPC; return $self->error; |
643 | return $self->_error (&Errno::ENOSPC, 1); |
410 | } |
644 | } |
411 | |
645 | |
412 | return if $self->{in_drain}; |
646 | while () { |
413 | local $self->{in_drain} = 1; |
|
|
414 | |
|
|
415 | while (my $len = length $self->{rbuf}) { |
|
|
416 | no strict 'refs'; |
647 | no strict 'refs'; |
|
|
648 | |
|
|
649 | my $len = length $self->{rbuf}; |
|
|
650 | |
417 | if (my $cb = shift @{ $self->{queue} }) { |
651 | if (my $cb = shift @{ $self->{_queue} }) { |
418 | if (!$cb->($self)) { |
652 | unless ($cb->($self)) { |
419 | if ($self->{eof}) { |
653 | if ($self->{_eof}) { |
420 | # no progress can be made (not enough data and no data forthcoming) |
654 | # no progress can be made (not enough data and no data forthcoming) |
421 | $! = &Errno::EPIPE; return $self->error; |
655 | $self->_error (&Errno::EPIPE, 1), last; |
422 | } |
656 | } |
423 | |
657 | |
424 | unshift @{ $self->{queue} }, $cb; |
658 | unshift @{ $self->{_queue} }, $cb; |
425 | return; |
659 | last; |
426 | } |
660 | } |
427 | } elsif ($self->{on_read}) { |
661 | } elsif ($self->{on_read}) { |
|
|
662 | last unless $len; |
|
|
663 | |
428 | $self->{on_read}($self); |
664 | $self->{on_read}($self); |
429 | |
665 | |
430 | if ( |
666 | if ( |
431 | $self->{eof} # if no further data will arrive |
|
|
432 | && $len == length $self->{rbuf} # and no data has been consumed |
667 | $len == length $self->{rbuf} # if no data has been consumed |
433 | && !@{ $self->{queue} } # and the queue is still empty |
668 | && !@{ $self->{_queue} } # and the queue is still empty |
434 | && $self->{on_read} # and we still want to read data |
669 | && $self->{on_read} # but we still have on_read |
435 | ) { |
670 | ) { |
|
|
671 | # no further data will arrive |
436 | # then no progress can be made |
672 | # so no progress can be made |
437 | $! = &Errno::EPIPE; return $self->error; |
673 | $self->_error (&Errno::EPIPE, 1), last |
|
|
674 | if $self->{_eof}; |
|
|
675 | |
|
|
676 | last; # more data might arrive |
438 | } |
677 | } |
439 | } else { |
678 | } else { |
440 | # read side becomes idle |
679 | # read side becomes idle |
441 | delete $self->{rw}; |
680 | delete $self->{_rw}; |
442 | return; |
681 | last; |
443 | } |
682 | } |
444 | } |
683 | } |
445 | |
684 | |
446 | if ($self->{eof}) { |
|
|
447 | $self->_shutdown; |
|
|
448 | $self->{on_eof}($self) |
685 | $self->{on_eof}($self) |
449 | if $self->{on_eof}; |
686 | if $self->{_eof} && $self->{on_eof}; |
|
|
687 | |
|
|
688 | # may need to restart read watcher |
|
|
689 | unless ($self->{_rw}) { |
|
|
690 | $self->start_read |
|
|
691 | if $self->{on_read} || @{ $self->{_queue} }; |
450 | } |
692 | } |
451 | } |
693 | } |
452 | |
694 | |
453 | =item $handle->on_read ($cb) |
695 | =item $handle->on_read ($cb) |
454 | |
696 | |
… | |
… | |
460 | |
702 | |
461 | sub on_read { |
703 | sub on_read { |
462 | my ($self, $cb) = @_; |
704 | my ($self, $cb) = @_; |
463 | |
705 | |
464 | $self->{on_read} = $cb; |
706 | $self->{on_read} = $cb; |
|
|
707 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
465 | } |
708 | } |
466 | |
709 | |
467 | =item $handle->rbuf |
710 | =item $handle->rbuf |
468 | |
711 | |
469 | Returns the read buffer (as a modifiable lvalue). |
712 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
500 | interested in (which can be none at all) and return a true value. After returning |
743 | interested in (which can be none at all) and return a true value. After returning |
501 | true, it will be removed from the queue. |
744 | true, it will be removed from the queue. |
502 | |
745 | |
503 | =cut |
746 | =cut |
504 | |
747 | |
|
|
748 | our %RH; |
|
|
749 | |
|
|
750 | sub register_read_type($$) { |
|
|
751 | $RH{$_[0]} = $_[1]; |
|
|
752 | } |
|
|
753 | |
505 | sub push_read { |
754 | sub push_read { |
506 | my ($self, $cb) = @_; |
755 | my $self = shift; |
|
|
756 | my $cb = pop; |
507 | |
757 | |
|
|
758 | if (@_) { |
|
|
759 | my $type = shift; |
|
|
760 | |
|
|
761 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
|
|
762 | ->($self, $cb, @_); |
|
|
763 | } |
|
|
764 | |
508 | push @{ $self->{queue} }, $cb; |
765 | push @{ $self->{_queue} }, $cb; |
509 | $self->_drain_rbuf; |
766 | $self->_drain_rbuf unless $self->{_in_drain}; |
510 | } |
767 | } |
511 | |
768 | |
512 | sub unshift_read { |
769 | sub unshift_read { |
513 | my ($self, $cb) = @_; |
770 | my $self = shift; |
|
|
771 | my $cb = pop; |
514 | |
772 | |
|
|
773 | if (@_) { |
|
|
774 | my $type = shift; |
|
|
775 | |
|
|
776 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
|
|
777 | ->($self, $cb, @_); |
|
|
778 | } |
|
|
779 | |
|
|
780 | |
515 | push @{ $self->{queue} }, $cb; |
781 | unshift @{ $self->{_queue} }, $cb; |
516 | $self->_drain_rbuf; |
782 | $self->_drain_rbuf unless $self->{_in_drain}; |
517 | } |
783 | } |
518 | |
784 | |
519 | =item $handle->push_read_chunk ($len, $cb->($self, $data)) |
785 | =item $handle->push_read (type => @args, $cb) |
520 | |
786 | |
521 | =item $handle->unshift_read_chunk ($len, $cb->($self, $data)) |
787 | =item $handle->unshift_read (type => @args, $cb) |
522 | |
788 | |
523 | Append the given callback to the end of the queue (C<push_read_chunk>) or |
789 | Instead of providing a callback that parses the data itself you can chose |
524 | prepend it (C<unshift_read_chunk>). |
790 | between a number of predefined parsing formats, for chunks of data, lines |
|
|
791 | etc. |
525 | |
792 | |
526 | The callback will be called only once C<$len> bytes have been read, and |
793 | Predefined types are (if you have ideas for additional types, feel free to |
527 | these C<$len> bytes will be passed to the callback. |
794 | drop by and tell us): |
528 | |
795 | |
529 | =cut |
796 | =over 4 |
530 | |
797 | |
531 | sub _read_chunk($$) { |
798 | =item chunk => $octets, $cb->($handle, $data) |
|
|
799 | |
|
|
800 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
|
|
801 | data read to the callback. The callback will never be called with less |
|
|
802 | data. |
|
|
803 | |
|
|
804 | Example: read 2 bytes. |
|
|
805 | |
|
|
806 | $handle->push_read (chunk => 2, sub { |
|
|
807 | warn "yay ", unpack "H*", $_[1]; |
|
|
808 | }); |
|
|
809 | |
|
|
810 | =cut |
|
|
811 | |
|
|
812 | register_read_type chunk => sub { |
532 | my ($self, $len, $cb) = @_; |
813 | my ($self, $cb, $len) = @_; |
533 | |
814 | |
534 | sub { |
815 | sub { |
535 | $len <= length $_[0]{rbuf} or return; |
816 | $len <= length $_[0]{rbuf} or return; |
536 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
817 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
537 | 1 |
818 | 1 |
538 | } |
819 | } |
539 | } |
820 | }; |
540 | |
821 | |
|
|
822 | # compatibility with older API |
541 | sub push_read_chunk { |
823 | sub push_read_chunk { |
542 | $_[0]->push_read (&_read_chunk); |
824 | $_[0]->push_read (chunk => $_[1], $_[2]); |
543 | } |
825 | } |
544 | |
|
|
545 | |
826 | |
546 | sub unshift_read_chunk { |
827 | sub unshift_read_chunk { |
547 | $_[0]->unshift_read (&_read_chunk); |
828 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
548 | } |
829 | } |
549 | |
830 | |
550 | =item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol)) |
831 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
551 | |
|
|
552 | =item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol)) |
|
|
553 | |
|
|
554 | Append the given callback to the end of the queue (C<push_read_line>) or |
|
|
555 | prepend it (C<unshift_read_line>). |
|
|
556 | |
832 | |
557 | The callback will be called only once a full line (including the end of |
833 | The callback will be called only once a full line (including the end of |
558 | line marker, C<$eol>) has been read. This line (excluding the end of line |
834 | line marker, C<$eol>) has been read. This line (excluding the end of line |
559 | marker) will be passed to the callback as second argument (C<$line>), and |
835 | marker) will be passed to the callback as second argument (C<$line>), and |
560 | the end of line marker as the third argument (C<$eol>). |
836 | the end of line marker as the third argument (C<$eol>). |
… | |
… | |
571 | Partial lines at the end of the stream will never be returned, as they are |
847 | Partial lines at the end of the stream will never be returned, as they are |
572 | not marked by the end of line marker. |
848 | not marked by the end of line marker. |
573 | |
849 | |
574 | =cut |
850 | =cut |
575 | |
851 | |
576 | sub _read_line($$) { |
852 | register_read_type line => sub { |
577 | my $self = shift; |
853 | my ($self, $cb, $eol) = @_; |
578 | my $cb = pop; |
|
|
579 | my $eol = @_ ? shift : qr|(\015?\012)|; |
|
|
580 | my $pos; |
|
|
581 | |
854 | |
|
|
855 | $eol = qr|(\015?\012)| if @_ < 3; |
582 | $eol = quotemeta $eol unless ref $eol; |
856 | $eol = quotemeta $eol unless ref $eol; |
583 | $eol = qr|^(.*?)($eol)|s; |
857 | $eol = qr|^(.*?)($eol)|s; |
584 | |
858 | |
585 | sub { |
859 | sub { |
586 | $_[0]{rbuf} =~ s/$eol// or return; |
860 | $_[0]{rbuf} =~ s/$eol// or return; |
587 | |
861 | |
588 | $cb->($_[0], $1, $2); |
862 | $cb->($_[0], $1, $2); |
589 | 1 |
863 | 1 |
590 | } |
864 | } |
591 | } |
865 | }; |
592 | |
866 | |
|
|
867 | # compatibility with older API |
593 | sub push_read_line { |
868 | sub push_read_line { |
594 | $_[0]->push_read (&_read_line); |
869 | my $self = shift; |
|
|
870 | $self->push_read (line => @_); |
595 | } |
871 | } |
596 | |
872 | |
597 | sub unshift_read_line { |
873 | sub unshift_read_line { |
598 | $_[0]->unshift_read (&_read_line); |
874 | my $self = shift; |
|
|
875 | $self->unshift_read (line => @_); |
599 | } |
876 | } |
|
|
877 | |
|
|
878 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
|
|
879 | |
|
|
880 | Makes a regex match against the regex object C<$accept> and returns |
|
|
881 | everything up to and including the match. |
|
|
882 | |
|
|
883 | Example: read a single line terminated by '\n'. |
|
|
884 | |
|
|
885 | $handle->push_read (regex => qr<\n>, sub { ... }); |
|
|
886 | |
|
|
887 | If C<$reject> is given and not undef, then it determines when the data is |
|
|
888 | to be rejected: it is matched against the data when the C<$accept> regex |
|
|
889 | does not match and generates an C<EBADMSG> error when it matches. This is |
|
|
890 | useful to quickly reject wrong data (to avoid waiting for a timeout or a |
|
|
891 | receive buffer overflow). |
|
|
892 | |
|
|
893 | Example: expect a single decimal number followed by whitespace, reject |
|
|
894 | anything else (not the use of an anchor). |
|
|
895 | |
|
|
896 | $handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... }); |
|
|
897 | |
|
|
898 | If C<$skip> is given and not C<undef>, then it will be matched against |
|
|
899 | the receive buffer when neither C<$accept> nor C<$reject> match, |
|
|
900 | and everything preceding and including the match will be accepted |
|
|
901 | unconditionally. This is useful to skip large amounts of data that you |
|
|
902 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
|
|
903 | have to start matching from the beginning. This is purely an optimisation |
|
|
904 | and is usually worth only when you expect more than a few kilobytes. |
|
|
905 | |
|
|
906 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
|
|
907 | expect the header to be very large (it isn't in practise, but...), we use |
|
|
908 | a skip regex to skip initial portions. The skip regex is tricky in that |
|
|
909 | it only accepts something not ending in either \015 or \012, as these are |
|
|
910 | required for the accept regex. |
|
|
911 | |
|
|
912 | $handle->push_read (regex => |
|
|
913 | qr<\015\012\015\012>, |
|
|
914 | undef, # no reject |
|
|
915 | qr<^.*[^\015\012]>, |
|
|
916 | sub { ... }); |
|
|
917 | |
|
|
918 | =cut |
|
|
919 | |
|
|
920 | register_read_type regex => sub { |
|
|
921 | my ($self, $cb, $accept, $reject, $skip) = @_; |
|
|
922 | |
|
|
923 | my $data; |
|
|
924 | my $rbuf = \$self->{rbuf}; |
|
|
925 | |
|
|
926 | sub { |
|
|
927 | # accept |
|
|
928 | if ($$rbuf =~ $accept) { |
|
|
929 | $data .= substr $$rbuf, 0, $+[0], ""; |
|
|
930 | $cb->($self, $data); |
|
|
931 | return 1; |
|
|
932 | } |
|
|
933 | |
|
|
934 | # reject |
|
|
935 | if ($reject && $$rbuf =~ $reject) { |
|
|
936 | $self->_error (&Errno::EBADMSG); |
|
|
937 | } |
|
|
938 | |
|
|
939 | # skip |
|
|
940 | if ($skip && $$rbuf =~ $skip) { |
|
|
941 | $data .= substr $$rbuf, 0, $+[0], ""; |
|
|
942 | } |
|
|
943 | |
|
|
944 | () |
|
|
945 | } |
|
|
946 | }; |
|
|
947 | |
|
|
948 | =item netstring => $cb->($handle, $string) |
|
|
949 | |
|
|
950 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
951 | |
|
|
952 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
953 | |
|
|
954 | =cut |
|
|
955 | |
|
|
956 | register_read_type netstring => sub { |
|
|
957 | my ($self, $cb) = @_; |
|
|
958 | |
|
|
959 | sub { |
|
|
960 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
961 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
962 | $self->_error (&Errno::EBADMSG); |
|
|
963 | } |
|
|
964 | return; |
|
|
965 | } |
|
|
966 | |
|
|
967 | my $len = $1; |
|
|
968 | |
|
|
969 | $self->unshift_read (chunk => $len, sub { |
|
|
970 | my $string = $_[1]; |
|
|
971 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
972 | if ($_[1] eq ",") { |
|
|
973 | $cb->($_[0], $string); |
|
|
974 | } else { |
|
|
975 | $self->_error (&Errno::EBADMSG); |
|
|
976 | } |
|
|
977 | }); |
|
|
978 | }); |
|
|
979 | |
|
|
980 | 1 |
|
|
981 | } |
|
|
982 | }; |
|
|
983 | |
|
|
984 | =item packstring => $format, $cb->($handle, $string) |
|
|
985 | |
|
|
986 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
987 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
988 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
989 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
990 | |
|
|
991 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
992 | |
|
|
993 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
994 | format (very efficient). |
|
|
995 | |
|
|
996 | $handle->push_read (packstring => "w", sub { |
|
|
997 | my ($handle, $data) = @_; |
|
|
998 | }); |
|
|
999 | |
|
|
1000 | =cut |
|
|
1001 | |
|
|
1002 | register_read_type packstring => sub { |
|
|
1003 | my ($self, $cb, $format) = @_; |
|
|
1004 | |
|
|
1005 | sub { |
|
|
1006 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1007 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
|
|
1008 | or return; |
|
|
1009 | |
|
|
1010 | # remove prefix |
|
|
1011 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
|
|
1012 | |
|
|
1013 | # read rest |
|
|
1014 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1015 | |
|
|
1016 | 1 |
|
|
1017 | } |
|
|
1018 | }; |
|
|
1019 | |
|
|
1020 | =item json => $cb->($handle, $hash_or_arrayref) |
|
|
1021 | |
|
|
1022 | Reads a JSON object or array, decodes it and passes it to the callback. |
|
|
1023 | |
|
|
1024 | If a C<json> object was passed to the constructor, then that will be used |
|
|
1025 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
|
|
1026 | |
|
|
1027 | This read type uses the incremental parser available with JSON version |
|
|
1028 | 2.09 (and JSON::XS version 2.2) and above. You have to provide a |
|
|
1029 | dependency on your own: this module will load the JSON module, but |
|
|
1030 | AnyEvent does not depend on it itself. |
|
|
1031 | |
|
|
1032 | Since JSON texts are fully self-delimiting, the C<json> read and write |
|
|
1033 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
|
|
1034 | the C<json> write type description, above, for an actual example. |
|
|
1035 | |
|
|
1036 | =cut |
|
|
1037 | |
|
|
1038 | register_read_type json => sub { |
|
|
1039 | my ($self, $cb, $accept, $reject, $skip) = @_; |
|
|
1040 | |
|
|
1041 | require JSON; |
|
|
1042 | |
|
|
1043 | my $data; |
|
|
1044 | my $rbuf = \$self->{rbuf}; |
|
|
1045 | |
|
|
1046 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
1047 | |
|
|
1048 | sub { |
|
|
1049 | my $ref = $json->incr_parse ($self->{rbuf}); |
|
|
1050 | |
|
|
1051 | if ($ref) { |
|
|
1052 | $self->{rbuf} = $json->incr_text; |
|
|
1053 | $json->incr_text = ""; |
|
|
1054 | $cb->($self, $ref); |
|
|
1055 | |
|
|
1056 | 1 |
|
|
1057 | } else { |
|
|
1058 | $self->{rbuf} = ""; |
|
|
1059 | () |
|
|
1060 | } |
|
|
1061 | } |
|
|
1062 | }; |
|
|
1063 | |
|
|
1064 | =back |
|
|
1065 | |
|
|
1066 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
|
|
1067 | |
|
|
1068 | This function (not method) lets you add your own types to C<push_read>. |
|
|
1069 | |
|
|
1070 | Whenever the given C<type> is used, C<push_read> will invoke the code |
|
|
1071 | reference with the handle object, the callback and the remaining |
|
|
1072 | arguments. |
|
|
1073 | |
|
|
1074 | The code reference is supposed to return a callback (usually a closure) |
|
|
1075 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
|
|
1076 | |
|
|
1077 | It should invoke the passed callback when it is done reading (remember to |
|
|
1078 | pass C<$handle> as first argument as all other callbacks do that). |
|
|
1079 | |
|
|
1080 | Note that this is a function, and all types registered this way will be |
|
|
1081 | global, so try to use unique names. |
|
|
1082 | |
|
|
1083 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
|
|
1084 | search for C<register_read_type>)). |
600 | |
1085 | |
601 | =item $handle->stop_read |
1086 | =item $handle->stop_read |
602 | |
1087 | |
603 | =item $handle->start_read |
1088 | =item $handle->start_read |
604 | |
1089 | |
605 | In rare cases you actually do not want to read anything from the |
1090 | In rare cases you actually do not want to read anything from the |
606 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
1091 | socket. In this case you can call C<stop_read>. Neither C<on_read> nor |
607 | any queued callbacks will be executed then. To start readign again, call |
1092 | any queued callbacks will be executed then. To start reading again, call |
608 | C<start_read>. |
1093 | C<start_read>. |
|
|
1094 | |
|
|
1095 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
|
|
1096 | you change the C<on_read> callback or push/unshift a read callback, and it |
|
|
1097 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
|
|
1098 | there are any read requests in the queue. |
609 | |
1099 | |
610 | =cut |
1100 | =cut |
611 | |
1101 | |
612 | sub stop_read { |
1102 | sub stop_read { |
613 | my ($self) = @_; |
1103 | my ($self) = @_; |
614 | |
1104 | |
615 | delete $self->{rw}; |
1105 | delete $self->{_rw}; |
616 | } |
1106 | } |
617 | |
1107 | |
618 | sub start_read { |
1108 | sub start_read { |
619 | my ($self) = @_; |
1109 | my ($self) = @_; |
620 | |
1110 | |
621 | unless ($self->{rw} || $self->{eof}) { |
1111 | unless ($self->{_rw} || $self->{_eof}) { |
622 | Scalar::Util::weaken $self; |
1112 | Scalar::Util::weaken $self; |
623 | |
1113 | |
624 | $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1114 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
625 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1115 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
626 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1116 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
627 | |
1117 | |
628 | if ($len > 0) { |
1118 | if ($len > 0) { |
|
|
1119 | $self->{_activity} = AnyEvent->now; |
|
|
1120 | |
629 | $self->{filter_r} |
1121 | $self->{filter_r} |
630 | ? $self->{filter_r}->($self, $rbuf) |
1122 | ? $self->{filter_r}($self, $rbuf) |
631 | : $self->_drain_rbuf; |
1123 | : $self->{_in_drain} || $self->_drain_rbuf; |
632 | |
1124 | |
633 | } elsif (defined $len) { |
1125 | } elsif (defined $len) { |
634 | delete $self->{rw}; |
1126 | delete $self->{_rw}; |
635 | $self->{eof} = 1; |
1127 | $self->{_eof} = 1; |
636 | $self->_drain_rbuf; |
1128 | $self->_drain_rbuf unless $self->{_in_drain}; |
637 | |
1129 | |
638 | } elsif ($! != EAGAIN && $! != EINTR) { |
1130 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
639 | return $self->error; |
1131 | return $self->_error ($!, 1); |
640 | } |
1132 | } |
641 | }); |
1133 | }); |
642 | } |
1134 | } |
643 | } |
1135 | } |
644 | |
1136 | |
645 | sub _dotls { |
1137 | sub _dotls { |
646 | my ($self) = @_; |
1138 | my ($self) = @_; |
647 | |
1139 | |
|
|
1140 | my $buf; |
|
|
1141 | |
648 | if (length $self->{tls_wbuf}) { |
1142 | if (length $self->{_tls_wbuf}) { |
649 | my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf}); |
1143 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
650 | substr $self->{tls_wbuf}, 0, $len, "" if $len > 0; |
1144 | substr $self->{_tls_wbuf}, 0, $len, ""; |
|
|
1145 | } |
651 | } |
1146 | } |
652 | |
1147 | |
653 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) { |
1148 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
654 | $self->{wbuf} .= $buf; |
1149 | $self->{wbuf} .= $buf; |
655 | $self->_drain_wbuf; |
1150 | $self->_drain_wbuf; |
656 | } |
1151 | } |
657 | |
1152 | |
658 | if (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
1153 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
1154 | if (length $buf) { |
659 | $self->{rbuf} .= $buf; |
1155 | $self->{rbuf} .= $buf; |
660 | $self->_drain_rbuf; |
1156 | $self->_drain_rbuf unless $self->{_in_drain}; |
661 | } elsif ( |
1157 | } else { |
|
|
1158 | # let's treat SSL-eof as we treat normal EOF |
|
|
1159 | $self->{_eof} = 1; |
|
|
1160 | $self->_shutdown; |
|
|
1161 | return; |
|
|
1162 | } |
|
|
1163 | } |
|
|
1164 | |
662 | (my $err = Net::SSLeay::get_error ($self->{tls}, -1)) |
1165 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
|
|
1166 | |
663 | != Net::SSLeay::ERROR_WANT_READ () |
1167 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
664 | ) { |
|
|
665 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1168 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
666 | $self->error; |
1169 | return $self->_error ($!, 1); |
667 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1170 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
668 | $! = &Errno::EIO; |
1171 | return $self->_error (&Errno::EIO, 1); |
669 | $self->error; |
|
|
670 | } |
1172 | } |
671 | |
1173 | |
672 | # all others are fine for our purposes |
1174 | # all others are fine for our purposes |
673 | } |
1175 | } |
674 | } |
1176 | } |
675 | |
1177 | |
676 | # TODO: maybe document... |
1178 | =item $handle->starttls ($tls[, $tls_ctx]) |
|
|
1179 | |
|
|
1180 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
|
|
1181 | object is created, you can also do that at a later time by calling |
|
|
1182 | C<starttls>. |
|
|
1183 | |
|
|
1184 | The first argument is the same as the C<tls> constructor argument (either |
|
|
1185 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
|
|
1186 | |
|
|
1187 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
|
|
1188 | used when AnyEvent::Handle has to create its own TLS connection object. |
|
|
1189 | |
|
|
1190 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
|
|
1191 | call and can be used or changed to your liking. Note that the handshake |
|
|
1192 | might have already started when this function returns. |
|
|
1193 | |
|
|
1194 | =cut |
|
|
1195 | |
677 | sub starttls { |
1196 | sub starttls { |
678 | my ($self, $ssl, $ctx) = @_; |
1197 | my ($self, $ssl, $ctx) = @_; |
|
|
1198 | |
|
|
1199 | $self->stoptls; |
679 | |
1200 | |
680 | if ($ssl eq "accept") { |
1201 | if ($ssl eq "accept") { |
681 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1202 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
682 | Net::SSLeay::set_accept_state ($ssl); |
1203 | Net::SSLeay::set_accept_state ($ssl); |
683 | } elsif ($ssl eq "connect") { |
1204 | } elsif ($ssl eq "connect") { |
… | |
… | |
685 | Net::SSLeay::set_connect_state ($ssl); |
1206 | Net::SSLeay::set_connect_state ($ssl); |
686 | } |
1207 | } |
687 | |
1208 | |
688 | $self->{tls} = $ssl; |
1209 | $self->{tls} = $ssl; |
689 | |
1210 | |
|
|
1211 | # basically, this is deep magic (because SSL_read should have the same issues) |
|
|
1212 | # but the openssl maintainers basically said: "trust us, it just works". |
|
|
1213 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
|
|
1214 | # and mismaintained ssleay-module doesn't even offer them). |
|
|
1215 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1216 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
|
|
1217 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
|
|
1218 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
|
|
1219 | |
690 | $self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1220 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
691 | $self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1221 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
692 | |
1222 | |
693 | Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio}); |
1223 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
694 | |
1224 | |
695 | $self->{filter_w} = sub { |
1225 | $self->{filter_w} = sub { |
696 | $_[0]{tls_wbuf} .= ${$_[1]}; |
1226 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
697 | &_dotls; |
1227 | &_dotls; |
698 | }; |
1228 | }; |
699 | $self->{filter_r} = sub { |
1229 | $self->{filter_r} = sub { |
700 | Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]}); |
1230 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
701 | &_dotls; |
1231 | &_dotls; |
702 | }; |
1232 | }; |
703 | } |
1233 | } |
704 | |
1234 | |
|
|
1235 | =item $handle->stoptls |
|
|
1236 | |
|
|
1237 | Destroys the SSL connection, if any. Partial read or write data will be |
|
|
1238 | lost. |
|
|
1239 | |
|
|
1240 | =cut |
|
|
1241 | |
|
|
1242 | sub stoptls { |
|
|
1243 | my ($self) = @_; |
|
|
1244 | |
|
|
1245 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
|
|
1246 | |
|
|
1247 | delete $self->{_rbio}; |
|
|
1248 | delete $self->{_wbio}; |
|
|
1249 | delete $self->{_tls_wbuf}; |
|
|
1250 | delete $self->{filter_r}; |
|
|
1251 | delete $self->{filter_w}; |
|
|
1252 | } |
|
|
1253 | |
705 | sub DESTROY { |
1254 | sub DESTROY { |
706 | my $self = shift; |
1255 | my $self = shift; |
707 | |
1256 | |
708 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1257 | $self->stoptls; |
709 | } |
1258 | } |
710 | |
1259 | |
711 | =item AnyEvent::Handle::TLS_CTX |
1260 | =item AnyEvent::Handle::TLS_CTX |
712 | |
1261 | |
713 | This function creates and returns the Net::SSLeay::CTX object used by |
1262 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
743 | } |
1292 | } |
744 | } |
1293 | } |
745 | |
1294 | |
746 | =back |
1295 | =back |
747 | |
1296 | |
|
|
1297 | =head1 SUBCLASSING AnyEvent::Handle |
|
|
1298 | |
|
|
1299 | In many cases, you might want to subclass AnyEvent::Handle. |
|
|
1300 | |
|
|
1301 | To make this easier, a given version of AnyEvent::Handle uses these |
|
|
1302 | conventions: |
|
|
1303 | |
|
|
1304 | =over 4 |
|
|
1305 | |
|
|
1306 | =item * all constructor arguments become object members. |
|
|
1307 | |
|
|
1308 | At least initially, when you pass a C<tls>-argument to the constructor it |
|
|
1309 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
|
|
1310 | mutated later on (for example C<tls> will hold the TLS connection object). |
|
|
1311 | |
|
|
1312 | =item * other object member names are prefixed with an C<_>. |
|
|
1313 | |
|
|
1314 | All object members not explicitly documented (internal use) are prefixed |
|
|
1315 | with an underscore character, so the remaining non-C<_>-namespace is free |
|
|
1316 | for use for subclasses. |
|
|
1317 | |
|
|
1318 | =item * all members not documented here and not prefixed with an underscore |
|
|
1319 | are free to use in subclasses. |
|
|
1320 | |
|
|
1321 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
|
|
1322 | member variables, but thats just life, at least it is documented. |
|
|
1323 | |
|
|
1324 | =back |
|
|
1325 | |
748 | =head1 AUTHOR |
1326 | =head1 AUTHOR |
749 | |
1327 | |
750 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
1328 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
751 | |
1329 | |
752 | =cut |
1330 | =cut |