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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.221 by root, Thu Aug 4 09:35:37 2011 UTC vs.
Revision 1.242 by root, Wed Dec 10 04:29:33 2014 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	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	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
135	If, for some reason, the handle is not acceptable, calling C<$retry>	137	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	138	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	139	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	140	callback can be invoked after the connect callback returns, i.e. one can
139	similar properties of the handle will have been reset.	141	start a handshake and then decide to retry with the next host if the
		142	handshake fails.
140		143
141	In most cases, you should ignore the C<$retry> parameter.	144	In most cases, you should ignore the C<$retry> parameter.
142		145
143	=item on_connect_error => $cb->($handle, $message)	146	=item on_connect_error => $cb->($handle, $message)
144		147
…		…
164	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In	167	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	168	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.	169	often easiest to not report C<EPIPE> errors in this callback.
167		170
168	AnyEvent::Handle tries to find an appropriate error code for you to check	171	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	172	against, but in some cases (TLS errors), this does not work well.
170	recommended to always output the C<$message> argument in human-readable	173
171	error messages (it's usually the same as C<"$!">).	174	If you report the error to the user, it is recommended to always output
		175	the C<$message> argument in human-readable error messages (you don't need
		176	to report C<"$!"> if you report C<$message>).
		177
		178	If you want to react programmatically to the error, then looking at C<$!>
		179	and comparing it against some of the documented C<Errno> values is usually
		180	better than looking at the C<$message>.
172		181
173	Non-fatal errors can be retried by returning, but it is recommended	182	Non-fatal errors can be retried by returning, but it is recommended
174	to simply ignore this parameter and instead abondon the handle object	183	to simply ignore this parameter and instead abondon the handle object
175	when this callback is invoked. Examples of non-fatal errors are timeouts	184	when this callback is invoked. Examples of non-fatal errors are timeouts
176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	185	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
…		…
224	If an EOF condition has been detected but no C<on_eof> callback has been	233	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>.	234	set, then a fatal error will be raised with C<$!> set to <0>.
226		235
227	=item on_drain => $cb->($handle)	236	=item on_drain => $cb->($handle)
228		237
229	This sets the callback that is called when the write buffer becomes empty	238	This sets the callback that is called once when the write buffer becomes
230	(or immediately if the buffer is empty already).	239	empty (and immediately when the handle object is created).
231		240
232	To append to the write buffer, use the C<< ->push_write >> method.	241	To append to the write buffer, use the C<< ->push_write >> method.
233		242
234	This callback is useful when you don't want to put all of your write data	243	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	244	into the queue at once, for example, when you want to write the contents
…		…
417	appropriate error message.	426	appropriate error message.
418		427
419	TLS mode requires Net::SSLeay to be installed (it will be loaded	428	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	429	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	430	have a dependency on that module, so if your module requires it, you have
422	to add the dependency yourself.	431	to add the dependency yourself. If Net::SSLeay cannot be loaded or is too
		432	old, you get an C<EPROTO> error.
423		433
424	Unlike TCP, TLS has a server and client side: for the TLS server side, use	434	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>	435	C<accept>, and for the TLS client side of a connection, use C<connect>
426	mode.	436	mode.
427		437
…		…
483	callback.	493	callback.
484		494
485	This callback will only be called on TLS shutdowns, not when the	495	This callback will only be called on TLS shutdowns, not when the
486	underlying handle signals EOF.	496	underlying handle signals EOF.
487		497
488	=item json => JSON or JSON::XS object	498	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
489		499
490	This is the json coder object used by the C<json> read and write types.	500	This is the json coder object used by the C<json> read and write types.
491		501
492	If you don't supply it, then AnyEvent::Handle will create and use a	502	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	503	suitable one (on demand), which will write and expect UTF-8 encoded
		504	JSON texts (either using L<JSON::XS> or L<JSON>). The written texts are
		505	guaranteed not to contain any newline character.
		506
		507	For security reasons, this encoder will likely I<not> handle numbers and
		508	strings, only arrays and objects/hashes. The reason is that originally
		509	JSON was self-delimited, but Dougles Crockford thought it was a splendid
		510	idea to redefine JSON incompatibly, so this is no longer true.
		511
		512	For protocols that used back-to-back JSON texts, this might lead to
		513	run-ins, where two or more JSON texts will be interpreted as one JSON
494	texts.	514	text.
495		515
		516	For this reason, if the default encoder uses L<JSON::XS>, it will default
		517	to not allowing anything but arrays and objects/hashes, at least for the
		518	forseeable future (it will change at some point). This might or might not
		519	be true for the L<JSON> module, so this might cause a security issue.
		520
		521	If you depend on either behaviour, you should create your own json object
		522	and pass it in explicitly.
		523
		524	=item cbor => L<CBOR::XS> object
		525
		526	This is the cbor coder object used by the C<cbor> read and write types.
		527
		528	If you don't supply it, then AnyEvent::Handle will create and use a
		529	suitable one (on demand), which will write CBOR without using extensions,
		530	if possible.
		531
496	Note that you are responsible to depend on the JSON module if you want to	532	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.	533	want to use this functionality, as AnyEvent does not have a dependency on
		534	it itself.
498		535
499	=back	536	=back
500		537
501	=cut	538	=cut
502		539
…		…
880		917
881	The write queue is very simple: you can add data to its end, and	918	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.	919	AnyEvent::Handle will automatically try to get rid of it for you.
883		920
884	When data could be written and the write buffer is shorter then the low	921	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.	922	water mark, the C<on_drain> callback will be invoked once.
886		923
887	=over 4	924	=over 4
888		925
889	=item $handle->on_drain ($cb)	926	=item $handle->on_drain ($cb)
890		927
…		…
1032		1069
1033	Encodes the given hash or array reference into a JSON object. Unless you	1070	Encodes the given hash or array reference into a JSON object. Unless you
1034	provide your own JSON object, this means it will be encoded to JSON text	1071	provide your own JSON object, this means it will be encoded to JSON text
1035	in UTF-8.	1072	in UTF-8.
1036		1073
		1074	The default encoder might or might not handle every type of JSON value -
		1075	it might be limited to arrays and objects for security reasons. See the
		1076	C<json> constructor attribute for more details.
		1077
1037	JSON objects (and arrays) are self-delimiting, so you can write JSON at	1078	JSON objects (and arrays) are self-delimiting, so if you only use arrays
1038	one end of a handle and read them at the other end without using any	1079	and hashes, you can write JSON at one end of a handle and read them at the
1039	additional framing.	1080	other end without using any additional framing.
1040		1081
1041	The generated JSON text is guaranteed not to contain any newlines: While	1082	The JSON text generated by the default encoder is guaranteed not to
1042	this module doesn't need delimiters after or between JSON texts to be	1083	contain any newlines: While this module doesn't need delimiters after or
1043	able to read them, many other languages depend on that.	1084	between JSON texts to be able to read them, many other languages depend on
		1085	them.
1044		1086
1045	A simple RPC protocol that interoperates easily with others is to send	1087	A simple RPC protocol that interoperates easily with other languages is
1046	JSON arrays (or objects, although arrays are usually the better choice as	1088	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	1089	choice as they mimic how function argument passing works) and a newline
1048	JSON text:	1090	after each JSON text:
1049		1091
1050	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1092	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1051	$handle->push_write ("\012");	1093	$handle->push_write ("\012");
1052		1094
1053	An AnyEvent::Handle receiver would simply use the C<json> read type and	1095	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
1056	$handle->push_read (json => sub { my $array = $_[1]; ... });	1098	$handle->push_read (json => sub { my $array = $_[1]; ... });
1057		1099
1058	Other languages could read single lines terminated by a newline and pass	1100	Other languages could read single lines terminated by a newline and pass
1059	this line into their JSON decoder of choice.	1101	this line into their JSON decoder of choice.
1060		1102
		1103	=item cbor => $perl_scalar
		1104
		1105	Encodes the given scalar into a CBOR value. Unless you provide your own
		1106	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1107	using any extensions, if possible.
		1108
		1109	CBOR values are self-delimiting, so you can write CBOR at one end of
		1110	a handle and read them at the other end without using any additional
		1111	framing.
		1112
		1113	A simple nd very very fast RPC protocol that interoperates with
		1114	other languages is to send CBOR and receive CBOR values (arrays are
		1115	recommended):
		1116
		1117	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1118
		1119	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1120
		1121	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1122
1061	=cut	1123	=cut
1062		1124
1063	sub json_coder() {	1125	sub json_coder() {
1064	eval { require JSON::XS; JSON::XS->new->utf8 }	1126	eval { require JSON::XS; JSON::XS->new->utf8 }
1065	\|\| do { require JSON; JSON->new->utf8 }	1127	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1066	}	1128	}
1067		1129
1068	register_write_type json => sub {	1130	register_write_type json => sub {
1069	my ($self, $ref) = @_;	1131	my ($self, $ref) = @_;
1070		1132
1071	my $json = $self->{json} \|\|= json_coder;	1133	($self->{json} \|\|= json_coder)
1072
1073	$json->encode ($ref)	1134	->encode ($ref)
		1135	};
		1136
		1137	sub cbor_coder() {
		1138	require CBOR::XS;
		1139	CBOR::XS->new
		1140	}
		1141
		1142	register_write_type cbor => sub {
		1143	my ($self, $scalar) = @_;
		1144
		1145	($self->{cbor} \|\|= cbor_coder)
		1146	->encode ($scalar)
1074	};	1147	};
1075		1148
1076	=item storable => $reference	1149	=item storable => $reference
1077		1150
1078	Freezes the given reference using L<Storable> and writes it to the	1151	Freezes the given reference using L<Storable> and writes it to the
…		…
1081	=cut	1154	=cut
1082		1155
1083	register_write_type storable => sub {	1156	register_write_type storable => sub {
1084	my ($self, $ref) = @_;	1157	my ($self, $ref) = @_;
1085		1158
1086	require Storable;	1159	require Storable unless $Storable::VERSION;
1087		1160
1088	pack "w/a*", Storable::nfreeze ($ref)	1161	pack "w/a*", Storable::nfreeze ($ref)
1089	};	1162	};
1090		1163
1091	=back	1164	=back
…		…
1128		1201
1129	Whenever the given C<type> is used, C<push_write> will the function with	1202	Whenever the given C<type> is used, C<push_write> will the function with
1130	the handle object and the remaining arguments.	1203	the handle object and the remaining arguments.
1131		1204
1132	The function is supposed to return a single octet string that will be	1205	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	1206	appended to the write buffer, so you can mentally treat this function as a
1134	"arguments to on-the-wire-format" converter.	1207	"arguments to on-the-wire-format" converter.
1135		1208
1136	Example: implement a custom write type C<join> that joins the remaining	1209	Example: implement a custom write type C<join> that joins the remaining
1137	arguments using the first one.	1210	arguments using the first one.
1138		1211
…		…
1432	data.	1505	data.
1433		1506
1434	Example: read 2 bytes.	1507	Example: read 2 bytes.
1435		1508
1436	$handle->push_read (chunk => 2, sub {	1509	$handle->push_read (chunk => 2, sub {
1437	warn "yay ", unpack "H*", $_[1];	1510	say "yay " . unpack "H*", $_[1];
1438	});	1511	});
1439		1512
1440	=cut	1513	=cut
1441		1514
1442	register_read_type chunk => sub {	1515	register_read_type chunk => sub {
…		…
1472		1545
1473	register_read_type line => sub {	1546	register_read_type line => sub {
1474	my ($self, $cb, $eol) = @_;	1547	my ($self, $cb, $eol) = @_;
1475		1548
1476	if (@_ < 3) {	1549	if (@_ < 3) {
1477	# this is more than twice as fast as the generic code below	1550	# this is faster then the generic code below
1478	sub {	1551	sub {
1479	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1552	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1553	or return;
1480		1554
		1555	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1481	$cb->($_[0], $1, $2);	1556	$cb->($_[0], $str, "$1");
1482	1	1557	1
1483	}	1558	}
1484	} else {	1559	} else {
1485	$eol = quotemeta $eol unless ref $eol;	1560	$eol = quotemeta $eol unless ref $eol;
1486	$eol = qr\|^(.*?)($eol)\|s;	1561	$eol = qr\|^(.*?)($eol)\|s;
1487		1562
1488	sub {	1563	sub {
1489	$_[0]{rbuf} =~ s/$eol// or return;	1564	$_[0]{rbuf} =~ s/$eol// or return;
1490		1565
1491	$cb->($_[0], $1, $2);	1566	$cb->($_[0], "$1", "$2");
1492	1	1567	1
1493	}	1568	}
1494	}	1569	}
1495	};	1570	};
1496		1571
…		…
1649	=item json => $cb->($handle, $hash_or_arrayref)	1724	=item json => $cb->($handle, $hash_or_arrayref)
1650		1725
1651	Reads a JSON object or array, decodes it and passes it to the	1726	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.	1727	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1653		1728
1654	If a C<json> object was passed to the constructor, then that will be used	1729	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.	1730	used for the final decode, otherwise it will create a L<JSON::XS> or
		1731	L<JSON::PP> coder object expecting UTF-8.
1656		1732
1657	This read type uses the incremental parser available with JSON version	1733	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	1734	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		1735
1662	Since JSON texts are fully self-delimiting, the C<json> read and write	1736	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	1737	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1664	the C<json> write type description, above, for an actual example.	1738	the C<json> write type description, above, for an actual example.
1665		1739
…		…
1669	my ($self, $cb) = @_;	1743	my ($self, $cb) = @_;
1670		1744
1671	my $json = $self->{json} \|\|= json_coder;	1745	my $json = $self->{json} \|\|= json_coder;
1672		1746
1673	my $data;	1747	my $data;
1674	my $rbuf = \$self->{rbuf};
1675		1748
1676	sub {	1749	sub {
1677	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };	1750	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1678		1751
1679	if ($ref) {	1752	if ($ref) {
…		…
1698	()	1771	()
1699	}	1772	}
1700	}	1773	}
1701	};	1774	};
1702		1775
		1776	=item cbor => $cb->($handle, $scalar)
		1777
		1778	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1779	error occurs, an C<EBADMSG> error will be raised.
		1780
		1781	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1782	used for the final decode, otherwise it will create a CBOR coder without
		1783	enabling any options.
		1784
		1785	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1786	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1787	itself.
		1788
		1789	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1790	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1791	the C<cbor> write type description, above, for an actual example.
		1792
		1793	=cut
		1794
		1795	register_read_type cbor => sub {
		1796	my ($self, $cb) = @_;
		1797
		1798	my $cbor = $self->{cbor} \|\|= cbor_coder;
		1799
		1800	my $data;
		1801
		1802	sub {
		1803	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1804
		1805	if (@value) {
		1806	$cb->($_[0], @value);
		1807
		1808	1
		1809	} elsif ($@) {
		1810	# error case
		1811	$cbor->incr_reset;
		1812
		1813	$_[0]->_error (Errno::EBADMSG);
		1814
		1815	()
		1816	} else {
		1817	()
		1818	}
		1819	}
		1820	};
		1821
1703	=item storable => $cb->($handle, $ref)	1822	=item storable => $cb->($handle, $ref)
1704		1823
1705	Deserialises a L<Storable> frozen representation as written by the	1824	Deserialises a L<Storable> frozen representation as written by the
1706	C<storable> write type (BER-encoded length prefix followed by nfreeze'd	1825	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
1707	data).	1826	data).
…		…
1711	=cut	1830	=cut
1712		1831
1713	register_read_type storable => sub {	1832	register_read_type storable => sub {
1714	my ($self, $cb) = @_;	1833	my ($self, $cb) = @_;
1715		1834
1716	require Storable;	1835	require Storable unless $Storable::VERSION;
1717		1836
1718	sub {	1837	sub {
1719	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1838	# 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} })	1839	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1721	or return;	1840	or return;
…		…
1724		1843
1725	# bypass unshift if we already have the remaining chunk	1844	# bypass unshift if we already have the remaining chunk
1726	if ($format + $len <= length $_[0]{rbuf}) {	1845	if ($format + $len <= length $_[0]{rbuf}) {
1727	my $data = substr $_[0]{rbuf}, $format, $len;	1846	my $data = substr $_[0]{rbuf}, $format, $len;
1728	substr $_[0]{rbuf}, 0, $format + $len, "";	1847	substr $_[0]{rbuf}, 0, $format + $len, "";
		1848
1729	$cb->($_[0], Storable::thaw ($data));	1849	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1850	or return $_[0]->_error (Errno::EBADMSG);
1730	} else {	1851	} else {
1731	# remove prefix	1852	# remove prefix
1732	substr $_[0]{rbuf}, 0, $format, "";	1853	substr $_[0]{rbuf}, 0, $format, "";
1733		1854
1734	# read remaining chunk	1855	# read remaining chunk
1735	$_[0]->unshift_read (chunk => $len, sub {	1856	$_[0]->unshift_read (chunk => $len, sub {
1736	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1857	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1737	$cb->($_[0], $ref);
1738	} else {
1739	$_[0]->_error (Errno::EBADMSG);	1858	or $_[0]->_error (Errno::EBADMSG);
1740	}
1741	});	1859	});
1742	}	1860	}
1743		1861
1744	1	1862	1
1745	}	1863	}
		1864	};
		1865
		1866	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1867
		1868	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1869	record without consuming anything. Only SSL version 3 or higher
		1870	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1871	SSL2-compatible framing is supported).
		1872
		1873	If it detects that the input data is likely TLS, it calls the callback
		1874	with a true value for C<$detect> and the (on-wire) TLS version as second
		1875	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1876	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1877	be definitely not TLS, it calls the callback with a false value for
		1878	C<$detect>.
		1879
		1880	The callback could use this information to decide whether or not to start
		1881	TLS negotiation.
		1882
		1883	In all cases the data read so far is passed to the following read
		1884	handlers.
		1885
		1886	Usually you want to use the C<tls_autostart> read type instead.
		1887
		1888	If you want to design a protocol that works in the presence of TLS
		1889	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1890	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1891	read type does are a bit more strict, but might losen in the future to
		1892	accomodate protocol changes.
		1893
		1894	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1895	L<Net::SSLeay>).
		1896
		1897	=item tls_autostart => $tls[, $tls_ctx]
		1898
		1899	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1900	to start tls by calling C<starttls> with the given arguments.
		1901
		1902	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1903	been configured to accept, as servers do not normally send a handshake on
		1904	their own and ths cannot be detected in this way.
		1905
		1906	See C<tls_detect> above for more details.
		1907
		1908	Example: give the client a chance to start TLS before accepting a text
		1909	line.
		1910
		1911	$hdl->push_read (tls_detect => "accept");
		1912	$hdl->push_read (line => sub {
		1913	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1914	});
		1915
		1916	=cut
		1917
		1918	register_read_type tls_detect => sub {
		1919	my ($self, $cb) = @_;
		1920
		1921	sub {
		1922	# this regex matches a full or partial tls record
		1923	if (
		1924	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1925	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1926	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1927	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1928	) {
		1929	return if 3 != length $1; # partial match, can't decide yet
		1930
		1931	# full match, valid TLS record
		1932	my ($major, $minor) = unpack "CC", $1;
		1933	$cb->($self, "accept", $major + $minor * 0.1);
		1934	} else {
		1935	# mismatch == guaranteed not TLS
		1936	$cb->($self, undef);
		1937	}
		1938
		1939	1
		1940	}
		1941	};
		1942
		1943	register_read_type tls_autostart => sub {
		1944	my ($self, @tls) = @_;
		1945
		1946	$RH{tls_detect}($self, sub {
		1947	return unless $_[1];
		1948	$_[0]->starttls (@tls);
		1949	})
1746	};	1950	};
1747		1951
1748	=back	1952	=back
1749		1953
1750	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1954	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1792	some readings of the the SSL/TLS specifications basically require this	1996	some readings of the the SSL/TLS specifications basically require this
1793	attack to be working, as SSL/TLS implementations might stall sending data	1997	attack to be working, as SSL/TLS implementations might stall sending data
1794	during a rehandshake.	1998	during a rehandshake.
1795		1999
1796	As a guideline, during the initial handshake, you should not stop reading,	2000	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.	2001	and as a client, it might cause problems, depending on your application.
1798		2002
1799	=cut	2003	=cut
1800		2004
1801	sub stop_read {	2005	sub stop_read {
1802	my ($self) = @_;	2006	my ($self) = @_;
…		…
1850	my ($self, $err) = @_;	2054	my ($self, $err) = @_;
1851		2055
1852	return $self->_error ($!, 1)	2056	return $self->_error ($!, 1)
1853	if $err == Net::SSLeay::ERROR_SYSCALL ();	2057	if $err == Net::SSLeay::ERROR_SYSCALL ();
1854		2058
1855	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2059	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1856		2060
1857	# reduce error string to look less scary	2061	# reduce error string to look less scary
1858	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2062	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1859		2063
1860	if ($self->{_on_starttls}) {	2064	if ($self->{_on_starttls}) {
…		…
1874	sub _dotls {	2078	sub _dotls {
1875	my ($self) = @_;	2079	my ($self) = @_;
1876		2080
1877	my $tmp;	2081	my $tmp;
1878		2082
1879	if (length $self->{_tls_wbuf}) {	2083	while (length $self->{_tls_wbuf}) {
1880	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2084	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1881	substr $self->{_tls_wbuf}, 0, $tmp, "";	2085	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2086
		2087	return $self->_tls_error ($tmp)
		2088	if $tmp != $ERROR_WANT_READ
		2089	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		2090
		2091	last;
1882	}	2092	}
1883		2093
1884	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2094	substr $self->{_tls_wbuf}, 0, $tmp, "";
1885	return $self->_tls_error ($tmp)
1886	if $tmp != $ERROR_WANT_READ
1887	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1888	}	2095	}
1889		2096
1890	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2097	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1891	unless (length $tmp) {	2098	unless (length $tmp) {
1892	$self->{_on_starttls}	2099	$self->{_on_starttls}
…		…
1906	$self->{_tls_rbuf} .= $tmp;	2113	$self->{_tls_rbuf} .= $tmp;
1907	$self->_drain_rbuf;	2114	$self->_drain_rbuf;
1908	$self->{tls} or return; # tls session might have gone away in callback	2115	$self->{tls} or return; # tls session might have gone away in callback
1909	}	2116	}
1910		2117
1911	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	2118	$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)	2119	return $self->_tls_error ($tmp)
1913	if $tmp != $ERROR_WANT_READ	2120	if $tmp != $ERROR_WANT_READ
1914	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2121	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1915		2122
1916	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2123	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1926		2133
1927	=item $handle->starttls ($tls[, $tls_ctx])	2134	=item $handle->starttls ($tls[, $tls_ctx])
1928		2135
1929	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2136	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	2137	object is created, you can also do that at a later time by calling
1931	C<starttls>.	2138	C<starttls>. See the C<tls> constructor argument for general info.
1932		2139
1933	Starting TLS is currently an asynchronous operation - when you push some	2140	Starting TLS is currently an asynchronous operation - when you push some
1934	write data and then call C<< ->starttls >> then TLS negotiation will start	2141	write data and then call C<< ->starttls >> then TLS negotiation will start
1935	immediately, after which the queued write data is then sent.	2142	immediately, after which the queued write data is then sent. This might
		2143	change in future versions, so best make sure you have no outstanding write
		2144	data when calling this method.
1936		2145
1937	The first argument is the same as the C<tls> constructor argument (either	2146	The first argument is the same as the C<tls> constructor argument (either
1938	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2147	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1939		2148
1940	The second argument is the optional C<AnyEvent::TLS> object that is used	2149	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1962	my ($self, $tls, $ctx) = @_;	2171	my ($self, $tls, $ctx) = @_;
1963		2172
1964	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2173	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1965	if $self->{tls};	2174	if $self->{tls};
1966		2175
		2176	unless (defined $AnyEvent::TLS::VERSION) {
		2177	eval {
		2178	require Net::SSLeay;
		2179	require AnyEvent::TLS;
		2180	1
		2181	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2182	}
		2183
1967	$self->{tls} = $tls;	2184	$self->{tls} = $tls;
1968	$self->{tls_ctx} = $ctx if @_ > 2;	2185	$self->{tls_ctx} = $ctx if @_ > 2;
1969		2186
1970	return unless $self->{fh};	2187	return unless $self->{fh};
1971		2188
1972	require Net::SSLeay;
1973
1974	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2189	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1975	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2190	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1976		2191
1977	$tls = delete $self->{tls};	2192	$tls = delete $self->{tls};
1978	$ctx = $self->{tls_ctx};	2193	$ctx = $self->{tls_ctx};
1979		2194
1980	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2195	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1981		2196
1982	if ("HASH" eq ref $ctx) {	2197	if ("HASH" eq ref $ctx) {
1983	require AnyEvent::TLS;
1984
1985	if ($ctx->{cache}) {	2198	if ($ctx->{cache}) {
1986	my $key = $ctx+0;	2199	my $key = $ctx+0;
1987	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2200	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1988	} else {	2201	} else {
1989	$ctx = new AnyEvent::TLS %$ctx;	2202	$ctx = new AnyEvent::TLS %$ctx;
…		…
2204	Probably because your C<on_error> callback is being called instead: When	2417	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	2418	you have outstanding requests in your read queue, then an EOF is
2206	considered an error as you clearly expected some data.	2419	considered an error as you clearly expected some data.
2207		2420
2208	To avoid this, make sure you have an empty read queue whenever your handle	2421	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	2422	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	2423	an C<on_read> handler that simply pushes the first read requests in the
2211	queue.	2424	queue.
2212		2425
2213	See also the next question, which explains this in a bit more detail.	2426	See also the next question, which explains this in a bit more detail.
2214		2427
…		…
2222	handles requests until the server gets some QUIT command, causing it to	2435	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	2436	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	2437	client dropping the connection is an error, which means this variant can
2225	detect an unexpected detection close.	2438	detect an unexpected detection close.
2226		2439
2227	To handle this case, always make sure you have a on-empty read queue, by	2440	To handle this case, always make sure you have a non-empty read queue, by
2228	pushing the "read request start" handler on it:	2441	pushing the "read request start" handler on it:
2229		2442
2230	# we assume a request starts with a single line	2443	# we assume a request starts with a single line
2231	my @start_request; @start_request = (line => sub {	2444	my @start_request; @start_request = (line => sub {
2232	my ($hdl, $line) = @_;	2445	my ($hdl, $line) = @_;
…		…
2245	some data and raises the C<EPIPE> error when the connction is dropped	2458	some data and raises the C<EPIPE> error when the connction is dropped
2246	unexpectedly.	2459	unexpectedly.
2247		2460
2248	The second variant is a protocol where the client can drop the connection	2461	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	2462	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	2463	sockets easier, and in general, it means you cannot distinguish a protocl
2251	failure/client crash from a normal connection close. Nevertheless, these	2464	failure/client crash from a normal connection close. Nevertheless, these
2252	kinds of protocols are common (and sometimes even the best solution to the	2465	kinds of protocols are common (and sometimes even the best solution to the
2253	problem).	2466	problem).
2254		2467
2255	Having an outstanding read request at all times is possible if you ignore	2468	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	2543	C<low_water_mark> this will be called precisely when all data has been
2331	written to the socket:	2544	written to the socket:
2332		2545
2333	$handle->push_write (...);	2546	$handle->push_write (...);
2334	$handle->on_drain (sub {	2547	$handle->on_drain (sub {
2335	warn "all data submitted to the kernel\n";	2548	AE::log debug => "All data submitted to the kernel.";
2336	undef $handle;	2549	undef $handle;
2337	});	2550	});
2338		2551
2339	If you just want to queue some data and then signal EOF to the other side,	2552	If you just want to queue some data and then signal EOF to the other side,
2340	consider using C<< ->push_shutdown >> instead.	2553	consider using C<< ->push_shutdown >> instead.
…		…
2424	When you have intermediate CA certificates that your clients might not	2637	When you have intermediate CA certificates that your clients might not
2425	know about, just append them to the C<cert_file>.	2638	know about, just append them to the C<cert_file>.
2426		2639
2427	=back	2640	=back
2428		2641
2429
2430	=head1 SUBCLASSING AnyEvent::Handle	2642	=head1 SUBCLASSING AnyEvent::Handle
2431		2643
2432	In many cases, you might want to subclass AnyEvent::Handle.	2644	In many cases, you might want to subclass AnyEvent::Handle.
2433		2645
2434	To make this easier, a given version of AnyEvent::Handle uses these	2646	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2460		2672
2461	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2673	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2462		2674
2463	=cut	2675	=cut
2464		2676
2465	1; # End of AnyEvent::Handle	2677	1
		2678

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.221 by root, Thu Aug 4 09:35:37 2011 UTC vs. Revision 1.242 by root, Wed Dec 10 04:29:33 2014 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.221 by root, Thu Aug 4 09:35:37 2011 UTC vs.
Revision 1.242 by root, Wed Dec 10 04:29:33 2014 UTC