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(WSAWOULDBLOCK); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
10 | use Fcntl (); |
10 | use Fcntl (); |
11 | use Errno qw/EAGAIN EINTR/; |
11 | use Errno qw(EAGAIN EINTR); |
12 | |
12 | |
13 | =head1 NAME |
13 | =head1 NAME |
14 | |
14 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
16 | |
17 | =cut |
17 | =cut |
18 | |
18 | |
19 | our $VERSION = '0.04'; |
19 | our $VERSION = 4.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->($self) |
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->($self) |
100 | =item on_error => $cb->($handle, $fatal) |
87 | |
101 | |
88 | This is the fatal error callback, that is called when, well, a fatal error |
102 | This is the error callback, which is called when, well, some error |
89 | occurs, such as not being able to resolve the hostname, failure to connect |
103 | occured, such as not being able to resolve the hostname, failure to |
90 | or a read error. |
104 | connect or a read error. |
91 | |
105 | |
92 | The object will not be in a usable state when this callback has been |
106 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
93 | called. |
107 | fatal errors the handle object will be shut down and will not be usable |
|
|
108 | (but you are free to look at the current C< ->rbuf >). Examples of fatal |
|
|
109 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
110 | (C<EPIPE>) or I/O errors. |
|
|
111 | |
|
|
112 | Non-fatal errors can be retried by simply returning, but it is recommended |
|
|
113 | to simply ignore this parameter and instead abondon the handle object |
|
|
114 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
115 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
94 | |
116 | |
95 | On callback entrance, the value of C<$!> contains the operating system |
117 | On callback entrance, the value of C<$!> contains the operating system |
96 | error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>). |
118 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
97 | |
|
|
98 | The callback should throw an exception. If it returns, then |
|
|
99 | AnyEvent::Handle will C<croak> for you. |
|
|
100 | |
119 | |
101 | While not mandatory, it is I<highly> recommended to set this callback, as |
120 | While not mandatory, it is I<highly> recommended to set this callback, as |
102 | you will not be notified of errors otherwise. The default simply calls |
121 | you will not be notified of errors otherwise. The default simply calls |
103 | die. |
122 | C<croak>. |
104 | |
123 | |
105 | =item on_read => $cb->($self) |
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<$self->{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 |
114 | feed all the remaining data to the queued callbacks and C<on_read> before |
135 | feed all the remaining data to the queued callbacks and C<on_read> before |
115 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
136 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
116 | error will be raised (with C<$!> set to C<EPIPE>). |
137 | error will be raised (with C<$!> set to C<EPIPE>). |
117 | |
138 | |
118 | =item on_drain => $cb->() |
139 | =item on_drain => $cb->($handle) |
119 | |
140 | |
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. |
|
|
145 | |
|
|
146 | This callback is useful when you don't want to put all of your write data |
|
|
147 | into the queue at once, for example, when you want to write the contents |
|
|
148 | of some file to the socket you might not want to read the whole file into |
|
|
149 | memory and push it into the queue, but instead only read more data from |
|
|
150 | the file when the write queue becomes empty. |
|
|
151 | |
|
|
152 | =item timeout => $fractional_seconds |
|
|
153 | |
|
|
154 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
|
|
155 | seconds pass without a successful read or write on the underlying file |
|
|
156 | handle, the C<on_timeout> callback will be invoked (and if that one is |
|
|
157 | missing, an C<ETIMEDOUT> error will be raised). |
|
|
158 | |
|
|
159 | Note that timeout processing is also active when you currently do not have |
|
|
160 | any outstanding read or write requests: If you plan to keep the connection |
|
|
161 | idle then you should disable the timout temporarily or ignore the timeout |
|
|
162 | in the C<on_timeout> callback. |
|
|
163 | |
|
|
164 | Zero (the default) disables this timeout. |
|
|
165 | |
|
|
166 | =item on_timeout => $cb->($handle) |
|
|
167 | |
|
|
168 | Called whenever the inactivity timeout passes. If you return from this |
|
|
169 | callback, then the timeout will be reset as if some activity had happened, |
|
|
170 | so this condition is not fatal in any way. |
124 | |
171 | |
125 | =item rbuf_max => <bytes> |
172 | =item rbuf_max => <bytes> |
126 | |
173 | |
127 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
174 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
128 | when the read buffer ever (strictly) exceeds this size. This is useful to |
175 | when the read buffer ever (strictly) exceeds this size. This is useful to |
… | |
… | |
132 | 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 |
133 | (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 |
134 | 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 |
135 | isn't finished). |
182 | isn't finished). |
136 | |
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 | |
137 | =item read_size => <bytes> |
208 | =item read_size => <bytes> |
138 | |
209 | |
139 | 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 |
140 | on each [loop iteration). Default: C<4096>. |
211 | during each (loop iteration). Default: C<8192>. |
141 | |
212 | |
142 | =item low_water_mark => <bytes> |
213 | =item low_water_mark => <bytes> |
143 | |
214 | |
144 | 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 |
145 | 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 |
146 | considered empty. |
217 | considered empty. |
|
|
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. |
147 | |
229 | |
148 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
230 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
149 | |
231 | |
150 | 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 it |
151 | will start making tls handshake and will transparently encrypt/decrypt |
233 | will start making tls handshake and will transparently encrypt/decrypt |
… | |
… | |
160 | You can also provide your own TLS connection object, but you have |
242 | You can also provide your own TLS connection object, but you have |
161 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
243 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
162 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
244 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
163 | AnyEvent::Handle. |
245 | AnyEvent::Handle. |
164 | |
246 | |
165 | See the C<starttls> method if you need to start TLs negotiation later. |
247 | See the C<starttls> method if you need to start TLS negotiation later. |
166 | |
248 | |
167 | =item tls_ctx => $ssl_ctx |
249 | =item tls_ctx => $ssl_ctx |
168 | |
250 | |
169 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
251 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
170 | (unless a connection object was specified directly). If this parameter is |
252 | (unless a connection object was specified directly). If this parameter is |
171 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
253 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
172 | |
254 | |
|
|
255 | =item json => JSON or JSON::XS object |
|
|
256 | |
|
|
257 | This is the json coder object used by the C<json> read and write types. |
|
|
258 | |
|
|
259 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
260 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
|
|
261 | |
|
|
262 | Note that you are responsible to depend on the JSON module if you want to |
|
|
263 | use this functionality, as AnyEvent does not have a dependency itself. |
|
|
264 | |
173 | =item filter_r => $cb |
265 | =item filter_r => $cb |
174 | |
266 | |
175 | =item filter_w => $cb |
267 | =item filter_w => $cb |
176 | |
268 | |
177 | These exist, but are undocumented at this time. |
269 | These exist, but are undocumented at this time. |
… | |
… | |
192 | if ($self->{tls}) { |
284 | if ($self->{tls}) { |
193 | require Net::SSLeay; |
285 | require Net::SSLeay; |
194 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
286 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
195 | } |
287 | } |
196 | |
288 | |
197 | $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; |
289 | $self->{_activity} = AnyEvent->now; |
198 | $self->on_error (delete $self->{on_error}) if $self->{on_error}; |
290 | $self->_timeout; |
|
|
291 | |
199 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
292 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
200 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
293 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
201 | |
294 | |
202 | $self->start_read; |
295 | $self->start_read |
|
|
296 | if $self->{on_read}; |
203 | |
297 | |
204 | $self |
298 | $self |
205 | } |
299 | } |
206 | |
300 | |
207 | sub _shutdown { |
301 | sub _shutdown { |
208 | my ($self) = @_; |
302 | my ($self) = @_; |
209 | |
303 | |
|
|
304 | delete $self->{_tw}; |
210 | delete $self->{_rw}; |
305 | delete $self->{_rw}; |
211 | delete $self->{_ww}; |
306 | delete $self->{_ww}; |
212 | delete $self->{fh}; |
307 | delete $self->{fh}; |
213 | } |
|
|
214 | |
308 | |
|
|
309 | $self->stoptls; |
|
|
310 | |
|
|
311 | delete $self->{on_read}; |
|
|
312 | delete $self->{_queue}; |
|
|
313 | } |
|
|
314 | |
215 | sub error { |
315 | sub _error { |
216 | my ($self) = @_; |
316 | my ($self, $errno, $fatal) = @_; |
217 | |
317 | |
218 | { |
|
|
219 | local $!; |
|
|
220 | $self->_shutdown; |
318 | $self->_shutdown |
221 | } |
319 | if $fatal; |
222 | |
320 | |
223 | $self->{on_error}($self) |
321 | $! = $errno; |
|
|
322 | |
224 | if $self->{on_error}; |
323 | if ($self->{on_error}) { |
225 | |
324 | $self->{on_error}($self, $fatal); |
|
|
325 | } else { |
226 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
326 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
|
|
327 | } |
227 | } |
328 | } |
228 | |
329 | |
229 | =item $fh = $handle->fh |
330 | =item $fh = $handle->fh |
230 | |
331 | |
231 | This method returns the file handle of the L<AnyEvent::Handle> object. |
332 | This method returns the file handle of the L<AnyEvent::Handle> object. |
… | |
… | |
250 | |
351 | |
251 | =cut |
352 | =cut |
252 | |
353 | |
253 | sub on_eof { |
354 | sub on_eof { |
254 | $_[0]{on_eof} = $_[1]; |
355 | $_[0]{on_eof} = $_[1]; |
|
|
356 | } |
|
|
357 | |
|
|
358 | =item $handle->on_timeout ($cb) |
|
|
359 | |
|
|
360 | Replace the current C<on_timeout> callback, or disables the callback |
|
|
361 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
|
|
362 | argument. |
|
|
363 | |
|
|
364 | =cut |
|
|
365 | |
|
|
366 | sub on_timeout { |
|
|
367 | $_[0]{on_timeout} = $_[1]; |
|
|
368 | } |
|
|
369 | |
|
|
370 | =item $handle->autocork ($boolean) |
|
|
371 | |
|
|
372 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
373 | constructor argument). |
|
|
374 | |
|
|
375 | =cut |
|
|
376 | |
|
|
377 | =item $handle->no_delay ($boolean) |
|
|
378 | |
|
|
379 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
380 | the same name for details). |
|
|
381 | |
|
|
382 | =cut |
|
|
383 | |
|
|
384 | sub no_delay { |
|
|
385 | $_[0]{no_delay} = $_[1]; |
|
|
386 | |
|
|
387 | eval { |
|
|
388 | local $SIG{__DIE__}; |
|
|
389 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
390 | }; |
|
|
391 | } |
|
|
392 | |
|
|
393 | ############################################################################# |
|
|
394 | |
|
|
395 | =item $handle->timeout ($seconds) |
|
|
396 | |
|
|
397 | Configures (or disables) the inactivity timeout. |
|
|
398 | |
|
|
399 | =cut |
|
|
400 | |
|
|
401 | sub timeout { |
|
|
402 | my ($self, $timeout) = @_; |
|
|
403 | |
|
|
404 | $self->{timeout} = $timeout; |
|
|
405 | $self->_timeout; |
|
|
406 | } |
|
|
407 | |
|
|
408 | # reset the timeout watcher, as neccessary |
|
|
409 | # also check for time-outs |
|
|
410 | sub _timeout { |
|
|
411 | my ($self) = @_; |
|
|
412 | |
|
|
413 | if ($self->{timeout}) { |
|
|
414 | my $NOW = AnyEvent->now; |
|
|
415 | |
|
|
416 | # when would the timeout trigger? |
|
|
417 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
|
|
418 | |
|
|
419 | # now or in the past already? |
|
|
420 | if ($after <= 0) { |
|
|
421 | $self->{_activity} = $NOW; |
|
|
422 | |
|
|
423 | if ($self->{on_timeout}) { |
|
|
424 | $self->{on_timeout}($self); |
|
|
425 | } else { |
|
|
426 | $self->_error (&Errno::ETIMEDOUT); |
|
|
427 | } |
|
|
428 | |
|
|
429 | # callback could have changed timeout value, optimise |
|
|
430 | return unless $self->{timeout}; |
|
|
431 | |
|
|
432 | # calculate new after |
|
|
433 | $after = $self->{timeout}; |
|
|
434 | } |
|
|
435 | |
|
|
436 | Scalar::Util::weaken $self; |
|
|
437 | return unless $self; # ->error could have destroyed $self |
|
|
438 | |
|
|
439 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
|
|
440 | delete $self->{_tw}; |
|
|
441 | $self->_timeout; |
|
|
442 | }); |
|
|
443 | } else { |
|
|
444 | delete $self->{_tw}; |
|
|
445 | } |
255 | } |
446 | } |
256 | |
447 | |
257 | ############################################################################# |
448 | ############################################################################# |
258 | |
449 | |
259 | =back |
450 | =back |
… | |
… | |
306 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
497 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
307 | |
498 | |
308 | if ($len >= 0) { |
499 | if ($len >= 0) { |
309 | substr $self->{wbuf}, 0, $len, ""; |
500 | substr $self->{wbuf}, 0, $len, ""; |
310 | |
501 | |
|
|
502 | $self->{_activity} = AnyEvent->now; |
|
|
503 | |
311 | $self->{on_drain}($self) |
504 | $self->{on_drain}($self) |
312 | if $self->{low_water_mark} >= length $self->{wbuf} |
505 | if $self->{low_water_mark} >= length $self->{wbuf} |
313 | && $self->{on_drain}; |
506 | && $self->{on_drain}; |
314 | |
507 | |
315 | delete $self->{_ww} unless length $self->{wbuf}; |
508 | delete $self->{_ww} unless length $self->{wbuf}; |
316 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) { |
509 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
317 | $self->error; |
510 | $self->_error ($!, 1); |
318 | } |
511 | } |
319 | }; |
512 | }; |
320 | |
513 | |
321 | # try to write data immediately |
514 | # try to write data immediately |
322 | $cb->(); |
515 | $cb->() unless $self->{autocork}; |
323 | |
516 | |
324 | # if still data left in wbuf, we need to poll |
517 | # if still data left in wbuf, we need to poll |
325 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
518 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
326 | if length $self->{wbuf}; |
519 | if length $self->{wbuf}; |
327 | }; |
520 | }; |
… | |
… | |
342 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
535 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
343 | ->($self, @_); |
536 | ->($self, @_); |
344 | } |
537 | } |
345 | |
538 | |
346 | if ($self->{filter_w}) { |
539 | if ($self->{filter_w}) { |
347 | $self->{filter_w}->($self, \$_[0]); |
540 | $self->{filter_w}($self, \$_[0]); |
348 | } else { |
541 | } else { |
349 | $self->{wbuf} .= $_[0]; |
542 | $self->{wbuf} .= $_[0]; |
350 | $self->_drain_wbuf; |
543 | $self->_drain_wbuf; |
351 | } |
544 | } |
352 | } |
545 | } |
353 | |
546 | |
354 | =item $handle->push_write (type => @args) |
547 | =item $handle->push_write (type => @args) |
355 | |
548 | |
356 | =item $handle->unshift_write (type => @args) |
|
|
357 | |
|
|
358 | Instead of formatting your data yourself, you can also let this module do |
549 | Instead of formatting your data yourself, you can also let this module do |
359 | the job by specifying a type and type-specific arguments. |
550 | the job by specifying a type and type-specific arguments. |
360 | |
551 | |
361 | Predefined types are (if you have ideas for additional types, feel free to |
552 | Predefined types are (if you have ideas for additional types, feel free to |
362 | drop by and tell us): |
553 | drop by and tell us): |
… | |
… | |
366 | =item netstring => $string |
557 | =item netstring => $string |
367 | |
558 | |
368 | Formats the given value as netstring |
559 | Formats the given value as netstring |
369 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
560 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
370 | |
561 | |
371 | =back |
|
|
372 | |
|
|
373 | =cut |
562 | =cut |
374 | |
563 | |
375 | register_write_type netstring => sub { |
564 | register_write_type netstring => sub { |
376 | my ($self, $string) = @_; |
565 | my ($self, $string) = @_; |
377 | |
566 | |
378 | sprintf "%d:%s,", (length $string), $string |
567 | sprintf "%d:%s,", (length $string), $string |
379 | }; |
568 | }; |
380 | |
569 | |
|
|
570 | =item packstring => $format, $data |
|
|
571 | |
|
|
572 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
573 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
574 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
575 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
576 | |
|
|
577 | =cut |
|
|
578 | |
|
|
579 | register_write_type packstring => sub { |
|
|
580 | my ($self, $format, $string) = @_; |
|
|
581 | |
|
|
582 | pack "$format/a*", $string |
|
|
583 | }; |
|
|
584 | |
381 | =item json => $array_or_hashref |
585 | =item json => $array_or_hashref |
382 | |
586 | |
|
|
587 | Encodes the given hash or array reference into a JSON object. Unless you |
|
|
588 | provide your own JSON object, this means it will be encoded to JSON text |
|
|
589 | in UTF-8. |
|
|
590 | |
|
|
591 | JSON objects (and arrays) are self-delimiting, so you can write JSON at |
|
|
592 | one end of a handle and read them at the other end without using any |
|
|
593 | additional framing. |
|
|
594 | |
|
|
595 | The generated JSON text is guaranteed not to contain any newlines: While |
|
|
596 | this module doesn't need delimiters after or between JSON texts to be |
|
|
597 | able to read them, many other languages depend on that. |
|
|
598 | |
|
|
599 | A simple RPC protocol that interoperates easily with others is to send |
|
|
600 | JSON arrays (or objects, although arrays are usually the better choice as |
|
|
601 | they mimic how function argument passing works) and a newline after each |
|
|
602 | JSON text: |
|
|
603 | |
|
|
604 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
|
|
605 | $handle->push_write ("\012"); |
|
|
606 | |
|
|
607 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
|
|
608 | rely on the fact that the newline will be skipped as leading whitespace: |
|
|
609 | |
|
|
610 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
|
|
611 | |
|
|
612 | Other languages could read single lines terminated by a newline and pass |
|
|
613 | this line into their JSON decoder of choice. |
|
|
614 | |
|
|
615 | =cut |
|
|
616 | |
|
|
617 | register_write_type json => sub { |
|
|
618 | my ($self, $ref) = @_; |
|
|
619 | |
|
|
620 | require JSON; |
|
|
621 | |
|
|
622 | $self->{json} ? $self->{json}->encode ($ref) |
|
|
623 | : JSON::encode_json ($ref) |
|
|
624 | }; |
|
|
625 | |
|
|
626 | =item storable => $reference |
|
|
627 | |
|
|
628 | Freezes the given reference using L<Storable> and writes it to the |
|
|
629 | handle. Uses the C<nfreeze> format. |
|
|
630 | |
|
|
631 | =cut |
|
|
632 | |
|
|
633 | register_write_type storable => sub { |
|
|
634 | my ($self, $ref) = @_; |
|
|
635 | |
|
|
636 | require Storable; |
|
|
637 | |
|
|
638 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
639 | }; |
|
|
640 | |
|
|
641 | =back |
|
|
642 | |
383 | =item AnyEvent::Handle::register_write_type type => $coderef->($self, @args) |
643 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
384 | |
644 | |
385 | This function (not method) lets you add your own types to C<push_write>. |
645 | This function (not method) lets you add your own types to C<push_write>. |
386 | Whenever the given C<type> is used, C<push_write> will invoke the code |
646 | Whenever the given C<type> is used, C<push_write> will invoke the code |
387 | reference with the handle object and the remaining arguments. |
647 | reference with the handle object and the remaining arguments. |
388 | |
648 | |
… | |
… | |
407 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
667 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
408 | a queue. |
668 | a queue. |
409 | |
669 | |
410 | In the simple case, you just install an C<on_read> callback and whenever |
670 | In the simple case, you just install an C<on_read> callback and whenever |
411 | new data arrives, it will be called. You can then remove some data (if |
671 | new data arrives, it will be called. You can then remove some data (if |
412 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
672 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
413 | or not. |
673 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
674 | partial message has been received so far). |
414 | |
675 | |
415 | In the more complex case, you want to queue multiple callbacks. In this |
676 | In the more complex case, you want to queue multiple callbacks. In this |
416 | case, AnyEvent::Handle will call the first queued callback each time new |
677 | case, AnyEvent::Handle will call the first queued callback each time new |
417 | data arrives and removes it when it has done its job (see C<push_read>, |
678 | data arrives (also the first time it is queued) and removes it when it has |
418 | below). |
679 | done its job (see C<push_read>, below). |
419 | |
680 | |
420 | This way you can, for example, push three line-reads, followed by reading |
681 | This way you can, for example, push three line-reads, followed by reading |
421 | a chunk of data, and AnyEvent::Handle will execute them in order. |
682 | a chunk of data, and AnyEvent::Handle will execute them in order. |
422 | |
683 | |
423 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
684 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
424 | the specified number of bytes which give an XML datagram. |
685 | the specified number of bytes which give an XML datagram. |
425 | |
686 | |
426 | # in the default state, expect some header bytes |
687 | # in the default state, expect some header bytes |
427 | $handle->on_read (sub { |
688 | $handle->on_read (sub { |
428 | # some data is here, now queue the length-header-read (4 octets) |
689 | # some data is here, now queue the length-header-read (4 octets) |
429 | shift->unshift_read_chunk (4, sub { |
690 | shift->unshift_read (chunk => 4, sub { |
430 | # header arrived, decode |
691 | # header arrived, decode |
431 | my $len = unpack "N", $_[1]; |
692 | my $len = unpack "N", $_[1]; |
432 | |
693 | |
433 | # now read the payload |
694 | # now read the payload |
434 | shift->unshift_read_chunk ($len, sub { |
695 | shift->unshift_read (chunk => $len, sub { |
435 | my $xml = $_[1]; |
696 | my $xml = $_[1]; |
436 | # handle xml |
697 | # handle xml |
437 | }); |
698 | }); |
438 | }); |
699 | }); |
439 | }); |
700 | }); |
440 | |
701 | |
441 | Example 2: Implement a client for a protocol that replies either with |
702 | Example 2: Implement a client for a protocol that replies either with "OK" |
442 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
703 | and another line or "ERROR" for the first request that is sent, and 64 |
443 | second request. Due tot he availability of a full queue, we can just |
704 | bytes for the second request. Due to the availability of a queue, we can |
444 | pipeline sending both requests and manipulate the queue as necessary in |
705 | just pipeline sending both requests and manipulate the queue as necessary |
445 | the callbacks: |
706 | in the callbacks. |
446 | |
707 | |
447 | # request one |
708 | When the first callback is called and sees an "OK" response, it will |
|
|
709 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
710 | 64-byte chunk callback. |
|
|
711 | |
|
|
712 | # request one, returns either "OK + extra line" or "ERROR" |
448 | $handle->push_write ("request 1\015\012"); |
713 | $handle->push_write ("request 1\015\012"); |
449 | |
714 | |
450 | # we expect "ERROR" or "OK" as response, so push a line read |
715 | # we expect "ERROR" or "OK" as response, so push a line read |
451 | $handle->push_read_line (sub { |
716 | $handle->push_read (line => sub { |
452 | # if we got an "OK", we have to _prepend_ another line, |
717 | # if we got an "OK", we have to _prepend_ another line, |
453 | # so it will be read before the second request reads its 64 bytes |
718 | # so it will be read before the second request reads its 64 bytes |
454 | # which are already in the queue when this callback is called |
719 | # which are already in the queue when this callback is called |
455 | # we don't do this in case we got an error |
720 | # we don't do this in case we got an error |
456 | if ($_[1] eq "OK") { |
721 | if ($_[1] eq "OK") { |
457 | $_[0]->unshift_read_line (sub { |
722 | $_[0]->unshift_read (line => sub { |
458 | my $response = $_[1]; |
723 | my $response = $_[1]; |
459 | ... |
724 | ... |
460 | }); |
725 | }); |
461 | } |
726 | } |
462 | }); |
727 | }); |
463 | |
728 | |
464 | # request two |
729 | # request two, simply returns 64 octets |
465 | $handle->push_write ("request 2\015\012"); |
730 | $handle->push_write ("request 2\015\012"); |
466 | |
731 | |
467 | # simply read 64 bytes, always |
732 | # simply read 64 bytes, always |
468 | $handle->push_read_chunk (64, sub { |
733 | $handle->push_read (chunk => 64, sub { |
469 | my $response = $_[1]; |
734 | my $response = $_[1]; |
470 | ... |
735 | ... |
471 | }); |
736 | }); |
472 | |
737 | |
473 | =over 4 |
738 | =over 4 |
474 | |
739 | |
475 | =cut |
740 | =cut |
476 | |
741 | |
477 | sub _drain_rbuf { |
742 | sub _drain_rbuf { |
478 | my ($self) = @_; |
743 | my ($self) = @_; |
|
|
744 | |
|
|
745 | local $self->{_in_drain} = 1; |
479 | |
746 | |
480 | if ( |
747 | if ( |
481 | defined $self->{rbuf_max} |
748 | defined $self->{rbuf_max} |
482 | && $self->{rbuf_max} < length $self->{rbuf} |
749 | && $self->{rbuf_max} < length $self->{rbuf} |
483 | ) { |
750 | ) { |
484 | $! = &Errno::ENOSPC; |
751 | $self->_error (&Errno::ENOSPC, 1), return; |
485 | $self->error; |
|
|
486 | } |
752 | } |
487 | |
753 | |
488 | return if $self->{in_drain}; |
754 | while () { |
489 | local $self->{in_drain} = 1; |
|
|
490 | |
|
|
491 | while (my $len = length $self->{rbuf}) { |
755 | my $len = length $self->{rbuf}; |
492 | no strict 'refs'; |
756 | |
493 | if (my $cb = shift @{ $self->{_queue} }) { |
757 | if (my $cb = shift @{ $self->{_queue} }) { |
494 | unless ($cb->($self)) { |
758 | unless ($cb->($self)) { |
495 | if ($self->{_eof}) { |
759 | if ($self->{_eof}) { |
496 | # no progress can be made (not enough data and no data forthcoming) |
760 | # no progress can be made (not enough data and no data forthcoming) |
497 | $! = &Errno::EPIPE; |
761 | $self->_error (&Errno::EPIPE, 1), return; |
498 | $self->error; |
|
|
499 | } |
762 | } |
500 | |
763 | |
501 | unshift @{ $self->{_queue} }, $cb; |
764 | unshift @{ $self->{_queue} }, $cb; |
502 | return; |
765 | last; |
503 | } |
766 | } |
504 | } elsif ($self->{on_read}) { |
767 | } elsif ($self->{on_read}) { |
|
|
768 | last unless $len; |
|
|
769 | |
505 | $self->{on_read}($self); |
770 | $self->{on_read}($self); |
506 | |
771 | |
507 | if ( |
772 | if ( |
508 | $self->{_eof} # if no further data will arrive |
|
|
509 | && $len == length $self->{rbuf} # and no data has been consumed |
773 | $len == length $self->{rbuf} # if no data has been consumed |
510 | && !@{ $self->{_queue} } # and the queue is still empty |
774 | && !@{ $self->{_queue} } # and the queue is still empty |
511 | && $self->{on_read} # and we still want to read data |
775 | && $self->{on_read} # but we still have on_read |
512 | ) { |
776 | ) { |
|
|
777 | # no further data will arrive |
513 | # then no progress can be made |
778 | # so no progress can be made |
514 | $! = &Errno::EPIPE; |
779 | $self->_error (&Errno::EPIPE, 1), return |
515 | $self->error; |
780 | if $self->{_eof}; |
|
|
781 | |
|
|
782 | last; # more data might arrive |
516 | } |
783 | } |
517 | } else { |
784 | } else { |
518 | # read side becomes idle |
785 | # read side becomes idle |
519 | delete $self->{_rw}; |
786 | delete $self->{_rw}; |
520 | return; |
787 | last; |
521 | } |
788 | } |
522 | } |
789 | } |
523 | |
790 | |
524 | if ($self->{_eof}) { |
791 | if ($self->{_eof}) { |
525 | $self->_shutdown; |
792 | if ($self->{on_eof}) { |
526 | $self->{on_eof}($self) |
793 | $self->{on_eof}($self) |
527 | if $self->{on_eof}; |
794 | } else { |
|
|
795 | $self->_error (0, 1); |
|
|
796 | } |
|
|
797 | } |
|
|
798 | |
|
|
799 | # may need to restart read watcher |
|
|
800 | unless ($self->{_rw}) { |
|
|
801 | $self->start_read |
|
|
802 | if $self->{on_read} || @{ $self->{_queue} }; |
528 | } |
803 | } |
529 | } |
804 | } |
530 | |
805 | |
531 | =item $handle->on_read ($cb) |
806 | =item $handle->on_read ($cb) |
532 | |
807 | |
… | |
… | |
538 | |
813 | |
539 | sub on_read { |
814 | sub on_read { |
540 | my ($self, $cb) = @_; |
815 | my ($self, $cb) = @_; |
541 | |
816 | |
542 | $self->{on_read} = $cb; |
817 | $self->{on_read} = $cb; |
|
|
818 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
543 | } |
819 | } |
544 | |
820 | |
545 | =item $handle->rbuf |
821 | =item $handle->rbuf |
546 | |
822 | |
547 | Returns the read buffer (as a modifiable lvalue). |
823 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
596 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
872 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
597 | ->($self, $cb, @_); |
873 | ->($self, $cb, @_); |
598 | } |
874 | } |
599 | |
875 | |
600 | push @{ $self->{_queue} }, $cb; |
876 | push @{ $self->{_queue} }, $cb; |
601 | $self->_drain_rbuf; |
877 | $self->_drain_rbuf unless $self->{_in_drain}; |
602 | } |
878 | } |
603 | |
879 | |
604 | sub unshift_read { |
880 | sub unshift_read { |
605 | my $self = shift; |
881 | my $self = shift; |
606 | my $cb = pop; |
882 | my $cb = pop; |
… | |
… | |
612 | ->($self, $cb, @_); |
888 | ->($self, $cb, @_); |
613 | } |
889 | } |
614 | |
890 | |
615 | |
891 | |
616 | unshift @{ $self->{_queue} }, $cb; |
892 | unshift @{ $self->{_queue} }, $cb; |
617 | $self->_drain_rbuf; |
893 | $self->_drain_rbuf unless $self->{_in_drain}; |
618 | } |
894 | } |
619 | |
895 | |
620 | =item $handle->push_read (type => @args, $cb) |
896 | =item $handle->push_read (type => @args, $cb) |
621 | |
897 | |
622 | =item $handle->unshift_read (type => @args, $cb) |
898 | =item $handle->unshift_read (type => @args, $cb) |
… | |
… | |
628 | Predefined types are (if you have ideas for additional types, feel free to |
904 | Predefined types are (if you have ideas for additional types, feel free to |
629 | drop by and tell us): |
905 | drop by and tell us): |
630 | |
906 | |
631 | =over 4 |
907 | =over 4 |
632 | |
908 | |
633 | =item chunk => $octets, $cb->($self, $data) |
909 | =item chunk => $octets, $cb->($handle, $data) |
634 | |
910 | |
635 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
911 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
636 | data read to the callback. The callback will never be called with less |
912 | data read to the callback. The callback will never be called with less |
637 | data. |
913 | data. |
638 | |
914 | |
… | |
… | |
652 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
928 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
653 | 1 |
929 | 1 |
654 | } |
930 | } |
655 | }; |
931 | }; |
656 | |
932 | |
657 | # compatibility with older API |
|
|
658 | sub push_read_chunk { |
|
|
659 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
660 | } |
|
|
661 | |
|
|
662 | sub unshift_read_chunk { |
|
|
663 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
664 | } |
|
|
665 | |
|
|
666 | =item line => [$eol, ]$cb->($self, $line, $eol) |
933 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
667 | |
934 | |
668 | The callback will be called only once a full line (including the end of |
935 | The callback will be called only once a full line (including the end of |
669 | line marker, C<$eol>) has been read. This line (excluding the end of line |
936 | line marker, C<$eol>) has been read. This line (excluding the end of line |
670 | marker) will be passed to the callback as second argument (C<$line>), and |
937 | marker) will be passed to the callback as second argument (C<$line>), and |
671 | the end of line marker as the third argument (C<$eol>). |
938 | the end of line marker as the third argument (C<$eol>). |
… | |
… | |
685 | =cut |
952 | =cut |
686 | |
953 | |
687 | register_read_type line => sub { |
954 | register_read_type line => sub { |
688 | my ($self, $cb, $eol) = @_; |
955 | my ($self, $cb, $eol) = @_; |
689 | |
956 | |
690 | $eol = qr|(\015?\012)| if @_ < 3; |
957 | if (@_ < 3) { |
|
|
958 | # this is more than twice as fast as the generic code below |
|
|
959 | sub { |
|
|
960 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
|
|
961 | |
|
|
962 | $cb->($_[0], $1, $2); |
|
|
963 | 1 |
|
|
964 | } |
|
|
965 | } else { |
691 | $eol = quotemeta $eol unless ref $eol; |
966 | $eol = quotemeta $eol unless ref $eol; |
692 | $eol = qr|^(.*?)($eol)|s; |
967 | $eol = qr|^(.*?)($eol)|s; |
693 | |
968 | |
694 | sub { |
969 | sub { |
695 | $_[0]{rbuf} =~ s/$eol// or return; |
970 | $_[0]{rbuf} =~ s/$eol// or return; |
696 | |
971 | |
697 | $cb->($_[0], $1, $2); |
972 | $cb->($_[0], $1, $2); |
|
|
973 | 1 |
698 | 1 |
974 | } |
699 | } |
975 | } |
700 | }; |
976 | }; |
701 | |
977 | |
702 | # compatibility with older API |
|
|
703 | sub push_read_line { |
|
|
704 | my $self = shift; |
|
|
705 | $self->push_read (line => @_); |
|
|
706 | } |
|
|
707 | |
|
|
708 | sub unshift_read_line { |
|
|
709 | my $self = shift; |
|
|
710 | $self->unshift_read (line => @_); |
|
|
711 | } |
|
|
712 | |
|
|
713 | =item netstring => $cb->($string) |
|
|
714 | |
|
|
715 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
716 | |
|
|
717 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
718 | |
|
|
719 | =cut |
|
|
720 | |
|
|
721 | register_read_type netstring => sub { |
|
|
722 | my ($self, $cb) = @_; |
|
|
723 | |
|
|
724 | sub { |
|
|
725 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
726 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
727 | $! = &Errno::EBADMSG; |
|
|
728 | $self->error; |
|
|
729 | } |
|
|
730 | return; |
|
|
731 | } |
|
|
732 | |
|
|
733 | my $len = $1; |
|
|
734 | |
|
|
735 | $self->unshift_read (chunk => $len, sub { |
|
|
736 | my $string = $_[1]; |
|
|
737 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
738 | if ($_[1] eq ",") { |
|
|
739 | $cb->($_[0], $string); |
|
|
740 | } else { |
|
|
741 | $! = &Errno::EBADMSG; |
|
|
742 | $self->error; |
|
|
743 | } |
|
|
744 | }); |
|
|
745 | }); |
|
|
746 | |
|
|
747 | 1 |
|
|
748 | } |
|
|
749 | }; |
|
|
750 | |
|
|
751 | =item regex => $accept[, $reject[, $skip], $cb->($data) |
978 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
752 | |
979 | |
753 | Makes a regex match against the regex object C<$accept> and returns |
980 | Makes a regex match against the regex object C<$accept> and returns |
754 | everything up to and including the match. |
981 | everything up to and including the match. |
755 | |
982 | |
756 | Example: read a single line terminated by '\n'. |
983 | Example: read a single line terminated by '\n'. |
… | |
… | |
804 | return 1; |
1031 | return 1; |
805 | } |
1032 | } |
806 | |
1033 | |
807 | # reject |
1034 | # reject |
808 | if ($reject && $$rbuf =~ $reject) { |
1035 | if ($reject && $$rbuf =~ $reject) { |
809 | $! = &Errno::EBADMSG; |
1036 | $self->_error (&Errno::EBADMSG); |
810 | $self->error; |
|
|
811 | } |
1037 | } |
812 | |
1038 | |
813 | # skip |
1039 | # skip |
814 | if ($skip && $$rbuf =~ $skip) { |
1040 | if ($skip && $$rbuf =~ $skip) { |
815 | $data .= substr $$rbuf, 0, $+[0], ""; |
1041 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
817 | |
1043 | |
818 | () |
1044 | () |
819 | } |
1045 | } |
820 | }; |
1046 | }; |
821 | |
1047 | |
|
|
1048 | =item netstring => $cb->($handle, $string) |
|
|
1049 | |
|
|
1050 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
1051 | |
|
|
1052 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
1053 | |
|
|
1054 | =cut |
|
|
1055 | |
|
|
1056 | register_read_type netstring => sub { |
|
|
1057 | my ($self, $cb) = @_; |
|
|
1058 | |
|
|
1059 | sub { |
|
|
1060 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
1061 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
1062 | $self->_error (&Errno::EBADMSG); |
|
|
1063 | } |
|
|
1064 | return; |
|
|
1065 | } |
|
|
1066 | |
|
|
1067 | my $len = $1; |
|
|
1068 | |
|
|
1069 | $self->unshift_read (chunk => $len, sub { |
|
|
1070 | my $string = $_[1]; |
|
|
1071 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
1072 | if ($_[1] eq ",") { |
|
|
1073 | $cb->($_[0], $string); |
|
|
1074 | } else { |
|
|
1075 | $self->_error (&Errno::EBADMSG); |
|
|
1076 | } |
|
|
1077 | }); |
|
|
1078 | }); |
|
|
1079 | |
|
|
1080 | 1 |
|
|
1081 | } |
|
|
1082 | }; |
|
|
1083 | |
|
|
1084 | =item packstring => $format, $cb->($handle, $string) |
|
|
1085 | |
|
|
1086 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1087 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1088 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1089 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1090 | |
|
|
1091 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
1092 | |
|
|
1093 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1094 | format (very efficient). |
|
|
1095 | |
|
|
1096 | $handle->push_read (packstring => "w", sub { |
|
|
1097 | my ($handle, $data) = @_; |
|
|
1098 | }); |
|
|
1099 | |
|
|
1100 | =cut |
|
|
1101 | |
|
|
1102 | register_read_type packstring => sub { |
|
|
1103 | my ($self, $cb, $format) = @_; |
|
|
1104 | |
|
|
1105 | sub { |
|
|
1106 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1107 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
|
|
1108 | or return; |
|
|
1109 | |
|
|
1110 | $format = length pack $format, $len; |
|
|
1111 | |
|
|
1112 | # bypass unshift if we already have the remaining chunk |
|
|
1113 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1114 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1115 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1116 | $cb->($_[0], $data); |
|
|
1117 | } else { |
|
|
1118 | # remove prefix |
|
|
1119 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1120 | |
|
|
1121 | # read remaining chunk |
|
|
1122 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1123 | } |
|
|
1124 | |
|
|
1125 | 1 |
|
|
1126 | } |
|
|
1127 | }; |
|
|
1128 | |
|
|
1129 | =item json => $cb->($handle, $hash_or_arrayref) |
|
|
1130 | |
|
|
1131 | Reads a JSON object or array, decodes it and passes it to the callback. |
|
|
1132 | |
|
|
1133 | If a C<json> object was passed to the constructor, then that will be used |
|
|
1134 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
|
|
1135 | |
|
|
1136 | This read type uses the incremental parser available with JSON version |
|
|
1137 | 2.09 (and JSON::XS version 2.2) and above. You have to provide a |
|
|
1138 | dependency on your own: this module will load the JSON module, but |
|
|
1139 | AnyEvent does not depend on it itself. |
|
|
1140 | |
|
|
1141 | Since JSON texts are fully self-delimiting, the C<json> read and write |
|
|
1142 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
|
|
1143 | the C<json> write type description, above, for an actual example. |
|
|
1144 | |
|
|
1145 | =cut |
|
|
1146 | |
|
|
1147 | register_read_type json => sub { |
|
|
1148 | my ($self, $cb) = @_; |
|
|
1149 | |
|
|
1150 | require JSON; |
|
|
1151 | |
|
|
1152 | my $data; |
|
|
1153 | my $rbuf = \$self->{rbuf}; |
|
|
1154 | |
|
|
1155 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
1156 | |
|
|
1157 | sub { |
|
|
1158 | my $ref = $json->incr_parse ($self->{rbuf}); |
|
|
1159 | |
|
|
1160 | if ($ref) { |
|
|
1161 | $self->{rbuf} = $json->incr_text; |
|
|
1162 | $json->incr_text = ""; |
|
|
1163 | $cb->($self, $ref); |
|
|
1164 | |
|
|
1165 | 1 |
|
|
1166 | } else { |
|
|
1167 | $self->{rbuf} = ""; |
|
|
1168 | () |
|
|
1169 | } |
|
|
1170 | } |
|
|
1171 | }; |
|
|
1172 | |
|
|
1173 | =item storable => $cb->($handle, $ref) |
|
|
1174 | |
|
|
1175 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1176 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1177 | data). |
|
|
1178 | |
|
|
1179 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1180 | |
|
|
1181 | =cut |
|
|
1182 | |
|
|
1183 | register_read_type storable => sub { |
|
|
1184 | my ($self, $cb) = @_; |
|
|
1185 | |
|
|
1186 | require Storable; |
|
|
1187 | |
|
|
1188 | sub { |
|
|
1189 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1190 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1191 | or return; |
|
|
1192 | |
|
|
1193 | my $format = length pack "w", $len; |
|
|
1194 | |
|
|
1195 | # bypass unshift if we already have the remaining chunk |
|
|
1196 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1197 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1198 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1199 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1200 | } else { |
|
|
1201 | # remove prefix |
|
|
1202 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1203 | |
|
|
1204 | # read remaining chunk |
|
|
1205 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1206 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1207 | $cb->($_[0], $ref); |
|
|
1208 | } else { |
|
|
1209 | $self->_error (&Errno::EBADMSG); |
|
|
1210 | } |
|
|
1211 | }); |
|
|
1212 | } |
|
|
1213 | |
|
|
1214 | 1 |
|
|
1215 | } |
|
|
1216 | }; |
|
|
1217 | |
822 | =back |
1218 | =back |
823 | |
1219 | |
824 | =item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args) |
1220 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
825 | |
1221 | |
826 | This function (not method) lets you add your own types to C<push_read>. |
1222 | This function (not method) lets you add your own types to C<push_read>. |
827 | |
1223 | |
828 | Whenever the given C<type> is used, C<push_read> will invoke the code |
1224 | Whenever the given C<type> is used, C<push_read> will invoke the code |
829 | reference with the handle object, the callback and the remaining |
1225 | reference with the handle object, the callback and the remaining |
… | |
… | |
831 | |
1227 | |
832 | The code reference is supposed to return a callback (usually a closure) |
1228 | The code reference is supposed to return a callback (usually a closure) |
833 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
1229 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
834 | |
1230 | |
835 | It should invoke the passed callback when it is done reading (remember to |
1231 | It should invoke the passed callback when it is done reading (remember to |
836 | pass C<$self> as first argument as all other callbacks do that). |
1232 | pass C<$handle> as first argument as all other callbacks do that). |
837 | |
1233 | |
838 | Note that this is a function, and all types registered this way will be |
1234 | Note that this is a function, and all types registered this way will be |
839 | global, so try to use unique names. |
1235 | global, so try to use unique names. |
840 | |
1236 | |
841 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
1237 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
… | |
… | |
844 | =item $handle->stop_read |
1240 | =item $handle->stop_read |
845 | |
1241 | |
846 | =item $handle->start_read |
1242 | =item $handle->start_read |
847 | |
1243 | |
848 | In rare cases you actually do not want to read anything from the |
1244 | In rare cases you actually do not want to read anything from the |
849 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
1245 | socket. In this case you can call C<stop_read>. Neither C<on_read> nor |
850 | any queued callbacks will be executed then. To start reading again, call |
1246 | any queued callbacks will be executed then. To start reading again, call |
851 | C<start_read>. |
1247 | C<start_read>. |
|
|
1248 | |
|
|
1249 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
|
|
1250 | you change the C<on_read> callback or push/unshift a read callback, and it |
|
|
1251 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
|
|
1252 | there are any read requests in the queue. |
852 | |
1253 | |
853 | =cut |
1254 | =cut |
854 | |
1255 | |
855 | sub stop_read { |
1256 | sub stop_read { |
856 | my ($self) = @_; |
1257 | my ($self) = @_; |
… | |
… | |
867 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1268 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
868 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1269 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
869 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1270 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
870 | |
1271 | |
871 | if ($len > 0) { |
1272 | if ($len > 0) { |
|
|
1273 | $self->{_activity} = AnyEvent->now; |
|
|
1274 | |
872 | $self->{filter_r} |
1275 | $self->{filter_r} |
873 | ? $self->{filter_r}->($self, $rbuf) |
1276 | ? $self->{filter_r}($self, $rbuf) |
874 | : $self->_drain_rbuf; |
1277 | : $self->{_in_drain} || $self->_drain_rbuf; |
875 | |
1278 | |
876 | } elsif (defined $len) { |
1279 | } elsif (defined $len) { |
877 | delete $self->{_rw}; |
1280 | delete $self->{_rw}; |
878 | $self->{_eof} = 1; |
1281 | $self->{_eof} = 1; |
879 | $self->_drain_rbuf; |
1282 | $self->_drain_rbuf unless $self->{_in_drain}; |
880 | |
1283 | |
881 | } elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) { |
1284 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
882 | return $self->error; |
1285 | return $self->_error ($!, 1); |
883 | } |
1286 | } |
884 | }); |
1287 | }); |
885 | } |
1288 | } |
886 | } |
1289 | } |
887 | |
1290 | |
888 | sub _dotls { |
1291 | sub _dotls { |
889 | my ($self) = @_; |
1292 | my ($self) = @_; |
|
|
1293 | |
|
|
1294 | my $buf; |
890 | |
1295 | |
891 | if (length $self->{_tls_wbuf}) { |
1296 | if (length $self->{_tls_wbuf}) { |
892 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1297 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
893 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1298 | substr $self->{_tls_wbuf}, 0, $len, ""; |
894 | } |
1299 | } |
895 | } |
1300 | } |
896 | |
1301 | |
897 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1302 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
898 | $self->{wbuf} .= $buf; |
1303 | $self->{wbuf} .= $buf; |
899 | $self->_drain_wbuf; |
1304 | $self->_drain_wbuf; |
900 | } |
1305 | } |
901 | |
1306 | |
902 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
1307 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
1308 | if (length $buf) { |
903 | $self->{rbuf} .= $buf; |
1309 | $self->{rbuf} .= $buf; |
904 | $self->_drain_rbuf; |
1310 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1311 | } else { |
|
|
1312 | # let's treat SSL-eof as we treat normal EOF |
|
|
1313 | $self->{_eof} = 1; |
|
|
1314 | $self->_shutdown; |
|
|
1315 | return; |
|
|
1316 | } |
905 | } |
1317 | } |
906 | |
1318 | |
907 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1319 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
908 | |
1320 | |
909 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1321 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
910 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1322 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
911 | $self->error; |
1323 | return $self->_error ($!, 1); |
912 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1324 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
913 | $! = &Errno::EIO; |
1325 | return $self->_error (&Errno::EIO, 1); |
914 | $self->error; |
|
|
915 | } |
1326 | } |
916 | |
1327 | |
917 | # all others are fine for our purposes |
1328 | # all others are fine for our purposes |
918 | } |
1329 | } |
919 | } |
1330 | } |
… | |
… | |
934 | call and can be used or changed to your liking. Note that the handshake |
1345 | call and can be used or changed to your liking. Note that the handshake |
935 | might have already started when this function returns. |
1346 | might have already started when this function returns. |
936 | |
1347 | |
937 | =cut |
1348 | =cut |
938 | |
1349 | |
939 | # TODO: maybe document... |
|
|
940 | sub starttls { |
1350 | sub starttls { |
941 | my ($self, $ssl, $ctx) = @_; |
1351 | my ($self, $ssl, $ctx) = @_; |
942 | |
1352 | |
943 | $self->stoptls; |
1353 | $self->stoptls; |
944 | |
1354 | |
… | |
… | |
997 | |
1407 | |
998 | sub DESTROY { |
1408 | sub DESTROY { |
999 | my $self = shift; |
1409 | my $self = shift; |
1000 | |
1410 | |
1001 | $self->stoptls; |
1411 | $self->stoptls; |
|
|
1412 | |
|
|
1413 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1414 | |
|
|
1415 | if ($linger && length $self->{wbuf}) { |
|
|
1416 | my $fh = delete $self->{fh}; |
|
|
1417 | my $wbuf = delete $self->{wbuf}; |
|
|
1418 | |
|
|
1419 | my @linger; |
|
|
1420 | |
|
|
1421 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1422 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1423 | |
|
|
1424 | if ($len > 0) { |
|
|
1425 | substr $wbuf, 0, $len, ""; |
|
|
1426 | } else { |
|
|
1427 | @linger = (); # end |
|
|
1428 | } |
|
|
1429 | }); |
|
|
1430 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1431 | @linger = (); |
|
|
1432 | }); |
|
|
1433 | } |
1002 | } |
1434 | } |
1003 | |
1435 | |
1004 | =item AnyEvent::Handle::TLS_CTX |
1436 | =item AnyEvent::Handle::TLS_CTX |
1005 | |
1437 | |
1006 | This function creates and returns the Net::SSLeay::CTX object used by |
1438 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
1048 | =over 4 |
1480 | =over 4 |
1049 | |
1481 | |
1050 | =item * all constructor arguments become object members. |
1482 | =item * all constructor arguments become object members. |
1051 | |
1483 | |
1052 | At least initially, when you pass a C<tls>-argument to the constructor it |
1484 | At least initially, when you pass a C<tls>-argument to the constructor it |
1053 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1485 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1054 | mutated later on (for example C<tls> will hold the TLS connection object). |
1486 | mutated later on (for example C<tls> will hold the TLS connection object). |
1055 | |
1487 | |
1056 | =item * other object member names are prefixed with an C<_>. |
1488 | =item * other object member names are prefixed with an C<_>. |
1057 | |
1489 | |
1058 | All object members not explicitly documented (internal use) are prefixed |
1490 | All object members not explicitly documented (internal use) are prefixed |