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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.220 by root, Sun Jul 24 13:10:43 2011 UTC vs.
Revision 1.241 by root, Fri Sep 5 22:17:26 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
		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
…		…
359	already have occured on BSD systems), but at least it will protect you	371	already have occured on BSD systems), but at least it will protect you
360	from most attacks.	372	from most attacks.
361		373
362	=item read_size => <bytes>	374	=item read_size => <bytes>
363		375
364	The initial read block size, the number of bytes this module will try to	376	The initial read block size, the number of bytes this module will try
365	read during each loop iteration. Each handle object will consume at least	377	to read during each loop iteration. Each handle object will consume
366	this amount of memory for the read buffer as well, so when handling many	378	at least this amount of memory for the read buffer as well, so when
367	connections requirements). See also C<max_read_size>. Default: C<2048>.	379	handling many connections watch out for memory requirements). See also
		380	C<max_read_size>. Default: C<2048>.
368		381
369	=item max_read_size => <bytes>	382	=item max_read_size => <bytes>
370		383
371	The maximum read buffer size used by the dynamic adjustment	384	The maximum read buffer size used by the dynamic adjustment
372	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in	385	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
…		…
416	appropriate error message.	429	appropriate error message.
417		430
418	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
419	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
420	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
421	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.
422		436
423	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
424	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>
425	mode.	439	mode.
426		440
…		…
482	callback.	496	callback.
483		497
484	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
485	underlying handle signals EOF.	499	underlying handle signals EOF.
486		500
487	=item json => JSON or JSON::XS object	501	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
488		502
489	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.
490		504
491	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
492	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
		507	JSON texts (either using L<JSON::XS> or L<JSON>). The written texts are
		508	guaranteed not to contain any newline character.
		509
		510	For security reasons, this encoder will likely I<not> handle numbers and
		511	strings, only arrays and objects/hashes. The reason is that originally
		512	JSON was self-delimited, but Dougles Crockford thought it was a splendid
		513	idea to redefine JSON incompatibly, so this is no longer true.
		514
		515	For protocols that used back-to-back JSON texts, this might lead to
		516	run-ins, where two or more JSON texts will be interpreted as one JSON
493	texts.	517	text.
494		518
		519	For this reason, if the default encoder uses L<JSON::XS>, it will default
		520	to not allowing anything but arrays and objects/hashes, at least for the
		521	forseeable future (it will change at some point). This might or might not
		522	be true for the L<JSON> module, so this might cause a security issue.
		523
		524	If you depend on either behaviour, you should create your own json object
		525	and pass it in explicitly.
		526
		527	=item cbor => L<CBOR::XS> object
		528
		529	This is the cbor coder object used by the C<cbor> read and write types.
		530
		531	If you don't supply it, then AnyEvent::Handle will create and use a
		532	suitable one (on demand), which will write CBOR without using extensions,
		533	if possible.
		534
495	Note that you are responsible to depend on the JSON module if you want to	535	Note that you are responsible to depend on the L<CBOR::XS> module if you
496	use this functionality, as AnyEvent does not have a dependency itself.	536	want to use this functionality, as AnyEvent does not have a dependency on
		537	it itself.
497		538
498	=back	539	=back
499		540
500	=cut	541	=cut
501		542
…		…
879		920
880	The write queue is very simple: you can add data to its end, and	921	The write queue is very simple: you can add data to its end, and
881	AnyEvent::Handle will automatically try to get rid of it for you.	922	AnyEvent::Handle will automatically try to get rid of it for you.
882		923
883	When data could be written and the write buffer is shorter then the low	924	When data could be written and the write buffer is shorter then the low
884	water mark, the C<on_drain> callback will be invoked.	925	water mark, the C<on_drain> callback will be invoked once.
885		926
886	=over 4	927	=over 4
887		928
888	=item $handle->on_drain ($cb)	929	=item $handle->on_drain ($cb)
889		930
…		…
1031		1072
1032	Encodes the given hash or array reference into a JSON object. Unless you	1073	Encodes the given hash or array reference into a JSON object. Unless you
1033	provide your own JSON object, this means it will be encoded to JSON text	1074	provide your own JSON object, this means it will be encoded to JSON text
1034	in UTF-8.	1075	in UTF-8.
1035		1076
		1077	The default encoder might or might not handle every type of JSON value -
		1078	it might be limited to arrays and objects for security reasons. See the
		1079	C<json> constructor attribute for more details.
		1080
