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 (); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
10 | use Fcntl (); |
10 | use Fcntl (); |
11 | use Errno qw/EAGAIN EINTR/; |
11 | use Errno qw(EAGAIN EINTR); |
12 | |
12 | |
13 | =head1 NAME |
13 | =head1 NAME |
14 | |
14 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
16 | |
17 | This module is experimental. |
|
|
18 | |
|
|
19 | =cut |
17 | =cut |
20 | |
18 | |
21 | our $VERSION = '0.04'; |
19 | our $VERSION = 4.232; |
22 | |
20 | |
23 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
24 | |
22 | |
25 | use AnyEvent; |
23 | use AnyEvent; |
26 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
27 | |
25 | |
28 | my $cv = AnyEvent->condvar; |
26 | my $cv = AnyEvent->condvar; |
29 | |
27 | |
30 | my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN); |
28 | my $handle = |
31 | |
|
|
32 | #TODO |
|
|
33 | |
|
|
34 | # or use the constructor to pass the callback: |
|
|
35 | |
|
|
36 | my $ae_fh2 = |
|
|
37 | AnyEvent::Handle->new ( |
29 | AnyEvent::Handle->new ( |
38 | fh => \*STDIN, |
30 | fh => \*STDIN, |
39 | on_eof => sub { |
31 | on_eof => sub { |
40 | $cv->broadcast; |
32 | $cv->broadcast; |
41 | }, |
33 | }, |
42 | #TODO |
|
|
43 | ); |
34 | ); |
44 | |
35 | |
45 | $cv->wait; |
36 | # send some request line |
|
|
37 | $handle->push_write ("getinfo\015\012"); |
|
|
38 | |
|
|
39 | # read the response line |
|
|
40 | $handle->push_read (line => sub { |
|
|
41 | my ($handle, $line) = @_; |
|
|
42 | warn "read line <$line>\n"; |
|
|
43 | $cv->send; |
|
|
44 | }); |
|
|
45 | |
|
|
46 | $cv->recv; |
46 | |
47 | |
47 | =head1 DESCRIPTION |
48 | =head1 DESCRIPTION |
48 | |
49 | |
49 | This module is a helper module to make it easier to do event-based I/O on |
50 | This module is a helper module to make it easier to do event-based I/O on |
50 | filehandles. For utility functions for doing non-blocking connects and accepts |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
51 | on sockets see L<AnyEvent::Util>. |
52 | on sockets see L<AnyEvent::Util>. |
52 | |
53 | |
|
|
54 | The L<AnyEvent::Intro> tutorial contains some well-documented |
|
|
55 | AnyEvent::Handle examples. |
|
|
56 | |
53 | 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 |
54 | 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 |
55 | treatment of characters applies to this module as well. |
59 | treatment of characters applies to this module as well. |
56 | |
60 | |
57 | 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 |
… | |
… | |
69 | |
73 | |
70 | =item fh => $filehandle [MANDATORY] |
74 | =item fh => $filehandle [MANDATORY] |
71 | |
75 | |
72 | The filehandle this L<AnyEvent::Handle> object will operate on. |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
73 | |
77 | |
74 | NOTE: The filehandle will be set to non-blocking (using |
78 | NOTE: The filehandle will be set to non-blocking mode (using |
75 | AnyEvent::Util::fh_nonblocking). |
79 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
80 | that mode. |
76 | |
81 | |
77 | =item on_eof => $cb->($self) |
82 | =item on_eof => $cb->($handle) |
78 | |
83 | |
79 | 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. |
80 | |
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 | |
81 | 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, |
82 | 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 |
83 | waiting for data. |
95 | waiting for data. |
84 | |
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 | |
85 | =item on_error => $cb->($self) |
100 | =item on_error => $cb->($handle, $fatal) |
86 | |
101 | |
87 | 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 |
88 | 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 |
89 | or a read error. |
104 | connect or a read error. |
90 | |
105 | |
91 | 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 |
92 | 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>). |
93 | |
116 | |
94 | On callback entrance, the value of C<$!> contains the operating system |
117 | On callback entrance, the value of C<$!> contains the operating system |
95 | error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>). |
118 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
96 | |
119 | |
97 | 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 |
98 | 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 |
99 | die. |
122 | C<croak>. |
100 | |
123 | |
101 | =item on_read => $cb->($self) |
124 | =item on_read => $cb->($handle) |
102 | |
125 | |
103 | 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 |
104 | 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). |
105 | |
130 | |
106 | 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 >> |
107 | method or access the C<$self->{rbuf}> member directly. |
132 | method or access the C<$handle->{rbuf}> member directly. |
108 | |
133 | |
109 | 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 |
110 | 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 |
111 | 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 |
112 | error will be raised (with C<$!> set to C<EPIPE>). |
137 | error will be raised (with C<$!> set to C<EPIPE>). |
113 | |
138 | |
114 | =item on_drain => $cb->() |
139 | =item on_drain => $cb->($handle) |
115 | |
140 | |
116 | 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 |
117 | (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). |
118 | |
143 | |
119 | 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. |
120 | |
171 | |
121 | =item rbuf_max => <bytes> |
172 | =item rbuf_max => <bytes> |
122 | |
173 | |
123 | 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>) |
124 | 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 |
… | |
… | |
128 | 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 |
129 | (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 |
130 | 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 |
131 | isn't finished). |
182 | isn't finished). |
132 | |
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 | |
133 | =item read_size => <bytes> |
208 | =item read_size => <bytes> |
134 | |
209 | |
135 | 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 |
136 | on each [loop iteration). Default: C<4096>. |
211 | during each (loop iteration). Default: C<8192>. |
137 | |
212 | |
138 | =item low_water_mark => <bytes> |
213 | =item low_water_mark => <bytes> |
139 | |
214 | |
140 | 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 |
141 | 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 |
142 | considered empty. |
217 | considered empty. |
143 | |
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 | |
144 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
230 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
145 | |
231 | |
146 | 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 |
147 | will start making tls handshake and will transparently encrypt/decrypt |
233 | AnyEvent will start a TLS handshake and will transparently encrypt/decrypt |
148 | data. |
234 | data. |
149 | |
235 | |
150 | 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 |
151 | automatically when you try to create a TLS handle). |
237 | automatically when you try to create a TLS handle). |
152 | |
238 | |
153 | 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 |
154 | connection, use C<connect> mode. |
240 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
241 | mode. |
155 | |
242 | |
156 | 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 |
157 | 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> |
158 | 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 |
159 | AnyEvent::Handle. |
246 | AnyEvent::Handle. |
160 | |
247 | |
161 | 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. |
162 | |
249 | |
163 | =item tls_ctx => $ssl_ctx |
250 | =item tls_ctx => $ssl_ctx |
164 | |
251 | |
165 | 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 |
166 | (unless a connection object was specified directly). If this parameter is |
253 | (unless a connection object was specified directly). If this parameter is |
167 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
254 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
168 | |
255 | |
|
|
256 | =item json => JSON or JSON::XS object |
|
|
257 | |
|
|
258 | This is the json coder object used by the C<json> read and write types. |
|
|
259 | |
|
|
260 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
261 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
262 | texts. |
|
|
263 | |
|
|
264 | Note that you are responsible to depend on the JSON module if you want to |
|
|
265 | use this functionality, as AnyEvent does not have a dependency itself. |
|
|
266 | |
|
|
267 | =item filter_r => $cb |
|
|
268 | |
|
|
269 | =item filter_w => $cb |
|
|
270 | |
|
|
271 | These exist, but are undocumented at this time. (They are used internally |
|
|
272 | by the TLS code). |
|
|
273 | |
169 | =back |
274 | =back |
170 | |
275 | |
171 | =cut |
276 | =cut |
172 | |
|
|
173 | our (%RH, %WH); |
|
|
174 | |
|
|
175 | sub register_read_type($$) { |
|
|
176 | $RH{$_[0]} = $_[1]; |
|
|
177 | } |
|
|
178 | |
|
|
179 | sub register_write_type($$) { |
|
|
180 | $WH{$_[0]} = $_[1]; |
|
|
181 | } |
|
|
182 | |
277 | |
183 | sub new { |
278 | sub new { |
184 | my $class = shift; |
279 | my $class = shift; |
185 | |
280 | |
186 | my $self = bless { @_ }, $class; |
281 | my $self = bless { @_ }, $class; |
… | |
… | |
192 | if ($self->{tls}) { |
287 | if ($self->{tls}) { |
193 | require Net::SSLeay; |
288 | require Net::SSLeay; |
194 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
289 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
195 | } |
290 | } |
196 | |
291 | |
197 | $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; |
292 | $self->{_activity} = AnyEvent->now; |
198 | $self->on_error (delete $self->{on_error}) if $self->{on_error}; |
293 | $self->_timeout; |
|
|
294 | |
199 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
295 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
200 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
296 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
201 | |
297 | |
202 | $self->start_read; |
298 | $self->start_read |
|
|
299 | if $self->{on_read}; |
203 | |
300 | |
204 | $self |
301 | $self |
205 | } |
302 | } |
206 | |
303 | |
207 | sub _shutdown { |
304 | sub _shutdown { |
208 | my ($self) = @_; |
305 | my ($self) = @_; |
209 | |
306 | |
|
|
307 | delete $self->{_tw}; |
210 | delete $self->{rw}; |
308 | delete $self->{_rw}; |
211 | delete $self->{ww}; |
309 | delete $self->{_ww}; |
212 | delete $self->{fh}; |
310 | delete $self->{fh}; |
213 | } |
|
|
214 | |
311 | |
|
|
312 | $self->stoptls; |
|
|
313 | |
|
|
314 | delete $self->{on_read}; |
|
|
315 | delete $self->{_queue}; |
|
|
316 | } |
|
|
317 | |
215 | sub error { |
318 | sub _error { |
216 | my ($self) = @_; |
319 | my ($self, $errno, $fatal) = @_; |
217 | |
320 | |
218 | { |
|
|
219 | local $!; |
|
|
220 | $self->_shutdown; |
321 | $self->_shutdown |
221 | } |
322 | if $fatal; |
|
|
323 | |
|
|
324 | $! = $errno; |
222 | |
325 | |
223 | if ($self->{on_error}) { |
326 | if ($self->{on_error}) { |
224 | $self->{on_error}($self); |
327 | $self->{on_error}($self, $fatal); |
225 | } else { |
328 | } else { |
226 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
329 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
227 | } |
330 | } |
228 | } |
331 | } |
229 | |
332 | |
230 | =item $fh = $handle->fh |
333 | =item $fh = $handle->fh |
231 | |
334 | |
232 | 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. |
233 | |
336 | |
234 | =cut |
337 | =cut |
235 | |
338 | |
236 | sub fh { $_[0]->{fh} } |
339 | sub fh { $_[0]{fh} } |
237 | |
340 | |
238 | =item $handle->on_error ($cb) |
341 | =item $handle->on_error ($cb) |
239 | |
342 | |
240 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
343 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
241 | |
344 | |
… | |
… | |
251 | |
354 | |
252 | =cut |
355 | =cut |
253 | |
356 | |
254 | sub on_eof { |
357 | sub on_eof { |
255 | $_[0]{on_eof} = $_[1]; |
358 | $_[0]{on_eof} = $_[1]; |
|
|
359 | } |
|
|
360 | |
|
|
361 | =item $handle->on_timeout ($cb) |
|
|
362 | |
|
|
363 | Replace the current C<on_timeout> callback, or disables the callback |
|
|
364 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
|
|
365 | argument. |
|
|
366 | |
|
|
367 | =cut |
|
|
368 | |
|
|
369 | sub on_timeout { |
|
|
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 | }; |
|
|
394 | } |
|
|
395 | |
|
|
396 | ############################################################################# |
|
|
397 | |
|
|
398 | =item $handle->timeout ($seconds) |
|
|
399 | |
|
|
400 | Configures (or disables) the inactivity timeout. |
|
|
401 | |
|
|
402 | =cut |
|
|
403 | |
|
|
404 | sub timeout { |
|
|
405 | my ($self, $timeout) = @_; |
|
|
406 | |
|
|
407 | $self->{timeout} = $timeout; |
|
|
408 | $self->_timeout; |
|
|
409 | } |
|
|
410 | |
|
|
411 | # reset the timeout watcher, as neccessary |
|
|
412 | # also check for time-outs |
|
|
413 | sub _timeout { |
|
|
414 | my ($self) = @_; |
|
|
415 | |
|
|
416 | if ($self->{timeout}) { |
|
|
417 | my $NOW = AnyEvent->now; |
|
|
418 | |
|
|
419 | # when would the timeout trigger? |
|
|
420 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
|
|
421 | |
|
|
422 | # now or in the past already? |
|
|
423 | if ($after <= 0) { |
|
|
424 | $self->{_activity} = $NOW; |
|
|
425 | |
|
|
426 | if ($self->{on_timeout}) { |
|
|
427 | $self->{on_timeout}($self); |
|
|
428 | } else { |
|
|
429 | $self->_error (&Errno::ETIMEDOUT); |
|
|
430 | } |
|
|
431 | |
|
|
432 | # callback could have changed timeout value, optimise |
|
|
433 | return unless $self->{timeout}; |
|
|
434 | |
|
|
435 | # calculate new after |
|
|
436 | $after = $self->{timeout}; |
|
|
437 | } |
|
|
438 | |
|
|
439 | Scalar::Util::weaken $self; |
|
|
440 | return unless $self; # ->error could have destroyed $self |
|
|
441 | |
|
|
442 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
|
|
443 | delete $self->{_tw}; |
|
|
444 | $self->_timeout; |
|
|
445 | }); |
|
|
446 | } else { |
|
|
447 | delete $self->{_tw}; |
|
|
448 | } |
256 | } |
449 | } |
257 | |
450 | |
258 | ############################################################################# |
451 | ############################################################################# |
259 | |
452 | |
260 | =back |
453 | =back |
… | |
… | |
297 | =cut |
490 | =cut |
298 | |
491 | |
299 | sub _drain_wbuf { |
492 | sub _drain_wbuf { |
300 | my ($self) = @_; |
493 | my ($self) = @_; |
301 | |
494 | |
302 | if (!$self->{ww} && length $self->{wbuf}) { |
495 | if (!$self->{_ww} && length $self->{wbuf}) { |
|
|
496 | |
303 | Scalar::Util::weaken $self; |
497 | Scalar::Util::weaken $self; |
|
|
498 | |
304 | my $cb = sub { |
499 | my $cb = sub { |
305 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
500 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
306 | |
501 | |
307 | if ($len >= 0) { |
502 | if ($len >= 0) { |
308 | substr $self->{wbuf}, 0, $len, ""; |
503 | substr $self->{wbuf}, 0, $len, ""; |
|
|
504 | |
|
|
505 | $self->{_activity} = AnyEvent->now; |
309 | |
506 | |
310 | $self->{on_drain}($self) |
507 | $self->{on_drain}($self) |
311 | if $self->{low_water_mark} >= length $self->{wbuf} |
508 | if $self->{low_water_mark} >= length $self->{wbuf} |
312 | && $self->{on_drain}; |
509 | && $self->{on_drain}; |
313 | |
510 | |
314 | delete $self->{ww} unless length $self->{wbuf}; |
511 | delete $self->{_ww} unless length $self->{wbuf}; |
315 | } elsif ($! != EAGAIN && $! != EINTR) { |
512 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
316 | $self->error; |
513 | $self->_error ($!, 1); |
317 | } |
514 | } |
318 | }; |
515 | }; |
319 | |
516 | |
|
|
517 | # try to write data immediately |
|
|
518 | $cb->() unless $self->{autocork}; |
|
|
519 | |
|
|
520 | # if still data left in wbuf, we need to poll |
320 | $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb); |
521 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
321 | |
522 | if length $self->{wbuf}; |
322 | $cb->($self); |
|
|
323 | }; |
523 | }; |
|
|
524 | } |
|
|
525 | |
|
|
526 | our %WH; |
|
|
527 | |
|
|
528 | sub register_write_type($$) { |
|
|
529 | $WH{$_[0]} = $_[1]; |
324 | } |
530 | } |
325 | |
531 | |
326 | sub push_write { |
532 | sub push_write { |
327 | my $self = shift; |
533 | my $self = shift; |
328 | |
534 | |
… | |
… | |
332 | @_ = ($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") |
333 | ->($self, @_); |
539 | ->($self, @_); |
334 | } |
540 | } |
335 | |
541 | |
336 | if ($self->{filter_w}) { |
542 | if ($self->{filter_w}) { |
337 | $self->{filter_w}->($self, \$_[0]); |
543 | $self->{filter_w}($self, \$_[0]); |
338 | } else { |
544 | } else { |
339 | $self->{wbuf} .= $_[0]; |
545 | $self->{wbuf} .= $_[0]; |
340 | $self->_drain_wbuf; |
546 | $self->_drain_wbuf; |
341 | } |
547 | } |
342 | } |
548 | } |
343 | |
549 | |
344 | =item $handle->push_write (type => @args) |
550 | =item $handle->push_write (type => @args) |
345 | |
551 | |
346 | =item $handle->unshift_write (type => @args) |
|
|
347 | |
|
|
348 | 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 |
349 | the job by specifying a type and type-specific arguments. |
553 | the job by specifying a type and type-specific arguments. |
350 | |
554 | |
351 | Predefined types are: |
555 | Predefined types are (if you have ideas for additional types, feel free to |
|
|
556 | drop by and tell us): |
352 | |
557 | |
353 | =over 4 |
558 | =over 4 |
354 | |
559 | |
355 | =item netstring => $string |
560 | =item netstring => $string |
356 | |
561 | |
… | |
… | |
363 | my ($self, $string) = @_; |
568 | my ($self, $string) = @_; |
364 | |
569 | |
365 | sprintf "%d:%s,", (length $string), $string |
570 | sprintf "%d:%s,", (length $string), $string |
366 | }; |
571 | }; |
367 | |
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 |
|
|
586 | }; |
|
|
587 | |
|
|
588 | =item json => $array_or_hashref |
|
|
589 | |
|
|
590 | Encodes the given hash or array reference into a JSON object. Unless you |
|
|
591 | provide your own JSON object, this means it will be encoded to JSON text |
|
|
592 | in UTF-8. |
|
|
593 | |
|
|
594 | JSON objects (and arrays) are self-delimiting, so you can write JSON at |
|
|
595 | one end of a handle and read them at the other end without using any |
|
|
596 | additional framing. |
|
|
597 | |
|
|
598 | The generated JSON text is guaranteed not to contain any newlines: While |
|
|
599 | this module doesn't need delimiters after or between JSON texts to be |
|
|
600 | able to read them, many other languages depend on that. |
|
|
601 | |
|
|
602 | A simple RPC protocol that interoperates easily with others is to send |
|
|
603 | JSON arrays (or objects, although arrays are usually the better choice as |
|
|
604 | they mimic how function argument passing works) and a newline after each |
|
|
605 | JSON text: |
|
|
606 | |
|
|
607 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
|
|
608 | $handle->push_write ("\012"); |
|
|
609 | |
|
|
610 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
|
|
611 | rely on the fact that the newline will be skipped as leading whitespace: |
|
|
612 | |
|
|
613 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
|
|
614 | |
|
|
615 | Other languages could read single lines terminated by a newline and pass |
|
|
616 | this line into their JSON decoder of choice. |
|
|
617 | |
|
|
618 | =cut |
|
|
619 | |
|
|
620 | register_write_type json => sub { |
|
|
621 | my ($self, $ref) = @_; |
|
|
622 | |
|
|
623 | require JSON; |
|
|
624 | |
|
|
625 | $self->{json} ? $self->{json}->encode ($ref) |
|
|
626 | : JSON::encode_json ($ref) |
|
|
627 | }; |
|
|
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 | |
368 | =back |
644 | =back |
369 | |
645 | |
370 | =cut |
646 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
371 | |
647 | |
|
|
648 | This function (not method) lets you add your own types to C<push_write>. |
|
|
649 | Whenever the given C<type> is used, C<push_write> will invoke the code |
|
|
650 | reference with the handle object and the remaining arguments. |
372 | |
651 | |
|
|
652 | The code reference is supposed to return a single octet string that will |
|
|
653 | be appended to the write buffer. |
|
|
654 | |
|
|
655 | Note that this is a function, and all types registered this way will be |
|
|
656 | global, so try to use unique names. |
|
|
657 | |
|
|
658 | =cut |
373 | |
659 | |
374 | ############################################################################# |
660 | ############################################################################# |
375 | |
661 | |
376 | =back |
662 | =back |
377 | |
663 | |
… | |
… | |
384 | 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 |
385 | a queue. |
671 | a queue. |
386 | |
672 | |
387 | 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 |
388 | 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 |
389 | 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 |
390 | 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). |
391 | |
678 | |
392 | 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 |
393 | 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 |
394 | 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 |
395 | below). |
682 | done its job (see C<push_read>, below). |
396 | |
683 | |
397 | 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 |
398 | 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. |
399 | |
686 | |
400 | 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 |
401 | the specified number of bytes which give an XML datagram. |
688 | the specified number of bytes which give an XML datagram. |
402 | |
689 | |
403 | # in the default state, expect some header bytes |
690 | # in the default state, expect some header bytes |
404 | $handle->on_read (sub { |
691 | $handle->on_read (sub { |
405 | # 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) |
406 | shift->unshift_read_chunk (4, sub { |
693 | shift->unshift_read (chunk => 4, sub { |
407 | # header arrived, decode |
694 | # header arrived, decode |
408 | my $len = unpack "N", $_[1]; |
695 | my $len = unpack "N", $_[1]; |
409 | |
696 | |
410 | # now read the payload |
697 | # now read the payload |
411 | shift->unshift_read_chunk ($len, sub { |
698 | shift->unshift_read (chunk => $len, sub { |
412 | my $xml = $_[1]; |
699 | my $xml = $_[1]; |
413 | # handle xml |
700 | # handle xml |
414 | }); |
701 | }); |
415 | }); |
702 | }); |
416 | }); |
703 | }); |
417 | |
704 | |
418 | 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" |
419 | "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 |
420 | 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 |
421 | pipeline sending both requests and manipulate the queue as necessary in |
708 | just pipeline sending both requests and manipulate the queue as necessary |
422 | the callbacks: |
709 | in the callbacks. |
423 | |
710 | |
424 | # 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" |
425 | $handle->push_write ("request 1\015\012"); |
716 | $handle->push_write ("request 1\015\012"); |
426 | |
717 | |
427 | # 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 |
428 | $handle->push_read_line (sub { |
719 | $handle->push_read (line => sub { |
429 | # if we got an "OK", we have to _prepend_ another line, |
720 | # if we got an "OK", we have to _prepend_ another line, |
430 | # so it will be read before the second request reads its 64 bytes |
721 | # so it will be read before the second request reads its 64 bytes |
431 | # which are already in the queue when this callback is called |
722 | # which are already in the queue when this callback is called |
432 | # we don't do this in case we got an error |
723 | # we don't do this in case we got an error |
433 | if ($_[1] eq "OK") { |
724 | if ($_[1] eq "OK") { |
434 | $_[0]->unshift_read_line (sub { |
725 | $_[0]->unshift_read (line => sub { |
435 | my $response = $_[1]; |
726 | my $response = $_[1]; |
436 | ... |
727 | ... |
437 | }); |
728 | }); |
438 | } |
729 | } |
439 | }); |
730 | }); |
440 | |
731 | |
441 | # request two |
732 | # request two, simply returns 64 octets |
442 | $handle->push_write ("request 2\015\012"); |
733 | $handle->push_write ("request 2\015\012"); |
443 | |
734 | |
444 | # simply read 64 bytes, always |
735 | # simply read 64 bytes, always |
445 | $handle->push_read_chunk (64, sub { |
736 | $handle->push_read (chunk => 64, sub { |
446 | my $response = $_[1]; |
737 | my $response = $_[1]; |
447 | ... |
738 | ... |
448 | }); |
739 | }); |
449 | |
740 | |
450 | =over 4 |
741 | =over 4 |
451 | |
742 | |
452 | =cut |
743 | =cut |
453 | |
744 | |
454 | sub _drain_rbuf { |
745 | sub _drain_rbuf { |
455 | my ($self) = @_; |
746 | my ($self) = @_; |
|
|
747 | |
|
|
748 | local $self->{_in_drain} = 1; |
456 | |
749 | |
457 | if ( |
750 | if ( |
458 | defined $self->{rbuf_max} |
751 | defined $self->{rbuf_max} |
459 | && $self->{rbuf_max} < length $self->{rbuf} |
752 | && $self->{rbuf_max} < length $self->{rbuf} |
460 | ) { |
753 | ) { |
461 | $! = &Errno::ENOSPC; return $self->error; |
754 | $self->_error (&Errno::ENOSPC, 1), return; |
462 | } |
755 | } |
463 | |
756 | |
464 | return if $self->{in_drain}; |
757 | while () { |
465 | local $self->{in_drain} = 1; |
|
|
466 | |
|
|
467 | while (my $len = length $self->{rbuf}) { |
758 | my $len = length $self->{rbuf}; |
468 | no strict 'refs'; |
759 | |
469 | if (my $cb = shift @{ $self->{queue} }) { |
760 | if (my $cb = shift @{ $self->{_queue} }) { |
470 | unless ($cb->($self)) { |
761 | unless ($cb->($self)) { |
471 | if ($self->{eof}) { |
762 | if ($self->{_eof}) { |
472 | # 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) |
473 | $! = &Errno::EPIPE; return $self->error; |
764 | $self->_error (&Errno::EPIPE, 1), return; |
474 | } |
765 | } |
475 | |
766 | |
476 | unshift @{ $self->{queue} }, $cb; |
767 | unshift @{ $self->{_queue} }, $cb; |
477 | return; |
768 | last; |
478 | } |
769 | } |
479 | } elsif ($self->{on_read}) { |
770 | } elsif ($self->{on_read}) { |
|
|
771 | last unless $len; |
|
|
772 | |
480 | $self->{on_read}($self); |
773 | $self->{on_read}($self); |
481 | |
774 | |
482 | if ( |
775 | if ( |
483 | $self->{eof} # if no further data will arrive |
|
|
484 | && $len == length $self->{rbuf} # and no data has been consumed |
776 | $len == length $self->{rbuf} # if no data has been consumed |
485 | && !@{ $self->{queue} } # and the queue is still empty |
777 | && !@{ $self->{_queue} } # and the queue is still empty |
486 | && $self->{on_read} # and we still want to read data |
778 | && $self->{on_read} # but we still have on_read |
487 | ) { |
779 | ) { |
|
|
780 | # no further data will arrive |
488 | # then no progress can be made |
781 | # so no progress can be made |
489 | $! = &Errno::EPIPE; return $self->error; |
782 | $self->_error (&Errno::EPIPE, 1), return |
|
|
783 | if $self->{_eof}; |
|
|
784 | |
|
|
785 | last; # more data might arrive |
490 | } |
786 | } |
491 | } else { |
787 | } else { |
492 | # read side becomes idle |
788 | # read side becomes idle |
493 | delete $self->{rw}; |
789 | delete $self->{_rw}; |
494 | return; |
790 | last; |
495 | } |
791 | } |
496 | } |
792 | } |
497 | |
793 | |
498 | if ($self->{eof}) { |
794 | if ($self->{_eof}) { |
499 | $self->_shutdown; |
795 | if ($self->{on_eof}) { |
500 | $self->{on_eof}($self) |
796 | $self->{on_eof}($self) |
501 | 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} }; |
502 | } |
806 | } |
503 | } |
807 | } |
504 | |
808 | |
505 | =item $handle->on_read ($cb) |
809 | =item $handle->on_read ($cb) |
506 | |
810 | |
… | |
… | |
512 | |
816 | |
513 | sub on_read { |
817 | sub on_read { |
514 | my ($self, $cb) = @_; |
818 | my ($self, $cb) = @_; |
515 | |
819 | |
516 | $self->{on_read} = $cb; |
820 | $self->{on_read} = $cb; |
|
|
821 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
517 | } |
822 | } |
518 | |
823 | |
519 | =item $handle->rbuf |
824 | =item $handle->rbuf |
520 | |
825 | |
521 | Returns the read buffer (as a modifiable lvalue). |
826 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
552 | interested in (which can be none at all) and return a true value. After returning |
857 | interested in (which can be none at all) and return a true value. After returning |
553 | true, it will be removed from the queue. |
858 | true, it will be removed from the queue. |
554 | |
859 | |
555 | =cut |
860 | =cut |
556 | |
861 | |
|
|
862 | our %RH; |
|
|
863 | |
|
|
864 | sub register_read_type($$) { |
|
|
865 | $RH{$_[0]} = $_[1]; |
|
|
866 | } |
|
|
867 | |
557 | sub push_read { |
868 | sub push_read { |
558 | my $self = shift; |
869 | my $self = shift; |
559 | my $cb = pop; |
870 | my $cb = pop; |
560 | |
871 | |
561 | if (@_) { |
872 | if (@_) { |
… | |
… | |
563 | |
874 | |
564 | $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") |
565 | ->($self, $cb, @_); |
876 | ->($self, $cb, @_); |
566 | } |
877 | } |
567 | |
878 | |
568 | push @{ $self->{queue} }, $cb; |
879 | push @{ $self->{_queue} }, $cb; |
569 | $self->_drain_rbuf; |
880 | $self->_drain_rbuf unless $self->{_in_drain}; |
570 | } |
881 | } |
571 | |
882 | |
572 | sub unshift_read { |
883 | sub unshift_read { |
573 | my $self = shift; |
884 | my $self = shift; |
574 | my $cb = pop; |
885 | my $cb = pop; |
… | |
… | |
579 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
890 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
580 | ->($self, $cb, @_); |
891 | ->($self, $cb, @_); |
581 | } |
892 | } |
582 | |
893 | |
583 | |
894 | |
584 | unshift @{ $self->{queue} }, $cb; |
895 | unshift @{ $self->{_queue} }, $cb; |
585 | $self->_drain_rbuf; |
896 | $self->_drain_rbuf unless $self->{_in_drain}; |
586 | } |
897 | } |
587 | |
898 | |
588 | =item $handle->push_read (type => @args, $cb) |
899 | =item $handle->push_read (type => @args, $cb) |
589 | |
900 | |
590 | =item $handle->unshift_read (type => @args, $cb) |
901 | =item $handle->unshift_read (type => @args, $cb) |
591 | |
902 | |
592 | Instead of providing a callback that parses the data itself you can chose |
903 | Instead of providing a callback that parses the data itself you can chose |
593 | between a number of predefined parsing formats, for chunks of data, lines |
904 | between a number of predefined parsing formats, for chunks of data, lines |
594 | etc. |
905 | etc. |
595 | |
906 | |
596 | The types currently supported are: |
907 | Predefined types are (if you have ideas for additional types, feel free to |
|
|
908 | drop by and tell us): |
597 | |
909 | |
598 | =over 4 |
910 | =over 4 |
599 | |
911 | |
600 | =item chunk => $octets, $cb->($self, $data) |
912 | =item chunk => $octets, $cb->($handle, $data) |
601 | |
913 | |
602 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
914 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
603 | data read to the callback. The callback will never be called with less |
915 | data read to the callback. The callback will never be called with less |
604 | data. |
916 | data. |
605 | |
917 | |
… | |
… | |
619 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
931 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
620 | 1 |
932 | 1 |
621 | } |
933 | } |
622 | }; |
934 | }; |
623 | |
935 | |
624 | # compatibility with older API |
|
|
625 | sub push_read_chunk { |
|
|
626 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
627 | } |
|
|
628 | |
|
|
629 | sub unshift_read_chunk { |
|
|
630 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
631 | } |
|
|
632 | |
|
|
633 | =item line => [$eol, ]$cb->($self, $line, $eol) |
936 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
634 | |
937 | |
635 | 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 |
636 | 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 |
637 | 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 |
638 | the end of line marker as the third argument (C<$eol>). |
941 | the end of line marker as the third argument (C<$eol>). |
… | |
… | |
652 | =cut |
955 | =cut |
653 | |
956 | |
654 | register_read_type line => sub { |
957 | register_read_type line => sub { |
655 | my ($self, $cb, $eol) = @_; |
958 | my ($self, $cb, $eol) = @_; |
656 | |
959 | |
657 | $eol = qr|(\015?\012)| if @_ < 3; |
960 | if (@_ < 3) { |
|
|
961 | # this is more than twice as fast as the generic code below |
|
|
962 | sub { |
|
|
963 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
|
|
964 | |
|
|
965 | $cb->($_[0], $1, $2); |
|
|
966 | 1 |
|
|
967 | } |
|
|
968 | } else { |
658 | $eol = quotemeta $eol unless ref $eol; |
969 | $eol = quotemeta $eol unless ref $eol; |
659 | $eol = qr|^(.*?)($eol)|s; |
970 | $eol = qr|^(.*?)($eol)|s; |
|
|
971 | |
|
|
972 | sub { |
|
|
973 | $_[0]{rbuf} =~ s/$eol// or return; |
|
|
974 | |
|
|
975 | $cb->($_[0], $1, $2); |
|
|
976 | 1 |
|
|
977 | } |
|
|
978 | } |
|
|
979 | }; |
|
|
980 | |
|
|
981 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
|
|
982 | |
|
|
983 | Makes a regex match against the regex object C<$accept> and returns |
|
|
984 | everything up to and including the match. |
|
|
985 | |
|
|
986 | Example: read a single line terminated by '\n'. |
|
|
987 | |
|
|
988 | $handle->push_read (regex => qr<\n>, sub { ... }); |
|
|
989 | |
|
|
990 | If C<$reject> is given and not undef, then it determines when the data is |
|
|
991 | to be rejected: it is matched against the data when the C<$accept> regex |
|
|
992 | does not match and generates an C<EBADMSG> error when it matches. This is |
|
|
993 | useful to quickly reject wrong data (to avoid waiting for a timeout or a |
|
|
994 | receive buffer overflow). |
|
|
995 | |
|
|
996 | Example: expect a single decimal number followed by whitespace, reject |
|
|
997 | anything else (not the use of an anchor). |
|
|
998 | |
|
|
999 | $handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... }); |
|
|
1000 | |
|
|
1001 | If C<$skip> is given and not C<undef>, then it will be matched against |
|
|
1002 | the receive buffer when neither C<$accept> nor C<$reject> match, |
|
|
1003 | and everything preceding and including the match will be accepted |
|
|
1004 | unconditionally. This is useful to skip large amounts of data that you |
|
|
1005 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
|
|
1006 | have to start matching from the beginning. This is purely an optimisation |
|
|
1007 | and is usually worth only when you expect more than a few kilobytes. |
|
|
1008 | |
|
|
1009 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
|
|
1010 | expect the header to be very large (it isn't in practise, but...), we use |
|
|
1011 | a skip regex to skip initial portions. The skip regex is tricky in that |
|
|
1012 | it only accepts something not ending in either \015 or \012, as these are |
|
|
1013 | required for the accept regex. |
|
|
1014 | |
|
|
1015 | $handle->push_read (regex => |
|
|
1016 | qr<\015\012\015\012>, |
|
|
1017 | undef, # no reject |
|
|
1018 | qr<^.*[^\015\012]>, |
|
|
1019 | sub { ... }); |
|
|
1020 | |
|
|
1021 | =cut |
|
|
1022 | |
|
|
1023 | register_read_type regex => sub { |
|
|
1024 | my ($self, $cb, $accept, $reject, $skip) = @_; |
|
|
1025 | |
|
|
1026 | my $data; |
|
|
1027 | my $rbuf = \$self->{rbuf}; |
660 | |
1028 | |
661 | sub { |
1029 | sub { |
662 | $_[0]{rbuf} =~ s/$eol// or return; |
1030 | # accept |
663 | |
1031 | if ($$rbuf =~ $accept) { |
664 | $cb->($_[0], $1, $2); |
1032 | $data .= substr $$rbuf, 0, $+[0], ""; |
|
|
1033 | $cb->($self, $data); |
|
|
1034 | return 1; |
|
|
1035 | } |
665 | 1 |
1036 | |
|
|
1037 | # reject |
|
|
1038 | if ($reject && $$rbuf =~ $reject) { |
|
|
1039 | $self->_error (&Errno::EBADMSG); |
|
|
1040 | } |
|
|
1041 | |
|
|
1042 | # skip |
|
|
1043 | if ($skip && $$rbuf =~ $skip) { |
|
|
1044 | $data .= substr $$rbuf, 0, $+[0], ""; |
|
|
1045 | } |
|
|
1046 | |
|
|
1047 | () |
666 | } |
1048 | } |
667 | }; |
1049 | }; |
668 | |
1050 | |
669 | # compatibility with older API |
|
|
670 | sub push_read_line { |
|
|
671 | my $self = shift; |
|
|
672 | $self->push_read (line => @_); |
|
|
673 | } |
|
|
674 | |
|
|
675 | sub unshift_read_line { |
|
|
676 | my $self = shift; |
|
|
677 | $self->unshift_read (line => @_); |
|
|
678 | } |
|
|
679 | |
|
|
680 | =item netstring => $cb->($string) |
1051 | =item netstring => $cb->($handle, $string) |
681 | |
1052 | |
682 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
1053 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
683 | |
1054 | |
684 | Throws an error with C<$!> set to EBADMSG on format violations. |
1055 | Throws an error with C<$!> set to EBADMSG on format violations. |
685 | |
1056 | |
… | |
… | |
689 | my ($self, $cb) = @_; |
1060 | my ($self, $cb) = @_; |
690 | |
1061 | |
691 | sub { |
1062 | sub { |
692 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1063 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
693 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1064 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
694 | $! = &Errno::EBADMSG; |
1065 | $self->_error (&Errno::EBADMSG); |
695 | $self->error; |
|
|
696 | } |
1066 | } |
697 | return; |
1067 | return; |
698 | } |
1068 | } |
699 | |
1069 | |
700 | my $len = $1; |
1070 | my $len = $1; |
… | |
… | |
703 | my $string = $_[1]; |
1073 | my $string = $_[1]; |
704 | $_[0]->unshift_read (chunk => 1, sub { |
1074 | $_[0]->unshift_read (chunk => 1, sub { |
705 | if ($_[1] eq ",") { |
1075 | if ($_[1] eq ",") { |
706 | $cb->($_[0], $string); |
1076 | $cb->($_[0], $string); |
707 | } else { |
1077 | } else { |
708 | $! = &Errno::EBADMSG; |
1078 | $self->_error (&Errno::EBADMSG); |
709 | $self->error; |
|
|
710 | } |
1079 | } |
711 | }); |
1080 | }); |
712 | }); |
1081 | }); |
713 | |
1082 | |
714 | 1 |
1083 | 1 |
715 | } |
1084 | } |
716 | }; |
1085 | }; |
717 | |
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 | |
|
|
1132 | =item json => $cb->($handle, $hash_or_arrayref) |
|
|
1133 | |
|
|
1134 | Reads a JSON object or array, decodes it and passes it to the callback. |
|
|
1135 | |
|
|
1136 | If a C<json> object was passed to the constructor, then that will be used |
|
|
1137 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
|
|
1138 | |
|
|
1139 | This read type uses the incremental parser available with JSON version |
|
|
1140 | 2.09 (and JSON::XS version 2.2) and above. You have to provide a |
|
|
1141 | dependency on your own: this module will load the JSON module, but |
|
|
1142 | AnyEvent does not depend on it itself. |
|
|
1143 | |
|
|
1144 | Since JSON texts are fully self-delimiting, the C<json> read and write |
|
|
1145 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
|
|
1146 | the C<json> write type description, above, for an actual example. |
|
|
1147 | |
|
|
1148 | =cut |
|
|
1149 | |
|
|
1150 | register_read_type json => sub { |
|
|
1151 | my ($self, $cb) = @_; |
|
|
1152 | |
|
|
1153 | require JSON; |
|
|
1154 | |
|
|
1155 | my $data; |
|
|
1156 | my $rbuf = \$self->{rbuf}; |
|
|
1157 | |
|
|
1158 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
1159 | |
|
|
1160 | sub { |
|
|
1161 | my $ref = $json->incr_parse ($self->{rbuf}); |
|
|
1162 | |
|
|
1163 | if ($ref) { |
|
|
1164 | $self->{rbuf} = $json->incr_text; |
|
|
1165 | $json->incr_text = ""; |
|
|
1166 | $cb->($self, $ref); |
|
|
1167 | |
|
|
1168 | 1 |
|
|
1169 | } else { |
|
|
1170 | $self->{rbuf} = ""; |
|
|
1171 | () |
|
|
1172 | } |
|
|
1173 | } |
|
|
1174 | }; |
|
|
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 | |
718 | =back |
1221 | =back |
719 | |
1222 | |
|
|
1223 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
|
|
1224 | |
|
|
1225 | This function (not method) lets you add your own types to C<push_read>. |
|
|
1226 | |
|
|
1227 | Whenever the given C<type> is used, C<push_read> will invoke the code |
|
|
1228 | reference with the handle object, the callback and the remaining |
|
|
1229 | arguments. |
|
|
1230 | |
|
|
1231 | The code reference is supposed to return a callback (usually a closure) |
|
|
1232 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
|
|
1233 | |
|
|
1234 | It should invoke the passed callback when it is done reading (remember to |
|
|
1235 | pass C<$handle> as first argument as all other callbacks do that). |
|
|
1236 | |
|
|
1237 | Note that this is a function, and all types registered this way will be |
|
|
1238 | global, so try to use unique names. |
|
|
1239 | |
|
|
1240 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
|
|
1241 | search for C<register_read_type>)). |
|
|
1242 | |
720 | =item $handle->stop_read |
1243 | =item $handle->stop_read |
721 | |
1244 | |
722 | =item $handle->start_read |
1245 | =item $handle->start_read |
723 | |
1246 | |
724 | 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 |
725 | 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 |
726 | 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 |
727 | C<start_read>. |
1250 | C<start_read>. |
728 | |
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. |
|
|
1256 | |
729 | =cut |
1257 | =cut |
730 | |
1258 | |
731 | sub stop_read { |
1259 | sub stop_read { |
732 | my ($self) = @_; |
1260 | my ($self) = @_; |
733 | |
1261 | |
734 | delete $self->{rw}; |
1262 | delete $self->{_rw}; |
735 | } |
1263 | } |
736 | |
1264 | |
737 | sub start_read { |
1265 | sub start_read { |
738 | my ($self) = @_; |
1266 | my ($self) = @_; |
739 | |
1267 | |
740 | unless ($self->{rw} || $self->{eof}) { |
1268 | unless ($self->{_rw} || $self->{_eof}) { |
741 | Scalar::Util::weaken $self; |
1269 | Scalar::Util::weaken $self; |
742 | |
1270 | |
743 | $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1271 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
744 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1272 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
745 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1273 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
746 | |
1274 | |
747 | if ($len > 0) { |
1275 | if ($len > 0) { |
|
|
1276 | $self->{_activity} = AnyEvent->now; |
|
|
1277 | |
748 | $self->{filter_r} |
1278 | $self->{filter_r} |
749 | ? $self->{filter_r}->($self, $rbuf) |
1279 | ? $self->{filter_r}($self, $rbuf) |
750 | : $self->_drain_rbuf; |
1280 | : $self->{_in_drain} || $self->_drain_rbuf; |
751 | |
1281 | |
752 | } elsif (defined $len) { |
1282 | } elsif (defined $len) { |
753 | delete $self->{rw}; |
1283 | delete $self->{_rw}; |
754 | $self->{eof} = 1; |
1284 | $self->{_eof} = 1; |
755 | $self->_drain_rbuf; |
1285 | $self->_drain_rbuf unless $self->{_in_drain}; |
756 | |
1286 | |
757 | } elsif ($! != EAGAIN && $! != EINTR) { |
1287 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
758 | return $self->error; |
1288 | return $self->_error ($!, 1); |
759 | } |
1289 | } |
760 | }); |
1290 | }); |
761 | } |
1291 | } |
762 | } |
1292 | } |
763 | |
1293 | |
764 | sub _dotls { |
1294 | sub _dotls { |
765 | my ($self) = @_; |
1295 | my ($self) = @_; |
766 | |
1296 | |
|
|
1297 | my $buf; |
|
|
1298 | |
767 | if (length $self->{tls_wbuf}) { |
1299 | if (length $self->{_tls_wbuf}) { |
768 | 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) { |
769 | substr $self->{tls_wbuf}, 0, $len, ""; |
1301 | substr $self->{_tls_wbuf}, 0, $len, ""; |
770 | } |
1302 | } |
771 | } |
1303 | } |
772 | |
1304 | |
773 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) { |
1305 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
774 | $self->{wbuf} .= $buf; |
1306 | $self->{wbuf} .= $buf; |
775 | $self->_drain_wbuf; |
1307 | $self->_drain_wbuf; |
776 | } |
1308 | } |
777 | |
1309 | |
778 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
1310 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
1311 | if (length $buf) { |
779 | $self->{rbuf} .= $buf; |
1312 | $self->{rbuf} .= $buf; |
780 | $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 | } |
781 | } |
1320 | } |
782 | |
1321 | |
783 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1322 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
784 | |
1323 | |
785 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1324 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
786 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1325 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
787 | $self->error; |
1326 | return $self->_error ($!, 1); |
788 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1327 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
789 | $! = &Errno::EIO; |
1328 | return $self->_error (&Errno::EIO, 1); |
790 | $self->error; |
|
|
791 | } |
1329 | } |
792 | |
1330 | |
793 | # all others are fine for our purposes |
1331 | # all others are fine for our purposes |
794 | } |
1332 | } |
795 | } |
1333 | } |
… | |
… | |
804 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1342 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
805 | |
1343 | |
806 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
1344 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
807 | used when AnyEvent::Handle has to create its own TLS connection object. |
1345 | used when AnyEvent::Handle has to create its own TLS connection object. |
808 | |
1346 | |
809 | =cut |
1347 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
|
|
1348 | call and can be used or changed to your liking. Note that the handshake |
|
|
1349 | might have already started when this function returns. |
810 | |
1350 | |
811 | # TODO: maybe document... |
1351 | =cut |
|
|
1352 | |
812 | sub starttls { |
1353 | sub starttls { |
813 | my ($self, $ssl, $ctx) = @_; |
1354 | my ($self, $ssl, $ctx) = @_; |
814 | |
1355 | |
815 | $self->stoptls; |
1356 | $self->stoptls; |
816 | |
1357 | |
… | |
… | |
827 | # 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) |
828 | # but the openssl maintainers basically said: "trust us, it just works". |
1369 | # but the openssl maintainers basically said: "trust us, it just works". |
829 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1370 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
830 | # and mismaintained ssleay-module doesn't even offer them). |
1371 | # and mismaintained ssleay-module doesn't even offer them). |
831 | # 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. |
832 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1379 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
833 | (eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1380 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
834 | | (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1381 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
835 | |
1382 | |
836 | $self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1383 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
837 | $self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1384 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
838 | |
1385 | |
839 | Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio}); |
1386 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
840 | |
1387 | |
841 | $self->{filter_w} = sub { |
1388 | $self->{filter_w} = sub { |
842 | $_[0]{tls_wbuf} .= ${$_[1]}; |
1389 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
843 | &_dotls; |
1390 | &_dotls; |
844 | }; |
1391 | }; |
845 | $self->{filter_r} = sub { |
1392 | $self->{filter_r} = sub { |
846 | Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]}); |
1393 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
847 | &_dotls; |
1394 | &_dotls; |
848 | }; |
1395 | }; |
849 | } |
1396 | } |
850 | |
1397 | |
851 | =item $handle->stoptls |
1398 | =item $handle->stoptls |
… | |
… | |
857 | |
1404 | |
858 | sub stoptls { |
1405 | sub stoptls { |
859 | my ($self) = @_; |
1406 | my ($self) = @_; |
860 | |
1407 | |
861 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1408 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
|
|
1409 | |
862 | delete $self->{tls_rbio}; |
1410 | delete $self->{_rbio}; |
863 | delete $self->{tls_wbio}; |
1411 | delete $self->{_wbio}; |
864 | delete $self->{tls_wbuf}; |
1412 | delete $self->{_tls_wbuf}; |
865 | delete $self->{filter_r}; |
1413 | delete $self->{filter_r}; |
866 | delete $self->{filter_w}; |
1414 | delete $self->{filter_w}; |
867 | } |
1415 | } |
868 | |
1416 | |
869 | sub DESTROY { |
1417 | sub DESTROY { |
870 | my $self = shift; |
1418 | my $self = shift; |
871 | |
1419 | |
872 | $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 | } |
873 | } |
1443 | } |
874 | |
1444 | |
875 | =item AnyEvent::Handle::TLS_CTX |
1445 | =item AnyEvent::Handle::TLS_CTX |
876 | |
1446 | |
877 | 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 |
… | |
… | |
907 | } |
1477 | } |
908 | } |
1478 | } |
909 | |
1479 | |
910 | =back |
1480 | =back |
911 | |
1481 | |
|
|
1482 | =head1 SUBCLASSING AnyEvent::Handle |
|
|
1483 | |
|
|
1484 | In many cases, you might want to subclass AnyEvent::Handle. |
|
|
1485 | |
|
|
1486 | To make this easier, a given version of AnyEvent::Handle uses these |
|
|
1487 | conventions: |
|
|
1488 | |
|
|
1489 | =over 4 |
|
|
1490 | |
|
|
1491 | =item * all constructor arguments become object members. |
|
|
1492 | |
|
|
1493 | At least initially, when you pass a C<tls>-argument to the constructor it |
|
|
1494 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
|
|
1495 | mutated later on (for example C<tls> will hold the TLS connection object). |
|
|
1496 | |
|
|
1497 | =item * other object member names are prefixed with an C<_>. |
|
|
1498 | |
|
|
1499 | All object members not explicitly documented (internal use) are prefixed |
|
|
1500 | with an underscore character, so the remaining non-C<_>-namespace is free |
|
|
1501 | for use for subclasses. |
|
|
1502 | |
|
|
1503 | =item * all members not documented here and not prefixed with an underscore |
|
|
1504 | are free to use in subclasses. |
|
|
1505 | |
|
|
1506 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
|
|
1507 | member variables, but thats just life, at least it is documented. |
|
|
1508 | |
|
|
1509 | =back |
|
|
1510 | |
912 | =head1 AUTHOR |
1511 | =head1 AUTHOR |
913 | |
1512 | |
914 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
1513 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
915 | |
1514 | |
916 | =cut |
1515 | =cut |