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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.222 by root, Thu Aug 25 03:08:48 2011 UTC vs.
Revision 1.254 by root, Mon Feb 10 11:34:13 2020 UTC

…		…
11		11
12	my $hdl; $hdl = new AnyEvent::Handle	12	my $hdl; $hdl = new AnyEvent::Handle
13	fh => \*STDIN,	13	fh => \*STDIN,
14	on_error => sub {	14	on_error => sub {
15	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
16	AE::log 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	AE::log 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
33	=head1 DESCRIPTION	33	=head1 DESCRIPTION
34		34
35	This is a helper module to make it easier to do event-based I/O on	35	This is a helper module to make it easier to do event-based I/O
36	stream-based filehandles (sockets, pipes, and other stream things).	36	on stream-based filehandles (sockets, pipes, and other stream
		37	things). Specifically, it doesn't work as expected on files, packet-based
		38	sockets or similar things.
37		39
38	The L<AnyEvent::Intro> tutorial contains some well-documented	40	The L<AnyEvent::Intro> tutorial contains some well-documented
39	AnyEvent::Handle examples.	41	AnyEvent::Handle examples.
40		42
41	In the following, where the documentation refers to "bytes", it means	43	In the following, where the documentation refers to "bytes", it means
…		…
53	package AnyEvent::Handle;	55	package AnyEvent::Handle;
54		56
55	use Scalar::Util ();	57	use Scalar::Util ();
56	use List::Util ();	58	use List::Util ();
57	use Carp ();	59	use Carp ();
58	use Errno qw(EAGAIN EINTR);	60	use Errno qw(EAGAIN EWOULDBLOCK EINTR);
59		61
60	use AnyEvent (); BEGIN { AnyEvent::common_sense }	62	use AnyEvent (); BEGIN { AnyEvent::common_sense }
61	use AnyEvent::Util qw(WSAEWOULDBLOCK);	63	use AnyEvent::Util qw(WSAEWOULDBLOCK);
62		64
63	our $VERSION = $AnyEvent::VERSION;	65	our $VERSION = $AnyEvent::VERSION;
…		…
91		93
92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]	94	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
93		95
94	The filehandle this L<AnyEvent::Handle> object will operate on.	96	The filehandle this L<AnyEvent::Handle> object will operate on.
95	NOTE: The filehandle will be set to non-blocking mode (using	97	NOTE: The filehandle will be set to non-blocking mode (using
96	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	98	C<AnyEvent::fh_unblock>) by the constructor and needs to stay in
97	that mode.	99	that mode.
98		100
99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]	101	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
100		102
101	Try to connect to the specified host and service (port), using	103	Try to connect to the specified host and service (port), using
…		…
128	=item on_connect => $cb->($handle, $host, $port, $retry->())	130	=item on_connect => $cb->($handle, $host, $port, $retry->())
129		131
130	This callback is called when a connection has been successfully established.	132	This callback is called when a connection has been successfully established.
131		133
132	The peer's numeric host and port (the socket peername) are passed as	134	The peer's numeric host and port (the socket peername) are passed as
133	parameters, together with a retry callback.	135	parameters, together with a retry callback. At the time it is called the
		136	read and write queues, EOF status, TLS status and similar properties of
		137	the handle will have been reset.
134		138
135	If, for some reason, the handle is not acceptable, calling C<$retry>	139	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	140	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	141	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	142	callback can be invoked after the connect callback returns, i.e. one can
139	similar properties of the handle will have been reset.	143	start a handshake and then decide to retry with the next host if the
		144	handshake fails.
140		145
141	In most cases, you should ignore the C<$retry> parameter.	146	In most cases, you should ignore the C<$retry> parameter.
142		147
143	=item on_connect_error => $cb->($handle, $message)	148	=item on_connect_error => $cb->($handle, $message)
144		149
…		…
164	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In	169	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	170	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.	171	often easiest to not report C<EPIPE> errors in this callback.
167		172
168	AnyEvent::Handle tries to find an appropriate error code for you to check	173	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	174	against, but in some cases (TLS errors), this does not work well.
170	recommended to always output the C<$message> argument in human-readable	175
171	error messages (it's usually the same as C<"$!">).	176	If you report the error to the user, it is recommended to always output
		177	the C<$message> argument in human-readable error messages (you don't need
		178	to report C<"$!"> if you report C<$message>).
		179
		180	If you want to react programmatically to the error, then looking at C<$!>
		181	and comparing it against some of the documented C<Errno> values is usually
		182	better than looking at the C<$message>.
172		183
173	Non-fatal errors can be retried by returning, but it is recommended	184	Non-fatal errors can be retried by returning, but it is recommended
174	to simply ignore this parameter and instead abondon the handle object	185	to simply ignore this parameter and instead abondon the handle object
175	when this callback is invoked. Examples of non-fatal errors are timeouts	186	when this callback is invoked. Examples of non-fatal errors are timeouts
176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	187	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
…		…
224	If an EOF condition has been detected but no C<on_eof> callback has been	235	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>.	236	set, then a fatal error will be raised with C<$!> set to <0>.
226		237
227	=item on_drain => $cb->($handle)	238	=item on_drain => $cb->($handle)
228		239
229	This sets the callback that is called when the write buffer becomes empty	240	This sets the callback that is called once when the write buffer becomes
230	(or immediately if the buffer is empty already).	241	empty (and immediately when the handle object is created).
231		242
232	To append to the write buffer, use the C<< ->push_write >> method.	243	To append to the write buffer, use the C<< ->push_write >> method.
233		244
234	This callback is useful when you don't want to put all of your write data	245	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	246	into the queue at once, for example, when you want to write the contents
…		…
417	appropriate error message.	428	appropriate error message.
418		429
419	TLS mode requires Net::SSLeay to be installed (it will be loaded	430	TLS mode requires Net::SSLeay to be installed (it will be loaded
420	automatically when you try to create a TLS handle): this module doesn't	431	automatically when you try to create a TLS handle): this module doesn't
421	have a dependency on that module, so if your module requires it, you have	432	have a dependency on that module, so if your module requires it, you have
422	to add the dependency yourself.	433	to add the dependency yourself. If Net::SSLeay cannot be loaded or is too
		434	old, you get an C<EPROTO> error.
423		435
424	Unlike TCP, TLS has a server and client side: for the TLS server side, use	436	Unlike TCP, TLS has a server and client side: for the TLS server side, use
425	C<accept>, and for the TLS client side of a connection, use C<connect>	437	C<accept>, and for the TLS client side of a connection, use C<connect>
426	mode.	438	mode.
427		439
…		…
483	callback.	495	callback.
484		496
485	This callback will only be called on TLS shutdowns, not when the	497	This callback will only be called on TLS shutdowns, not when the
486	underlying handle signals EOF.	498	underlying handle signals EOF.
487		499
488	=item json => JSON or JSON::XS object	500	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
489		501
490	This is the json coder object used by the C<json> read and write types.	502	This is the json coder object used by the C<json> read and write types.
491		503
492	If you don't supply it, then AnyEvent::Handle will create and use a	504	If you don't supply it, then AnyEvent::Handle will create and use a
493	suitable one (on demand), which will write and expect UTF-8 encoded JSON	505	suitable one (on demand), which will write and expect UTF-8 encoded
		506	JSON texts (either using L<JSON::XS> or L<JSON>). The written texts are
		507	guaranteed not to contain any newline character.
		508
		509	For security reasons, this encoder will likely I<not> handle numbers and
		510	strings, only arrays and objects/hashes. The reason is that originally
		511	JSON was self-delimited, but Dougles Crockford thought it was a splendid
		512	idea to redefine JSON incompatibly, so this is no longer true.
		513
		514	For protocols that used back-to-back JSON texts, this might lead to
		515	run-ins, where two or more JSON texts will be interpreted as one JSON
494	texts.	516	text.
495		517
		518	For this reason, if the default encoder uses L<JSON::XS>, it will default
		519	to not allowing anything but arrays and objects/hashes, at least for the
		520	forseeable future (it will change at some point). This might or might not
		521	be true for the L<JSON> module, so this might cause a security issue.
		522
		523	If you depend on either behaviour, you should create your own json object
		524	and pass it in explicitly.
		525
		526	=item cbor => L<CBOR::XS> object
		527
		528	This is the cbor coder object used by the C<cbor> read and write types.
		529
		530	If you don't supply it, then AnyEvent::Handle will create and use a
		531	suitable one (on demand), which will write CBOR without using extensions,
		532	if possible.
		533
496	Note that you are responsible to depend on the JSON module if you want to	534	Note that you are responsible to depend on the L<CBOR::XS> module if you
497	use this functionality, as AnyEvent does not have a dependency itself.	535	want to use this functionality, as AnyEvent does not have a dependency on
		536	it itself.
498		537
499	=back	538	=back
500		539
501	=cut	540	=cut
502		541
…		…
574	# with AnyEvent::Handle, do them a favour.	613	# with AnyEvent::Handle, do them a favour.
575	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();	614	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
576	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"	615	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
577	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;	616	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
578		617
579	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	618	AnyEvent::fh_unblock $self->{fh};
580		619
581	$self->{_activity} =	620	$self->{_activity} =
582	$self->{_ractivity} =	621	$self->{_ractivity} =
583	$self->{_wactivity} = AE::now;	622	$self->{_wactivity} = AE::now;
584		623
…		…
716	$_[0]{oobinline} = $_[1];	755	$_[0]{oobinline} = $_[1];
717		756
718	eval {	757	eval {
719	local $SIG{__DIE__};	758	local $SIG{__DIE__};
720	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]	759	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
721	if $_[0]{fh};
722	};
723	}
724
725	=item $handle->keepalive ($boolean)
726
727	Enables or disables the C<keepalive> setting (see constructor argument of
728	the same name for details).
729
730	=cut
731
732	sub keepalive {
733	$_[0]{keepalive} = $_[1];
734
735	eval {
736	local $SIG{__DIE__};
737	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
738	if $_[0]{fh};	760	if $_[0]{fh};
739	};	761	};
740	}	762	}
741		763
742	=item $handle->on_starttls ($cb)	764	=item $handle->on_starttls ($cb)
…		…
880		902
881	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
882	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.
883		905
884	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
885	water mark, the C<on_drain> callback will be invoked.	907	water mark, the C<on_drain> callback will be invoked once.
886		908
887	=over 4	909	=over 4
888		910
889	=item $handle->on_drain ($cb)	911	=item $handle->on_drain ($cb)
890		912
…		…
934	$self->{on_drain}($self)	956	$self->{on_drain}($self)
935	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	957	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
936	&& $self->{on_drain};	958	&& $self->{on_drain};
937		959
938	delete $self->{_ww} unless length $self->{wbuf};	960	delete $self->{_ww} unless length $self->{wbuf};
939	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	961	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
940	$self->_error ($!, 1);	962	$self->_error ($!, 1);
941	}	963	}
942	};	964	};
943		965
944	# try to write data immediately	966	# try to write data immediately
…		…
1032		1054
1033	Encodes the given hash or array reference into a JSON object. Unless you	1055	Encodes the given hash or array reference into a JSON object. Unless you
1034	provide your own JSON object, this means it will be encoded to JSON text	1056	provide your own JSON object, this means it will be encoded to JSON text
1035	in UTF-8.	1057	in UTF-8.
1036		1058
		1059	The default encoder might or might not handle every type of JSON value -
		1060	it might be limited to arrays and objects for security reasons. See the
		1061	C<json> constructor attribute for more details.
		1062
