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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.214 by root, Sun Jan 16 17:12:27 2011 UTC vs.
Revision 1.242 by root, Wed Dec 10 04:29:33 2014 UTC

…		…
11		11
12	my $hdl; $hdl = new AnyEvent::Handle	12	my $hdl; $hdl = new AnyEvent::Handle
13	fh => \*STDIN,	13	fh => \*STDIN,
14	on_error => sub {	14	on_error => sub {
15	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
16	warn "got error $msg\n";	16	AE::log error => $msg;
17	$hdl->destroy;	17	$hdl->destroy;
18	$cv->send;	18	$cv->send;
19	};	19	};
20		20
21	# send some request line	21	# send some request line
22	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
23		23
24	# read the response line	24	# read the response line
25	$hdl->push_read (line => sub {	25	$hdl->push_read (line => sub {
26	my ($hdl, $line) = @_;	26	my ($hdl, $line) = @_;
27	warn "got line <$line>\n";	27	say "got line <$line>";
28	$cv->send;	28	$cv->send;
29	});	29	});
30		30
31	$cv->recv;	31	$cv->recv;
32		32
…		…
128	=item on_connect => $cb->($handle, $host, $port, $retry->())	128	=item on_connect => $cb->($handle, $host, $port, $retry->())
129		129
130	This callback is called when a connection has been successfully established.	130	This callback is called when a connection has been successfully established.
131		131
132	The peer's numeric host and port (the socket peername) are passed as	132	The peer's numeric host and port (the socket peername) are passed as
133	parameters, together with a retry callback.	133	parameters, together with a retry callback. At the time it is called the
		134	read and write queues, EOF status, TLS status and similar properties of
		135	the handle will have been reset.
134		136
135	If, for some reason, the handle is not acceptable, calling C<$retry>	137	If, for some reason, the handle is not acceptable, calling C<$retry> will
136	will continue with the next connection target (in case of multi-homed	138	continue with the next connection target (in case of multi-homed hosts or
137	hosts or SRV records there can be multiple connection endpoints). At the	139	SRV records there can be multiple connection endpoints). The C<$retry>
138	time it is called the read and write queues, eof status, tls status and	140	callback can be invoked after the connect callback returns, i.e. one can
139	similar properties of the handle will have been reset.	141	start a handshake and then decide to retry with the next host if the
		142	handshake fails.
140		143
141	In most cases, you should ignore the C<$retry> parameter.	144	In most cases, you should ignore the C<$retry> parameter.
142		145
143	=item on_connect_error => $cb->($handle, $message)	146	=item on_connect_error => $cb->($handle, $message)
144		147
…		…
164	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In	167	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
165	cases where the other side can close the connection at will, it is	168	cases where the other side can close the connection at will, it is
166	often easiest to not report C<EPIPE> errors in this callback.	169	often easiest to not report C<EPIPE> errors in this callback.
167		170
168	AnyEvent::Handle tries to find an appropriate error code for you to check	171	AnyEvent::Handle tries to find an appropriate error code for you to check
169	against, but in some cases (TLS errors), this does not work well. It is	172	against, but in some cases (TLS errors), this does not work well.
170	recommended to always output the C<$message> argument in human-readable	173
171	error messages (it's usually the same as C<"$!">).	174	If you report the error to the user, it is recommended to always output
		175	the C<$message> argument in human-readable error messages (you don't need
		176	to report C<"$!"> if you report C<$message>).
		177
		178	If you want to react programmatically to the error, then looking at C<$!>
		179	and comparing it against some of the documented C<Errno> values is usually
		180	better than looking at the C<$message>.
172		181
173	Non-fatal errors can be retried by returning, but it is recommended	182	Non-fatal errors can be retried by returning, but it is recommended
174	to simply ignore this parameter and instead abondon the handle object	183	to simply ignore this parameter and instead abondon the handle object
175	when this callback is invoked. Examples of non-fatal errors are timeouts	184	when this callback is invoked. Examples of non-fatal errors are timeouts
176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	185	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
…		…
224	If an EOF condition has been detected but no C<on_eof> callback has been	233	If an EOF condition has been detected but no C<on_eof> callback has been
225	set, then a fatal error will be raised with C<$!> set to <0>.	234	set, then a fatal error will be raised with C<$!> set to <0>.
226		235
227	=item on_drain => $cb->($handle)	236	=item on_drain => $cb->($handle)
228		237
229	This sets the callback that is called when the write buffer becomes empty	238	This sets the callback that is called once when the write buffer becomes
230	(or immediately if the buffer is empty already).	239	empty (and immediately when the handle object is created).
231		240
232	To append to the write buffer, use the C<< ->push_write >> method.	241	To append to the write buffer, use the C<< ->push_write >> method.
233		242
234	This callback is useful when you don't want to put all of your write data	243	This callback is useful when you don't want to put all of your write data
235	into the queue at once, for example, when you want to write the contents	244	into the queue at once, for example, when you want to write the contents
…		…
247	many seconds pass without a successful read or write on the underlying	256	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	257	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>	258	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
250	error will be raised).	259	error will be raised).
251		260
252	There are three variants of the timeouts that work independently	261	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:	262	other, for both read and write (triggered when nothing was read I<OR>
		263	written), just read (triggered when nothing was read), and just write:
