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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.214 by root, Sun Jan 16 17:12:27 2011 UTC vs.
Revision 1.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	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
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
…		…
247	many seconds pass without a successful read or write on the underlying	258	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	259	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>	260	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
250	error will be raised).	261	error will be raised).
251		262
252	There are three variants of the timeouts that work independently	263	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:	264	other, for both read and write (triggered when nothing was read I<OR>
		265	written), just read (triggered when nothing was read), and just write:
254	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks	266	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
255	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions	267	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
256	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.	268	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
257		269
258	Note that timeout processing is active even when you do not have	270	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	271	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	272	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	273	timeout in the corresponding C<on_timeout> callback, in which case
262	restart the timeout.	274	AnyEvent::Handle will simply restart the timeout.
263		275
264	Zero (the default) disables this timeout.	276	Zero (the default) disables the corresponding timeout.
265		277
266	=item on_timeout => $cb->($handle)	278	=item on_timeout => $cb->($handle)
		279
		280	=item on_rtimeout => $cb->($handle)
		281
		282	=item on_wtimeout => $cb->($handle)
267		283
268	Called whenever the inactivity timeout passes. If you return from this	284	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,	285	callback, then the timeout will be reset as if some activity had happened,
270	so this condition is not fatal in any way.	286	so this condition is not fatal in any way.
271		287
…		…
354	already have occured on BSD systems), but at least it will protect you	370	already have occured on BSD systems), but at least it will protect you
355	from most attacks.	371	from most attacks.
356		372
357	=item read_size => <bytes>	373	=item read_size => <bytes>
358		374
359	The initial read block size, the number of bytes this module will try to	375	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	376	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	377	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>.	378	handling many connections watch out for memory requirements). See also
		379	C<max_read_size>. Default: C<2048>.