1037	JSON objects (and arrays) are self-delimiting, so you can write JSON at	1063	JSON objects (and arrays) are self-delimiting, so if you only use arrays
1038	one end of a handle and read them at the other end without using any	1064	and hashes, you can write JSON at one end of a handle and read them at the
1039	additional framing.	1065	other end without using any additional framing.
1040		1066
1041	The generated JSON text is guaranteed not to contain any newlines: While	1067	The JSON text generated by the default encoder is guaranteed not to
1042	this module doesn't need delimiters after or between JSON texts to be	1068	contain any newlines: While this module doesn't need delimiters after or
1043	able to read them, many other languages depend on that.	1069	between JSON texts to be able to read them, many other languages depend on
		1070	them.
1044		1071
1045	A simple RPC protocol that interoperates easily with others is to send	1072	A simple RPC protocol that interoperates easily with other languages is
1046	JSON arrays (or objects, although arrays are usually the better choice as	1073	to send JSON arrays (or objects, although arrays are usually the better
1047	they mimic how function argument passing works) and a newline after each	1074	choice as they mimic how function argument passing works) and a newline
1048	JSON text:	1075	after each JSON text:
1049		1076
1050	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1077	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1051	$handle->push_write ("\012");	1078	$handle->push_write ("\012");
1052		1079
1053	An AnyEvent::Handle receiver would simply use the C<json> read type and	1080	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
1056	$handle->push_read (json => sub { my $array = $_[1]; ... });	1083	$handle->push_read (json => sub { my $array = $_[1]; ... });
1057		1084
1058	Other languages could read single lines terminated by a newline and pass	1085	Other languages could read single lines terminated by a newline and pass
1059	this line into their JSON decoder of choice.	1086	this line into their JSON decoder of choice.
1060		1087
		1088	=item cbor => $perl_scalar
		1089
		1090	Encodes the given scalar into a CBOR value. Unless you provide your own
		1091	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1092	using any extensions, if possible.
		1093
		1094	CBOR values are self-delimiting, so you can write CBOR at one end of
		1095	a handle and read them at the other end without using any additional
		1096	framing.
		1097
		1098	A simple nd very very fast RPC protocol that interoperates with
		1099	other languages is to send CBOR and receive CBOR values (arrays are
		1100	recommended):
		1101
		1102	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1103
		1104	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1105
		1106	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1107
