… | |
… | |
11 | |
11 | |
12 | my $hdl; $hdl = new AnyEvent::Handle |
12 | my $hdl; $hdl = new AnyEvent::Handle |
13 | fh => \*STDIN, |
13 | fh => \*STDIN, |
14 | on_error => sub { |
14 | on_error => sub { |
15 | my ($hdl, $fatal, $msg) = @_; |
15 | my ($hdl, $fatal, $msg) = @_; |
16 | warn "got error $msg\n"; |
16 | AE::log warn => "got error $msg\n"; |
17 | $hdl->destroy; |
17 | $hdl->destroy; |
18 | $cv->send; |
18 | $cv->send; |
19 | }; |
19 | }; |
20 | |
20 | |
21 | # send some request line |
21 | # send some request line |
22 | $hdl->push_write ("getinfo\015\012"); |
22 | $hdl->push_write ("getinfo\015\012"); |
23 | |
23 | |
24 | # read the response line |
24 | # read the response line |
25 | $hdl->push_read (line => sub { |
25 | $hdl->push_read (line => sub { |
26 | my ($hdl, $line) = @_; |
26 | my ($hdl, $line) = @_; |
27 | warn "got line <$line>\n"; |
27 | AE::log warn => "got line <$line>\n"; |
28 | $cv->send; |
28 | $cv->send; |
29 | }); |
29 | }); |
30 | |
30 | |
31 | $cv->recv; |
31 | $cv->recv; |
32 | |
32 | |
… | |
… | |
247 | many seconds pass without a successful read or write on the underlying |
247 | many seconds pass without a successful read or write on the underlying |
248 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
248 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
249 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
249 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
250 | error will be raised). |
250 | error will be raised). |
251 | |
251 | |
252 | There are three variants of the timeouts that work independently |
252 | There are three variants of the timeouts that work independently of each |
253 | of each other, for both read and write, just read, and just write: |
253 | other, for both read and write (triggered when nothing was read I<OR> |
|
|
254 | written), just read (triggered when nothing was read), and just write: |
254 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
255 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
255 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
256 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
256 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
257 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
257 | |
258 | |
258 | Note that timeout processing is active even when you do not have |
259 | Note that timeout processing is active even when you do not have any |
259 | any outstanding read or write requests: If you plan to keep the connection |
260 | outstanding read or write requests: If you plan to keep the connection |
260 | idle then you should disable the timeout temporarily or ignore the timeout |
261 | idle then you should disable the timeout temporarily or ignore the |
261 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
262 | timeout in the corresponding C<on_timeout> callback, in which case |
262 | restart the timeout. |
263 | AnyEvent::Handle will simply restart the timeout. |
263 | |
264 | |
264 | Zero (the default) disables this timeout. |
265 | Zero (the default) disables the corresponding timeout. |
265 | |
266 | |
266 | =item on_timeout => $cb->($handle) |
267 | =item on_timeout => $cb->($handle) |
|
|
268 | |
|
|
269 | =item on_rtimeout => $cb->($handle) |
|
|
270 | |
|
|
271 | =item on_wtimeout => $cb->($handle) |
267 | |
272 | |
268 | Called whenever the inactivity timeout passes. If you return from this |
273 | Called whenever the inactivity timeout passes. If you return from this |
269 | callback, then the timeout will be reset as if some activity had happened, |
274 | callback, then the timeout will be reset as if some activity had happened, |
270 | so this condition is not fatal in any way. |
275 | so this condition is not fatal in any way. |
271 | |
276 | |
… | |
… | |
354 | already have occured on BSD systems), but at least it will protect you |
359 | already have occured on BSD systems), but at least it will protect you |
355 | from most attacks. |
360 | from most attacks. |
356 | |
361 | |
357 | =item read_size => <bytes> |
362 | =item read_size => <bytes> |
358 | |
363 | |
359 | The initial read block size, the number of bytes this module will try to |
364 | The initial read block size, the number of bytes this module will try |
360 | read during each loop iteration. Each handle object will consume at least |
365 | to read during each loop iteration. Each handle object will consume |
361 | this amount of memory for the read buffer as well, so when handling many |
366 | at least this amount of memory for the read buffer as well, so when |
362 | connections requirements). See also C<max_read_size>. Default: C<2048>. |
367 | handling many connections watch out for memory requirements). See also |
|
|
368 | C<max_read_size>. Default: C<2048>. |
363 | |
369 | |
364 | =item max_read_size => <bytes> |
370 | =item max_read_size => <bytes> |
365 | |
371 | |
366 | The maximum read buffer size used by the dynamic adjustment |
372 | The maximum read buffer size used by the dynamic adjustment |
367 | algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in |
373 | algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in |
… | |
… | |
536 | }); |
542 | }); |
537 | |
543 | |
538 | } else { |
544 | } else { |
539 | if ($self->{on_connect_error}) { |
545 | if ($self->{on_connect_error}) { |
540 | $self->{on_connect_error}($self, "$!"); |
546 | $self->{on_connect_error}($self, "$!"); |
541 | $self->destroy; |
547 | $self->destroy if $self; |
542 | } else { |
548 | } else { |
543 | $self->_error ($!, 1); |
549 | $self->_error ($!, 1); |
544 | } |
550 | } |
545 | } |
551 | } |
546 | }, |
552 | }, |
… | |
… | |
779 | |
785 | |
780 | =item $handle->wtimeout ($seconds) |
786 | =item $handle->wtimeout ($seconds) |
781 | |
787 | |
782 | Configures (or disables) the inactivity timeout. |
788 | Configures (or disables) the inactivity timeout. |
783 | |
789 | |
|
|
790 | The timeout will be checked instantly, so this method might destroy the |
|
|
791 | handle before it returns. |
|
|
792 | |
784 | =item $handle->timeout_reset |
793 | =item $handle->timeout_reset |
785 | |
794 | |
786 | =item $handle->rtimeout_reset |
795 | =item $handle->rtimeout_reset |
787 | |
796 | |
788 | =item $handle->wtimeout_reset |
797 | =item $handle->wtimeout_reset |
… | |
… | |
1119 | |
1128 | |
1120 | Whenever the given C<type> is used, C<push_write> will the function with |
1129 | Whenever the given C<type> is used, C<push_write> will the function with |
1121 | the handle object and the remaining arguments. |
1130 | the handle object and the remaining arguments. |
1122 | |
1131 | |
1123 | The function is supposed to return a single octet string that will be |
1132 | The function is supposed to return a single octet string that will be |
1124 | appended to the write buffer, so you cna mentally treat this function as a |
1133 | appended to the write buffer, so you can mentally treat this function as a |
1125 | "arguments to on-the-wire-format" converter. |
1134 | "arguments to on-the-wire-format" converter. |
1126 | |
1135 | |
1127 | Example: implement a custom write type C<join> that joins the remaining |
1136 | Example: implement a custom write type C<join> that joins the remaining |
1128 | arguments using the first one. |
1137 | arguments using the first one. |
1129 | |
1138 | |
… | |
… | |
1423 | data. |
1432 | data. |
1424 | |
1433 | |
1425 | Example: read 2 bytes. |
1434 | Example: read 2 bytes. |
1426 | |
1435 | |
1427 | $handle->push_read (chunk => 2, sub { |
1436 | $handle->push_read (chunk => 2, sub { |
1428 | warn "yay ", unpack "H*", $_[1]; |
1437 | AE::log debug => "yay " . unpack "H*", $_[1]; |
1429 | }); |
1438 | }); |
1430 | |
1439 | |
1431 | =cut |
1440 | =cut |
1432 | |
1441 | |
1433 | register_read_type chunk => sub { |
1442 | register_read_type chunk => sub { |
… | |
… | |
1535 | |
1544 | |
1536 | sub { |
1545 | sub { |
1537 | # accept |
1546 | # accept |
1538 | if ($$rbuf =~ $accept) { |
1547 | if ($$rbuf =~ $accept) { |
1539 | $data .= substr $$rbuf, 0, $+[0], ""; |
1548 | $data .= substr $$rbuf, 0, $+[0], ""; |
1540 | $cb->($self, $data); |
1549 | $cb->($_[0], $data); |
1541 | return 1; |
1550 | return 1; |
1542 | } |
1551 | } |
1543 | |
1552 | |
1544 | # reject |
1553 | # reject |
1545 | if ($reject && $$rbuf =~ $reject) { |
1554 | if ($reject && $$rbuf =~ $reject) { |
1546 | $self->_error (Errno::EBADMSG); |
1555 | $_[0]->_error (Errno::EBADMSG); |
1547 | } |
1556 | } |
1548 | |
1557 | |
1549 | # skip |
1558 | # skip |
1550 | if ($skip && $$rbuf =~ $skip) { |
1559 | if ($skip && $$rbuf =~ $skip) { |
1551 | $data .= substr $$rbuf, 0, $+[0], ""; |
1560 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
1567 | my ($self, $cb) = @_; |
1576 | my ($self, $cb) = @_; |
1568 | |
1577 | |
1569 | sub { |
1578 | sub { |
1570 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1579 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1571 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1580 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1572 | $self->_error (Errno::EBADMSG); |
1581 | $_[0]->_error (Errno::EBADMSG); |
1573 | } |
1582 | } |
1574 | return; |
1583 | return; |
1575 | } |
1584 | } |
1576 | |
1585 | |
1577 | my $len = $1; |
1586 | my $len = $1; |
1578 | |
1587 | |
1579 | $self->unshift_read (chunk => $len, sub { |
1588 | $_[0]->unshift_read (chunk => $len, sub { |
1580 | my $string = $_[1]; |
1589 | my $string = $_[1]; |
1581 | $_[0]->unshift_read (chunk => 1, sub { |
1590 | $_[0]->unshift_read (chunk => 1, sub { |
1582 | if ($_[1] eq ",") { |
1591 | if ($_[1] eq ",") { |
1583 | $cb->($_[0], $string); |
1592 | $cb->($_[0], $string); |
1584 | } else { |
1593 | } else { |
1585 | $self->_error (Errno::EBADMSG); |
1594 | $_[0]->_error (Errno::EBADMSG); |
1586 | } |
1595 | } |
1587 | }); |
1596 | }); |
1588 | }); |
1597 | }); |
1589 | |
1598 | |
1590 | 1 |
1599 | 1 |
… | |
… | |
1663 | |
1672 | |
1664 | my $data; |
1673 | my $data; |
1665 | my $rbuf = \$self->{rbuf}; |
1674 | my $rbuf = \$self->{rbuf}; |
1666 | |
1675 | |
1667 | sub { |
1676 | sub { |
1668 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1677 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1669 | |
1678 | |
1670 | if ($ref) { |
1679 | if ($ref) { |
1671 | $self->{rbuf} = $json->incr_text; |
1680 | $_[0]{rbuf} = $json->incr_text; |
1672 | $json->incr_text = ""; |
1681 | $json->incr_text = ""; |
1673 | $cb->($self, $ref); |
1682 | $cb->($_[0], $ref); |
1674 | |
1683 | |
1675 | 1 |
1684 | 1 |
1676 | } elsif ($@) { |
1685 | } elsif ($@) { |
1677 | # error case |
1686 | # error case |
1678 | $json->incr_skip; |
1687 | $json->incr_skip; |
1679 | |
1688 | |
1680 | $self->{rbuf} = $json->incr_text; |
1689 | $_[0]{rbuf} = $json->incr_text; |
1681 | $json->incr_text = ""; |
1690 | $json->incr_text = ""; |
1682 | |
1691 | |
1683 | $self->_error (Errno::EBADMSG); |
1692 | $_[0]->_error (Errno::EBADMSG); |
1684 | |
1693 | |
1685 | () |
1694 | () |
1686 | } else { |
1695 | } else { |
1687 | $self->{rbuf} = ""; |
1696 | $_[0]{rbuf} = ""; |
1688 | |
1697 | |
1689 | () |
1698 | () |
1690 | } |
1699 | } |
1691 | } |
1700 | } |
1692 | }; |
1701 | }; |
… | |
… | |
1725 | # read remaining chunk |
1734 | # read remaining chunk |
1726 | $_[0]->unshift_read (chunk => $len, sub { |
1735 | $_[0]->unshift_read (chunk => $len, sub { |
1727 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1736 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1728 | $cb->($_[0], $ref); |
1737 | $cb->($_[0], $ref); |
1729 | } else { |
1738 | } else { |
1730 | $self->_error (Errno::EBADMSG); |
1739 | $_[0]->_error (Errno::EBADMSG); |
1731 | } |
1740 | } |
1732 | }); |
1741 | }); |
1733 | } |
1742 | } |
1734 | |
1743 | |
1735 | 1 |
1744 | 1 |
… | |
… | |
2002 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
2011 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
2003 | |
2012 | |
2004 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2013 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2005 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2014 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2006 | |
2015 | |
2007 | Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); |
2016 | Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf}); |
|
|
2017 | $self->{rbuf} = ""; |
2008 | |
2018 | |
2009 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
2019 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
2010 | |
2020 | |
2011 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
2021 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
2012 | if $self->{on_starttls}; |
2022 | if $self->{on_starttls}; |
… | |
… | |
2194 | Probably because your C<on_error> callback is being called instead: When |
2204 | Probably because your C<on_error> callback is being called instead: When |
2195 | you have outstanding requests in your read queue, then an EOF is |
2205 | you have outstanding requests in your read queue, then an EOF is |
2196 | considered an error as you clearly expected some data. |
2206 | considered an error as you clearly expected some data. |
2197 | |
2207 | |
2198 | To avoid this, make sure you have an empty read queue whenever your handle |
2208 | To avoid this, make sure you have an empty read queue whenever your handle |
2199 | is supposed to be "idle" (i.e. connection closes are O.K.). You cna set |
2209 | is supposed to be "idle" (i.e. connection closes are O.K.). You can set |
2200 | an C<on_read> handler that simply pushes the first read requests in the |
2210 | an C<on_read> handler that simply pushes the first read requests in the |
2201 | queue. |
2211 | queue. |
2202 | |
2212 | |
2203 | See also the next question, which explains this in a bit more detail. |
2213 | See also the next question, which explains this in a bit more detail. |
2204 | |
2214 | |
… | |
… | |
2235 | some data and raises the C<EPIPE> error when the connction is dropped |
2245 | some data and raises the C<EPIPE> error when the connction is dropped |
2236 | unexpectedly. |
2246 | unexpectedly. |
2237 | |
2247 | |
2238 | The second variant is a protocol where the client can drop the connection |
2248 | The second variant is a protocol where the client can drop the connection |
2239 | at any time. For TCP, this means that the server machine may run out of |
2249 | at any time. For TCP, this means that the server machine may run out of |
2240 | sockets easier, and in general, it means you cnanot distinguish a protocl |
2250 | sockets easier, and in general, it means you cannot distinguish a protocl |
2241 | failure/client crash from a normal connection close. Nevertheless, these |
2251 | failure/client crash from a normal connection close. Nevertheless, these |
2242 | kinds of protocols are common (and sometimes even the best solution to the |
2252 | kinds of protocols are common (and sometimes even the best solution to the |
2243 | problem). |
2253 | problem). |
2244 | |
2254 | |
2245 | Having an outstanding read request at all times is possible if you ignore |
2255 | Having an outstanding read request at all times is possible if you ignore |
… | |
… | |
2297 | $handle->on_eof (undef); |
2307 | $handle->on_eof (undef); |
2298 | $handle->on_error (sub { |
2308 | $handle->on_error (sub { |
2299 | my $data = delete $_[0]{rbuf}; |
2309 | my $data = delete $_[0]{rbuf}; |
2300 | }); |
2310 | }); |
2301 | |
2311 | |
|
|
2312 | Note that this example removes the C<rbuf> member from the handle object, |
|
|
2313 | which is not normally allowed by the API. It is expressly permitted in |
|
|
2314 | this case only, as the handle object needs to be destroyed afterwards. |
|
|
2315 | |
2302 | The reason to use C<on_error> is that TCP connections, due to latencies |
2316 | The reason to use C<on_error> is that TCP connections, due to latencies |
2303 | and packets loss, might get closed quite violently with an error, when in |
2317 | and packets loss, might get closed quite violently with an error, when in |
2304 | fact all data has been received. |
2318 | fact all data has been received. |
2305 | |
2319 | |
2306 | It is usually better to use acknowledgements when transferring data, |
2320 | It is usually better to use acknowledgements when transferring data, |
… | |
… | |
2316 | C<low_water_mark> this will be called precisely when all data has been |
2330 | C<low_water_mark> this will be called precisely when all data has been |
2317 | written to the socket: |
2331 | written to the socket: |
2318 | |
2332 | |
2319 | $handle->push_write (...); |
2333 | $handle->push_write (...); |
2320 | $handle->on_drain (sub { |
2334 | $handle->on_drain (sub { |
2321 | warn "all data submitted to the kernel\n"; |
2335 | AE::log debug => "all data submitted to the kernel\n"; |
2322 | undef $handle; |
2336 | undef $handle; |
2323 | }); |
2337 | }); |
2324 | |
2338 | |
2325 | If you just want to queue some data and then signal EOF to the other side, |
2339 | If you just want to queue some data and then signal EOF to the other side, |
2326 | consider using C<< ->push_shutdown >> instead. |
2340 | consider using C<< ->push_shutdown >> instead. |