363		380
364	=item max_read_size => <bytes>	381	=item max_read_size => <bytes>
365		382
366	The maximum read buffer size used by the dynamic adjustment	383	The maximum read buffer size used by the dynamic adjustment
367	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in	384	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
…		…
411	appropriate error message.	428	appropriate error message.
412		429
413	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
414	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
415	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
416	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.
417		435
418	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
419	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>
420	mode.	438	mode.
421		439
…		…
477	callback.	495	callback.
478		496
479	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
480	underlying handle signals EOF.	498	underlying handle signals EOF.
481		499
482	=item json => JSON or JSON::XS object	500	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
483		501
484	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.
485		503
486	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
487	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
488	texts.	516	text.
489		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
490	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
491	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.
492		537
493	=back	538	=back
494		539
495	=cut	540	=cut
496		541
…		…
536	});	581	});
537		582
538	} else {	583	} else {
539	if ($self->{on_connect_error}) {	584	if ($self->{on_connect_error}) {
540	$self->{on_connect_error}($self, "$!");	585	$self->{on_connect_error}($self, "$!");
541	$self->destroy;	586	$self->destroy if $self;
542	} else {	587	} else {
543	$self->_error ($!, 1);	588	$self->_error ($!, 1);
544	}	589	}
545	}	590	}
546	},	591	},
…		…
568	# with AnyEvent::Handle, do them a favour.	613	# with AnyEvent::Handle, do them a favour.
569	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();	614	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
570	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!"
571	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;	616	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
572		617
573	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	618	AnyEvent::fh_unblock $self->{fh};
574		619
575	$self->{_activity} =	620	$self->{_activity} =
576	$self->{_ractivity} =	621	$self->{_ractivity} =
577	$self->{_wactivity} = AE::now;	622	$self->{_wactivity} = AE::now;
578		623
…		…
714	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]	759	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
715	if $_[0]{fh};	760	if $_[0]{fh};
716	};	761	};
717	}	762	}
718		763
719	=item $handle->keepalive ($boolean)
720
721	Enables or disables the C<keepalive> setting (see constructor argument of
722	the same name for details).
723
724	=cut
725
726	sub keepalive {
727	$_[0]{keepalive} = $_[1];
728
729	eval {
730	local $SIG{__DIE__};
731	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
732	if $_[0]{fh};
733	};
734	}
735
736	=item $handle->on_starttls ($cb)	764	=item $handle->on_starttls ($cb)
737		765
738	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).	766	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
739		767
740	=cut	768	=cut
…		…
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
…		…
925	$self->{on_drain}($self)	956	$self->{on_drain}($self)
926	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})
927	&& $self->{on_drain};	958	&& $self->{on_drain};
928		959
929	delete $self->{_ww} unless length $self->{wbuf};	960	delete $self->{_ww} unless length $self->{wbuf};
930	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	961	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
931	$self->_error ($!, 1);	962	$self->_error ($!, 1);
932	}	963	}
933	};	964	};
934		965
935	# try to write data immediately	966	# try to write data immediately
…		…
1023		1054
1024	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
1025	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
1026	in UTF-8.	1057	in UTF-8.
1027		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
1028	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
1029	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
1030	additional framing.	1065	other end without using any additional framing.
1031		1066
1032	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
1033	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
1034	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.
1035		1071
1036	A simple RPC protocol that interoperates easily with others is to send	1072	A simple RPC protocol that interoperates easily with other languages is
1037	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
1038	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
1039	JSON text:	1075	after each JSON text:
1040		1076
1041	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1077	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1042	$handle->push_write ("\012");	1078	$handle->push_write ("\012");
1043		1079
1044	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
…		…
1047	$handle->push_read (json => sub { my $array = $_[1]; ... });	1083	$handle->push_read (json => sub { my $array = $_[1]; ... });
1048		1084
1049	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
1050	this line into their JSON decoder of choice.	1086	this line into their JSON decoder of choice.
1051		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
1052	=cut	1108	=cut
1053		1109
1054	sub json_coder() {	1110	sub json_coder() {
1055	eval { require JSON::XS; JSON::XS->new->utf8 }	1111	eval { require JSON::XS; JSON::XS->new->utf8 }
1056	\|\| do { require JSON; JSON->new->utf8 }	1112	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1057	}	1113	}
1058		1114
1059	register_write_type json => sub {	1115	register_write_type json => sub {
1060	my ($self, $ref) = @_;	1116	my ($self, $ref) = @_;
1061		1117
1062	my $json = $self->{json} \|\|= json_coder;	1118	($self->{json} \|\|= json_coder)
1063
1064	$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)
1065	};	1132	};
1066		1133
1067	=item storable => $reference	1134	=item storable => $reference
1068		1135
1069	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
…		…
1072	=cut	1139	=cut
1073		1140
1074	register_write_type storable => sub {	1141	register_write_type storable => sub {
1075	my ($self, $ref) = @_;	1142	my ($self, $ref) = @_;
1076		1143
1077	require Storable;	1144	require Storable unless $Storable::VERSION;
1078		1145
1079	pack "w/a*", Storable::nfreeze ($ref)	1146	pack "w/a*", Storable::nfreeze ($ref)
1080	};	1147	};
1081		1148
1082	=back	1149	=back
…		…
1119		1186
1120	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
1121	the handle object and the remaining arguments.	1188	the handle object and the remaining arguments.
1122		1189
1123	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
1124	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
1125	"arguments to on-the-wire-format" converter.	1192	"arguments to on-the-wire-format" converter.
1126		1193
1127	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
1128	arguments using the first one.	1195	arguments using the first one.
1129		1196
…		…
1423	data.	1490	data.
1424		1491
1425	Example: read 2 bytes.	1492	Example: read 2 bytes.
1426		1493
1427	$handle->push_read (chunk => 2, sub {	1494	$handle->push_read (chunk => 2, sub {
1428	warn "yay ", unpack "H*", $_[1];	1495	say "yay " . unpack "H*", $_[1];
1429	});	1496	});
1430		1497
1431	=cut	1498	=cut
1432		1499
1433	register_read_type chunk => sub {	1500	register_read_type chunk => sub {
…		…
1463		1530
1464	register_read_type line => sub {	1531	register_read_type line => sub {
1465	my ($self, $cb, $eol) = @_;	1532	my ($self, $cb, $eol) = @_;
1466		1533
1467	if (@_ < 3) {	1534	if (@_ < 3) {
1468	# this is more than twice as fast as the generic code below	1535	# this is faster then the generic code below
1469	sub {	1536	sub {
1470	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1537	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1538	or return;
1471		1539
		1540	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1472	$cb->($_[0], $1, $2);	1541	$cb->($_[0], $str, "$1");
1473	1	1542	1
1474	}	1543	}
1475	} else {	1544	} else {
1476	$eol = quotemeta $eol unless ref $eol;	1545	$eol = quotemeta $eol unless ref $eol;
1477	$eol = qr\|^(.*?)($eol)\|s;	1546	$eol = qr\|^(.*?)($eol)\|s;
1478		1547
1479	sub {	1548	sub {
1480	$_[0]{rbuf} =~ s/$eol// or return;	1549	$_[0]{rbuf} =~ s/$eol// or return;
1481		1550
1482	$cb->($_[0], $1, $2);	1551	$cb->($_[0], "$1", "$2");
1483	1	1552	1
1484	}	1553	}
1485	}	1554	}
1486	};	1555	};
1487		1556
1488	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1557	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
1489		1558
1490	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
1491	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.
1492		1562
1493	Example: read a single line terminated by '\n'.	1563	Example: read a single line terminated by '\n'.
1494		1564
1495	$handle->push_read (regex => qr<\n>, sub { ... });	1565	$handle->push_read (regex => qr<\n>, sub { ... });
1496		1566
…		…
1535		1605
1536	sub {	1606	sub {
1537	# accept	1607	# accept
1538	if ($$rbuf =~ $accept) {	1608	if ($$rbuf =~ $accept) {
1539	$data .= substr $$rbuf, 0, $+[0], "";	1609	$data .= substr $$rbuf, 0, $+[0], "";
1540	$cb->($self, $data);	1610	$cb->($_[0], $data);
1541	return 1;	1611	return 1;
1542	}	1612	}
1543		1613
1544	# reject	1614	# reject
1545	if ($reject && $$rbuf =~ $reject) {	1615	if ($reject && $$rbuf =~ $reject) {
1546	$self->_error (Errno::EBADMSG);	1616	$_[0]->_error (Errno::EBADMSG);
1547	}	1617	}
1548		1618
1549	# skip	1619	# skip
1550	if ($skip && $$rbuf =~ $skip) {	1620	if ($skip && $$rbuf =~ $skip) {
1551	$data .= substr $$rbuf, 0, $+[0], "";	1621	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1567	my ($self, $cb) = @_;	1637	my ($self, $cb) = @_;
1568		1638
1569	sub {	1639	sub {
1570	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1640	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1571	if ($_[0]{rbuf} =~ /[^0-9]/) {	1641	if ($_[0]{rbuf} =~ /[^0-9]/) {
1572	$self->_error (Errno::EBADMSG);	1642	$_[0]->_error (Errno::EBADMSG);
1573	}	1643	}
1574	return;	1644	return;
1575	}	1645	}
1576		1646
1577	my $len = $1;	1647	my $len = $1;
1578		1648
1579	$self->unshift_read (chunk => $len, sub {	1649	$_[0]->unshift_read (chunk => $len, sub {
1580	my $string = $_[1];	1650	my $string = $_[1];
1581	$_[0]->unshift_read (chunk => 1, sub {	1651	$_[0]->unshift_read (chunk => 1, sub {
1582	if ($_[1] eq ",") {	1652	if ($_[1] eq ",") {
1583	$cb->($_[0], $string);	1653	$cb->($_[0], $string);
1584	} else {	1654	} else {
1585	$self->_error (Errno::EBADMSG);	1655	$_[0]->_error (Errno::EBADMSG);
1586	}	1656	}
1587	});	1657	});
1588	});	1658	});
1589		1659
1590	1	1660	1
…		…
1640	=item json => $cb->($handle, $hash_or_arrayref)	1710	=item json => $cb->($handle, $hash_or_arrayref)
1641		1711
1642	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
1643	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.
1644		1714
1645	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
1646	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.
1647		1718
1648	This read type uses the incremental parser available with JSON version	1719	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	1720	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		1721
1653	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
1654	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
1655	the C<json> write type description, above, for an actual example.	1724	the C<json> write type description, above, for an actual example.
1656		1725
…		…
1660	my ($self, $cb) = @_;	1729	my ($self, $cb) = @_;
1661		1730
1662	my $json = $self->{json} \|\|= json_coder;	1731	my $json = $self->{json} \|\|= json_coder;
1663		1732
1664	my $data;	1733	my $data;
1665	my $rbuf = \$self->{rbuf};
1666		1734
1667	sub {	1735	sub {
1668	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1736	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1669		1737
1670	if ($ref) {	1738	if ($ref) {
1671	$self->{rbuf} = $json->incr_text;	1739	$_[0]{rbuf} = $json->incr_text;
1672	$json->incr_text = "";	1740	$json->incr_text = "";
1673	$cb->($self, $ref);	1741	$cb->($_[0], $ref);
1674		1742
1675	1	1743	1
1676	} elsif ($@) {	1744	} elsif ($@) {
1677	# error case	1745	# error case
1678	$json->incr_skip;	1746	$json->incr_skip;
1679		1747
1680	$self->{rbuf} = $json->incr_text;	1748	$_[0]{rbuf} = $json->incr_text;
1681	$json->incr_text = "";	1749	$json->incr_text = "";
1682		1750
1683	$self->_error (Errno::EBADMSG);	1751	$_[0]->_error (Errno::EBADMSG);
1684		1752
1685	()	1753	()
1686	} else {	1754	} else {
1687	$self->{rbuf} = "";	1755	$_[0]{rbuf} = "";
1688		1756
		1757	()
		1758	}
		1759	}
		1760	};
		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 {
1689	()	1803	()
1690	}	1804	}
1691	}	1805	}
1692	};	1806	};
1693		1807
…		…
1702	=cut	1816	=cut
1703		1817
1704	register_read_type storable => sub {	1818	register_read_type storable => sub {
1705	my ($self, $cb) = @_;	1819	my ($self, $cb) = @_;
1706		1820
1707	require Storable;	1821	require Storable unless $Storable::VERSION;
1708		1822
1709	sub {	1823	sub {
1710	# 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
1711	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1825	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1712	or return;	1826	or return;
…		…
1715		1829
1716	# bypass unshift if we already have the remaining chunk	1830	# bypass unshift if we already have the remaining chunk
1717	if ($format + $len <= length $_[0]{rbuf}) {	1831	if ($format + $len <= length $_[0]{rbuf}) {
1718	my $data = substr $_[0]{rbuf}, $format, $len;	1832	my $data = substr $_[0]{rbuf}, $format, $len;
1719	substr $_[0]{rbuf}, 0, $format + $len, "";	1833	substr $_[0]{rbuf}, 0, $format + $len, "";
		1834
1720	$cb->($_[0], Storable::thaw ($data));	1835	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1836	or return $_[0]->_error (Errno::EBADMSG);
1721	} else {	1837	} else {
1722	# remove prefix	1838	# remove prefix
1723	substr $_[0]{rbuf}, 0, $format, "";	1839	substr $_[0]{rbuf}, 0, $format, "";
1724		1840
1725	# read remaining chunk	1841	# read remaining chunk
1726	$_[0]->unshift_read (chunk => $len, sub {	1842	$_[0]->unshift_read (chunk => $len, sub {
1727	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1843	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1728	$cb->($_[0], $ref);
1729	} else {
1730	$self->_error (Errno::EBADMSG);	1844	or $_[0]->_error (Errno::EBADMSG);
1731	}
1732	});	1845	});
1733	}	1846	}
1734		1847
1735	1	1848	1
1736	}	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	})
1737	};	1936	};
1738		1937
1739	=back	1938	=back
1740		1939
1741	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1940	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1783	some readings of the the SSL/TLS specifications basically require this	1982	some readings of the the SSL/TLS specifications basically require this
1784	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
1785	during a rehandshake.	1984	during a rehandshake.
1786		1985
1787	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,
1788	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.
1789		1988
1790	=cut	1989	=cut
1791		1990
1792	sub stop_read {	1991	sub stop_read {
1793	my ($self) = @_;	1992	my ($self) = @_;
…		…
1825	} elsif (defined $len) {	2024	} elsif (defined $len) {
1826	delete $self->{_rw};	2025	delete $self->{_rw};
1827	$self->{_eof} = 1;	2026	$self->{_eof} = 1;
1828	$self->_drain_rbuf;	2027	$self->_drain_rbuf;
1829		2028
1830	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2029	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
1831	return $self->_error ($!, 1);	2030	return $self->_error ($!, 1);
1832	}	2031	}
1833	};	2032	};
1834	}	2033	}
1835	}	2034	}
…		…
1841	my ($self, $err) = @_;	2040	my ($self, $err) = @_;
1842		2041
1843	return $self->_error ($!, 1)	2042	return $self->_error ($!, 1)
1844	if $err == Net::SSLeay::ERROR_SYSCALL ();	2043	if $err == Net::SSLeay::ERROR_SYSCALL ();
1845		2044
1846	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 ());
1847		2046
1848	# reduce error string to look less scary	2047	# reduce error string to look less scary
1849	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2048	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1850		2049
1851	if ($self->{_on_starttls}) {	2050	if ($self->{_on_starttls}) {
…		…
1857	}	2056	}
1858	}	2057	}
1859		2058
1860	# poll the write BIO and send the data if applicable	2059	# poll the write BIO and send the data if applicable
1861	# also decode read data if possible	2060	# also decode read data if possible
1862	# this is basiclaly our TLS state machine	2061	# this is basically our TLS state machine
1863	# more efficient implementations are possible with openssl,	2062	# more efficient implementations are possible with openssl,
1864	# but not with the buggy and incomplete Net::SSLeay.	2063	# but not with the buggy and incomplete Net::SSLeay.
1865	sub _dotls {	2064	sub _dotls {
1866	my ($self) = @_;	2065	my ($self) = @_;
1867		2066
1868	my $tmp;	2067	my $tmp;
1869		2068
1870	if (length $self->{_tls_wbuf}) {	2069	while (length $self->{_tls_wbuf}) {
1871	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2070	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1872	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;
1873	}	2078	}
1874		2079
1875	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2080	substr $self->{_tls_wbuf}, 0, $tmp, "";
1876	return $self->_tls_error ($tmp)
1877	if $tmp != $ERROR_WANT_READ
1878	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1879	}	2081	}
1880		2082
1881	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2083	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1882	unless (length $tmp) {	2084	unless (length $tmp) {
1883	$self->{_on_starttls}	2085	$self->{_on_starttls}
…		…
1897	$self->{_tls_rbuf} .= $tmp;	2099	$self->{_tls_rbuf} .= $tmp;
1898	$self->_drain_rbuf;	2100	$self->_drain_rbuf;
1899	$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
1900	}	2102	}
1901		2103
1902	$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
1903	return $self->_tls_error ($tmp)	2105	return $self->_tls_error ($tmp)
1904	if $tmp != $ERROR_WANT_READ	2106	if $tmp != $ERROR_WANT_READ
1905	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2107	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1906		2108
1907	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2109	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1917		2119
1918	=item $handle->starttls ($tls[, $tls_ctx])	2120	=item $handle->starttls ($tls[, $tls_ctx])
1919		2121
1920	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2122	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1921	object is created, you can also do that at a later time by calling	2123	object is created, you can also do that at a later time by calling
1922	C<starttls>.	2124	C<starttls>. See the C<tls> constructor argument for general info.
1923		2125
1924	Starting TLS is currently an asynchronous operation - when you push some	2126	Starting TLS is currently an asynchronous operation - when you push some
1925	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
1926	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.
1927		2131
1928	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
1929	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2133	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1930		2134
1931	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
…		…
1953	my ($self, $tls, $ctx) = @_;	2157	my ($self, $tls, $ctx) = @_;
1954		2158
1955	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"
1956	if $self->{tls};	2160	if $self->{tls};
1957		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
1958	$self->{tls} = $tls;	2170	$self->{tls} = $tls;
1959	$self->{tls_ctx} = $ctx if @_ > 2;	2171	$self->{tls_ctx} = $ctx if @_ > 2;
1960		2172
1961	return unless $self->{fh};	2173	return unless $self->{fh};
1962		2174
1963	require Net::SSLeay;
1964
1965	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2175	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1966	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2176	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1967		2177
1968	$tls = delete $self->{tls};	2178	$tls = delete $self->{tls};
1969	$ctx = $self->{tls_ctx};	2179	$ctx = $self->{tls_ctx};
1970		2180
1971	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
1972		2182
1973	if ("HASH" eq ref $ctx) {	2183	if ("HASH" eq ref $ctx) {
1974	require AnyEvent::TLS;
1975
1976	if ($ctx->{cache}) {	2184	if ($ctx->{cache}) {
1977	my $key = $ctx+0;	2185	my $key = $ctx+0;
1978	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2186	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1979	} else {	2187	} else {
1980	$ctx = new AnyEvent::TLS %$ctx;	2188	$ctx = new AnyEvent::TLS %$ctx;
…		…
1985	$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});
1986		2194
1987	# 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)
1988	# but the openssl maintainers basically said: "trust us, it just works".	2196	# but the openssl maintainers basically said: "trust us, it just works".
1989	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	2197	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1990	# and mismaintained ssleay-module doesn't even offer them).	2198	# and mismaintained ssleay-module didn't offer them for a decade or so).
1991	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	2199	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1992	#	2200	#
1993	# in short: this is a mess.	2201	# in short: this is a mess.
1994	#	2202	#
1995	# 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.
1996	# 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,
1997	# 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
1998	# have identity issues in that area.	2206	# have identity issues in that area.
1999	# Net::SSLeay::CTX_set_mode ($ssl,	2207	# Net::SSLeay::set_mode ($ssl,
2000	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	2208	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
2001	# \| (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));
2002	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2210	Net::SSLeay::set_mode ($tls, 1\|2);
2003		2211
2004	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2212	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
2005	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2213	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
2006		2214
2007	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2215	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2216	$self->{rbuf} = "";
2008		2217
2009	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2218	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
2010		2219
2011	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2220	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
2012	if $self->{on_starttls};	2221	if $self->{on_starttls};
…		…
2046		2255
2047	return unless $self->{tls};	2256	return unless $self->{tls};
2048		2257
2049	$self->{tls_ctx}->_put_session (delete $self->{tls})	2258	$self->{tls_ctx}->_put_session (delete $self->{tls})
2050	if $self->{tls} > 0;	2259	if $self->{tls} > 0;
2051		2260
2052	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2261	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
2053	}	2262	}
		2263
		2264	=item $handle->resettls
		2265
		2266	This rarely-used method simply resets and TLS state on the handle, usually
		2267	causing data loss.
		2268
		2269	One case where it may be useful is when you want to skip over the data in
		2270	the stream but you are not interested in interpreting it, so data loss is
		2271	no concern.
		2272
		2273	=cut
		2274
		2275	*resettls = \&_freetls;
