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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.218 by root, Thu Feb 24 12:04:20 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	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> 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 JSON
493	texts.	507	texts.
494		508
495	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
496	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.
497		524
498	=back	525	=back
499		526
500	=cut	527	=cut
501		528
…		…
879		906
880	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
881	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.
882		909
883	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
884	water mark, the C<on_drain> callback will be invoked.	911	water mark, the C<on_drain> callback will be invoked once.
885		912
886	=over 4	913	=over 4
887		914
888	=item $handle->on_drain ($cb)	915	=item $handle->on_drain ($cb)
889		916
…		…
1039		1066
1040	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
1041	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
1042	able to read them, many other languages depend on that.	1069	able to read them, many other languages depend on that.
1043		1070
1044	A simple RPC protocol that interoperates easily with others is to send	1071	A simple RPC protocol that interoperates easily with other languages is
1045	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
1046	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
1047	JSON text:	1074	after each JSON text:
1048		1075
1049	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1076	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1050	$handle->push_write ("\012");	1077	$handle->push_write ("\012");
1051		1078
1052	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
…		…
1055	$handle->push_read (json => sub { my $array = $_[1]; ... });	1082	$handle->push_read (json => sub { my $array = $_[1]; ... });
1056		1083
1057	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
1058	this line into their JSON decoder of choice.	1085	this line into their JSON decoder of choice.
1059		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
1060	=cut	1107	=cut
1061		1108
1062	sub json_coder() {	1109	sub json_coder() {
1063	eval { require JSON::XS; JSON::XS->new->utf8 }	1110	eval { require JSON::XS; JSON::XS->new->utf8 }
1064	\|\| do { require JSON; JSON->new->utf8 }	1111	\|\| do { require JSON; JSON->new->utf8 }
1065	}	1112	}
1066		1113
1067	register_write_type json => sub {	1114	register_write_type json => sub {
1068	my ($self, $ref) = @_;	1115	my ($self, $ref) = @_;
1069		1116
1070	my $json = $self->{json} \|\|= json_coder;	1117	($self->{json} \|\|= json_coder)
1071
1072	$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)
1073	};	1131	};
1074		1132
1075	=item storable => $reference	1133	=item storable => $reference
1076		1134
1077	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
…		…
1080	=cut	1138	=cut
1081		1139
1082	register_write_type storable => sub {	1140	register_write_type storable => sub {
1083	my ($self, $ref) = @_;	1141	my ($self, $ref) = @_;
1084		1142
1085	require Storable;	1143	require Storable unless $Storable::VERSION;
1086		1144
1087	pack "w/a*", Storable::nfreeze ($ref)	1145	pack "w/a*", Storable::nfreeze ($ref)
1088	};	1146	};
1089		1147
1090	=back	1148	=back
…		…
1127		1185
1128	Whenever the given C<type> is used, C<push_write> will the function with	1186	Whenever the given C<type> is used, C<push_write> will the function with
1129	the handle object and the remaining arguments.	1187	the handle object and the remaining arguments.
1130		1188
1131	The function is supposed to return a single octet string that will be	1189	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	1190	appended to the write buffer, so you can mentally treat this function as a
1133	"arguments to on-the-wire-format" converter.	1191	"arguments to on-the-wire-format" converter.
1134		1192
1135	Example: implement a custom write type C<join> that joins the remaining	1193	Example: implement a custom write type C<join> that joins the remaining
1136	arguments using the first one.	1194	arguments using the first one.
1137		1195
…		…
1431	data.	1489	data.
1432		1490
1433	Example: read 2 bytes.	1491	Example: read 2 bytes.
1434		1492
1435	$handle->push_read (chunk => 2, sub {	1493	$handle->push_read (chunk => 2, sub {
1436	warn "yay ", unpack "H*", $_[1];	1494	say "yay " . unpack "H*", $_[1];
1437	});	1495	});
1438		1496
1439	=cut	1497	=cut
1440		1498
1441	register_read_type chunk => sub {	1499	register_read_type chunk => sub {
…		…
1471		1529
1472	register_read_type line => sub {	1530	register_read_type line => sub {
1473	my ($self, $cb, $eol) = @_;	1531	my ($self, $cb, $eol) = @_;
1474		1532
1475	if (@_ < 3) {	1533	if (@_ < 3) {
1476	# this is more than twice as fast as the generic code below	1534	# this is faster then the generic code below
1477	sub {	1535	sub {
1478	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1536	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1537	or return;
1479		1538
		1539	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1480	$cb->($_[0], $1, $2);	1540	$cb->($_[0], $str, "$1");
1481	1	1541	1
1482	}	1542	}
1483	} else {	1543	} else {
1484	$eol = quotemeta $eol unless ref $eol;	1544	$eol = quotemeta $eol unless ref $eol;
1485	$eol = qr\|^(.*?)($eol)\|s;	1545	$eol = qr\|^(.*?)($eol)\|s;
1486		1546
1487	sub {	1547	sub {
1488	$_[0]{rbuf} =~ s/$eol// or return;	1548	$_[0]{rbuf} =~ s/$eol// or return;
1489		1549
1490	$cb->($_[0], $1, $2);	1550	$cb->($_[0], "$1", "$2");
1491	1	1551	1
1492	}	1552	}
1493	}	1553	}
1494	};	1554	};
1495		1555
…		…
1543		1603
1544	sub {	1604	sub {
1545	# accept	1605	# accept
1546	if ($$rbuf =~ $accept) {	1606	if ($$rbuf =~ $accept) {
1547	$data .= substr $$rbuf, 0, $+[0], "";	1607	$data .= substr $$rbuf, 0, $+[0], "";
1548	$cb->($self, $data);	1608	$cb->($_[0], $data);
1549	return 1;	1609	return 1;
1550	}	1610	}
1551		1611
1552	# reject	1612	# reject
1553	if ($reject && $$rbuf =~ $reject) {	1613	if ($reject && $$rbuf =~ $reject) {
1554	$self->_error (Errno::EBADMSG);	1614	$_[0]->_error (Errno::EBADMSG);
1555	}	1615	}
1556		1616
1557	# skip	1617	# skip
1558	if ($skip && $$rbuf =~ $skip) {	1618	if ($skip && $$rbuf =~ $skip) {
1559	$data .= substr $$rbuf, 0, $+[0], "";	1619	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1575	my ($self, $cb) = @_;	1635	my ($self, $cb) = @_;
1576		1636
1577	sub {	1637	sub {
1578	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1638	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1579	if ($_[0]{rbuf} =~ /[^0-9]/) {	1639	if ($_[0]{rbuf} =~ /[^0-9]/) {
1580	$self->_error (Errno::EBADMSG);	1640	$_[0]->_error (Errno::EBADMSG);
1581	}	1641	}
1582	return;	1642	return;
1583	}	1643	}
1584		1644
1585	my $len = $1;	1645	my $len = $1;
1586		1646
1587	$self->unshift_read (chunk => $len, sub {	1647	$_[0]->unshift_read (chunk => $len, sub {
1588	my $string = $_[1];	1648	my $string = $_[1];
1589	$_[0]->unshift_read (chunk => 1, sub {	1649	$_[0]->unshift_read (chunk => 1, sub {
1590	if ($_[1] eq ",") {	1650	if ($_[1] eq ",") {
1591	$cb->($_[0], $string);	1651	$cb->($_[0], $string);
1592	} else {	1652	} else {
1593	$self->_error (Errno::EBADMSG);	1653	$_[0]->_error (Errno::EBADMSG);
1594	}	1654	}
1595	});	1655	});
1596	});	1656	});
1597		1657
1598	1	1658	1
…		…
1668	my ($self, $cb) = @_;	1728	my ($self, $cb) = @_;
1669		1729
1670	my $json = $self->{json} \|\|= json_coder;	1730	my $json = $self->{json} \|\|= json_coder;
1671		1731
1672	my $data;	1732	my $data;
1673	my $rbuf = \$self->{rbuf};
1674		1733
1675	sub {	1734	sub {
1676	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1735	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1677		1736
1678	if ($ref) {	1737	if ($ref) {
1679	$self->{rbuf} = $json->incr_text;	1738	$_[0]{rbuf} = $json->incr_text;
1680	$json->incr_text = "";	1739	$json->incr_text = "";
1681	$cb->($self, $ref);	1740	$cb->($_[0], $ref);
1682		1741
1683	1	1742	1
1684	} elsif ($@) {	1743	} elsif ($@) {
1685	# error case	1744	# error case
1686	$json->incr_skip;	1745	$json->incr_skip;
1687		1746
1688	$self->{rbuf} = $json->incr_text;	1747	$_[0]{rbuf} = $json->incr_text;
1689	$json->incr_text = "";	1748	$json->incr_text = "";
1690		1749
1691	$self->_error (Errno::EBADMSG);	1750	$_[0]->_error (Errno::EBADMSG);
1692		1751
1693	()	1752	()
1694	} else {	1753	} else {
1695	$self->{rbuf} = "";	1754	$_[0]{rbuf} = "";
1696		1755
		1756	()
		1757	}
		1758	}
		1759	};
		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 {
1697	()	1802	()
1698	}	1803	}
1699	}	1804	}
1700	};	1805	};
1701		1806
…		…
1710	=cut	1815	=cut
1711		1816
1712	register_read_type storable => sub {	1817	register_read_type storable => sub {
1713	my ($self, $cb) = @_;	1818	my ($self, $cb) = @_;
1714		1819
1715	require Storable;	1820	require Storable unless $Storable::VERSION;
1716		1821
1717	sub {	1822	sub {
1718	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1823	# 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} })	1824	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1720	or return;	1825	or return;
…		…
1723		1828
1724	# bypass unshift if we already have the remaining chunk	1829	# bypass unshift if we already have the remaining chunk
1725	if ($format + $len <= length $_[0]{rbuf}) {	1830	if ($format + $len <= length $_[0]{rbuf}) {
1726	my $data = substr $_[0]{rbuf}, $format, $len;	1831	my $data = substr $_[0]{rbuf}, $format, $len;
1727	substr $_[0]{rbuf}, 0, $format + $len, "";	1832	substr $_[0]{rbuf}, 0, $format + $len, "";
		1833
1728	$cb->($_[0], Storable::thaw ($data));	1834	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1835	or return $_[0]->_error (Errno::EBADMSG);
1729	} else {	1836	} else {
1730	# remove prefix	1837	# remove prefix
1731	substr $_[0]{rbuf}, 0, $format, "";	1838	substr $_[0]{rbuf}, 0, $format, "";
1732		1839
1733	# read remaining chunk	1840	# read remaining chunk
1734	$_[0]->unshift_read (chunk => $len, sub {	1841	$_[0]->unshift_read (chunk => $len, sub {
1735	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1842	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1736	$cb->($_[0], $ref);
1737	} else {
1738	$self->_error (Errno::EBADMSG);	1843	or $_[0]->_error (Errno::EBADMSG);
1739	}
1740	});	1844	});
1741	}	1845	}
1742		1846
1743	1	1847	1
1744	}	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	})
1745	};	1935	};
1746		1936
1747	=back	1937	=back
1748		1938
1749	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1939	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1791	some readings of the the SSL/TLS specifications basically require this	1981	some readings of the the SSL/TLS specifications basically require this
1792	attack to be working, as SSL/TLS implementations might stall sending data	1982	attack to be working, as SSL/TLS implementations might stall sending data
1793	during a rehandshake.	1983	during a rehandshake.
1794		1984
1795	As a guideline, during the initial handshake, you should not stop reading,	1985	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.	1986	and as a client, it might cause problems, depending on your application.
1797		1987
1798	=cut	1988	=cut
1799		1989
1800	sub stop_read {	1990	sub stop_read {
1801	my ($self) = @_;	1991	my ($self) = @_;
…		…
1849	my ($self, $err) = @_;	2039	my ($self, $err) = @_;
1850		2040
1851	return $self->_error ($!, 1)	2041	return $self->_error ($!, 1)
1852	if $err == Net::SSLeay::ERROR_SYSCALL ();	2042	if $err == Net::SSLeay::ERROR_SYSCALL ();
1853		2043
1854	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 ());
1855		2045
1856	# reduce error string to look less scary	2046	# reduce error string to look less scary
1857	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2047	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1858		2048
1859	if ($self->{_on_starttls}) {	2049	if ($self->{_on_starttls}) {
…		…
1873	sub _dotls {	2063	sub _dotls {
1874	my ($self) = @_;	2064	my ($self) = @_;
1875		2065
1876	my $tmp;	2066	my $tmp;
1877		2067
1878	if (length $self->{_tls_wbuf}) {	2068	while (length $self->{_tls_wbuf}) {
1879	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2069	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1880	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;
1881	}	2077	}
1882		2078
1883	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2079	substr $self->{_tls_wbuf}, 0, $tmp, "";
1884	return $self->_tls_error ($tmp)
1885	if $tmp != $ERROR_WANT_READ
1886	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1887	}	2080	}
1888		2081
1889	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2082	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1890	unless (length $tmp) {	2083	unless (length $tmp) {
1891	$self->{_on_starttls}	2084	$self->{_on_starttls}
…		…
1905	$self->{_tls_rbuf} .= $tmp;	2098	$self->{_tls_rbuf} .= $tmp;
1906	$self->_drain_rbuf;	2099	$self->_drain_rbuf;
1907	$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
1908	}	2101	}
1909		2102
1910	$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
1911	return $self->_tls_error ($tmp)	2104	return $self->_tls_error ($tmp)
1912	if $tmp != $ERROR_WANT_READ	2105	if $tmp != $ERROR_WANT_READ
1913	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2106	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1914		2107
1915	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2108	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1925		2118
1926	=item $handle->starttls ($tls[, $tls_ctx])	2119	=item $handle->starttls ($tls[, $tls_ctx])
1927		2120
1928	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2121	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	2122	object is created, you can also do that at a later time by calling
1930	C<starttls>.	2123	C<starttls>. See the C<tls> constructor argument for general info.
1931		2124
1932	Starting TLS is currently an asynchronous operation - when you push some	2125	Starting TLS is currently an asynchronous operation - when you push some
1933	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
1934	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.
1935		2130
1936	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
1937	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2132	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1938		2133
1939	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
…		…
1961	my ($self, $tls, $ctx) = @_;	2156	my ($self, $tls, $ctx) = @_;
1962		2157
1963	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"
1964	if $self->{tls};	2159	if $self->{tls};
1965		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
1966	$self->{tls} = $tls;	2169	$self->{tls} = $tls;
1967	$self->{tls_ctx} = $ctx if @_ > 2;	2170	$self->{tls_ctx} = $ctx if @_ > 2;
1968		2171
1969	return unless $self->{fh};	2172	return unless $self->{fh};
1970		2173
1971	require Net::SSLeay;
1972
1973	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2174	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1974	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2175	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1975		2176
1976	$tls = delete $self->{tls};	2177	$tls = delete $self->{tls};
1977	$ctx = $self->{tls_ctx};	2178	$ctx = $self->{tls_ctx};
1978		2179
1979	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
1980		2181
1981	if ("HASH" eq ref $ctx) {	2182	if ("HASH" eq ref $ctx) {
1982	require AnyEvent::TLS;
1983
1984	if ($ctx->{cache}) {	2183	if ($ctx->{cache}) {
1985	my $key = $ctx+0;	2184	my $key = $ctx+0;
1986	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2185	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1987	} else {	2186	} else {
1988	$ctx = new AnyEvent::TLS %$ctx;	2187	$ctx = new AnyEvent::TLS %$ctx;
…		…
2010	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2209	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
2011		2210
2012	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2211	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
2013	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2212	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
2014		2213
2015	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2214	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2215	$self->{rbuf} = "";
2016		2216
2017	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2217	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
2018		2218
2019	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2219	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
2020	if $self->{on_starttls};	2220	if $self->{on_starttls};
…		…
2202	Probably because your C<on_error> callback is being called instead: When	2402	Probably because your C<on_error> callback is being called instead: When
2203	you have outstanding requests in your read queue, then an EOF is	2403	you have outstanding requests in your read queue, then an EOF is
2204	considered an error as you clearly expected some data.	2404	considered an error as you clearly expected some data.
2205		2405
2206	To avoid this, make sure you have an empty read queue whenever your handle	2406	To avoid this, make sure you have an empty read queue whenever your handle
2207	is supposed to be "idle" (i.e. connection closes are O.K.). You cna set	2407	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
2208	an C<on_read> handler that simply pushes the first read requests in the	2408	an C<on_read> handler that simply pushes the first read requests in the
2209	queue.	2409	queue.
2210		2410
2211	See also the next question, which explains this in a bit more detail.	2411	See also the next question, which explains this in a bit more detail.
2212		2412
…		…
2220	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
2221	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
2222	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
2223	detect an unexpected detection close.	2423	detect an unexpected detection close.
2224		2424
2225	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
2226	pushing the "read request start" handler on it:	2426	pushing the "read request start" handler on it:
2227		2427
2228	# we assume a request starts with a single line	2428	# we assume a request starts with a single line
2229	my @start_request; @start_request = (line => sub {	2429	my @start_request; @start_request = (line => sub {
2230	my ($hdl, $line) = @_;	2430	my ($hdl, $line) = @_;
…		…
2243	some data and raises the C<EPIPE> error when the connction is dropped	2443	some data and raises the C<EPIPE> error when the connction is dropped
2244	unexpectedly.	2444	unexpectedly.
2245		2445
2246	The second variant is a protocol where the client can drop the connection	2446	The second variant is a protocol where the client can drop the connection
2247	at any time. For TCP, this means that the server machine may run out of	2447	at any time. For TCP, this means that the server machine may run out of
2248	sockets easier, and in general, it means you cnanot distinguish a protocl	2448	sockets easier, and in general, it means you cannot distinguish a protocl
2249	failure/client crash from a normal connection close. Nevertheless, these	2449	failure/client crash from a normal connection close. Nevertheless, these
2250	kinds of protocols are common (and sometimes even the best solution to the	2450	kinds of protocols are common (and sometimes even the best solution to the
2251	problem).	2451	problem).
2252		2452
2253	Having an outstanding read request at all times is possible if you ignore	2453	Having an outstanding read request at all times is possible if you ignore
…		…
2305	$handle->on_eof (undef);	2505	$handle->on_eof (undef);
2306	$handle->on_error (sub {	2506	$handle->on_error (sub {
2307	my $data = delete $_[0]{rbuf};	2507	my $data = delete $_[0]{rbuf};
2308	});	2508	});
2309		2509
		2510	Note that this example removes the C<rbuf> member from the handle object,
		2511	which is not normally allowed by the API. It is expressly permitted in
		2512	this case only, as the handle object needs to be destroyed afterwards.
		2513
2310	The reason to use C<on_error> is that TCP connections, due to latencies	2514	The reason to use C<on_error> is that TCP connections, due to latencies
2311	and packets loss, might get closed quite violently with an error, when in	2515	and packets loss, might get closed quite violently with an error, when in
2312	fact all data has been received.	2516	fact all data has been received.
2313		2517
2314	It is usually better to use acknowledgements when transferring data,	2518	It is usually better to use acknowledgements when transferring data,
…		…
2324	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
2325	written to the socket:	2529	written to the socket:
2326		2530
2327	$handle->push_write (...);	2531	$handle->push_write (...);
2328	$handle->on_drain (sub {	2532	$handle->on_drain (sub {
2329	warn "all data submitted to the kernel\n";	2533	AE::log debug => "All data submitted to the kernel.";
2330	undef $handle;	2534	undef $handle;
2331	});	2535	});
2332		2536
2333	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,
2334	consider using C<< ->push_shutdown >> instead.	2538	consider using C<< ->push_shutdown >> instead.
…		…
2418	When you have intermediate CA certificates that your clients might not	2622	When you have intermediate CA certificates that your clients might not
2419	know about, just append them to the C<cert_file>.	2623	know about, just append them to the C<cert_file>.
2420		2624
2421	=back	2625	=back
2422		2626
2423
2424	=head1 SUBCLASSING AnyEvent::Handle	2627	=head1 SUBCLASSING AnyEvent::Handle
2425		2628
2426	In many cases, you might want to subclass AnyEvent::Handle.	2629	In many cases, you might want to subclass AnyEvent::Handle.
2427		2630
2428	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
…		…
2454		2657
2455	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>.
2456		2659
2457	=cut	2660	=cut
2458		2661
2459	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.218 by root, Thu Feb 24 12:04:20 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.218 by root, Thu Feb 24 12:04:20 2011 UTC vs.
Revision 1.239 by root, Tue Dec 10 20:39:12 2013 UTC