1061	=cut	1108	=cut
1062		1109
1063	sub json_coder() {	1110	sub json_coder() {
1064	eval { require JSON::XS; JSON::XS->new->utf8 }	1111	eval { require JSON::XS; JSON::XS->new->utf8 }
1065	\|\| do { require JSON; JSON->new->utf8 }	1112	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1066	}	1113	}
1067		1114
1068	register_write_type json => sub {	1115	register_write_type json => sub {
1069	my ($self, $ref) = @_;	1116	my ($self, $ref) = @_;
1070		1117
1071	my $json = $self->{json} \|\|= json_coder;	1118	($self->{json} \|\|= json_coder)
1072
1073	$json->encode ($ref)	1119	->encode ($ref)
		1120	};
		1121
		1122	sub cbor_coder() {
		1123	require CBOR::XS;
		1124	CBOR::XS->new
		1125	}
		1126
		1127	register_write_type cbor => sub {
		1128	my ($self, $scalar) = @_;
		1129
		1130	($self->{cbor} \|\|= cbor_coder)
		1131	->encode ($scalar)
1074	};	1132	};
1075		1133
1076	=item storable => $reference	1134	=item storable => $reference
1077		1135
1078	Freezes the given reference using L<Storable> and writes it to the	1136	Freezes the given reference using L<Storable> and writes it to the
…		…
1081	=cut	1139	=cut
1082		1140
1083	register_write_type storable => sub {	1141	register_write_type storable => sub {
1084	my ($self, $ref) = @_;	1142	my ($self, $ref) = @_;
1085		1143
1086	require Storable;	1144	require Storable unless $Storable::VERSION;
1087		1145
1088	pack "w/a*", Storable::nfreeze ($ref)	1146	pack "w/a*", Storable::nfreeze ($ref)
1089	};	1147	};
1090		1148
1091	=back	1149	=back
…		…
1128		1186
1129	Whenever the given C<type> is used, C<push_write> will the function with	1187	Whenever the given C<type> is used, C<push_write> will the function with
1130	the handle object and the remaining arguments.	1188	the handle object and the remaining arguments.
1131		1189
1132	The function is supposed to return a single octet string that will be	1190	The function is supposed to return a single octet string that will be
1133	appended to the write buffer, so you cna mentally treat this function as a	1191	appended to the write buffer, so you can mentally treat this function as a
1134	"arguments to on-the-wire-format" converter.	1192	"arguments to on-the-wire-format" converter.
1135		1193
1136	Example: implement a custom write type C<join> that joins the remaining	1194	Example: implement a custom write type C<join> that joins the remaining
1137	arguments using the first one.	1195	arguments using the first one.
1138		1196
…		…
1432	data.	1490	data.
1433		1491
1434	Example: read 2 bytes.	1492	Example: read 2 bytes.
1435		1493
1436	$handle->push_read (chunk => 2, sub {	1494	$handle->push_read (chunk => 2, sub {
1437	AE::log debug => "yay " . unpack "H*", $_[1];	1495	say "yay " . unpack "H*", $_[1];
1438	});	1496	});
1439		1497
1440	=cut	1498	=cut
1441		1499
1442	register_read_type chunk => sub {	1500	register_read_type chunk => sub {
…		…
1472		1530
1473	register_read_type line => sub {	1531	register_read_type line => sub {
1474	my ($self, $cb, $eol) = @_;	1532	my ($self, $cb, $eol) = @_;
1475		1533
1476	if (@_ < 3) {	1534	if (@_ < 3) {
1477	# this is more than twice as fast as the generic code below	1535	# this is faster then the generic code below
1478	sub {	1536	sub {
1479	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1537	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1538	or return;
1480		1539
		1540	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1481	$cb->($_[0], $1, $2);	1541	$cb->($_[0], $str, "$1");
1482	1	1542	1
1483	}	1543	}
1484	} else {	1544	} else {
1485	$eol = quotemeta $eol unless ref $eol;	1545	$eol = quotemeta $eol unless ref $eol;
1486	$eol = qr\|^(.*?)($eol)\|s;	1546	$eol = qr\|^(.*?)($eol)\|s;
1487		1547
1488	sub {	1548	sub {
1489	$_[0]{rbuf} =~ s/$eol// or return;	1549	$_[0]{rbuf} =~ s/$eol// or return;
1490		1550
1491	$cb->($_[0], $1, $2);	1551	$cb->($_[0], "$1", "$2");
1492	1	1552	1
1493	}	1553	}
1494	}	1554	}
1495	};	1555	};
1496		1556
1497	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1557	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
1498		1558
1499	Makes a regex match against the regex object C<$accept> and returns	1559	Makes a regex match against the regex object C<$accept> and returns
1500	everything up to and including the match.	1560	everything up to and including the match. All the usual regex variables
		1561	($1, %+ etc.) from the regex match are available in the callback.
1501		1562
1502	Example: read a single line terminated by '\n'.	1563	Example: read a single line terminated by '\n'.
1503		1564
1504	$handle->push_read (regex => qr<\n>, sub { ... });	1565	$handle->push_read (regex => qr<\n>, sub { ... });
1505		1566
…		…
1649	=item json => $cb->($handle, $hash_or_arrayref)	1710	=item json => $cb->($handle, $hash_or_arrayref)
1650		1711
1651	Reads a JSON object or array, decodes it and passes it to the	1712	Reads a JSON object or array, decodes it and passes it to the
1652	callback. When a parse error occurs, an C<EBADMSG> error will be raised.	1713	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1653		1714
1654	If a C<json> object was passed to the constructor, then that will be used	1715	If a C<json> object was passed to the constructor, then that will be
1655	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1716	used for the final decode, otherwise it will create a L<JSON::XS> or
		1717	L<JSON::PP> coder object expecting UTF-8.
1656		1718
1657	This read type uses the incremental parser available with JSON version	1719	This read type uses the incremental parser available with JSON version
1658	2.09 (and JSON::XS version 2.2) and above. You have to provide a	1720	2.09 (and JSON::XS version 2.2) and above.
1659	dependency on your own: this module will load the JSON module, but
1660	AnyEvent does not depend on it itself.
1661		1721
1662	Since JSON texts are fully self-delimiting, the C<json> read and write	1722	Since JSON texts are fully self-delimiting, the C<json> read and write
1663	types are an ideal simple RPC protocol: just exchange JSON datagrams. See	1723	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1664	the C<json> write type description, above, for an actual example.	1724	the C<json> write type description, above, for an actual example.
1665		1725
…		…
1669	my ($self, $cb) = @_;	1729	my ($self, $cb) = @_;
1670		1730
1671	my $json = $self->{json} \|\|= json_coder;	1731	my $json = $self->{json} \|\|= json_coder;
1672		1732
1673	my $data;	1733	my $data;
1674	my $rbuf = \$self->{rbuf};
1675		1734
1676	sub {	1735	sub {
1677	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };	1736	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1678		1737
1679	if ($ref) {	1738	if ($ref) {
…		…
1698	()	1757	()
1699	}	1758	}
1700	}	1759	}
1701	};	1760	};
1702		1761
		1762	=item cbor => $cb->($handle, $scalar)
		1763
		1764	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1765	error occurs, an C<EBADMSG> error will be raised.
		1766
		1767	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1768	used for the final decode, otherwise it will create a CBOR coder without
		1769	enabling any options.
		1770
		1771	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1772	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1773	itself.
		1774
		1775	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1776	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1777	the C<cbor> write type description, above, for an actual example.
		1778
		1779	=cut
		1780
		1781	register_read_type cbor => sub {
		1782	my ($self, $cb) = @_;
		1783
		1784	my $cbor = $self->{cbor} \|\|= cbor_coder;
		1785
		1786	my $data;
		1787
		1788	sub {
		1789	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1790
		1791	if (@value) {
		1792	$cb->($_[0], @value);
		1793
		1794	1
		1795	} elsif ($@) {
		1796	# error case
		1797	$cbor->incr_reset;
		1798
		1799	$_[0]->_error (Errno::EBADMSG);
		1800
		1801	()
		1802	} else {
		1803	()
		1804	}
		1805	}
		1806	};
		1807
