[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.226 by root, Mon Dec 12 12:56:04 2011 UTC vs.
Revision 1.240 by root, Tue Dec 17 16:43:15 2013 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\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
…		…
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
…		…
483	callback.	496	callback.
484		497
485	This callback will only be called on TLS shutdowns, not when the	498	This callback will only be called on TLS shutdowns, not when the
486	underlying handle signals EOF.	499	underlying handle signals EOF.
487		500
488	=item json => JSON or JSON::XS object	501	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
489		502
490	This is the json coder object used by the C<json> read and write types.	503	This is the json coder object used by the C<json> read and write types.
491		504
492	If you don't supply it, then AnyEvent::Handle will create and use a	505	If you don't supply it, then AnyEvent::Handle will create and use a
493	suitable one (on demand), which will write and expect UTF-8 encoded JSON	506	suitable one (on demand), which will write and expect UTF-8 encoded JSON
494	texts.	507	texts.
495		508
		509	=item cbor => L<CBOR::XS> object
		510
		511	This is the cbor coder object used by the C<cbor> read and write types.
		512
		513	If you don't supply it, then AnyEvent::Handle will create and use a
		514	suitable one (on demand), which will write CBOR without using extensions,
		515	if possible. texts.
		516
496	Note that you are responsible to depend on the JSON module if you want to	517	Note that you are responsible to depend on the L<CBOR::XS> module if you
497	use this functionality, as AnyEvent does not have a dependency itself.	518	want to use this functionality, as AnyEvent does not have a dependency on
		519	it itself.
498		520
499	=back	521	=back
500		522
501	=cut	523	=cut
502		524
…		…
880		902
881	The write queue is very simple: you can add data to its end, and	903	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.	904	AnyEvent::Handle will automatically try to get rid of it for you.
883		905
884	When data could be written and the write buffer is shorter then the low	906	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.	907	water mark, the C<on_drain> callback will be invoked once.
886		908
887	=over 4	909	=over 4
888		910
889	=item $handle->on_drain ($cb)	911	=item $handle->on_drain ($cb)
890		912
…		…
1040		1062
1041	The generated JSON text is guaranteed not to contain any newlines: While	1063	The generated JSON text is guaranteed not to contain any newlines: While
1042	this module doesn't need delimiters after or between JSON texts to be	1064	this module doesn't need delimiters after or between JSON texts to be
1043	able to read them, many other languages depend on that.	1065	able to read them, many other languages depend on that.
1044		1066
1045	A simple RPC protocol that interoperates easily with others is to send	1067	A simple RPC protocol that interoperates easily with other languages is
1046	JSON arrays (or objects, although arrays are usually the better choice as	1068	to send JSON arrays (or objects, although arrays are usually the better
1047	they mimic how function argument passing works) and a newline after each	1069	choice as they mimic how function argument passing works) and a newline
1048	JSON text:	1070	after each JSON text:
1049		1071
1050	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1072	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1051	$handle->push_write ("\012");	1073	$handle->push_write ("\012");
1052		1074
1053	An AnyEvent::Handle receiver would simply use the C<json> read type and	1075	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
1056	$handle->push_read (json => sub { my $array = $_[1]; ... });	1078	$handle->push_read (json => sub { my $array = $_[1]; ... });
1057		1079
1058	Other languages could read single lines terminated by a newline and pass	1080	Other languages could read single lines terminated by a newline and pass
1059	this line into their JSON decoder of choice.	1081	this line into their JSON decoder of choice.
1060		1082
		1083	=item cbor => $perl_scalar
		1084
		1085	Encodes the given scalar into a CBOR value. Unless you provide your own
		1086	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1087	using any extensions, if possible.
		1088
		1089	CBOR values are self-delimiting, so you can write CBOR at one end of
		1090	a handle and read them at the other end without using any additional
		1091	framing.
		1092
		1093	A simple nd very very fast RPC protocol that interoperates with
		1094	other languages is to send CBOR and receive CBOR values (arrays are
		1095	recommended):
		1096
		1097	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1098
		1099	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1100
		1101	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1102
1061	=cut	1103	=cut
1062		1104
1063	sub json_coder() {	1105	sub json_coder() {
1064	eval { require JSON::XS; JSON::XS->new->utf8 }	1106	eval { require JSON::XS; JSON::XS->new->utf8 }
1065	\|\| do { require JSON; JSON->new->utf8 }	1107	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1066	}	1108	}
1067		1109
1068	register_write_type json => sub {	1110	register_write_type json => sub {
1069	my ($self, $ref) = @_;	1111	my ($self, $ref) = @_;
1070		1112
1071	my $json = $self->{json} \|\|= json_coder;	1113	($self->{json} \|\|= json_coder)
1072
1073	$json->encode ($ref)	1114	->encode ($ref)
		1115	};
		1116
		1117	sub cbor_coder() {
		1118	require CBOR::XS;
		1119	CBOR::XS->new
		1120	}
		1121
		1122	register_write_type cbor => sub {
		1123	my ($self, $scalar) = @_;
		1124
		1125	($self->{cbor} \|\|= cbor_coder)
		1126	->encode ($scalar)
1074	};	1127	};
1075		1128
1076	=item storable => $reference	1129	=item storable => $reference
1077		1130
1078	Freezes the given reference using L<Storable> and writes it to the	1131	Freezes the given reference using L<Storable> and writes it to the
…		…
1472		1525
1473	register_read_type line => sub {	1526	register_read_type line => sub {
1474	my ($self, $cb, $eol) = @_;	1527	my ($self, $cb, $eol) = @_;
1475		1528
1476	if (@_ < 3) {	1529	if (@_ < 3) {
1477	# this is more than twice as fast as the generic code below	1530	# this is faster then the generic code below
1478	sub {	1531	sub {
1479	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1532	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1533	or return;
1480		1534
		1535	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1481	$cb->($_[0], $1, $2);	1536	$cb->($_[0], $str, "$1");
1482	1	1537	1
1483	}	1538	}
1484	} else {	1539	} else {
1485	$eol = quotemeta $eol unless ref $eol;	1540	$eol = quotemeta $eol unless ref $eol;
1486	$eol = qr\|^(.*?)($eol)\|s;	1541	$eol = qr\|^(.*?)($eol)\|s;
1487		1542
1488	sub {	1543	sub {
1489	$_[0]{rbuf} =~ s/$eol// or return;	1544	$_[0]{rbuf} =~ s/$eol// or return;
1490		1545
1491	$cb->($_[0], $1, $2);	1546	$cb->($_[0], "$1", "$2");
1492	1	1547	1
1493	}	1548	}
1494	}	1549	}
1495	};	1550	};
1496		1551
…		…
1649	=item json => $cb->($handle, $hash_or_arrayref)	1704	=item json => $cb->($handle, $hash_or_arrayref)
1650		1705
1651	Reads a JSON object or array, decodes it and passes it to the	1706	Reads a JSON object or array, decodes it and passes it to the
1652	callback. When a parse error occurs, an C<EBADMSG> error will be raised.	1707	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1653		1708
1654	If a C<json> object was passed to the constructor, then that will be used	1709	If a C<json> object was passed to the constructor, then that will be
1655	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1710	used for the final decode, otherwise it will create a L<JSON::XS> or
		1711	L<JSON::PP> coder object expecting UTF-8.
1656		1712
1657	This read type uses the incremental parser available with JSON version	1713	This read type uses the incremental parser available with JSON version
1658	2.09 (and JSON::XS version 2.2) and above. You have to provide a	1714	2.09 (and JSON::XS version 2.2) and above.
1659	dependency on your own: this module will load the JSON module, but
1660	AnyEvent does not depend on it itself.
1661		1715
1662	Since JSON texts are fully self-delimiting, the C<json> read and write	1716	Since JSON texts are fully self-delimiting, the C<json> read and write
1663	types are an ideal simple RPC protocol: just exchange JSON datagrams. See	1717	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1664	the C<json> write type description, above, for an actual example.	1718	the C<json> write type description, above, for an actual example.
1665		1719
…		…
1669	my ($self, $cb) = @_;	1723	my ($self, $cb) = @_;
1670		1724
1671	my $json = $self->{json} \|\|= json_coder;	1725	my $json = $self->{json} \|\|= json_coder;
1672		1726
1673	my $data;	1727	my $data;
1674	my $rbuf = \$self->{rbuf};
1675		1728
1676	sub {	1729	sub {
1677	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };	1730	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1678		1731
1679	if ($ref) {	1732	if ($ref) {
…		…
1698	()	1751	()
1699	}	1752	}
1700	}	1753	}
1701	};	1754	};
1702		1755
		1756	=item cbor => $cb->($handle, $scalar)
		1757
		1758	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1759	error occurs, an C<EBADMSG> error will be raised.
		1760
		1761	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1762	used for the final decode, otherwise it will create a CBOR coder without
		1763	enabling any options.
		1764
		1765	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1766	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1767	itself.
		1768
		1769	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1770	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1771	the C<cbor> write type description, above, for an actual example.
		1772
		1773	=cut
		1774
		1775	register_read_type cbor => sub {
		1776	my ($self, $cb) = @_;
		1777
		1778	my $cbor = $self->{cbor} \|\|= cbor_coder;
		1779
		1780	my $data;
		1781
		1782	sub {
		1783	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1784
		1785	if (@value) {
		1786	$cb->($_[0], @value);
		1787
		1788	1
		1789	} elsif ($@) {
		1790	# error case
		1791	$cbor->incr_reset;
		1792
		1793	$_[0]->_error (Errno::EBADMSG);
		1794
		1795	()
		1796	} else {
		1797	()
		1798	}
		1799	}
		1800	};
		1801
