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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.226 by root, Mon Dec 12 12:56:04 2011 UTC vs.
Revision 1.244 by root, Wed Apr 1 19:59:01 2015 UTC

…		…
11		11
12	my $hdl; $hdl = new AnyEvent::Handle	12	my $hdl; $hdl = new AnyEvent::Handle
13	fh => \*STDIN,	13	fh => \*STDIN,
14	on_error => sub {	14	on_error => sub {
15	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
16	AE::log error => "got error $msg\n";	16	AE::log error => $msg;
17	$hdl->destroy;	17	$hdl->destroy;
18	$cv->send;	18	$cv->send;
19	};	19	};
20		20
21	# send some request line	21	# send some request line
…		…
53	package AnyEvent::Handle;	53	package AnyEvent::Handle;
54		54
55	use Scalar::Util ();	55	use Scalar::Util ();
56	use List::Util ();	56	use List::Util ();
57	use Carp ();	57	use Carp ();
58	use Errno qw(EAGAIN EINTR);	58	use Errno qw(EAGAIN EWOULDBLOCK EINTR);
59		59
60	use AnyEvent (); BEGIN { AnyEvent::common_sense }	60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
61	use AnyEvent::Util qw(WSAEWOULDBLOCK);	61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
62		62
63	our $VERSION = $AnyEvent::VERSION;	63	our $VERSION = $AnyEvent::VERSION;
…		…
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
…		…
934	$self->{on_drain}($self)	971	$self->{on_drain}($self)
935	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	972	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
936	&& $self->{on_drain};	973	&& $self->{on_drain};
937		974
938	delete $self->{_ww} unless length $self->{wbuf};	975	delete $self->{_ww} unless length $self->{wbuf};
939	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	976	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
940	$self->_error ($!, 1);	977	$self->_error ($!, 1);
941	}	978	}
942	};	979	};
943		980
944	# try to write data immediately	981	# try to write data immediately
…		…
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
…		…
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
1497	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1572	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
1498		1573
1499	Makes a regex match against the regex object C<$accept> and returns	1574	Makes a regex match against the regex object C<$accept> and returns
1500	everything up to and including the match.	1575	everything up to and including the match. All the usual regex variables
		1576	($1, %+ etc.) from the regex match are available in the callback.
1501		1577
1502	Example: read a single line terminated by '\n'.	1578	Example: read a single line terminated by '\n'.
1503		1579
1504	$handle->push_read (regex => qr<\n>, sub { ... });	1580	$handle->push_read (regex => qr<\n>, sub { ... });
1505		1581
…		…
1649	=item json => $cb->($handle, $hash_or_arrayref)	1725	=item json => $cb->($handle, $hash_or_arrayref)
1650		1726
1651	Reads a JSON object or array, decodes it and passes it to the	1727	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.	1728	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1653		1729
1654	If a C<json> object was passed to the constructor, then that will be used	1730	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.	1731	used for the final decode, otherwise it will create a L<JSON::XS> or
		1732	L<JSON::PP> coder object expecting UTF-8.
1656		1733
1657	This read type uses the incremental parser available with JSON version	1734	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	1735	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		1736
1662	Since JSON texts are fully self-delimiting, the C<json> read and write	1737	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	1738	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1664	the C<json> write type description, above, for an actual example.	1739	the C<json> write type description, above, for an actual example.
1665		1740
…		…
1669	my ($self, $cb) = @_;	1744	my ($self, $cb) = @_;
1670		1745
1671	my $json = $self->{json} \|\|= json_coder;	1746	my $json = $self->{json} \|\|= json_coder;
1672		1747
1673	my $data;	1748	my $data;
1674	my $rbuf = \$self->{rbuf};
1675		1749
1676	sub {	1750	sub {
1677	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };	1751	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1678		1752
1679	if ($ref) {	1753	if ($ref) {
…		…
1698	()	1772	()
1699	}	1773	}
1700	}	1774	}
1701	};	1775	};
1702		1776
		1777	=item cbor => $cb->($handle, $scalar)
		1778
		1779	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1780	error occurs, an C<EBADMSG> error will be raised.
		1781
		1782	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1783	used for the final decode, otherwise it will create a CBOR coder without
		1784	enabling any options.
		1785
		1786	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1787	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1788	itself.
		1789
		1790	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1791	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1792	the C<cbor> write type description, above, for an actual example.
		1793
		1794	=cut
		1795
		1796	register_read_type cbor => sub {
		1797	my ($self, $cb) = @_;
		1798
		1799	my $cbor = $self->{cbor} \|\|= cbor_coder;
		1800
		1801	my $data;
		1802
		1803	sub {
		1804	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1805
		1806	if (@value) {
		1807	$cb->($_[0], @value);
		1808
		1809	1
		1810	} elsif ($@) {
		1811	# error case
		1812	$cbor->incr_reset;
		1813
		1814	$_[0]->_error (Errno::EBADMSG);
		1815
		1816	()
		1817	} else {
		1818	()
		1819	}
		1820	}
		1821	};
		1822
1703	=item storable => $cb->($handle, $ref)	1823	=item storable => $cb->($handle, $ref)
1704		1824
1705	Deserialises a L<Storable> frozen representation as written by the	1825	Deserialises a L<Storable> frozen representation as written by the
1706	C<storable> write type (BER-encoded length prefix followed by nfreeze'd	1826	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
1707	data).	1827	data).
…		…
1724		1844
1725	# bypass unshift if we already have the remaining chunk	1845	# bypass unshift if we already have the remaining chunk
1726	if ($format + $len <= length $_[0]{rbuf}) {	1846	if ($format + $len <= length $_[0]{rbuf}) {
1727	my $data = substr $_[0]{rbuf}, $format, $len;	1847	my $data = substr $_[0]{rbuf}, $format, $len;
1728	substr $_[0]{rbuf}, 0, $format + $len, "";	1848	substr $_[0]{rbuf}, 0, $format + $len, "";
		1849
1729	$cb->($_[0], Storable::thaw ($data));	1850	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1851	or return $_[0]->_error (Errno::EBADMSG);
1730	} else {	1852	} else {
1731	# remove prefix	1853	# remove prefix
1732	substr $_[0]{rbuf}, 0, $format, "";	1854	substr $_[0]{rbuf}, 0, $format, "";
1733		1855
1734	# read remaining chunk	1856	# read remaining chunk
1735	$_[0]->unshift_read (chunk => $len, sub {	1857	$_[0]->unshift_read (chunk => $len, sub {
1736	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1858	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1737	$cb->($_[0], $ref);
1738	} else {
1739	$_[0]->_error (Errno::EBADMSG);	1859	or $_[0]->_error (Errno::EBADMSG);
1740	}
1741	});	1860	});
1742	}	1861	}
1743		1862
1744	1	1863	1
1745	}	1864	}
		1865	};
		1866
		1867	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1868
		1869	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1870	record without consuming anything. Only SSL version 3 or higher
		1871	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1872	SSL2-compatible framing is supported).
		1873
		1874	If it detects that the input data is likely TLS, it calls the callback
		1875	with a true value for C<$detect> and the (on-wire) TLS version as second
		1876	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1877	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1878	be definitely not TLS, it calls the callback with a false value for
		1879	C<$detect>.
		1880
		1881	The callback could use this information to decide whether or not to start
		1882	TLS negotiation.
		1883
		1884	In all cases the data read so far is passed to the following read
		1885	handlers.
		1886
		1887	Usually you want to use the C<tls_autostart> read type instead.
		1888
		1889	If you want to design a protocol that works in the presence of TLS
		1890	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1891	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1892	read type does are a bit more strict, but might losen in the future to
		1893	accomodate protocol changes.
		1894
		1895	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1896	L<Net::SSLeay>).
		1897
		1898	=item tls_autostart => $tls[, $tls_ctx]
		1899
		1900	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1901	to start tls by calling C<starttls> with the given arguments.
		1902
		1903	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1904	been configured to accept, as servers do not normally send a handshake on
		1905	their own and ths cannot be detected in this way.
		1906
		1907	See C<tls_detect> above for more details.
		1908
		1909	Example: give the client a chance to start TLS before accepting a text
		1910	line.
		1911
		1912	$hdl->push_read (tls_detect => "accept");
		1913	$hdl->push_read (line => sub {
		1914	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1915	});
		1916
		1917	=cut
		1918
		1919	register_read_type tls_detect => sub {
		1920	my ($self, $cb) = @_;
		1921
		1922	sub {
		1923	# this regex matches a full or partial tls record
		1924	if (
		1925	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1926	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1927	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1928	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1929	) {
		1930	return if 3 != length $1; # partial match, can't decide yet
		1931
		1932	# full match, valid TLS record
		1933	my ($major, $minor) = unpack "CC", $1;
		1934	$cb->($self, "accept", $major + $minor * 0.1);
		1935	} else {
		1936	# mismatch == guaranteed not TLS
		1937	$cb->($self, undef);
		1938	}
		1939
		1940	1
		1941	}
		1942	};
		1943
		1944	register_read_type tls_autostart => sub {
		1945	my ($self, @tls) = @_;
		1946
		1947	$RH{tls_detect}($self, sub {
		1948	return unless $_[1];
		1949	$_[0]->starttls (@tls);
		1950	})
1746	};	1951	};
1747		1952
1748	=back	1953	=back
1749		1954
1750	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1955	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1834	} elsif (defined $len) {	2039	} elsif (defined $len) {
1835	delete $self->{_rw};	2040	delete $self->{_rw};
1836	$self->{_eof} = 1;	2041	$self->{_eof} = 1;
1837	$self->_drain_rbuf;	2042	$self->_drain_rbuf;
1838		2043
1839	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2044	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
1840	return $self->_error ($!, 1);	2045	return $self->_error ($!, 1);
1841	}	2046	}
1842	};	2047	};
1843	}	2048	}
1844	}	2049	}
…		…
1850	my ($self, $err) = @_;	2055	my ($self, $err) = @_;
1851		2056
1852	return $self->_error ($!, 1)	2057	return $self->_error ($!, 1)
1853	if $err == Net::SSLeay::ERROR_SYSCALL ();	2058	if $err == Net::SSLeay::ERROR_SYSCALL ();
1854		2059
1855	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2060	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1856		2061
1857	# reduce error string to look less scary	2062	# reduce error string to look less scary
1858	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2063	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1859		2064
1860	if ($self->{_on_starttls}) {	2065	if ($self->{_on_starttls}) {
…		…
1874	sub _dotls {	2079	sub _dotls {
1875	my ($self) = @_;	2080	my ($self) = @_;
1876		2081
1877	my $tmp;	2082	my $tmp;
1878		2083
1879	if (length $self->{_tls_wbuf}) {	2084	while (length $self->{_tls_wbuf}) {
1880	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2085	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1881	substr $self->{_tls_wbuf}, 0, $tmp, "";	2086	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2087
		2088	return $self->_tls_error ($tmp)
		2089	if $tmp != $ERROR_WANT_READ
		2090	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		2091
		2092	last;
1882	}	2093	}
1883		2094
1884	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2095	substr $self->{_tls_wbuf}, 0, $tmp, "";
1885	return $self->_tls_error ($tmp)
1886	if $tmp != $ERROR_WANT_READ
1887	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1888	}	2096	}
1889		2097
1890	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2098	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1891	unless (length $tmp) {	2099	unless (length $tmp) {
1892	$self->{_on_starttls}	2100	$self->{_on_starttls}
…		…
1906	$self->{_tls_rbuf} .= $tmp;	2114	$self->{_tls_rbuf} .= $tmp;
1907	$self->_drain_rbuf;	2115	$self->_drain_rbuf;
1908	$self->{tls} or return; # tls session might have gone away in callback	2116	$self->{tls} or return; # tls session might have gone away in callback
1909	}	2117	}
1910		2118
1911	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	2119	$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)	2120	return $self->_tls_error ($tmp)
1913	if $tmp != $ERROR_WANT_READ	2121	if $tmp != $ERROR_WANT_READ
1914	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2122	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1915		2123
1916	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2124	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1926		2134
1927	=item $handle->starttls ($tls[, $tls_ctx])	2135	=item $handle->starttls ($tls[, $tls_ctx])
1928		2136
1929	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2137	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	2138	object is created, you can also do that at a later time by calling
1931	C<starttls>.	2139	C<starttls>. See the C<tls> constructor argument for general info.
1932		2140
1933	Starting TLS is currently an asynchronous operation - when you push some	2141	Starting TLS is currently an asynchronous operation - when you push some
1934	write data and then call C<< ->starttls >> then TLS negotiation will start	2142	write data and then call C<< ->starttls >> then TLS negotiation will start
1935	immediately, after which the queued write data is then sent.	2143	immediately, after which the queued write data is then sent. This might
		2144	change in future versions, so best make sure you have no outstanding write
		2145	data when calling this method.
1936		2146
1937	The first argument is the same as the C<tls> constructor argument (either	2147	The first argument is the same as the C<tls> constructor argument (either
1938	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2148	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1939		2149
1940	The second argument is the optional C<AnyEvent::TLS> object that is used	2150	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1962	my ($self, $tls, $ctx) = @_;	2172	my ($self, $tls, $ctx) = @_;
1963		2173
1964	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2174	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1965	if $self->{tls};	2175	if $self->{tls};
1966		2176
		2177	unless (defined $AnyEvent::TLS::VERSION) {
		2178	eval {
		2179	require Net::SSLeay;
		2180	require AnyEvent::TLS;
		2181	1
		2182	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2183	}
		2184
1967	$self->{tls} = $tls;	2185	$self->{tls} = $tls;
1968	$self->{tls_ctx} = $ctx if @_ > 2;	2186	$self->{tls_ctx} = $ctx if @_ > 2;
1969		2187
1970	return unless $self->{fh};	2188	return unless $self->{fh};
1971		2189
1972	require Net::SSLeay;
1973
1974	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2190	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1975	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2191	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1976		2192
1977	$tls = delete $self->{tls};	2193	$tls = delete $self->{tls};
1978	$ctx = $self->{tls_ctx};	2194	$ctx = $self->{tls_ctx};
1979		2195
1980	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2196	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1981		2197
1982	if ("HASH" eq ref $ctx) {	2198	if ("HASH" eq ref $ctx) {
1983	require AnyEvent::TLS;
1984
1985	if ($ctx->{cache}) {	2199	if ($ctx->{cache}) {
1986	my $key = $ctx+0;	2200	my $key = $ctx+0;
1987	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2201	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1988	} else {	2202	} else {
1989	$ctx = new AnyEvent::TLS %$ctx;	2203	$ctx = new AnyEvent::TLS %$ctx;
…		…
2091	push @linger, AE::io $fh, 1, sub {	2305	push @linger, AE::io $fh, 1, sub {
2092	my $len = syswrite $fh, $wbuf, length $wbuf;	2306	my $len = syswrite $fh, $wbuf, length $wbuf;
2093		2307
2094	if ($len > 0) {	2308	if ($len > 0) {
2095	substr $wbuf, 0, $len, "";	2309	substr $wbuf, 0, $len, "";
2096	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {	2310	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) {
2097	@linger = (); # end	2311	@linger = (); # end
2098	}	2312	}
2099	};	2313	};
2100	push @linger, AE::timer $linger, 0, sub {	2314	push @linger, AE::timer $linger, 0, sub {
2101	@linger = ();	2315	@linger = ();
…		…
2222	handles requests until the server gets some QUIT command, causing it to	2436	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	2437	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	2438	client dropping the connection is an error, which means this variant can
2225	detect an unexpected detection close.	2439	detect an unexpected detection close.
2226		2440
2227	To handle this case, always make sure you have a on-empty read queue, by	2441	To handle this case, always make sure you have a non-empty read queue, by
2228	pushing the "read request start" handler on it:	2442	pushing the "read request start" handler on it:
2229		2443
2230	# we assume a request starts with a single line	2444	# we assume a request starts with a single line
2231	my @start_request; @start_request = (line => sub {	2445	my @start_request; @start_request = (line => sub {
2232	my ($hdl, $line) = @_;	2446	my ($hdl, $line) = @_;
…		…
2330	C<low_water_mark> this will be called precisely when all data has been	2544	C<low_water_mark> this will be called precisely when all data has been
2331	written to the socket:	2545	written to the socket:
2332		2546
2333	$handle->push_write (...);	2547	$handle->push_write (...);
2334	$handle->on_drain (sub {	2548	$handle->on_drain (sub {
2335	AE::log debug => "all data submitted to the kernel\n";	2549	AE::log debug => "All data submitted to the kernel.";
2336	undef $handle;	2550	undef $handle;
2337	});	2551	});
2338		2552
2339	If you just want to queue some data and then signal EOF to the other side,	2553	If you just want to queue some data and then signal EOF to the other side,
2340	consider using C<< ->push_shutdown >> instead.	2554	consider using C<< ->push_shutdown >> instead.
…		…
2424	When you have intermediate CA certificates that your clients might not	2638	When you have intermediate CA certificates that your clients might not
2425	know about, just append them to the C<cert_file>.	2639	know about, just append them to the C<cert_file>.
2426		2640
2427	=back	2641	=back
2428		2642
2429
2430	=head1 SUBCLASSING AnyEvent::Handle	2643	=head1 SUBCLASSING AnyEvent::Handle
2431		2644
2432	In many cases, you might want to subclass AnyEvent::Handle.	2645	In many cases, you might want to subclass AnyEvent::Handle.
2433		2646
2434	To make this easier, a given version of AnyEvent::Handle uses these	2647	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2460		2673
2461	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2674	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2462		2675
2463	=cut	2676	=cut
2464		2677
2465	1; # End of AnyEvent::Handle	2678	1
		2679

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.226 by root, Mon Dec 12 12:56:04 2011 UTC vs. Revision 1.244 by root, Wed Apr 1 19:59:01 2015 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.226 by root, Mon Dec 12 12:56:04 2011 UTC vs.
Revision 1.244 by root, Wed Apr 1 19:59:01 2015 UTC