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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.210 by root, Thu Dec 30 01:53:15 2010 UTC vs.
Revision 1.240 by root, Tue Dec 17 16:43:15 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>, L<JSON::PP> 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
		509	=item cbor => L<CBOR::XS> object
		510
		511	This is the cbor coder object used by the C<cbor> read and write types.
		512
		513	If you don't supply it, then AnyEvent::Handle will create and use a
		514	suitable one (on demand), which will write CBOR without using extensions,
		515	if possible. texts.
		516
490	Note that you are responsible to depend on the JSON module if you want to	517	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.	518	want to use this functionality, as AnyEvent does not have a dependency on
		519	it itself.
492		520
493	=back	521	=back
494		522
495	=cut	523	=cut
496		524
…		…
536	});	564	});
537		565
538	} else {	566	} else {
539	if ($self->{on_connect_error}) {	567	if ($self->{on_connect_error}) {
540	$self->{on_connect_error}($self, "$!");	568	$self->{on_connect_error}($self, "$!");
541	$self->destroy;	569	$self->destroy if $self;
542	} else {	570	} else {
543	$self->_error ($!, 1);	571	$self->_error ($!, 1);
544	}	572	}
545	}	573	}
546	},	574	},
…		…
765		793
766	sub rbuf_max {	794	sub rbuf_max {
767	$_[0]{rbuf_max} = $_[1];	795	$_[0]{rbuf_max} = $_[1];
768	}	796	}
769		797
770	sub rbuf_max {	798	sub wbuf_max {
771	$_[0]{wbuf_max} = $_[1];	799	$_[0]{wbuf_max} = $_[1];
772	}	800	}
773		801
774	#############################################################################	802	#############################################################################
775		803
…		…
778	=item $handle->rtimeout ($seconds)	806	=item $handle->rtimeout ($seconds)
779		807
780	=item $handle->wtimeout ($seconds)	808	=item $handle->wtimeout ($seconds)
781		809
782	Configures (or disables) the inactivity timeout.	810	Configures (or disables) the inactivity timeout.
		811
		812	The timeout will be checked instantly, so this method might destroy the
		813	handle before it returns.
783		814
784	=item $handle->timeout_reset	815	=item $handle->timeout_reset
785		816
786	=item $handle->rtimeout_reset	817	=item $handle->rtimeout_reset
787		818
…		…
871		902
872	The write queue is very simple: you can add data to its end, and	903	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.	904	AnyEvent::Handle will automatically try to get rid of it for you.
874		905
875	When data could be written and the write buffer is shorter then the low	906	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.	907	water mark, the C<on_drain> callback will be invoked once.
877		908
878	=over 4	909	=over 4
879		910
880	=item $handle->on_drain ($cb)	911	=item $handle->on_drain ($cb)
881		912
…		…
1031		1062
1032	The generated JSON text is guaranteed not to contain any newlines: While	1063	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	1064	this module doesn't need delimiters after or between JSON texts to be
1034	able to read them, many other languages depend on that.	1065	able to read them, many other languages depend on that.
1035		1066
1036	A simple RPC protocol that interoperates easily with others is to send	1067	A simple RPC protocol that interoperates easily with other languages is
1037	JSON arrays (or objects, although arrays are usually the better choice as	1068	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	1069	choice as they mimic how function argument passing works) and a newline
1039	JSON text:	1070	after each JSON text:
1040		1071
1041	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1072	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1042	$handle->push_write ("\012");	1073	$handle->push_write ("\012");
1043		1074
1044	An AnyEvent::Handle receiver would simply use the C<json> read type and	1075	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
1047	$handle->push_read (json => sub { my $array = $_[1]; ... });	1078	$handle->push_read (json => sub { my $array = $_[1]; ... });
1048		1079
1049	Other languages could read single lines terminated by a newline and pass	1080	Other languages could read single lines terminated by a newline and pass
1050	this line into their JSON decoder of choice.	1081	this line into their JSON decoder of choice.
1051		1082
		1083	=item cbor => $perl_scalar
		1084
		1085	Encodes the given scalar into a CBOR value. Unless you provide your own
		1086	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1087	using any extensions, if possible.
		1088
		1089	CBOR values are self-delimiting, so you can write CBOR at one end of
		1090	a handle and read them at the other end without using any additional
		1091	framing.
		1092
		1093	A simple nd very very fast RPC protocol that interoperates with
		1094	other languages is to send CBOR and receive CBOR values (arrays are
		1095	recommended):
		1096
		1097	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1098
		1099	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1100
		1101	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1102
