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

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.239 by root, Tue Dec 10 20:39:12 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.239 by root, Tue Dec 10 20:39:12 2013 UTC