… | |
… | |
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 | |
… | |
… | |
114 | =over 4 |
114 | =over 4 |
115 | |
115 | |
116 | =item on_prepare => $cb->($handle) |
116 | =item on_prepare => $cb->($handle) |
117 | |
117 | |
118 | This (rarely used) callback is called before a new connection is |
118 | This (rarely used) callback is called before a new connection is |
119 | attempted, but after the file handle has been created. It could be used to |
119 | attempted, but after the file handle has been created (you can access that |
|
|
120 | file handle via C<< $handle->{fh} >>). It could be used to prepare the |
120 | prepare the file handle with parameters required for the actual connect |
121 | file handle with parameters required for the actual connect (as opposed to |
121 | (as opposed to settings that can be changed when the connection is already |
122 | settings that can be changed when the connection is already established). |
122 | established). |
|
|
123 | |
123 | |
124 | The return value of this callback should be the connect timeout value in |
124 | The return value of this callback should be the connect timeout value in |
125 | seconds (or C<0>, or C<undef>, or the empty list, to indicate that the |
125 | seconds (or C<0>, or C<undef>, or the empty list, to indicate that the |
126 | default timeout is to be used). |
126 | default timeout is to be used). |
127 | |
127 | |
… | |
… | |
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 | |
… | |
… | |
278 | For example, a server accepting connections from untrusted sources should |
283 | For example, a server accepting connections from untrusted sources should |
279 | be configured to accept only so-and-so much data that it cannot act on |
284 | be configured to accept only so-and-so much data that it cannot act on |
280 | (for example, when expecting a line, an attacker could send an unlimited |
285 | (for example, when expecting a line, an attacker could send an unlimited |
281 | amount of data without a callback ever being called as long as the line |
286 | amount of data without a callback ever being called as long as the line |
282 | isn't finished). |
287 | isn't finished). |
|
|
288 | |
|
|
289 | =item wbuf_max => <bytes> |
|
|
290 | |
|
|
291 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
|
|
292 | when the write buffer ever (strictly) exceeds this size. This is useful to |
|
|
293 | avoid some forms of denial-of-service attacks. |
|
|
294 | |
|
|
295 | Although the units of this parameter is bytes, this is the I<raw> number |
|
|
296 | of bytes not yet accepted by the kernel. This can make a difference when |
|
|
297 | you e.g. use TLS, as TLS typically makes your write data larger (but it |
|
|
298 | can also make it smaller due to compression). |
|
|
299 | |
|
|
300 | As an example of when this limit is useful, take a chat server that sends |
|
|
301 | chat messages to a client. If the client does not read those in a timely |
|
|
302 | manner then the send buffer in the server would grow unbounded. |
283 | |
303 | |
284 | =item autocork => <boolean> |
304 | =item autocork => <boolean> |
285 | |
305 | |
286 | When disabled (the default), C<push_write> will try to immediately |
306 | When disabled (the default), C<push_write> will try to immediately |
287 | write the data to the handle if possible. This avoids having to register |
307 | write the data to the handle if possible. This avoids having to register |
… | |
… | |
339 | 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 |
340 | from most attacks. |
360 | from most attacks. |
341 | |
361 | |
342 | =item read_size => <bytes> |
362 | =item read_size => <bytes> |
343 | |
363 | |
344 | 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 |
345 | read during each loop iteration. Each handle object will consume at least |
365 | to read during each loop iteration. Each handle object will consume |
346 | 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 |
347 | 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>. |
348 | |
369 | |
349 | =item max_read_size => <bytes> |
370 | =item max_read_size => <bytes> |
350 | |
371 | |
351 | The maximum read buffer size used by the dynamic adjustment |
372 | The maximum read buffer size used by the dynamic adjustment |
352 | 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 |
… | |
… | |
521 | }); |
542 | }); |
522 | |
543 | |
523 | } else { |
544 | } else { |
524 | if ($self->{on_connect_error}) { |
545 | if ($self->{on_connect_error}) { |
525 | $self->{on_connect_error}($self, "$!"); |
546 | $self->{on_connect_error}($self, "$!"); |
526 | $self->destroy; |
547 | $self->destroy if $self; |
527 | } else { |
548 | } else { |
528 | $self->_error ($!, 1); |
549 | $self->_error ($!, 1); |
529 | } |
550 | } |
530 | } |
551 | } |
531 | }, |
552 | }, |
532 | sub { |
553 | sub { |
533 | local $self->{fh} = $_[0]; |
554 | local $self->{fh} = $_[0]; |
534 | |
555 | |
535 | $self->{on_prepare} |
556 | $self->{on_prepare} |
536 | ? $self->{on_prepare}->($self) |
557 | ? $self->{on_prepare}->($self) |
537 | : () |
558 | : () |
538 | } |
559 | } |
539 | ); |
560 | ); |
540 | } |
561 | } |
541 | |
562 | |
… | |
… | |
740 | |
761 | |
741 | =item $handle->rbuf_max ($max_octets) |
762 | =item $handle->rbuf_max ($max_octets) |
742 | |
763 | |
743 | Configures the C<rbuf_max> setting (C<undef> disables it). |
764 | Configures the C<rbuf_max> setting (C<undef> disables it). |
744 | |
765 | |
|
|
766 | =item $handle->wbuf_max ($max_octets) |
|
|
767 | |
|
|
768 | Configures the C<wbuf_max> setting (C<undef> disables it). |
|
|
769 | |
745 | =cut |
770 | =cut |
746 | |
771 | |
747 | sub rbuf_max { |
772 | sub rbuf_max { |
748 | $_[0]{rbuf_max} = $_[1]; |
773 | $_[0]{rbuf_max} = $_[1]; |
749 | } |
774 | } |
750 | |
775 | |
|
|
776 | sub wbuf_max { |
|
|
777 | $_[0]{wbuf_max} = $_[1]; |
|
|
778 | } |
|
|
779 | |
751 | ############################################################################# |
780 | ############################################################################# |
752 | |
781 | |
753 | =item $handle->timeout ($seconds) |
782 | =item $handle->timeout ($seconds) |
754 | |
783 | |
755 | =item $handle->rtimeout ($seconds) |
784 | =item $handle->rtimeout ($seconds) |
756 | |
785 | |
757 | =item $handle->wtimeout ($seconds) |
786 | =item $handle->wtimeout ($seconds) |
758 | |
787 | |
759 | Configures (or disables) the inactivity timeout. |
788 | Configures (or disables) the inactivity timeout. |
|
|
789 | |
|
|
790 | The timeout will be checked instantly, so this method might destroy the |
|
|
791 | handle before it returns. |
760 | |
792 | |
761 | =item $handle->timeout_reset |
793 | =item $handle->timeout_reset |
762 | |
794 | |
763 | =item $handle->rtimeout_reset |
795 | =item $handle->rtimeout_reset |
764 | |
796 | |
… | |
… | |
873 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
905 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
874 | } |
906 | } |
875 | |
907 | |
876 | =item $handle->push_write ($data) |
908 | =item $handle->push_write ($data) |
877 | |
909 | |
878 | Queues the given scalar to be written. You can push as much data as you |
910 | Queues the given scalar to be written. You can push as much data as |
879 | want (only limited by the available memory), as C<AnyEvent::Handle> |
911 | you want (only limited by the available memory and C<wbuf_max>), as |
880 | buffers it independently of the kernel. |
912 | C<AnyEvent::Handle> buffers it independently of the kernel. |
881 | |
913 | |
882 | This method may invoke callbacks (and therefore the handle might be |
914 | This method may invoke callbacks (and therefore the handle might be |
883 | destroyed after it returns). |
915 | destroyed after it returns). |
884 | |
916 | |
885 | =cut |
917 | =cut |
… | |
… | |
913 | $cb->() unless $self->{autocork}; |
945 | $cb->() unless $self->{autocork}; |
914 | |
946 | |
915 | # if still data left in wbuf, we need to poll |
947 | # if still data left in wbuf, we need to poll |
916 | $self->{_ww} = AE::io $self->{fh}, 1, $cb |
948 | $self->{_ww} = AE::io $self->{fh}, 1, $cb |
917 | if length $self->{wbuf}; |
949 | if length $self->{wbuf}; |
|
|
950 | |
|
|
951 | if ( |
|
|
952 | defined $self->{wbuf_max} |
|
|
953 | && $self->{wbuf_max} < length $self->{wbuf} |
|
|
954 | ) { |
|
|
955 | $self->_error (Errno::ENOSPC, 1), return; |
|
|
956 | } |
918 | }; |
957 | }; |
919 | } |
958 | } |
920 | |
959 | |
921 | our %WH; |
960 | our %WH; |
922 | |
961 | |
… | |
… | |
1057 | before it was actually written. One way to do that is to replace your |
1096 | before it was actually written. One way to do that is to replace your |
1058 | C<on_drain> handler by a callback that shuts down the socket (and set |
1097 | C<on_drain> handler by a callback that shuts down the socket (and set |
1059 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
1098 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
1060 | replaces the C<on_drain> callback with: |
1099 | replaces the C<on_drain> callback with: |
1061 | |
1100 | |
1062 | sub { shutdown $_[0]{fh}, 1 } # for push_shutdown |
1101 | sub { shutdown $_[0]{fh}, 1 } |
1063 | |
1102 | |
1064 | This simply shuts down the write side and signals an EOF condition to the |
1103 | This simply shuts down the write side and signals an EOF condition to the |
1065 | the peer. |
1104 | the peer. |
1066 | |
1105 | |
1067 | You can rely on the normal read queue and C<on_eof> handling |
1106 | You can rely on the normal read queue and C<on_eof> handling |
… | |
… | |
1089 | |
1128 | |
1090 | 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 |
1091 | the handle object and the remaining arguments. |
1130 | the handle object and the remaining arguments. |
1092 | |
1131 | |
1093 | 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 |
1094 | 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 |
1095 | "arguments to on-the-wire-format" converter. |
1134 | "arguments to on-the-wire-format" converter. |
1096 | |
1135 | |
1097 | 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 |
1098 | arguments using the first one. |
1137 | arguments using the first one. |
1099 | |
1138 | |
… | |
… | |
1393 | data. |
1432 | data. |
1394 | |
1433 | |
1395 | Example: read 2 bytes. |
1434 | Example: read 2 bytes. |
1396 | |
1435 | |
1397 | $handle->push_read (chunk => 2, sub { |
1436 | $handle->push_read (chunk => 2, sub { |
1398 | warn "yay ", unpack "H*", $_[1]; |
1437 | AE::log debug => "yay " . unpack "H*", $_[1]; |
1399 | }); |
1438 | }); |
1400 | |
1439 | |
1401 | =cut |
1440 | =cut |
1402 | |
1441 | |
1403 | register_read_type chunk => sub { |
1442 | register_read_type chunk => sub { |
… | |
… | |
1505 | |
1544 | |
1506 | sub { |
1545 | sub { |
1507 | # accept |
1546 | # accept |
1508 | if ($$rbuf =~ $accept) { |
1547 | if ($$rbuf =~ $accept) { |
1509 | $data .= substr $$rbuf, 0, $+[0], ""; |
1548 | $data .= substr $$rbuf, 0, $+[0], ""; |
1510 | $cb->($self, $data); |
1549 | $cb->($_[0], $data); |
1511 | return 1; |
1550 | return 1; |
1512 | } |
1551 | } |
1513 | |
1552 | |
1514 | # reject |
1553 | # reject |
1515 | if ($reject && $$rbuf =~ $reject) { |
1554 | if ($reject && $$rbuf =~ $reject) { |
1516 | $self->_error (Errno::EBADMSG); |
1555 | $_[0]->_error (Errno::EBADMSG); |
1517 | } |
1556 | } |
1518 | |
1557 | |
1519 | # skip |
1558 | # skip |
1520 | if ($skip && $$rbuf =~ $skip) { |
1559 | if ($skip && $$rbuf =~ $skip) { |
1521 | $data .= substr $$rbuf, 0, $+[0], ""; |
1560 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
1537 | my ($self, $cb) = @_; |
1576 | my ($self, $cb) = @_; |
1538 | |
1577 | |
1539 | sub { |
1578 | sub { |
1540 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1579 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1541 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1580 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1542 | $self->_error (Errno::EBADMSG); |
1581 | $_[0]->_error (Errno::EBADMSG); |
1543 | } |
1582 | } |
1544 | return; |
1583 | return; |
1545 | } |
1584 | } |
1546 | |
1585 | |
1547 | my $len = $1; |
1586 | my $len = $1; |
1548 | |
1587 | |
1549 | $self->unshift_read (chunk => $len, sub { |
1588 | $_[0]->unshift_read (chunk => $len, sub { |
1550 | my $string = $_[1]; |
1589 | my $string = $_[1]; |
1551 | $_[0]->unshift_read (chunk => 1, sub { |
1590 | $_[0]->unshift_read (chunk => 1, sub { |
1552 | if ($_[1] eq ",") { |
1591 | if ($_[1] eq ",") { |
1553 | $cb->($_[0], $string); |
1592 | $cb->($_[0], $string); |
1554 | } else { |
1593 | } else { |
1555 | $self->_error (Errno::EBADMSG); |
1594 | $_[0]->_error (Errno::EBADMSG); |
1556 | } |
1595 | } |
1557 | }); |
1596 | }); |
1558 | }); |
1597 | }); |
1559 | |
1598 | |
1560 | 1 |
1599 | 1 |
… | |
… | |
1633 | |
1672 | |
1634 | my $data; |
1673 | my $data; |
1635 | my $rbuf = \$self->{rbuf}; |
1674 | my $rbuf = \$self->{rbuf}; |
1636 | |
1675 | |
1637 | sub { |
1676 | sub { |
1638 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1677 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1639 | |
1678 | |
1640 | if ($ref) { |
1679 | if ($ref) { |
1641 | $self->{rbuf} = $json->incr_text; |
1680 | $_[0]{rbuf} = $json->incr_text; |
1642 | $json->incr_text = ""; |
1681 | $json->incr_text = ""; |
1643 | $cb->($self, $ref); |
1682 | $cb->($_[0], $ref); |
1644 | |
1683 | |
1645 | 1 |
1684 | 1 |
1646 | } elsif ($@) { |
1685 | } elsif ($@) { |
1647 | # error case |
1686 | # error case |
1648 | $json->incr_skip; |
1687 | $json->incr_skip; |
1649 | |
1688 | |
1650 | $self->{rbuf} = $json->incr_text; |
1689 | $_[0]{rbuf} = $json->incr_text; |
1651 | $json->incr_text = ""; |
1690 | $json->incr_text = ""; |
1652 | |
1691 | |
1653 | $self->_error (Errno::EBADMSG); |
1692 | $_[0]->_error (Errno::EBADMSG); |
1654 | |
1693 | |
1655 | () |
1694 | () |
1656 | } else { |
1695 | } else { |
1657 | $self->{rbuf} = ""; |
1696 | $_[0]{rbuf} = ""; |
1658 | |
1697 | |
1659 | () |
1698 | () |
1660 | } |
1699 | } |
1661 | } |
1700 | } |
1662 | }; |
1701 | }; |
… | |
… | |
1695 | # read remaining chunk |
1734 | # read remaining chunk |
1696 | $_[0]->unshift_read (chunk => $len, sub { |
1735 | $_[0]->unshift_read (chunk => $len, sub { |
1697 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1736 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1698 | $cb->($_[0], $ref); |
1737 | $cb->($_[0], $ref); |
1699 | } else { |
1738 | } else { |
1700 | $self->_error (Errno::EBADMSG); |
1739 | $_[0]->_error (Errno::EBADMSG); |
1701 | } |
1740 | } |
1702 | }); |
1741 | }); |
1703 | } |
1742 | } |
1704 | |
1743 | |
1705 | 1 |
1744 | 1 |
… | |
… | |
1743 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1782 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1744 | you change the C<on_read> callback or push/unshift a read callback, and it |
1783 | you change the C<on_read> callback or push/unshift a read callback, and it |
1745 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1784 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1746 | there are any read requests in the queue. |
1785 | there are any read requests in the queue. |
1747 | |
1786 | |
1748 | These methods will have no effect when in TLS mode (as TLS doesn't support |
1787 | In older versions of this module (<= 5.3), these methods had no effect, |
1749 | half-duplex connections). |
1788 | as TLS does not support half-duplex connections. In current versions they |
|
|
1789 | work as expected, as this behaviour is required to avoid certain resource |
|
|
1790 | attacks, where the program would be forced to read (and buffer) arbitrary |
|
|
1791 | amounts of data before being able to send some data. The drawback is that |
|
|
1792 | some readings of the the SSL/TLS specifications basically require this |
|
|
1793 | attack to be working, as SSL/TLS implementations might stall sending data |
|
|
1794 | during a rehandshake. |
|
|
1795 | |
|
|
1796 | As a guideline, during the initial handshake, you should not stop reading, |
|
|
1797 | and as a client, it might cause problems, depending on your applciation. |
1750 | |
1798 | |
1751 | =cut |
1799 | =cut |
1752 | |
1800 | |
1753 | sub stop_read { |
1801 | sub stop_read { |
1754 | my ($self) = @_; |
1802 | my ($self) = @_; |
1755 | |
1803 | |
1756 | delete $self->{_rw} unless $self->{tls}; |
1804 | delete $self->{_rw}; |
1757 | } |
1805 | } |
1758 | |
1806 | |
1759 | sub start_read { |
1807 | sub start_read { |
1760 | my ($self) = @_; |
1808 | my ($self) = @_; |
1761 | |
1809 | |
… | |
… | |
1963 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
2011 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
1964 | |
2012 | |
1965 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2013 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1966 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2014 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1967 | |
2015 | |
1968 | Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); |
2016 | Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf}); |
|
|
2017 | $self->{rbuf} = ""; |
1969 | |
2018 | |
1970 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
2019 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
1971 | |
2020 | |
1972 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
2021 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
1973 | if $self->{on_starttls}; |
2022 | if $self->{on_starttls}; |
… | |
… | |
2010 | $self->{tls_ctx}->_put_session (delete $self->{tls}) |
2059 | $self->{tls_ctx}->_put_session (delete $self->{tls}) |
2011 | if $self->{tls} > 0; |
2060 | if $self->{tls} > 0; |
2012 | |
2061 | |
2013 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
2062 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
2014 | } |
2063 | } |
|
|
2064 | |
|
|
2065 | =item $handle->resettls |
|
|
2066 | |
|
|
2067 | This rarely-used method simply resets and TLS state on the handle, usually |
|
|
2068 | causing data loss. |
|
|
2069 | |
|
|
2070 | One case where it may be useful is when you want to skip over the data in |
|
|
2071 | the stream but you are not interested in interpreting it, so data loss is |
|
|
2072 | no concern. |
|
|
2073 | |
|
|
2074 | =cut |
|
|
2075 | |
|
|
2076 | *resettls = \&_freetls; |
2015 | |
2077 | |
2016 | sub DESTROY { |
2078 | sub DESTROY { |
2017 | my ($self) = @_; |
2079 | my ($self) = @_; |
2018 | |
2080 | |
2019 | &_freetls; |
2081 | &_freetls; |
… | |
… | |
2135 | |
2197 | |
2136 | It is only safe to "forget" the reference inside EOF or error callbacks, |
2198 | It is only safe to "forget" the reference inside EOF or error callbacks, |
2137 | from within all other callbacks, you need to explicitly call the C<< |
2199 | from within all other callbacks, you need to explicitly call the C<< |
2138 | ->destroy >> method. |
2200 | ->destroy >> method. |
2139 | |
2201 | |
|
|
2202 | =item Why is my C<on_eof> callback never called? |
|
|
2203 | |
|
|
2204 | Probably because your C<on_error> callback is being called instead: When |
|
|
2205 | you have outstanding requests in your read queue, then an EOF is |
|
|
2206 | considered an error as you clearly expected some data. |
|
|
2207 | |
|
|
2208 | To avoid this, make sure you have an empty read queue whenever your handle |
|
|
2209 | is supposed to be "idle" (i.e. connection closes are O.K.). You can set |
|
|
2210 | an C<on_read> handler that simply pushes the first read requests in the |
|
|
2211 | queue. |
|
|
2212 | |
|
|
2213 | See also the next question, which explains this in a bit more detail. |
|
|
2214 | |
|
|
2215 | =item How can I serve requests in a loop? |
|
|
2216 | |
|
|
2217 | Most protocols consist of some setup phase (authentication for example) |
|
|
2218 | followed by a request handling phase, where the server waits for requests |
|
|
2219 | and handles them, in a loop. |
|
|
2220 | |
|
|
2221 | There are two important variants: The first (traditional, better) variant |
|
|
2222 | handles requests until the server gets some QUIT command, causing it to |
|
|
2223 | close the connection first (highly desirable for a busy TCP server). A |
|
|
2224 | client dropping the connection is an error, which means this variant can |
|
|
2225 | detect an unexpected detection close. |
|
|
2226 | |
|
|
2227 | To handle this case, always make sure you have a on-empty read queue, by |
|
|
2228 | pushing the "read request start" handler on it: |
|
|
2229 | |
|
|
2230 | # we assume a request starts with a single line |
|
|
2231 | my @start_request; @start_request = (line => sub { |
|
|
2232 | my ($hdl, $line) = @_; |
|
|
2233 | |
|
|
2234 | ... handle request |
|
|
2235 | |
|
|
2236 | # push next request read, possibly from a nested callback |
|
|
2237 | $hdl->push_read (@start_request); |
|
|
2238 | }); |
|
|
2239 | |
|
|
2240 | # auth done, now go into request handling loop |
|
|
2241 | # now push the first @start_request |
|
|
2242 | $hdl->push_read (@start_request); |
|
|
2243 | |
|
|
2244 | By always having an outstanding C<push_read>, the handle always expects |
|
|
2245 | some data and raises the C<EPIPE> error when the connction is dropped |
|
|
2246 | unexpectedly. |
|
|
2247 | |
|
|
2248 | The second variant is a protocol where the client can drop the connection |
|
|
2249 | at any time. For TCP, this means that the server machine may run out of |
|
|
2250 | sockets easier, and in general, it means you cannot distinguish a protocl |
|
|
2251 | failure/client crash from a normal connection close. Nevertheless, these |
|
|
2252 | kinds of protocols are common (and sometimes even the best solution to the |
|
|
2253 | problem). |
|
|
2254 | |
|
|
2255 | Having an outstanding read request at all times is possible if you ignore |
|
|
2256 | C<EPIPE> errors, but this doesn't help with when the client drops the |
|
|
2257 | connection during a request, which would still be an error. |
|
|
2258 | |
|
|
2259 | A better solution is to push the initial request read in an C<on_read> |
|
|
2260 | callback. This avoids an error, as when the server doesn't expect data |
|
|
2261 | (i.e. is idly waiting for the next request, an EOF will not raise an |
|
|
2262 | error, but simply result in an C<on_eof> callback. It is also a bit slower |
|
|
2263 | and simpler: |
|
|
2264 | |
|
|
2265 | # auth done, now go into request handling loop |
|
|
2266 | $hdl->on_read (sub { |
|
|
2267 | my ($hdl) = @_; |
|
|
2268 | |
|
|
2269 | # called each time we receive data but the read queue is empty |
|
|
2270 | # simply start read the request |
|
|
2271 | |
|
|
2272 | $hdl->push_read (line => sub { |
|
|
2273 | my ($hdl, $line) = @_; |
|
|
2274 | |
|
|
2275 | ... handle request |
|
|
2276 | |
|
|
2277 | # do nothing special when the request has been handled, just |
|
|
2278 | # let the request queue go empty. |
|
|
2279 | }); |
|
|
2280 | }); |
|
|
2281 | |
2140 | =item I get different callback invocations in TLS mode/Why can't I pause |
2282 | =item I get different callback invocations in TLS mode/Why can't I pause |
2141 | reading? |
2283 | reading? |
2142 | |
2284 | |
2143 | Unlike, say, TCP, TLS connections do not consist of two independent |
2285 | Unlike, say, TCP, TLS connections do not consist of two independent |
2144 | communication channels, one for each direction. Or put differently, the |
2286 | communication channels, one for each direction. Or put differently, the |
… | |
… | |
2165 | $handle->on_eof (undef); |
2307 | $handle->on_eof (undef); |
2166 | $handle->on_error (sub { |
2308 | $handle->on_error (sub { |
2167 | my $data = delete $_[0]{rbuf}; |
2309 | my $data = delete $_[0]{rbuf}; |
2168 | }); |
2310 | }); |
2169 | |
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 | |
2170 | 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 |
2171 | 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 |
2172 | fact all data has been received. |
2318 | fact all data has been received. |
2173 | |
2319 | |
2174 | It is usually better to use acknowledgements when transferring data, |
2320 | It is usually better to use acknowledgements when transferring data, |
… | |
… | |
2184 | 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 |
2185 | written to the socket: |
2331 | written to the socket: |
2186 | |
2332 | |
2187 | $handle->push_write (...); |
2333 | $handle->push_write (...); |
2188 | $handle->on_drain (sub { |
2334 | $handle->on_drain (sub { |
2189 | warn "all data submitted to the kernel\n"; |
2335 | AE::log debug => "all data submitted to the kernel\n"; |
2190 | undef $handle; |
2336 | undef $handle; |
2191 | }); |
2337 | }); |
2192 | |
2338 | |
2193 | 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, |
2194 | consider using C<< ->push_shutdown >> instead. |
2340 | consider using C<< ->push_shutdown >> instead. |