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