254	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks	264	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
255	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions	265	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
256	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.	266	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
257		267
258	Note that timeout processing is active even when you do not have	268	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	269	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	270	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	271	timeout in the corresponding C<on_timeout> callback, in which case
262	restart the timeout.	272	AnyEvent::Handle will simply restart the timeout.
263		273
264	Zero (the default) disables this timeout.	274	Zero (the default) disables the corresponding timeout.
265		275
266	=item on_timeout => $cb->($handle)	276	=item on_timeout => $cb->($handle)
		277
		278	=item on_rtimeout => $cb->($handle)
		279
		280	=item on_wtimeout => $cb->($handle)
267		281
268	Called whenever the inactivity timeout passes. If you return from this	282	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,	283	callback, then the timeout will be reset as if some activity had happened,
270	so this condition is not fatal in any way.	284	so this condition is not fatal in any way.
271		285
…		…
354	already have occured on BSD systems), but at least it will protect you	368	already have occured on BSD systems), but at least it will protect you
355	from most attacks.	369	from most attacks.
356		370
357	=item read_size => <bytes>	371	=item read_size => <bytes>
358		372
359	The initial read block size, the number of bytes this module will try to	373	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	374	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	375	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>.	376	handling many connections watch out for memory requirements). See also
		377	C<max_read_size>. Default: C<2048>.
363		378
364	=item max_read_size => <bytes>	379	=item max_read_size => <bytes>
365		380
366	The maximum read buffer size used by the dynamic adjustment	381	The maximum read buffer size used by the dynamic adjustment
367	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in	382	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
…		…
411	appropriate error message.	426	appropriate error message.
412		427
413	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
414	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
415	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
416	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.
417		433
418	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
419	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>
420	mode.	436	mode.
421		437
…		…
477	callback.	493	callback.
478		494
479	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
480	underlying handle signals EOF.	496	underlying handle signals EOF.
481		497
482	=item json => JSON or JSON::XS object	498	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
483		499
484	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.
485		501
486	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
487	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
488	texts.	514	text.
489		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
490	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
491	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.
492		535
493	=back	536	=back
494		537
495	=cut	538	=cut
496		539
…		…
536	});	579	});
537		580
538	} else {	581	} else {
539	if ($self->{on_connect_error}) {	582	if ($self->{on_connect_error}) {
540	$self->{on_connect_error}($self, "$!");	583	$self->{on_connect_error}($self, "$!");
541	$self->destroy;	584	$self->destroy if $self;
542	} else {	585	} else {
543	$self->_error ($!, 1);	586	$self->_error ($!, 1);
544	}	587	}
545	}	588	}
546	},	589	},
…		…
765		808
766	sub rbuf_max {	809	sub rbuf_max {
767	$_[0]{rbuf_max} = $_[1];	810	$_[0]{rbuf_max} = $_[1];
768	}	811	}
769		812
770	sub rbuf_max {	813	sub wbuf_max {
771	$_[0]{wbuf_max} = $_[1];	814	$_[0]{wbuf_max} = $_[1];
772	}	815	}
773		816
774	#############################################################################	817	#############################################################################
775		818
…		…
778	=item $handle->rtimeout ($seconds)	821	=item $handle->rtimeout ($seconds)
779		822
780	=item $handle->wtimeout ($seconds)	823	=item $handle->wtimeout ($seconds)
781		824
782	Configures (or disables) the inactivity timeout.	825	Configures (or disables) the inactivity timeout.
		826
		827	The timeout will be checked instantly, so this method might destroy the
		828	handle before it returns.
