… | |
… | |
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.22; |
19 | our $VERSION = 4.3; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
49 | |
49 | |
50 | This module is a helper module to make it easier to do event-based I/O on |
50 | This module is a helper module to make it easier to do event-based I/O on |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
52 | on sockets see L<AnyEvent::Util>. |
52 | on sockets see L<AnyEvent::Util>. |
53 | |
53 | |
|
|
54 | The L<AnyEvent::Intro> tutorial contains some well-documented |
|
|
55 | AnyEvent::Handle examples. |
|
|
56 | |
54 | In the following, when the documentation refers to of "bytes" then this |
57 | In the following, when the documentation refers to of "bytes" then this |
55 | means characters. As sysread and syswrite are used for all I/O, their |
58 | means characters. As sysread and syswrite are used for all I/O, their |
56 | treatment of characters applies to this module as well. |
59 | treatment of characters applies to this module as well. |
57 | |
60 | |
58 | All callbacks will be invoked with the handle object as their first |
61 | All callbacks will be invoked with the handle object as their first |
59 | argument. |
62 | argument. |
60 | |
63 | |
|
|
64 | =head2 SIGPIPE is not handled by this module |
|
|
65 | |
|
|
66 | SIGPIPE is not handled by this module, so one of the practical |
|
|
67 | requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} = |
|
|
68 | 'IGNORE'>). At least, this is highly recommend in a networked program: If |
|
|
69 | you use AnyEvent::Handle in a filter program (like sort), exiting on |
|
|
70 | SIGPIPE is probably the right thing to do. |
|
|
71 | |
61 | =head1 METHODS |
72 | =head1 METHODS |
62 | |
73 | |
63 | =over 4 |
74 | =over 4 |
64 | |
75 | |
65 | =item B<new (%args)> |
76 | =item B<new (%args)> |
… | |
… | |
70 | |
81 | |
71 | =item fh => $filehandle [MANDATORY] |
82 | =item fh => $filehandle [MANDATORY] |
72 | |
83 | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
84 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
85 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
86 | NOTE: The filehandle will be set to non-blocking mode (using |
76 | AnyEvent::Util::fh_nonblocking). |
87 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
88 | that mode. |
77 | |
89 | |
78 | =item on_eof => $cb->($handle) |
90 | =item on_eof => $cb->($handle) |
79 | |
91 | |
80 | Set the callback to be called when an end-of-file condition is detected, |
92 | 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 |
93 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
94 | connection cleanly. |
83 | |
95 | |
|
|
96 | For sockets, this just means that the other side has stopped sending data, |
|
|
97 | you can still try to write data, and, in fact, one can return from the eof |
|
|
98 | callback and continue writing data, as only the read part has been shut |
|
|
99 | down. |
|
|
100 | |
84 | While not mandatory, it is I<highly> recommended to set an eof callback, |
101 | 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 |
102 | otherwise you might end up with a closed socket while you are still |
86 | waiting for data. |
103 | waiting for data. |
87 | |
104 | |
88 | If an EOF condition has been detected but no C<on_eof> callback has been |
105 | If an EOF condition has been detected but no C<on_eof> callback has been |
… | |
… | |
93 | This is the error callback, which is called when, well, some error |
110 | This is the error callback, which is called when, well, some error |
94 | occured, such as not being able to resolve the hostname, failure to |
111 | occured, such as not being able to resolve the hostname, failure to |
95 | connect or a read error. |
112 | connect or a read error. |
96 | |
113 | |
97 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
114 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
98 | fatal errors the handle object will be shut down and will not be |
115 | fatal errors the handle object will be shut down and will not be usable |
|
|
116 | (but you are free to look at the current C<< ->rbuf >>). Examples of fatal |
|
|
117 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
118 | (C<EPIPE>) or I/O errors. |
|
|
119 | |
99 | usable. Non-fatal errors can be retried by simply returning, but it is |
120 | Non-fatal errors can be retried by simply returning, but it is recommended |
100 | recommended to simply ignore this parameter and instead abondon the handle |
121 | to simply ignore this parameter and instead abondon the handle object |
101 | object when this callback is invoked. |
122 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
123 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
102 | |
124 | |
103 | On callback entrance, the value of C<$!> contains the operating system |
125 | On callback entrance, the value of C<$!> contains the operating system |
104 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
126 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
105 | |
127 | |
106 | While not mandatory, it is I<highly> recommended to set this callback, as |
128 | While not mandatory, it is I<highly> recommended to set this callback, as |
… | |
… | |
138 | =item timeout => $fractional_seconds |
160 | =item timeout => $fractional_seconds |
139 | |
161 | |
140 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
162 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
141 | seconds pass without a successful read or write on the underlying file |
163 | seconds pass without a successful read or write on the underlying file |
142 | handle, the C<on_timeout> callback will be invoked (and if that one is |
164 | handle, the C<on_timeout> callback will be invoked (and if that one is |
143 | missing, an C<ETIMEDOUT> error will be raised). |
165 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
144 | |
166 | |
145 | Note that timeout processing is also active when you currently do not have |
167 | Note that timeout processing is also active when you currently do not have |
146 | any outstanding read or write requests: If you plan to keep the connection |
168 | any outstanding read or write requests: If you plan to keep the connection |
147 | idle then you should disable the timout temporarily or ignore the timeout |
169 | idle then you should disable the timout temporarily or ignore the timeout |
148 | in the C<on_timeout> callback. |
170 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
|
|
171 | restart the timeout. |
149 | |
172 | |
150 | Zero (the default) disables this timeout. |
173 | Zero (the default) disables this timeout. |
151 | |
174 | |
152 | =item on_timeout => $cb->($handle) |
175 | =item on_timeout => $cb->($handle) |
153 | |
176 | |
… | |
… | |
157 | |
180 | |
158 | =item rbuf_max => <bytes> |
181 | =item rbuf_max => <bytes> |
159 | |
182 | |
160 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
183 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
161 | when the read buffer ever (strictly) exceeds this size. This is useful to |
184 | when the read buffer ever (strictly) exceeds this size. This is useful to |
162 | avoid denial-of-service attacks. |
185 | avoid some forms of denial-of-service attacks. |
163 | |
186 | |
164 | For example, a server accepting connections from untrusted sources should |
187 | For example, a server accepting connections from untrusted sources should |
165 | be configured to accept only so-and-so much data that it cannot act on |
188 | be configured to accept only so-and-so much data that it cannot act on |
166 | (for example, when expecting a line, an attacker could send an unlimited |
189 | (for example, when expecting a line, an attacker could send an unlimited |
167 | amount of data without a callback ever being called as long as the line |
190 | amount of data without a callback ever being called as long as the line |
168 | isn't finished). |
191 | isn't finished). |
169 | |
192 | |
170 | =item autocork => <boolean> |
193 | =item autocork => <boolean> |
171 | |
194 | |
172 | When disabled (the default), then C<push_write> will try to immediately |
195 | When disabled (the default), then C<push_write> will try to immediately |
173 | write the data to the handle if possible. This avoids having to register |
196 | write the data to the handle, if possible. This avoids having to register |
174 | a write watcher and wait for the next event loop iteration, but can be |
197 | a write watcher and wait for the next event loop iteration, but can |
175 | inefficient if you write multiple small chunks (this disadvantage is |
198 | be inefficient if you write multiple small chunks (on the wire, this |
176 | usually avoided by your kernel's nagle algorithm, see C<low_delay>). |
199 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
|
|
200 | C<no_delay>, but this option can save costly syscalls). |
177 | |
201 | |
178 | When enabled, then writes will always be queued till the next event loop |
202 | When enabled, then writes will always be queued till the next event loop |
179 | iteration. This is efficient when you do many small writes per iteration, |
203 | iteration. This is efficient when you do many small writes per iteration, |
180 | but less efficient when you do a single write only. |
204 | but less efficient when you do a single write only per iteration (or when |
|
|
205 | the write buffer often is full). It also increases write latency. |
181 | |
206 | |
182 | =item no_delay => <boolean> |
207 | =item no_delay => <boolean> |
183 | |
208 | |
184 | When doing small writes on sockets, your operating system kernel might |
209 | When doing small writes on sockets, your operating system kernel might |
185 | wait a bit for more data before actually sending it out. This is called |
210 | wait a bit for more data before actually sending it out. This is called |
186 | the Nagle algorithm, and usually it is beneficial. |
211 | the Nagle algorithm, and usually it is beneficial. |
187 | |
212 | |
188 | In some situations you want as low a delay as possible, which cna be |
213 | In some situations you want as low a delay as possible, which can be |
189 | accomplishd by setting this option to true. |
214 | accomplishd by setting this option to a true value. |
190 | |
215 | |
191 | The default is your opertaing system's default behaviour, this option |
216 | The default is your opertaing system's default behaviour (most likely |
192 | explicitly enables or disables it, if possible. |
217 | enabled), this option explicitly enables or disables it, if possible. |
193 | |
218 | |
194 | =item read_size => <bytes> |
219 | =item read_size => <bytes> |
195 | |
220 | |
196 | The default read block size (the amount of bytes this module will try to read |
221 | The default read block size (the amount of bytes this module will |
197 | during each (loop iteration). Default: C<8192>. |
222 | try to read during each loop iteration, which affects memory |
|
|
223 | requirements). Default: C<8192>. |
198 | |
224 | |
199 | =item low_water_mark => <bytes> |
225 | =item low_water_mark => <bytes> |
200 | |
226 | |
201 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
227 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
202 | buffer: If the write reaches this size or gets even samller it is |
228 | buffer: If the write reaches this size or gets even samller it is |
203 | considered empty. |
229 | considered empty. |
204 | |
230 | |
|
|
231 | Sometimes it can be beneficial (for performance reasons) to add data to |
|
|
232 | the write buffer before it is fully drained, but this is a rare case, as |
|
|
233 | the operating system kernel usually buffers data as well, so the default |
|
|
234 | is good in almost all cases. |
|
|
235 | |
205 | =item linger => <seconds> |
236 | =item linger => <seconds> |
206 | |
237 | |
207 | If non-zero (default: C<3600>), then the destructor of the |
238 | If non-zero (default: C<3600>), then the destructor of the |
208 | AnyEvent::Handle object will check wether there is still outstanding write |
239 | AnyEvent::Handle object will check whether there is still outstanding |
209 | data and will install a watcher that will write out this data. No errors |
240 | write data and will install a watcher that will write this data to the |
210 | will be reported (this mostly matches how the operating system treats |
241 | socket. No errors will be reported (this mostly matches how the operating |
211 | outstanding data at socket close time). |
242 | system treats outstanding data at socket close time). |
212 | |
243 | |
213 | This will not work for partial TLS data that could not yet been |
244 | This will not work for partial TLS data that could not be encoded |
214 | encoded. This data will be lost. |
245 | yet. This data will be lost. Calling the C<stoptls> method in time might |
|
|
246 | help. |
215 | |
247 | |
216 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
248 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
217 | |
249 | |
218 | When this parameter is given, it enables TLS (SSL) mode, that means it |
250 | When this parameter is given, it enables TLS (SSL) mode, that means |
219 | will start making tls handshake and will transparently encrypt/decrypt |
251 | AnyEvent will start a TLS handshake as soon as the conenction has been |
220 | data. |
252 | established and will transparently encrypt/decrypt data afterwards. |
221 | |
253 | |
222 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
254 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
223 | automatically when you try to create a TLS handle). |
255 | automatically when you try to create a TLS handle): this module doesn't |
|
|
256 | have a dependency on that module, so if your module requires it, you have |
|
|
257 | to add the dependency yourself. |
224 | |
258 | |
225 | For the TLS server side, use C<accept>, and for the TLS client side of a |
259 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
226 | connection, use C<connect> mode. |
260 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
261 | mode. |
227 | |
262 | |
228 | You can also provide your own TLS connection object, but you have |
263 | You can also provide your own TLS connection object, but you have |
229 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
264 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
230 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
265 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
231 | AnyEvent::Handle. |
266 | AnyEvent::Handle. |
232 | |
267 | |
233 | See the C<starttls> method if you need to start TLS negotiation later. |
268 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
234 | |
269 | |
235 | =item tls_ctx => $ssl_ctx |
270 | =item tls_ctx => $ssl_ctx |
236 | |
271 | |
237 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
272 | Use the given C<Net::SSLeay::CTX> object to create the new TLS connection |
238 | (unless a connection object was specified directly). If this parameter is |
273 | (unless a connection object was specified directly). If this parameter is |
239 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
274 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
240 | |
275 | |
241 | =item json => JSON or JSON::XS object |
276 | =item json => JSON or JSON::XS object |
242 | |
277 | |
243 | This is the json coder object used by the C<json> read and write types. |
278 | This is the json coder object used by the C<json> read and write types. |
244 | |
279 | |
245 | If you don't supply it, then AnyEvent::Handle will create and use a |
280 | If you don't supply it, then AnyEvent::Handle will create and use a |
246 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
281 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
282 | texts. |
247 | |
283 | |
248 | Note that you are responsible to depend on the JSON module if you want to |
284 | Note that you are responsible to depend on the JSON module if you want to |
249 | use this functionality, as AnyEvent does not have a dependency itself. |
285 | use this functionality, as AnyEvent does not have a dependency itself. |
250 | |
286 | |
251 | =item filter_r => $cb |
|
|
252 | |
|
|
253 | =item filter_w => $cb |
|
|
254 | |
|
|
255 | These exist, but are undocumented at this time. |
|
|
256 | |
|
|
257 | =back |
287 | =back |
258 | |
288 | |
259 | =cut |
289 | =cut |
260 | |
290 | |
261 | sub new { |
291 | sub new { |
… | |
… | |
265 | |
295 | |
266 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
296 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
267 | |
297 | |
268 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
298 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
269 | |
299 | |
270 | if ($self->{tls}) { |
|
|
271 | require Net::SSLeay; |
|
|
272 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
300 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
273 | } |
301 | if $self->{tls}; |
274 | |
302 | |
275 | $self->{_activity} = AnyEvent->now; |
303 | $self->{_activity} = AnyEvent->now; |
276 | $self->_timeout; |
304 | $self->_timeout; |
277 | |
305 | |
278 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
306 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
… | |
… | |
290 | delete $self->{_tw}; |
318 | delete $self->{_tw}; |
291 | delete $self->{_rw}; |
319 | delete $self->{_rw}; |
292 | delete $self->{_ww}; |
320 | delete $self->{_ww}; |
293 | delete $self->{fh}; |
321 | delete $self->{fh}; |
294 | |
322 | |
295 | $self->stoptls; |
323 | &_freetls; |
|
|
324 | |
|
|
325 | delete $self->{on_read}; |
|
|
326 | delete $self->{_queue}; |
296 | } |
327 | } |
297 | |
328 | |
298 | sub _error { |
329 | sub _error { |
299 | my ($self, $errno, $fatal) = @_; |
330 | my ($self, $errno, $fatal) = @_; |
300 | |
331 | |
… | |
… | |
310 | } |
341 | } |
311 | } |
342 | } |
312 | |
343 | |
313 | =item $fh = $handle->fh |
344 | =item $fh = $handle->fh |
314 | |
345 | |
315 | This method returns the file handle of the L<AnyEvent::Handle> object. |
346 | This method returns the file handle used to create the L<AnyEvent::Handle> object. |
316 | |
347 | |
317 | =cut |
348 | =cut |
318 | |
349 | |
319 | sub fh { $_[0]{fh} } |
350 | sub fh { $_[0]{fh} } |
320 | |
351 | |
… | |
… | |
338 | $_[0]{on_eof} = $_[1]; |
369 | $_[0]{on_eof} = $_[1]; |
339 | } |
370 | } |
340 | |
371 | |
341 | =item $handle->on_timeout ($cb) |
372 | =item $handle->on_timeout ($cb) |
342 | |
373 | |
343 | Replace the current C<on_timeout> callback, or disables the callback |
374 | Replace the current C<on_timeout> callback, or disables the callback (but |
344 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
375 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
345 | argument. |
376 | argument and method. |
346 | |
377 | |
347 | =cut |
378 | =cut |
348 | |
379 | |
349 | sub on_timeout { |
380 | sub on_timeout { |
350 | $_[0]{on_timeout} = $_[1]; |
381 | $_[0]{on_timeout} = $_[1]; |
… | |
… | |
456 | my ($self, $cb) = @_; |
487 | my ($self, $cb) = @_; |
457 | |
488 | |
458 | $self->{on_drain} = $cb; |
489 | $self->{on_drain} = $cb; |
459 | |
490 | |
460 | $cb->($self) |
491 | $cb->($self) |
461 | if $cb && $self->{low_water_mark} >= length $self->{wbuf}; |
492 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
462 | } |
493 | } |
463 | |
494 | |
464 | =item $handle->push_write ($data) |
495 | =item $handle->push_write ($data) |
465 | |
496 | |
466 | Queues the given scalar to be written. You can push as much data as you |
497 | Queues the given scalar to be written. You can push as much data as you |
… | |
… | |
483 | substr $self->{wbuf}, 0, $len, ""; |
514 | substr $self->{wbuf}, 0, $len, ""; |
484 | |
515 | |
485 | $self->{_activity} = AnyEvent->now; |
516 | $self->{_activity} = AnyEvent->now; |
486 | |
517 | |
487 | $self->{on_drain}($self) |
518 | $self->{on_drain}($self) |
488 | if $self->{low_water_mark} >= length $self->{wbuf} |
519 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
489 | && $self->{on_drain}; |
520 | && $self->{on_drain}; |
490 | |
521 | |
491 | delete $self->{_ww} unless length $self->{wbuf}; |
522 | delete $self->{_ww} unless length $self->{wbuf}; |
492 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
523 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
493 | $self->_error ($!, 1); |
524 | $self->_error ($!, 1); |
… | |
… | |
517 | |
548 | |
518 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
549 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
519 | ->($self, @_); |
550 | ->($self, @_); |
520 | } |
551 | } |
521 | |
552 | |
522 | if ($self->{filter_w}) { |
553 | if ($self->{tls}) { |
523 | $self->{filter_w}($self, \$_[0]); |
554 | $self->{_tls_wbuf} .= $_[0]; |
|
|
555 | &_dotls ($self); |
524 | } else { |
556 | } else { |
525 | $self->{wbuf} .= $_[0]; |
557 | $self->{wbuf} .= $_[0]; |
526 | $self->_drain_wbuf; |
558 | $self->_drain_wbuf; |
527 | } |
559 | } |
528 | } |
560 | } |
… | |
… | |
729 | |
761 | |
730 | if ( |
762 | if ( |
731 | defined $self->{rbuf_max} |
763 | defined $self->{rbuf_max} |
732 | && $self->{rbuf_max} < length $self->{rbuf} |
764 | && $self->{rbuf_max} < length $self->{rbuf} |
733 | ) { |
765 | ) { |
734 | return $self->_error (&Errno::ENOSPC, 1); |
766 | $self->_error (&Errno::ENOSPC, 1), return; |
735 | } |
767 | } |
736 | |
768 | |
737 | while () { |
769 | while () { |
738 | my $len = length $self->{rbuf}; |
770 | my $len = length $self->{rbuf}; |
739 | |
771 | |
740 | if (my $cb = shift @{ $self->{_queue} }) { |
772 | if (my $cb = shift @{ $self->{_queue} }) { |
741 | unless ($cb->($self)) { |
773 | unless ($cb->($self)) { |
742 | if ($self->{_eof}) { |
774 | if ($self->{_eof}) { |
743 | # no progress can be made (not enough data and no data forthcoming) |
775 | # no progress can be made (not enough data and no data forthcoming) |
744 | $self->_error (&Errno::EPIPE, 1), last; |
776 | $self->_error (&Errno::EPIPE, 1), return; |
745 | } |
777 | } |
746 | |
778 | |
747 | unshift @{ $self->{_queue} }, $cb; |
779 | unshift @{ $self->{_queue} }, $cb; |
748 | last; |
780 | last; |
749 | } |
781 | } |
… | |
… | |
757 | && !@{ $self->{_queue} } # and the queue is still empty |
789 | && !@{ $self->{_queue} } # and the queue is still empty |
758 | && $self->{on_read} # but we still have on_read |
790 | && $self->{on_read} # but we still have on_read |
759 | ) { |
791 | ) { |
760 | # no further data will arrive |
792 | # no further data will arrive |
761 | # so no progress can be made |
793 | # so no progress can be made |
762 | $self->_error (&Errno::EPIPE, 1), last |
794 | $self->_error (&Errno::EPIPE, 1), return |
763 | if $self->{_eof}; |
795 | if $self->{_eof}; |
764 | |
796 | |
765 | last; # more data might arrive |
797 | last; # more data might arrive |
766 | } |
798 | } |
767 | } else { |
799 | } else { |
768 | # read side becomes idle |
800 | # read side becomes idle |
769 | delete $self->{_rw}; |
801 | delete $self->{_rw} unless $self->{tls}; |
770 | last; |
802 | last; |
771 | } |
803 | } |
772 | } |
804 | } |
773 | |
805 | |
774 | if ($self->{_eof}) { |
806 | if ($self->{_eof}) { |
… | |
… | |
1232 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1264 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1233 | you change the C<on_read> callback or push/unshift a read callback, and it |
1265 | you change the C<on_read> callback or push/unshift a read callback, and it |
1234 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1266 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1235 | there are any read requests in the queue. |
1267 | there are any read requests in the queue. |
1236 | |
1268 | |
|
|
1269 | These methods will have no effect when in TLS mode (as TLS doesn't support |
|
|
1270 | half-duplex connections). |
|
|
1271 | |
1237 | =cut |
1272 | =cut |
1238 | |
1273 | |
1239 | sub stop_read { |
1274 | sub stop_read { |
1240 | my ($self) = @_; |
1275 | my ($self) = @_; |
1241 | |
1276 | |
1242 | delete $self->{_rw}; |
1277 | delete $self->{_rw} unless $self->{tls}; |
1243 | } |
1278 | } |
1244 | |
1279 | |
1245 | sub start_read { |
1280 | sub start_read { |
1246 | my ($self) = @_; |
1281 | my ($self) = @_; |
1247 | |
1282 | |
1248 | unless ($self->{_rw} || $self->{_eof}) { |
1283 | unless ($self->{_rw} || $self->{_eof}) { |
1249 | Scalar::Util::weaken $self; |
1284 | Scalar::Util::weaken $self; |
1250 | |
1285 | |
1251 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1286 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1252 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1287 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1253 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1288 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1254 | |
1289 | |
1255 | if ($len > 0) { |
1290 | if ($len > 0) { |
1256 | $self->{_activity} = AnyEvent->now; |
1291 | $self->{_activity} = AnyEvent->now; |
1257 | |
1292 | |
1258 | $self->{filter_r} |
1293 | if ($self->{tls}) { |
1259 | ? $self->{filter_r}($self, $rbuf) |
1294 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1260 | : $self->{_in_drain} || $self->_drain_rbuf; |
1295 | &_dotls ($self); |
|
|
1296 | } else { |
|
|
1297 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1298 | } |
1261 | |
1299 | |
1262 | } elsif (defined $len) { |
1300 | } elsif (defined $len) { |
1263 | delete $self->{_rw}; |
1301 | delete $self->{_rw}; |
1264 | $self->{_eof} = 1; |
1302 | $self->{_eof} = 1; |
1265 | $self->_drain_rbuf unless $self->{_in_drain}; |
1303 | $self->_drain_rbuf unless $self->{_in_drain}; |
… | |
… | |
1280 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1318 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1281 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1319 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1282 | } |
1320 | } |
1283 | } |
1321 | } |
1284 | |
1322 | |
1285 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1286 | $self->{wbuf} .= $buf; |
|
|
1287 | $self->_drain_wbuf; |
|
|
1288 | } |
|
|
1289 | |
|
|
1290 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1323 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1291 | if (length $buf) { |
1324 | unless (length $buf) { |
1292 | $self->{rbuf} .= $buf; |
|
|
1293 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1294 | } else { |
|
|
1295 | # let's treat SSL-eof as we treat normal EOF |
1325 | # let's treat SSL-eof as we treat normal EOF |
|
|
1326 | delete $self->{_rw}; |
1296 | $self->{_eof} = 1; |
1327 | $self->{_eof} = 1; |
1297 | $self->_shutdown; |
1328 | &_freetls; |
1298 | return; |
|
|
1299 | } |
1329 | } |
|
|
1330 | |
|
|
1331 | $self->{rbuf} .= $buf; |
|
|
1332 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1333 | $self->{tls} or return; # tls session might have gone away in callback |
1300 | } |
1334 | } |
1301 | |
1335 | |
1302 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1336 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1303 | |
1337 | |
1304 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1338 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
… | |
… | |
1308 | return $self->_error (&Errno::EIO, 1); |
1342 | return $self->_error (&Errno::EIO, 1); |
1309 | } |
1343 | } |
1310 | |
1344 | |
1311 | # all others are fine for our purposes |
1345 | # all others are fine for our purposes |
1312 | } |
1346 | } |
|
|
1347 | |
|
|
1348 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1349 | $self->{wbuf} .= $buf; |
|
|
1350 | $self->_drain_wbuf; |
|
|
1351 | } |
1313 | } |
1352 | } |
1314 | |
1353 | |
1315 | =item $handle->starttls ($tls[, $tls_ctx]) |
1354 | =item $handle->starttls ($tls[, $tls_ctx]) |
1316 | |
1355 | |
1317 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1356 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
… | |
… | |
1326 | |
1365 | |
1327 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1366 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1328 | call and can be used or changed to your liking. Note that the handshake |
1367 | call and can be used or changed to your liking. Note that the handshake |
1329 | might have already started when this function returns. |
1368 | might have already started when this function returns. |
1330 | |
1369 | |
|
|
1370 | If it an error to start a TLS handshake more than once per |
|
|
1371 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
|
|
1372 | |
1331 | =cut |
1373 | =cut |
1332 | |
1374 | |
1333 | sub starttls { |
1375 | sub starttls { |
1334 | my ($self, $ssl, $ctx) = @_; |
1376 | my ($self, $ssl, $ctx) = @_; |
1335 | |
1377 | |
1336 | $self->stoptls; |
1378 | require Net::SSLeay; |
1337 | |
1379 | |
|
|
1380 | Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object" |
|
|
1381 | if $self->{tls}; |
|
|
1382 | |
1338 | if ($ssl eq "accept") { |
1383 | if ($ssl eq "accept") { |
1339 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1384 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1340 | Net::SSLeay::set_accept_state ($ssl); |
1385 | Net::SSLeay::set_accept_state ($ssl); |
1341 | } elsif ($ssl eq "connect") { |
1386 | } elsif ($ssl eq "connect") { |
1342 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1387 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
… | |
… | |
1348 | # basically, this is deep magic (because SSL_read should have the same issues) |
1393 | # basically, this is deep magic (because SSL_read should have the same issues) |
1349 | # but the openssl maintainers basically said: "trust us, it just works". |
1394 | # but the openssl maintainers basically said: "trust us, it just works". |
1350 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1395 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1351 | # and mismaintained ssleay-module doesn't even offer them). |
1396 | # and mismaintained ssleay-module doesn't even offer them). |
1352 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1397 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1398 | # |
|
|
1399 | # in short: this is a mess. |
|
|
1400 | # |
|
|
1401 | # note that we do not try to keep the length constant between writes as we are required to do. |
|
|
1402 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
|
|
1403 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
|
|
1404 | # have identity issues in that area. |
1353 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1405 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1354 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1406 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1355 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1407 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1356 | |
1408 | |
1357 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1409 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1358 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1410 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1359 | |
1411 | |
1360 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1412 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1361 | |
1413 | |
1362 | $self->{filter_w} = sub { |
1414 | &_dotls; # need to trigger the initial handshake |
1363 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
1415 | $self->start_read; # make sure we actually do read |
1364 | &_dotls; |
|
|
1365 | }; |
|
|
1366 | $self->{filter_r} = sub { |
|
|
1367 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
|
|
1368 | &_dotls; |
|
|
1369 | }; |
|
|
1370 | } |
1416 | } |
1371 | |
1417 | |
1372 | =item $handle->stoptls |
1418 | =item $handle->stoptls |
1373 | |
1419 | |
1374 | Destroys the SSL connection, if any. Partial read or write data will be |
1420 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1375 | lost. |
1421 | sending a close notify to the other side, but since OpenSSL doesn't |
|
|
1422 | support non-blocking shut downs, it is not possible to re-use the stream |
|
|
1423 | afterwards. |
1376 | |
1424 | |
1377 | =cut |
1425 | =cut |
1378 | |
1426 | |
1379 | sub stoptls { |
1427 | sub stoptls { |
1380 | my ($self) = @_; |
1428 | my ($self) = @_; |
1381 | |
1429 | |
|
|
1430 | if ($self->{tls}) { |
|
|
1431 | Net::SSLeay::shutdown ($self->{tls}); |
|
|
1432 | |
|
|
1433 | &_dotls; |
|
|
1434 | |
|
|
1435 | # we don't give a shit. no, we do, but we can't. no... |
|
|
1436 | # we, we... have to use openssl :/ |
|
|
1437 | &_freetls; |
|
|
1438 | } |
|
|
1439 | } |
|
|
1440 | |
|
|
1441 | sub _freetls { |
|
|
1442 | my ($self) = @_; |
|
|
1443 | |
|
|
1444 | return unless $self->{tls}; |
|
|
1445 | |
1382 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1446 | Net::SSLeay::free (delete $self->{tls}); |
1383 | |
1447 | |
1384 | delete $self->{_rbio}; |
1448 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1385 | delete $self->{_wbio}; |
|
|
1386 | delete $self->{_tls_wbuf}; |
|
|
1387 | delete $self->{filter_r}; |
|
|
1388 | delete $self->{filter_w}; |
|
|
1389 | } |
1449 | } |
1390 | |
1450 | |
1391 | sub DESTROY { |
1451 | sub DESTROY { |
1392 | my $self = shift; |
1452 | my $self = shift; |
1393 | |
1453 | |
1394 | $self->stoptls; |
1454 | &_freetls; |
1395 | |
1455 | |
1396 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1456 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1397 | |
1457 | |
1398 | if ($linger && length $self->{wbuf}) { |
1458 | if ($linger && length $self->{wbuf}) { |
1399 | my $fh = delete $self->{fh}; |
1459 | my $fh = delete $self->{fh}; |
… | |
… | |
1451 | } |
1511 | } |
1452 | } |
1512 | } |
1453 | |
1513 | |
1454 | =back |
1514 | =back |
1455 | |
1515 | |
|
|
1516 | |
|
|
1517 | =head1 NONFREQUENTLY ASKED QUESTIONS |
|
|
1518 | |
|
|
1519 | =over 4 |
|
|
1520 | |
|
|
1521 | =item How do I read data until the other side closes the connection? |
|
|
1522 | |
|
|
1523 | If you just want to read your data into a perl scalar, the easiest way to achieve this is |
|
|
1524 | by setting an C<on_read> callback that does nothing, clearing the C<on_eof> callback |
|
|
1525 | and in the C<on_error> callback, the data will be in C<$_[0]{rbuf}>: |
|
|
1526 | |
|
|
1527 | $handle->on_read (sub { }); |
|
|
1528 | $handle->on_eof (undef); |
|
|
1529 | $handle->on_error (sub { |
|
|
1530 | my $data = delete $_[0]{rbuf}; |
|
|
1531 | undef $handle; |
|
|
1532 | }); |
|
|
1533 | |
|
|
1534 | The reason to use C<on_error> is that TCP connections, due to latencies |
|
|
1535 | and packets loss, might get closed quite violently with an error, when in |
|
|
1536 | fact, all data has been received. |
|
|
1537 | |
|
|
1538 | It is usually better to use acknowledgements when transfering data, |
|
|
1539 | to make sure the other side hasn't just died and you got the data |
|
|
1540 | intact. This is also one reason why so many internet protocols have an |
|
|
1541 | explicit QUIT command. |
|
|
1542 | |
|
|
1543 | |
|
|
1544 | =item I don't want to destroy the handle too early - how do I wait until all data has been sent? |
|
|
1545 | |
|
|
1546 | After writing your last bits of data, set the C<on_drain> callback |
|
|
1547 | and destroy the handle in there - with the default setting of |
|
|
1548 | C<low_water_mark> this will be called precisely when all data has been |
|
|
1549 | written to the socket: |
|
|
1550 | |
|
|
1551 | $handle->push_write (...); |
|
|
1552 | $handle->on_drain (sub { |
|
|
1553 | warn "all data submitted to the kernel\n"; |
|
|
1554 | undef $handle; |
|
|
1555 | }); |
|
|
1556 | |
|
|
1557 | =back |
|
|
1558 | |
|
|
1559 | |
1456 | =head1 SUBCLASSING AnyEvent::Handle |
1560 | =head1 SUBCLASSING AnyEvent::Handle |
1457 | |
1561 | |
1458 | In many cases, you might want to subclass AnyEvent::Handle. |
1562 | In many cases, you might want to subclass AnyEvent::Handle. |
1459 | |
1563 | |
1460 | To make this easier, a given version of AnyEvent::Handle uses these |
1564 | To make this easier, a given version of AnyEvent::Handle uses these |