1703	=item storable => $cb->($handle, $ref)	1808	=item storable => $cb->($handle, $ref)
1704		1809
1705	Deserialises a L<Storable> frozen representation as written by the	1810	Deserialises a L<Storable> frozen representation as written by the
1706	C<storable> write type (BER-encoded length prefix followed by nfreeze'd	1811	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
1707	data).	1812	data).
…		…
1711	=cut	1816	=cut
1712		1817
1713	register_read_type storable => sub {	1818	register_read_type storable => sub {
1714	my ($self, $cb) = @_;	1819	my ($self, $cb) = @_;
1715		1820
1716	require Storable;	1821	require Storable unless $Storable::VERSION;
1717		1822
1718	sub {	1823	sub {
1719	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1824	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1720	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1825	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1721	or return;	1826	or return;
…		…
1724		1829
1725	# bypass unshift if we already have the remaining chunk	1830	# bypass unshift if we already have the remaining chunk
1726	if ($format + $len <= length $_[0]{rbuf}) {	1831	if ($format + $len <= length $_[0]{rbuf}) {
1727	my $data = substr $_[0]{rbuf}, $format, $len;	1832	my $data = substr $_[0]{rbuf}, $format, $len;
1728	substr $_[0]{rbuf}, 0, $format + $len, "";	1833	substr $_[0]{rbuf}, 0, $format + $len, "";
		1834
1729	$cb->($_[0], Storable::thaw ($data));	1835	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1836	or return $_[0]->_error (Errno::EBADMSG);
1730	} else {	1837	} else {
1731	# remove prefix	1838	# remove prefix
1732	substr $_[0]{rbuf}, 0, $format, "";	1839	substr $_[0]{rbuf}, 0, $format, "";
1733		1840
1734	# read remaining chunk	1841	# read remaining chunk
1735	$_[0]->unshift_read (chunk => $len, sub {	1842	$_[0]->unshift_read (chunk => $len, sub {
1736	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1843	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1737	$cb->($_[0], $ref);
1738	} else {
1739	$_[0]->_error (Errno::EBADMSG);	1844	or $_[0]->_error (Errno::EBADMSG);
1740	}
1741	});	1845	});
1742	}	1846	}
1743		1847
1744	1	1848	1
1745	}	1849	}
		1850	};
		1851
		1852	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1853
		1854	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1855	record without consuming anything. Only SSL version 3 or higher
		1856	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1857	SSL2-compatible framing is supported).
		1858
		1859	If it detects that the input data is likely TLS, it calls the callback
		1860	with a true value for C<$detect> and the (on-wire) TLS version as second
		1861	and third argument (C<$major> is C<3>, and C<$minor> is 0..4 for SSL
		1862	3.0, TLS 1.0, 1.1, 1.2 and 1.3, respectively). If it detects the input
		1863	to be definitely not TLS, it calls the callback with a false value for
		1864	C<$detect>.
		1865
		1866	The callback could use this information to decide whether or not to start
		1867	TLS negotiation.
		1868
		1869	In all cases the data read so far is passed to the following read
		1870	handlers.
		1871
		1872	Usually you want to use the C<tls_autostart> read type instead.
		1873
		1874	If you want to design a protocol that works in the presence of TLS
		1875	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1876	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1877	read type does are a bit more strict, but might losen in the future to
		1878	accomodate protocol changes.
		1879
		1880	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1881	L<Net::SSLeay>).
		1882
		1883	=item tls_autostart => [$tls_ctx, ]$tls
		1884
		1885	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1886	to start tls by calling C<starttls> with the given arguments.
		1887
		1888	In practice, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1889	been configured to accept, as servers do not normally send a handshake on
		1890	their own and ths cannot be detected in this way.
		1891
		1892	See C<tls_detect> above for more details.
		1893
		1894	Example: give the client a chance to start TLS before accepting a text
		1895	line.
		1896
		1897	$hdl->push_read (tls_autostart => "accept");
		1898	$hdl->push_read (line => sub {
		1899	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1900	});
		1901
		1902	=cut
		1903
		1904	register_read_type tls_detect => sub {
		1905	my ($self, $cb) = @_;
		1906
		1907	sub {
		1908	# this regex matches a full or partial tls record
		1909	if (
		1910	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1911	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1912	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1913	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1914	) {
		1915	return if 3 != length $1; # partial match, can't decide yet
		1916
		1917	# full match, valid TLS record
		1918	my ($major, $minor) = unpack "CC", $1;
		1919	$cb->($self, "accept", $major, $minor);
		1920	} else {
		1921	# mismatch == guaranteed not TLS
		1922	$cb->($self, undef);
		1923	}
		1924
		1925	1
		1926	}
		1927	};
		1928
		1929	register_read_type tls_autostart => sub {
		1930	my ($self, @tls) = @_;
		1931
		1932	$RH{tls_detect}($self, sub {
		1933	return unless $_[1];
		1934	$_[0]->starttls (@tls);
		1935	})
1746	};	1936	};
1747		1937
1748	=back	1938	=back
1749		1939
1750	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1940	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1792	some readings of the the SSL/TLS specifications basically require this	1982	some readings of the the SSL/TLS specifications basically require this
1793	attack to be working, as SSL/TLS implementations might stall sending data	1983	attack to be working, as SSL/TLS implementations might stall sending data
1794	during a rehandshake.	1984	during a rehandshake.
1795		1985
1796	As a guideline, during the initial handshake, you should not stop reading,	1986	As a guideline, during the initial handshake, you should not stop reading,
1797	and as a client, it might cause problems, depending on your applciation.	1987	and as a client, it might cause problems, depending on your application.
1798		1988
1799	=cut	1989	=cut
1800		1990
1801	sub stop_read {	1991	sub stop_read {
1802	my ($self) = @_;	1992	my ($self) = @_;
…		…
1834	} elsif (defined $len) {	2024	} elsif (defined $len) {
1835	delete $self->{_rw};	2025	delete $self->{_rw};
1836	$self->{_eof} = 1;	2026	$self->{_eof} = 1;
1837	$self->_drain_rbuf;	2027	$self->_drain_rbuf;
1838		2028
1839	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2029	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
1840	return $self->_error ($!, 1);	2030	return $self->_error ($!, 1);
1841	}	2031	}
1842	};	2032	};
1843	}	2033	}
1844	}	2034	}
…		…
1850	my ($self, $err) = @_;	2040	my ($self, $err) = @_;
1851		2041
1852	return $self->_error ($!, 1)	2042	return $self->_error ($!, 1)
1853	if $err == Net::SSLeay::ERROR_SYSCALL ();	2043	if $err == Net::SSLeay::ERROR_SYSCALL ();
1854		2044
1855	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2045	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1856		2046
1857	# reduce error string to look less scary	2047	# reduce error string to look less scary
1858	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2048	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1859		2049
1860	if ($self->{_on_starttls}) {	2050	if ($self->{_on_starttls}) {
…		…
1866	}	2056	}
1867	}	2057	}
1868		2058
1869	# poll the write BIO and send the data if applicable	2059	# poll the write BIO and send the data if applicable
1870	# also decode read data if possible	2060	# also decode read data if possible
1871	# this is basiclaly our TLS state machine	2061	# this is basically our TLS state machine
1872	# more efficient implementations are possible with openssl,	2062	# more efficient implementations are possible with openssl,
1873	# but not with the buggy and incomplete Net::SSLeay.	2063	# but not with the buggy and incomplete Net::SSLeay.
1874	sub _dotls {	2064	sub _dotls {
1875	my ($self) = @_;	2065	my ($self) = @_;
1876		2066
1877	my $tmp;	2067	my $tmp;
1878		2068
1879	if (length $self->{_tls_wbuf}) {	2069	while (length $self->{_tls_wbuf}) {
1880	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2070	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1881	substr $self->{_tls_wbuf}, 0, $tmp, "";	2071	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2072
		2073	return $self->_tls_error ($tmp)
		2074	if $tmp != $ERROR_WANT_READ
		2075	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		2076
		2077	last;
1882	}	2078	}
1883		2079
1884	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2080	substr $self->{_tls_wbuf}, 0, $tmp, "";
1885	return $self->_tls_error ($tmp)
1886	if $tmp != $ERROR_WANT_READ
1887	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1888	}	2081	}
1889		2082
1890	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2083	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1891	unless (length $tmp) {	2084	unless (length $tmp) {
1892	$self->{_on_starttls}	2085	$self->{_on_starttls}
…		…
1906	$self->{_tls_rbuf} .= $tmp;	2099	$self->{_tls_rbuf} .= $tmp;
1907	$self->_drain_rbuf;	2100	$self->_drain_rbuf;
1908	$self->{tls} or return; # tls session might have gone away in callback	2101	$self->{tls} or return; # tls session might have gone away in callback
1909	}	2102	}
1910		2103
1911	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	2104	$tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us
1912	return $self->_tls_error ($tmp)	2105	return $self->_tls_error ($tmp)
1913	if $tmp != $ERROR_WANT_READ	2106	if $tmp != $ERROR_WANT_READ
1914	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2107	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1915		2108
1916	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2109	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1926		2119
1927	=item $handle->starttls ($tls[, $tls_ctx])	2120	=item $handle->starttls ($tls[, $tls_ctx])
1928		2121
1929	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2122	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1930	object is created, you can also do that at a later time by calling	2123	object is created, you can also do that at a later time by calling
1931	C<starttls>.	2124	C<starttls>. See the C<tls> constructor argument for general info.
1932		2125
1933	Starting TLS is currently an asynchronous operation - when you push some	2126	Starting TLS is currently an asynchronous operation - when you push some
1934	write data and then call C<< ->starttls >> then TLS negotiation will start	2127	write data and then call C<< ->starttls >> then TLS negotiation will start
1935	immediately, after which the queued write data is then sent.	2128	immediately, after which the queued write data is then sent. This might
		2129	change in future versions, so best make sure you have no outstanding write
		2130	data when calling this method.