1052	=cut	1103	=cut
1053		1104
1054	sub json_coder() {	1105	sub json_coder() {
1055	eval { require JSON::XS; JSON::XS->new->utf8 }	1106	eval { require JSON::XS; JSON::XS->new->utf8 }
1056	\|\| do { require JSON; JSON->new->utf8 }	1107	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1057	}	1108	}
1058		1109
1059	register_write_type json => sub {	1110	register_write_type json => sub {
1060	my ($self, $ref) = @_;	1111	my ($self, $ref) = @_;
1061		1112
1062	my $json = $self->{json} \|\|= json_coder;	1113	($self->{json} \|\|= json_coder)
1063
1064	$json->encode ($ref)	1114	->encode ($ref)
		1115	};
		1116
		1117	sub cbor_coder() {
		1118	require CBOR::XS;
		1119	CBOR::XS->new
		1120	}
		1121
		1122	register_write_type cbor => sub {
		1123	my ($self, $scalar) = @_;
		1124
		1125	($self->{cbor} \|\|= cbor_coder)
		1126	->encode ($scalar)
1065	};	1127	};
1066		1128
1067	=item storable => $reference	1129	=item storable => $reference
1068		1130
1069	Freezes the given reference using L<Storable> and writes it to the	1131	Freezes the given reference using L<Storable> and writes it to the
…		…
1072	=cut	1134	=cut
1073		1135
1074	register_write_type storable => sub {	1136	register_write_type storable => sub {
1075	my ($self, $ref) = @_;	1137	my ($self, $ref) = @_;
1076		1138
1077	require Storable;	1139	require Storable unless $Storable::VERSION;
1078		1140
1079	pack "w/a*", Storable::nfreeze ($ref)	1141	pack "w/a*", Storable::nfreeze ($ref)
1080	};	1142	};
1081		1143
1082	=back	1144	=back
…		…
1087	before it was actually written. One way to do that is to replace your	1149	before it was actually written. One way to do that is to replace your
1088	C<on_drain> handler by a callback that shuts down the socket (and set	1150	C<on_drain> handler by a callback that shuts down the socket (and set
1089	C<low_water_mark> to C<0>). This method is a shorthand for just that, and	1151	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
1090	replaces the C<on_drain> callback with:	1152	replaces the C<on_drain> callback with:
1091		1153
1092	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1154	sub { shutdown $_[0]{fh}, 1 }
1093		1155
1094	This simply shuts down the write side and signals an EOF condition to the	1156	This simply shuts down the write side and signals an EOF condition to the
1095	the peer.	1157	the peer.
1096		1158
1097	You can rely on the normal read queue and C<on_eof> handling	1159	You can rely on the normal read queue and C<on_eof> handling
…		…
1119		1181
1120	Whenever the given C<type> is used, C<push_write> will the function with	1182	Whenever the given C<type> is used, C<push_write> will the function with
1121	the handle object and the remaining arguments.	1183	the handle object and the remaining arguments.
1122		1184
1123	The function is supposed to return a single octet string that will be	1185	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	1186	appended to the write buffer, so you can mentally treat this function as a
1125	"arguments to on-the-wire-format" converter.	1187	"arguments to on-the-wire-format" converter.
1126		1188
1127	Example: implement a custom write type C<join> that joins the remaining	1189	Example: implement a custom write type C<join> that joins the remaining
1128	arguments using the first one.	1190	arguments using the first one.
1129		1191
…		…
1423	data.	1485	data.
1424		1486
1425	Example: read 2 bytes.	1487	Example: read 2 bytes.
1426		1488
1427	$handle->push_read (chunk => 2, sub {	1489	$handle->push_read (chunk => 2, sub {
1428	warn "yay ", unpack "H*", $_[1];	1490	say "yay " . unpack "H*", $_[1];
1429	});	1491	});
1430		1492
1431	=cut	1493	=cut
1432		1494
1433	register_read_type chunk => sub {	1495	register_read_type chunk => sub {
…		…
1463		1525
1464	register_read_type line => sub {	1526	register_read_type line => sub {
1465	my ($self, $cb, $eol) = @_;	1527	my ($self, $cb, $eol) = @_;
1466		1528
1467	if (@_ < 3) {	1529	if (@_ < 3) {
1468	# this is more than twice as fast as the generic code below	1530	# this is faster then the generic code below
1469	sub {	1531	sub {
1470	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1532	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1533	or return;
1471		1534
		1535	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1472	$cb->($_[0], $1, $2);	1536	$cb->($_[0], $str, "$1");
1473	1	1537	1
1474	}	1538	}
1475	} else {	1539	} else {
1476	$eol = quotemeta $eol unless ref $eol;	1540	$eol = quotemeta $eol unless ref $eol;
1477	$eol = qr\|^(.*?)($eol)\|s;	1541	$eol = qr\|^(.*?)($eol)\|s;
1478		1542
1479	sub {	1543	sub {
1480	$_[0]{rbuf} =~ s/$eol// or return;	1544	$_[0]{rbuf} =~ s/$eol// or return;
1481		1545
1482	$cb->($_[0], $1, $2);	1546	$cb->($_[0], "$1", "$2");
1483	1	1547	1
1484	}	1548	}
1485	}	1549	}
1486	};	1550	};
1487		1551
…		…
1535		1599
1536	sub {	1600	sub {
1537	# accept	1601	# accept
1538	if ($$rbuf =~ $accept) {	1602	if ($$rbuf =~ $accept) {
1539	$data .= substr $$rbuf, 0, $+[0], "";	1603	$data .= substr $$rbuf, 0, $+[0], "";
1540	$cb->($self, $data);	1604	$cb->($_[0], $data);
1541	return 1;	1605	return 1;
1542	}	1606	}
1543		1607
1544	# reject	1608	# reject
1545	if ($reject && $$rbuf =~ $reject) {	1609	if ($reject && $$rbuf =~ $reject) {
1546	$self->_error (Errno::EBADMSG);	1610	$_[0]->_error (Errno::EBADMSG);
1547	}	1611	}
1548		1612
1549	# skip	1613	# skip
1550	if ($skip && $$rbuf =~ $skip) {	1614	if ($skip && $$rbuf =~ $skip) {
1551	$data .= substr $$rbuf, 0, $+[0], "";	1615	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1567	my ($self, $cb) = @_;	1631	my ($self, $cb) = @_;
1568		1632
1569	sub {	1633	sub {
1570	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1634	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1571	if ($_[0]{rbuf} =~ /[^0-9]/) {	1635	if ($_[0]{rbuf} =~ /[^0-9]/) {
1572	$self->_error (Errno::EBADMSG);	1636	$_[0]->_error (Errno::EBADMSG);
1573	}	1637	}
1574	return;	1638	return;
1575	}	1639	}
1576		1640
1577	my $len = $1;	1641	my $len = $1;
1578		1642
1579	$self->unshift_read (chunk => $len, sub {	1643	$_[0]->unshift_read (chunk => $len, sub {
1580	my $string = $_[1];	1644	my $string = $_[1];
1581	$_[0]->unshift_read (chunk => 1, sub {	1645	$_[0]->unshift_read (chunk => 1, sub {
1582	if ($_[1] eq ",") {	1646	if ($_[1] eq ",") {
1583	$cb->($_[0], $string);	1647	$cb->($_[0], $string);
1584	} else {	1648	} else {
1585	$self->_error (Errno::EBADMSG);	1649	$_[0]->_error (Errno::EBADMSG);
1586	}	1650	}
1587	});	1651	});
1588	});	1652	});
1589		1653
1590	1	1654	1
…		…
1640	=item json => $cb->($handle, $hash_or_arrayref)	1704	=item json => $cb->($handle, $hash_or_arrayref)
1641		1705
1642	Reads a JSON object or array, decodes it and passes it to the	1706	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.	1707	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1644		1708
1645	If a C<json> object was passed to the constructor, then that will be used	1709	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.	1710	used for the final decode, otherwise it will create a L<JSON::XS> or
		1711	L<JSON::PP> coder object expecting UTF-8.
1647		1712
1648	This read type uses the incremental parser available with JSON version	1713	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	1714	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		1715
1653	Since JSON texts are fully self-delimiting, the C<json> read and write	1716	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	1717	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1655	the C<json> write type description, above, for an actual example.	1718	the C<json> write type description, above, for an actual example.
1656		1719
…		…
1660	my ($self, $cb) = @_;	1723	my ($self, $cb) = @_;
1661		1724
1662	my $json = $self->{json} \|\|= json_coder;	1725	my $json = $self->{json} \|\|= json_coder;
1663		1726
1664	my $data;	1727	my $data;
1665	my $rbuf = \$self->{rbuf};
1666		1728
1667	sub {	1729	sub {
1668	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1730	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1669		1731
1670	if ($ref) {	1732	if ($ref) {
1671	$self->{rbuf} = $json->incr_text;	1733	$_[0]{rbuf} = $json->incr_text;
1672	$json->incr_text = "";	1734	$json->incr_text = "";
1673	$cb->($self, $ref);	1735	$cb->($_[0], $ref);
1674		1736
1675	1	1737	1
1676	} elsif ($@) {	1738	} elsif ($@) {
1677	# error case	1739	# error case
1678	$json->incr_skip;	1740	$json->incr_skip;
1679		1741
1680	$self->{rbuf} = $json->incr_text;	1742	$_[0]{rbuf} = $json->incr_text;
1681	$json->incr_text = "";	1743	$json->incr_text = "";
1682		1744
1683	$self->_error (Errno::EBADMSG);	1745	$_[0]->_error (Errno::EBADMSG);
1684		1746
1685	()	1747	()
1686	} else {	1748	} else {
1687	$self->{rbuf} = "";	1749	$_[0]{rbuf} = "";
1688		1750
		1751	()
		1752	}
		1753	}
		1754	};
		1755
		1756	=item cbor => $cb->($handle, $scalar)
		1757
		1758	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1759	error occurs, an C<EBADMSG> error will be raised.
		1760
		1761	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1762	used for the final decode, otherwise it will create a CBOR coder without
		1763	enabling any options.
		1764
		1765	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1766	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1767	itself.
		1768
		1769	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1770	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1771	the C<cbor> write type description, above, for an actual example.
		1772
		1773	=cut
		1774
		1775	register_read_type cbor => sub {
		1776	my ($self, $cb) = @_;
		1777
		1778	my $cbor = $self->{cbor} \|\|= cbor_coder;
		1779
		1780	my $data;
		1781
		1782	sub {
		1783	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1784
		1785	if (@value) {
		1786	$cb->($_[0], @value);
		1787
		1788	1
		1789	} elsif ($@) {
		1790	# error case
		1791	$cbor->incr_reset;
		1792
		1793	$_[0]->_error (Errno::EBADMSG);
		1794
		1795	()
		1796	} else {
1689	()	1797	()
1690	}	1798	}
1691	}	1799	}
1692	};	1800	};
1693		1801
…		…
1702	=cut	1810	=cut
1703		1811
1704	register_read_type storable => sub {	1812	register_read_type storable => sub {
1705	my ($self, $cb) = @_;	1813	my ($self, $cb) = @_;
1706		1814
1707	require Storable;	1815	require Storable unless $Storable::VERSION;
1708		1816
1709	sub {	1817	sub {
1710	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1818	# 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} })	1819	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1712	or return;	1820	or return;
…		…
1715		1823
1716	# bypass unshift if we already have the remaining chunk	1824	# bypass unshift if we already have the remaining chunk
1717	if ($format + $len <= length $_[0]{rbuf}) {	1825	if ($format + $len <= length $_[0]{rbuf}) {
1718	my $data = substr $_[0]{rbuf}, $format, $len;	1826	my $data = substr $_[0]{rbuf}, $format, $len;
1719	substr $_[0]{rbuf}, 0, $format + $len, "";	1827	substr $_[0]{rbuf}, 0, $format + $len, "";
		1828
1720	$cb->($_[0], Storable::thaw ($data));	1829	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1830	or return $_[0]->_error (Errno::EBADMSG);
1721	} else {	1831	} else {
1722	# remove prefix	1832	# remove prefix
1723	substr $_[0]{rbuf}, 0, $format, "";	1833	substr $_[0]{rbuf}, 0, $format, "";
1724		1834
1725	# read remaining chunk	1835	# read remaining chunk
1726	$_[0]->unshift_read (chunk => $len, sub {	1836	$_[0]->unshift_read (chunk => $len, sub {
1727	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1837	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1728	$cb->($_[0], $ref);
1729	} else {
1730	$self->_error (Errno::EBADMSG);	1838	or $_[0]->_error (Errno::EBADMSG);
1731	}
1732	});	1839	});
1733	}	1840	}
1734		1841
1735	1	1842	1
1736	}	1843	}
		1844	};
		1845
		1846	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1847
		1848	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1849	record without consuming anything. Only SSL version 3 or higher
		1850	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1851	SSL2-compatible framing is supported).
		1852
		1853	If it detects that the input data is likely TLS, it calls the callback
		1854	with a true value for C<$detect> and the (on-wire) TLS version as second
		1855	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1856	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1857	be definitely not TLS, it calls the callback with a false value for
		1858	C<$detect>.
		1859
		1860	The callback could use this information to decide whether or not to start
		1861	TLS negotiation.
		1862
		1863	In all cases the data read so far is passed to the following read
		1864	handlers.
		1865
		1866	Usually you want to use the C<tls_autostart> read type instead.
		1867
		1868	If you want to design a protocol that works in the presence of TLS
		1869	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1870	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1871	read type does are a bit more strict, but might losen in the future to
		1872	accomodate protocol changes.
		1873
		1874	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1875	L<Net::SSLeay>).
		1876
		1877	=item tls_autostart => $tls[, $tls_ctx]
		1878
		1879	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1880	to start tls by calling C<starttls> with the given arguments.
		1881
		1882	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1883	been configured to accept, as servers do not normally send a handshake on
		1884	their own and ths cannot be detected in this way.
		1885
		1886	See C<tls_detect> above for more details.
		1887
		1888	Example: give the client a chance to start TLS before accepting a text
		1889	line.
		1890
		1891	$hdl->push_read (tls_detect => "accept");
		1892	$hdl->push_read (line => sub {
		1893	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1894	});
		1895
		1896	=cut
		1897
		1898	register_read_type tls_detect => sub {
		1899	my ($self, $cb) = @_;
		1900
		1901	sub {
		1902	# this regex matches a full or partial tls record
		1903	if (
		1904	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1905	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1906	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1907	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1908	) {
		1909	return if 3 != length $1; # partial match, can't decide yet
		1910
		1911	# full match, valid TLS record
		1912	my ($major, $minor) = unpack "CC", $1;
		1913	$cb->($self, "accept", $major + $minor * 0.1);
		1914	} else {
		1915	# mismatch == guaranteed not TLS
		1916	$cb->($self, undef);
		1917	}
		1918
		1919	1
		1920	}
		1921	};
		1922
		1923	register_read_type tls_autostart => sub {
		1924	my ($self, @tls) = @_;
		1925
		1926	$RH{tls_detect}($self, sub {
		1927	return unless $_[1];
		1928	$_[0]->starttls (@tls);
		1929	})
1737	};	1930	};
1738		1931
1739	=back	1932	=back
1740		1933
1741	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1934	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1773	Note that AnyEvent::Handle will automatically C<start_read> for you when	1966	Note that AnyEvent::Handle will automatically C<start_read> for you when
1774	you change the C<on_read> callback or push/unshift a read callback, and it	1967	you change the C<on_read> callback or push/unshift a read callback, and it
1775	will automatically C<stop_read> for you when neither C<on_read> is set nor	1968	will automatically C<stop_read> for you when neither C<on_read> is set nor
1776	there are any read requests in the queue.	1969	there are any read requests in the queue.
1777		1970
1778	These methods will have no effect when in TLS mode (as TLS doesn't support	1971	In older versions of this module (<= 5.3), these methods had no effect,
1779	half-duplex connections).	1972	as TLS does not support half-duplex connections. In current versions they
		1973	work as expected, as this behaviour is required to avoid certain resource
		1974	attacks, where the program would be forced to read (and buffer) arbitrary
		1975	amounts of data before being able to send some data. The drawback is that
		1976	some readings of the the SSL/TLS specifications basically require this
		1977	attack to be working, as SSL/TLS implementations might stall sending data
		1978	during a rehandshake.
		1979
		1980	As a guideline, during the initial handshake, you should not stop reading,
		1981	and as a client, it might cause problems, depending on your application.
1780		1982
1781	=cut	1983	=cut
1782		1984
1783	sub stop_read {	1985	sub stop_read {
1784	my ($self) = @_;	1986	my ($self) = @_;
1785		1987
1786	delete $self->{_rw} unless $self->{tls};	1988	delete $self->{_rw};
1787	}	1989	}
1788		1990
1789	sub start_read {	1991	sub start_read {
1790	my ($self) = @_;	1992	my ($self) = @_;
1791		1993
…		…
1832	my ($self, $err) = @_;	2034	my ($self, $err) = @_;
1833		2035
1834	return $self->_error ($!, 1)	2036	return $self->_error ($!, 1)
1835	if $err == Net::SSLeay::ERROR_SYSCALL ();	2037	if $err == Net::SSLeay::ERROR_SYSCALL ();
1836		2038
1837	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2039	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1838		2040
1839	# reduce error string to look less scary	2041	# reduce error string to look less scary
1840	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2042	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1841		2043
1842	if ($self->{_on_starttls}) {	2044	if ($self->{_on_starttls}) {
…		…
1856	sub _dotls {	2058	sub _dotls {
1857	my ($self) = @_;	2059	my ($self) = @_;
1858		2060
1859	my $tmp;	2061	my $tmp;
1860		2062
1861	if (length $self->{_tls_wbuf}) {	2063	while (length $self->{_tls_wbuf}) {
1862	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2064	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1863	substr $self->{_tls_wbuf}, 0, $tmp, "";	2065	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2066
		2067	return $self->_tls_error ($tmp)
		2068	if $tmp != $ERROR_WANT_READ
		2069	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		2070
		2071	last;
1864	}	2072	}
1865		2073
1866	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2074	substr $self->{_tls_wbuf}, 0, $tmp, "";
1867	return $self->_tls_error ($tmp)
1868	if $tmp != $ERROR_WANT_READ
1869	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1870	}	2075	}
1871		2076
1872	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2077	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1873	unless (length $tmp) {	2078	unless (length $tmp) {
1874	$self->{_on_starttls}	2079	$self->{_on_starttls}
…		…
1888	$self->{_tls_rbuf} .= $tmp;	2093	$self->{_tls_rbuf} .= $tmp;
1889	$self->_drain_rbuf;	2094	$self->_drain_rbuf;
1890	$self->{tls} or return; # tls session might have gone away in callback	2095	$self->{tls} or return; # tls session might have gone away in callback
1891	}	2096	}
1892		2097
1893	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	2098	$tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us
1894	return $self->_tls_error ($tmp)	2099	return $self->_tls_error ($tmp)
1895	if $tmp != $ERROR_WANT_READ	2100	if $tmp != $ERROR_WANT_READ
1896	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2101	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1897		2102
1898	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2103	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1908		2113
1909	=item $handle->starttls ($tls[, $tls_ctx])	2114	=item $handle->starttls ($tls[, $tls_ctx])
1910		2115
1911	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2116	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1912	object is created, you can also do that at a later time by calling	2117	object is created, you can also do that at a later time by calling
1913	C<starttls>.	2118	C<starttls>. See the C<tls> constructor argument for general info.
1914		2119
1915	Starting TLS is currently an asynchronous operation - when you push some	2120	Starting TLS is currently an asynchronous operation - when you push some
1916	write data and then call C<< ->starttls >> then TLS negotiation will start	2121	write data and then call C<< ->starttls >> then TLS negotiation will start
1917	immediately, after which the queued write data is then sent.	2122	immediately, after which the queued write data is then sent. This might
		2123	change in future versions, so best make sure you have no outstanding write
		2124	data when calling this method.
1918		2125
1919	The first argument is the same as the C<tls> constructor argument (either	2126	The first argument is the same as the C<tls> constructor argument (either
1920	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2127	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1921		2128
1922	The second argument is the optional C<AnyEvent::TLS> object that is used	2129	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1944	my ($self, $tls, $ctx) = @_;	2151	my ($self, $tls, $ctx) = @_;
1945		2152
1946	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2153	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1947	if $self->{tls};	2154	if $self->{tls};
1948		2155
		2156	unless (defined $AnyEvent::TLS::VERSION) {
		2157	eval {
		2158	require Net::SSLeay;
		2159	require AnyEvent::TLS;
		2160	1
		2161	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2162	}
		2163
1949	$self->{tls} = $tls;	2164	$self->{tls} = $tls;
1950	$self->{tls_ctx} = $ctx if @_ > 2;	2165	$self->{tls_ctx} = $ctx if @_ > 2;
1951		2166
1952	return unless $self->{fh};	2167	return unless $self->{fh};
1953		2168
1954	require Net::SSLeay;
1955
1956	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2169	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1957	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2170	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1958		2171
1959	$tls = delete $self->{tls};	2172	$tls = delete $self->{tls};
1960	$ctx = $self->{tls_ctx};	2173	$ctx = $self->{tls_ctx};
1961		2174
1962	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2175	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1963		2176
1964	if ("HASH" eq ref $ctx) {	2177	if ("HASH" eq ref $ctx) {
1965	require AnyEvent::TLS;
1966
1967	if ($ctx->{cache}) {	2178	if ($ctx->{cache}) {
1968	my $key = $ctx+0;	2179	my $key = $ctx+0;
1969	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2180	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1970	} else {	2181	} else {
1971	$ctx = new AnyEvent::TLS %$ctx;	2182	$ctx = new AnyEvent::TLS %$ctx;
…		…
1993	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2204	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1994		2205
1995	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2206	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1996	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2207	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1997		2208
1998	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2209	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2210	$self->{rbuf} = "";
1999		2211
2000	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2212	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
2001		2213
2002	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2214	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
2003	if $self->{on_starttls};	2215	if $self->{on_starttls};
…		…
2040	$self->{tls_ctx}->_put_session (delete $self->{tls})	2252	$self->{tls_ctx}->_put_session (delete $self->{tls})
2041	if $self->{tls} > 0;	2253	if $self->{tls} > 0;
2042		2254
2043	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2255	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
2044	}	2256	}
		2257
		2258	=item $handle->resettls
		2259
		2260	This rarely-used method simply resets and TLS state on the handle, usually
		2261	causing data loss.
		2262
		2263	One case where it may be useful is when you want to skip over the data in
		2264	the stream but you are not interested in interpreting it, so data loss is
		2265	no concern.
		2266
		2267	=cut
		2268
		2269	*resettls = \&_freetls;
2045		2270
2046	sub DESTROY {	2271	sub DESTROY {
2047	my ($self) = @_;	2272	my ($self) = @_;
2048		2273
2049	&_freetls;	2274	&_freetls;
…		…
2172	Probably because your C<on_error> callback is being called instead: When	2397	Probably because your C<on_error> callback is being called instead: When
2173	you have outstanding requests in your read queue, then an EOF is	2398	you have outstanding requests in your read queue, then an EOF is
2174	considered an error as you clearly expected some data.	2399	considered an error as you clearly expected some data.
2175		2400
2176	To avoid this, make sure you have an empty read queue whenever your handle	2401	To avoid this, make sure you have an empty read queue whenever your handle
2177	is supposed to be "idle" (i.e. connection closes are O.K.). You cna set	2402	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
2178	an C<on_read> handler that simply pushes the first read requests in the	2403	an C<on_read> handler that simply pushes the first read requests in the
2179	queue.	2404	queue.
2180		2405
2181	See also the next question, which explains this in a bit more detail.	2406	See also the next question, which explains this in a bit more detail.
2182		2407
…		…
2190	handles requests until the server gets some QUIT command, causing it to	2415	handles requests until the server gets some QUIT command, causing it to
2191	close the connection first (highly desirable for a busy TCP server). A	2416	close the connection first (highly desirable for a busy TCP server). A
2192	client dropping the connection is an error, which means this variant can	2417	client dropping the connection is an error, which means this variant can
2193	detect an unexpected detection close.	2418	detect an unexpected detection close.
2194		2419
2195	To handle this case, always make sure you have a on-empty read queue, by	2420	To handle this case, always make sure you have a non-empty read queue, by
2196	pushing the "read request start" handler on it:	2421	pushing the "read request start" handler on it:
2197		2422
2198	# we assume a request starts with a single line	2423	# we assume a request starts with a single line
2199	my @start_request; @start_request = (line => sub {	2424	my @start_request; @start_request = (line => sub {
2200	my ($hdl, $line) = @_;	2425	my ($hdl, $line) = @_;
…		…
2213	some data and raises the C<EPIPE> error when the connction is dropped	2438	some data and raises the C<EPIPE> error when the connction is dropped
2214	unexpectedly.	2439	unexpectedly.
2215		2440
2216	The second variant is a protocol where the client can drop the connection	2441	The second variant is a protocol where the client can drop the connection
2217	at any time. For TCP, this means that the server machine may run out of	2442	at any time. For TCP, this means that the server machine may run out of
2218	sockets easier, and in general, it means you cnanot distinguish a protocl	2443	sockets easier, and in general, it means you cannot distinguish a protocl
2219	failure/client crash from a normal connection close. Nevertheless, these	2444	failure/client crash from a normal connection close. Nevertheless, these
2220	kinds of protocols are common (and sometimes even the best solution to the	2445	kinds of protocols are common (and sometimes even the best solution to the
2221	problem).	2446	problem).
2222		2447
2223	Having an outstanding read request at all times is possible if you ignore	2448	Having an outstanding read request at all times is possible if you ignore
…		…
2275	$handle->on_eof (undef);	2500	$handle->on_eof (undef);
2276	$handle->on_error (sub {	2501	$handle->on_error (sub {
2277	my $data = delete $_[0]{rbuf};	2502	my $data = delete $_[0]{rbuf};
2278	});	2503	});
2279		2504
		2505	Note that this example removes the C<rbuf> member from the handle object,
		2506	which is not normally allowed by the API. It is expressly permitted in
		2507	this case only, as the handle object needs to be destroyed afterwards.
		2508
2280	The reason to use C<on_error> is that TCP connections, due to latencies	2509	The reason to use C<on_error> is that TCP connections, due to latencies
2281	and packets loss, might get closed quite violently with an error, when in	2510	and packets loss, might get closed quite violently with an error, when in
2282	fact all data has been received.	2511	fact all data has been received.
2283		2512
2284	It is usually better to use acknowledgements when transferring data,	2513	It is usually better to use acknowledgements when transferring data,
…		…
2294	C<low_water_mark> this will be called precisely when all data has been	2523	C<low_water_mark> this will be called precisely when all data has been
2295	written to the socket:	2524	written to the socket:
2296		2525
2297	$handle->push_write (...);	2526	$handle->push_write (...);
2298	$handle->on_drain (sub {	2527	$handle->on_drain (sub {
2299	warn "all data submitted to the kernel\n";	2528	AE::log debug => "All data submitted to the kernel.";
2300	undef $handle;	2529	undef $handle;
2301	});	2530	});
2302		2531
2303	If you just want to queue some data and then signal EOF to the other side,	2532	If you just want to queue some data and then signal EOF to the other side,
2304	consider using C<< ->push_shutdown >> instead.	2533	consider using C<< ->push_shutdown >> instead.
…		…
2388	When you have intermediate CA certificates that your clients might not	2617	When you have intermediate CA certificates that your clients might not
2389	know about, just append them to the C<cert_file>.	2618	know about, just append them to the C<cert_file>.
2390		2619
2391	=back	2620	=back
2392		2621
2393
2394	=head1 SUBCLASSING AnyEvent::Handle	2622	=head1 SUBCLASSING AnyEvent::Handle
2395		2623
2396	In many cases, you might want to subclass AnyEvent::Handle.	2624	In many cases, you might want to subclass AnyEvent::Handle.
2397		2625
2398	To make this easier, a given version of AnyEvent::Handle uses these	2626	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2424		2652
2425	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2653	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2426		2654
2427	=cut	2655	=cut
2428		2656
2429	1; # End of AnyEvent::Handle	2657	1
		2658

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.210 by root, Thu Dec 30 01:53:15 2010 UTC vs. Revision 1.240 by root, Tue Dec 17 16:43:15 2013 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.210 by root, Thu Dec 30 01:53:15 2010 UTC vs.
Revision 1.240 by root, Tue Dec 17 16:43:15 2013 UTC