783		829
784	=item $handle->timeout_reset	830	=item $handle->timeout_reset
785		831
786	=item $handle->rtimeout_reset	832	=item $handle->rtimeout_reset
787		833
…		…
871		917
872	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
873	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.
874		920
875	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
876	water mark, the C<on_drain> callback will be invoked.	922	water mark, the C<on_drain> callback will be invoked once.
877		923
878	=over 4	924	=over 4
879		925
880	=item $handle->on_drain ($cb)	926	=item $handle->on_drain ($cb)
881		927
…		…
1023		1069
1024	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
1025	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
1026	in UTF-8.	1072	in UTF-8.
1027		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
1028	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
1029	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
1030	additional framing.	1080	other end without using any additional framing.
1031		1081
1032	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
1033	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
1034	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.
1035		1086
1036	A simple RPC protocol that interoperates easily with others is to send	1087	A simple RPC protocol that interoperates easily with other languages is
1037	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
1038	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
1039	JSON text:	1090	after each JSON text:
1040		1091
1041	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1092	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1042	$handle->push_write ("\012");	1093	$handle->push_write ("\012");
1043		1094
1044	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
…		…
1047	$handle->push_read (json => sub { my $array = $_[1]; ... });	1098	$handle->push_read (json => sub { my $array = $_[1]; ... });
1048		1099
1049	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
1050	this line into their JSON decoder of choice.	1101	this line into their JSON decoder of choice.
1051		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
1052	=cut	1123	=cut
1053		1124
1054	sub json_coder() {	1125	sub json_coder() {
1055	eval { require JSON::XS; JSON::XS->new->utf8 }	1126	eval { require JSON::XS; JSON::XS->new->utf8 }
1056	\|\| do { require JSON; JSON->new->utf8 }	1127	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1057	}	1128	}
1058		1129
1059	register_write_type json => sub {	1130	register_write_type json => sub {
1060	my ($self, $ref) = @_;	1131	my ($self, $ref) = @_;
1061		1132
1062	my $json = $self->{json} \|\|= json_coder;	1133	($self->{json} \|\|= json_coder)
1063
1064	$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)
1065	};	1147	};
1066		1148
1067	=item storable => $reference	1149	=item storable => $reference
1068		1150
1069	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
…		…
1072	=cut	1154	=cut
1073		1155
1074	register_write_type storable => sub {	1156	register_write_type storable => sub {
1075	my ($self, $ref) = @_;	1157	my ($self, $ref) = @_;
1076		1158
1077	require Storable;	1159	require Storable unless $Storable::VERSION;
1078		1160
1079	pack "w/a*", Storable::nfreeze ($ref)	1161	pack "w/a*", Storable::nfreeze ($ref)
1080	};	1162	};
1081		1163
1082	=back	1164	=back
…		…
1119		1201
1120	Whenever the given C<type> is used, C<push_write> will the function with	1202	Whenever the given C<type> is used, C<push_write> will the function with
1121	the handle object and the remaining arguments.	1203	the handle object and the remaining arguments.
1122		1204
1123	The function is supposed to return a single octet string that will be	1205	The function is supposed to return a single octet string that will be
1124	appended to the write buffer, so you cna mentally treat this function as a	1206	appended to the write buffer, so you can mentally treat this function as a
1125	"arguments to on-the-wire-format" converter.	1207	"arguments to on-the-wire-format" converter.
1126		1208
1127	Example: implement a custom write type C<join> that joins the remaining	1209	Example: implement a custom write type C<join> that joins the remaining
1128	arguments using the first one.	1210	arguments using the first one.
1129		1211
…		…
1423	data.	1505	data.
1424		1506
1425	Example: read 2 bytes.	1507	Example: read 2 bytes.
1426		1508
1427	$handle->push_read (chunk => 2, sub {	1509	$handle->push_read (chunk => 2, sub {
1428	warn "yay ", unpack "H*", $_[1];	1510	say "yay " . unpack "H*", $_[1];
1429	});	1511	});
1430		1512
1431	=cut	1513	=cut
1432		1514
1433	register_read_type chunk => sub {	1515	register_read_type chunk => sub {
…		…
1463		1545
1464	register_read_type line => sub {	1546	register_read_type line => sub {
1465	my ($self, $cb, $eol) = @_;	1547	my ($self, $cb, $eol) = @_;
1466		1548
1467	if (@_ < 3) {	1549	if (@_ < 3) {
1468	# this is more than twice as fast as the generic code below	1550	# this is faster then the generic code below
1469	sub {	1551	sub {
1470	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1552	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1553	or return;
1471		1554
		1555	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1472	$cb->($_[0], $1, $2);	1556	$cb->($_[0], $str, "$1");
1473	1	1557	1
1474	}	1558	}
1475	} else {	1559	} else {
1476	$eol = quotemeta $eol unless ref $eol;	1560	$eol = quotemeta $eol unless ref $eol;
1477	$eol = qr\|^(.*?)($eol)\|s;	1561	$eol = qr\|^(.*?)($eol)\|s;
1478		1562
1479	sub {	1563	sub {
1480	$_[0]{rbuf} =~ s/$eol// or return;	1564	$_[0]{rbuf} =~ s/$eol// or return;
1481		1565
1482	$cb->($_[0], $1, $2);	1566	$cb->($_[0], "$1", "$2");
1483	1	1567	1
1484	}	1568	}
1485	}	1569	}
1486	};	1570	};
1487		1571
…		…
1535		1619
1536	sub {	1620	sub {
1537	# accept	1621	# accept
1538	if ($$rbuf =~ $accept) {	1622	if ($$rbuf =~ $accept) {
1539	$data .= substr $$rbuf, 0, $+[0], "";	1623	$data .= substr $$rbuf, 0, $+[0], "";
1540	$cb->($self, $data);	1624	$cb->($_[0], $data);
1541	return 1;	1625	return 1;
1542	}	1626	}
1543		1627
1544	# reject	1628	# reject
1545	if ($reject && $$rbuf =~ $reject) {	1629	if ($reject && $$rbuf =~ $reject) {
1546	$self->_error (Errno::EBADMSG);	1630	$_[0]->_error (Errno::EBADMSG);
1547	}	1631	}
1548		1632
1549	# skip	1633	# skip
1550	if ($skip && $$rbuf =~ $skip) {	1634	if ($skip && $$rbuf =~ $skip) {
1551	$data .= substr $$rbuf, 0, $+[0], "";	1635	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1567	my ($self, $cb) = @_;	1651	my ($self, $cb) = @_;
1568		1652
1569	sub {	1653	sub {
1570	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1654	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1571	if ($_[0]{rbuf} =~ /[^0-9]/) {	1655	if ($_[0]{rbuf} =~ /[^0-9]/) {
1572	$self->_error (Errno::EBADMSG);	1656	$_[0]->_error (Errno::EBADMSG);
1573	}	1657	}
1574	return;	1658	return;
1575	}	1659	}
1576		1660
1577	my $len = $1;	1661	my $len = $1;
1578		1662
1579	$self->unshift_read (chunk => $len, sub {	1663	$_[0]->unshift_read (chunk => $len, sub {
1580	my $string = $_[1];	1664	my $string = $_[1];
1581	$_[0]->unshift_read (chunk => 1, sub {	1665	$_[0]->unshift_read (chunk => 1, sub {
1582	if ($_[1] eq ",") {	1666	if ($_[1] eq ",") {
1583	$cb->($_[0], $string);	1667	$cb->($_[0], $string);
1584	} else {	1668	} else {
1585	$self->_error (Errno::EBADMSG);	1669	$_[0]->_error (Errno::EBADMSG);
1586	}	1670	}
1587	});	1671	});
1588	});	1672	});
1589		1673
1590	1	1674	1
…		…
1640	=item json => $cb->($handle, $hash_or_arrayref)	1724	=item json => $cb->($handle, $hash_or_arrayref)
1641		1725
1642	Reads a JSON object or array, decodes it and passes it to the	1726	Reads a JSON object or array, decodes it and passes it to the
1643	callback. When a parse error occurs, an C<EBADMSG> error will be raised.	1727	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1644		1728
1645	If a C<json> object was passed to the constructor, then that will be used	1729	If a C<json> object was passed to the constructor, then that will be
1646	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1730	used for the final decode, otherwise it will create a L<JSON::XS> or
		1731	L<JSON::PP> coder object expecting UTF-8.
1647		1732
1648	This read type uses the incremental parser available with JSON version	1733	This read type uses the incremental parser available with JSON version
1649	2.09 (and JSON::XS version 2.2) and above. You have to provide a	1734	2.09 (and JSON::XS version 2.2) and above.
1650	dependency on your own: this module will load the JSON module, but
1651	AnyEvent does not depend on it itself.
1652		1735
1653	Since JSON texts are fully self-delimiting, the C<json> read and write	1736	Since JSON texts are fully self-delimiting, the C<json> read and write
1654	types are an ideal simple RPC protocol: just exchange JSON datagrams. See	1737	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1655	the C<json> write type description, above, for an actual example.	1738	the C<json> write type description, above, for an actual example.
1656		1739
…		…
1660	my ($self, $cb) = @_;	1743	my ($self, $cb) = @_;
1661		1744
1662	my $json = $self->{json} \|\|= json_coder;	1745	my $json = $self->{json} \|\|= json_coder;
1663		1746
1664	my $data;	1747	my $data;
1665	my $rbuf = \$self->{rbuf};
1666		1748
1667	sub {	1749	sub {
1668	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1750	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1669		1751
1670	if ($ref) {	1752	if ($ref) {
1671	$self->{rbuf} = $json->incr_text;	1753	$_[0]{rbuf} = $json->incr_text;
1672	$json->incr_text = "";	1754	$json->incr_text = "";
1673	$cb->($self, $ref);	1755	$cb->($_[0], $ref);
1674		1756
1675	1	1757	1
1676	} elsif ($@) {	1758	} elsif ($@) {
1677	# error case	1759	# error case
1678	$json->incr_skip;	1760	$json->incr_skip;
1679		1761
1680	$self->{rbuf} = $json->incr_text;	1762	$_[0]{rbuf} = $json->incr_text;
1681	$json->incr_text = "";	1763	$json->incr_text = "";
1682		1764
1683	$self->_error (Errno::EBADMSG);	1765	$_[0]->_error (Errno::EBADMSG);
1684		1766
1685	()	1767	()
1686	} else {	1768	} else {
1687	$self->{rbuf} = "";	1769	$_[0]{rbuf} = "";
1688		1770
		1771	()
		1772	}
		1773	}
		1774	};
		1775
		1776	=item cbor => $cb->($handle, $scalar)
		1777
		1778	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1779	error occurs, an C<EBADMSG> error will be raised.
		1780
		1781	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1782	used for the final decode, otherwise it will create a CBOR coder without
		1783	enabling any options.
		1784
		1785	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1786	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1787	itself.
		1788
		1789	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1790	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1791	the C<cbor> write type description, above, for an actual example.
		1792
		1793	=cut
		1794
		1795	register_read_type cbor => sub {
		1796	my ($self, $cb) = @_;
		1797
		1798	my $cbor = $self->{cbor} \|\|= cbor_coder;
		1799
		1800	my $data;
		1801
		1802	sub {
		1803	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1804
		1805	if (@value) {
		1806	$cb->($_[0], @value);
		1807
		1808	1
		1809	} elsif ($@) {
		1810	# error case
		1811	$cbor->incr_reset;
		1812
		1813	$_[0]->_error (Errno::EBADMSG);
		1814
		1815	()
		1816	} else {
1689	()	1817	()
1690	}	1818	}
1691	}	1819	}
1692	};	1820	};
1693		1821
…		…
1702	=cut	1830	=cut
1703		1831
1704	register_read_type storable => sub {	1832	register_read_type storable => sub {
1705	my ($self, $cb) = @_;	1833	my ($self, $cb) = @_;
1706		1834
1707	require Storable;	1835	require Storable unless $Storable::VERSION;
1708		1836
1709	sub {	1837	sub {
1710	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1838	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1711	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1839	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1712	or return;	1840	or return;
…		…
1715		1843
1716	# bypass unshift if we already have the remaining chunk	1844	# bypass unshift if we already have the remaining chunk
1717	if ($format + $len <= length $_[0]{rbuf}) {	1845	if ($format + $len <= length $_[0]{rbuf}) {
1718	my $data = substr $_[0]{rbuf}, $format, $len;	1846	my $data = substr $_[0]{rbuf}, $format, $len;
1719	substr $_[0]{rbuf}, 0, $format + $len, "";	1847	substr $_[0]{rbuf}, 0, $format + $len, "";
		1848
1720	$cb->($_[0], Storable::thaw ($data));	1849	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1850	or return $_[0]->_error (Errno::EBADMSG);
1721	} else {	1851	} else {
1722	# remove prefix	1852	# remove prefix
1723	substr $_[0]{rbuf}, 0, $format, "";	1853	substr $_[0]{rbuf}, 0, $format, "";
1724		1854
1725	# read remaining chunk	1855	# read remaining chunk
1726	$_[0]->unshift_read (chunk => $len, sub {	1856	$_[0]->unshift_read (chunk => $len, sub {
1727	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1857	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1728	$cb->($_[0], $ref);
1729	} else {
1730	$self->_error (Errno::EBADMSG);	1858	or $_[0]->_error (Errno::EBADMSG);
1731	}
1732	});	1859	});
1733	}	1860	}
1734		1861
1735	1	1862	1
1736	}	1863	}
		1864	};
		1865
		1866	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1867
		1868	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1869	record without consuming anything. Only SSL version 3 or higher
		1870	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1871	SSL2-compatible framing is supported).
		1872
		1873	If it detects that the input data is likely TLS, it calls the callback
		1874	with a true value for C<$detect> and the (on-wire) TLS version as second
		1875	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1876	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1877	be definitely not TLS, it calls the callback with a false value for
		1878	C<$detect>.
		1879
		1880	The callback could use this information to decide whether or not to start
		1881	TLS negotiation.
		1882
		1883	In all cases the data read so far is passed to the following read
		1884	handlers.
		1885
		1886	Usually you want to use the C<tls_autostart> read type instead.
		1887
		1888	If you want to design a protocol that works in the presence of TLS
		1889	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1890	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1891	read type does are a bit more strict, but might losen in the future to
		1892	accomodate protocol changes.
		1893
		1894	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1895	L<Net::SSLeay>).
		1896
		1897	=item tls_autostart => $tls[, $tls_ctx]
		1898
		1899	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1900	to start tls by calling C<starttls> with the given arguments.
		1901
		1902	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1903	been configured to accept, as servers do not normally send a handshake on
		1904	their own and ths cannot be detected in this way.
		1905
		1906	See C<tls_detect> above for more details.
		1907
		1908	Example: give the client a chance to start TLS before accepting a text
		1909	line.
		1910
		1911	$hdl->push_read (tls_detect => "accept");
		1912	$hdl->push_read (line => sub {
		1913	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1914	});
		1915
		1916	=cut
		1917
		1918	register_read_type tls_detect => sub {
		1919	my ($self, $cb) = @_;
		1920
		1921	sub {
		1922	# this regex matches a full or partial tls record
		1923	if (
		1924	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1925	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1926	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1927	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1928	) {
		1929	return if 3 != length $1; # partial match, can't decide yet
		1930
		1931	# full match, valid TLS record
		1932	my ($major, $minor) = unpack "CC", $1;
		1933	$cb->($self, "accept", $major + $minor * 0.1);
		1934	} else {
		1935	# mismatch == guaranteed not TLS
		1936	$cb->($self, undef);
		1937	}
		1938
		1939	1
		1940	}
		1941	};
		1942
		1943	register_read_type tls_autostart => sub {
		1944	my ($self, @tls) = @_;
		1945
		1946	$RH{tls_detect}($self, sub {
		1947	return unless $_[1];
		1948	$_[0]->starttls (@tls);
		1949	})
1737	};	1950	};
1738		1951
1739	=back	1952	=back
1740		1953
1741	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1954	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1783	some readings of the the SSL/TLS specifications basically require this	1996	some readings of the the SSL/TLS specifications basically require this
1784	attack to be working, as SSL/TLS implementations might stall sending data	1997	attack to be working, as SSL/TLS implementations might stall sending data
1785	during a rehandshake.	1998	during a rehandshake.
1786		1999
1787	As a guideline, during the initial handshake, you should not stop reading,	2000	As a guideline, during the initial handshake, you should not stop reading,
1788	and as a client, it might cause problems, depending on your applciation.	2001	and as a client, it might cause problems, depending on your application.
1789		2002
1790	=cut	2003	=cut
1791		2004
1792	sub stop_read {	2005	sub stop_read {
1793	my ($self) = @_;	2006	my ($self) = @_;
…		…
1841	my ($self, $err) = @_;	2054	my ($self, $err) = @_;
1842		2055
1843	return $self->_error ($!, 1)	2056	return $self->_error ($!, 1)
1844	if $err == Net::SSLeay::ERROR_SYSCALL ();	2057	if $err == Net::SSLeay::ERROR_SYSCALL ();
1845		2058
1846	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2059	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1847		2060
1848	# reduce error string to look less scary	2061	# reduce error string to look less scary
1849	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2062	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1850		2063
1851	if ($self->{_on_starttls}) {	2064	if ($self->{_on_starttls}) {
…		…
1865	sub _dotls {	2078	sub _dotls {
1866	my ($self) = @_;	2079	my ($self) = @_;
1867		2080
1868	my $tmp;	2081	my $tmp;
1869		2082
1870	if (length $self->{_tls_wbuf}) {	2083	while (length $self->{_tls_wbuf}) {
1871	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2084	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1872	substr $self->{_tls_wbuf}, 0, $tmp, "";	2085	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2086
		2087	return $self->_tls_error ($tmp)
		2088	if $tmp != $ERROR_WANT_READ
		2089	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		2090
		2091	last;
1873	}	2092	}
1874		2093
1875	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2094	substr $self->{_tls_wbuf}, 0, $tmp, "";
1876	return $self->_tls_error ($tmp)
1877	if $tmp != $ERROR_WANT_READ
1878	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1879	}	2095	}
1880		2096
1881	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2097	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1882	unless (length $tmp) {	2098	unless (length $tmp) {
1883	$self->{_on_starttls}	2099	$self->{_on_starttls}
…		…
1897	$self->{_tls_rbuf} .= $tmp;	2113	$self->{_tls_rbuf} .= $tmp;
1898	$self->_drain_rbuf;	2114	$self->_drain_rbuf;
1899	$self->{tls} or return; # tls session might have gone away in callback	2115	$self->{tls} or return; # tls session might have gone away in callback
1900	}	2116	}
1901		2117
1902	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	2118	$tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us
1903	return $self->_tls_error ($tmp)	2119	return $self->_tls_error ($tmp)
1904	if $tmp != $ERROR_WANT_READ	2120	if $tmp != $ERROR_WANT_READ
1905	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2121	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1906		2122
1907	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2123	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1917		2133
1918	=item $handle->starttls ($tls[, $tls_ctx])	2134	=item $handle->starttls ($tls[, $tls_ctx])
1919		2135
1920	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2136	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	2137	object is created, you can also do that at a later time by calling
1922	C<starttls>.	2138	C<starttls>. See the C<tls> constructor argument for general info.
1923		2139
1924	Starting TLS is currently an asynchronous operation - when you push some	2140	Starting TLS is currently an asynchronous operation - when you push some
1925	write data and then call C<< ->starttls >> then TLS negotiation will start	2141	write data and then call C<< ->starttls >> then TLS negotiation will start
1926	immediately, after which the queued write data is then sent.	2142	immediately, after which the queued write data is then sent. This might
		2143	change in future versions, so best make sure you have no outstanding write
		2144	data when calling this method.
1927		2145
1928	The first argument is the same as the C<tls> constructor argument (either	2146	The first argument is the same as the C<tls> constructor argument (either
1929	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2147	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1930		2148
1931	The second argument is the optional C<AnyEvent::TLS> object that is used	2149	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1953	my ($self, $tls, $ctx) = @_;	2171	my ($self, $tls, $ctx) = @_;
1954		2172
1955	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2173	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1956	if $self->{tls};	2174	if $self->{tls};
1957		2175
		2176	unless (defined $AnyEvent::TLS::VERSION) {
		2177	eval {
		2178	require Net::SSLeay;
		2179	require AnyEvent::TLS;
		2180	1
		2181	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2182	}
		2183
1958	$self->{tls} = $tls;	2184	$self->{tls} = $tls;
1959	$self->{tls_ctx} = $ctx if @_ > 2;	2185	$self->{tls_ctx} = $ctx if @_ > 2;
1960		2186
1961	return unless $self->{fh};	2187	return unless $self->{fh};
1962		2188
1963	require Net::SSLeay;
1964
1965	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2189	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1966	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2190	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1967		2191
1968	$tls = delete $self->{tls};	2192	$tls = delete $self->{tls};
1969	$ctx = $self->{tls_ctx};	2193	$ctx = $self->{tls_ctx};
1970		2194
1971	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2195	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1972		2196
1973	if ("HASH" eq ref $ctx) {	2197	if ("HASH" eq ref $ctx) {
1974	require AnyEvent::TLS;
1975
1976	if ($ctx->{cache}) {	2198	if ($ctx->{cache}) {
1977	my $key = $ctx+0;	2199	my $key = $ctx+0;
1978	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2200	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1979	} else {	2201	} else {
1980	$ctx = new AnyEvent::TLS %$ctx;	2202	$ctx = new AnyEvent::TLS %$ctx;
…		…
2002	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2224	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
2003		2225
2004	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2226	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
2005	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2227	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
2006		2228
2007	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2229	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2230	$self->{rbuf} = "";
2008		2231
2009	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2232	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
2010		2233
2011	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2234	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
2012	if $self->{on_starttls};	2235	if $self->{on_starttls};
…		…
2049	$self->{tls_ctx}->_put_session (delete $self->{tls})	2272	$self->{tls_ctx}->_put_session (delete $self->{tls})
2050	if $self->{tls} > 0;	2273	if $self->{tls} > 0;
2051		2274
2052	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2275	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
2053	}	2276	}
		2277
		2278	=item $handle->resettls
		2279
		2280	This rarely-used method simply resets and TLS state on the handle, usually
		2281	causing data loss.
		2282
		2283	One case where it may be useful is when you want to skip over the data in
		2284	the stream but you are not interested in interpreting it, so data loss is
		2285	no concern.
		2286
		2287	=cut
		2288
		2289	*resettls = \&_freetls;
2054		2290
2055	sub DESTROY {	2291	sub DESTROY {
2056	my ($self) = @_;	2292	my ($self) = @_;
2057		2293
2058	&_freetls;	2294	&_freetls;
…		…
2181	Probably because your C<on_error> callback is being called instead: When	2417	Probably because your C<on_error> callback is being called instead: When
2182	you have outstanding requests in your read queue, then an EOF is	2418	you have outstanding requests in your read queue, then an EOF is
2183	considered an error as you clearly expected some data.	2419	considered an error as you clearly expected some data.
2184		2420
2185	To avoid this, make sure you have an empty read queue whenever your handle	2421	To avoid this, make sure you have an empty read queue whenever your handle
2186	is supposed to be "idle" (i.e. connection closes are O.K.). You cna set	2422	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
2187	an C<on_read> handler that simply pushes the first read requests in the	2423	an C<on_read> handler that simply pushes the first read requests in the
2188	queue.	2424	queue.
2189		2425
2190	See also the next question, which explains this in a bit more detail.	2426	See also the next question, which explains this in a bit more detail.
2191		2427
…		…
2199	handles requests until the server gets some QUIT command, causing it to	2435	handles requests until the server gets some QUIT command, causing it to
2200	close the connection first (highly desirable for a busy TCP server). A	2436	close the connection first (highly desirable for a busy TCP server). A
2201	client dropping the connection is an error, which means this variant can	2437	client dropping the connection is an error, which means this variant can
2202	detect an unexpected detection close.	2438	detect an unexpected detection close.
2203		2439
2204	To handle this case, always make sure you have a on-empty read queue, by	2440	To handle this case, always make sure you have a non-empty read queue, by
2205	pushing the "read request start" handler on it:	2441	pushing the "read request start" handler on it:
2206		2442
2207	# we assume a request starts with a single line	2443	# we assume a request starts with a single line
2208	my @start_request; @start_request = (line => sub {	2444	my @start_request; @start_request = (line => sub {
2209	my ($hdl, $line) = @_;	2445	my ($hdl, $line) = @_;
…		…
2222	some data and raises the C<EPIPE> error when the connction is dropped	2458	some data and raises the C<EPIPE> error when the connction is dropped
2223	unexpectedly.	2459	unexpectedly.
2224		2460
2225	The second variant is a protocol where the client can drop the connection	2461	The second variant is a protocol where the client can drop the connection
2226	at any time. For TCP, this means that the server machine may run out of	2462	at any time. For TCP, this means that the server machine may run out of
2227	sockets easier, and in general, it means you cnanot distinguish a protocl	2463	sockets easier, and in general, it means you cannot distinguish a protocl
2228	failure/client crash from a normal connection close. Nevertheless, these	2464	failure/client crash from a normal connection close. Nevertheless, these
2229	kinds of protocols are common (and sometimes even the best solution to the	2465	kinds of protocols are common (and sometimes even the best solution to the
2230	problem).	2466	problem).
2231		2467
2232	Having an outstanding read request at all times is possible if you ignore	2468	Having an outstanding read request at all times is possible if you ignore
…		…
2284	$handle->on_eof (undef);	2520	$handle->on_eof (undef);
2285	$handle->on_error (sub {	2521	$handle->on_error (sub {
2286	my $data = delete $_[0]{rbuf};	2522	my $data = delete $_[0]{rbuf};
2287	});	2523	});
2288		2524
		2525	Note that this example removes the C<rbuf> member from the handle object,
		2526	which is not normally allowed by the API. It is expressly permitted in
		2527	this case only, as the handle object needs to be destroyed afterwards.
		2528
2289	The reason to use C<on_error> is that TCP connections, due to latencies	2529	The reason to use C<on_error> is that TCP connections, due to latencies
2290	and packets loss, might get closed quite violently with an error, when in	2530	and packets loss, might get closed quite violently with an error, when in
2291	fact all data has been received.	2531	fact all data has been received.
2292		2532
2293	It is usually better to use acknowledgements when transferring data,	2533	It is usually better to use acknowledgements when transferring data,
…		…
2303	C<low_water_mark> this will be called precisely when all data has been	2543	C<low_water_mark> this will be called precisely when all data has been
2304	written to the socket:	2544	written to the socket:
2305		2545
2306	$handle->push_write (...);	2546	$handle->push_write (...);
2307	$handle->on_drain (sub {	2547	$handle->on_drain (sub {
2308	warn "all data submitted to the kernel\n";	2548	AE::log debug => "All data submitted to the kernel.";
2309	undef $handle;	2549	undef $handle;
2310	});	2550	});
2311		2551
2312	If you just want to queue some data and then signal EOF to the other side,	2552	If you just want to queue some data and then signal EOF to the other side,
2313	consider using C<< ->push_shutdown >> instead.	2553	consider using C<< ->push_shutdown >> instead.
…		…
2397	When you have intermediate CA certificates that your clients might not	2637	When you have intermediate CA certificates that your clients might not
2398	know about, just append them to the C<cert_file>.	2638	know about, just append them to the C<cert_file>.
2399		2639
2400	=back	2640	=back
2401		2641
2402
2403	=head1 SUBCLASSING AnyEvent::Handle	2642	=head1 SUBCLASSING AnyEvent::Handle
2404		2643
2405	In many cases, you might want to subclass AnyEvent::Handle.	2644	In many cases, you might want to subclass AnyEvent::Handle.
2406		2645
2407	To make this easier, a given version of AnyEvent::Handle uses these	2646	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2433		2672
2434	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2673	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2435		2674
2436	=cut	2675	=cut
2437		2676
2438	1; # End of AnyEvent::Handle	2677	1
		2678

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.214 by root, Sun Jan 16 17:12:27 2011 UTC vs. Revision 1.242 by root, Wed Dec 10 04:29:33 2014 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.214 by root, Sun Jan 16 17:12:27 2011 UTC vs.
Revision 1.242 by root, Wed Dec 10 04:29:33 2014 UTC