1036	JSON objects (and arrays) are self-delimiting, so you can write JSON at	1081	JSON objects (and arrays) are self-delimiting, so if you only use arrays
1037	one end of a handle and read them at the other end without using any	1082	and hashes, you can write JSON at one end of a handle and read them at the
1038	additional framing.	1083	other end without using any additional framing.
1039		1084
1040	The generated JSON text is guaranteed not to contain any newlines: While	1085	The JSON text generated by the default encoder is guaranteed not to
1041	this module doesn't need delimiters after or between JSON texts to be	1086	contain any newlines: While this module doesn't need delimiters after or
1042	able to read them, many other languages depend on that.	1087	between JSON texts to be able to read them, many other languages depend on
		1088	them.
1043		1089
1044	A simple RPC protocol that interoperates easily with others is to send	1090	A simple RPC protocol that interoperates easily with other languages is
1045	JSON arrays (or objects, although arrays are usually the better choice as	1091	to send JSON arrays (or objects, although arrays are usually the better
1046	they mimic how function argument passing works) and a newline after each	1092	choice as they mimic how function argument passing works) and a newline
1047	JSON text:	1093	after each JSON text:
1048		1094
1049	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1095	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1050	$handle->push_write ("\012");	1096	$handle->push_write ("\012");
1051		1097
1052	An AnyEvent::Handle receiver would simply use the C<json> read type and	1098	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
1055	$handle->push_read (json => sub { my $array = $_[1]; ... });	1101	$handle->push_read (json => sub { my $array = $_[1]; ... });
1056		1102
1057	Other languages could read single lines terminated by a newline and pass	1103	Other languages could read single lines terminated by a newline and pass
1058	this line into their JSON decoder of choice.	1104	this line into their JSON decoder of choice.
1059		1105
		1106	=item cbor => $perl_scalar
		1107
		1108	Encodes the given scalar into a CBOR value. Unless you provide your own
		1109	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1110	using any extensions, if possible.
		1111
		1112	CBOR values are self-delimiting, so you can write CBOR at one end of
		1113	a handle and read them at the other end without using any additional
		1114	framing.
		1115
		1116	A simple nd very very fast RPC protocol that interoperates with
		1117	other languages is to send CBOR and receive CBOR values (arrays are
		1118	recommended):
		1119
		1120	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1121
		1122	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1123
		1124	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1125
