ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent/Handle.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.232 by root, Fri Mar 30 03:11:17 2012 UTC vs.
Revision 1.244 by root, Wed Apr 1 19:59:01 2015 UTC

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 error => "Got error $msg!"; 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
53package AnyEvent::Handle; 53package AnyEvent::Handle;
54 54
55use Scalar::Util (); 55use Scalar::Util ();
56use List::Util (); 56use List::Util ();
57use Carp (); 57use Carp ();
58use Errno qw(EAGAIN EINTR); 58use Errno qw(EAGAIN EWOULDBLOCK EINTR);
59 59
60use AnyEvent (); BEGIN { AnyEvent::common_sense } 60use AnyEvent (); BEGIN { AnyEvent::common_sense }
61use AnyEvent::Util qw(WSAEWOULDBLOCK); 61use AnyEvent::Util qw(WSAEWOULDBLOCK);
62 62
63our $VERSION = $AnyEvent::VERSION; 63our $VERSION = $AnyEvent::VERSION;
132The peer's numeric host and port (the socket peername) are passed as 132The peer's numeric host and port (the socket peername) are passed as
133parameters, together with a retry callback. At the time it is called the 133parameters, together with a retry callback. At the time it is called the
134read and write queues, EOF status, TLS status and similar properties of 134read and write queues, EOF status, TLS status and similar properties of
135the handle will have been reset. 135the handle will have been reset.
136 136
137It is not allowed to use the read or write queues while the handle object
138is connecting.
139
140If, for some reason, the handle is not acceptable, calling C<$retry> will 137If, for some reason, the handle is not acceptable, calling C<$retry> will
141continue with the next connection target (in case of multi-homed hosts or 138continue with the next connection target (in case of multi-homed hosts or
142SRV records there can be multiple connection endpoints). The C<$retry> 139SRV records there can be multiple connection endpoints). The C<$retry>
143callback can be invoked after the connect callback returns, i.e. one can 140callback can be invoked after the connect callback returns, i.e. one can
144start a handshake and then decide to retry with the next host if the 141start a handshake and then decide to retry with the next host if the
170with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In 167with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
171cases where the other side can close the connection at will, it is 168cases where the other side can close the connection at will, it is
172often easiest to not report C<EPIPE> errors in this callback. 169often easiest to not report C<EPIPE> errors in this callback.
173 170
174AnyEvent::Handle tries to find an appropriate error code for you to check 171AnyEvent::Handle tries to find an appropriate error code for you to check
175against, but in some cases (TLS errors), this does not work well. It is 172against, but in some cases (TLS errors), this does not work well.
176recommended to always output the C<$message> argument in human-readable 173
177error messages (it's usually the same as C<"$!">). 174If you report the error to the user, it is recommended to always output
175the C<$message> argument in human-readable error messages (you don't need
176to report C<"$!"> if you report C<$message>).
177
178If you want to react programmatically to the error, then looking at C<$!>
179and comparing it against some of the documented C<Errno> values is usually
180better than looking at the C<$message>.
178 181
179Non-fatal errors can be retried by returning, but it is recommended 182Non-fatal errors can be retried by returning, but it is recommended
180to simply ignore this parameter and instead abondon the handle object 183to simply ignore this parameter and instead abondon the handle object
181when this callback is invoked. Examples of non-fatal errors are timeouts 184when this callback is invoked. Examples of non-fatal errors are timeouts
182C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 185C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
423appropriate error message. 426appropriate error message.
424 427
425TLS mode requires Net::SSLeay to be installed (it will be loaded 428TLS mode requires Net::SSLeay to be installed (it will be loaded
426automatically when you try to create a TLS handle): this module doesn't 429automatically when you try to create a TLS handle): this module doesn't
427have a dependency on that module, so if your module requires it, you have 430have a dependency on that module, so if your module requires it, you have
428to add the dependency yourself. 431to add the dependency yourself. If Net::SSLeay cannot be loaded or is too
432old, you get an C<EPROTO> error.
429 433
430Unlike TCP, TLS has a server and client side: for the TLS server side, use 434Unlike TCP, TLS has a server and client side: for the TLS server side, use
431C<accept>, and for the TLS client side of a connection, use C<connect> 435C<accept>, and for the TLS client side of a connection, use C<connect>
432mode. 436mode.
433 437
489callback. 493callback.
490 494
491This callback will only be called on TLS shutdowns, not when the 495This callback will only be called on TLS shutdowns, not when the
492underlying handle signals EOF. 496underlying handle signals EOF.
493 497
494=item json => JSON or JSON::XS object 498=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
495 499
496This is the json coder object used by the C<json> read and write types. 500This is the json coder object used by the C<json> read and write types.
497 501
498If you don't supply it, then AnyEvent::Handle will create and use a 502If you don't supply it, then AnyEvent::Handle will create and use a
499suitable one (on demand), which will write and expect UTF-8 encoded JSON 503suitable one (on demand), which will write and expect UTF-8 encoded
504JSON texts (either using L<JSON::XS> or L<JSON>). The written texts are
505guaranteed not to contain any newline character.
506
507For security reasons, this encoder will likely I<not> handle numbers and
508strings, only arrays and objects/hashes. The reason is that originally
509JSON was self-delimited, but Dougles Crockford thought it was a splendid
510idea to redefine JSON incompatibly, so this is no longer true.
511
512For protocols that used back-to-back JSON texts, this might lead to
513run-ins, where two or more JSON texts will be interpreted as one JSON
500texts. 514text.
501 515
516For this reason, if the default encoder uses L<JSON::XS>, it will default
517to not allowing anything but arrays and objects/hashes, at least for the
518forseeable future (it will change at some point). This might or might not
519be true for the L<JSON> module, so this might cause a security issue.
520
521If you depend on either behaviour, you should create your own json object
522and pass it in explicitly.
523
524=item cbor => L<CBOR::XS> object
525
526This is the cbor coder object used by the C<cbor> read and write types.
527
528If you don't supply it, then AnyEvent::Handle will create and use a
529suitable one (on demand), which will write CBOR without using extensions,
530if possible.
531
502Note that you are responsible to depend on the JSON module if you want to 532Note that you are responsible to depend on the L<CBOR::XS> module if you
503use this functionality, as AnyEvent does not have a dependency itself. 533want to use this functionality, as AnyEvent does not have a dependency on
534it itself.
504 535
505=back 536=back
506 537
507=cut 538=cut
508 539
940 $self->{on_drain}($self) 971 $self->{on_drain}($self)
941 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) 972 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
942 && $self->{on_drain}; 973 && $self->{on_drain};
943 974
944 delete $self->{_ww} unless length $self->{wbuf}; 975 delete $self->{_ww} unless length $self->{wbuf};
945 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 976 } elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
946 $self->_error ($!, 1); 977 $self->_error ($!, 1);
947 } 978 }
948 }; 979 };
949 980
950 # try to write data immediately 981 # try to write data immediately
1038 1069
1039Encodes the given hash or array reference into a JSON object. Unless you 1070Encodes the given hash or array reference into a JSON object. Unless you
1040provide your own JSON object, this means it will be encoded to JSON text 1071provide your own JSON object, this means it will be encoded to JSON text
1041in UTF-8. 1072in UTF-8.
1042 1073
1074The default encoder might or might not handle every type of JSON value -
1075it might be limited to arrays and objects for security reasons. See the
1076C<json> constructor attribute for more details.
1077
1043JSON objects (and arrays) are self-delimiting, so you can write JSON at 1078JSON objects (and arrays) are self-delimiting, so if you only use arrays
1044one end of a handle and read them at the other end without using any 1079and hashes, you can write JSON at one end of a handle and read them at the
1045additional framing. 1080other end without using any additional framing.
1046 1081
1047The generated JSON text is guaranteed not to contain any newlines: While 1082The JSON text generated by the default encoder is guaranteed not to
1048this module doesn't need delimiters after or between JSON texts to be 1083contain any newlines: While this module doesn't need delimiters after or
1049able to read them, many other languages depend on that. 1084between JSON texts to be able to read them, many other languages depend on
1085them.
1050 1086
1051A simple RPC protocol that interoperates easily with others is to send 1087A simple RPC protocol that interoperates easily with other languages is
1052JSON arrays (or objects, although arrays are usually the better choice as 1088to send JSON arrays (or objects, although arrays are usually the better
1053they mimic how function argument passing works) and a newline after each 1089choice as they mimic how function argument passing works) and a newline
1054JSON text: 1090after each JSON text:
1055 1091
1056 $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever 1092 $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1057 $handle->push_write ("\012"); 1093 $handle->push_write ("\012");
1058 1094
1059An AnyEvent::Handle receiver would simply use the C<json> read type and 1095An AnyEvent::Handle receiver would simply use the C<json> read type and
1062 $handle->push_read (json => sub { my $array = $_[1]; ... }); 1098 $handle->push_read (json => sub { my $array = $_[1]; ... });
1063 1099
1064Other languages could read single lines terminated by a newline and pass 1100Other languages could read single lines terminated by a newline and pass
1065this line into their JSON decoder of choice. 1101this line into their JSON decoder of choice.
1066 1102
1103=item cbor => $perl_scalar
1104
1105Encodes the given scalar into a CBOR value. Unless you provide your own
1106L<CBOR::XS> object, this means it will be encoded to a CBOR string not
1107using any extensions, if possible.
1108
1109CBOR values are self-delimiting, so you can write CBOR at one end of
1110a handle and read them at the other end without using any additional
1111framing.
1112
1113A simple nd very very fast RPC protocol that interoperates with
1114other languages is to send CBOR and receive CBOR values (arrays are
1115recommended):
1116
1117 $handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
1118
1119An AnyEvent::Handle receiver would simply use the C<cbor> read type:
1120
1121 $handle->push_read (cbor => sub { my $array = $_[1]; ... });
1122
1067=cut 1123=cut
1068 1124
1069sub json_coder() { 1125sub json_coder() {
1070 eval { require JSON::XS; JSON::XS->new->utf8 } 1126 eval { require JSON::XS; JSON::XS->new->utf8 }
1071 || do { require JSON; JSON->new->utf8 } 1127 || do { require JSON::PP; JSON::PP->new->utf8 }
1072} 1128}
1073 1129
1074register_write_type json => sub { 1130register_write_type json => sub {
1075 my ($self, $ref) = @_; 1131 my ($self, $ref) = @_;
1076 1132
1077 my $json = $self->{json} ||= json_coder; 1133 ($self->{json} ||= json_coder)
1078
1079 $json->encode ($ref) 1134 ->encode ($ref)
1135};
1136
1137sub cbor_coder() {
1138 require CBOR::XS;
1139 CBOR::XS->new
1140}
1141
1142register_write_type cbor => sub {
1143 my ($self, $scalar) = @_;
1144
1145 ($self->{cbor} ||= cbor_coder)
1146 ->encode ($scalar)
1080}; 1147};
1081 1148
1082=item storable => $reference 1149=item storable => $reference
1083 1150
1084Freezes the given reference using L<Storable> and writes it to the 1151Freezes the given reference using L<Storable> and writes it to the
1478 1545
1479register_read_type line => sub { 1546register_read_type line => sub {
1480 my ($self, $cb, $eol) = @_; 1547 my ($self, $cb, $eol) = @_;
1481 1548
1482 if (@_ < 3) { 1549 if (@_ < 3) {
1483 # this is more than twice as fast as the generic code below 1550 # this is faster then the generic code below
1484 sub { 1551 sub {
1485 $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; 1552 (my $pos = index $_[0]{rbuf}, "\012") >= 0
1553 or return;
1486 1554
1555 (my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1487 $cb->($_[0], "$1", "$2"); 1556 $cb->($_[0], $str, "$1");
1488 1 1557 1
1489 } 1558 }
1490 } else { 1559 } else {
1491 $eol = quotemeta $eol unless ref $eol; 1560 $eol = quotemeta $eol unless ref $eol;
1492 $eol = qr|^(.*?)($eol)|s; 1561 $eol = qr|^(.*?)($eol)|s;
1501}; 1570};
1502 1571
1503=item regex => $accept[, $reject[, $skip], $cb->($handle, $data) 1572=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
1504 1573
1505Makes a regex match against the regex object C<$accept> and returns 1574Makes a regex match against the regex object C<$accept> and returns
1506everything up to and including the match. 1575everything up to and including the match. All the usual regex variables
1576($1, %+ etc.) from the regex match are available in the callback.
1507 1577
1508Example: read a single line terminated by '\n'. 1578Example: read a single line terminated by '\n'.
1509 1579
1510 $handle->push_read (regex => qr<\n>, sub { ... }); 1580 $handle->push_read (regex => qr<\n>, sub { ... });
1511 1581
1655=item json => $cb->($handle, $hash_or_arrayref) 1725=item json => $cb->($handle, $hash_or_arrayref)
1656 1726
1657Reads a JSON object or array, decodes it and passes it to the 1727Reads a JSON object or array, decodes it and passes it to the
1658callback. When a parse error occurs, an C<EBADMSG> error will be raised. 1728callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1659 1729
1660If a C<json> object was passed to the constructor, then that will be used 1730If a C<json> object was passed to the constructor, then that will be
1661for the final decode, otherwise it will create a JSON coder expecting UTF-8. 1731used for the final decode, otherwise it will create a L<JSON::XS> or
1732L<JSON::PP> coder object expecting UTF-8.
1662 1733
1663This read type uses the incremental parser available with JSON version 1734This read type uses the incremental parser available with JSON version
16642.09 (and JSON::XS version 2.2) and above. You have to provide a 17352.09 (and JSON::XS version 2.2) and above.
1665dependency on your own: this module will load the JSON module, but
1666AnyEvent does not depend on it itself.
1667 1736
1668Since JSON texts are fully self-delimiting, the C<json> read and write 1737Since JSON texts are fully self-delimiting, the C<json> read and write
1669types are an ideal simple RPC protocol: just exchange JSON datagrams. See 1738types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1670the C<json> write type description, above, for an actual example. 1739the C<json> write type description, above, for an actual example.
1671 1740
1675 my ($self, $cb) = @_; 1744 my ($self, $cb) = @_;
1676 1745
1677 my $json = $self->{json} ||= json_coder; 1746 my $json = $self->{json} ||= json_coder;
1678 1747
1679 my $data; 1748 my $data;
1680 my $rbuf = \$self->{rbuf};
1681 1749
1682 sub { 1750 sub {
1683 my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; 1751 my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1684 1752
1685 if ($ref) { 1753 if ($ref) {
1699 1767
1700 () 1768 ()
1701 } else { 1769 } else {
1702 $_[0]{rbuf} = ""; 1770 $_[0]{rbuf} = "";
1703 1771
1772 ()
1773 }
1774 }
1775};
1776
1777=item cbor => $cb->($handle, $scalar)
1778
1779Reads a CBOR value, decodes it and passes it to the callback. When a parse
1780error occurs, an C<EBADMSG> error will be raised.
1781
1782If a L<CBOR::XS> object was passed to the constructor, then that will be
1783used for the final decode, otherwise it will create a CBOR coder without
1784enabling any options.
1785
1786You have to provide a dependency to L<CBOR::XS> on your own: this module
1787will load the L<CBOR::XS> module, but AnyEvent does not depend on it
1788itself.
1789
1790Since CBOR values are fully self-delimiting, the C<cbor> read and write
1791types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
1792the C<cbor> write type description, above, for an actual example.
1793
1794=cut
1795
1796register_read_type cbor => sub {
1797 my ($self, $cb) = @_;
1798
1799 my $cbor = $self->{cbor} ||= cbor_coder;
1800
1801 my $data;
1802
1803 sub {
1804 my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
1805
1806 if (@value) {
1807 $cb->($_[0], @value);
1808
1809 1
1810 } elsif ($@) {
1811 # error case
1812 $cbor->incr_reset;
1813
1814 $_[0]->_error (Errno::EBADMSG);
1815
1816 ()
1817 } else {
1704 () 1818 ()
1705 } 1819 }
1706 } 1820 }
1707}; 1821};
1708 1822
1746 }); 1860 });
1747 } 1861 }
1748 1862
1749 1 1863 1
1750 } 1864 }
1865};
1866
1867=item tls_detect => $cb->($handle, $detect, $major, $minor)
1868
1869Checks the input stream for a valid SSL or TLS handshake TLSPaintext
1870record without consuming anything. Only SSL version 3 or higher
1871is handled, up to the fictituous protocol 4.x (but both SSL3+ and
1872SSL2-compatible framing is supported).
1873
1874If it detects that the input data is likely TLS, it calls the callback
1875with a true value for C<$detect> and the (on-wire) TLS version as second
1876and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
18773.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
1878be definitely not TLS, it calls the callback with a false value for
1879C<$detect>.
1880
1881The callback could use this information to decide whether or not to start
1882TLS negotiation.
1883
1884In all cases the data read so far is passed to the following read
1885handlers.
1886
1887Usually you want to use the C<tls_autostart> read type instead.
1888
1889If you want to design a protocol that works in the presence of TLS
1890dtection, make sure that any non-TLS data doesn't start with the octet 22
1891(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
1892read type does are a bit more strict, but might losen in the future to
1893accomodate protocol changes.
1894
1895This read type does not rely on L<AnyEvent::TLS> (and thus, not on
1896L<Net::SSLeay>).
1897
1898=item tls_autostart => $tls[, $tls_ctx]
1899
1900Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
1901to start tls by calling C<starttls> with the given arguments.
1902
1903In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
1904been configured to accept, as servers do not normally send a handshake on
1905their own and ths cannot be detected in this way.
1906
1907See C<tls_detect> above for more details.
1908
1909Example: give the client a chance to start TLS before accepting a text
1910line.
1911
1912 $hdl->push_read (tls_detect => "accept");
1913 $hdl->push_read (line => sub {
1914 print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
1915 });
1916
1917=cut
1918
1919register_read_type tls_detect => sub {
1920 my ($self, $cb) = @_;
1921
1922 sub {
1923 # this regex matches a full or partial tls record
1924 if (
1925 # ssl3+: type(22=handshake) major(=3) minor(any) length_hi
1926 $self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs
1927 # ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
1928 or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs
1929 ) {
1930 return if 3 != length $1; # partial match, can't decide yet
1931
1932 # full match, valid TLS record
1933 my ($major, $minor) = unpack "CC", $1;
1934 $cb->($self, "accept", $major + $minor * 0.1);
1935 } else {
1936 # mismatch == guaranteed not TLS
1937 $cb->($self, undef);
1938 }
1939
1940 1
1941 }
1942};
1943
1944register_read_type tls_autostart => sub {
1945 my ($self, @tls) = @_;
1946
1947 $RH{tls_detect}($self, sub {
1948 return unless $_[1];
1949 $_[0]->starttls (@tls);
1950 })
1751}; 1951};
1752 1952
1753=back 1953=back
1754 1954
1755=item custom read types - Package::anyevent_read_type $handle, $cb, @args 1955=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1839 } elsif (defined $len) { 2039 } elsif (defined $len) {
1840 delete $self->{_rw}; 2040 delete $self->{_rw};
1841 $self->{_eof} = 1; 2041 $self->{_eof} = 1;
1842 $self->_drain_rbuf; 2042 $self->_drain_rbuf;
1843 2043
1844 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 2044 } elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
1845 return $self->_error ($!, 1); 2045 return $self->_error ($!, 1);
1846 } 2046 }
1847 }; 2047 };
1848 } 2048 }
1849} 2049}
1855 my ($self, $err) = @_; 2055 my ($self, $err) = @_;
1856 2056
1857 return $self->_error ($!, 1) 2057 return $self->_error ($!, 1)
1858 if $err == Net::SSLeay::ERROR_SYSCALL (); 2058 if $err == Net::SSLeay::ERROR_SYSCALL ();
1859 2059
1860 my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); 2060 my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1861 2061
1862 # reduce error string to look less scary 2062 # reduce error string to look less scary
1863 $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; 2063 $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1864 2064
1865 if ($self->{_on_starttls}) { 2065 if ($self->{_on_starttls}) {
1879sub _dotls { 2079sub _dotls {
1880 my ($self) = @_; 2080 my ($self) = @_;
1881 2081
1882 my $tmp; 2082 my $tmp;
1883 2083
1884 if (length $self->{_tls_wbuf}) { 2084 while (length $self->{_tls_wbuf}) {
1885 while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { 2085 if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1886 substr $self->{_tls_wbuf}, 0, $tmp, ""; 2086 $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
2087
2088 return $self->_tls_error ($tmp)
2089 if $tmp != $ERROR_WANT_READ
2090 && ($tmp != $ERROR_SYSCALL || $!);
2091
2092 last;
1887 } 2093 }
1888 2094
1889 $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); 2095 substr $self->{_tls_wbuf}, 0, $tmp, "";
1890 return $self->_tls_error ($tmp)
1891 if $tmp != $ERROR_WANT_READ
1892 && ($tmp != $ERROR_SYSCALL || $!);
1893 } 2096 }
1894 2097
1895 while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { 2098 while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1896 unless (length $tmp) { 2099 unless (length $tmp) {
1897 $self->{_on_starttls} 2100 $self->{_on_starttls}
1911 $self->{_tls_rbuf} .= $tmp; 2114 $self->{_tls_rbuf} .= $tmp;
1912 $self->_drain_rbuf; 2115 $self->_drain_rbuf;
1913 $self->{tls} or return; # tls session might have gone away in callback 2116 $self->{tls} or return; # tls session might have gone away in callback
1914 } 2117 }
1915 2118
1916 $tmp = Net::SSLeay::get_error ($self->{tls}, -1); 2119 $tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us
1917 return $self->_tls_error ($tmp) 2120 return $self->_tls_error ($tmp)
1918 if $tmp != $ERROR_WANT_READ 2121 if $tmp != $ERROR_WANT_READ
1919 && ($tmp != $ERROR_SYSCALL || $!); 2122 && ($tmp != $ERROR_SYSCALL || $!);
1920 2123
1921 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 2124 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1931 2134
1932=item $handle->starttls ($tls[, $tls_ctx]) 2135=item $handle->starttls ($tls[, $tls_ctx])
1933 2136
1934Instead of starting TLS negotiation immediately when the AnyEvent::Handle 2137Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1935object is created, you can also do that at a later time by calling 2138object is created, you can also do that at a later time by calling
1936C<starttls>. 2139C<starttls>. See the C<tls> constructor argument for general info.
1937 2140
1938Starting TLS is currently an asynchronous operation - when you push some 2141Starting TLS is currently an asynchronous operation - when you push some
1939write data and then call C<< ->starttls >> then TLS negotiation will start 2142write data and then call C<< ->starttls >> then TLS negotiation will start
1940immediately, after which the queued write data is then sent. 2143immediately, after which the queued write data is then sent. This might
2144change in future versions, so best make sure you have no outstanding write
2145data when calling this method.
1941 2146
1942The first argument is the same as the C<tls> constructor argument (either 2147The first argument is the same as the C<tls> constructor argument (either
1943C<"connect">, C<"accept"> or an existing Net::SSLeay object). 2148C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1944 2149
1945The second argument is the optional C<AnyEvent::TLS> object that is used 2150The second argument is the optional C<AnyEvent::TLS> object that is used
1967 my ($self, $tls, $ctx) = @_; 2172 my ($self, $tls, $ctx) = @_;
1968 2173
1969 Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" 2174 Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1970 if $self->{tls}; 2175 if $self->{tls};
1971 2176
2177 unless (defined $AnyEvent::TLS::VERSION) {
2178 eval {
2179 require Net::SSLeay;
2180 require AnyEvent::TLS;
2181 1
2182 } or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
2183 }
2184
1972 $self->{tls} = $tls; 2185 $self->{tls} = $tls;
1973 $self->{tls_ctx} = $ctx if @_ > 2; 2186 $self->{tls_ctx} = $ctx if @_ > 2;
1974 2187
1975 return unless $self->{fh}; 2188 return unless $self->{fh};
1976 2189
1977 require Net::SSLeay;
1978
1979 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); 2190 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1980 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); 2191 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1981 2192
1982 $tls = delete $self->{tls}; 2193 $tls = delete $self->{tls};
1983 $ctx = $self->{tls_ctx}; 2194 $ctx = $self->{tls_ctx};
1984 2195
1985 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session 2196 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1986 2197
1987 if ("HASH" eq ref $ctx) { 2198 if ("HASH" eq ref $ctx) {
1988 require AnyEvent::TLS;
1989
1990 if ($ctx->{cache}) { 2199 if ($ctx->{cache}) {
1991 my $key = $ctx+0; 2200 my $key = $ctx+0;
1992 $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; 2201 $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1993 } else { 2202 } else {
1994 $ctx = new AnyEvent::TLS %$ctx; 2203 $ctx = new AnyEvent::TLS %$ctx;
2096 push @linger, AE::io $fh, 1, sub { 2305 push @linger, AE::io $fh, 1, sub {
2097 my $len = syswrite $fh, $wbuf, length $wbuf; 2306 my $len = syswrite $fh, $wbuf, length $wbuf;
2098 2307
2099 if ($len > 0) { 2308 if ($len > 0) {
2100 substr $wbuf, 0, $len, ""; 2309 substr $wbuf, 0, $len, "";
2101 } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) { 2310 } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) {
2102 @linger = (); # end 2311 @linger = (); # end
2103 } 2312 }
2104 }; 2313 };
2105 push @linger, AE::timer $linger, 0, sub { 2314 push @linger, AE::timer $linger, 0, sub {
2106 @linger = (); 2315 @linger = ();
2227handles requests until the server gets some QUIT command, causing it to 2436handles requests until the server gets some QUIT command, causing it to
2228close the connection first (highly desirable for a busy TCP server). A 2437close the connection first (highly desirable for a busy TCP server). A
2229client dropping the connection is an error, which means this variant can 2438client dropping the connection is an error, which means this variant can
2230detect an unexpected detection close. 2439detect an unexpected detection close.
2231 2440
2232To handle this case, always make sure you have a on-empty read queue, by 2441To handle this case, always make sure you have a non-empty read queue, by
2233pushing the "read request start" handler on it: 2442pushing the "read request start" handler on it:
2234 2443
2235 # we assume a request starts with a single line 2444 # we assume a request starts with a single line
2236 my @start_request; @start_request = (line => sub { 2445 my @start_request; @start_request = (line => sub {
2237 my ($hdl, $line) = @_; 2446 my ($hdl, $line) = @_;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines