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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.217 by root, Thu Feb 3 00:29:33 2011 UTC vs.
Revision 1.238 by root, Tue Dec 10 15:54:51 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
…		…
247	many seconds pass without a successful read or write on the underlying	259	many seconds pass without a successful read or write on the underlying
248	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback	260	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
249	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>	261	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
250	error will be raised).	262	error will be raised).
251		263
252	There are three variants of the timeouts that work independently	264	There are three variants of the timeouts that work independently of each
253	of each other, for both read and write, just read, and just write:	265	other, for both read and write (triggered when nothing was read I<OR>
		266	written), just read (triggered when nothing was read), and just write:
254	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks	267	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
255	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions	268	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
256	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.	269	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
257		270
258	Note that timeout processing is active even when you do not have	271	Note that timeout processing is active even when you do not have any
259	any outstanding read or write requests: If you plan to keep the connection	272	outstanding read or write requests: If you plan to keep the connection
260	idle then you should disable the timeout temporarily or ignore the timeout	273	idle then you should disable the timeout temporarily or ignore the
261	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	274	timeout in the corresponding C<on_timeout> callback, in which case
262	restart the timeout.	275	AnyEvent::Handle will simply restart the timeout.
263		276
264	Zero (the default) disables this timeout.	277	Zero (the default) disables the corresponding timeout.
265		278
266	=item on_timeout => $cb->($handle)	279	=item on_timeout => $cb->($handle)
		280
		281	=item on_rtimeout => $cb->($handle)
		282
		283	=item on_wtimeout => $cb->($handle)
267		284
268	Called whenever the inactivity timeout passes. If you return from this	285	Called whenever the inactivity timeout passes. If you return from this
269	callback, then the timeout will be reset as if some activity had happened,	286	callback, then the timeout will be reset as if some activity had happened,
270	so this condition is not fatal in any way.	287	so this condition is not fatal in any way.
271		288
…		…
354	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
355	from most attacks.	372	from most attacks.
356		373
357	=item read_size => <bytes>	374	=item read_size => <bytes>
358		375
359	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
360	read during each loop iteration. Each handle object will consume at least	377	to read during each loop iteration. Each handle object will consume
361	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
362	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>.
363		381
364	=item max_read_size => <bytes>	382	=item max_read_size => <bytes>
365		383
366	The maximum read buffer size used by the dynamic adjustment	384	The maximum read buffer size used by the dynamic adjustment
367	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
…		…
411	appropriate error message.	429	appropriate error message.
412		430
413	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
414	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
415	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
416	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.
417		436
418	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
419	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>
420	mode.	439	mode.
421		440
…		…
477	callback.	496	callback.
478		497
479	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
480	underlying handle signals EOF.	499	underlying handle signals EOF.
481		500
482	=item json => JSON or JSON::XS object	501	=item json => L<JSON> or L<JSON::XS> object
483		502
484	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.
485		504
486	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
487	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
488	texts.	507	texts.
489		508
490	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
491	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.
492		524
493	=back	525	=back
494		526
495	=cut	527	=cut
496		528
…		…
779		811
780	=item $handle->wtimeout ($seconds)	812	=item $handle->wtimeout ($seconds)
781		813
782	Configures (or disables) the inactivity timeout.	814	Configures (or disables) the inactivity timeout.
783		815
		816	The timeout will be checked instantly, so this method might destroy the
		817	handle before it returns.
		818
784	=item $handle->timeout_reset	819	=item $handle->timeout_reset
785		820
786	=item $handle->rtimeout_reset	821	=item $handle->rtimeout_reset
787		822
788	=item $handle->wtimeout_reset	823	=item $handle->wtimeout_reset
…		…
871		906
872	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
873	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.
874		909
875	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
876	water mark, the C<on_drain> callback will be invoked.	911	water mark, the C<on_drain> callback will be invoked once.
877		912
878	=over 4	913	=over 4
879		914
880	=item $handle->on_drain ($cb)	915	=item $handle->on_drain ($cb)
881		916
…		…
1031		1066
1032	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
1033	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
1034	able to read them, many other languages depend on that.	1069	able to read them, many other languages depend on that.
1035		1070
1036	A simple RPC protocol that interoperates easily with others is to send	1071	A simple RPC protocol that interoperates easily with other languages is
1037	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
1038	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
1039	JSON text:	1074	after each JSON text:
1040		1075
1041	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1076	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1042	$handle->push_write ("\012");	1077	$handle->push_write ("\012");
1043		1078
1044	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
…		…
1047	$handle->push_read (json => sub { my $array = $_[1]; ... });	1082	$handle->push_read (json => sub { my $array = $_[1]; ... });
1048		1083
1049	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
1050	this line into their JSON decoder of choice.	1085	this line into their JSON decoder of choice.
1051		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
1052	=cut	1107	=cut
1053		1108
1054	sub json_coder() {	1109	sub json_coder() {
1055	eval { require JSON::XS; JSON::XS->new->utf8 }	1110	eval { require JSON::XS; JSON::XS->new->utf8 }
1056	\|\| do { require JSON; JSON->new->utf8 }	1111	\|\| do { require JSON; JSON->new->utf8 }
1057	}	1112	}
1058		1113
1059	register_write_type json => sub {	1114	register_write_type json => sub {
1060	my ($self, $ref) = @_;	1115	my ($self, $ref) = @_;
1061		1116
1062	my $json = $self->{json} \|\|= json_coder;	1117	($self->{json} \|\|= json_coder)
1063
1064	$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)
1065	};	1131	};
1066		1132
1067	=item storable => $reference	1133	=item storable => $reference
1068		1134
1069	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
…		…
1072	=cut	1138	=cut
1073		1139
1074	register_write_type storable => sub {	1140	register_write_type storable => sub {
1075	my ($self, $ref) = @_;	1141	my ($self, $ref) = @_;
1076		1142
1077	require Storable;	1143	require Storable unless $Storable::VERSION;
1078		1144
1079	pack "w/a*", Storable::nfreeze ($ref)	1145	pack "w/a*", Storable::nfreeze ($ref)
1080	};	1146	};
1081		1147
1082	=back	1148	=back
…		…
1119		1185
1120	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
1121	the handle object and the remaining arguments.	1187	the handle object and the remaining arguments.
1122		1188
1123	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
1124	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
1125	"arguments to on-the-wire-format" converter.	1191	"arguments to on-the-wire-format" converter.
1126		1192
1127	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
1128	arguments using the first one.	1194	arguments using the first one.
1129		1195
…		…
1423	data.	1489	data.
1424		1490
1425	Example: read 2 bytes.	1491	Example: read 2 bytes.
1426		1492
1427	$handle->push_read (chunk => 2, sub {	1493	$handle->push_read (chunk => 2, sub {
1428	warn "yay ", unpack "H*", $_[1];	1494	say "yay " . unpack "H*", $_[1];
1429	});	1495	});
1430		1496
1431	=cut	1497	=cut
1432		1498
1433	register_read_type chunk => sub {	1499	register_read_type chunk => sub {
…		…
1463		1529
1464	register_read_type line => sub {	1530	register_read_type line => sub {
1465	my ($self, $cb, $eol) = @_;	1531	my ($self, $cb, $eol) = @_;
1466		1532
1467	if (@_ < 3) {	1533	if (@_ < 3) {
1468	# this is more than twice as fast as the generic code below	1534	# this is faster then the generic code below
1469	sub {	1535	sub {
1470	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1536	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1537	or return;
1471		1538
		1539	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1472	$cb->($_[0], $1, $2);	1540	$cb->($_[0], $str, "$1");
1473	1	1541	1
1474	}	1542	}
1475	} else {	1543	} else {
1476	$eol = quotemeta $eol unless ref $eol;	1544	$eol = quotemeta $eol unless ref $eol;
1477	$eol = qr\|^(.*?)($eol)\|s;	1545	$eol = qr\|^(.*?)($eol)\|s;
1478		1546
1479	sub {	1547	sub {
1480	$_[0]{rbuf} =~ s/$eol// or return;	1548	$_[0]{rbuf} =~ s/$eol// or return;
1481		1549
1482	$cb->($_[0], $1, $2);	1550	$cb->($_[0], "$1", "$2");
1483	1	1551	1
1484	}	1552	}
1485	}	1553	}
1486	};	1554	};
1487		1555
…		…
1535		1603
1536	sub {	1604	sub {
1537	# accept	1605	# accept
1538	if ($$rbuf =~ $accept) {	1606	if ($$rbuf =~ $accept) {
1539	$data .= substr $$rbuf, 0, $+[0], "";	1607	$data .= substr $$rbuf, 0, $+[0], "";
1540	$cb->($self, $data);	1608	$cb->($_[0], $data);
1541	return 1;	1609	return 1;
1542	}	1610	}
1543		1611
1544	# reject	1612	# reject
1545	if ($reject && $$rbuf =~ $reject) {	1613	if ($reject && $$rbuf =~ $reject) {
1546	$self->_error (Errno::EBADMSG);	1614	$_[0]->_error (Errno::EBADMSG);
1547	}	1615	}
1548		1616
1549	# skip	1617	# skip
1550	if ($skip && $$rbuf =~ $skip) {	1618	if ($skip && $$rbuf =~ $skip) {
1551	$data .= substr $$rbuf, 0, $+[0], "";	1619	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1567	my ($self, $cb) = @_;	1635	my ($self, $cb) = @_;
1568		1636
1569	sub {	1637	sub {
1570	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1638	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1571	if ($_[0]{rbuf} =~ /[^0-9]/) {	1639	if ($_[0]{rbuf} =~ /[^0-9]/) {
1572	$self->_error (Errno::EBADMSG);	1640	$_[0]->_error (Errno::EBADMSG);
1573	}	1641	}
1574	return;	1642	return;
1575	}	1643	}
1576		1644
1577	my $len = $1;	1645	my $len = $1;
1578		1646
1579	$self->unshift_read (chunk => $len, sub {	1647	$_[0]->unshift_read (chunk => $len, sub {
1580	my $string = $_[1];	1648	my $string = $_[1];
1581	$_[0]->unshift_read (chunk => 1, sub {	1649	$_[0]->unshift_read (chunk => 1, sub {
1582	if ($_[1] eq ",") {	1650	if ($_[1] eq ",") {
1583	$cb->($_[0], $string);	1651	$cb->($_[0], $string);
1584	} else {	1652	} else {
1585	$self->_error (Errno::EBADMSG);	1653	$_[0]->_error (Errno::EBADMSG);
1586	}	1654	}
1587	});	1655	});
1588	});	1656	});
1589		1657
1590	1	1658	1
…		…
1660	my ($self, $cb) = @_;	1728	my ($self, $cb) = @_;
1661		1729
1662	my $json = $self->{json} \|\|= json_coder;	1730	my $json = $self->{json} \|\|= json_coder;
1663		1731
1664	my $data;	1732	my $data;
1665	my $rbuf = \$self->{rbuf};
1666		1733
1667	sub {	1734	sub {
1668	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1735	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1669		1736
1670	if ($ref) {	1737	if ($ref) {
1671	$self->{rbuf} = $json->incr_text;	1738	$_[0]{rbuf} = $json->incr_text;
1672	$json->incr_text = "";	1739	$json->incr_text = "";
1673	$cb->($self, $ref);	1740	$cb->($_[0], $ref);
1674		1741
1675	1	1742	1
1676	} elsif ($@) {	1743	} elsif ($@) {
1677	# error case	1744	# error case
1678	$json->incr_skip;	1745	$json->incr_skip;
1679		1746
1680	$self->{rbuf} = $json->incr_text;	1747	$_[0]{rbuf} = $json->incr_text;
1681	$json->incr_text = "";	1748	$json->incr_text = "";
1682		1749
1683	$self->_error (Errno::EBADMSG);	1750	$_[0]->_error (Errno::EBADMSG);
1684		1751
1685	()	1752	()
1686	} else {	1753	} else {
1687	$self->{rbuf} = "";	1754	$_[0]{rbuf} = "";
1688		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 {
1689	()	1802	()
1690	}	1803	}
1691	}	1804	}
1692	};	1805	};
1693		1806
…		…
1702	=cut	1815	=cut
1703		1816
1704	register_read_type storable => sub {	1817	register_read_type storable => sub {
1705	my ($self, $cb) = @_;	1818	my ($self, $cb) = @_;
1706		1819
1707	require Storable;	1820	require Storable unless $Storable::VERSION;
1708		1821
1709	sub {	1822	sub {
1710	# 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
1711	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1824	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1712	or return;	1825	or return;
…		…
1715		1828
1716	# bypass unshift if we already have the remaining chunk	1829	# bypass unshift if we already have the remaining chunk
1717	if ($format + $len <= length $_[0]{rbuf}) {	1830	if ($format + $len <= length $_[0]{rbuf}) {
1718	my $data = substr $_[0]{rbuf}, $format, $len;	1831	my $data = substr $_[0]{rbuf}, $format, $len;
1719	substr $_[0]{rbuf}, 0, $format + $len, "";	1832	substr $_[0]{rbuf}, 0, $format + $len, "";
		1833
1720	$cb->($_[0], Storable::thaw ($data));	1834	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1835	or return $_[0]->_error (Errno::EBADMSG);
1721	} else {	1836	} else {
1722	# remove prefix	1837	# remove prefix
1723	substr $_[0]{rbuf}, 0, $format, "";	1838	substr $_[0]{rbuf}, 0, $format, "";
1724		1839
1725	# read remaining chunk	1840	# read remaining chunk
1726	$_[0]->unshift_read (chunk => $len, sub {	1841	$_[0]->unshift_read (chunk => $len, sub {
1727	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1842	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1728	$cb->($_[0], $ref);
1729	} else {
1730	$self->_error (Errno::EBADMSG);	1843	or $_[0]->_error (Errno::EBADMSG);
1731	}
1732	});	1844	});
1733	}	1845	}
1734		1846
1735	1	1847	1
1736	}	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	})
1737	};	1935	};
1738		1936
1739	=back	1937	=back
1740		1938
1741	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1939	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1783	some readings of the the SSL/TLS specifications basically require this	1981	some readings of the the SSL/TLS specifications basically require this
1784	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
1785	during a rehandshake.	1983	during a rehandshake.
1786		1984
1787	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,
1788	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.
1789		1987
1790	=cut	1988	=cut
1791		1989
1792	sub stop_read {	1990	sub stop_read {
1793	my ($self) = @_;	1991	my ($self) = @_;
…		…
1841	my ($self, $err) = @_;	2039	my ($self, $err) = @_;
1842		2040
1843	return $self->_error ($!, 1)	2041	return $self->_error ($!, 1)
1844	if $err == Net::SSLeay::ERROR_SYSCALL ();	2042	if $err == Net::SSLeay::ERROR_SYSCALL ();
1845		2043
1846	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 ());
1847		2045
1848	# reduce error string to look less scary	2046	# reduce error string to look less scary
1849	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2047	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1850		2048
1851	if ($self->{_on_starttls}) {	2049	if ($self->{_on_starttls}) {
…		…
1917		2115
1918	=item $handle->starttls ($tls[, $tls_ctx])	2116	=item $handle->starttls ($tls[, $tls_ctx])
1919		2117
1920	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2118	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1921	object is created, you can also do that at a later time by calling	2119	object is created, you can also do that at a later time by calling
1922	C<starttls>.	2120	C<starttls>. See the C<tls> constructor argument for general info.
1923		2121
1924	Starting TLS is currently an asynchronous operation - when you push some	2122	Starting TLS is currently an asynchronous operation - when you push some
1925	write data and then call C<< ->starttls >> then TLS negotiation will start	2123	write data and then call C<< ->starttls >> then TLS negotiation will start
1926	immediately, after which the queued write data is then sent.	2124	immediately, after which the queued write data is then sent. This might
		2125	change in future versions, so best make sure you have no outstanding write
		2126	data when calling this method.
1927		2127
1928	The first argument is the same as the C<tls> constructor argument (either	2128	The first argument is the same as the C<tls> constructor argument (either
1929	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2129	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1930		2130
1931	The second argument is the optional C<AnyEvent::TLS> object that is used	2131	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1953	my ($self, $tls, $ctx) = @_;	2153	my ($self, $tls, $ctx) = @_;
1954		2154
1955	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2155	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1956	if $self->{tls};	2156	if $self->{tls};
1957		2157
		2158	unless (defined $AnyEvent::TLS::VERSION) {
		2159	eval {
		2160	require Net::SSLeay;
		2161	require AnyEvent::TLS;
		2162	1
		2163	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2164	}
		2165
1958	$self->{tls} = $tls;	2166	$self->{tls} = $tls;
1959	$self->{tls_ctx} = $ctx if @_ > 2;	2167	$self->{tls_ctx} = $ctx if @_ > 2;
1960		2168
1961	return unless $self->{fh};	2169	return unless $self->{fh};
1962		2170
1963	require Net::SSLeay;
1964
1965	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2171	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1966	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2172	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1967		2173
1968	$tls = delete $self->{tls};	2174	$tls = delete $self->{tls};
1969	$ctx = $self->{tls_ctx};	2175	$ctx = $self->{tls_ctx};
1970		2176
1971	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2177	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1972		2178
1973	if ("HASH" eq ref $ctx) {	2179	if ("HASH" eq ref $ctx) {
1974	require AnyEvent::TLS;
1975
1976	if ($ctx->{cache}) {	2180	if ($ctx->{cache}) {
1977	my $key = $ctx+0;	2181	my $key = $ctx+0;
1978	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2182	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1979	} else {	2183	} else {
1980	$ctx = new AnyEvent::TLS %$ctx;	2184	$ctx = new AnyEvent::TLS %$ctx;
…		…
2002	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2206	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
2003		2207
2004	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2208	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
2005	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2209	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
2006		2210
2007	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2211	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2212	$self->{rbuf} = "";
2008		2213
2009	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2214	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
2010		2215
2011	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2216	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
2012	if $self->{on_starttls};	2217	if $self->{on_starttls};
…		…
2194	Probably because your C<on_error> callback is being called instead: When	2399	Probably because your C<on_error> callback is being called instead: When
2195	you have outstanding requests in your read queue, then an EOF is	2400	you have outstanding requests in your read queue, then an EOF is
2196	considered an error as you clearly expected some data.	2401	considered an error as you clearly expected some data.
2197		2402
2198	To avoid this, make sure you have an empty read queue whenever your handle	2403	To avoid this, make sure you have an empty read queue whenever your handle
2199	is supposed to be "idle" (i.e. connection closes are O.K.). You cna set	2404	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
2200	an C<on_read> handler that simply pushes the first read requests in the	2405	an C<on_read> handler that simply pushes the first read requests in the
2201	queue.	2406	queue.
2202		2407
2203	See also the next question, which explains this in a bit more detail.	2408	See also the next question, which explains this in a bit more detail.
2204		2409
…		…
2212	handles requests until the server gets some QUIT command, causing it to	2417	handles requests until the server gets some QUIT command, causing it to
2213	close the connection first (highly desirable for a busy TCP server). A	2418	close the connection first (highly desirable for a busy TCP server). A
2214	client dropping the connection is an error, which means this variant can	2419	client dropping the connection is an error, which means this variant can
2215	detect an unexpected detection close.	2420	detect an unexpected detection close.
2216		2421
2217	To handle this case, always make sure you have a on-empty read queue, by	2422	To handle this case, always make sure you have a non-empty read queue, by
2218	pushing the "read request start" handler on it:	2423	pushing the "read request start" handler on it:
2219		2424
2220	# we assume a request starts with a single line	2425	# we assume a request starts with a single line
2221	my @start_request; @start_request = (line => sub {	2426	my @start_request; @start_request = (line => sub {
2222	my ($hdl, $line) = @_;	2427	my ($hdl, $line) = @_;
…		…
2235	some data and raises the C<EPIPE> error when the connction is dropped	2440	some data and raises the C<EPIPE> error when the connction is dropped
2236	unexpectedly.	2441	unexpectedly.
2237		2442
2238	The second variant is a protocol where the client can drop the connection	2443	The second variant is a protocol where the client can drop the connection
2239	at any time. For TCP, this means that the server machine may run out of	2444	at any time. For TCP, this means that the server machine may run out of
2240	sockets easier, and in general, it means you cnanot distinguish a protocl	2445	sockets easier, and in general, it means you cannot distinguish a protocl
2241	failure/client crash from a normal connection close. Nevertheless, these	2446	failure/client crash from a normal connection close. Nevertheless, these
2242	kinds of protocols are common (and sometimes even the best solution to the	2447	kinds of protocols are common (and sometimes even the best solution to the
2243	problem).	2448	problem).
2244		2449
2245	Having an outstanding read request at all times is possible if you ignore	2450	Having an outstanding read request at all times is possible if you ignore
…		…
2297	$handle->on_eof (undef);	2502	$handle->on_eof (undef);
2298	$handle->on_error (sub {	2503	$handle->on_error (sub {
2299	my $data = delete $_[0]{rbuf};	2504	my $data = delete $_[0]{rbuf};
2300	});	2505	});
2301		2506
		2507	Note that this example removes the C<rbuf> member from the handle object,
		2508	which is not normally allowed by the API. It is expressly permitted in
		2509	this case only, as the handle object needs to be destroyed afterwards.
		2510
2302	The reason to use C<on_error> is that TCP connections, due to latencies	2511	The reason to use C<on_error> is that TCP connections, due to latencies
2303	and packets loss, might get closed quite violently with an error, when in	2512	and packets loss, might get closed quite violently with an error, when in
2304	fact all data has been received.	2513	fact all data has been received.
2305		2514
2306	It is usually better to use acknowledgements when transferring data,	2515	It is usually better to use acknowledgements when transferring data,
…		…
2316	C<low_water_mark> this will be called precisely when all data has been	2525	C<low_water_mark> this will be called precisely when all data has been
2317	written to the socket:	2526	written to the socket:
2318		2527
2319	$handle->push_write (...);	2528	$handle->push_write (...);
2320	$handle->on_drain (sub {	2529	$handle->on_drain (sub {
2321	warn "all data submitted to the kernel\n";	2530	AE::log debug => "All data submitted to the kernel.";
2322	undef $handle;	2531	undef $handle;
2323	});	2532	});
2324		2533
2325	If you just want to queue some data and then signal EOF to the other side,	2534	If you just want to queue some data and then signal EOF to the other side,
2326	consider using C<< ->push_shutdown >> instead.	2535	consider using C<< ->push_shutdown >> instead.
…		…
2410	When you have intermediate CA certificates that your clients might not	2619	When you have intermediate CA certificates that your clients might not
2411	know about, just append them to the C<cert_file>.	2620	know about, just append them to the C<cert_file>.
2412		2621
2413	=back	2622	=back
2414		2623
2415
2416	=head1 SUBCLASSING AnyEvent::Handle	2624	=head1 SUBCLASSING AnyEvent::Handle
2417		2625
2418	In many cases, you might want to subclass AnyEvent::Handle.	2626	In many cases, you might want to subclass AnyEvent::Handle.
2419		2627
2420	To make this easier, a given version of AnyEvent::Handle uses these	2628	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2446		2654
2447	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2655	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2448		2656
2449	=cut	2657	=cut
2450		2658
2451	1; # End of AnyEvent::Handle	2659	1
		2660

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.217 by root, Thu Feb 3 00:29:33 2011 UTC vs. Revision 1.238 by root, Tue Dec 10 15:54:51 2013 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.217 by root, Thu Feb 3 00:29:33 2011 UTC vs.
Revision 1.238 by root, Tue Dec 10 15:54:51 2013 UTC