1060	=cut	1126	=cut
1061		1127
1062	sub json_coder() {	1128	sub json_coder() {
1063	eval { require JSON::XS; JSON::XS->new->utf8 }	1129	eval { require JSON::XS; JSON::XS->new->utf8 }
1064	\|\| do { require JSON; JSON->new->utf8 }	1130	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1065	}	1131	}
1066		1132
1067	register_write_type json => sub {	1133	register_write_type json => sub {
1068	my ($self, $ref) = @_;	1134	my ($self, $ref) = @_;
1069		1135
1070	my $json = $self->{json} \|\|= json_coder;	1136	($self->{json} \|\|= json_coder)
1071
1072	$json->encode ($ref)	1137	->encode ($ref)
		1138	};
		1139
		1140	sub cbor_coder() {
		1141	require CBOR::XS;
		1142	CBOR::XS->new
		1143	}
		1144
		1145	register_write_type cbor => sub {
		1146	my ($self, $scalar) = @_;
		1147
		1148	($self->{cbor} \|\|= cbor_coder)
		1149	->encode ($scalar)
1073	};	1150	};
1074		1151
1075	=item storable => $reference	1152	=item storable => $reference
1076		1153
1077	Freezes the given reference using L<Storable> and writes it to the	1154	Freezes the given reference using L<Storable> and writes it to the
…		…
1080	=cut	1157	=cut
1081		1158
1082	register_write_type storable => sub {	1159	register_write_type storable => sub {
1083	my ($self, $ref) = @_;	1160	my ($self, $ref) = @_;
1084		1161
1085	require Storable;	1162	require Storable unless $Storable::VERSION;
1086		1163
1087	pack "w/a*", Storable::nfreeze ($ref)	1164	pack "w/a*", Storable::nfreeze ($ref)
1088	};	1165	};
1089		1166
1090	=back	1167	=back
…		…
1127		1204
1128	Whenever the given C<type> is used, C<push_write> will the function with	1205	Whenever the given C<type> is used, C<push_write> will the function with
1129	the handle object and the remaining arguments.	1206	the handle object and the remaining arguments.
1130		1207
1131	The function is supposed to return a single octet string that will be	1208	The function is supposed to return a single octet string that will be
1132	appended to the write buffer, so you cna mentally treat this function as a	1209	appended to the write buffer, so you can mentally treat this function as a
1133	"arguments to on-the-wire-format" converter.	1210	"arguments to on-the-wire-format" converter.
1134		1211
1135	Example: implement a custom write type C<join> that joins the remaining	1212	Example: implement a custom write type C<join> that joins the remaining
1136	arguments using the first one.	1213	arguments using the first one.
1137		1214
…		…
1431	data.	1508	data.
1432		1509
1433	Example: read 2 bytes.	1510	Example: read 2 bytes.
1434		1511
1435	$handle->push_read (chunk => 2, sub {	1512	$handle->push_read (chunk => 2, sub {
1436	warn "yay ", unpack "H*", $_[1];	1513	say "yay " . unpack "H*", $_[1];
1437	});	1514	});
1438		1515
1439	=cut	1516	=cut
1440		1517
1441	register_read_type chunk => sub {	1518	register_read_type chunk => sub {
…		…
1471		1548
1472	register_read_type line => sub {	1549	register_read_type line => sub {
1473	my ($self, $cb, $eol) = @_;	1550	my ($self, $cb, $eol) = @_;
1474		1551
1475	if (@_ < 3) {	1552	if (@_ < 3) {
1476	# this is more than twice as fast as the generic code below	1553	# this is faster then the generic code below
1477	sub {	1554	sub {
1478	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1555	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1556	or return;
1479		1557
		1558	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1480	$cb->($_[0], $1, $2);	1559	$cb->($_[0], $str, "$1");
1481	1	1560	1
1482	}	1561	}
1483	} else {	1562	} else {
1484	$eol = quotemeta $eol unless ref $eol;	1563	$eol = quotemeta $eol unless ref $eol;
1485	$eol = qr\|^(.*?)($eol)\|s;	1564	$eol = qr\|^(.*?)($eol)\|s;
1486		1565
1487	sub {	1566	sub {
1488	$_[0]{rbuf} =~ s/$eol// or return;	1567	$_[0]{rbuf} =~ s/$eol// or return;
1489		1568
1490	$cb->($_[0], $1, $2);	1569	$cb->($_[0], "$1", "$2");
1491	1	1570	1
1492	}	1571	}
1493	}	1572	}
1494	};	1573	};
1495		1574
…		…
1648	=item json => $cb->($handle, $hash_or_arrayref)	1727	=item json => $cb->($handle, $hash_or_arrayref)
1649		1728
1650	Reads a JSON object or array, decodes it and passes it to the	1729	Reads a JSON object or array, decodes it and passes it to the
1651	callback. When a parse error occurs, an C<EBADMSG> error will be raised.	1730	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1652		1731
1653	If a C<json> object was passed to the constructor, then that will be used	1732	If a C<json> object was passed to the constructor, then that will be
1654	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1733	used for the final decode, otherwise it will create a L<JSON::XS> or
		1734	L<JSON::PP> coder object expecting UTF-8.
1655		1735
1656	This read type uses the incremental parser available with JSON version	1736	This read type uses the incremental parser available with JSON version
1657	2.09 (and JSON::XS version 2.2) and above. You have to provide a	1737	2.09 (and JSON::XS version 2.2) and above.
1658	dependency on your own: this module will load the JSON module, but
1659	AnyEvent does not depend on it itself.
1660		1738
1661	Since JSON texts are fully self-delimiting, the C<json> read and write	1739	Since JSON texts are fully self-delimiting, the C<json> read and write
1662	types are an ideal simple RPC protocol: just exchange JSON datagrams. See	1740	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1663	the C<json> write type description, above, for an actual example.	1741	the C<json> write type description, above, for an actual example.
1664		1742
…		…
1668	my ($self, $cb) = @_;	1746	my ($self, $cb) = @_;
1669		1747
1670	my $json = $self->{json} \|\|= json_coder;	1748	my $json = $self->{json} \|\|= json_coder;
1671		1749
1672	my $data;	1750	my $data;
1673	my $rbuf = \$self->{rbuf};
1674		1751
1675	sub {	1752	sub {
1676	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };	1753	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1677		1754
1678	if ($ref) {	1755	if ($ref) {
…		…
1697	()	1774	()
1698	}	1775	}
1699	}	1776	}
1700	};	1777	};
1701		1778
		1779	=item cbor => $cb->($handle, $scalar)
		1780
		1781	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1782	error occurs, an C<EBADMSG> error will be raised.
		1783
		1784	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1785	used for the final decode, otherwise it will create a CBOR coder without
		1786	enabling any options.
		1787
		1788	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1789	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1790	itself.
		1791
		1792	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1793	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1794	the C<cbor> write type description, above, for an actual example.
		1795
		1796	=cut
		1797
		1798	register_read_type cbor => sub {
		1799	my ($self, $cb) = @_;
		1800
		1801	my $cbor = $self->{cbor} \|\|= cbor_coder;
		1802
		1803	my $data;
		1804
		1805	sub {
		1806	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1807
		1808	if (@value) {
		1809	$cb->($_[0], @value);
		1810
		1811	1
		1812	} elsif ($@) {
		1813	# error case
		1814	$cbor->incr_reset;
		1815
		1816	$_[0]->_error (Errno::EBADMSG);
		1817
		1818	()
		1819	} else {
		1820	()
		1821	}
		1822	}
		1823	};
		1824
1702	=item storable => $cb->($handle, $ref)	1825	=item storable => $cb->($handle, $ref)
1703		1826
1704	Deserialises a L<Storable> frozen representation as written by the	1827	Deserialises a L<Storable> frozen representation as written by the
1705	C<storable> write type (BER-encoded length prefix followed by nfreeze'd	1828	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
1706	data).	1829	data).
…		…
1710	=cut	1833	=cut
1711		1834
1712	register_read_type storable => sub {	1835	register_read_type storable => sub {
1713	my ($self, $cb) = @_;	1836	my ($self, $cb) = @_;
1714		1837
1715	require Storable;	1838	require Storable unless $Storable::VERSION;
1716		1839
1717	sub {	1840	sub {
1718	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1841	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1719	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1842	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1720	or return;	1843	or return;
…		…
1723		1846
1724	# bypass unshift if we already have the remaining chunk	1847	# bypass unshift if we already have the remaining chunk
1725	if ($format + $len <= length $_[0]{rbuf}) {	1848	if ($format + $len <= length $_[0]{rbuf}) {
1726	my $data = substr $_[0]{rbuf}, $format, $len;	1849	my $data = substr $_[0]{rbuf}, $format, $len;
1727	substr $_[0]{rbuf}, 0, $format + $len, "";	1850	substr $_[0]{rbuf}, 0, $format + $len, "";
		1851
1728	$cb->($_[0], Storable::thaw ($data));	1852	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1853	or return $_[0]->_error (Errno::EBADMSG);
1729	} else {	1854	} else {
1730	# remove prefix	1855	# remove prefix
1731	substr $_[0]{rbuf}, 0, $format, "";	1856	substr $_[0]{rbuf}, 0, $format, "";
1732		1857
1733	# read remaining chunk	1858	# read remaining chunk
1734	$_[0]->unshift_read (chunk => $len, sub {	1859	$_[0]->unshift_read (chunk => $len, sub {
1735	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1860	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1736	$cb->($_[0], $ref);
1737	} else {
1738	$_[0]->_error (Errno::EBADMSG);	1861	or $_[0]->_error (Errno::EBADMSG);
1739	}
1740	});	1862	});
1741	}	1863	}
1742		1864
1743	1	1865	1
1744	}	1866	}
		1867	};
		1868
		1869	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1870
		1871	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1872	record without consuming anything. Only SSL version 3 or higher
		1873	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1874	SSL2-compatible framing is supported).
		1875
		1876	If it detects that the input data is likely TLS, it calls the callback
		1877	with a true value for C<$detect> and the (on-wire) TLS version as second
		1878	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1879	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1880	be definitely not TLS, it calls the callback with a false value for
		1881	C<$detect>.
		1882
		1883	The callback could use this information to decide whether or not to start
		1884	TLS negotiation.
		1885
		1886	In all cases the data read so far is passed to the following read
		1887	handlers.
		1888
		1889	Usually you want to use the C<tls_autostart> read type instead.
		1890
		1891	If you want to design a protocol that works in the presence of TLS
		1892	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1893	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1894	read type does are a bit more strict, but might losen in the future to
		1895	accomodate protocol changes.
		1896
		1897	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1898	L<Net::SSLeay>).
		1899
		1900	=item tls_autostart => $tls[, $tls_ctx]
		1901
		1902	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1903	to start tls by calling C<starttls> with the given arguments.
		1904
		1905	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1906	been configured to accept, as servers do not normally send a handshake on
		1907	their own and ths cannot be detected in this way.
		1908
		1909	See C<tls_detect> above for more details.
		1910
		1911	Example: give the client a chance to start TLS before accepting a text
		1912	line.
		1913
		1914	$hdl->push_read (tls_detect => "accept");
		1915	$hdl->push_read (line => sub {
		1916	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1917	});
		1918
		1919	=cut
		1920
		1921	register_read_type tls_detect => sub {
		1922	my ($self, $cb) = @_;
		1923
		1924	sub {
		1925	# this regex matches a full or partial tls record
		1926	if (
		1927	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1928	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1929	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1930	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1931	) {
		1932	return if 3 != length $1; # partial match, can't decide yet
		1933
		1934	# full match, valid TLS record
		1935	my ($major, $minor) = unpack "CC", $1;
		1936	$cb->($self, "accept", $major + $minor * 0.1);
		1937	} else {
		1938	# mismatch == guaranteed not TLS
		1939	$cb->($self, undef);
		1940	}
		1941
		1942	1
		1943	}
		1944	};
		1945
		1946	register_read_type tls_autostart => sub {
		1947	my ($self, @tls) = @_;
		1948
		1949	$RH{tls_detect}($self, sub {
		1950	return unless $_[1];
		1951	$_[0]->starttls (@tls);
		1952	})
1745	};	1953	};
1746		1954
1747	=back	1955	=back
1748		1956
1749	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1957	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1791	some readings of the the SSL/TLS specifications basically require this	1999	some readings of the the SSL/TLS specifications basically require this
1792	attack to be working, as SSL/TLS implementations might stall sending data	2000	attack to be working, as SSL/TLS implementations might stall sending data
1793	during a rehandshake.	2001	during a rehandshake.
1794		2002
1795	As a guideline, during the initial handshake, you should not stop reading,	2003	As a guideline, during the initial handshake, you should not stop reading,
1796	and as a client, it might cause problems, depending on your applciation.	2004	and as a client, it might cause problems, depending on your application.
1797		2005
1798	=cut	2006	=cut
1799		2007
1800	sub stop_read {	2008	sub stop_read {
1801	my ($self) = @_;	2009	my ($self) = @_;
…		…
1849	my ($self, $err) = @_;	2057	my ($self, $err) = @_;
1850		2058
1851	return $self->_error ($!, 1)	2059	return $self->_error ($!, 1)
1852	if $err == Net::SSLeay::ERROR_SYSCALL ();	2060	if $err == Net::SSLeay::ERROR_SYSCALL ();
1853		2061
1854	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2062	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1855		2063
1856	# reduce error string to look less scary	2064	# reduce error string to look less scary
1857	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2065	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1858		2066
1859	if ($self->{_on_starttls}) {	2067	if ($self->{_on_starttls}) {
…		…
1873	sub _dotls {	2081	sub _dotls {
1874	my ($self) = @_;	2082	my ($self) = @_;
1875		2083
1876	my $tmp;	2084	my $tmp;
1877		2085
1878	if (length $self->{_tls_wbuf}) {	2086	while (length $self->{_tls_wbuf}) {
1879	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2087	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1880	substr $self->{_tls_wbuf}, 0, $tmp, "";	2088	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2089
		2090	return $self->_tls_error ($tmp)
		2091	if $tmp != $ERROR_WANT_READ
		2092	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		2093
		2094	last;
1881	}	2095	}
1882		2096
1883	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2097	substr $self->{_tls_wbuf}, 0, $tmp, "";
1884	return $self->_tls_error ($tmp)
1885	if $tmp != $ERROR_WANT_READ
1886	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1887	}	2098	}
1888		2099
1889	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2100	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1890	unless (length $tmp) {	2101	unless (length $tmp) {
1891	$self->{_on_starttls}	2102	$self->{_on_starttls}
…		…
1905	$self->{_tls_rbuf} .= $tmp;	2116	$self->{_tls_rbuf} .= $tmp;
1906	$self->_drain_rbuf;	2117	$self->_drain_rbuf;
1907	$self->{tls} or return; # tls session might have gone away in callback	2118	$self->{tls} or return; # tls session might have gone away in callback
1908	}	2119	}
1909		2120
1910	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	2121	$tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us
1911	return $self->_tls_error ($tmp)	2122	return $self->_tls_error ($tmp)
1912	if $tmp != $ERROR_WANT_READ	2123	if $tmp != $ERROR_WANT_READ
1913	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2124	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1914		2125
1915	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2126	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1925		2136
1926	=item $handle->starttls ($tls[, $tls_ctx])	2137	=item $handle->starttls ($tls[, $tls_ctx])
1927		2138
1928	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2139	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1929	object is created, you can also do that at a later time by calling	2140	object is created, you can also do that at a later time by calling
1930	C<starttls>.	2141	C<starttls>. See the C<tls> constructor argument for general info.
1931		2142
1932	Starting TLS is currently an asynchronous operation - when you push some	2143	Starting TLS is currently an asynchronous operation - when you push some
1933	write data and then call C<< ->starttls >> then TLS negotiation will start	2144	write data and then call C<< ->starttls >> then TLS negotiation will start
1934	immediately, after which the queued write data is then sent.	2145	immediately, after which the queued write data is then sent. This might
		2146	change in future versions, so best make sure you have no outstanding write
		2147	data when calling this method.
1935		2148
1936	The first argument is the same as the C<tls> constructor argument (either	2149	The first argument is the same as the C<tls> constructor argument (either
1937	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2150	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1938		2151
1939	The second argument is the optional C<AnyEvent::TLS> object that is used	2152	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1961	my ($self, $tls, $ctx) = @_;	2174	my ($self, $tls, $ctx) = @_;
1962		2175
1963	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2176	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1964	if $self->{tls};	2177	if $self->{tls};
1965		2178
		2179	unless (defined $AnyEvent::TLS::VERSION) {
		2180	eval {
		2181	require Net::SSLeay;
		2182	require AnyEvent::TLS;
		2183	1
		2184	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2185	}
		2186
1966	$self->{tls} = $tls;	2187	$self->{tls} = $tls;
1967	$self->{tls_ctx} = $ctx if @_ > 2;	2188	$self->{tls_ctx} = $ctx if @_ > 2;
1968		2189
1969	return unless $self->{fh};	2190	return unless $self->{fh};
1970		2191
1971	require Net::SSLeay;
1972
1973	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2192	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1974	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2193	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1975		2194
1976	$tls = delete $self->{tls};	2195	$tls = delete $self->{tls};
1977	$ctx = $self->{tls_ctx};	2196	$ctx = $self->{tls_ctx};
1978		2197
1979	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2198	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1980		2199
1981	if ("HASH" eq ref $ctx) {	2200	if ("HASH" eq ref $ctx) {
1982	require AnyEvent::TLS;
1983
1984	if ($ctx->{cache}) {	2201	if ($ctx->{cache}) {
1985	my $key = $ctx+0;	2202	my $key = $ctx+0;
1986	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2203	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1987	} else {	2204	} else {
1988	$ctx = new AnyEvent::TLS %$ctx;	2205	$ctx = new AnyEvent::TLS %$ctx;
…		…
2203	Probably because your C<on_error> callback is being called instead: When	2420	Probably because your C<on_error> callback is being called instead: When
2204	you have outstanding requests in your read queue, then an EOF is	2421	you have outstanding requests in your read queue, then an EOF is
2205	considered an error as you clearly expected some data.	2422	considered an error as you clearly expected some data.
2206		2423
2207	To avoid this, make sure you have an empty read queue whenever your handle	2424	To avoid this, make sure you have an empty read queue whenever your handle
2208	is supposed to be "idle" (i.e. connection closes are O.K.). You cna set	2425	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
2209	an C<on_read> handler that simply pushes the first read requests in the	2426	an C<on_read> handler that simply pushes the first read requests in the
2210	queue.	2427	queue.
2211		2428
2212	See also the next question, which explains this in a bit more detail.	2429	See also the next question, which explains this in a bit more detail.
2213		2430
…		…
2221	handles requests until the server gets some QUIT command, causing it to	2438	handles requests until the server gets some QUIT command, causing it to
2222	close the connection first (highly desirable for a busy TCP server). A	2439	close the connection first (highly desirable for a busy TCP server). A
2223	client dropping the connection is an error, which means this variant can	2440	client dropping the connection is an error, which means this variant can
2224	detect an unexpected detection close.	2441	detect an unexpected detection close.
2225		2442
2226	To handle this case, always make sure you have a on-empty read queue, by	2443	To handle this case, always make sure you have a non-empty read queue, by
2227	pushing the "read request start" handler on it:	2444	pushing the "read request start" handler on it:
2228		2445
2229	# we assume a request starts with a single line	2446	# we assume a request starts with a single line
2230	my @start_request; @start_request = (line => sub {	2447	my @start_request; @start_request = (line => sub {
2231	my ($hdl, $line) = @_;	2448	my ($hdl, $line) = @_;
…		…
2244	some data and raises the C<EPIPE> error when the connction is dropped	2461	some data and raises the C<EPIPE> error when the connction is dropped
2245	unexpectedly.	2462	unexpectedly.
2246		2463
2247	The second variant is a protocol where the client can drop the connection	2464	The second variant is a protocol where the client can drop the connection
2248	at any time. For TCP, this means that the server machine may run out of	2465	at any time. For TCP, this means that the server machine may run out of
2249	sockets easier, and in general, it means you cnanot distinguish a protocl	2466	sockets easier, and in general, it means you cannot distinguish a protocl
2250	failure/client crash from a normal connection close. Nevertheless, these	2467	failure/client crash from a normal connection close. Nevertheless, these
2251	kinds of protocols are common (and sometimes even the best solution to the	2468	kinds of protocols are common (and sometimes even the best solution to the
2252	problem).	2469	problem).
2253		2470
2254	Having an outstanding read request at all times is possible if you ignore	2471	Having an outstanding read request at all times is possible if you ignore
…		…
2329	C<low_water_mark> this will be called precisely when all data has been	2546	C<low_water_mark> this will be called precisely when all data has been
2330	written to the socket:	2547	written to the socket:
2331		2548
2332	$handle->push_write (...);	2549	$handle->push_write (...);
2333	$handle->on_drain (sub {	2550	$handle->on_drain (sub {
2334	warn "all data submitted to the kernel\n";	2551	AE::log debug => "All data submitted to the kernel.";
2335	undef $handle;	2552	undef $handle;
2336	});	2553	});
2337		2554
2338	If you just want to queue some data and then signal EOF to the other side,	2555	If you just want to queue some data and then signal EOF to the other side,
2339	consider using C<< ->push_shutdown >> instead.	2556	consider using C<< ->push_shutdown >> instead.
…		…
2423	When you have intermediate CA certificates that your clients might not	2640	When you have intermediate CA certificates that your clients might not
2424	know about, just append them to the C<cert_file>.	2641	know about, just append them to the C<cert_file>.
2425		2642
2426	=back	2643	=back
2427		2644
2428
2429	=head1 SUBCLASSING AnyEvent::Handle	2645	=head1 SUBCLASSING AnyEvent::Handle
2430		2646
2431	In many cases, you might want to subclass AnyEvent::Handle.	2647	In many cases, you might want to subclass AnyEvent::Handle.
2432		2648
2433	To make this easier, a given version of AnyEvent::Handle uses these	2649	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2459		2675
2460	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2676	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2461		2677
2462	=cut	2678	=cut
2463		2679
2464	1; # End of AnyEvent::Handle	2680	1
		2681

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.220 by root, Sun Jul 24 13:10:43 2011 UTC vs. Revision 1.241 by root, Fri Sep 5 22:17:26 2014 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.220 by root, Sun Jul 24 13:10:43 2011 UTC vs.
Revision 1.241 by root, Fri Sep 5 22:17:26 2014 UTC