… | |
… | |
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 | AE::log warn => "got error $msg\n"; |
16 | AE::log error => $msg; |
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 | AE::log warn => "got line <$line>\n"; |
27 | say "got line <$line>"; |
28 | $cv->send; |
28 | $cv->send; |
29 | }); |
29 | }); |
30 | |
30 | |
31 | $cv->recv; |
31 | $cv->recv; |
32 | |
32 | |
… | |
… | |
128 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
128 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
129 | |
129 | |
130 | This callback is called when a connection has been successfully established. |
130 | This callback is called when a connection has been successfully established. |
131 | |
131 | |
132 | The peer's numeric host and port (the socket peername) are passed as |
132 | The peer's numeric host and port (the socket peername) are passed as |
133 | parameters, together with a retry callback. |
133 | parameters, together with a retry callback. At the time it is called the |
|
|
134 | read and write queues, EOF status, TLS status and similar properties of |
|
|
135 | the handle will have been reset. |
134 | |
136 | |
|
|
137 | It is not allowed to use the read or write queues while the handle object |
|
|
138 | is connecting. |
|
|
139 | |
135 | If, for some reason, the handle is not acceptable, calling C<$retry> |
140 | If, for some reason, the handle is not acceptable, calling C<$retry> will |
136 | will continue with the next connection target (in case of multi-homed |
141 | continue with the next connection target (in case of multi-homed hosts or |
137 | hosts or SRV records there can be multiple connection endpoints). At the |
142 | SRV records there can be multiple connection endpoints). The C<$retry> |
138 | time it is called the read and write queues, eof status, tls status and |
143 | callback can be invoked after the connect callback returns, i.e. one can |
139 | similar properties of the handle will have been reset. |
144 | start a handshake and then decide to retry with the next host if the |
|
|
145 | handshake fails. |
140 | |
146 | |
141 | In most cases, you should ignore the C<$retry> parameter. |
147 | In most cases, you should ignore the C<$retry> parameter. |
142 | |
148 | |
143 | =item on_connect_error => $cb->($handle, $message) |
149 | =item on_connect_error => $cb->($handle, $message) |
144 | |
150 | |
… | |
… | |
164 | with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In |
170 | with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In |
165 | cases where the other side can close the connection at will, it is |
171 | cases where the other side can close the connection at will, it is |
166 | often easiest to not report C<EPIPE> errors in this callback. |
172 | often easiest to not report C<EPIPE> errors in this callback. |
167 | |
173 | |
168 | AnyEvent::Handle tries to find an appropriate error code for you to check |
174 | AnyEvent::Handle tries to find an appropriate error code for you to check |
169 | against, but in some cases (TLS errors), this does not work well. It is |
175 | against, but in some cases (TLS errors), this does not work well. |
170 | recommended to always output the C<$message> argument in human-readable |
176 | |
171 | error messages (it's usually the same as C<"$!">). |
177 | If you report the error to the user, it is recommended to always output |
|
|
178 | the C<$message> argument in human-readable error messages (you don't need |
|
|
179 | to report C<"$!"> if you report C<$message>). |
|
|
180 | |
|
|
181 | If you want to react programmatically to the error, then looking at C<$!> |
|
|
182 | and comparing it against some of the documented C<Errno> values is usually |
|
|
183 | better than looking at the C<$message>. |
172 | |
184 | |
173 | Non-fatal errors can be retried by returning, but it is recommended |
185 | Non-fatal errors can be retried by returning, but it is recommended |
174 | to simply ignore this parameter and instead abondon the handle object |
186 | to simply ignore this parameter and instead abondon the handle object |
175 | when this callback is invoked. Examples of non-fatal errors are timeouts |
187 | when this callback is invoked. Examples of non-fatal errors are timeouts |
176 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
188 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
… | |
… | |
224 | If an EOF condition has been detected but no C<on_eof> callback has been |
236 | If an EOF condition has been detected but no C<on_eof> callback has been |
225 | set, then a fatal error will be raised with C<$!> set to <0>. |
237 | set, then a fatal error will be raised with C<$!> set to <0>. |
226 | |
238 | |
227 | =item on_drain => $cb->($handle) |
239 | =item on_drain => $cb->($handle) |
228 | |
240 | |
229 | This sets the callback that is called when the write buffer becomes empty |
241 | This sets the callback that is called once when the write buffer becomes |
230 | (or immediately if the buffer is empty already). |
242 | empty (and immediately when the handle object is created). |
231 | |
243 | |
232 | To append to the write buffer, use the C<< ->push_write >> method. |
244 | To append to the write buffer, use the C<< ->push_write >> method. |
233 | |
245 | |
234 | This callback is useful when you don't want to put all of your write data |
246 | This callback is useful when you don't want to put all of your write data |
235 | into the queue at once, for example, when you want to write the contents |
247 | into the queue at once, for example, when you want to write the contents |
… | |
… | |
417 | appropriate error message. |
429 | appropriate error message. |
418 | |
430 | |
419 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
431 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
420 | automatically when you try to create a TLS handle): this module doesn't |
432 | automatically when you try to create a TLS handle): this module doesn't |
421 | have a dependency on that module, so if your module requires it, you have |
433 | have a dependency on that module, so if your module requires it, you have |
422 | to add the dependency yourself. |
434 | to add the dependency yourself. If Net::SSLeay cannot be loaded or is too |
|
|
435 | old, you get an C<EPROTO> error. |
423 | |
436 | |
424 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
437 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
425 | C<accept>, and for the TLS client side of a connection, use C<connect> |
438 | C<accept>, and for the TLS client side of a connection, use C<connect> |
426 | mode. |
439 | mode. |
427 | |
440 | |
… | |
… | |
880 | |
893 | |
881 | The write queue is very simple: you can add data to its end, and |
894 | The write queue is very simple: you can add data to its end, and |
882 | AnyEvent::Handle will automatically try to get rid of it for you. |
895 | AnyEvent::Handle will automatically try to get rid of it for you. |
883 | |
896 | |
884 | When data could be written and the write buffer is shorter then the low |
897 | When data could be written and the write buffer is shorter then the low |
885 | water mark, the C<on_drain> callback will be invoked. |
898 | water mark, the C<on_drain> callback will be invoked once. |
886 | |
899 | |
887 | =over 4 |
900 | =over 4 |
888 | |
901 | |
889 | =item $handle->on_drain ($cb) |
902 | =item $handle->on_drain ($cb) |
890 | |
903 | |
… | |
… | |
1081 | =cut |
1094 | =cut |
1082 | |
1095 | |
1083 | register_write_type storable => sub { |
1096 | register_write_type storable => sub { |
1084 | my ($self, $ref) = @_; |
1097 | my ($self, $ref) = @_; |
1085 | |
1098 | |
1086 | require Storable; |
1099 | require Storable unless $Storable::VERSION; |
1087 | |
1100 | |
1088 | pack "w/a*", Storable::nfreeze ($ref) |
1101 | pack "w/a*", Storable::nfreeze ($ref) |
1089 | }; |
1102 | }; |
1090 | |
1103 | |
1091 | =back |
1104 | =back |
… | |
… | |
1128 | |
1141 | |
1129 | Whenever the given C<type> is used, C<push_write> will the function with |
1142 | Whenever the given C<type> is used, C<push_write> will the function with |
1130 | the handle object and the remaining arguments. |
1143 | the handle object and the remaining arguments. |
1131 | |
1144 | |
1132 | The function is supposed to return a single octet string that will be |
1145 | The function is supposed to return a single octet string that will be |
1133 | appended to the write buffer, so you cna mentally treat this function as a |
1146 | appended to the write buffer, so you can mentally treat this function as a |
1134 | "arguments to on-the-wire-format" converter. |
1147 | "arguments to on-the-wire-format" converter. |
1135 | |
1148 | |
1136 | Example: implement a custom write type C<join> that joins the remaining |
1149 | Example: implement a custom write type C<join> that joins the remaining |
1137 | arguments using the first one. |
1150 | arguments using the first one. |
1138 | |
1151 | |
… | |
… | |
1432 | data. |
1445 | data. |
1433 | |
1446 | |
1434 | Example: read 2 bytes. |
1447 | Example: read 2 bytes. |
1435 | |
1448 | |
1436 | $handle->push_read (chunk => 2, sub { |
1449 | $handle->push_read (chunk => 2, sub { |
1437 | AE::log debug => "yay " . unpack "H*", $_[1]; |
1450 | say "yay " . unpack "H*", $_[1]; |
1438 | }); |
1451 | }); |
1439 | |
1452 | |
1440 | =cut |
1453 | =cut |
1441 | |
1454 | |
1442 | register_read_type chunk => sub { |
1455 | register_read_type chunk => sub { |
… | |
… | |
1476 | if (@_ < 3) { |
1489 | if (@_ < 3) { |
1477 | # this is more than twice as fast as the generic code below |
1490 | # this is more than twice as fast as the generic code below |
1478 | sub { |
1491 | sub { |
1479 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1492 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1480 | |
1493 | |
1481 | $cb->($_[0], $1, $2); |
1494 | $cb->($_[0], "$1", "$2"); |
1482 | 1 |
1495 | 1 |
1483 | } |
1496 | } |
1484 | } else { |
1497 | } else { |
1485 | $eol = quotemeta $eol unless ref $eol; |
1498 | $eol = quotemeta $eol unless ref $eol; |
1486 | $eol = qr|^(.*?)($eol)|s; |
1499 | $eol = qr|^(.*?)($eol)|s; |
1487 | |
1500 | |
1488 | sub { |
1501 | sub { |
1489 | $_[0]{rbuf} =~ s/$eol// or return; |
1502 | $_[0]{rbuf} =~ s/$eol// or return; |
1490 | |
1503 | |
1491 | $cb->($_[0], $1, $2); |
1504 | $cb->($_[0], "$1", "$2"); |
1492 | 1 |
1505 | 1 |
1493 | } |
1506 | } |
1494 | } |
1507 | } |
1495 | }; |
1508 | }; |
1496 | |
1509 | |
… | |
… | |
1711 | =cut |
1724 | =cut |
1712 | |
1725 | |
1713 | register_read_type storable => sub { |
1726 | register_read_type storable => sub { |
1714 | my ($self, $cb) = @_; |
1727 | my ($self, $cb) = @_; |
1715 | |
1728 | |
1716 | require Storable; |
1729 | require Storable unless $Storable::VERSION; |
1717 | |
1730 | |
1718 | sub { |
1731 | sub { |
1719 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1732 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1720 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1733 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1721 | or return; |
1734 | or return; |
… | |
… | |
1724 | |
1737 | |
1725 | # bypass unshift if we already have the remaining chunk |
1738 | # bypass unshift if we already have the remaining chunk |
1726 | if ($format + $len <= length $_[0]{rbuf}) { |
1739 | if ($format + $len <= length $_[0]{rbuf}) { |
1727 | my $data = substr $_[0]{rbuf}, $format, $len; |
1740 | my $data = substr $_[0]{rbuf}, $format, $len; |
1728 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
1741 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1742 | |
1729 | $cb->($_[0], Storable::thaw ($data)); |
1743 | eval { $cb->($_[0], Storable::thaw ($data)); 1 } |
|
|
1744 | or return $_[0]->_error (Errno::EBADMSG); |
1730 | } else { |
1745 | } else { |
1731 | # remove prefix |
1746 | # remove prefix |
1732 | substr $_[0]{rbuf}, 0, $format, ""; |
1747 | substr $_[0]{rbuf}, 0, $format, ""; |
1733 | |
1748 | |
1734 | # read remaining chunk |
1749 | # read remaining chunk |
1735 | $_[0]->unshift_read (chunk => $len, sub { |
1750 | $_[0]->unshift_read (chunk => $len, sub { |
1736 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1751 | eval { $cb->($_[0], Storable::thaw ($_[1])); 1 } |
1737 | $cb->($_[0], $ref); |
|
|
1738 | } else { |
|
|
1739 | $_[0]->_error (Errno::EBADMSG); |
1752 | or $_[0]->_error (Errno::EBADMSG); |
1740 | } |
|
|
1741 | }); |
1753 | }); |
1742 | } |
1754 | } |
1743 | |
1755 | |
1744 | 1 |
1756 | 1 |
1745 | } |
1757 | } |
|
|
1758 | }; |
|
|
1759 | |
|
|
1760 | =item tls_detect => $cb->($handle, $detect, $major, $minor) |
|
|
1761 | |
|
|
1762 | Checks the input stream for a valid SSL or TLS handshake TLSPaintext |
|
|
1763 | record without consuming anything. Only SSL version 3 or higher |
|
|
1764 | is handled, up to the fictituous protocol 4.x (but both SSL3+ and |
|
|
1765 | SSL2-compatible framing is supported). |
|
|
1766 | |
|
|
1767 | If it detects that the input data is likely TLS, it calls the callback |
|
|
1768 | with a true value for C<$detect> and the (on-wire) TLS version as second |
|
|
1769 | and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL |
|
|
1770 | 3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to |
|
|
1771 | be definitely not TLS, it calls the callback with a false value for |
|
|
1772 | C<$detect>. |
|
|
1773 | |
|
|
1774 | The callback could use this information to decide whether or not to start |
|
|
1775 | TLS negotiation. |
|
|
1776 | |
|
|
1777 | In all cases the data read so far is passed to the following read |
|
|
1778 | handlers. |
|
|
1779 | |
|
|
1780 | Usually you want to use the C<tls_autostart> read type instead. |
|
|
1781 | |
|
|
1782 | If you want to design a protocol that works in the presence of TLS |
|
|
1783 | dtection, make sure that any non-TLS data doesn't start with the octet 22 |
|
|
1784 | (ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this |
|
|
1785 | read type does are a bit more strict, but might losen in the future to |
|
|
1786 | accomodate protocol changes. |
|
|
1787 | |
|
|
1788 | This read type does not rely on L<AnyEvent::TLS> (and thus, not on |
|
|
1789 | L<Net::SSLeay>). |
|
|
1790 | |
|
|
1791 | =item tls_autostart => $tls[, $tls_ctx] |
|
|
1792 | |
|
|
1793 | Tries to detect a valid SSL or TLS handshake. If one is detected, it tries |
|
|
1794 | to start tls by calling C<starttls> with the given arguments. |
|
|
1795 | |
|
|
1796 | In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has |
|
|
1797 | been configured to accept, as servers do not normally send a handshake on |
|
|
1798 | their own and ths cannot be detected in this way. |
|
|
1799 | |
|
|
1800 | See C<tls_detect> above for more details. |
|
|
1801 | |
|
|
1802 | Example: give the client a chance to start TLS before accepting a text |
|
|
1803 | line. |
|
|
1804 | |
|
|
1805 | $hdl->push_read (tls_detect => "accept"); |
|
|
1806 | $hdl->push_read (line => sub { |
|
|
1807 | print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n"; |
|
|
1808 | }); |
|
|
1809 | |
|
|
1810 | =cut |
|
|
1811 | |
|
|
1812 | register_read_type tls_detect => sub { |
|
|
1813 | my ($self, $cb) = @_; |
|
|
1814 | |
|
|
1815 | sub { |
|
|
1816 | # this regex matches a full or partial tls record |
|
|
1817 | if ( |
|
|
1818 | # ssl3+: type(22=handshake) major(=3) minor(any) length_hi |
|
|
1819 | $self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs |
|
|
1820 | # ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength) |
|
|
1821 | or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs |
|
|
1822 | ) { |
|
|
1823 | return if 3 != length $1; # partial match, can't decide yet |
|
|
1824 | |
|
|
1825 | # full match, valid TLS record |
|
|
1826 | my ($major, $minor) = unpack "CC", $1; |
|
|
1827 | $cb->($self, "accept", $major + $minor * 0.1); |
|
|
1828 | } else { |
|
|
1829 | # mismatch == guaranteed not TLS |
|
|
1830 | $cb->($self, undef); |
|
|
1831 | } |
|
|
1832 | |
|
|
1833 | 1 |
|
|
1834 | } |
|
|
1835 | }; |
|
|
1836 | |
|
|
1837 | register_read_type tls_autostart => sub { |
|
|
1838 | my ($self, @tls) = @_; |
|
|
1839 | |
|
|
1840 | $RH{tls_detect}($self, sub { |
|
|
1841 | return unless $_[1]; |
|
|
1842 | $_[0]->starttls (@tls); |
|
|
1843 | }) |
1746 | }; |
1844 | }; |
1747 | |
1845 | |
1748 | =back |
1846 | =back |
1749 | |
1847 | |
1750 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
1848 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
… | |
… | |
1792 | some readings of the the SSL/TLS specifications basically require this |
1890 | some readings of the the SSL/TLS specifications basically require this |
1793 | attack to be working, as SSL/TLS implementations might stall sending data |
1891 | attack to be working, as SSL/TLS implementations might stall sending data |
1794 | during a rehandshake. |
1892 | during a rehandshake. |
1795 | |
1893 | |
1796 | As a guideline, during the initial handshake, you should not stop reading, |
1894 | 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. |
1895 | and as a client, it might cause problems, depending on your application. |
1798 | |
1896 | |
1799 | =cut |
1897 | =cut |
1800 | |
1898 | |
1801 | sub stop_read { |
1899 | sub stop_read { |
1802 | my ($self) = @_; |
1900 | my ($self) = @_; |
… | |
… | |
1850 | my ($self, $err) = @_; |
1948 | my ($self, $err) = @_; |
1851 | |
1949 | |
1852 | return $self->_error ($!, 1) |
1950 | return $self->_error ($!, 1) |
1853 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
1951 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
1854 | |
1952 | |
1855 | my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
1953 | my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
1856 | |
1954 | |
1857 | # reduce error string to look less scary |
1955 | # reduce error string to look less scary |
1858 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
1956 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
1859 | |
1957 | |
1860 | if ($self->{_on_starttls}) { |
1958 | if ($self->{_on_starttls}) { |
… | |
… | |
1926 | |
2024 | |
1927 | =item $handle->starttls ($tls[, $tls_ctx]) |
2025 | =item $handle->starttls ($tls[, $tls_ctx]) |
1928 | |
2026 | |
1929 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
2027 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1930 | object is created, you can also do that at a later time by calling |
2028 | object is created, you can also do that at a later time by calling |
1931 | C<starttls>. |
2029 | C<starttls>. See the C<tls> constructor argument for general info. |
1932 | |
2030 | |
1933 | Starting TLS is currently an asynchronous operation - when you push some |
2031 | Starting TLS is currently an asynchronous operation - when you push some |
1934 | write data and then call C<< ->starttls >> then TLS negotiation will start |
2032 | write data and then call C<< ->starttls >> then TLS negotiation will start |
1935 | immediately, after which the queued write data is then sent. |
2033 | immediately, after which the queued write data is then sent. This might |
|
|
2034 | change in future versions, so best make sure you have no outstanding write |
|
|
2035 | data when calling this method. |
1936 | |
2036 | |
1937 | The first argument is the same as the C<tls> constructor argument (either |
2037 | The first argument is the same as the C<tls> constructor argument (either |
1938 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
2038 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1939 | |
2039 | |
1940 | The second argument is the optional C<AnyEvent::TLS> object that is used |
2040 | The second argument is the optional C<AnyEvent::TLS> object that is used |
… | |
… | |
1962 | my ($self, $tls, $ctx) = @_; |
2062 | my ($self, $tls, $ctx) = @_; |
1963 | |
2063 | |
1964 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
2064 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
1965 | if $self->{tls}; |
2065 | if $self->{tls}; |
1966 | |
2066 | |
|
|
2067 | unless (defined $AnyEvent::TLS::VERSION) { |
|
|
2068 | eval { |
|
|
2069 | require Net::SSLeay; |
|
|
2070 | require AnyEvent::TLS; |
|
|
2071 | 1 |
|
|
2072 | } or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system"); |
|
|
2073 | } |
|
|
2074 | |
1967 | $self->{tls} = $tls; |
2075 | $self->{tls} = $tls; |
1968 | $self->{tls_ctx} = $ctx if @_ > 2; |
2076 | $self->{tls_ctx} = $ctx if @_ > 2; |
1969 | |
2077 | |
1970 | return unless $self->{fh}; |
2078 | return unless $self->{fh}; |
1971 | |
2079 | |
1972 | require Net::SSLeay; |
|
|
1973 | |
|
|
1974 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
2080 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1975 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
2081 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1976 | |
2082 | |
1977 | $tls = delete $self->{tls}; |
2083 | $tls = delete $self->{tls}; |
1978 | $ctx = $self->{tls_ctx}; |
2084 | $ctx = $self->{tls_ctx}; |
1979 | |
2085 | |
1980 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
2086 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1981 | |
2087 | |
1982 | if ("HASH" eq ref $ctx) { |
2088 | if ("HASH" eq ref $ctx) { |
1983 | require AnyEvent::TLS; |
|
|
1984 | |
|
|
1985 | if ($ctx->{cache}) { |
2089 | if ($ctx->{cache}) { |
1986 | my $key = $ctx+0; |
2090 | my $key = $ctx+0; |
1987 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
2091 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
1988 | } else { |
2092 | } else { |
1989 | $ctx = new AnyEvent::TLS %$ctx; |
2093 | $ctx = new AnyEvent::TLS %$ctx; |
… | |
… | |
2204 | Probably because your C<on_error> callback is being called instead: When |
2308 | 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 |
2309 | you have outstanding requests in your read queue, then an EOF is |
2206 | considered an error as you clearly expected some data. |
2310 | considered an error as you clearly expected some data. |
2207 | |
2311 | |
2208 | To avoid this, make sure you have an empty read queue whenever your handle |
2312 | 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 cna set |
2313 | 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 |
2314 | an C<on_read> handler that simply pushes the first read requests in the |
2211 | queue. |
2315 | queue. |
2212 | |
2316 | |
2213 | See also the next question, which explains this in a bit more detail. |
2317 | See also the next question, which explains this in a bit more detail. |
2214 | |
2318 | |
… | |
… | |
2222 | handles requests until the server gets some QUIT command, causing it to |
2326 | 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 |
2327 | 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 |
2328 | client dropping the connection is an error, which means this variant can |
2225 | detect an unexpected detection close. |
2329 | detect an unexpected detection close. |
2226 | |
2330 | |
2227 | To handle this case, always make sure you have a on-empty read queue, by |
2331 | To handle this case, always make sure you have a non-empty read queue, by |
2228 | pushing the "read request start" handler on it: |
2332 | pushing the "read request start" handler on it: |
2229 | |
2333 | |
2230 | # we assume a request starts with a single line |
2334 | # we assume a request starts with a single line |
2231 | my @start_request; @start_request = (line => sub { |
2335 | my @start_request; @start_request = (line => sub { |
2232 | my ($hdl, $line) = @_; |
2336 | my ($hdl, $line) = @_; |
… | |
… | |
2245 | some data and raises the C<EPIPE> error when the connction is dropped |
2349 | some data and raises the C<EPIPE> error when the connction is dropped |
2246 | unexpectedly. |
2350 | unexpectedly. |
2247 | |
2351 | |
2248 | The second variant is a protocol where the client can drop the connection |
2352 | 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 |
2353 | at any time. For TCP, this means that the server machine may run out of |
2250 | sockets easier, and in general, it means you cnanot distinguish a protocl |
2354 | sockets easier, and in general, it means you cannot distinguish a protocl |
2251 | failure/client crash from a normal connection close. Nevertheless, these |
2355 | failure/client crash from a normal connection close. Nevertheless, these |
2252 | kinds of protocols are common (and sometimes even the best solution to the |
2356 | kinds of protocols are common (and sometimes even the best solution to the |
2253 | problem). |
2357 | problem). |
2254 | |
2358 | |
2255 | Having an outstanding read request at all times is possible if you ignore |
2359 | Having an outstanding read request at all times is possible if you ignore |
… | |
… | |
2330 | C<low_water_mark> this will be called precisely when all data has been |
2434 | C<low_water_mark> this will be called precisely when all data has been |
2331 | written to the socket: |
2435 | written to the socket: |
2332 | |
2436 | |
2333 | $handle->push_write (...); |
2437 | $handle->push_write (...); |
2334 | $handle->on_drain (sub { |
2438 | $handle->on_drain (sub { |
2335 | AE::log debug => "all data submitted to the kernel\n"; |
2439 | AE::log debug => "All data submitted to the kernel."; |
2336 | undef $handle; |
2440 | undef $handle; |
2337 | }); |
2441 | }); |
2338 | |
2442 | |
2339 | If you just want to queue some data and then signal EOF to the other side, |
2443 | If you just want to queue some data and then signal EOF to the other side, |
2340 | consider using C<< ->push_shutdown >> instead. |
2444 | consider using C<< ->push_shutdown >> instead. |
… | |
… | |
2424 | When you have intermediate CA certificates that your clients might not |
2528 | When you have intermediate CA certificates that your clients might not |
2425 | know about, just append them to the C<cert_file>. |
2529 | know about, just append them to the C<cert_file>. |
2426 | |
2530 | |
2427 | =back |
2531 | =back |
2428 | |
2532 | |
2429 | |
|
|
2430 | =head1 SUBCLASSING AnyEvent::Handle |
2533 | =head1 SUBCLASSING AnyEvent::Handle |
2431 | |
2534 | |
2432 | In many cases, you might want to subclass AnyEvent::Handle. |
2535 | In many cases, you might want to subclass AnyEvent::Handle. |
2433 | |
2536 | |
2434 | To make this easier, a given version of AnyEvent::Handle uses these |
2537 | To make this easier, a given version of AnyEvent::Handle uses these |
… | |
… | |
2460 | |
2563 | |
2461 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2564 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2462 | |
2565 | |
2463 | =cut |
2566 | =cut |
2464 | |
2567 | |
2465 | 1; # End of AnyEvent::Handle |
2568 | 1 |
|
|
2569 | |