1703	=item storable => $cb->($handle, $ref)	1802	=item storable => $cb->($handle, $ref)
1704		1803
1705	Deserialises a L<Storable> frozen representation as written by the	1804	Deserialises a L<Storable> frozen representation as written by the
1706	C<storable> write type (BER-encoded length prefix followed by nfreeze'd	1805	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
1707	data).	1806	data).
…		…
1724		1823
1725	# bypass unshift if we already have the remaining chunk	1824	# bypass unshift if we already have the remaining chunk
1726	if ($format + $len <= length $_[0]{rbuf}) {	1825	if ($format + $len <= length $_[0]{rbuf}) {
1727	my $data = substr $_[0]{rbuf}, $format, $len;	1826	my $data = substr $_[0]{rbuf}, $format, $len;
1728	substr $_[0]{rbuf}, 0, $format + $len, "";	1827	substr $_[0]{rbuf}, 0, $format + $len, "";
		1828
1729	$cb->($_[0], Storable::thaw ($data));	1829	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1830	or return $_[0]->_error (Errno::EBADMSG);
1730	} else {	1831	} else {
1731	# remove prefix	1832	# remove prefix
1732	substr $_[0]{rbuf}, 0, $format, "";	1833	substr $_[0]{rbuf}, 0, $format, "";
1733		1834
1734	# read remaining chunk	1835	# read remaining chunk
1735	$_[0]->unshift_read (chunk => $len, sub {	1836	$_[0]->unshift_read (chunk => $len, sub {
1736	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1837	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1737	$cb->($_[0], $ref);
1738	} else {
1739	$_[0]->_error (Errno::EBADMSG);	1838	or $_[0]->_error (Errno::EBADMSG);
1740	}
1741	});	1839	});
1742	}	1840	}
1743		1841
1744	1	1842	1
1745	}	1843	}
		1844	};
		1845
		1846	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1847
		1848	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1849	record without consuming anything. Only SSL version 3 or higher
		1850	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1851	SSL2-compatible framing is supported).
		1852
		1853	If it detects that the input data is likely TLS, it calls the callback
		1854	with a true value for C<$detect> and the (on-wire) TLS version as second
		1855	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1856	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1857	be definitely not TLS, it calls the callback with a false value for
		1858	C<$detect>.
		1859
		1860	The callback could use this information to decide whether or not to start
		1861	TLS negotiation.
		1862
		1863	In all cases the data read so far is passed to the following read
		1864	handlers.
		1865
		1866	Usually you want to use the C<tls_autostart> read type instead.
		1867
		1868	If you want to design a protocol that works in the presence of TLS
		1869	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1870	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1871	read type does are a bit more strict, but might losen in the future to
		1872	accomodate protocol changes.
		1873
		1874	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1875	L<Net::SSLeay>).
		1876
		1877	=item tls_autostart => $tls[, $tls_ctx]
		1878
		1879	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1880	to start tls by calling C<starttls> with the given arguments.
		1881
		1882	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1883	been configured to accept, as servers do not normally send a handshake on
		1884	their own and ths cannot be detected in this way.
		1885
		1886	See C<tls_detect> above for more details.
		1887
		1888	Example: give the client a chance to start TLS before accepting a text
		1889	line.
		1890
		1891	$hdl->push_read (tls_detect => "accept");
		1892	$hdl->push_read (line => sub {
		1893	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1894	});
		1895
		1896	=cut
		1897
		1898	register_read_type tls_detect => sub {
		1899	my ($self, $cb) = @_;
		1900
		1901	sub {
		1902	# this regex matches a full or partial tls record
		1903	if (
		1904	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1905	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1906	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1907	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1908	) {
		1909	return if 3 != length $1; # partial match, can't decide yet
		1910
		1911	# full match, valid TLS record
		1912	my ($major, $minor) = unpack "CC", $1;
		1913	$cb->($self, "accept", $major + $minor * 0.1);
		1914	} else {
		1915	# mismatch == guaranteed not TLS
		1916	$cb->($self, undef);
		1917	}
		1918
		1919	1
		1920	}
		1921	};
		1922
		1923	register_read_type tls_autostart => sub {
		1924	my ($self, @tls) = @_;
		1925
		1926	$RH{tls_detect}($self, sub {
		1927	return unless $_[1];
		1928	$_[0]->starttls (@tls);
		1929	})
1746	};	1930	};
1747		1931
1748	=back	1932	=back
1749		1933
1750	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1934	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1850	my ($self, $err) = @_;	2034	my ($self, $err) = @_;
1851		2035
1852	return $self->_error ($!, 1)	2036	return $self->_error ($!, 1)
1853	if $err == Net::SSLeay::ERROR_SYSCALL ();	2037	if $err == Net::SSLeay::ERROR_SYSCALL ();
1854		2038
1855	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2039	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1856		2040
1857	# reduce error string to look less scary	2041	# reduce error string to look less scary
1858	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2042	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1859		2043
1860	if ($self->{_on_starttls}) {	2044	if ($self->{_on_starttls}) {
…		…
1874	sub _dotls {	2058	sub _dotls {
1875	my ($self) = @_;	2059	my ($self) = @_;
1876		2060
1877	my $tmp;	2061	my $tmp;
1878		2062
1879	if (length $self->{_tls_wbuf}) {	2063	while (length $self->{_tls_wbuf}) {
1880	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2064	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1881	substr $self->{_tls_wbuf}, 0, $tmp, "";	2065	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2066
		2067	return $self->_tls_error ($tmp)
		2068	if $tmp != $ERROR_WANT_READ
		2069	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		2070
		2071	last;
1882	}	2072	}
1883		2073
1884	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2074	substr $self->{_tls_wbuf}, 0, $tmp, "";
1885	return $self->_tls_error ($tmp)
1886	if $tmp != $ERROR_WANT_READ
1887	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1888	}	2075	}
1889		2076
1890	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2077	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1891	unless (length $tmp) {	2078	unless (length $tmp) {
1892	$self->{_on_starttls}	2079	$self->{_on_starttls}
…		…
1906	$self->{_tls_rbuf} .= $tmp;	2093	$self->{_tls_rbuf} .= $tmp;
1907	$self->_drain_rbuf;	2094	$self->_drain_rbuf;
1908	$self->{tls} or return; # tls session might have gone away in callback	2095	$self->{tls} or return; # tls session might have gone away in callback
1909	}	2096	}
1910		2097
1911	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	2098	$tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us
1912	return $self->_tls_error ($tmp)	2099	return $self->_tls_error ($tmp)
1913	if $tmp != $ERROR_WANT_READ	2100	if $tmp != $ERROR_WANT_READ
1914	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2101	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1915		2102
1916	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2103	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1926		2113
1927	=item $handle->starttls ($tls[, $tls_ctx])	2114	=item $handle->starttls ($tls[, $tls_ctx])
1928		2115
1929	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2116	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	2117	object is created, you can also do that at a later time by calling
1931	C<starttls>.	2118	C<starttls>. See the C<tls> constructor argument for general info.
1932		2119
1933	Starting TLS is currently an asynchronous operation - when you push some	2120	Starting TLS is currently an asynchronous operation - when you push some
1934	write data and then call C<< ->starttls >> then TLS negotiation will start	2121	write data and then call C<< ->starttls >> then TLS negotiation will start
1935	immediately, after which the queued write data is then sent.	2122	immediately, after which the queued write data is then sent. This might
		2123	change in future versions, so best make sure you have no outstanding write
		2124	data when calling this method.
1936		2125
1937	The first argument is the same as the C<tls> constructor argument (either	2126	The first argument is the same as the C<tls> constructor argument (either
1938	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2127	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1939		2128
1940	The second argument is the optional C<AnyEvent::TLS> object that is used	2129	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1962	my ($self, $tls, $ctx) = @_;	2151	my ($self, $tls, $ctx) = @_;
1963		2152
1964	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2153	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1965	if $self->{tls};	2154	if $self->{tls};
1966		2155
		2156	unless (defined $AnyEvent::TLS::VERSION) {
		2157	eval {
		2158	require Net::SSLeay;
		2159	require AnyEvent::TLS;
		2160	1
		2161	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2162	}
		2163
1967	$self->{tls} = $tls;	2164	$self->{tls} = $tls;
1968	$self->{tls_ctx} = $ctx if @_ > 2;	2165	$self->{tls_ctx} = $ctx if @_ > 2;
1969		2166
1970	return unless $self->{fh};	2167	return unless $self->{fh};
1971		2168
1972	require Net::SSLeay;
1973
1974	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2169	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1975	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2170	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1976		2171
1977	$tls = delete $self->{tls};	2172	$tls = delete $self->{tls};
1978	$ctx = $self->{tls_ctx};	2173	$ctx = $self->{tls_ctx};
1979		2174
1980	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2175	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1981		2176
1982	if ("HASH" eq ref $ctx) {	2177	if ("HASH" eq ref $ctx) {
1983	require AnyEvent::TLS;
1984
1985	if ($ctx->{cache}) {	2178	if ($ctx->{cache}) {
1986	my $key = $ctx+0;	2179	my $key = $ctx+0;
1987	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2180	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1988	} else {	2181	} else {
1989	$ctx = new AnyEvent::TLS %$ctx;	2182	$ctx = new AnyEvent::TLS %$ctx;
…		…
2222	handles requests until the server gets some QUIT command, causing it to	2415	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	2416	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	2417	client dropping the connection is an error, which means this variant can
2225	detect an unexpected detection close.	2418	detect an unexpected detection close.
2226		2419
2227	To handle this case, always make sure you have a on-empty read queue, by	2420	To handle this case, always make sure you have a non-empty read queue, by
2228	pushing the "read request start" handler on it:	2421	pushing the "read request start" handler on it:
2229		2422
2230	# we assume a request starts with a single line	2423	# we assume a request starts with a single line
2231	my @start_request; @start_request = (line => sub {	2424	my @start_request; @start_request = (line => sub {
2232	my ($hdl, $line) = @_;	2425	my ($hdl, $line) = @_;
…		…
2330	C<low_water_mark> this will be called precisely when all data has been	2523	C<low_water_mark> this will be called precisely when all data has been
2331	written to the socket:	2524	written to the socket:
2332		2525
2333	$handle->push_write (...);	2526	$handle->push_write (...);
2334	$handle->on_drain (sub {	2527	$handle->on_drain (sub {
2335	AE::log debug => "all data submitted to the kernel\n";	2528	AE::log debug => "All data submitted to the kernel.";
2336	undef $handle;	2529	undef $handle;
2337	});	2530	});
2338		2531
2339	If you just want to queue some data and then signal EOF to the other side,	2532	If you just want to queue some data and then signal EOF to the other side,
2340	consider using C<< ->push_shutdown >> instead.	2533	consider using C<< ->push_shutdown >> instead.
…		…
2424	When you have intermediate CA certificates that your clients might not	2617	When you have intermediate CA certificates that your clients might not
2425	know about, just append them to the C<cert_file>.	2618	know about, just append them to the C<cert_file>.
2426		2619
2427	=back	2620	=back
2428		2621
2429
2430	=head1 SUBCLASSING AnyEvent::Handle	2622	=head1 SUBCLASSING AnyEvent::Handle
2431		2623
2432	In many cases, you might want to subclass AnyEvent::Handle.	2624	In many cases, you might want to subclass AnyEvent::Handle.
2433		2625
2434	To make this easier, a given version of AnyEvent::Handle uses these	2626	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2460		2652
2461	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2653	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2462		2654
2463	=cut	2655	=cut
2464		2656
2465	1; # End of AnyEvent::Handle	2657	1
		2658

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.226 by root, Mon Dec 12 12:56:04 2011 UTC vs. Revision 1.240 by root, Tue Dec 17 16:43:15 2013 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.226 by root, Mon Dec 12 12:56:04 2011 UTC vs.
Revision 1.240 by root, Tue Dec 17 16:43:15 2013 UTC