2054		2276
2055	sub DESTROY {	2277	sub DESTROY {
2056	my ($self) = @_;	2278	my ($self) = @_;
2057		2279
2058	&_freetls;	2280	&_freetls;
…		…
2068	push @linger, AE::io $fh, 1, sub {	2290	push @linger, AE::io $fh, 1, sub {
2069	my $len = syswrite $fh, $wbuf, length $wbuf;	2291	my $len = syswrite $fh, $wbuf, length $wbuf;
2070		2292
2071	if ($len > 0) {	2293	if ($len > 0) {
2072	substr $wbuf, 0, $len, "";	2294	substr $wbuf, 0, $len, "";
2073	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {	2295	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) {
2074	@linger = (); # end	2296	@linger = (); # end
2075	}	2297	}
2076	};	2298	};
2077	push @linger, AE::timer $linger, 0, sub {	2299	push @linger, AE::timer $linger, 0, sub {
2078	@linger = ();	2300	@linger = ();
…		…
2181	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
2182	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
2183	considered an error as you clearly expected some data.	2405	considered an error as you clearly expected some data.
2184		2406
2185	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
2186	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
2187	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
2188	queue.	2410	queue.
2189		2411
2190	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.
2191		2413
…		…
2199	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
2200	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
2201	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
2202	detect an unexpected detection close.	2424	detect an unexpected detection close.
2203		2425
2204	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
2205	pushing the "read request start" handler on it:	2427	pushing the "read request start" handler on it:
2206		2428
2207	# we assume a request starts with a single line	2429	# we assume a request starts with a single line
2208	my @start_request; @start_request = (line => sub {	2430	my @start_request; @start_request = (line => sub {
2209	my ($hdl, $line) = @_;	2431	my ($hdl, $line) = @_;
…		…
2222	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
2223	unexpectedly.	2445	unexpectedly.
2224		2446
2225	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
2226	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
2227	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
2228	failure/client crash from a normal connection close. Nevertheless, these	2450	failure/client crash from a normal connection close. Nevertheless, these
2229	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
2230	problem).	2452	problem).
2231		2453
2232	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
…		…
2284	$handle->on_eof (undef);	2506	$handle->on_eof (undef);
2285	$handle->on_error (sub {	2507	$handle->on_error (sub {
2286	my $data = delete $_[0]{rbuf};	2508	my $data = delete $_[0]{rbuf};
2287	});	2509	});
2288		2510
		2511	Note that this example removes the C<rbuf> member from the handle object,
		2512	which is not normally allowed by the API. It is expressly permitted in
		2513	this case only, as the handle object needs to be destroyed afterwards.
		2514
2289	The reason to use C<on_error> is that TCP connections, due to latencies	2515	The reason to use C<on_error> is that TCP connections, due to latencies
2290	and packets loss, might get closed quite violently with an error, when in	2516	and packets loss, might get closed quite violently with an error, when in
2291	fact all data has been received.	2517	fact all data has been received.
2292		2518
2293	It is usually better to use acknowledgements when transferring data,	2519	It is usually better to use acknowledgements when transferring data,
…		…
2303	C<low_water_mark> this will be called precisely when all data has been	2529	C<low_water_mark> this will be called precisely when all data has been
2304	written to the socket:	2530	written to the socket:
2305		2531
2306	$handle->push_write (...);	2532	$handle->push_write (...);
2307	$handle->on_drain (sub {	2533	$handle->on_drain (sub {
2308	warn "all data submitted to the kernel\n";	2534	AE::log debug => "All data submitted to the kernel.";
2309	undef $handle;	2535	undef $handle;
2310	});	2536	});
2311		2537
2312	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,
2313	consider using C<< ->push_shutdown >> instead.	2539	consider using C<< ->push_shutdown >> instead.
…		…
2397	When you have intermediate CA certificates that your clients might not	2623	When you have intermediate CA certificates that your clients might not
2398	know about, just append them to the C<cert_file>.	2624	know about, just append them to the C<cert_file>.
2399		2625
2400	=back	2626	=back
2401		2627
2402
2403	=head1 SUBCLASSING AnyEvent::Handle	2628	=head1 SUBCLASSING AnyEvent::Handle
2404		2629
2405	In many cases, you might want to subclass AnyEvent::Handle.	2630	In many cases, you might want to subclass AnyEvent::Handle.
2406		2631
2407	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
…		…
2433		2658
2434	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>.
2435		2660
2436	=cut	2661	=cut
2437		2662
2438	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.214 by root, Sun Jan 16 17:12:27 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.214 by root, Sun Jan 16 17:12:27 2011 UTC vs.
Revision 1.254 by root, Mon Feb 10 11:34:13 2020 UTC