… | |
… | |
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.232; |
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 |
… | |
… | |
99 | 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 |
100 | connect or a read error. |
112 | connect or a read error. |
101 | |
113 | |
102 | 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 |
103 | fatal errors the handle object will be shut down and will not be usable |
115 | fatal errors the handle object will be shut down and will not be usable |
104 | (but you are free to look at the current C< ->rbuf >). Examples of fatal |
116 | (but you are free to look at the current C<< ->rbuf >>). Examples of fatal |
105 | errors are an EOF condition with active (but unsatisifable) read watchers |
117 | errors are an EOF condition with active (but unsatisifable) read watchers |
106 | (C<EPIPE>) or I/O errors. |
118 | (C<EPIPE>) or I/O errors. |
107 | |
119 | |
108 | Non-fatal errors can be retried by simply returning, but it is recommended |
120 | Non-fatal errors can be retried by simply returning, but it is recommended |
109 | to simply ignore this parameter and instead abondon the handle object |
121 | to simply ignore this parameter and instead abondon the handle object |
… | |
… | |
148 | =item timeout => $fractional_seconds |
160 | =item timeout => $fractional_seconds |
149 | |
161 | |
150 | 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 |
151 | 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 |
152 | 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 |
153 | missing, an C<ETIMEDOUT> error will be raised). |
165 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
154 | |
166 | |
155 | 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 |
156 | 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 |
157 | 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 |
158 | in the C<on_timeout> callback. |
170 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
|
|
171 | restart the timeout. |
159 | |
172 | |
160 | Zero (the default) disables this timeout. |
173 | Zero (the default) disables this timeout. |
161 | |
174 | |
162 | =item on_timeout => $cb->($handle) |
175 | =item on_timeout => $cb->($handle) |
163 | |
176 | |
… | |
… | |
167 | |
180 | |
168 | =item rbuf_max => <bytes> |
181 | =item rbuf_max => <bytes> |
169 | |
182 | |
170 | 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>) |
171 | 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 |
172 | avoid denial-of-service attacks. |
185 | avoid some forms of denial-of-service attacks. |
173 | |
186 | |
174 | For example, a server accepting connections from untrusted sources should |
187 | For example, a server accepting connections from untrusted sources should |
175 | 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 |
176 | (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 |
177 | 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 |
178 | isn't finished). |
191 | isn't finished). |
179 | |
192 | |
180 | =item autocork => <boolean> |
193 | =item autocork => <boolean> |
181 | |
194 | |
182 | 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 |
183 | 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 |
184 | 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 |
185 | inefficient if you write multiple small chunks (this disadvantage is |
198 | be inefficient if you write multiple small chunks (on the wire, this |
186 | 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). |
187 | |
201 | |
188 | 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 |
189 | 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, |
190 | 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. |
191 | |
206 | |
192 | =item no_delay => <boolean> |
207 | =item no_delay => <boolean> |
193 | |
208 | |
194 | When doing small writes on sockets, your operating system kernel might |
209 | When doing small writes on sockets, your operating system kernel might |
195 | 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 |
196 | the Nagle algorithm, and usually it is beneficial. |
211 | the Nagle algorithm, and usually it is beneficial. |
197 | |
212 | |
198 | 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 |
199 | accomplishd by setting this option to true. |
214 | accomplishd by setting this option to a true value. |
200 | |
215 | |
201 | The default is your opertaing system's default behaviour, this option |
216 | The default is your opertaing system's default behaviour (most likely |
202 | explicitly enables or disables it, if possible. |
217 | enabled), this option explicitly enables or disables it, if possible. |
203 | |
218 | |
204 | =item read_size => <bytes> |
219 | =item read_size => <bytes> |
205 | |
220 | |
206 | 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 |
207 | during each (loop iteration). Default: C<8192>. |
222 | try to read during each loop iteration, which affects memory |
|
|
223 | requirements). Default: C<8192>. |
208 | |
224 | |
209 | =item low_water_mark => <bytes> |
225 | =item low_water_mark => <bytes> |
210 | |
226 | |
211 | 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 |
212 | 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 |
213 | considered empty. |
229 | considered empty. |
214 | |
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 | |
215 | =item linger => <seconds> |
236 | =item linger => <seconds> |
216 | |
237 | |
217 | If non-zero (default: C<3600>), then the destructor of the |
238 | If non-zero (default: C<3600>), then the destructor of the |
218 | AnyEvent::Handle object will check wether there is still outstanding write |
239 | AnyEvent::Handle object will check whether there is still outstanding |
219 | 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 |
220 | will be reported (this mostly matches how the operating system treats |
241 | socket. No errors will be reported (this mostly matches how the operating |
221 | outstanding data at socket close time). |
242 | system treats outstanding data at socket close time). |
222 | |
243 | |
223 | 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 |
224 | encoded. This data will be lost. |
245 | yet. This data will be lost. |
225 | |
246 | |
226 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
247 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
227 | |
248 | |
228 | When this parameter is given, it enables TLS (SSL) mode, that means it |
249 | When this parameter is given, it enables TLS (SSL) mode, that means |
229 | will start making tls handshake and will transparently encrypt/decrypt |
250 | AnyEvent will start a TLS handshake as soon as the conenction has been |
230 | data. |
251 | established and will transparently encrypt/decrypt data afterwards. |
231 | |
252 | |
232 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
253 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
233 | automatically when you try to create a TLS handle). |
254 | automatically when you try to create a TLS handle): this module doesn't |
|
|
255 | have a dependency on that module, so if your module requires it, you have |
|
|
256 | to add the dependency yourself. |
234 | |
257 | |
235 | For the TLS server side, use C<accept>, and for the TLS client side of a |
258 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
236 | connection, use C<connect> mode. |
259 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
260 | mode. |
237 | |
261 | |
238 | You can also provide your own TLS connection object, but you have |
262 | You can also provide your own TLS connection object, but you have |
239 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
263 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
240 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
264 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
241 | AnyEvent::Handle. |
265 | AnyEvent::Handle. |
242 | |
266 | |
243 | See the C<starttls> method if you need to start TLS negotiation later. |
267 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
244 | |
268 | |
245 | =item tls_ctx => $ssl_ctx |
269 | =item tls_ctx => $ssl_ctx |
246 | |
270 | |
247 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
271 | Use the given C<Net::SSLeay::CTX> object to create the new TLS connection |
248 | (unless a connection object was specified directly). If this parameter is |
272 | (unless a connection object was specified directly). If this parameter is |
249 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
273 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
250 | |
274 | |
251 | =item json => JSON or JSON::XS object |
275 | =item json => JSON or JSON::XS object |
252 | |
276 | |
253 | This is the json coder object used by the C<json> read and write types. |
277 | This is the json coder object used by the C<json> read and write types. |
254 | |
278 | |
255 | If you don't supply it, then AnyEvent::Handle will create and use a |
279 | If you don't supply it, then AnyEvent::Handle will create and use a |
256 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
280 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
281 | texts. |
257 | |
282 | |
258 | Note that you are responsible to depend on the JSON module if you want to |
283 | Note that you are responsible to depend on the JSON module if you want to |
259 | use this functionality, as AnyEvent does not have a dependency itself. |
284 | use this functionality, as AnyEvent does not have a dependency itself. |
260 | |
285 | |
261 | =item filter_r => $cb |
286 | =item filter_r => $cb |
262 | |
287 | |
263 | =item filter_w => $cb |
288 | =item filter_w => $cb |
264 | |
289 | |
265 | These exist, but are undocumented at this time. |
290 | These exist, but are undocumented at this time. (They are used internally |
|
|
291 | by the TLS code). |
266 | |
292 | |
267 | =back |
293 | =back |
268 | |
294 | |
269 | =cut |
295 | =cut |
270 | |
296 | |
… | |
… | |
323 | } |
349 | } |
324 | } |
350 | } |
325 | |
351 | |
326 | =item $fh = $handle->fh |
352 | =item $fh = $handle->fh |
327 | |
353 | |
328 | This method returns the file handle of the L<AnyEvent::Handle> object. |
354 | This method returns the file handle used to create the L<AnyEvent::Handle> object. |
329 | |
355 | |
330 | =cut |
356 | =cut |
331 | |
357 | |
332 | sub fh { $_[0]{fh} } |
358 | sub fh { $_[0]{fh} } |
333 | |
359 | |
… | |
… | |
351 | $_[0]{on_eof} = $_[1]; |
377 | $_[0]{on_eof} = $_[1]; |
352 | } |
378 | } |
353 | |
379 | |
354 | =item $handle->on_timeout ($cb) |
380 | =item $handle->on_timeout ($cb) |
355 | |
381 | |
356 | Replace the current C<on_timeout> callback, or disables the callback |
382 | Replace the current C<on_timeout> callback, or disables the callback (but |
357 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
383 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
358 | argument. |
384 | argument and method. |
359 | |
385 | |
360 | =cut |
386 | =cut |
361 | |
387 | |
362 | sub on_timeout { |
388 | sub on_timeout { |
363 | $_[0]{on_timeout} = $_[1]; |
389 | $_[0]{on_timeout} = $_[1]; |
… | |
… | |
1293 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1319 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1294 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1320 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1295 | } |
1321 | } |
1296 | } |
1322 | } |
1297 | |
1323 | |
1298 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1299 | $self->{wbuf} .= $buf; |
|
|
1300 | $self->_drain_wbuf; |
|
|
1301 | } |
|
|
1302 | |
|
|
1303 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1324 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1304 | if (length $buf) { |
1325 | unless (length $buf) { |
1305 | $self->{rbuf} .= $buf; |
|
|
1306 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1307 | } else { |
|
|
1308 | # let's treat SSL-eof as we treat normal EOF |
1326 | # let's treat SSL-eof as we treat normal EOF |
|
|
1327 | delete $self->{_rw}; |
1309 | $self->{_eof} = 1; |
1328 | $self->{_eof} = 1; |
1310 | $self->_shutdown; |
|
|
1311 | return; |
|
|
1312 | } |
1329 | } |
|
|
1330 | |
|
|
1331 | $self->{rbuf} .= $buf; |
|
|
1332 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1333 | |
|
|
1334 | $self->{tls} or return; # tls could have gone away |
1313 | } |
1335 | } |
1314 | |
1336 | |
1315 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1337 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1316 | |
1338 | |
1317 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1339 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
… | |
… | |
1321 | return $self->_error (&Errno::EIO, 1); |
1343 | return $self->_error (&Errno::EIO, 1); |
1322 | } |
1344 | } |
1323 | |
1345 | |
1324 | # all others are fine for our purposes |
1346 | # all others are fine for our purposes |
1325 | } |
1347 | } |
|
|
1348 | |
|
|
1349 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1350 | $self->{wbuf} .= $buf; |
|
|
1351 | $self->_drain_wbuf; |
|
|
1352 | } |
1326 | } |
1353 | } |
1327 | |
1354 | |
1328 | =item $handle->starttls ($tls[, $tls_ctx]) |
1355 | =item $handle->starttls ($tls[, $tls_ctx]) |
1329 | |
1356 | |
1330 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1357 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
… | |
… | |
1361 | # basically, this is deep magic (because SSL_read should have the same issues) |
1388 | # basically, this is deep magic (because SSL_read should have the same issues) |
1362 | # but the openssl maintainers basically said: "trust us, it just works". |
1389 | # but the openssl maintainers basically said: "trust us, it just works". |
1363 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1390 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1364 | # and mismaintained ssleay-module doesn't even offer them). |
1391 | # and mismaintained ssleay-module doesn't even offer them). |
1365 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1392 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1393 | # |
|
|
1394 | # in short: this is a mess. |
|
|
1395 | # |
|
|
1396 | # note that we do not try to kepe the length constant between writes as we are required to do. |
|
|
1397 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
|
|
1398 | # and we drive openssl fully in blocking mode here. |
1366 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1399 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1367 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1400 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1368 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1401 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1369 | |
1402 | |
1370 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1403 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
… | |
… | |
1378 | }; |
1411 | }; |
1379 | $self->{filter_r} = sub { |
1412 | $self->{filter_r} = sub { |
1380 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
1413 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
1381 | &_dotls; |
1414 | &_dotls; |
1382 | }; |
1415 | }; |
|
|
1416 | |
|
|
1417 | &_dotls; # need to trigger the initial negotiation exchange |
1383 | } |
1418 | } |
1384 | |
1419 | |
1385 | =item $handle->stoptls |
1420 | =item $handle->stoptls |
1386 | |
1421 | |
1387 | Destroys the SSL connection, if any. Partial read or write data will be |
1422 | Destroys the SSL connection, if any. Partial read or write data will be |