1 | package AnyEvent::Handle; |
1 | package AnyEvent::Handle; |
2 | |
2 | |
3 | no warnings; |
3 | no warnings; |
4 | use strict; |
4 | use strict qw(subs vars); |
5 | |
5 | |
6 | use AnyEvent (); |
6 | use AnyEvent (); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
… | |
… | |
14 | |
14 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
16 | |
17 | =cut |
17 | =cut |
18 | |
18 | |
19 | our $VERSION = 4.14; |
19 | our $VERSION = 4.331; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
27 | |
27 | |
28 | my $handle = |
28 | my $handle = |
29 | AnyEvent::Handle->new ( |
29 | AnyEvent::Handle->new ( |
30 | fh => \*STDIN, |
30 | fh => \*STDIN, |
31 | on_eof => sub { |
31 | on_eof => sub { |
32 | $cv->broadcast; |
32 | $cv->send; |
33 | }, |
33 | }, |
34 | ); |
34 | ); |
35 | |
35 | |
36 | # send some request line |
36 | # send some request line |
37 | $handle->push_write ("getinfo\015\012"); |
37 | $handle->push_write ("getinfo\015\012"); |
… | |
… | |
49 | |
49 | |
50 | This module is a helper module to make it easier to do event-based I/O on |
50 | This module is a helper module to make it easier to do event-based I/O on |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
52 | on sockets see L<AnyEvent::Util>. |
52 | on sockets see L<AnyEvent::Util>. |
53 | |
53 | |
|
|
54 | The L<AnyEvent::Intro> tutorial contains some well-documented |
|
|
55 | AnyEvent::Handle examples. |
|
|
56 | |
54 | In the following, when the documentation refers to of "bytes" then this |
57 | In the following, when the documentation refers to of "bytes" then this |
55 | means characters. As sysread and syswrite are used for all I/O, their |
58 | means characters. As sysread and syswrite are used for all I/O, their |
56 | treatment of characters applies to this module as well. |
59 | treatment of characters applies to this module as well. |
57 | |
60 | |
58 | All callbacks will be invoked with the handle object as their first |
61 | All callbacks will be invoked with the handle object as their first |
… | |
… | |
70 | |
73 | |
71 | =item fh => $filehandle [MANDATORY] |
74 | =item fh => $filehandle [MANDATORY] |
72 | |
75 | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
77 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
78 | NOTE: The filehandle will be set to non-blocking mode (using |
76 | AnyEvent::Util::fh_nonblocking). |
79 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
80 | that mode. |
77 | |
81 | |
78 | =item on_eof => $cb->($handle) |
82 | =item on_eof => $cb->($handle) |
79 | |
83 | |
80 | Set the callback to be called when an end-of-file condition is detcted, |
84 | Set the callback to be called when an end-of-file condition is detected, |
81 | i.e. in the case of a socket, when the other side has closed the |
85 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
86 | connection cleanly. |
83 | |
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 | |
84 | 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, |
85 | 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 |
86 | waiting for data. |
95 | waiting for data. |
|
|
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>. |
87 | |
99 | |
88 | =item on_error => $cb->($handle, $fatal) |
100 | =item on_error => $cb->($handle, $fatal) |
89 | |
101 | |
90 | This is the error callback, which is called when, well, some error |
102 | This is the error callback, which is called when, well, some error |
91 | occured, such as not being able to resolve the hostname, failure to |
103 | occured, such as not being able to resolve the hostname, failure to |
92 | connect or a read error. |
104 | connect or a read error. |
93 | |
105 | |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
106 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
95 | fatal errors the handle object will be shut down and will not be |
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 | |
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
112 | Non-fatal errors can be retried by simply returning, but it is recommended |
97 | recommended to simply ignore this parameter and instead abondon the handle |
113 | to simply ignore this parameter and instead abondon the handle object |
98 | object when this callback is invoked. |
114 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
115 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
99 | |
116 | |
100 | On callback entrance, the value of C<$!> contains the operating system |
117 | On callback entrance, the value of C<$!> contains the operating system |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
118 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
102 | |
119 | |
103 | 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 |
… | |
… | |
124 | 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 |
125 | (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). |
126 | |
143 | |
127 | 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. |
128 | |
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 | |
129 | =item timeout => $fractional_seconds |
152 | =item timeout => $fractional_seconds |
130 | |
153 | |
131 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
154 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
132 | seconds pass without a successful read or write on the underlying file |
155 | seconds pass without a successful read or write on the underlying file |
133 | handle, the C<on_timeout> callback will be invoked (and if that one is |
156 | handle, the C<on_timeout> callback will be invoked (and if that one is |
134 | missing, an C<ETIMEDOUT> error will be raised). |
157 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
135 | |
158 | |
136 | Note that timeout processing is also active when you currently do not have |
159 | Note that timeout processing is also active when you currently do not have |
137 | any outstanding read or write requests: If you plan to keep the connection |
160 | any outstanding read or write requests: If you plan to keep the connection |
138 | idle then you should disable the timout temporarily or ignore the timeout |
161 | idle then you should disable the timout temporarily or ignore the timeout |
139 | in the C<on_timeout> callback. |
162 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
|
|
163 | restart the timeout. |
140 | |
164 | |
141 | Zero (the default) disables this timeout. |
165 | Zero (the default) disables this timeout. |
142 | |
166 | |
143 | =item on_timeout => $cb->($handle) |
167 | =item on_timeout => $cb->($handle) |
144 | |
168 | |
… | |
… | |
148 | |
172 | |
149 | =item rbuf_max => <bytes> |
173 | =item rbuf_max => <bytes> |
150 | |
174 | |
151 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
175 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
152 | when the read buffer ever (strictly) exceeds this size. This is useful to |
176 | when the read buffer ever (strictly) exceeds this size. This is useful to |
153 | avoid denial-of-service attacks. |
177 | avoid some forms of denial-of-service attacks. |
154 | |
178 | |
155 | For example, a server accepting connections from untrusted sources should |
179 | For example, a server accepting connections from untrusted sources should |
156 | be configured to accept only so-and-so much data that it cannot act on |
180 | be configured to accept only so-and-so much data that it cannot act on |
157 | (for example, when expecting a line, an attacker could send an unlimited |
181 | (for example, when expecting a line, an attacker could send an unlimited |
158 | amount of data without a callback ever being called as long as the line |
182 | amount of data without a callback ever being called as long as the line |
159 | isn't finished). |
183 | isn't finished). |
160 | |
184 | |
|
|
185 | =item autocork => <boolean> |
|
|
186 | |
|
|
187 | When disabled (the default), then C<push_write> will try to immediately |
|
|
188 | write the data to the handle, if possible. This avoids having to register |
|
|
189 | a write watcher and wait for the next event loop iteration, but can |
|
|
190 | be inefficient if you write multiple small chunks (on the wire, this |
|
|
191 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
|
|
192 | C<no_delay>, but this option can save costly syscalls). |
|
|
193 | |
|
|
194 | When enabled, then writes will always be queued till the next event loop |
|
|
195 | iteration. This is efficient when you do many small writes per iteration, |
|
|
196 | but less efficient when you do a single write only per iteration (or when |
|
|
197 | the write buffer often is full). It also increases write latency. |
|
|
198 | |
|
|
199 | =item no_delay => <boolean> |
|
|
200 | |
|
|
201 | When doing small writes on sockets, your operating system kernel might |
|
|
202 | wait a bit for more data before actually sending it out. This is called |
|
|
203 | the Nagle algorithm, and usually it is beneficial. |
|
|
204 | |
|
|
205 | In some situations you want as low a delay as possible, which can be |
|
|
206 | accomplishd by setting this option to a true value. |
|
|
207 | |
|
|
208 | The default is your opertaing system's default behaviour (most likely |
|
|
209 | enabled), this option explicitly enables or disables it, if possible. |
|
|
210 | |
161 | =item read_size => <bytes> |
211 | =item read_size => <bytes> |
162 | |
212 | |
163 | The default read block size (the amount of bytes this module will try to read |
213 | The default read block size (the amount of bytes this module will |
164 | during each (loop iteration). Default: C<8192>. |
214 | try to read during each loop iteration, which affects memory |
|
|
215 | requirements). Default: C<8192>. |
165 | |
216 | |
166 | =item low_water_mark => <bytes> |
217 | =item low_water_mark => <bytes> |
167 | |
218 | |
168 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
219 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
169 | buffer: If the write reaches this size or gets even samller it is |
220 | buffer: If the write reaches this size or gets even samller it is |
170 | considered empty. |
221 | considered empty. |
171 | |
222 | |
|
|
223 | Sometimes it can be beneficial (for performance reasons) to add data to |
|
|
224 | the write buffer before it is fully drained, but this is a rare case, as |
|
|
225 | the operating system kernel usually buffers data as well, so the default |
|
|
226 | is good in almost all cases. |
|
|
227 | |
172 | =item linger => <seconds> |
228 | =item linger => <seconds> |
173 | |
229 | |
174 | If non-zero (default: C<3600>), then the destructor of the |
230 | If non-zero (default: C<3600>), then the destructor of the |
175 | AnyEvent::Handle object will check wether there is still outstanding write |
231 | AnyEvent::Handle object will check whether there is still outstanding |
176 | data and will install a watcher that will write out this data. No errors |
232 | write data and will install a watcher that will write this data to the |
177 | will be reported (this mostly matches how the operating system treats |
233 | socket. No errors will be reported (this mostly matches how the operating |
178 | outstanding data at socket close time). |
234 | system treats outstanding data at socket close time). |
179 | |
235 | |
180 | This will not work for partial TLS data that could not yet been |
236 | This will not work for partial TLS data that could not be encoded |
181 | encoded. This data will be lost. |
237 | yet. This data will be lost. Calling the C<stoptls> method in time might |
|
|
238 | help. |
182 | |
239 | |
183 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
240 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
184 | |
241 | |
185 | When this parameter is given, it enables TLS (SSL) mode, that means it |
242 | When this parameter is given, it enables TLS (SSL) mode, that means |
186 | will start making tls handshake and will transparently encrypt/decrypt |
243 | AnyEvent will start a TLS handshake as soon as the conenction has been |
187 | data. |
244 | established and will transparently encrypt/decrypt data afterwards. |
188 | |
245 | |
189 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
246 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
190 | automatically when you try to create a TLS handle). |
247 | automatically when you try to create a TLS handle): this module doesn't |
|
|
248 | have a dependency on that module, so if your module requires it, you have |
|
|
249 | to add the dependency yourself. |
191 | |
250 | |
192 | For the TLS server side, use C<accept>, and for the TLS client side of a |
251 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
193 | connection, use C<connect> mode. |
252 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
253 | mode. |
194 | |
254 | |
195 | You can also provide your own TLS connection object, but you have |
255 | You can also provide your own TLS connection object, but you have |
196 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
256 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
197 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
257 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
198 | AnyEvent::Handle. |
258 | AnyEvent::Handle. |
199 | |
259 | |
|
|
260 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
|
|
261 | passing in the wrong integer will lead to certain crash. This most often |
|
|
262 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
|
|
263 | segmentation fault. |
|
|
264 | |
200 | See the C<starttls> method if you need to start TLs negotiation later. |
265 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
201 | |
266 | |
202 | =item tls_ctx => $ssl_ctx |
267 | =item tls_ctx => $ssl_ctx |
203 | |
268 | |
204 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
269 | Use the given C<Net::SSLeay::CTX> object to create the new TLS connection |
205 | (unless a connection object was specified directly). If this parameter is |
270 | (unless a connection object was specified directly). If this parameter is |
206 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
271 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
207 | |
272 | |
208 | =item json => JSON or JSON::XS object |
273 | =item json => JSON or JSON::XS object |
209 | |
274 | |
210 | This is the json coder object used by the C<json> read and write types. |
275 | This is the json coder object used by the C<json> read and write types. |
211 | |
276 | |
212 | If you don't supply it, then AnyEvent::Handle will create and use a |
277 | If you don't supply it, then AnyEvent::Handle will create and use a |
213 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
278 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
279 | texts. |
214 | |
280 | |
215 | Note that you are responsible to depend on the JSON module if you want to |
281 | Note that you are responsible to depend on the JSON module if you want to |
216 | use this functionality, as AnyEvent does not have a dependency itself. |
282 | use this functionality, as AnyEvent does not have a dependency itself. |
217 | |
283 | |
218 | =item filter_r => $cb |
|
|
219 | |
|
|
220 | =item filter_w => $cb |
|
|
221 | |
|
|
222 | These exist, but are undocumented at this time. |
|
|
223 | |
|
|
224 | =back |
284 | =back |
225 | |
285 | |
226 | =cut |
286 | =cut |
227 | |
287 | |
228 | sub new { |
288 | sub new { |
… | |
… | |
232 | |
292 | |
233 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
293 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
234 | |
294 | |
235 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
295 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
236 | |
296 | |
237 | if ($self->{tls}) { |
|
|
238 | require Net::SSLeay; |
|
|
239 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
297 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
240 | } |
298 | if $self->{tls}; |
241 | |
299 | |
242 | $self->{_activity} = AnyEvent->now; |
300 | $self->{_activity} = AnyEvent->now; |
243 | $self->_timeout; |
301 | $self->_timeout; |
244 | |
302 | |
245 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
303 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
|
|
304 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
305 | |
|
|
306 | $self->start_read |
|
|
307 | if $self->{on_read}; |
246 | |
308 | |
247 | $self |
309 | $self |
248 | } |
310 | } |
249 | |
311 | |
250 | sub _shutdown { |
312 | sub _shutdown { |
… | |
… | |
253 | delete $self->{_tw}; |
315 | delete $self->{_tw}; |
254 | delete $self->{_rw}; |
316 | delete $self->{_rw}; |
255 | delete $self->{_ww}; |
317 | delete $self->{_ww}; |
256 | delete $self->{fh}; |
318 | delete $self->{fh}; |
257 | |
319 | |
258 | $self->stoptls; |
320 | &_freetls; |
|
|
321 | |
|
|
322 | delete $self->{on_read}; |
|
|
323 | delete $self->{_queue}; |
259 | } |
324 | } |
260 | |
325 | |
261 | sub _error { |
326 | sub _error { |
262 | my ($self, $errno, $fatal) = @_; |
327 | my ($self, $errno, $fatal) = @_; |
263 | |
328 | |
… | |
… | |
266 | |
331 | |
267 | $! = $errno; |
332 | $! = $errno; |
268 | |
333 | |
269 | if ($self->{on_error}) { |
334 | if ($self->{on_error}) { |
270 | $self->{on_error}($self, $fatal); |
335 | $self->{on_error}($self, $fatal); |
271 | } else { |
336 | } elsif ($self->{fh}) { |
272 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
337 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
273 | } |
338 | } |
274 | } |
339 | } |
275 | |
340 | |
276 | =item $fh = $handle->fh |
341 | =item $fh = $handle->fh |
277 | |
342 | |
278 | This method returns the file handle of the L<AnyEvent::Handle> object. |
343 | This method returns the file handle used to create the L<AnyEvent::Handle> object. |
279 | |
344 | |
280 | =cut |
345 | =cut |
281 | |
346 | |
282 | sub fh { $_[0]{fh} } |
347 | sub fh { $_[0]{fh} } |
283 | |
348 | |
… | |
… | |
301 | $_[0]{on_eof} = $_[1]; |
366 | $_[0]{on_eof} = $_[1]; |
302 | } |
367 | } |
303 | |
368 | |
304 | =item $handle->on_timeout ($cb) |
369 | =item $handle->on_timeout ($cb) |
305 | |
370 | |
306 | Replace the current C<on_timeout> callback, or disables the callback |
371 | Replace the current C<on_timeout> callback, or disables the callback (but |
307 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
372 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
308 | argument. |
373 | argument and method. |
309 | |
374 | |
310 | =cut |
375 | =cut |
311 | |
376 | |
312 | sub on_timeout { |
377 | sub on_timeout { |
313 | $_[0]{on_timeout} = $_[1]; |
378 | $_[0]{on_timeout} = $_[1]; |
|
|
379 | } |
|
|
380 | |
|
|
381 | =item $handle->autocork ($boolean) |
|
|
382 | |
|
|
383 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
384 | constructor argument). Changes will only take effect on the next write. |
|
|
385 | |
|
|
386 | =cut |
|
|
387 | |
|
|
388 | sub autocork { |
|
|
389 | $_[0]{autocork} = $_[1]; |
|
|
390 | } |
|
|
391 | |
|
|
392 | =item $handle->no_delay ($boolean) |
|
|
393 | |
|
|
394 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
395 | the same name for details). |
|
|
396 | |
|
|
397 | =cut |
|
|
398 | |
|
|
399 | sub no_delay { |
|
|
400 | $_[0]{no_delay} = $_[1]; |
|
|
401 | |
|
|
402 | eval { |
|
|
403 | local $SIG{__DIE__}; |
|
|
404 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
405 | }; |
314 | } |
406 | } |
315 | |
407 | |
316 | ############################################################################# |
408 | ############################################################################# |
317 | |
409 | |
318 | =item $handle->timeout ($seconds) |
410 | =item $handle->timeout ($seconds) |
… | |
… | |
396 | my ($self, $cb) = @_; |
488 | my ($self, $cb) = @_; |
397 | |
489 | |
398 | $self->{on_drain} = $cb; |
490 | $self->{on_drain} = $cb; |
399 | |
491 | |
400 | $cb->($self) |
492 | $cb->($self) |
401 | if $cb && $self->{low_water_mark} >= length $self->{wbuf}; |
493 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
402 | } |
494 | } |
403 | |
495 | |
404 | =item $handle->push_write ($data) |
496 | =item $handle->push_write ($data) |
405 | |
497 | |
406 | Queues the given scalar to be written. You can push as much data as you |
498 | Queues the given scalar to be written. You can push as much data as you |
… | |
… | |
423 | substr $self->{wbuf}, 0, $len, ""; |
515 | substr $self->{wbuf}, 0, $len, ""; |
424 | |
516 | |
425 | $self->{_activity} = AnyEvent->now; |
517 | $self->{_activity} = AnyEvent->now; |
426 | |
518 | |
427 | $self->{on_drain}($self) |
519 | $self->{on_drain}($self) |
428 | if $self->{low_water_mark} >= length $self->{wbuf} |
520 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
429 | && $self->{on_drain}; |
521 | && $self->{on_drain}; |
430 | |
522 | |
431 | delete $self->{_ww} unless length $self->{wbuf}; |
523 | delete $self->{_ww} unless length $self->{wbuf}; |
432 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
524 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
433 | $self->_error ($!, 1); |
525 | $self->_error ($!, 1); |
434 | } |
526 | } |
435 | }; |
527 | }; |
436 | |
528 | |
437 | # try to write data immediately |
529 | # try to write data immediately |
438 | $cb->(); |
530 | $cb->() unless $self->{autocork}; |
439 | |
531 | |
440 | # if still data left in wbuf, we need to poll |
532 | # if still data left in wbuf, we need to poll |
441 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
533 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
442 | if length $self->{wbuf}; |
534 | if length $self->{wbuf}; |
443 | }; |
535 | }; |
… | |
… | |
457 | |
549 | |
458 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
550 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
459 | ->($self, @_); |
551 | ->($self, @_); |
460 | } |
552 | } |
461 | |
553 | |
462 | if ($self->{filter_w}) { |
554 | if ($self->{tls}) { |
463 | $self->{filter_w}($self, \$_[0]); |
555 | $self->{_tls_wbuf} .= $_[0]; |
|
|
556 | |
|
|
557 | &_dotls ($self); |
464 | } else { |
558 | } else { |
465 | $self->{wbuf} .= $_[0]; |
559 | $self->{wbuf} .= $_[0]; |
466 | $self->_drain_wbuf; |
560 | $self->_drain_wbuf; |
467 | } |
561 | } |
468 | } |
562 | } |
… | |
… | |
485 | =cut |
579 | =cut |
486 | |
580 | |
487 | register_write_type netstring => sub { |
581 | register_write_type netstring => sub { |
488 | my ($self, $string) = @_; |
582 | my ($self, $string) = @_; |
489 | |
583 | |
490 | sprintf "%d:%s,", (length $string), $string |
584 | (length $string) . ":$string," |
491 | }; |
585 | }; |
492 | |
586 | |
493 | =item packstring => $format, $data |
587 | =item packstring => $format, $data |
494 | |
588 | |
495 | An octet string prefixed with an encoded length. The encoding C<$format> |
589 | An octet string prefixed with an encoded length. The encoding C<$format> |
… | |
… | |
500 | =cut |
594 | =cut |
501 | |
595 | |
502 | register_write_type packstring => sub { |
596 | register_write_type packstring => sub { |
503 | my ($self, $format, $string) = @_; |
597 | my ($self, $format, $string) = @_; |
504 | |
598 | |
505 | pack "$format/a", $string |
599 | pack "$format/a*", $string |
506 | }; |
600 | }; |
507 | |
601 | |
508 | =item json => $array_or_hashref |
602 | =item json => $array_or_hashref |
509 | |
603 | |
510 | Encodes the given hash or array reference into a JSON object. Unless you |
604 | Encodes the given hash or array reference into a JSON object. Unless you |
… | |
… | |
544 | |
638 | |
545 | $self->{json} ? $self->{json}->encode ($ref) |
639 | $self->{json} ? $self->{json}->encode ($ref) |
546 | : JSON::encode_json ($ref) |
640 | : JSON::encode_json ($ref) |
547 | }; |
641 | }; |
548 | |
642 | |
|
|
643 | =item storable => $reference |
|
|
644 | |
|
|
645 | Freezes the given reference using L<Storable> and writes it to the |
|
|
646 | handle. Uses the C<nfreeze> format. |
|
|
647 | |
|
|
648 | =cut |
|
|
649 | |
|
|
650 | register_write_type storable => sub { |
|
|
651 | my ($self, $ref) = @_; |
|
|
652 | |
|
|
653 | require Storable; |
|
|
654 | |
|
|
655 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
656 | }; |
|
|
657 | |
549 | =back |
658 | =back |
550 | |
659 | |
551 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
660 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
552 | |
661 | |
553 | This function (not method) lets you add your own types to C<push_write>. |
662 | This function (not method) lets you add your own types to C<push_write>. |
… | |
… | |
575 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
684 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
576 | a queue. |
685 | a queue. |
577 | |
686 | |
578 | In the simple case, you just install an C<on_read> callback and whenever |
687 | In the simple case, you just install an C<on_read> callback and whenever |
579 | new data arrives, it will be called. You can then remove some data (if |
688 | new data arrives, it will be called. You can then remove some data (if |
580 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
689 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
581 | or not. |
690 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
691 | partial message has been received so far). |
582 | |
692 | |
583 | In the more complex case, you want to queue multiple callbacks. In this |
693 | In the more complex case, you want to queue multiple callbacks. In this |
584 | case, AnyEvent::Handle will call the first queued callback each time new |
694 | case, AnyEvent::Handle will call the first queued callback each time new |
585 | data arrives (also the first time it is queued) and removes it when it has |
695 | data arrives (also the first time it is queued) and removes it when it has |
586 | done its job (see C<push_read>, below). |
696 | done its job (see C<push_read>, below). |
… | |
… | |
604 | # handle xml |
714 | # handle xml |
605 | }); |
715 | }); |
606 | }); |
716 | }); |
607 | }); |
717 | }); |
608 | |
718 | |
609 | Example 2: Implement a client for a protocol that replies either with |
719 | Example 2: Implement a client for a protocol that replies either with "OK" |
610 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
720 | and another line or "ERROR" for the first request that is sent, and 64 |
611 | second request. Due tot he availability of a full queue, we can just |
721 | bytes for the second request. Due to the availability of a queue, we can |
612 | pipeline sending both requests and manipulate the queue as necessary in |
722 | just pipeline sending both requests and manipulate the queue as necessary |
613 | the callbacks: |
723 | in the callbacks. |
614 | |
724 | |
615 | # request one |
725 | When the first callback is called and sees an "OK" response, it will |
|
|
726 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
727 | 64-byte chunk callback. |
|
|
728 | |
|
|
729 | # request one, returns either "OK + extra line" or "ERROR" |
616 | $handle->push_write ("request 1\015\012"); |
730 | $handle->push_write ("request 1\015\012"); |
617 | |
731 | |
618 | # we expect "ERROR" or "OK" as response, so push a line read |
732 | # we expect "ERROR" or "OK" as response, so push a line read |
619 | $handle->push_read (line => sub { |
733 | $handle->push_read (line => sub { |
620 | # if we got an "OK", we have to _prepend_ another line, |
734 | # if we got an "OK", we have to _prepend_ another line, |
… | |
… | |
627 | ... |
741 | ... |
628 | }); |
742 | }); |
629 | } |
743 | } |
630 | }); |
744 | }); |
631 | |
745 | |
632 | # request two |
746 | # request two, simply returns 64 octets |
633 | $handle->push_write ("request 2\015\012"); |
747 | $handle->push_write ("request 2\015\012"); |
634 | |
748 | |
635 | # simply read 64 bytes, always |
749 | # simply read 64 bytes, always |
636 | $handle->push_read (chunk => 64, sub { |
750 | $handle->push_read (chunk => 64, sub { |
637 | my $response = $_[1]; |
751 | my $response = $_[1]; |
… | |
… | |
649 | |
763 | |
650 | if ( |
764 | if ( |
651 | defined $self->{rbuf_max} |
765 | defined $self->{rbuf_max} |
652 | && $self->{rbuf_max} < length $self->{rbuf} |
766 | && $self->{rbuf_max} < length $self->{rbuf} |
653 | ) { |
767 | ) { |
654 | return $self->_error (&Errno::ENOSPC, 1); |
768 | $self->_error (&Errno::ENOSPC, 1), return; |
655 | } |
769 | } |
656 | |
770 | |
657 | while () { |
771 | while () { |
658 | no strict 'refs'; |
|
|
659 | |
|
|
660 | my $len = length $self->{rbuf}; |
772 | my $len = length $self->{rbuf}; |
661 | |
773 | |
662 | if (my $cb = shift @{ $self->{_queue} }) { |
774 | if (my $cb = shift @{ $self->{_queue} }) { |
663 | unless ($cb->($self)) { |
775 | unless ($cb->($self)) { |
664 | if ($self->{_eof}) { |
776 | if ($self->{_eof}) { |
665 | # no progress can be made (not enough data and no data forthcoming) |
777 | # no progress can be made (not enough data and no data forthcoming) |
666 | $self->_error (&Errno::EPIPE, 1), last; |
778 | $self->_error (&Errno::EPIPE, 1), return; |
667 | } |
779 | } |
668 | |
780 | |
669 | unshift @{ $self->{_queue} }, $cb; |
781 | unshift @{ $self->{_queue} }, $cb; |
670 | last; |
782 | last; |
671 | } |
783 | } |
… | |
… | |
679 | && !@{ $self->{_queue} } # and the queue is still empty |
791 | && !@{ $self->{_queue} } # and the queue is still empty |
680 | && $self->{on_read} # but we still have on_read |
792 | && $self->{on_read} # but we still have on_read |
681 | ) { |
793 | ) { |
682 | # no further data will arrive |
794 | # no further data will arrive |
683 | # so no progress can be made |
795 | # so no progress can be made |
684 | $self->_error (&Errno::EPIPE, 1), last |
796 | $self->_error (&Errno::EPIPE, 1), return |
685 | if $self->{_eof}; |
797 | if $self->{_eof}; |
686 | |
798 | |
687 | last; # more data might arrive |
799 | last; # more data might arrive |
688 | } |
800 | } |
689 | } else { |
801 | } else { |
690 | # read side becomes idle |
802 | # read side becomes idle |
691 | delete $self->{_rw}; |
803 | delete $self->{_rw} unless $self->{tls}; |
692 | last; |
804 | last; |
693 | } |
805 | } |
694 | } |
806 | } |
695 | |
807 | |
|
|
808 | if ($self->{_eof}) { |
|
|
809 | if ($self->{on_eof}) { |
696 | $self->{on_eof}($self) |
810 | $self->{on_eof}($self) |
697 | if $self->{_eof} && $self->{on_eof}; |
811 | } else { |
|
|
812 | $self->_error (0, 1); |
|
|
813 | } |
|
|
814 | } |
698 | |
815 | |
699 | # may need to restart read watcher |
816 | # may need to restart read watcher |
700 | unless ($self->{_rw}) { |
817 | unless ($self->{_rw}) { |
701 | $self->start_read |
818 | $self->start_read |
702 | if $self->{on_read} || @{ $self->{_queue} }; |
819 | if $self->{on_read} || @{ $self->{_queue} }; |
… | |
… | |
828 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
945 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
829 | 1 |
946 | 1 |
830 | } |
947 | } |
831 | }; |
948 | }; |
832 | |
949 | |
833 | # compatibility with older API |
|
|
834 | sub push_read_chunk { |
|
|
835 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
836 | } |
|
|
837 | |
|
|
838 | sub unshift_read_chunk { |
|
|
839 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
840 | } |
|
|
841 | |
|
|
842 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
950 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
843 | |
951 | |
844 | The callback will be called only once a full line (including the end of |
952 | The callback will be called only once a full line (including the end of |
845 | line marker, C<$eol>) has been read. This line (excluding the end of line |
953 | line marker, C<$eol>) has been read. This line (excluding the end of line |
846 | marker) will be passed to the callback as second argument (C<$line>), and |
954 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
861 | =cut |
969 | =cut |
862 | |
970 | |
863 | register_read_type line => sub { |
971 | register_read_type line => sub { |
864 | my ($self, $cb, $eol) = @_; |
972 | my ($self, $cb, $eol) = @_; |
865 | |
973 | |
866 | $eol = qr|(\015?\012)| if @_ < 3; |
974 | if (@_ < 3) { |
|
|
975 | # this is more than twice as fast as the generic code below |
|
|
976 | sub { |
|
|
977 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
|
|
978 | |
|
|
979 | $cb->($_[0], $1, $2); |
|
|
980 | 1 |
|
|
981 | } |
|
|
982 | } else { |
867 | $eol = quotemeta $eol unless ref $eol; |
983 | $eol = quotemeta $eol unless ref $eol; |
868 | $eol = qr|^(.*?)($eol)|s; |
984 | $eol = qr|^(.*?)($eol)|s; |
869 | |
985 | |
870 | sub { |
986 | sub { |
871 | $_[0]{rbuf} =~ s/$eol// or return; |
987 | $_[0]{rbuf} =~ s/$eol// or return; |
872 | |
988 | |
873 | $cb->($_[0], $1, $2); |
989 | $cb->($_[0], $1, $2); |
|
|
990 | 1 |
874 | 1 |
991 | } |
875 | } |
992 | } |
876 | }; |
993 | }; |
877 | |
|
|
878 | # compatibility with older API |
|
|
879 | sub push_read_line { |
|
|
880 | my $self = shift; |
|
|
881 | $self->push_read (line => @_); |
|
|
882 | } |
|
|
883 | |
|
|
884 | sub unshift_read_line { |
|
|
885 | my $self = shift; |
|
|
886 | $self->unshift_read (line => @_); |
|
|
887 | } |
|
|
888 | |
994 | |
889 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
995 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
890 | |
996 | |
891 | Makes a regex match against the regex object C<$accept> and returns |
997 | Makes a regex match against the regex object C<$accept> and returns |
892 | everything up to and including the match. |
998 | everything up to and including the match. |
… | |
… | |
997 | An octet string prefixed with an encoded length. The encoding C<$format> |
1103 | An octet string prefixed with an encoded length. The encoding C<$format> |
998 | uses the same format as a Perl C<pack> format, but must specify a single |
1104 | uses the same format as a Perl C<pack> format, but must specify a single |
999 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1105 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1000 | optional C<!>, C<< < >> or C<< > >> modifier). |
1106 | optional C<!>, C<< < >> or C<< > >> modifier). |
1001 | |
1107 | |
1002 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
1108 | For example, DNS over TCP uses a prefix of C<n> (2 octet network order), |
|
|
1109 | EPP uses a prefix of C<N> (4 octtes). |
1003 | |
1110 | |
1004 | Example: read a block of data prefixed by its length in BER-encoded |
1111 | Example: read a block of data prefixed by its length in BER-encoded |
1005 | format (very efficient). |
1112 | format (very efficient). |
1006 | |
1113 | |
1007 | $handle->push_read (packstring => "w", sub { |
1114 | $handle->push_read (packstring => "w", sub { |
… | |
… | |
1013 | register_read_type packstring => sub { |
1120 | register_read_type packstring => sub { |
1014 | my ($self, $cb, $format) = @_; |
1121 | my ($self, $cb, $format) = @_; |
1015 | |
1122 | |
1016 | sub { |
1123 | sub { |
1017 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1124 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1018 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
1125 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
1019 | or return; |
1126 | or return; |
1020 | |
1127 | |
|
|
1128 | $format = length pack $format, $len; |
|
|
1129 | |
|
|
1130 | # bypass unshift if we already have the remaining chunk |
|
|
1131 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1132 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1133 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1134 | $cb->($_[0], $data); |
|
|
1135 | } else { |
1021 | # remove prefix |
1136 | # remove prefix |
1022 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
1137 | substr $_[0]{rbuf}, 0, $format, ""; |
1023 | |
1138 | |
1024 | # read rest |
1139 | # read remaining chunk |
1025 | $_[0]->unshift_read (chunk => $len, $cb); |
1140 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1141 | } |
1026 | |
1142 | |
1027 | 1 |
1143 | 1 |
1028 | } |
1144 | } |
1029 | }; |
1145 | }; |
1030 | |
1146 | |
… | |
… | |
1045 | the C<json> write type description, above, for an actual example. |
1161 | the C<json> write type description, above, for an actual example. |
1046 | |
1162 | |
1047 | =cut |
1163 | =cut |
1048 | |
1164 | |
1049 | register_read_type json => sub { |
1165 | register_read_type json => sub { |
1050 | my ($self, $cb, $accept, $reject, $skip) = @_; |
1166 | my ($self, $cb) = @_; |
1051 | |
1167 | |
1052 | require JSON; |
1168 | require JSON; |
1053 | |
1169 | |
1054 | my $data; |
1170 | my $data; |
1055 | my $rbuf = \$self->{rbuf}; |
1171 | my $rbuf = \$self->{rbuf}; |
… | |
… | |
1070 | () |
1186 | () |
1071 | } |
1187 | } |
1072 | } |
1188 | } |
1073 | }; |
1189 | }; |
1074 | |
1190 | |
|
|
1191 | =item storable => $cb->($handle, $ref) |
|
|
1192 | |
|
|
1193 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1194 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1195 | data). |
|
|
1196 | |
|
|
1197 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1198 | |
|
|
1199 | =cut |
|
|
1200 | |
|
|
1201 | register_read_type storable => sub { |
|
|
1202 | my ($self, $cb) = @_; |
|
|
1203 | |
|
|
1204 | require Storable; |
|
|
1205 | |
|
|
1206 | sub { |
|
|
1207 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1208 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1209 | or return; |
|
|
1210 | |
|
|
1211 | my $format = length pack "w", $len; |
|
|
1212 | |
|
|
1213 | # bypass unshift if we already have the remaining chunk |
|
|
1214 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1215 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1216 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1217 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1218 | } else { |
|
|
1219 | # remove prefix |
|
|
1220 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1221 | |
|
|
1222 | # read remaining chunk |
|
|
1223 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1224 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1225 | $cb->($_[0], $ref); |
|
|
1226 | } else { |
|
|
1227 | $self->_error (&Errno::EBADMSG); |
|
|
1228 | } |
|
|
1229 | }); |
|
|
1230 | } |
|
|
1231 | |
|
|
1232 | 1 |
|
|
1233 | } |
|
|
1234 | }; |
|
|
1235 | |
1075 | =back |
1236 | =back |
1076 | |
1237 | |
1077 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1238 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1078 | |
1239 | |
1079 | This function (not method) lets you add your own types to C<push_read>. |
1240 | This function (not method) lets you add your own types to C<push_read>. |
… | |
… | |
1106 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1267 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1107 | you change the C<on_read> callback or push/unshift a read callback, and it |
1268 | you change the C<on_read> callback or push/unshift a read callback, and it |
1108 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1269 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1109 | there are any read requests in the queue. |
1270 | there are any read requests in the queue. |
1110 | |
1271 | |
|
|
1272 | These methods will have no effect when in TLS mode (as TLS doesn't support |
|
|
1273 | half-duplex connections). |
|
|
1274 | |
1111 | =cut |
1275 | =cut |
1112 | |
1276 | |
1113 | sub stop_read { |
1277 | sub stop_read { |
1114 | my ($self) = @_; |
1278 | my ($self) = @_; |
1115 | |
1279 | |
1116 | delete $self->{_rw}; |
1280 | delete $self->{_rw} unless $self->{tls}; |
1117 | } |
1281 | } |
1118 | |
1282 | |
1119 | sub start_read { |
1283 | sub start_read { |
1120 | my ($self) = @_; |
1284 | my ($self) = @_; |
1121 | |
1285 | |
1122 | unless ($self->{_rw} || $self->{_eof}) { |
1286 | unless ($self->{_rw} || $self->{_eof}) { |
1123 | Scalar::Util::weaken $self; |
1287 | Scalar::Util::weaken $self; |
1124 | |
1288 | |
1125 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1289 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1126 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1290 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1127 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1291 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1128 | |
1292 | |
1129 | if ($len > 0) { |
1293 | if ($len > 0) { |
1130 | $self->{_activity} = AnyEvent->now; |
1294 | $self->{_activity} = AnyEvent->now; |
1131 | |
1295 | |
1132 | $self->{filter_r} |
1296 | if ($self->{tls}) { |
1133 | ? $self->{filter_r}($self, $rbuf) |
1297 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1134 | : $self->{_in_drain} || $self->_drain_rbuf; |
1298 | |
|
|
1299 | &_dotls ($self); |
|
|
1300 | } else { |
|
|
1301 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1302 | } |
1135 | |
1303 | |
1136 | } elsif (defined $len) { |
1304 | } elsif (defined $len) { |
1137 | delete $self->{_rw}; |
1305 | delete $self->{_rw}; |
1138 | $self->{_eof} = 1; |
1306 | $self->{_eof} = 1; |
1139 | $self->_drain_rbuf unless $self->{_in_drain}; |
1307 | $self->_drain_rbuf unless $self->{_in_drain}; |
… | |
… | |
1143 | } |
1311 | } |
1144 | }); |
1312 | }); |
1145 | } |
1313 | } |
1146 | } |
1314 | } |
1147 | |
1315 | |
|
|
1316 | # poll the write BIO and send the data if applicable |
1148 | sub _dotls { |
1317 | sub _dotls { |
1149 | my ($self) = @_; |
1318 | my ($self) = @_; |
1150 | |
1319 | |
1151 | my $buf; |
1320 | my $tmp; |
1152 | |
1321 | |
1153 | if (length $self->{_tls_wbuf}) { |
1322 | if (length $self->{_tls_wbuf}) { |
1154 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1323 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1155 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1324 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1156 | } |
1325 | } |
1157 | } |
1326 | } |
1158 | |
1327 | |
1159 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1160 | $self->{wbuf} .= $buf; |
|
|
1161 | $self->_drain_wbuf; |
|
|
1162 | } |
|
|
1163 | |
|
|
1164 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1328 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1165 | if (length $buf) { |
1329 | unless (length $tmp) { |
1166 | $self->{rbuf} .= $buf; |
|
|
1167 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1168 | } else { |
|
|
1169 | # let's treat SSL-eof as we treat normal EOF |
1330 | # let's treat SSL-eof as we treat normal EOF |
|
|
1331 | delete $self->{_rw}; |
1170 | $self->{_eof} = 1; |
1332 | $self->{_eof} = 1; |
1171 | $self->_shutdown; |
1333 | &_freetls; |
1172 | return; |
|
|
1173 | } |
1334 | } |
1174 | } |
|
|
1175 | |
1335 | |
|
|
1336 | $self->{rbuf} .= $tmp; |
|
|
1337 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1338 | $self->{tls} or return; # tls session might have gone away in callback |
|
|
1339 | } |
|
|
1340 | |
1176 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1341 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1177 | |
1342 | |
1178 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1343 | if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) { |
1179 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1344 | if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) { |
1180 | return $self->_error ($!, 1); |
1345 | return $self->_error ($!, 1); |
1181 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1346 | } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { |
1182 | return $self->_error (&Errno::EIO, 1); |
1347 | return $self->_error (&Errno::EIO, 1); |
1183 | } |
1348 | } |
1184 | |
1349 | |
1185 | # all others are fine for our purposes |
1350 | # all other errors are fine for our purposes |
|
|
1351 | } |
|
|
1352 | |
|
|
1353 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1354 | $self->{wbuf} .= $tmp; |
|
|
1355 | $self->_drain_wbuf; |
1186 | } |
1356 | } |
1187 | } |
1357 | } |
1188 | |
1358 | |
1189 | =item $handle->starttls ($tls[, $tls_ctx]) |
1359 | =item $handle->starttls ($tls[, $tls_ctx]) |
1190 | |
1360 | |
… | |
… | |
1200 | |
1370 | |
1201 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1371 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1202 | call and can be used or changed to your liking. Note that the handshake |
1372 | call and can be used or changed to your liking. Note that the handshake |
1203 | might have already started when this function returns. |
1373 | might have already started when this function returns. |
1204 | |
1374 | |
|
|
1375 | If it an error to start a TLS handshake more than once per |
|
|
1376 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
|
|
1377 | |
1205 | =cut |
1378 | =cut |
1206 | |
1379 | |
1207 | sub starttls { |
1380 | sub starttls { |
1208 | my ($self, $ssl, $ctx) = @_; |
1381 | my ($self, $ssl, $ctx) = @_; |
1209 | |
1382 | |
1210 | $self->stoptls; |
1383 | require Net::SSLeay; |
1211 | |
1384 | |
|
|
1385 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
|
|
1386 | if $self->{tls}; |
|
|
1387 | |
1212 | if ($ssl eq "accept") { |
1388 | if ($ssl eq "accept") { |
1213 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1389 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1214 | Net::SSLeay::set_accept_state ($ssl); |
1390 | Net::SSLeay::set_accept_state ($ssl); |
1215 | } elsif ($ssl eq "connect") { |
1391 | } elsif ($ssl eq "connect") { |
1216 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1392 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
… | |
… | |
1222 | # basically, this is deep magic (because SSL_read should have the same issues) |
1398 | # basically, this is deep magic (because SSL_read should have the same issues) |
1223 | # but the openssl maintainers basically said: "trust us, it just works". |
1399 | # but the openssl maintainers basically said: "trust us, it just works". |
1224 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1400 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1225 | # and mismaintained ssleay-module doesn't even offer them). |
1401 | # and mismaintained ssleay-module doesn't even offer them). |
1226 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1402 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1403 | # |
|
|
1404 | # in short: this is a mess. |
|
|
1405 | # |
|
|
1406 | # note that we do not try to keep the length constant between writes as we are required to do. |
|
|
1407 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
|
|
1408 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
|
|
1409 | # have identity issues in that area. |
1227 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1410 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1228 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1411 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1229 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1412 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1230 | |
1413 | |
1231 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1414 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1232 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1415 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1233 | |
1416 | |
1234 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1417 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1235 | |
1418 | |
1236 | $self->{filter_w} = sub { |
1419 | &_dotls; # need to trigger the initial handshake |
1237 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
1420 | $self->start_read; # make sure we actually do read |
1238 | &_dotls; |
|
|
1239 | }; |
|
|
1240 | $self->{filter_r} = sub { |
|
|
1241 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
|
|
1242 | &_dotls; |
|
|
1243 | }; |
|
|
1244 | } |
1421 | } |
1245 | |
1422 | |
1246 | =item $handle->stoptls |
1423 | =item $handle->stoptls |
1247 | |
1424 | |
1248 | Destroys the SSL connection, if any. Partial read or write data will be |
1425 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1249 | lost. |
1426 | sending a close notify to the other side, but since OpenSSL doesn't |
|
|
1427 | support non-blocking shut downs, it is not possible to re-use the stream |
|
|
1428 | afterwards. |
1250 | |
1429 | |
1251 | =cut |
1430 | =cut |
1252 | |
1431 | |
1253 | sub stoptls { |
1432 | sub stoptls { |
1254 | my ($self) = @_; |
1433 | my ($self) = @_; |
1255 | |
1434 | |
|
|
1435 | if ($self->{tls}) { |
|
|
1436 | Net::SSLeay::shutdown ($self->{tls}); |
|
|
1437 | |
|
|
1438 | &_dotls; |
|
|
1439 | |
|
|
1440 | # we don't give a shit. no, we do, but we can't. no... |
|
|
1441 | # we, we... have to use openssl :/ |
|
|
1442 | &_freetls; |
|
|
1443 | } |
|
|
1444 | } |
|
|
1445 | |
|
|
1446 | sub _freetls { |
|
|
1447 | my ($self) = @_; |
|
|
1448 | |
|
|
1449 | return unless $self->{tls}; |
|
|
1450 | |
1256 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1451 | Net::SSLeay::free (delete $self->{tls}); |
1257 | |
1452 | |
1258 | delete $self->{_rbio}; |
1453 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1259 | delete $self->{_wbio}; |
|
|
1260 | delete $self->{_tls_wbuf}; |
|
|
1261 | delete $self->{filter_r}; |
|
|
1262 | delete $self->{filter_w}; |
|
|
1263 | } |
1454 | } |
1264 | |
1455 | |
1265 | sub DESTROY { |
1456 | sub DESTROY { |
1266 | my $self = shift; |
1457 | my $self = shift; |
1267 | |
1458 | |
1268 | $self->stoptls; |
1459 | &_freetls; |
1269 | |
1460 | |
1270 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1461 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1271 | |
1462 | |
1272 | if ($linger && length $self->{wbuf}) { |
1463 | if ($linger && length $self->{wbuf}) { |
1273 | my $fh = delete $self->{fh}; |
1464 | my $fh = delete $self->{fh}; |
… | |
… | |
1288 | @linger = (); |
1479 | @linger = (); |
1289 | }); |
1480 | }); |
1290 | } |
1481 | } |
1291 | } |
1482 | } |
1292 | |
1483 | |
|
|
1484 | =item $handle->destroy |
|
|
1485 | |
|
|
1486 | Shuts down the handle object as much as possible - this call ensures that |
|
|
1487 | no further callbacks will be invoked and resources will be freed as much |
|
|
1488 | as possible. You must not call any methods on the object afterwards. |
|
|
1489 | |
|
|
1490 | Normally, you can just "forget" any references to an AnyEvent::Handle |
|
|
1491 | object and it will simply shut down. This works in fatal error and EOF |
|
|
1492 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
|
|
1493 | callback, so when you want to destroy the AnyEvent::Handle object from |
|
|
1494 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
|
|
1495 | that case. |
|
|
1496 | |
|
|
1497 | The handle might still linger in the background and write out remaining |
|
|
1498 | data, as specified by the C<linger> option, however. |
|
|
1499 | |
|
|
1500 | =cut |
|
|
1501 | |
|
|
1502 | sub destroy { |
|
|
1503 | my ($self) = @_; |
|
|
1504 | |
|
|
1505 | $self->DESTROY; |
|
|
1506 | %$self = (); |
|
|
1507 | } |
|
|
1508 | |
1293 | =item AnyEvent::Handle::TLS_CTX |
1509 | =item AnyEvent::Handle::TLS_CTX |
1294 | |
1510 | |
1295 | This function creates and returns the Net::SSLeay::CTX object used by |
1511 | This function creates and returns the Net::SSLeay::CTX object used by |
1296 | default for TLS mode. |
1512 | default for TLS mode. |
1297 | |
1513 | |
… | |
… | |
1325 | } |
1541 | } |
1326 | } |
1542 | } |
1327 | |
1543 | |
1328 | =back |
1544 | =back |
1329 | |
1545 | |
|
|
1546 | |
|
|
1547 | =head1 NONFREQUENTLY ASKED QUESTIONS |
|
|
1548 | |
|
|
1549 | =over 4 |
|
|
1550 | |
|
|
1551 | =item I C<undef> the AnyEvent::Handle reference inside my callback and |
|
|
1552 | still get further invocations! |
|
|
1553 | |
|
|
1554 | That's because AnyEvent::Handle keeps a reference to itself when handling |
|
|
1555 | read or write callbacks. |
|
|
1556 | |
|
|
1557 | It is only safe to "forget" the reference inside EOF or error callbacks, |
|
|
1558 | from within all other callbacks, you need to explicitly call the C<< |
|
|
1559 | ->destroy >> method. |
|
|
1560 | |
|
|
1561 | =item I get different callback invocations in TLS mode/Why can't I pause |
|
|
1562 | reading? |
|
|
1563 | |
|
|
1564 | Unlike, say, TCP, TLS connections do not consist of two independent |
|
|
1565 | communication channels, one for each direction. Or put differently. The |
|
|
1566 | read and write directions are not independent of each other: you cannot |
|
|
1567 | write data unless you are also prepared to read, and vice versa. |
|
|
1568 | |
|
|
1569 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
|
|
1570 | callback invocations when you are not expecting any read data - the reason |
|
|
1571 | is that AnyEvent::Handle always reads in TLS mode. |
|
|
1572 | |
|
|
1573 | During the connection, you have to make sure that you always have a |
|
|
1574 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
|
|
1575 | connection (or when you no longer want to use it) you can call the |
|
|
1576 | C<destroy> method. |
|
|
1577 | |
|
|
1578 | =item How do I read data until the other side closes the connection? |
|
|
1579 | |
|
|
1580 | If you just want to read your data into a perl scalar, the easiest way |
|
|
1581 | to achieve this is by setting an C<on_read> callback that does nothing, |
|
|
1582 | clearing the C<on_eof> callback and in the C<on_error> callback, the data |
|
|
1583 | will be in C<$_[0]{rbuf}>: |
|
|
1584 | |
|
|
1585 | $handle->on_read (sub { }); |
|
|
1586 | $handle->on_eof (undef); |
|
|
1587 | $handle->on_error (sub { |
|
|
1588 | my $data = delete $_[0]{rbuf}; |
|
|
1589 | undef $handle; |
|
|
1590 | }); |
|
|
1591 | |
|
|
1592 | The reason to use C<on_error> is that TCP connections, due to latencies |
|
|
1593 | and packets loss, might get closed quite violently with an error, when in |
|
|
1594 | fact, all data has been received. |
|
|
1595 | |
|
|
1596 | It is usually better to use acknowledgements when transferring data, |
|
|
1597 | to make sure the other side hasn't just died and you got the data |
|
|
1598 | intact. This is also one reason why so many internet protocols have an |
|
|
1599 | explicit QUIT command. |
|
|
1600 | |
|
|
1601 | =item I don't want to destroy the handle too early - how do I wait until |
|
|
1602 | all data has been written? |
|
|
1603 | |
|
|
1604 | After writing your last bits of data, set the C<on_drain> callback |
|
|
1605 | and destroy the handle in there - with the default setting of |
|
|
1606 | C<low_water_mark> this will be called precisely when all data has been |
|
|
1607 | written to the socket: |
|
|
1608 | |
|
|
1609 | $handle->push_write (...); |
|
|
1610 | $handle->on_drain (sub { |
|
|
1611 | warn "all data submitted to the kernel\n"; |
|
|
1612 | undef $handle; |
|
|
1613 | }); |
|
|
1614 | |
|
|
1615 | =back |
|
|
1616 | |
|
|
1617 | |
1330 | =head1 SUBCLASSING AnyEvent::Handle |
1618 | =head1 SUBCLASSING AnyEvent::Handle |
1331 | |
1619 | |
1332 | In many cases, you might want to subclass AnyEvent::Handle. |
1620 | In many cases, you might want to subclass AnyEvent::Handle. |
1333 | |
1621 | |
1334 | To make this easier, a given version of AnyEvent::Handle uses these |
1622 | To make this easier, a given version of AnyEvent::Handle uses these |
… | |
… | |
1337 | =over 4 |
1625 | =over 4 |
1338 | |
1626 | |
1339 | =item * all constructor arguments become object members. |
1627 | =item * all constructor arguments become object members. |
1340 | |
1628 | |
1341 | At least initially, when you pass a C<tls>-argument to the constructor it |
1629 | At least initially, when you pass a C<tls>-argument to the constructor it |
1342 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1630 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1343 | mutated later on (for example C<tls> will hold the TLS connection object). |
1631 | mutated later on (for example C<tls> will hold the TLS connection object). |
1344 | |
1632 | |
1345 | =item * other object member names are prefixed with an C<_>. |
1633 | =item * other object member names are prefixed with an C<_>. |
1346 | |
1634 | |
1347 | All object members not explicitly documented (internal use) are prefixed |
1635 | All object members not explicitly documented (internal use) are prefixed |