… | |
… | |
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 file handles 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.151; |
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>, C<EPIPE> or C<EBADMSG>). |
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 | This callback is useful when you don't want to put all of your write data |
|
|
130 | into the queue at once, for example, when you want to write the contents |
|
|
131 | of some file to the socket you might not want to read the whole file into |
|
|
132 | memory and push it into the queue, but instead only read more data from |
|
|
133 | the file when the write queue becomes empty. |
|
|
134 | |
|
|
135 | =item timeout => $fractional_seconds |
|
|
136 | |
|
|
137 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
|
|
138 | seconds pass without a successful read or write on the underlying file |
|
|
139 | handle, the C<on_timeout> callback will be invoked (and if that one is |
|
|
140 | missing, an C<ETIMEDOUT> error will be raised). |
|
|
141 | |
|
|
142 | Note that timeout processing is also active when you currently do not have |
|
|
143 | any outstanding read or write requests: If you plan to keep the connection |
|
|
144 | idle then you should disable the timout temporarily or ignore the timeout |
|
|
145 | in the C<on_timeout> callback. |
|
|
146 | |
|
|
147 | Zero (the default) disables this timeout. |
|
|
148 | |
|
|
149 | =item on_timeout => $cb->($handle) |
|
|
150 | |
|
|
151 | Called whenever the inactivity timeout passes. If you return from this |
|
|
152 | callback, then the timeout will be reset as if some activity had happened, |
|
|
153 | so this condition is not fatal in any way. |
120 | |
154 | |
121 | =item rbuf_max => <bytes> |
155 | =item rbuf_max => <bytes> |
122 | |
156 | |
123 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
157 | 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 |
158 | when the read buffer ever (strictly) exceeds this size. This is useful to |
… | |
… | |
131 | isn't finished). |
165 | isn't finished). |
132 | |
166 | |
133 | =item read_size => <bytes> |
167 | =item read_size => <bytes> |
134 | |
168 | |
135 | The default read block size (the amount of bytes this module will try to read |
169 | The default read block size (the amount of bytes this module will try to read |
136 | on each [loop iteration). Default: C<4096>. |
170 | during each (loop iteration). Default: C<8192>. |
137 | |
171 | |
138 | =item low_water_mark => <bytes> |
172 | =item low_water_mark => <bytes> |
139 | |
173 | |
140 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
174 | 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 |
175 | buffer: If the write reaches this size or gets even samller it is |
142 | considered empty. |
176 | considered empty. |
|
|
177 | |
|
|
178 | =item linger => <seconds> |
|
|
179 | |
|
|
180 | If non-zero (default: C<3600>), then the destructor of the |
|
|
181 | AnyEvent::Handle object will check wether there is still outstanding write |
|
|
182 | data and will install a watcher that will write out this data. No errors |
|
|
183 | will be reported (this mostly matches how the operating system treats |
|
|
184 | outstanding data at socket close time). |
|
|
185 | |
|
|
186 | This will not work for partial TLS data that could not yet been |
|
|
187 | encoded. This data will be lost. |
143 | |
188 | |
144 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
189 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
145 | |
190 | |
146 | When this parameter is given, it enables TLS (SSL) mode, that means it |
191 | When this parameter is given, it enables TLS (SSL) mode, that means it |
147 | will start making tls handshake and will transparently encrypt/decrypt |
192 | will start making tls handshake and will transparently encrypt/decrypt |
… | |
… | |
164 | |
209 | |
165 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
210 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
166 | (unless a connection object was specified directly). If this parameter is |
211 | (unless a connection object was specified directly). If this parameter is |
167 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
212 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
168 | |
213 | |
|
|
214 | =item json => JSON or JSON::XS object |
|
|
215 | |
|
|
216 | This is the json coder object used by the C<json> read and write types. |
|
|
217 | |
|
|
218 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
219 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
|
|
220 | |
|
|
221 | Note that you are responsible to depend on the JSON module if you want to |
|
|
222 | use this functionality, as AnyEvent does not have a dependency itself. |
|
|
223 | |
|
|
224 | =item filter_r => $cb |
|
|
225 | |
|
|
226 | =item filter_w => $cb |
|
|
227 | |
|
|
228 | These exist, but are undocumented at this time. |
|
|
229 | |
169 | =back |
230 | =back |
170 | |
231 | |
171 | =cut |
232 | =cut |
172 | |
|
|
173 | our (%RH, %WH); |
|
|
174 | |
|
|
175 | sub register_read_type($$) { |
|
|
176 | $RH{$_[0]} = $_[1]; |
|
|
177 | } |
|
|
178 | |
|
|
179 | sub register_write_type($$) { |
|
|
180 | $WH{$_[0]} = $_[1]; |
|
|
181 | } |
|
|
182 | |
233 | |
183 | sub new { |
234 | sub new { |
184 | my $class = shift; |
235 | my $class = shift; |
185 | |
236 | |
186 | my $self = bless { @_ }, $class; |
237 | my $self = bless { @_ }, $class; |
… | |
… | |
192 | if ($self->{tls}) { |
243 | if ($self->{tls}) { |
193 | require Net::SSLeay; |
244 | require Net::SSLeay; |
194 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
245 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
195 | } |
246 | } |
196 | |
247 | |
197 | $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; |
248 | $self->{_activity} = AnyEvent->now; |
198 | $self->on_error (delete $self->{on_error}) if $self->{on_error}; |
249 | $self->_timeout; |
|
|
250 | |
199 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
251 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
200 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
|
|
201 | |
252 | |
202 | $self->start_read; |
253 | $self->start_read |
|
|
254 | if $self->{on_read}; |
203 | |
255 | |
204 | $self |
256 | $self |
205 | } |
257 | } |
206 | |
258 | |
207 | sub _shutdown { |
259 | sub _shutdown { |
208 | my ($self) = @_; |
260 | my ($self) = @_; |
209 | |
261 | |
|
|
262 | delete $self->{_tw}; |
210 | delete $self->{rw}; |
263 | delete $self->{_rw}; |
211 | delete $self->{ww}; |
264 | delete $self->{_ww}; |
212 | delete $self->{fh}; |
265 | delete $self->{fh}; |
213 | } |
|
|
214 | |
266 | |
|
|
267 | $self->stoptls; |
|
|
268 | } |
|
|
269 | |
215 | sub error { |
270 | sub _error { |
216 | my ($self) = @_; |
271 | my ($self, $errno, $fatal) = @_; |
217 | |
272 | |
218 | { |
|
|
219 | local $!; |
|
|
220 | $self->_shutdown; |
273 | $self->_shutdown |
221 | } |
274 | if $fatal; |
|
|
275 | |
|
|
276 | $! = $errno; |
222 | |
277 | |
223 | if ($self->{on_error}) { |
278 | if ($self->{on_error}) { |
224 | $self->{on_error}($self); |
279 | $self->{on_error}($self, $fatal); |
225 | } else { |
280 | } else { |
226 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
281 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
227 | } |
282 | } |
228 | } |
283 | } |
229 | |
284 | |
230 | =item $fh = $handle->fh |
285 | =item $fh = $handle->fh |
231 | |
286 | |
232 | This method returns the file handle of the L<AnyEvent::Handle> object. |
287 | This method returns the file handle of the L<AnyEvent::Handle> object. |
233 | |
288 | |
234 | =cut |
289 | =cut |
235 | |
290 | |
236 | sub fh { $_[0]->{fh} } |
291 | sub fh { $_[0]{fh} } |
237 | |
292 | |
238 | =item $handle->on_error ($cb) |
293 | =item $handle->on_error ($cb) |
239 | |
294 | |
240 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
295 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
241 | |
296 | |
… | |
… | |
251 | |
306 | |
252 | =cut |
307 | =cut |
253 | |
308 | |
254 | sub on_eof { |
309 | sub on_eof { |
255 | $_[0]{on_eof} = $_[1]; |
310 | $_[0]{on_eof} = $_[1]; |
|
|
311 | } |
|
|
312 | |
|
|
313 | =item $handle->on_timeout ($cb) |
|
|
314 | |
|
|
315 | Replace the current C<on_timeout> callback, or disables the callback |
|
|
316 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
|
|
317 | argument. |
|
|
318 | |
|
|
319 | =cut |
|
|
320 | |
|
|
321 | sub on_timeout { |
|
|
322 | $_[0]{on_timeout} = $_[1]; |
|
|
323 | } |
|
|
324 | |
|
|
325 | ############################################################################# |
|
|
326 | |
|
|
327 | =item $handle->timeout ($seconds) |
|
|
328 | |
|
|
329 | Configures (or disables) the inactivity timeout. |
|
|
330 | |
|
|
331 | =cut |
|
|
332 | |
|
|
333 | sub timeout { |
|
|
334 | my ($self, $timeout) = @_; |
|
|
335 | |
|
|
336 | $self->{timeout} = $timeout; |
|
|
337 | $self->_timeout; |
|
|
338 | } |
|
|
339 | |
|
|
340 | # reset the timeout watcher, as neccessary |
|
|
341 | # also check for time-outs |
|
|
342 | sub _timeout { |
|
|
343 | my ($self) = @_; |
|
|
344 | |
|
|
345 | if ($self->{timeout}) { |
|
|
346 | my $NOW = AnyEvent->now; |
|
|
347 | |
|
|
348 | # when would the timeout trigger? |
|
|
349 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
|
|
350 | |
|
|
351 | # now or in the past already? |
|
|
352 | if ($after <= 0) { |
|
|
353 | $self->{_activity} = $NOW; |
|
|
354 | |
|
|
355 | if ($self->{on_timeout}) { |
|
|
356 | $self->{on_timeout}($self); |
|
|
357 | } else { |
|
|
358 | $self->_error (&Errno::ETIMEDOUT); |
|
|
359 | } |
|
|
360 | |
|
|
361 | # callback could have changed timeout value, optimise |
|
|
362 | return unless $self->{timeout}; |
|
|
363 | |
|
|
364 | # calculate new after |
|
|
365 | $after = $self->{timeout}; |
|
|
366 | } |
|
|
367 | |
|
|
368 | Scalar::Util::weaken $self; |
|
|
369 | return unless $self; # ->error could have destroyed $self |
|
|
370 | |
|
|
371 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
|
|
372 | delete $self->{_tw}; |
|
|
373 | $self->_timeout; |
|
|
374 | }); |
|
|
375 | } else { |
|
|
376 | delete $self->{_tw}; |
|
|
377 | } |
256 | } |
378 | } |
257 | |
379 | |
258 | ############################################################################# |
380 | ############################################################################# |
259 | |
381 | |
260 | =back |
382 | =back |
… | |
… | |
297 | =cut |
419 | =cut |
298 | |
420 | |
299 | sub _drain_wbuf { |
421 | sub _drain_wbuf { |
300 | my ($self) = @_; |
422 | my ($self) = @_; |
301 | |
423 | |
302 | if (!$self->{ww} && length $self->{wbuf}) { |
424 | if (!$self->{_ww} && length $self->{wbuf}) { |
|
|
425 | |
303 | Scalar::Util::weaken $self; |
426 | Scalar::Util::weaken $self; |
|
|
427 | |
304 | my $cb = sub { |
428 | my $cb = sub { |
305 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
429 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
306 | |
430 | |
307 | if ($len >= 0) { |
431 | if ($len >= 0) { |
308 | substr $self->{wbuf}, 0, $len, ""; |
432 | substr $self->{wbuf}, 0, $len, ""; |
|
|
433 | |
|
|
434 | $self->{_activity} = AnyEvent->now; |
309 | |
435 | |
310 | $self->{on_drain}($self) |
436 | $self->{on_drain}($self) |
311 | if $self->{low_water_mark} >= length $self->{wbuf} |
437 | if $self->{low_water_mark} >= length $self->{wbuf} |
312 | && $self->{on_drain}; |
438 | && $self->{on_drain}; |
313 | |
439 | |
314 | delete $self->{ww} unless length $self->{wbuf}; |
440 | delete $self->{_ww} unless length $self->{wbuf}; |
315 | } elsif ($! != EAGAIN && $! != EINTR) { |
441 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
316 | $self->error; |
442 | $self->_error ($!, 1); |
317 | } |
443 | } |
318 | }; |
444 | }; |
319 | |
445 | |
|
|
446 | # try to write data immediately |
|
|
447 | $cb->(); |
|
|
448 | |
|
|
449 | # if still data left in wbuf, we need to poll |
320 | $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb); |
450 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
321 | |
451 | if length $self->{wbuf}; |
322 | $cb->($self); |
|
|
323 | }; |
452 | }; |
|
|
453 | } |
|
|
454 | |
|
|
455 | our %WH; |
|
|
456 | |
|
|
457 | sub register_write_type($$) { |
|
|
458 | $WH{$_[0]} = $_[1]; |
324 | } |
459 | } |
325 | |
460 | |
326 | sub push_write { |
461 | sub push_write { |
327 | my $self = shift; |
462 | my $self = shift; |
328 | |
463 | |
… | |
… | |
332 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
467 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
333 | ->($self, @_); |
468 | ->($self, @_); |
334 | } |
469 | } |
335 | |
470 | |
336 | if ($self->{filter_w}) { |
471 | if ($self->{filter_w}) { |
337 | $self->{filter_w}->($self, \$_[0]); |
472 | $self->{filter_w}($self, \$_[0]); |
338 | } else { |
473 | } else { |
339 | $self->{wbuf} .= $_[0]; |
474 | $self->{wbuf} .= $_[0]; |
340 | $self->_drain_wbuf; |
475 | $self->_drain_wbuf; |
341 | } |
476 | } |
342 | } |
477 | } |
343 | |
478 | |
344 | =item $handle->push_write (type => @args) |
479 | =item $handle->push_write (type => @args) |
345 | |
480 | |
346 | =item $handle->unshift_write (type => @args) |
|
|
347 | |
|
|
348 | Instead of formatting your data yourself, you can also let this module do |
481 | Instead of formatting your data yourself, you can also let this module do |
349 | the job by specifying a type and type-specific arguments. |
482 | the job by specifying a type and type-specific arguments. |
350 | |
483 | |
351 | Predefined types are: |
484 | Predefined types are (if you have ideas for additional types, feel free to |
|
|
485 | drop by and tell us): |
352 | |
486 | |
353 | =over 4 |
487 | =over 4 |
354 | |
488 | |
355 | =item netstring => $string |
489 | =item netstring => $string |
356 | |
490 | |
… | |
… | |
363 | my ($self, $string) = @_; |
497 | my ($self, $string) = @_; |
364 | |
498 | |
365 | sprintf "%d:%s,", (length $string), $string |
499 | sprintf "%d:%s,", (length $string), $string |
366 | }; |
500 | }; |
367 | |
501 | |
|
|
502 | =item packstring => $format, $data |
|
|
503 | |
|
|
504 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
505 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
506 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
507 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
508 | |
|
|
509 | =cut |
|
|
510 | |
|
|
511 | register_write_type packstring => sub { |
|
|
512 | my ($self, $format, $string) = @_; |
|
|
513 | |
|
|
514 | pack "$format/a*", $string |
|
|
515 | }; |
|
|
516 | |
|
|
517 | =item json => $array_or_hashref |
|
|
518 | |
|
|
519 | Encodes the given hash or array reference into a JSON object. Unless you |
|
|
520 | provide your own JSON object, this means it will be encoded to JSON text |
|
|
521 | in UTF-8. |
|
|
522 | |
|
|
523 | JSON objects (and arrays) are self-delimiting, so you can write JSON at |
|
|
524 | one end of a handle and read them at the other end without using any |
|
|
525 | additional framing. |
|
|
526 | |
|
|
527 | The generated JSON text is guaranteed not to contain any newlines: While |
|
|
528 | this module doesn't need delimiters after or between JSON texts to be |
|
|
529 | able to read them, many other languages depend on that. |
|
|
530 | |
|
|
531 | A simple RPC protocol that interoperates easily with others is to send |
|
|
532 | JSON arrays (or objects, although arrays are usually the better choice as |
|
|
533 | they mimic how function argument passing works) and a newline after each |
|
|
534 | JSON text: |
|
|
535 | |
|
|
536 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
|
|
537 | $handle->push_write ("\012"); |
|
|
538 | |
|
|
539 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
|
|
540 | rely on the fact that the newline will be skipped as leading whitespace: |
|
|
541 | |
|
|
542 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
|
|
543 | |
|
|
544 | Other languages could read single lines terminated by a newline and pass |
|
|
545 | this line into their JSON decoder of choice. |
|
|
546 | |
|
|
547 | =cut |
|
|
548 | |
|
|
549 | register_write_type json => sub { |
|
|
550 | my ($self, $ref) = @_; |
|
|
551 | |
|
|
552 | require JSON; |
|
|
553 | |
|
|
554 | $self->{json} ? $self->{json}->encode ($ref) |
|
|
555 | : JSON::encode_json ($ref) |
|
|
556 | }; |
|
|
557 | |
|
|
558 | =item storable => $reference |
|
|
559 | |
|
|
560 | Freezes the given reference using L<Storable> and writes it to the |
|
|
561 | handle. Uses the C<nfreeze> format. |
|
|
562 | |
|
|
563 | =cut |
|
|
564 | |
|
|
565 | register_write_type storable => sub { |
|
|
566 | my ($self, $ref) = @_; |
|
|
567 | |
|
|
568 | require Storable; |
|
|
569 | |
|
|
570 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
571 | }; |
|
|
572 | |
368 | =back |
573 | =back |
369 | |
574 | |
370 | =cut |
575 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
371 | |
576 | |
|
|
577 | This function (not method) lets you add your own types to C<push_write>. |
|
|
578 | Whenever the given C<type> is used, C<push_write> will invoke the code |
|
|
579 | reference with the handle object and the remaining arguments. |
372 | |
580 | |
|
|
581 | The code reference is supposed to return a single octet string that will |
|
|
582 | be appended to the write buffer. |
|
|
583 | |
|
|
584 | Note that this is a function, and all types registered this way will be |
|
|
585 | global, so try to use unique names. |
|
|
586 | |
|
|
587 | =cut |
373 | |
588 | |
374 | ############################################################################# |
589 | ############################################################################# |
375 | |
590 | |
376 | =back |
591 | =back |
377 | |
592 | |
… | |
… | |
384 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
599 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
385 | a queue. |
600 | a queue. |
386 | |
601 | |
387 | In the simple case, you just install an C<on_read> callback and whenever |
602 | In the simple case, you just install an C<on_read> callback and whenever |
388 | new data arrives, it will be called. You can then remove some data (if |
603 | new data arrives, it will be called. You can then remove some data (if |
389 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
604 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
390 | or not. |
605 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
606 | partial message has been received so far). |
391 | |
607 | |
392 | In the more complex case, you want to queue multiple callbacks. In this |
608 | In the more complex case, you want to queue multiple callbacks. In this |
393 | case, AnyEvent::Handle will call the first queued callback each time new |
609 | case, AnyEvent::Handle will call the first queued callback each time new |
394 | data arrives and removes it when it has done its job (see C<push_read>, |
610 | data arrives (also the first time it is queued) and removes it when it has |
395 | below). |
611 | done its job (see C<push_read>, below). |
396 | |
612 | |
397 | This way you can, for example, push three line-reads, followed by reading |
613 | This way you can, for example, push three line-reads, followed by reading |
398 | a chunk of data, and AnyEvent::Handle will execute them in order. |
614 | a chunk of data, and AnyEvent::Handle will execute them in order. |
399 | |
615 | |
400 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
616 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
401 | the specified number of bytes which give an XML datagram. |
617 | the specified number of bytes which give an XML datagram. |
402 | |
618 | |
403 | # in the default state, expect some header bytes |
619 | # in the default state, expect some header bytes |
404 | $handle->on_read (sub { |
620 | $handle->on_read (sub { |
405 | # some data is here, now queue the length-header-read (4 octets) |
621 | # some data is here, now queue the length-header-read (4 octets) |
406 | shift->unshift_read_chunk (4, sub { |
622 | shift->unshift_read (chunk => 4, sub { |
407 | # header arrived, decode |
623 | # header arrived, decode |
408 | my $len = unpack "N", $_[1]; |
624 | my $len = unpack "N", $_[1]; |
409 | |
625 | |
410 | # now read the payload |
626 | # now read the payload |
411 | shift->unshift_read_chunk ($len, sub { |
627 | shift->unshift_read (chunk => $len, sub { |
412 | my $xml = $_[1]; |
628 | my $xml = $_[1]; |
413 | # handle xml |
629 | # handle xml |
414 | }); |
630 | }); |
415 | }); |
631 | }); |
416 | }); |
632 | }); |
417 | |
633 | |
418 | Example 2: Implement a client for a protocol that replies either with |
634 | Example 2: Implement a client for a protocol that replies either with "OK" |
419 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
635 | and another line or "ERROR" for the first request that is sent, and 64 |
420 | second request. Due tot he availability of a full queue, we can just |
636 | bytes for the second request. Due to the availability of a queue, we can |
421 | pipeline sending both requests and manipulate the queue as necessary in |
637 | just pipeline sending both requests and manipulate the queue as necessary |
422 | the callbacks: |
638 | in the callbacks. |
423 | |
639 | |
424 | # request one |
640 | When the first callback is called and sees an "OK" response, it will |
|
|
641 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
642 | 64-byte chunk callback. |
|
|
643 | |
|
|
644 | # request one, returns either "OK + extra line" or "ERROR" |
425 | $handle->push_write ("request 1\015\012"); |
645 | $handle->push_write ("request 1\015\012"); |
426 | |
646 | |
427 | # we expect "ERROR" or "OK" as response, so push a line read |
647 | # we expect "ERROR" or "OK" as response, so push a line read |
428 | $handle->push_read_line (sub { |
648 | $handle->push_read (line => sub { |
429 | # if we got an "OK", we have to _prepend_ another line, |
649 | # if we got an "OK", we have to _prepend_ another line, |
430 | # so it will be read before the second request reads its 64 bytes |
650 | # so it will be read before the second request reads its 64 bytes |
431 | # which are already in the queue when this callback is called |
651 | # which are already in the queue when this callback is called |
432 | # we don't do this in case we got an error |
652 | # we don't do this in case we got an error |
433 | if ($_[1] eq "OK") { |
653 | if ($_[1] eq "OK") { |
434 | $_[0]->unshift_read_line (sub { |
654 | $_[0]->unshift_read (line => sub { |
435 | my $response = $_[1]; |
655 | my $response = $_[1]; |
436 | ... |
656 | ... |
437 | }); |
657 | }); |
438 | } |
658 | } |
439 | }); |
659 | }); |
440 | |
660 | |
441 | # request two |
661 | # request two, simply returns 64 octets |
442 | $handle->push_write ("request 2\015\012"); |
662 | $handle->push_write ("request 2\015\012"); |
443 | |
663 | |
444 | # simply read 64 bytes, always |
664 | # simply read 64 bytes, always |
445 | $handle->push_read_chunk (64, sub { |
665 | $handle->push_read (chunk => 64, sub { |
446 | my $response = $_[1]; |
666 | my $response = $_[1]; |
447 | ... |
667 | ... |
448 | }); |
668 | }); |
449 | |
669 | |
450 | =over 4 |
670 | =over 4 |
451 | |
671 | |
452 | =cut |
672 | =cut |
453 | |
673 | |
454 | sub _drain_rbuf { |
674 | sub _drain_rbuf { |
455 | my ($self) = @_; |
675 | my ($self) = @_; |
|
|
676 | |
|
|
677 | local $self->{_in_drain} = 1; |
456 | |
678 | |
457 | if ( |
679 | if ( |
458 | defined $self->{rbuf_max} |
680 | defined $self->{rbuf_max} |
459 | && $self->{rbuf_max} < length $self->{rbuf} |
681 | && $self->{rbuf_max} < length $self->{rbuf} |
460 | ) { |
682 | ) { |
461 | $! = &Errno::ENOSPC; return $self->error; |
683 | return $self->_error (&Errno::ENOSPC, 1); |
462 | } |
684 | } |
463 | |
685 | |
464 | return if $self->{in_drain}; |
686 | while () { |
465 | local $self->{in_drain} = 1; |
|
|
466 | |
|
|
467 | while (my $len = length $self->{rbuf}) { |
|
|
468 | no strict 'refs'; |
687 | no strict 'refs'; |
|
|
688 | |
|
|
689 | my $len = length $self->{rbuf}; |
|
|
690 | |
469 | if (my $cb = shift @{ $self->{queue} }) { |
691 | if (my $cb = shift @{ $self->{_queue} }) { |
470 | unless ($cb->($self)) { |
692 | unless ($cb->($self)) { |
471 | if ($self->{eof}) { |
693 | if ($self->{_eof}) { |
472 | # no progress can be made (not enough data and no data forthcoming) |
694 | # no progress can be made (not enough data and no data forthcoming) |
473 | $! = &Errno::EPIPE; return $self->error; |
695 | $self->_error (&Errno::EPIPE, 1), last; |
474 | } |
696 | } |
475 | |
697 | |
476 | unshift @{ $self->{queue} }, $cb; |
698 | unshift @{ $self->{_queue} }, $cb; |
477 | return; |
699 | last; |
478 | } |
700 | } |
479 | } elsif ($self->{on_read}) { |
701 | } elsif ($self->{on_read}) { |
|
|
702 | last unless $len; |
|
|
703 | |
480 | $self->{on_read}($self); |
704 | $self->{on_read}($self); |
481 | |
705 | |
482 | if ( |
706 | if ( |
483 | $self->{eof} # if no further data will arrive |
|
|
484 | && $len == length $self->{rbuf} # and no data has been consumed |
707 | $len == length $self->{rbuf} # if no data has been consumed |
485 | && !@{ $self->{queue} } # and the queue is still empty |
708 | && !@{ $self->{_queue} } # and the queue is still empty |
486 | && $self->{on_read} # and we still want to read data |
709 | && $self->{on_read} # but we still have on_read |
487 | ) { |
710 | ) { |
|
|
711 | # no further data will arrive |
488 | # then no progress can be made |
712 | # so no progress can be made |
489 | $! = &Errno::EPIPE; return $self->error; |
713 | $self->_error (&Errno::EPIPE, 1), last |
|
|
714 | if $self->{_eof}; |
|
|
715 | |
|
|
716 | last; # more data might arrive |
490 | } |
717 | } |
491 | } else { |
718 | } else { |
492 | # read side becomes idle |
719 | # read side becomes idle |
493 | delete $self->{rw}; |
720 | delete $self->{_rw}; |
494 | return; |
721 | last; |
495 | } |
722 | } |
496 | } |
723 | } |
497 | |
724 | |
498 | if ($self->{eof}) { |
|
|
499 | $self->_shutdown; |
|
|
500 | $self->{on_eof}($self) |
725 | $self->{on_eof}($self) |
501 | if $self->{on_eof}; |
726 | if $self->{_eof} && $self->{on_eof}; |
|
|
727 | |
|
|
728 | # may need to restart read watcher |
|
|
729 | unless ($self->{_rw}) { |
|
|
730 | $self->start_read |
|
|
731 | if $self->{on_read} || @{ $self->{_queue} }; |
502 | } |
732 | } |
503 | } |
733 | } |
504 | |
734 | |
505 | =item $handle->on_read ($cb) |
735 | =item $handle->on_read ($cb) |
506 | |
736 | |
… | |
… | |
512 | |
742 | |
513 | sub on_read { |
743 | sub on_read { |
514 | my ($self, $cb) = @_; |
744 | my ($self, $cb) = @_; |
515 | |
745 | |
516 | $self->{on_read} = $cb; |
746 | $self->{on_read} = $cb; |
|
|
747 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
517 | } |
748 | } |
518 | |
749 | |
519 | =item $handle->rbuf |
750 | =item $handle->rbuf |
520 | |
751 | |
521 | Returns the read buffer (as a modifiable lvalue). |
752 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
552 | interested in (which can be none at all) and return a true value. After returning |
783 | interested in (which can be none at all) and return a true value. After returning |
553 | true, it will be removed from the queue. |
784 | true, it will be removed from the queue. |
554 | |
785 | |
555 | =cut |
786 | =cut |
556 | |
787 | |
|
|
788 | our %RH; |
|
|
789 | |
|
|
790 | sub register_read_type($$) { |
|
|
791 | $RH{$_[0]} = $_[1]; |
|
|
792 | } |
|
|
793 | |
557 | sub push_read { |
794 | sub push_read { |
558 | my $self = shift; |
795 | my $self = shift; |
559 | my $cb = pop; |
796 | my $cb = pop; |
560 | |
797 | |
561 | if (@_) { |
798 | if (@_) { |
… | |
… | |
563 | |
800 | |
564 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
801 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
565 | ->($self, $cb, @_); |
802 | ->($self, $cb, @_); |
566 | } |
803 | } |
567 | |
804 | |
568 | push @{ $self->{queue} }, $cb; |
805 | push @{ $self->{_queue} }, $cb; |
569 | $self->_drain_rbuf; |
806 | $self->_drain_rbuf unless $self->{_in_drain}; |
570 | } |
807 | } |
571 | |
808 | |
572 | sub unshift_read { |
809 | sub unshift_read { |
573 | my $self = shift; |
810 | my $self = shift; |
574 | my $cb = pop; |
811 | my $cb = pop; |
… | |
… | |
579 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
816 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
580 | ->($self, $cb, @_); |
817 | ->($self, $cb, @_); |
581 | } |
818 | } |
582 | |
819 | |
583 | |
820 | |
584 | unshift @{ $self->{queue} }, $cb; |
821 | unshift @{ $self->{_queue} }, $cb; |
585 | $self->_drain_rbuf; |
822 | $self->_drain_rbuf unless $self->{_in_drain}; |
586 | } |
823 | } |
587 | |
824 | |
588 | =item $handle->push_read (type => @args, $cb) |
825 | =item $handle->push_read (type => @args, $cb) |
589 | |
826 | |
590 | =item $handle->unshift_read (type => @args, $cb) |
827 | =item $handle->unshift_read (type => @args, $cb) |
591 | |
828 | |
592 | Instead of providing a callback that parses the data itself you can chose |
829 | Instead of providing a callback that parses the data itself you can chose |
593 | between a number of predefined parsing formats, for chunks of data, lines |
830 | between a number of predefined parsing formats, for chunks of data, lines |
594 | etc. |
831 | etc. |
595 | |
832 | |
596 | The types currently supported are: |
833 | Predefined types are (if you have ideas for additional types, feel free to |
|
|
834 | drop by and tell us): |
597 | |
835 | |
598 | =over 4 |
836 | =over 4 |
599 | |
837 | |
600 | =item chunk => $octets, $cb->($self, $data) |
838 | =item chunk => $octets, $cb->($handle, $data) |
601 | |
839 | |
602 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
840 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
603 | data read to the callback. The callback will never be called with less |
841 | data read to the callback. The callback will never be called with less |
604 | data. |
842 | data. |
605 | |
843 | |
… | |
… | |
628 | |
866 | |
629 | sub unshift_read_chunk { |
867 | sub unshift_read_chunk { |
630 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
868 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
631 | } |
869 | } |
632 | |
870 | |
633 | =item line => [$eol, ]$cb->($self, $line, $eol) |
871 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
634 | |
872 | |
635 | The callback will be called only once a full line (including the end of |
873 | The callback will be called only once a full line (including the end of |
636 | line marker, C<$eol>) has been read. This line (excluding the end of line |
874 | line marker, C<$eol>) has been read. This line (excluding the end of line |
637 | marker) will be passed to the callback as second argument (C<$line>), and |
875 | marker) will be passed to the callback as second argument (C<$line>), and |
638 | the end of line marker as the third argument (C<$eol>). |
876 | the end of line marker as the third argument (C<$eol>). |
… | |
… | |
675 | sub unshift_read_line { |
913 | sub unshift_read_line { |
676 | my $self = shift; |
914 | my $self = shift; |
677 | $self->unshift_read (line => @_); |
915 | $self->unshift_read (line => @_); |
678 | } |
916 | } |
679 | |
917 | |
|
|
918 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
|
|
919 | |
|
|
920 | Makes a regex match against the regex object C<$accept> and returns |
|
|
921 | everything up to and including the match. |
|
|
922 | |
|
|
923 | Example: read a single line terminated by '\n'. |
|
|
924 | |
|
|
925 | $handle->push_read (regex => qr<\n>, sub { ... }); |
|
|
926 | |
|
|
927 | If C<$reject> is given and not undef, then it determines when the data is |
|
|
928 | to be rejected: it is matched against the data when the C<$accept> regex |
|
|
929 | does not match and generates an C<EBADMSG> error when it matches. This is |
|
|
930 | useful to quickly reject wrong data (to avoid waiting for a timeout or a |
|
|
931 | receive buffer overflow). |
|
|
932 | |
|
|
933 | Example: expect a single decimal number followed by whitespace, reject |
|
|
934 | anything else (not the use of an anchor). |
|
|
935 | |
|
|
936 | $handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... }); |
|
|
937 | |
|
|
938 | If C<$skip> is given and not C<undef>, then it will be matched against |
|
|
939 | the receive buffer when neither C<$accept> nor C<$reject> match, |
|
|
940 | and everything preceding and including the match will be accepted |
|
|
941 | unconditionally. This is useful to skip large amounts of data that you |
|
|
942 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
|
|
943 | have to start matching from the beginning. This is purely an optimisation |
|
|
944 | and is usually worth only when you expect more than a few kilobytes. |
|
|
945 | |
|
|
946 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
|
|
947 | expect the header to be very large (it isn't in practise, but...), we use |
|
|
948 | a skip regex to skip initial portions. The skip regex is tricky in that |
|
|
949 | it only accepts something not ending in either \015 or \012, as these are |
|
|
950 | required for the accept regex. |
|
|
951 | |
|
|
952 | $handle->push_read (regex => |
|
|
953 | qr<\015\012\015\012>, |
|
|
954 | undef, # no reject |
|
|
955 | qr<^.*[^\015\012]>, |
|
|
956 | sub { ... }); |
|
|
957 | |
|
|
958 | =cut |
|
|
959 | |
|
|
960 | register_read_type regex => sub { |
|
|
961 | my ($self, $cb, $accept, $reject, $skip) = @_; |
|
|
962 | |
|
|
963 | my $data; |
|
|
964 | my $rbuf = \$self->{rbuf}; |
|
|
965 | |
|
|
966 | sub { |
|
|
967 | # accept |
|
|
968 | if ($$rbuf =~ $accept) { |
|
|
969 | $data .= substr $$rbuf, 0, $+[0], ""; |
|
|
970 | $cb->($self, $data); |
|
|
971 | return 1; |
|
|
972 | } |
|
|
973 | |
|
|
974 | # reject |
|
|
975 | if ($reject && $$rbuf =~ $reject) { |
|
|
976 | $self->_error (&Errno::EBADMSG); |
|
|
977 | } |
|
|
978 | |
|
|
979 | # skip |
|
|
980 | if ($skip && $$rbuf =~ $skip) { |
|
|
981 | $data .= substr $$rbuf, 0, $+[0], ""; |
|
|
982 | } |
|
|
983 | |
|
|
984 | () |
|
|
985 | } |
|
|
986 | }; |
|
|
987 | |
680 | =item netstring => $cb->($string) |
988 | =item netstring => $cb->($handle, $string) |
681 | |
989 | |
682 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
990 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
683 | |
991 | |
684 | Throws an error with C<$!> set to EBADMSG on format violations. |
992 | Throws an error with C<$!> set to EBADMSG on format violations. |
685 | |
993 | |
… | |
… | |
689 | my ($self, $cb) = @_; |
997 | my ($self, $cb) = @_; |
690 | |
998 | |
691 | sub { |
999 | sub { |
692 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1000 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
693 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1001 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
694 | $! = &Errno::EBADMSG; |
1002 | $self->_error (&Errno::EBADMSG); |
695 | $self->error; |
|
|
696 | } |
1003 | } |
697 | return; |
1004 | return; |
698 | } |
1005 | } |
699 | |
1006 | |
700 | my $len = $1; |
1007 | my $len = $1; |
… | |
… | |
703 | my $string = $_[1]; |
1010 | my $string = $_[1]; |
704 | $_[0]->unshift_read (chunk => 1, sub { |
1011 | $_[0]->unshift_read (chunk => 1, sub { |
705 | if ($_[1] eq ",") { |
1012 | if ($_[1] eq ",") { |
706 | $cb->($_[0], $string); |
1013 | $cb->($_[0], $string); |
707 | } else { |
1014 | } else { |
708 | $! = &Errno::EBADMSG; |
1015 | $self->_error (&Errno::EBADMSG); |
709 | $self->error; |
|
|
710 | } |
1016 | } |
711 | }); |
1017 | }); |
712 | }); |
1018 | }); |
713 | |
1019 | |
714 | 1 |
1020 | 1 |
715 | } |
1021 | } |
716 | }; |
1022 | }; |
717 | |
1023 | |
|
|
1024 | =item packstring => $format, $cb->($handle, $string) |
|
|
1025 | |
|
|
1026 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1027 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1028 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1029 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1030 | |
|
|
1031 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
1032 | |
|
|
1033 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1034 | format (very efficient). |
|
|
1035 | |
|
|
1036 | $handle->push_read (packstring => "w", sub { |
|
|
1037 | my ($handle, $data) = @_; |
|
|
1038 | }); |
|
|
1039 | |
|
|
1040 | =cut |
|
|
1041 | |
|
|
1042 | register_read_type packstring => sub { |
|
|
1043 | my ($self, $cb, $format) = @_; |
|
|
1044 | |
|
|
1045 | sub { |
|
|
1046 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1047 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
|
|
1048 | or return; |
|
|
1049 | |
|
|
1050 | # remove prefix |
|
|
1051 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
|
|
1052 | |
|
|
1053 | # read rest |
|
|
1054 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1055 | |
|
|
1056 | 1 |
|
|
1057 | } |
|
|
1058 | }; |
|
|
1059 | |
|
|
1060 | =item json => $cb->($handle, $hash_or_arrayref) |
|
|
1061 | |
|
|
1062 | Reads a JSON object or array, decodes it and passes it to the callback. |
|
|
1063 | |
|
|
1064 | If a C<json> object was passed to the constructor, then that will be used |
|
|
1065 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
|
|
1066 | |
|
|
1067 | This read type uses the incremental parser available with JSON version |
|
|
1068 | 2.09 (and JSON::XS version 2.2) and above. You have to provide a |
|
|
1069 | dependency on your own: this module will load the JSON module, but |
|
|
1070 | AnyEvent does not depend on it itself. |
|
|
1071 | |
|
|
1072 | Since JSON texts are fully self-delimiting, the C<json> read and write |
|
|
1073 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
|
|
1074 | the C<json> write type description, above, for an actual example. |
|
|
1075 | |
|
|
1076 | =cut |
|
|
1077 | |
|
|
1078 | register_read_type json => sub { |
|
|
1079 | my ($self, $cb) = @_; |
|
|
1080 | |
|
|
1081 | require JSON; |
|
|
1082 | |
|
|
1083 | my $data; |
|
|
1084 | my $rbuf = \$self->{rbuf}; |
|
|
1085 | |
|
|
1086 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
1087 | |
|
|
1088 | sub { |
|
|
1089 | my $ref = $json->incr_parse ($self->{rbuf}); |
|
|
1090 | |
|
|
1091 | if ($ref) { |
|
|
1092 | $self->{rbuf} = $json->incr_text; |
|
|
1093 | $json->incr_text = ""; |
|
|
1094 | $cb->($self, $ref); |
|
|
1095 | |
|
|
1096 | 1 |
|
|
1097 | } else { |
|
|
1098 | $self->{rbuf} = ""; |
|
|
1099 | () |
|
|
1100 | } |
|
|
1101 | } |
|
|
1102 | }; |
|
|
1103 | |
|
|
1104 | =item storable => $cb->($handle, $ref) |
|
|
1105 | |
|
|
1106 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1107 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1108 | data). |
|
|
1109 | |
|
|
1110 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1111 | |
|
|
1112 | =cut |
|
|
1113 | |
|
|
1114 | register_read_type storable => sub { |
|
|
1115 | my ($self, $cb) = @_; |
|
|
1116 | |
|
|
1117 | require Storable; |
|
|
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 "w", $_[0]->{rbuf} }) |
|
|
1122 | or return; |
|
|
1123 | |
|
|
1124 | # remove prefix |
|
|
1125 | substr $_[0]->{rbuf}, 0, (length pack "w", $len), ""; |
|
|
1126 | |
|
|
1127 | # read rest |
|
|
1128 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1129 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1130 | $cb->($_[0], $ref); |
|
|
1131 | } else { |
|
|
1132 | $self->_error (&Errno::EBADMSG); |
|
|
1133 | } |
|
|
1134 | }); |
|
|
1135 | } |
|
|
1136 | }; |
|
|
1137 | |
718 | =back |
1138 | =back |
719 | |
1139 | |
|
|
1140 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
|
|
1141 | |
|
|
1142 | This function (not method) lets you add your own types to C<push_read>. |
|
|
1143 | |
|
|
1144 | Whenever the given C<type> is used, C<push_read> will invoke the code |
|
|
1145 | reference with the handle object, the callback and the remaining |
|
|
1146 | arguments. |
|
|
1147 | |
|
|
1148 | The code reference is supposed to return a callback (usually a closure) |
|
|
1149 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
|
|
1150 | |
|
|
1151 | It should invoke the passed callback when it is done reading (remember to |
|
|
1152 | pass C<$handle> as first argument as all other callbacks do that). |
|
|
1153 | |
|
|
1154 | Note that this is a function, and all types registered this way will be |
|
|
1155 | global, so try to use unique names. |
|
|
1156 | |
|
|
1157 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
|
|
1158 | search for C<register_read_type>)). |
|
|
1159 | |
720 | =item $handle->stop_read |
1160 | =item $handle->stop_read |
721 | |
1161 | |
722 | =item $handle->start_read |
1162 | =item $handle->start_read |
723 | |
1163 | |
724 | In rare cases you actually do not want to read anything from the |
1164 | In rare cases you actually do not want to read anything from the |
725 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
1165 | socket. In this case you can call C<stop_read>. Neither C<on_read> nor |
726 | any queued callbacks will be executed then. To start reading again, call |
1166 | any queued callbacks will be executed then. To start reading again, call |
727 | C<start_read>. |
1167 | C<start_read>. |
728 | |
1168 | |
|
|
1169 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
|
|
1170 | you change the C<on_read> callback or push/unshift a read callback, and it |
|
|
1171 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
|
|
1172 | there are any read requests in the queue. |
|
|
1173 | |
729 | =cut |
1174 | =cut |
730 | |
1175 | |
731 | sub stop_read { |
1176 | sub stop_read { |
732 | my ($self) = @_; |
1177 | my ($self) = @_; |
733 | |
1178 | |
734 | delete $self->{rw}; |
1179 | delete $self->{_rw}; |
735 | } |
1180 | } |
736 | |
1181 | |
737 | sub start_read { |
1182 | sub start_read { |
738 | my ($self) = @_; |
1183 | my ($self) = @_; |
739 | |
1184 | |
740 | unless ($self->{rw} || $self->{eof}) { |
1185 | unless ($self->{_rw} || $self->{_eof}) { |
741 | Scalar::Util::weaken $self; |
1186 | Scalar::Util::weaken $self; |
742 | |
1187 | |
743 | $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1188 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
744 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1189 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
745 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1190 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
746 | |
1191 | |
747 | if ($len > 0) { |
1192 | if ($len > 0) { |
|
|
1193 | $self->{_activity} = AnyEvent->now; |
|
|
1194 | |
748 | $self->{filter_r} |
1195 | $self->{filter_r} |
749 | ? $self->{filter_r}->($self, $rbuf) |
1196 | ? $self->{filter_r}($self, $rbuf) |
750 | : $self->_drain_rbuf; |
1197 | : $self->{_in_drain} || $self->_drain_rbuf; |
751 | |
1198 | |
752 | } elsif (defined $len) { |
1199 | } elsif (defined $len) { |
753 | delete $self->{rw}; |
1200 | delete $self->{_rw}; |
754 | $self->{eof} = 1; |
1201 | $self->{_eof} = 1; |
755 | $self->_drain_rbuf; |
1202 | $self->_drain_rbuf unless $self->{_in_drain}; |
756 | |
1203 | |
757 | } elsif ($! != EAGAIN && $! != EINTR) { |
1204 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
758 | return $self->error; |
1205 | return $self->_error ($!, 1); |
759 | } |
1206 | } |
760 | }); |
1207 | }); |
761 | } |
1208 | } |
762 | } |
1209 | } |
763 | |
1210 | |
764 | sub _dotls { |
1211 | sub _dotls { |
765 | my ($self) = @_; |
1212 | my ($self) = @_; |
766 | |
1213 | |
|
|
1214 | my $buf; |
|
|
1215 | |
767 | if (length $self->{tls_wbuf}) { |
1216 | if (length $self->{_tls_wbuf}) { |
768 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) { |
1217 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
769 | substr $self->{tls_wbuf}, 0, $len, ""; |
1218 | substr $self->{_tls_wbuf}, 0, $len, ""; |
770 | } |
1219 | } |
771 | } |
1220 | } |
772 | |
1221 | |
773 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) { |
1222 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
774 | $self->{wbuf} .= $buf; |
1223 | $self->{wbuf} .= $buf; |
775 | $self->_drain_wbuf; |
1224 | $self->_drain_wbuf; |
776 | } |
1225 | } |
777 | |
1226 | |
778 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
1227 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
1228 | if (length $buf) { |
779 | $self->{rbuf} .= $buf; |
1229 | $self->{rbuf} .= $buf; |
780 | $self->_drain_rbuf; |
1230 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1231 | } else { |
|
|
1232 | # let's treat SSL-eof as we treat normal EOF |
|
|
1233 | $self->{_eof} = 1; |
|
|
1234 | $self->_shutdown; |
|
|
1235 | return; |
|
|
1236 | } |
781 | } |
1237 | } |
782 | |
1238 | |
783 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1239 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
784 | |
1240 | |
785 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1241 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
786 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1242 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
787 | $self->error; |
1243 | return $self->_error ($!, 1); |
788 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1244 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
789 | $! = &Errno::EIO; |
1245 | return $self->_error (&Errno::EIO, 1); |
790 | $self->error; |
|
|
791 | } |
1246 | } |
792 | |
1247 | |
793 | # all others are fine for our purposes |
1248 | # all others are fine for our purposes |
794 | } |
1249 | } |
795 | } |
1250 | } |
… | |
… | |
804 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1259 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
805 | |
1260 | |
806 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
1261 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
807 | used when AnyEvent::Handle has to create its own TLS connection object. |
1262 | used when AnyEvent::Handle has to create its own TLS connection object. |
808 | |
1263 | |
809 | =cut |
1264 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
|
|
1265 | call and can be used or changed to your liking. Note that the handshake |
|
|
1266 | might have already started when this function returns. |
810 | |
1267 | |
811 | # TODO: maybe document... |
1268 | =cut |
|
|
1269 | |
812 | sub starttls { |
1270 | sub starttls { |
813 | my ($self, $ssl, $ctx) = @_; |
1271 | my ($self, $ssl, $ctx) = @_; |
814 | |
1272 | |
815 | $self->stoptls; |
1273 | $self->stoptls; |
816 | |
1274 | |
… | |
… | |
828 | # but the openssl maintainers basically said: "trust us, it just works". |
1286 | # but the openssl maintainers basically said: "trust us, it just works". |
829 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1287 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
830 | # and mismaintained ssleay-module doesn't even offer them). |
1288 | # and mismaintained ssleay-module doesn't even offer them). |
831 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1289 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
832 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1290 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
833 | (eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1291 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
834 | | (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1292 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
835 | |
1293 | |
836 | $self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1294 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
837 | $self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1295 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
838 | |
1296 | |
839 | Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio}); |
1297 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
840 | |
1298 | |
841 | $self->{filter_w} = sub { |
1299 | $self->{filter_w} = sub { |
842 | $_[0]{tls_wbuf} .= ${$_[1]}; |
1300 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
843 | &_dotls; |
1301 | &_dotls; |
844 | }; |
1302 | }; |
845 | $self->{filter_r} = sub { |
1303 | $self->{filter_r} = sub { |
846 | Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]}); |
1304 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
847 | &_dotls; |
1305 | &_dotls; |
848 | }; |
1306 | }; |
849 | } |
1307 | } |
850 | |
1308 | |
851 | =item $handle->stoptls |
1309 | =item $handle->stoptls |
… | |
… | |
857 | |
1315 | |
858 | sub stoptls { |
1316 | sub stoptls { |
859 | my ($self) = @_; |
1317 | my ($self) = @_; |
860 | |
1318 | |
861 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1319 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
|
|
1320 | |
862 | delete $self->{tls_rbio}; |
1321 | delete $self->{_rbio}; |
863 | delete $self->{tls_wbio}; |
1322 | delete $self->{_wbio}; |
864 | delete $self->{tls_wbuf}; |
1323 | delete $self->{_tls_wbuf}; |
865 | delete $self->{filter_r}; |
1324 | delete $self->{filter_r}; |
866 | delete $self->{filter_w}; |
1325 | delete $self->{filter_w}; |
867 | } |
1326 | } |
868 | |
1327 | |
869 | sub DESTROY { |
1328 | sub DESTROY { |
870 | my $self = shift; |
1329 | my $self = shift; |
871 | |
1330 | |
872 | $self->stoptls; |
1331 | $self->stoptls; |
|
|
1332 | |
|
|
1333 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1334 | |
|
|
1335 | if ($linger && length $self->{wbuf}) { |
|
|
1336 | my $fh = delete $self->{fh}; |
|
|
1337 | my $wbuf = delete $self->{wbuf}; |
|
|
1338 | |
|
|
1339 | my @linger; |
|
|
1340 | |
|
|
1341 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1342 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1343 | |
|
|
1344 | if ($len > 0) { |
|
|
1345 | substr $wbuf, 0, $len, ""; |
|
|
1346 | } else { |
|
|
1347 | @linger = (); # end |
|
|
1348 | } |
|
|
1349 | }); |
|
|
1350 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1351 | @linger = (); |
|
|
1352 | }); |
|
|
1353 | } |
873 | } |
1354 | } |
874 | |
1355 | |
875 | =item AnyEvent::Handle::TLS_CTX |
1356 | =item AnyEvent::Handle::TLS_CTX |
876 | |
1357 | |
877 | This function creates and returns the Net::SSLeay::CTX object used by |
1358 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
907 | } |
1388 | } |
908 | } |
1389 | } |
909 | |
1390 | |
910 | =back |
1391 | =back |
911 | |
1392 | |
|
|
1393 | =head1 SUBCLASSING AnyEvent::Handle |
|
|
1394 | |
|
|
1395 | In many cases, you might want to subclass AnyEvent::Handle. |
|
|
1396 | |
|
|
1397 | To make this easier, a given version of AnyEvent::Handle uses these |
|
|
1398 | conventions: |
|
|
1399 | |
|
|
1400 | =over 4 |
|
|
1401 | |
|
|
1402 | =item * all constructor arguments become object members. |
|
|
1403 | |
|
|
1404 | At least initially, when you pass a C<tls>-argument to the constructor it |
|
|
1405 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
|
|
1406 | mutated later on (for example C<tls> will hold the TLS connection object). |
|
|
1407 | |
|
|
1408 | =item * other object member names are prefixed with an C<_>. |
|
|
1409 | |
|
|
1410 | All object members not explicitly documented (internal use) are prefixed |
|
|
1411 | with an underscore character, so the remaining non-C<_>-namespace is free |
|
|
1412 | for use for subclasses. |
|
|
1413 | |
|
|
1414 | =item * all members not documented here and not prefixed with an underscore |
|
|
1415 | are free to use in subclasses. |
|
|
1416 | |
|
|
1417 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
|
|
1418 | member variables, but thats just life, at least it is documented. |
|
|
1419 | |
|
|
1420 | =back |
|
|
1421 | |
912 | =head1 AUTHOR |
1422 | =head1 AUTHOR |
913 | |
1423 | |
914 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
1424 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
915 | |
1425 | |
916 | =cut |
1426 | =cut |