1936		2131
1937	The first argument is the same as the C<tls> constructor argument (either	2132	The first argument is the same as the C<tls> constructor argument (either
1938	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2133	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1939		2134
1940	The second argument is the optional C<AnyEvent::TLS> object that is used	2135	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1962	my ($self, $tls, $ctx) = @_;	2157	my ($self, $tls, $ctx) = @_;
1963		2158
1964	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2159	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1965	if $self->{tls};	2160	if $self->{tls};
1966		2161
		2162	unless (defined $AnyEvent::TLS::VERSION) {
		2163	eval {
		2164	require Net::SSLeay;
		2165	require AnyEvent::TLS;
		2166	1
		2167	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2168	}
		2169
1967	$self->{tls} = $tls;	2170	$self->{tls} = $tls;
1968	$self->{tls_ctx} = $ctx if @_ > 2;	2171	$self->{tls_ctx} = $ctx if @_ > 2;
1969		2172
1970	return unless $self->{fh};	2173	return unless $self->{fh};
1971		2174
1972	require Net::SSLeay;
1973
1974	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2175	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1975	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2176	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1976		2177
1977	$tls = delete $self->{tls};	2178	$tls = delete $self->{tls};
1978	$ctx = $self->{tls_ctx};	2179	$ctx = $self->{tls_ctx};
1979		2180
1980	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2181	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1981		2182
1982	if ("HASH" eq ref $ctx) {	2183	if ("HASH" eq ref $ctx) {
1983	require AnyEvent::TLS;
1984
1985	if ($ctx->{cache}) {	2184	if ($ctx->{cache}) {
1986	my $key = $ctx+0;	2185	my $key = $ctx+0;
1987	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2186	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1988	} else {	2187	} else {
1989	$ctx = new AnyEvent::TLS %$ctx;	2188	$ctx = new AnyEvent::TLS %$ctx;
…		…
1994	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});	2193	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1995		2194
1996	# basically, this is deep magic (because SSL_read should have the same issues)	2195	# basically, this is deep magic (because SSL_read should have the same issues)
1997	# but the openssl maintainers basically said: "trust us, it just works".	2196	# but the openssl maintainers basically said: "trust us, it just works".
1998	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	2197	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1999	# and mismaintained ssleay-module doesn't even offer them).	2198	# and mismaintained ssleay-module didn't offer them for a decade or so).
2000	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	2199	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
2001	#	2200	#
2002	# in short: this is a mess.	2201	# in short: this is a mess.
2003	#	2202	#
2004	# note that we do not try to keep the length constant between writes as we are required to do.	2203	# note that we do not try to keep the length constant between writes as we are required to do.
2005	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	2204	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
2006	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	2205	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
2007	# have identity issues in that area.	2206	# have identity issues in that area.
2008	# Net::SSLeay::CTX_set_mode ($ssl,	2207	# Net::SSLeay::set_mode ($ssl,
2009	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	2208	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
2010	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	2209	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
2011	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2210	Net::SSLeay::set_mode ($tls, 1\|2);
2012		2211
2013	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2212	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
2014	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2213	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
2015		2214
2016	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});	2215	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
…		…
2056		2255
2057	return unless $self->{tls};	2256	return unless $self->{tls};
2058		2257
2059	$self->{tls_ctx}->_put_session (delete $self->{tls})	2258	$self->{tls_ctx}->_put_session (delete $self->{tls})
2060	if $self->{tls} > 0;	2259	if $self->{tls} > 0;
2061		2260
2062	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2261	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
2063	}	2262	}
2064		2263
2065	=item $handle->resettls	2264	=item $handle->resettls
2066		2265
…		…
2091	push @linger, AE::io $fh, 1, sub {	2290	push @linger, AE::io $fh, 1, sub {
2092	my $len = syswrite $fh, $wbuf, length $wbuf;	2291	my $len = syswrite $fh, $wbuf, length $wbuf;
2093		2292
2094	if ($len > 0) {	2293	if ($len > 0) {
2095	substr $wbuf, 0, $len, "";	2294	substr $wbuf, 0, $len, "";
2096	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {	2295	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) {
2097	@linger = (); # end	2296	@linger = (); # end
2098	}	2297	}
2099	};	2298	};
2100	push @linger, AE::timer $linger, 0, sub {	2299	push @linger, AE::timer $linger, 0, sub {
2101	@linger = ();	2300	@linger = ();
…		…
2204	Probably because your C<on_error> callback is being called instead: When	2403	Probably because your C<on_error> callback is being called instead: When
2205	you have outstanding requests in your read queue, then an EOF is	2404	you have outstanding requests in your read queue, then an EOF is
2206	considered an error as you clearly expected some data.	2405	considered an error as you clearly expected some data.
2207		2406
2208	To avoid this, make sure you have an empty read queue whenever your handle	2407	To avoid this, make sure you have an empty read queue whenever your handle
2209	is supposed to be "idle" (i.e. connection closes are O.K.). You cna set	2408	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
2210	an C<on_read> handler that simply pushes the first read requests in the	2409	an C<on_read> handler that simply pushes the first read requests in the
2211	queue.	2410	queue.
2212		2411
2213	See also the next question, which explains this in a bit more detail.	2412	See also the next question, which explains this in a bit more detail.
2214		2413
…		…
2222	handles requests until the server gets some QUIT command, causing it to	2421	handles requests until the server gets some QUIT command, causing it to
2223	close the connection first (highly desirable for a busy TCP server). A	2422	close the connection first (highly desirable for a busy TCP server). A
2224	client dropping the connection is an error, which means this variant can	2423	client dropping the connection is an error, which means this variant can
2225	detect an unexpected detection close.	2424	detect an unexpected detection close.
2226		2425
2227	To handle this case, always make sure you have a on-empty read queue, by	2426	To handle this case, always make sure you have a non-empty read queue, by
2228	pushing the "read request start" handler on it:	2427	pushing the "read request start" handler on it:
2229		2428
2230	# we assume a request starts with a single line	2429	# we assume a request starts with a single line
2231	my @start_request; @start_request = (line => sub {	2430	my @start_request; @start_request = (line => sub {
2232	my ($hdl, $line) = @_;	2431	my ($hdl, $line) = @_;
…		…
2245	some data and raises the C<EPIPE> error when the connction is dropped	2444	some data and raises the C<EPIPE> error when the connction is dropped
2246	unexpectedly.	2445	unexpectedly.
2247		2446
2248	The second variant is a protocol where the client can drop the connection	2447	The second variant is a protocol where the client can drop the connection
2249	at any time. For TCP, this means that the server machine may run out of	2448	at any time. For TCP, this means that the server machine may run out of
2250	sockets easier, and in general, it means you cnanot distinguish a protocl	2449	sockets easier, and in general, it means you cannot distinguish a protocl
2251	failure/client crash from a normal connection close. Nevertheless, these	2450	failure/client crash from a normal connection close. Nevertheless, these
2252	kinds of protocols are common (and sometimes even the best solution to the	2451	kinds of protocols are common (and sometimes even the best solution to the
2253	problem).	2452	problem).
2254		2453
2255	Having an outstanding read request at all times is possible if you ignore	2454	Having an outstanding read request at all times is possible if you ignore
…		…
2330	C<low_water_mark> this will be called precisely when all data has been	2529	C<low_water_mark> this will be called precisely when all data has been
2331	written to the socket:	2530	written to the socket:
2332		2531
2333	$handle->push_write (...);	2532	$handle->push_write (...);
2334	$handle->on_drain (sub {	2533	$handle->on_drain (sub {
2335	AE::log debug => "all data submitted to the kernel\n";	2534	AE::log debug => "All data submitted to the kernel.";
2336	undef $handle;	2535	undef $handle;
2337	});	2536	});
2338		2537
2339	If you just want to queue some data and then signal EOF to the other side,	2538	If you just want to queue some data and then signal EOF to the other side,
2340	consider using C<< ->push_shutdown >> instead.	2539	consider using C<< ->push_shutdown >> instead.
…		…
2424	When you have intermediate CA certificates that your clients might not	2623	When you have intermediate CA certificates that your clients might not
2425	know about, just append them to the C<cert_file>.	2624	know about, just append them to the C<cert_file>.
2426		2625
2427	=back	2626	=back
2428		2627
2429
2430	=head1 SUBCLASSING AnyEvent::Handle	2628	=head1 SUBCLASSING AnyEvent::Handle
2431		2629
2432	In many cases, you might want to subclass AnyEvent::Handle.	2630	In many cases, you might want to subclass AnyEvent::Handle.
2433		2631
2434	To make this easier, a given version of AnyEvent::Handle uses these	2632	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2460		2658
2461	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2659	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2462		2660
2463	=cut	2661	=cut
2464		2662
2465	1; # End of AnyEvent::Handle	2663	1
		2664

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.222 by root, Thu Aug 25 03:08:48 2011 UTC vs. Revision 1.254 by root, Mon Feb 10 11:34:13 2020 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.222 by root, Thu Aug 25 03:08:48 2011 UTC vs.
Revision 1.254 by root, Mon Feb 10 11:34:13 2020 UTC