1 | package AnyEvent::Handle; |
1 | package AnyEvent::Handle; |
2 | |
2 | |
3 | no warnings; |
3 | no warnings; |
4 | use strict; |
4 | use strict qw(subs vars); |
5 | |
5 | |
6 | use AnyEvent (); |
6 | use AnyEvent (); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
… | |
… | |
14 | |
14 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
16 | |
17 | =cut |
17 | =cut |
18 | |
18 | |
19 | our $VERSION = '0.04'; |
19 | our $VERSION = 4.232; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
49 | |
49 | |
50 | This module is a helper module to make it easier to do event-based I/O on |
50 | This module is a helper module to make it easier to do event-based I/O on |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
52 | on sockets see L<AnyEvent::Util>. |
52 | on sockets see L<AnyEvent::Util>. |
53 | |
53 | |
|
|
54 | The L<AnyEvent::Intro> tutorial contains some well-documented |
|
|
55 | AnyEvent::Handle examples. |
|
|
56 | |
54 | In the following, when the documentation refers to of "bytes" then this |
57 | In the following, when the documentation refers to of "bytes" then this |
55 | means characters. As sysread and syswrite are used for all I/O, their |
58 | means characters. As sysread and syswrite are used for all I/O, their |
56 | treatment of characters applies to this module as well. |
59 | treatment of characters applies to this module as well. |
57 | |
60 | |
58 | All callbacks will be invoked with the handle object as their first |
61 | All callbacks will be invoked with the handle object as their first |
… | |
… | |
70 | |
73 | |
71 | =item fh => $filehandle [MANDATORY] |
74 | =item fh => $filehandle [MANDATORY] |
72 | |
75 | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
77 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
78 | NOTE: The filehandle will be set to non-blocking mode (using |
76 | AnyEvent::Util::fh_nonblocking). |
79 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
80 | that mode. |
77 | |
81 | |
78 | =item on_eof => $cb->($handle) |
82 | =item on_eof => $cb->($handle) |
79 | |
83 | |
80 | Set the callback to be called on EOF. |
84 | Set the callback to be called when an end-of-file condition is detected, |
|
|
85 | i.e. in the case of a socket, when the other side has closed the |
|
|
86 | connection cleanly. |
81 | |
87 | |
|
|
88 | For sockets, this just means that the other side has stopped sending data, |
|
|
89 | you can still try to write data, and, in fact, one can return from the eof |
|
|
90 | callback and continue writing data, as only the read part has been shut |
|
|
91 | down. |
|
|
92 | |
82 | While not mandatory, it is highly recommended to set an eof callback, |
93 | While not mandatory, it is I<highly> recommended to set an eof callback, |
83 | otherwise you might end up with a closed socket while you are still |
94 | otherwise you might end up with a closed socket while you are still |
84 | waiting for data. |
95 | waiting for data. |
85 | |
96 | |
|
|
97 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
98 | set, then a fatal error will be raised with C<$!> set to <0>. |
|
|
99 | |
86 | =item on_error => $cb->($handle) |
100 | =item on_error => $cb->($handle, $fatal) |
87 | |
101 | |
88 | This is the fatal error callback, that is called when, well, a fatal error |
102 | This is the error callback, which is called when, well, some error |
89 | occurs, such as not being able to resolve the hostname, failure to connect |
103 | occured, such as not being able to resolve the hostname, failure to |
90 | or a read error. |
104 | connect or a read error. |
91 | |
105 | |
92 | The object will not be in a usable state when this callback has been |
106 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
93 | called. |
107 | fatal errors the handle object will be shut down and will not be usable |
|
|
108 | (but you are free to look at the current C< ->rbuf >). Examples of fatal |
|
|
109 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
110 | (C<EPIPE>) or I/O errors. |
|
|
111 | |
|
|
112 | Non-fatal errors can be retried by simply returning, but it is recommended |
|
|
113 | to simply ignore this parameter and instead abondon the handle object |
|
|
114 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
115 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
94 | |
116 | |
95 | On callback entrance, the value of C<$!> contains the operating system |
117 | On callback entrance, the value of C<$!> contains the operating system |
96 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
118 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
97 | |
119 | |
98 | The callback should throw an exception. If it returns, then |
|
|
99 | AnyEvent::Handle will C<croak> for you. |
|
|
100 | |
|
|
101 | While not mandatory, it is I<highly> recommended to set this callback, as |
120 | While not mandatory, it is I<highly> recommended to set this callback, as |
102 | you will not be notified of errors otherwise. The default simply calls |
121 | you will not be notified of errors otherwise. The default simply calls |
103 | die. |
122 | C<croak>. |
104 | |
123 | |
105 | =item on_read => $cb->($handle) |
124 | =item on_read => $cb->($handle) |
106 | |
125 | |
107 | This sets the default read callback, which is called when data arrives |
126 | This sets the default read callback, which is called when data arrives |
108 | and no read request is in the queue. |
127 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
128 | callback will only be called when at least one octet of data is in the |
|
|
129 | read buffer). |
109 | |
130 | |
110 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
131 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
111 | method or access the C<$handle->{rbuf}> member directly. |
132 | method or access the C<$handle->{rbuf}> member directly. |
112 | |
133 | |
113 | When an EOF condition is detected then AnyEvent::Handle will first try to |
134 | When an EOF condition is detected then AnyEvent::Handle will first try to |
… | |
… | |
120 | This sets the callback that is called when the write buffer becomes empty |
141 | This sets the callback that is called when the write buffer becomes empty |
121 | (or when the callback is set and the buffer is empty already). |
142 | (or when the callback is set and the buffer is empty already). |
122 | |
143 | |
123 | To append to the write buffer, use the C<< ->push_write >> method. |
144 | To append to the write buffer, use the C<< ->push_write >> method. |
124 | |
145 | |
|
|
146 | This callback is useful when you don't want to put all of your write data |
|
|
147 | into the queue at once, for example, when you want to write the contents |
|
|
148 | of some file to the socket you might not want to read the whole file into |
|
|
149 | memory and push it into the queue, but instead only read more data from |
|
|
150 | the file when the write queue becomes empty. |
|
|
151 | |
125 | =item timeout => $fractional_seconds |
152 | =item timeout => $fractional_seconds |
126 | |
153 | |
127 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
154 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
128 | seconds pass without a successful read or write on the underlying file |
155 | seconds pass without a successful read or write on the underlying file |
129 | handle, the C<on_timeout> callback will be invoked (and if that one is |
156 | handle, the C<on_timeout> callback will be invoked (and if that one is |
130 | missing, an C<ETIMEDOUT> errror will be raised). |
157 | missing, an C<ETIMEDOUT> error will be raised). |
131 | |
158 | |
132 | Note that timeout processing is also active when you currently do not have |
159 | Note that timeout processing is also active when you currently do not have |
133 | any outstanding read or write requests: If you plan to keep the connection |
160 | any outstanding read or write requests: If you plan to keep the connection |
134 | idle then you should disable the timout temporarily or ignore the timeout |
161 | idle then you should disable the timout temporarily or ignore the timeout |
135 | in the C<on_timeout> callback. |
162 | in the C<on_timeout> callback. |
… | |
… | |
152 | be configured to accept only so-and-so much data that it cannot act on |
179 | be configured to accept only so-and-so much data that it cannot act on |
153 | (for example, when expecting a line, an attacker could send an unlimited |
180 | (for example, when expecting a line, an attacker could send an unlimited |
154 | amount of data without a callback ever being called as long as the line |
181 | amount of data without a callback ever being called as long as the line |
155 | isn't finished). |
182 | isn't finished). |
156 | |
183 | |
|
|
184 | =item autocork => <boolean> |
|
|
185 | |
|
|
186 | When disabled (the default), then C<push_write> will try to immediately |
|
|
187 | write the data to the handle if possible. This avoids having to register |
|
|
188 | a write watcher and wait for the next event loop iteration, but can be |
|
|
189 | inefficient if you write multiple small chunks (this disadvantage is |
|
|
190 | usually avoided by your kernel's nagle algorithm, see C<low_delay>). |
|
|
191 | |
|
|
192 | When enabled, then writes will always be queued till the next event loop |
|
|
193 | iteration. This is efficient when you do many small writes per iteration, |
|
|
194 | but less efficient when you do a single write only. |
|
|
195 | |
|
|
196 | =item no_delay => <boolean> |
|
|
197 | |
|
|
198 | When doing small writes on sockets, your operating system kernel might |
|
|
199 | wait a bit for more data before actually sending it out. This is called |
|
|
200 | the Nagle algorithm, and usually it is beneficial. |
|
|
201 | |
|
|
202 | In some situations you want as low a delay as possible, which cna be |
|
|
203 | accomplishd by setting this option to true. |
|
|
204 | |
|
|
205 | The default is your opertaing system's default behaviour, this option |
|
|
206 | explicitly enables or disables it, if possible. |
|
|
207 | |
157 | =item read_size => <bytes> |
208 | =item read_size => <bytes> |
158 | |
209 | |
159 | The default read block size (the amount of bytes this module will try to read |
210 | The default read block size (the amount of bytes this module will try to read |
160 | on each [loop iteration). Default: C<4096>. |
211 | during each (loop iteration). Default: C<8192>. |
161 | |
212 | |
162 | =item low_water_mark => <bytes> |
213 | =item low_water_mark => <bytes> |
163 | |
214 | |
164 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
215 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
165 | buffer: If the write reaches this size or gets even samller it is |
216 | buffer: If the write reaches this size or gets even samller it is |
166 | considered empty. |
217 | considered empty. |
167 | |
218 | |
|
|
219 | =item linger => <seconds> |
|
|
220 | |
|
|
221 | If non-zero (default: C<3600>), then the destructor of the |
|
|
222 | AnyEvent::Handle object will check wether there is still outstanding write |
|
|
223 | data and will install a watcher that will write out this data. No errors |
|
|
224 | will be reported (this mostly matches how the operating system treats |
|
|
225 | outstanding data at socket close time). |
|
|
226 | |
|
|
227 | This will not work for partial TLS data that could not yet been |
|
|
228 | encoded. This data will be lost. |
|
|
229 | |
168 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
230 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
169 | |
231 | |
170 | When this parameter is given, it enables TLS (SSL) mode, that means it |
232 | When this parameter is given, it enables TLS (SSL) mode, that means |
171 | will start making tls handshake and will transparently encrypt/decrypt |
233 | AnyEvent will start a TLS handshake and will transparently encrypt/decrypt |
172 | data. |
234 | data. |
173 | |
235 | |
174 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
236 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
175 | automatically when you try to create a TLS handle). |
237 | automatically when you try to create a TLS handle). |
176 | |
238 | |
177 | For the TLS server side, use C<accept>, and for the TLS client side of a |
239 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
178 | connection, use C<connect> mode. |
240 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
241 | mode. |
179 | |
242 | |
180 | You can also provide your own TLS connection object, but you have |
243 | You can also provide your own TLS connection object, but you have |
181 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
244 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
182 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
245 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
183 | AnyEvent::Handle. |
246 | AnyEvent::Handle. |
184 | |
247 | |
185 | See the C<starttls> method if you need to start TLs negotiation later. |
248 | See the C<starttls> method for when need to start TLS negotiation later. |
186 | |
249 | |
187 | =item tls_ctx => $ssl_ctx |
250 | =item tls_ctx => $ssl_ctx |
188 | |
251 | |
189 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
252 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
190 | (unless a connection object was specified directly). If this parameter is |
253 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
193 | =item json => JSON or JSON::XS object |
256 | =item json => JSON or JSON::XS object |
194 | |
257 | |
195 | This is the json coder object used by the C<json> read and write types. |
258 | This is the json coder object used by the C<json> read and write types. |
196 | |
259 | |
197 | If you don't supply it, then AnyEvent::Handle will create and use a |
260 | If you don't supply it, then AnyEvent::Handle will create and use a |
198 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
261 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
262 | texts. |
199 | |
263 | |
200 | Note that you are responsible to depend on the JSON module if you want to |
264 | Note that you are responsible to depend on the JSON module if you want to |
201 | use this functionality, as AnyEvent does not have a dependency itself. |
265 | use this functionality, as AnyEvent does not have a dependency itself. |
202 | |
266 | |
203 | =item filter_r => $cb |
267 | =item filter_r => $cb |
204 | |
268 | |
205 | =item filter_w => $cb |
269 | =item filter_w => $cb |
206 | |
270 | |
207 | These exist, but are undocumented at this time. |
271 | These exist, but are undocumented at this time. (They are used internally |
|
|
272 | by the TLS code). |
208 | |
273 | |
209 | =back |
274 | =back |
210 | |
275 | |
211 | =cut |
276 | =cut |
212 | |
277 | |
… | |
… | |
222 | if ($self->{tls}) { |
287 | if ($self->{tls}) { |
223 | require Net::SSLeay; |
288 | require Net::SSLeay; |
224 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
289 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
225 | } |
290 | } |
226 | |
291 | |
227 | # $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop |
|
|
228 | # $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop |
|
|
229 | # $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop |
|
|
230 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
|
|
231 | |
|
|
232 | $self->{_activity} = AnyEvent->now; |
292 | $self->{_activity} = AnyEvent->now; |
233 | $self->_timeout; |
293 | $self->_timeout; |
234 | |
294 | |
|
|
295 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
|
|
296 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
297 | |
235 | $self->start_read; |
298 | $self->start_read |
|
|
299 | if $self->{on_read}; |
236 | |
300 | |
237 | $self |
301 | $self |
238 | } |
302 | } |
239 | |
303 | |
240 | sub _shutdown { |
304 | sub _shutdown { |
241 | my ($self) = @_; |
305 | my ($self) = @_; |
242 | |
306 | |
|
|
307 | delete $self->{_tw}; |
243 | delete $self->{_rw}; |
308 | delete $self->{_rw}; |
244 | delete $self->{_ww}; |
309 | delete $self->{_ww}; |
245 | delete $self->{fh}; |
310 | delete $self->{fh}; |
246 | } |
|
|
247 | |
311 | |
|
|
312 | $self->stoptls; |
|
|
313 | |
|
|
314 | delete $self->{on_read}; |
|
|
315 | delete $self->{_queue}; |
|
|
316 | } |
|
|
317 | |
248 | sub error { |
318 | sub _error { |
249 | my ($self) = @_; |
319 | my ($self, $errno, $fatal) = @_; |
250 | |
320 | |
251 | { |
|
|
252 | local $!; |
|
|
253 | $self->_shutdown; |
321 | $self->_shutdown |
254 | } |
322 | if $fatal; |
255 | |
323 | |
256 | $self->{on_error}($self) |
324 | $! = $errno; |
|
|
325 | |
257 | if $self->{on_error}; |
326 | if ($self->{on_error}) { |
258 | |
327 | $self->{on_error}($self, $fatal); |
|
|
328 | } else { |
259 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
329 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
|
|
330 | } |
260 | } |
331 | } |
261 | |
332 | |
262 | =item $fh = $handle->fh |
333 | =item $fh = $handle->fh |
263 | |
334 | |
264 | This method returns the file handle of the L<AnyEvent::Handle> object. |
335 | This method returns the file handle of the L<AnyEvent::Handle> object. |
… | |
… | |
295 | |
366 | |
296 | =cut |
367 | =cut |
297 | |
368 | |
298 | sub on_timeout { |
369 | sub on_timeout { |
299 | $_[0]{on_timeout} = $_[1]; |
370 | $_[0]{on_timeout} = $_[1]; |
|
|
371 | } |
|
|
372 | |
|
|
373 | =item $handle->autocork ($boolean) |
|
|
374 | |
|
|
375 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
376 | constructor argument). |
|
|
377 | |
|
|
378 | =cut |
|
|
379 | |
|
|
380 | =item $handle->no_delay ($boolean) |
|
|
381 | |
|
|
382 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
383 | the same name for details). |
|
|
384 | |
|
|
385 | =cut |
|
|
386 | |
|
|
387 | sub no_delay { |
|
|
388 | $_[0]{no_delay} = $_[1]; |
|
|
389 | |
|
|
390 | eval { |
|
|
391 | local $SIG{__DIE__}; |
|
|
392 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
393 | }; |
300 | } |
394 | } |
301 | |
395 | |
302 | ############################################################################# |
396 | ############################################################################# |
303 | |
397 | |
304 | =item $handle->timeout ($seconds) |
398 | =item $handle->timeout ($seconds) |
… | |
… | |
328 | # now or in the past already? |
422 | # now or in the past already? |
329 | if ($after <= 0) { |
423 | if ($after <= 0) { |
330 | $self->{_activity} = $NOW; |
424 | $self->{_activity} = $NOW; |
331 | |
425 | |
332 | if ($self->{on_timeout}) { |
426 | if ($self->{on_timeout}) { |
333 | $self->{on_timeout}->($self); |
427 | $self->{on_timeout}($self); |
334 | } else { |
428 | } else { |
335 | $! = Errno::ETIMEDOUT; |
429 | $self->_error (&Errno::ETIMEDOUT); |
336 | $self->error; |
|
|
337 | } |
430 | } |
338 | |
431 | |
339 | # callbakx could have changed timeout value, optimise |
432 | # callback could have changed timeout value, optimise |
340 | return unless $self->{timeout}; |
433 | return unless $self->{timeout}; |
341 | |
434 | |
342 | # calculate new after |
435 | # calculate new after |
343 | $after = $self->{timeout}; |
436 | $after = $self->{timeout}; |
344 | } |
437 | } |
345 | |
438 | |
346 | Scalar::Util::weaken $self; |
439 | Scalar::Util::weaken $self; |
|
|
440 | return unless $self; # ->error could have destroyed $self |
347 | |
441 | |
348 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
442 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
349 | delete $self->{_tw}; |
443 | delete $self->{_tw}; |
350 | $self->_timeout; |
444 | $self->_timeout; |
351 | }); |
445 | }); |
… | |
… | |
414 | if $self->{low_water_mark} >= length $self->{wbuf} |
508 | if $self->{low_water_mark} >= length $self->{wbuf} |
415 | && $self->{on_drain}; |
509 | && $self->{on_drain}; |
416 | |
510 | |
417 | delete $self->{_ww} unless length $self->{wbuf}; |
511 | delete $self->{_ww} unless length $self->{wbuf}; |
418 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
512 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
419 | $self->error; |
513 | $self->_error ($!, 1); |
420 | } |
514 | } |
421 | }; |
515 | }; |
422 | |
516 | |
423 | # try to write data immediately |
517 | # try to write data immediately |
424 | $cb->(); |
518 | $cb->() unless $self->{autocork}; |
425 | |
519 | |
426 | # if still data left in wbuf, we need to poll |
520 | # if still data left in wbuf, we need to poll |
427 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
521 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
428 | if length $self->{wbuf}; |
522 | if length $self->{wbuf}; |
429 | }; |
523 | }; |
… | |
… | |
444 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
538 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
445 | ->($self, @_); |
539 | ->($self, @_); |
446 | } |
540 | } |
447 | |
541 | |
448 | if ($self->{filter_w}) { |
542 | if ($self->{filter_w}) { |
449 | $self->{filter_w}->($self, \$_[0]); |
543 | $self->{filter_w}($self, \$_[0]); |
450 | } else { |
544 | } else { |
451 | $self->{wbuf} .= $_[0]; |
545 | $self->{wbuf} .= $_[0]; |
452 | $self->_drain_wbuf; |
546 | $self->_drain_wbuf; |
453 | } |
547 | } |
454 | } |
548 | } |
455 | |
549 | |
456 | =item $handle->push_write (type => @args) |
550 | =item $handle->push_write (type => @args) |
457 | |
551 | |
458 | =item $handle->unshift_write (type => @args) |
|
|
459 | |
|
|
460 | Instead of formatting your data yourself, you can also let this module do |
552 | Instead of formatting your data yourself, you can also let this module do |
461 | the job by specifying a type and type-specific arguments. |
553 | the job by specifying a type and type-specific arguments. |
462 | |
554 | |
463 | Predefined types are (if you have ideas for additional types, feel free to |
555 | Predefined types are (if you have ideas for additional types, feel free to |
464 | drop by and tell us): |
556 | drop by and tell us): |
… | |
… | |
468 | =item netstring => $string |
560 | =item netstring => $string |
469 | |
561 | |
470 | Formats the given value as netstring |
562 | Formats the given value as netstring |
471 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
563 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
472 | |
564 | |
473 | =back |
|
|
474 | |
|
|
475 | =cut |
565 | =cut |
476 | |
566 | |
477 | register_write_type netstring => sub { |
567 | register_write_type netstring => sub { |
478 | my ($self, $string) = @_; |
568 | my ($self, $string) = @_; |
479 | |
569 | |
480 | sprintf "%d:%s,", (length $string), $string |
570 | sprintf "%d:%s,", (length $string), $string |
|
|
571 | }; |
|
|
572 | |
|
|
573 | =item packstring => $format, $data |
|
|
574 | |
|
|
575 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
576 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
577 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
578 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
579 | |
|
|
580 | =cut |
|
|
581 | |
|
|
582 | register_write_type packstring => sub { |
|
|
583 | my ($self, $format, $string) = @_; |
|
|
584 | |
|
|
585 | pack "$format/a*", $string |
481 | }; |
586 | }; |
482 | |
587 | |
483 | =item json => $array_or_hashref |
588 | =item json => $array_or_hashref |
484 | |
589 | |
485 | Encodes the given hash or array reference into a JSON object. Unless you |
590 | Encodes the given hash or array reference into a JSON object. Unless you |
… | |
… | |
519 | |
624 | |
520 | $self->{json} ? $self->{json}->encode ($ref) |
625 | $self->{json} ? $self->{json}->encode ($ref) |
521 | : JSON::encode_json ($ref) |
626 | : JSON::encode_json ($ref) |
522 | }; |
627 | }; |
523 | |
628 | |
|
|
629 | =item storable => $reference |
|
|
630 | |
|
|
631 | Freezes the given reference using L<Storable> and writes it to the |
|
|
632 | handle. Uses the C<nfreeze> format. |
|
|
633 | |
|
|
634 | =cut |
|
|
635 | |
|
|
636 | register_write_type storable => sub { |
|
|
637 | my ($self, $ref) = @_; |
|
|
638 | |
|
|
639 | require Storable; |
|
|
640 | |
|
|
641 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
642 | }; |
|
|
643 | |
|
|
644 | =back |
|
|
645 | |
524 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
646 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
525 | |
647 | |
526 | This function (not method) lets you add your own types to C<push_write>. |
648 | This function (not method) lets you add your own types to C<push_write>. |
527 | Whenever the given C<type> is used, C<push_write> will invoke the code |
649 | Whenever the given C<type> is used, C<push_write> will invoke the code |
528 | reference with the handle object and the remaining arguments. |
650 | reference with the handle object and the remaining arguments. |
… | |
… | |
548 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
670 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
549 | a queue. |
671 | a queue. |
550 | |
672 | |
551 | In the simple case, you just install an C<on_read> callback and whenever |
673 | In the simple case, you just install an C<on_read> callback and whenever |
552 | new data arrives, it will be called. You can then remove some data (if |
674 | new data arrives, it will be called. You can then remove some data (if |
553 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
675 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
554 | or not. |
676 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
677 | partial message has been received so far). |
555 | |
678 | |
556 | In the more complex case, you want to queue multiple callbacks. In this |
679 | In the more complex case, you want to queue multiple callbacks. In this |
557 | case, AnyEvent::Handle will call the first queued callback each time new |
680 | case, AnyEvent::Handle will call the first queued callback each time new |
558 | data arrives and removes it when it has done its job (see C<push_read>, |
681 | data arrives (also the first time it is queued) and removes it when it has |
559 | below). |
682 | done its job (see C<push_read>, below). |
560 | |
683 | |
561 | This way you can, for example, push three line-reads, followed by reading |
684 | This way you can, for example, push three line-reads, followed by reading |
562 | a chunk of data, and AnyEvent::Handle will execute them in order. |
685 | a chunk of data, and AnyEvent::Handle will execute them in order. |
563 | |
686 | |
564 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
687 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
565 | the specified number of bytes which give an XML datagram. |
688 | the specified number of bytes which give an XML datagram. |
566 | |
689 | |
567 | # in the default state, expect some header bytes |
690 | # in the default state, expect some header bytes |
568 | $handle->on_read (sub { |
691 | $handle->on_read (sub { |
569 | # some data is here, now queue the length-header-read (4 octets) |
692 | # some data is here, now queue the length-header-read (4 octets) |
570 | shift->unshift_read_chunk (4, sub { |
693 | shift->unshift_read (chunk => 4, sub { |
571 | # header arrived, decode |
694 | # header arrived, decode |
572 | my $len = unpack "N", $_[1]; |
695 | my $len = unpack "N", $_[1]; |
573 | |
696 | |
574 | # now read the payload |
697 | # now read the payload |
575 | shift->unshift_read_chunk ($len, sub { |
698 | shift->unshift_read (chunk => $len, sub { |
576 | my $xml = $_[1]; |
699 | my $xml = $_[1]; |
577 | # handle xml |
700 | # handle xml |
578 | }); |
701 | }); |
579 | }); |
702 | }); |
580 | }); |
703 | }); |
581 | |
704 | |
582 | Example 2: Implement a client for a protocol that replies either with |
705 | Example 2: Implement a client for a protocol that replies either with "OK" |
583 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
706 | and another line or "ERROR" for the first request that is sent, and 64 |
584 | second request. Due tot he availability of a full queue, we can just |
707 | bytes for the second request. Due to the availability of a queue, we can |
585 | pipeline sending both requests and manipulate the queue as necessary in |
708 | just pipeline sending both requests and manipulate the queue as necessary |
586 | the callbacks: |
709 | in the callbacks. |
587 | |
710 | |
588 | # request one |
711 | When the first callback is called and sees an "OK" response, it will |
|
|
712 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
713 | 64-byte chunk callback. |
|
|
714 | |
|
|
715 | # request one, returns either "OK + extra line" or "ERROR" |
589 | $handle->push_write ("request 1\015\012"); |
716 | $handle->push_write ("request 1\015\012"); |
590 | |
717 | |
591 | # we expect "ERROR" or "OK" as response, so push a line read |
718 | # we expect "ERROR" or "OK" as response, so push a line read |
592 | $handle->push_read_line (sub { |
719 | $handle->push_read (line => sub { |
593 | # if we got an "OK", we have to _prepend_ another line, |
720 | # if we got an "OK", we have to _prepend_ another line, |
594 | # so it will be read before the second request reads its 64 bytes |
721 | # so it will be read before the second request reads its 64 bytes |
595 | # which are already in the queue when this callback is called |
722 | # which are already in the queue when this callback is called |
596 | # we don't do this in case we got an error |
723 | # we don't do this in case we got an error |
597 | if ($_[1] eq "OK") { |
724 | if ($_[1] eq "OK") { |
598 | $_[0]->unshift_read_line (sub { |
725 | $_[0]->unshift_read (line => sub { |
599 | my $response = $_[1]; |
726 | my $response = $_[1]; |
600 | ... |
727 | ... |
601 | }); |
728 | }); |
602 | } |
729 | } |
603 | }); |
730 | }); |
604 | |
731 | |
605 | # request two |
732 | # request two, simply returns 64 octets |
606 | $handle->push_write ("request 2\015\012"); |
733 | $handle->push_write ("request 2\015\012"); |
607 | |
734 | |
608 | # simply read 64 bytes, always |
735 | # simply read 64 bytes, always |
609 | $handle->push_read_chunk (64, sub { |
736 | $handle->push_read (chunk => 64, sub { |
610 | my $response = $_[1]; |
737 | my $response = $_[1]; |
611 | ... |
738 | ... |
612 | }); |
739 | }); |
613 | |
740 | |
614 | =over 4 |
741 | =over 4 |
615 | |
742 | |
616 | =cut |
743 | =cut |
617 | |
744 | |
618 | sub _drain_rbuf { |
745 | sub _drain_rbuf { |
619 | my ($self) = @_; |
746 | my ($self) = @_; |
|
|
747 | |
|
|
748 | local $self->{_in_drain} = 1; |
620 | |
749 | |
621 | if ( |
750 | if ( |
622 | defined $self->{rbuf_max} |
751 | defined $self->{rbuf_max} |
623 | && $self->{rbuf_max} < length $self->{rbuf} |
752 | && $self->{rbuf_max} < length $self->{rbuf} |
624 | ) { |
753 | ) { |
625 | $! = &Errno::ENOSPC; |
754 | $self->_error (&Errno::ENOSPC, 1), return; |
626 | $self->error; |
|
|
627 | } |
755 | } |
628 | |
756 | |
629 | return if $self->{in_drain}; |
757 | while () { |
630 | local $self->{in_drain} = 1; |
|
|
631 | |
|
|
632 | while (my $len = length $self->{rbuf}) { |
758 | my $len = length $self->{rbuf}; |
633 | no strict 'refs'; |
759 | |
634 | if (my $cb = shift @{ $self->{_queue} }) { |
760 | if (my $cb = shift @{ $self->{_queue} }) { |
635 | unless ($cb->($self)) { |
761 | unless ($cb->($self)) { |
636 | if ($self->{_eof}) { |
762 | if ($self->{_eof}) { |
637 | # no progress can be made (not enough data and no data forthcoming) |
763 | # no progress can be made (not enough data and no data forthcoming) |
638 | $! = &Errno::EPIPE; |
764 | $self->_error (&Errno::EPIPE, 1), return; |
639 | $self->error; |
|
|
640 | } |
765 | } |
641 | |
766 | |
642 | unshift @{ $self->{_queue} }, $cb; |
767 | unshift @{ $self->{_queue} }, $cb; |
643 | return; |
768 | last; |
644 | } |
769 | } |
645 | } elsif ($self->{on_read}) { |
770 | } elsif ($self->{on_read}) { |
|
|
771 | last unless $len; |
|
|
772 | |
646 | $self->{on_read}($self); |
773 | $self->{on_read}($self); |
647 | |
774 | |
648 | if ( |
775 | if ( |
649 | $self->{_eof} # if no further data will arrive |
|
|
650 | && $len == length $self->{rbuf} # and no data has been consumed |
776 | $len == length $self->{rbuf} # if no data has been consumed |
651 | && !@{ $self->{_queue} } # and the queue is still empty |
777 | && !@{ $self->{_queue} } # and the queue is still empty |
652 | && $self->{on_read} # and we still want to read data |
778 | && $self->{on_read} # but we still have on_read |
653 | ) { |
779 | ) { |
|
|
780 | # no further data will arrive |
654 | # then no progress can be made |
781 | # so no progress can be made |
655 | $! = &Errno::EPIPE; |
782 | $self->_error (&Errno::EPIPE, 1), return |
656 | $self->error; |
783 | if $self->{_eof}; |
|
|
784 | |
|
|
785 | last; # more data might arrive |
657 | } |
786 | } |
658 | } else { |
787 | } else { |
659 | # read side becomes idle |
788 | # read side becomes idle |
660 | delete $self->{_rw}; |
789 | delete $self->{_rw}; |
661 | return; |
790 | last; |
662 | } |
791 | } |
663 | } |
792 | } |
664 | |
793 | |
665 | if ($self->{_eof}) { |
794 | if ($self->{_eof}) { |
666 | $self->_shutdown; |
795 | if ($self->{on_eof}) { |
667 | $self->{on_eof}($self) |
796 | $self->{on_eof}($self) |
668 | if $self->{on_eof}; |
797 | } else { |
|
|
798 | $self->_error (0, 1); |
|
|
799 | } |
|
|
800 | } |
|
|
801 | |
|
|
802 | # may need to restart read watcher |
|
|
803 | unless ($self->{_rw}) { |
|
|
804 | $self->start_read |
|
|
805 | if $self->{on_read} || @{ $self->{_queue} }; |
669 | } |
806 | } |
670 | } |
807 | } |
671 | |
808 | |
672 | =item $handle->on_read ($cb) |
809 | =item $handle->on_read ($cb) |
673 | |
810 | |
… | |
… | |
679 | |
816 | |
680 | sub on_read { |
817 | sub on_read { |
681 | my ($self, $cb) = @_; |
818 | my ($self, $cb) = @_; |
682 | |
819 | |
683 | $self->{on_read} = $cb; |
820 | $self->{on_read} = $cb; |
|
|
821 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
684 | } |
822 | } |
685 | |
823 | |
686 | =item $handle->rbuf |
824 | =item $handle->rbuf |
687 | |
825 | |
688 | Returns the read buffer (as a modifiable lvalue). |
826 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
737 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
875 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
738 | ->($self, $cb, @_); |
876 | ->($self, $cb, @_); |
739 | } |
877 | } |
740 | |
878 | |
741 | push @{ $self->{_queue} }, $cb; |
879 | push @{ $self->{_queue} }, $cb; |
742 | $self->_drain_rbuf; |
880 | $self->_drain_rbuf unless $self->{_in_drain}; |
743 | } |
881 | } |
744 | |
882 | |
745 | sub unshift_read { |
883 | sub unshift_read { |
746 | my $self = shift; |
884 | my $self = shift; |
747 | my $cb = pop; |
885 | my $cb = pop; |
… | |
… | |
753 | ->($self, $cb, @_); |
891 | ->($self, $cb, @_); |
754 | } |
892 | } |
755 | |
893 | |
756 | |
894 | |
757 | unshift @{ $self->{_queue} }, $cb; |
895 | unshift @{ $self->{_queue} }, $cb; |
758 | $self->_drain_rbuf; |
896 | $self->_drain_rbuf unless $self->{_in_drain}; |
759 | } |
897 | } |
760 | |
898 | |
761 | =item $handle->push_read (type => @args, $cb) |
899 | =item $handle->push_read (type => @args, $cb) |
762 | |
900 | |
763 | =item $handle->unshift_read (type => @args, $cb) |
901 | =item $handle->unshift_read (type => @args, $cb) |
… | |
… | |
793 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
931 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
794 | 1 |
932 | 1 |
795 | } |
933 | } |
796 | }; |
934 | }; |
797 | |
935 | |
798 | # compatibility with older API |
|
|
799 | sub push_read_chunk { |
|
|
800 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
801 | } |
|
|
802 | |
|
|
803 | sub unshift_read_chunk { |
|
|
804 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
805 | } |
|
|
806 | |
|
|
807 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
936 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
808 | |
937 | |
809 | The callback will be called only once a full line (including the end of |
938 | The callback will be called only once a full line (including the end of |
810 | line marker, C<$eol>) has been read. This line (excluding the end of line |
939 | line marker, C<$eol>) has been read. This line (excluding the end of line |
811 | marker) will be passed to the callback as second argument (C<$line>), and |
940 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
826 | =cut |
955 | =cut |
827 | |
956 | |
828 | register_read_type line => sub { |
957 | register_read_type line => sub { |
829 | my ($self, $cb, $eol) = @_; |
958 | my ($self, $cb, $eol) = @_; |
830 | |
959 | |
831 | $eol = qr|(\015?\012)| if @_ < 3; |
960 | if (@_ < 3) { |
832 | $eol = quotemeta $eol unless ref $eol; |
961 | # this is more than twice as fast as the generic code below |
833 | $eol = qr|^(.*?)($eol)|s; |
|
|
834 | |
|
|
835 | sub { |
962 | sub { |
836 | $_[0]{rbuf} =~ s/$eol// or return; |
963 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
837 | |
964 | |
838 | $cb->($_[0], $1, $2); |
965 | $cb->($_[0], $1, $2); |
839 | 1 |
|
|
840 | } |
|
|
841 | }; |
|
|
842 | |
|
|
843 | # compatibility with older API |
|
|
844 | sub push_read_line { |
|
|
845 | my $self = shift; |
|
|
846 | $self->push_read (line => @_); |
|
|
847 | } |
|
|
848 | |
|
|
849 | sub unshift_read_line { |
|
|
850 | my $self = shift; |
|
|
851 | $self->unshift_read (line => @_); |
|
|
852 | } |
|
|
853 | |
|
|
854 | =item netstring => $cb->($handle, $string) |
|
|
855 | |
|
|
856 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
857 | |
|
|
858 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
859 | |
|
|
860 | =cut |
|
|
861 | |
|
|
862 | register_read_type netstring => sub { |
|
|
863 | my ($self, $cb) = @_; |
|
|
864 | |
|
|
865 | sub { |
|
|
866 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
867 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
868 | $! = &Errno::EBADMSG; |
|
|
869 | $self->error; |
|
|
870 | } |
966 | 1 |
871 | return; |
|
|
872 | } |
967 | } |
|
|
968 | } else { |
|
|
969 | $eol = quotemeta $eol unless ref $eol; |
|
|
970 | $eol = qr|^(.*?)($eol)|s; |
873 | |
971 | |
874 | my $len = $1; |
972 | sub { |
|
|
973 | $_[0]{rbuf} =~ s/$eol// or return; |
875 | |
974 | |
876 | $self->unshift_read (chunk => $len, sub { |
975 | $cb->($_[0], $1, $2); |
877 | my $string = $_[1]; |
|
|
878 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
879 | if ($_[1] eq ",") { |
|
|
880 | $cb->($_[0], $string); |
|
|
881 | } else { |
|
|
882 | $! = &Errno::EBADMSG; |
|
|
883 | $self->error; |
|
|
884 | } |
|
|
885 | }); |
976 | 1 |
886 | }); |
977 | } |
887 | |
|
|
888 | 1 |
|
|
889 | } |
978 | } |
890 | }; |
979 | }; |
891 | |
980 | |
892 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
981 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
893 | |
982 | |
… | |
… | |
945 | return 1; |
1034 | return 1; |
946 | } |
1035 | } |
947 | |
1036 | |
948 | # reject |
1037 | # reject |
949 | if ($reject && $$rbuf =~ $reject) { |
1038 | if ($reject && $$rbuf =~ $reject) { |
950 | $! = &Errno::EBADMSG; |
1039 | $self->_error (&Errno::EBADMSG); |
951 | $self->error; |
|
|
952 | } |
1040 | } |
953 | |
1041 | |
954 | # skip |
1042 | # skip |
955 | if ($skip && $$rbuf =~ $skip) { |
1043 | if ($skip && $$rbuf =~ $skip) { |
956 | $data .= substr $$rbuf, 0, $+[0], ""; |
1044 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
958 | |
1046 | |
959 | () |
1047 | () |
960 | } |
1048 | } |
961 | }; |
1049 | }; |
962 | |
1050 | |
|
|
1051 | =item netstring => $cb->($handle, $string) |
|
|
1052 | |
|
|
1053 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
1054 | |
|
|
1055 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
1056 | |
|
|
1057 | =cut |
|
|
1058 | |
|
|
1059 | register_read_type netstring => sub { |
|
|
1060 | my ($self, $cb) = @_; |
|
|
1061 | |
|
|
1062 | sub { |
|
|
1063 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
1064 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
1065 | $self->_error (&Errno::EBADMSG); |
|
|
1066 | } |
|
|
1067 | return; |
|
|
1068 | } |
|
|
1069 | |
|
|
1070 | my $len = $1; |
|
|
1071 | |
|
|
1072 | $self->unshift_read (chunk => $len, sub { |
|
|
1073 | my $string = $_[1]; |
|
|
1074 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
1075 | if ($_[1] eq ",") { |
|
|
1076 | $cb->($_[0], $string); |
|
|
1077 | } else { |
|
|
1078 | $self->_error (&Errno::EBADMSG); |
|
|
1079 | } |
|
|
1080 | }); |
|
|
1081 | }); |
|
|
1082 | |
|
|
1083 | 1 |
|
|
1084 | } |
|
|
1085 | }; |
|
|
1086 | |
|
|
1087 | =item packstring => $format, $cb->($handle, $string) |
|
|
1088 | |
|
|
1089 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1090 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1091 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1092 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1093 | |
|
|
1094 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
1095 | |
|
|
1096 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1097 | format (very efficient). |
|
|
1098 | |
|
|
1099 | $handle->push_read (packstring => "w", sub { |
|
|
1100 | my ($handle, $data) = @_; |
|
|
1101 | }); |
|
|
1102 | |
|
|
1103 | =cut |
|
|
1104 | |
|
|
1105 | register_read_type packstring => sub { |
|
|
1106 | my ($self, $cb, $format) = @_; |
|
|
1107 | |
|
|
1108 | sub { |
|
|
1109 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1110 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
|
|
1111 | or return; |
|
|
1112 | |
|
|
1113 | $format = length pack $format, $len; |
|
|
1114 | |
|
|
1115 | # bypass unshift if we already have the remaining chunk |
|
|
1116 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1117 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1118 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1119 | $cb->($_[0], $data); |
|
|
1120 | } else { |
|
|
1121 | # remove prefix |
|
|
1122 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1123 | |
|
|
1124 | # read remaining chunk |
|
|
1125 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1126 | } |
|
|
1127 | |
|
|
1128 | 1 |
|
|
1129 | } |
|
|
1130 | }; |
|
|
1131 | |
963 | =item json => $cb->($handle, $hash_or_arrayref) |
1132 | =item json => $cb->($handle, $hash_or_arrayref) |
964 | |
1133 | |
965 | Reads a JSON object or array, decodes it and passes it to the callback. |
1134 | Reads a JSON object or array, decodes it and passes it to the callback. |
966 | |
1135 | |
967 | If a C<json> object was passed to the constructor, then that will be used |
1136 | If a C<json> object was passed to the constructor, then that will be used |
… | |
… | |
977 | the C<json> write type description, above, for an actual example. |
1146 | the C<json> write type description, above, for an actual example. |
978 | |
1147 | |
979 | =cut |
1148 | =cut |
980 | |
1149 | |
981 | register_read_type json => sub { |
1150 | register_read_type json => sub { |
982 | my ($self, $cb, $accept, $reject, $skip) = @_; |
1151 | my ($self, $cb) = @_; |
983 | |
1152 | |
984 | require JSON; |
1153 | require JSON; |
985 | |
1154 | |
986 | my $data; |
1155 | my $data; |
987 | my $rbuf = \$self->{rbuf}; |
1156 | my $rbuf = \$self->{rbuf}; |
… | |
… | |
1002 | () |
1171 | () |
1003 | } |
1172 | } |
1004 | } |
1173 | } |
1005 | }; |
1174 | }; |
1006 | |
1175 | |
|
|
1176 | =item storable => $cb->($handle, $ref) |
|
|
1177 | |
|
|
1178 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1179 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1180 | data). |
|
|
1181 | |
|
|
1182 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1183 | |
|
|
1184 | =cut |
|
|
1185 | |
|
|
1186 | register_read_type storable => sub { |
|
|
1187 | my ($self, $cb) = @_; |
|
|
1188 | |
|
|
1189 | require Storable; |
|
|
1190 | |
|
|
1191 | sub { |
|
|
1192 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1193 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1194 | or return; |
|
|
1195 | |
|
|
1196 | my $format = length pack "w", $len; |
|
|
1197 | |
|
|
1198 | # bypass unshift if we already have the remaining chunk |
|
|
1199 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1200 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1201 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1202 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1203 | } else { |
|
|
1204 | # remove prefix |
|
|
1205 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1206 | |
|
|
1207 | # read remaining chunk |
|
|
1208 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1209 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1210 | $cb->($_[0], $ref); |
|
|
1211 | } else { |
|
|
1212 | $self->_error (&Errno::EBADMSG); |
|
|
1213 | } |
|
|
1214 | }); |
|
|
1215 | } |
|
|
1216 | |
|
|
1217 | 1 |
|
|
1218 | } |
|
|
1219 | }; |
|
|
1220 | |
1007 | =back |
1221 | =back |
1008 | |
1222 | |
1009 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1223 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1010 | |
1224 | |
1011 | This function (not method) lets you add your own types to C<push_read>. |
1225 | This function (not method) lets you add your own types to C<push_read>. |
… | |
… | |
1029 | =item $handle->stop_read |
1243 | =item $handle->stop_read |
1030 | |
1244 | |
1031 | =item $handle->start_read |
1245 | =item $handle->start_read |
1032 | |
1246 | |
1033 | In rare cases you actually do not want to read anything from the |
1247 | In rare cases you actually do not want to read anything from the |
1034 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
1248 | socket. In this case you can call C<stop_read>. Neither C<on_read> nor |
1035 | any queued callbacks will be executed then. To start reading again, call |
1249 | any queued callbacks will be executed then. To start reading again, call |
1036 | C<start_read>. |
1250 | C<start_read>. |
|
|
1251 | |
|
|
1252 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
|
|
1253 | you change the C<on_read> callback or push/unshift a read callback, and it |
|
|
1254 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
|
|
1255 | there are any read requests in the queue. |
1037 | |
1256 | |
1038 | =cut |
1257 | =cut |
1039 | |
1258 | |
1040 | sub stop_read { |
1259 | sub stop_read { |
1041 | my ($self) = @_; |
1260 | my ($self) = @_; |
… | |
… | |
1055 | |
1274 | |
1056 | if ($len > 0) { |
1275 | if ($len > 0) { |
1057 | $self->{_activity} = AnyEvent->now; |
1276 | $self->{_activity} = AnyEvent->now; |
1058 | |
1277 | |
1059 | $self->{filter_r} |
1278 | $self->{filter_r} |
1060 | ? $self->{filter_r}->($self, $rbuf) |
1279 | ? $self->{filter_r}($self, $rbuf) |
1061 | : $self->_drain_rbuf; |
1280 | : $self->{_in_drain} || $self->_drain_rbuf; |
1062 | |
1281 | |
1063 | } elsif (defined $len) { |
1282 | } elsif (defined $len) { |
1064 | delete $self->{_rw}; |
1283 | delete $self->{_rw}; |
1065 | delete $self->{_ww}; |
|
|
1066 | delete $self->{_tw}; |
|
|
1067 | $self->{_eof} = 1; |
1284 | $self->{_eof} = 1; |
1068 | $self->_drain_rbuf; |
1285 | $self->_drain_rbuf unless $self->{_in_drain}; |
1069 | |
1286 | |
1070 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1287 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1071 | return $self->error; |
1288 | return $self->_error ($!, 1); |
1072 | } |
1289 | } |
1073 | }); |
1290 | }); |
1074 | } |
1291 | } |
1075 | } |
1292 | } |
1076 | |
1293 | |
1077 | sub _dotls { |
1294 | sub _dotls { |
1078 | my ($self) = @_; |
1295 | my ($self) = @_; |
|
|
1296 | |
|
|
1297 | my $buf; |
1079 | |
1298 | |
1080 | if (length $self->{_tls_wbuf}) { |
1299 | if (length $self->{_tls_wbuf}) { |
1081 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1300 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1082 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1301 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1083 | } |
1302 | } |
1084 | } |
1303 | } |
1085 | |
1304 | |
1086 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1305 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1087 | $self->{wbuf} .= $buf; |
1306 | $self->{wbuf} .= $buf; |
1088 | $self->_drain_wbuf; |
1307 | $self->_drain_wbuf; |
1089 | } |
1308 | } |
1090 | |
1309 | |
1091 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
1310 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
1311 | if (length $buf) { |
1092 | $self->{rbuf} .= $buf; |
1312 | $self->{rbuf} .= $buf; |
1093 | $self->_drain_rbuf; |
1313 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1314 | } else { |
|
|
1315 | # let's treat SSL-eof as we treat normal EOF |
|
|
1316 | $self->{_eof} = 1; |
|
|
1317 | $self->_shutdown; |
|
|
1318 | return; |
|
|
1319 | } |
1094 | } |
1320 | } |
1095 | |
1321 | |
1096 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1322 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1097 | |
1323 | |
1098 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1324 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1099 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1325 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1100 | $self->error; |
1326 | return $self->_error ($!, 1); |
1101 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1327 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1102 | $! = &Errno::EIO; |
1328 | return $self->_error (&Errno::EIO, 1); |
1103 | $self->error; |
|
|
1104 | } |
1329 | } |
1105 | |
1330 | |
1106 | # all others are fine for our purposes |
1331 | # all others are fine for our purposes |
1107 | } |
1332 | } |
1108 | } |
1333 | } |
… | |
… | |
1123 | call and can be used or changed to your liking. Note that the handshake |
1348 | call and can be used or changed to your liking. Note that the handshake |
1124 | might have already started when this function returns. |
1349 | might have already started when this function returns. |
1125 | |
1350 | |
1126 | =cut |
1351 | =cut |
1127 | |
1352 | |
1128 | # TODO: maybe document... |
|
|
1129 | sub starttls { |
1353 | sub starttls { |
1130 | my ($self, $ssl, $ctx) = @_; |
1354 | my ($self, $ssl, $ctx) = @_; |
1131 | |
1355 | |
1132 | $self->stoptls; |
1356 | $self->stoptls; |
1133 | |
1357 | |
… | |
… | |
1144 | # basically, this is deep magic (because SSL_read should have the same issues) |
1368 | # basically, this is deep magic (because SSL_read should have the same issues) |
1145 | # but the openssl maintainers basically said: "trust us, it just works". |
1369 | # but the openssl maintainers basically said: "trust us, it just works". |
1146 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1370 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1147 | # and mismaintained ssleay-module doesn't even offer them). |
1371 | # and mismaintained ssleay-module doesn't even offer them). |
1148 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1372 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1373 | # |
|
|
1374 | # in short: this is a mess. |
|
|
1375 | # |
|
|
1376 | # note that we do not try to kepe the length constant between writes as we are required to do. |
|
|
1377 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
|
|
1378 | # and we drive openssl fully in blocking mode here. |
1149 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1379 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1150 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1380 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1151 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1381 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1152 | |
1382 | |
1153 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1383 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
… | |
… | |
1186 | |
1416 | |
1187 | sub DESTROY { |
1417 | sub DESTROY { |
1188 | my $self = shift; |
1418 | my $self = shift; |
1189 | |
1419 | |
1190 | $self->stoptls; |
1420 | $self->stoptls; |
|
|
1421 | |
|
|
1422 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1423 | |
|
|
1424 | if ($linger && length $self->{wbuf}) { |
|
|
1425 | my $fh = delete $self->{fh}; |
|
|
1426 | my $wbuf = delete $self->{wbuf}; |
|
|
1427 | |
|
|
1428 | my @linger; |
|
|
1429 | |
|
|
1430 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1431 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1432 | |
|
|
1433 | if ($len > 0) { |
|
|
1434 | substr $wbuf, 0, $len, ""; |
|
|
1435 | } else { |
|
|
1436 | @linger = (); # end |
|
|
1437 | } |
|
|
1438 | }); |
|
|
1439 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1440 | @linger = (); |
|
|
1441 | }); |
|
|
1442 | } |
1191 | } |
1443 | } |
1192 | |
1444 | |
1193 | =item AnyEvent::Handle::TLS_CTX |
1445 | =item AnyEvent::Handle::TLS_CTX |
1194 | |
1446 | |
1195 | This function creates and returns the Net::SSLeay::CTX object used by |
1447 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
1237 | =over 4 |
1489 | =over 4 |
1238 | |
1490 | |
1239 | =item * all constructor arguments become object members. |
1491 | =item * all constructor arguments become object members. |
1240 | |
1492 | |
1241 | At least initially, when you pass a C<tls>-argument to the constructor it |
1493 | At least initially, when you pass a C<tls>-argument to the constructor it |
1242 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1494 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1243 | mutated later on (for example C<tls> will hold the TLS connection object). |
1495 | mutated later on (for example C<tls> will hold the TLS connection object). |
1244 | |
1496 | |
1245 | =item * other object member names are prefixed with an C<_>. |
1497 | =item * other object member names are prefixed with an C<_>. |
1246 | |
1498 | |
1247 | All object members not explicitly documented (internal use) are prefixed |
1499 | All object members not explicitly documented (internal use) are prefixed |