[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.246 by root, Sun Jun 28 09:30:37 2015 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
…		…
765		810
766	sub rbuf_max {	811	sub rbuf_max {
767	$_[0]{rbuf_max} = $_[1];	812	$_[0]{rbuf_max} = $_[1];
768	}	813	}
769		814
770	sub rbuf_max {	815	sub wbuf_max {
771	$_[0]{wbuf_max} = $_[1];	816	$_[0]{wbuf_max} = $_[1];
772	}	817	}
773		818
774	#############################################################################	819	#############################################################################
775		820
…		…
778	=item $handle->rtimeout ($seconds)	823	=item $handle->rtimeout ($seconds)
779		824
780	=item $handle->wtimeout ($seconds)	825	=item $handle->wtimeout ($seconds)
781		826
782	Configures (or disables) the inactivity timeout.	827	Configures (or disables) the inactivity timeout.
		828
		829	The timeout will be checked instantly, so this method might destroy the
		830	handle before it returns.
783		831
784	=item $handle->timeout_reset	832	=item $handle->timeout_reset
785		833
786	=item $handle->rtimeout_reset	834	=item $handle->rtimeout_reset
787		835
…		…
871		919
872	The write queue is very simple: you can add data to its end, and	920	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.	921	AnyEvent::Handle will automatically try to get rid of it for you.
874		922
875	When data could be written and the write buffer is shorter then the low	923	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.	924	water mark, the C<on_drain> callback will be invoked once.
877		925
878	=over 4	926	=over 4
879		927
880	=item $handle->on_drain ($cb)	928	=item $handle->on_drain ($cb)
881		929
…		…
925	$self->{on_drain}($self)	973	$self->{on_drain}($self)
926	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	974	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
927	&& $self->{on_drain};	975	&& $self->{on_drain};
928		976
929	delete $self->{_ww} unless length $self->{wbuf};	977	delete $self->{_ww} unless length $self->{wbuf};
930	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	978	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
931	$self->_error ($!, 1);	979	$self->_error ($!, 1);
932	}	980	}
933	};	981	};
934		982
935	# try to write data immediately	983	# try to write data immediately
…		…
1023		1071
1024	Encodes the given hash or array reference into a JSON object. Unless you	1072	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	1073	provide your own JSON object, this means it will be encoded to JSON text
1026	in UTF-8.	1074	in UTF-8.
1027		1075
		1076	The default encoder might or might not handle every type of JSON value -
		1077	it might be limited to arrays and objects for security reasons. See the
		1078	C<json> constructor attribute for more details.
		1079
1028	JSON objects (and arrays) are self-delimiting, so you can write JSON at	1080	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	1081	and hashes, you can write JSON at one end of a handle and read them at the
1030	additional framing.	1082	other end without using any additional framing.
1031		1083
1032	The generated JSON text is guaranteed not to contain any newlines: While	1084	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	1085	contain any newlines: While this module doesn't need delimiters after or
1034	able to read them, many other languages depend on that.	1086	between JSON texts to be able to read them, many other languages depend on
		1087	them.
1035		1088
1036	A simple RPC protocol that interoperates easily with others is to send	1089	A simple RPC protocol that interoperates easily with other languages is
1037	JSON arrays (or objects, although arrays are usually the better choice as	1090	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	1091	choice as they mimic how function argument passing works) and a newline
1039	JSON text:	1092	after each JSON text:
1040		1093
1041	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1094	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1042	$handle->push_write ("\012");	1095	$handle->push_write ("\012");
1043		1096
1044	An AnyEvent::Handle receiver would simply use the C<json> read type and	1097	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
1047	$handle->push_read (json => sub { my $array = $_[1]; ... });	1100	$handle->push_read (json => sub { my $array = $_[1]; ... });
1048		1101
1049	Other languages could read single lines terminated by a newline and pass	1102	Other languages could read single lines terminated by a newline and pass
1050	this line into their JSON decoder of choice.	1103	this line into their JSON decoder of choice.
1051		1104
		1105	=item cbor => $perl_scalar
		1106
		1107	Encodes the given scalar into a CBOR value. Unless you provide your own
		1108	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1109	using any extensions, if possible.
		1110
		1111	CBOR values are self-delimiting, so you can write CBOR at one end of
		1112	a handle and read them at the other end without using any additional
		1113	framing.
		1114
		1115	A simple nd very very fast RPC protocol that interoperates with
		1116	other languages is to send CBOR and receive CBOR values (arrays are
		1117	recommended):
		1118
		1119	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1120
		1121	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1122
		1123	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1124
1052	=cut	1125	=cut
1053		1126
1054	sub json_coder() {	1127	sub json_coder() {
1055	eval { require JSON::XS; JSON::XS->new->utf8 }	1128	eval { require JSON::XS; JSON::XS->new->utf8 }
1056	\|\| do { require JSON; JSON->new->utf8 }	1129	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1057	}	1130	}
1058		1131
1059	register_write_type json => sub {	1132	register_write_type json => sub {
1060	my ($self, $ref) = @_;	1133	my ($self, $ref) = @_;
1061		1134
1062	my $json = $self->{json} \|\|= json_coder;	1135	($self->{json} \|\|= json_coder)
1063
1064	$json->encode ($ref)	1136	->encode ($ref)
		1137	};
		1138
		1139	sub cbor_coder() {
		1140	require CBOR::XS;
		1141	CBOR::XS->new
		1142	}
		1143
		1144	register_write_type cbor => sub {
		1145	my ($self, $scalar) = @_;
		1146
		1147	($self->{cbor} \|\|= cbor_coder)
		1148	->encode ($scalar)
1065	};	1149	};
1066		1150
1067	=item storable => $reference	1151	=item storable => $reference
1068		1152
1069	Freezes the given reference using L<Storable> and writes it to the	1153	Freezes the given reference using L<Storable> and writes it to the
…		…
1072	=cut	1156	=cut
1073		1157
1074	register_write_type storable => sub {	1158	register_write_type storable => sub {
1075	my ($self, $ref) = @_;	1159	my ($self, $ref) = @_;
1076		1160
1077	require Storable;	1161	require Storable unless $Storable::VERSION;
1078		1162
1079	pack "w/a*", Storable::nfreeze ($ref)	1163	pack "w/a*", Storable::nfreeze ($ref)
1080	};	1164	};
1081		1165
1082	=back	1166	=back
…		…
1119		1203
1120	Whenever the given C<type> is used, C<push_write> will the function with	1204	Whenever the given C<type> is used, C<push_write> will the function with
1121	the handle object and the remaining arguments.	1205	the handle object and the remaining arguments.
1122		1206
1123	The function is supposed to return a single octet string that will be	1207	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	1208	appended to the write buffer, so you can mentally treat this function as a
1125	"arguments to on-the-wire-format" converter.	1209	"arguments to on-the-wire-format" converter.
1126		1210
1127	Example: implement a custom write type C<join> that joins the remaining	1211	Example: implement a custom write type C<join> that joins the remaining
1128	arguments using the first one.	1212	arguments using the first one.
1129		1213
…		…
1423	data.	1507	data.
1424		1508
1425	Example: read 2 bytes.	1509	Example: read 2 bytes.
1426		1510
1427	$handle->push_read (chunk => 2, sub {	1511	$handle->push_read (chunk => 2, sub {
1428	warn "yay ", unpack "H*", $_[1];	1512	say "yay " . unpack "H*", $_[1];
1429	});	1513	});
1430		1514
1431	=cut	1515	=cut
1432		1516
1433	register_read_type chunk => sub {	1517	register_read_type chunk => sub {
…		…
1463		1547
1464	register_read_type line => sub {	1548	register_read_type line => sub {
1465	my ($self, $cb, $eol) = @_;	1549	my ($self, $cb, $eol) = @_;
1466		1550
1467	if (@_ < 3) {	1551	if (@_ < 3) {
1468	# this is more than twice as fast as the generic code below	1552	# this is faster then the generic code below
1469	sub {	1553	sub {
1470	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1554	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1555	or return;
1471		1556
		1557	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1472	$cb->($_[0], $1, $2);	1558	$cb->($_[0], $str, "$1");
1473	1	1559	1
1474	}	1560	}
1475	} else {	1561	} else {
1476	$eol = quotemeta $eol unless ref $eol;	1562	$eol = quotemeta $eol unless ref $eol;
1477	$eol = qr\|^(.*?)($eol)\|s;	1563	$eol = qr\|^(.*?)($eol)\|s;
1478		1564
1479	sub {	1565	sub {
1480	$_[0]{rbuf} =~ s/$eol// or return;	1566	$_[0]{rbuf} =~ s/$eol// or return;
1481		1567
1482	$cb->($_[0], $1, $2);	1568	$cb->($_[0], "$1", "$2");
1483	1	1569	1
1484	}	1570	}
1485	}	1571	}
1486	};	1572	};
1487		1573
1488	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1574	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
1489		1575
1490	Makes a regex match against the regex object C<$accept> and returns	1576	Makes a regex match against the regex object C<$accept> and returns
1491	everything up to and including the match.	1577	everything up to and including the match. All the usual regex variables
		1578	($1, %+ etc.) from the regex match are available in the callback.
1492		1579
1493	Example: read a single line terminated by '\n'.	1580	Example: read a single line terminated by '\n'.
1494		1581
1495	$handle->push_read (regex => qr<\n>, sub { ... });	1582	$handle->push_read (regex => qr<\n>, sub { ... });
1496		1583
…		…
1535		1622
1536	sub {	1623	sub {
1537	# accept	1624	# accept
1538	if ($$rbuf =~ $accept) {	1625	if ($$rbuf =~ $accept) {
1539	$data .= substr $$rbuf, 0, $+[0], "";	1626	$data .= substr $$rbuf, 0, $+[0], "";
1540	$cb->($self, $data);	1627	$cb->($_[0], $data);
1541	return 1;	1628	return 1;
1542	}	1629	}
1543		1630
1544	# reject	1631	# reject
1545	if ($reject && $$rbuf =~ $reject) {	1632	if ($reject && $$rbuf =~ $reject) {
1546	$self->_error (Errno::EBADMSG);	1633	$_[0]->_error (Errno::EBADMSG);
1547	}	1634	}
1548		1635
1549	# skip	1636	# skip
1550	if ($skip && $$rbuf =~ $skip) {	1637	if ($skip && $$rbuf =~ $skip) {
1551	$data .= substr $$rbuf, 0, $+[0], "";	1638	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1567	my ($self, $cb) = @_;	1654	my ($self, $cb) = @_;
1568		1655
1569	sub {	1656	sub {
1570	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1657	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1571	if ($_[0]{rbuf} =~ /[^0-9]/) {	1658	if ($_[0]{rbuf} =~ /[^0-9]/) {
1572	$self->_error (Errno::EBADMSG);	1659	$_[0]->_error (Errno::EBADMSG);
1573	}	1660	}
1574	return;	1661	return;
1575	}	1662	}
1576		1663
1577	my $len = $1;	1664	my $len = $1;
1578		1665
1579	$self->unshift_read (chunk => $len, sub {	1666	$_[0]->unshift_read (chunk => $len, sub {
1580	my $string = $_[1];	1667	my $string = $_[1];
1581	$_[0]->unshift_read (chunk => 1, sub {	1668	$_[0]->unshift_read (chunk => 1, sub {
1582	if ($_[1] eq ",") {	1669	if ($_[1] eq ",") {
1583	$cb->($_[0], $string);	1670	$cb->($_[0], $string);
1584	} else {	1671	} else {
1585	$self->_error (Errno::EBADMSG);	1672	$_[0]->_error (Errno::EBADMSG);
1586	}	1673	}
1587	});	1674	});
1588	});	1675	});
1589		1676
1590	1	1677	1
…		…
1640	=item json => $cb->($handle, $hash_or_arrayref)	1727	=item json => $cb->($handle, $hash_or_arrayref)
1641		1728
1642	Reads a JSON object or array, decodes it and passes it to the	1729	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.	1730	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1644		1731
1645	If a C<json> object was passed to the constructor, then that will be used	1732	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.	1733	used for the final decode, otherwise it will create a L<JSON::XS> or
		1734	L<JSON::PP> coder object expecting UTF-8.
1647		1735
1648	This read type uses the incremental parser available with JSON version	1736	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	1737	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		1738
1653	Since JSON texts are fully self-delimiting, the C<json> read and write	1739	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	1740	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1655	the C<json> write type description, above, for an actual example.	1741	the C<json> write type description, above, for an actual example.
1656		1742
…		…
1660	my ($self, $cb) = @_;	1746	my ($self, $cb) = @_;
1661		1747
1662	my $json = $self->{json} \|\|= json_coder;	1748	my $json = $self->{json} \|\|= json_coder;
1663		1749
1664	my $data;	1750	my $data;
1665	my $rbuf = \$self->{rbuf};
1666		1751
1667	sub {	1752	sub {
1668	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1753	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1669		1754
1670	if ($ref) {	1755	if ($ref) {
1671	$self->{rbuf} = $json->incr_text;	1756	$_[0]{rbuf} = $json->incr_text;
1672	$json->incr_text = "";	1757	$json->incr_text = "";
1673	$cb->($self, $ref);	1758	$cb->($_[0], $ref);
1674		1759
1675	1	1760	1
1676	} elsif ($@) {	1761	} elsif ($@) {
1677	# error case	1762	# error case
1678	$json->incr_skip;	1763	$json->incr_skip;
1679		1764
1680	$self->{rbuf} = $json->incr_text;	1765	$_[0]{rbuf} = $json->incr_text;
1681	$json->incr_text = "";	1766	$json->incr_text = "";
1682		1767
1683	$self->_error (Errno::EBADMSG);	1768	$_[0]->_error (Errno::EBADMSG);
1684		1769
1685	()	1770	()
1686	} else {	1771	} else {
1687	$self->{rbuf} = "";	1772	$_[0]{rbuf} = "";
1688		1773
		1774	()
		1775	}
		1776	}
		1777	};
		1778
		1779	=item cbor => $cb->($handle, $scalar)
		1780
		1781	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1782	error occurs, an C<EBADMSG> error will be raised.
		1783
		1784	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1785	used for the final decode, otherwise it will create a CBOR coder without
		1786	enabling any options.
		1787
		1788	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1789	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1790	itself.
		1791
		1792	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1793	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1794	the C<cbor> write type description, above, for an actual example.
		1795
		1796	=cut
		1797
		1798	register_read_type cbor => sub {
		1799	my ($self, $cb) = @_;
		1800
		1801	my $cbor = $self->{cbor} \|\|= cbor_coder;
		1802
		1803	my $data;
		1804
		1805	sub {
		1806	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1807
		1808	if (@value) {
		1809	$cb->($_[0], @value);
		1810
		1811	1
		1812	} elsif ($@) {
		1813	# error case
		1814	$cbor->incr_reset;
		1815
		1816	$_[0]->_error (Errno::EBADMSG);
		1817
		1818	()
		1819	} else {
1689	()	1820	()
1690	}	1821	}
1691	}	1822	}
1692	};	1823	};
1693		1824
…		…
1702	=cut	1833	=cut
1703		1834
1704	register_read_type storable => sub {	1835	register_read_type storable => sub {
1705	my ($self, $cb) = @_;	1836	my ($self, $cb) = @_;
1706		1837
1707	require Storable;	1838	require Storable unless $Storable::VERSION;
1708		1839
1709	sub {	1840	sub {
1710	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1841	# 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} })	1842	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1712	or return;	1843	or return;
…		…
1715		1846
1716	# bypass unshift if we already have the remaining chunk	1847	# bypass unshift if we already have the remaining chunk
1717	if ($format + $len <= length $_[0]{rbuf}) {	1848	if ($format + $len <= length $_[0]{rbuf}) {
1718	my $data = substr $_[0]{rbuf}, $format, $len;	1849	my $data = substr $_[0]{rbuf}, $format, $len;
1719	substr $_[0]{rbuf}, 0, $format + $len, "";	1850	substr $_[0]{rbuf}, 0, $format + $len, "";
		1851
1720	$cb->($_[0], Storable::thaw ($data));	1852	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1853	or return $_[0]->_error (Errno::EBADMSG);
1721	} else {	1854	} else {
1722	# remove prefix	1855	# remove prefix
1723	substr $_[0]{rbuf}, 0, $format, "";	1856	substr $_[0]{rbuf}, 0, $format, "";
1724		1857
1725	# read remaining chunk	1858	# read remaining chunk
1726	$_[0]->unshift_read (chunk => $len, sub {	1859	$_[0]->unshift_read (chunk => $len, sub {
1727	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1860	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1728	$cb->($_[0], $ref);
1729	} else {
1730	$self->_error (Errno::EBADMSG);	1861	or $_[0]->_error (Errno::EBADMSG);
1731	}
1732	});	1862	});
1733	}	1863	}
1734		1864
1735	1	1865	1
1736	}	1866	}
		1867	};
		1868
		1869	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1870
		1871	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1872	record without consuming anything. Only SSL version 3 or higher
		1873	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1874	SSL2-compatible framing is supported).
		1875
		1876	If it detects that the input data is likely TLS, it calls the callback
		1877	with a true value for C<$detect> and the (on-wire) TLS version as second
		1878	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1879	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1880	be definitely not TLS, it calls the callback with a false value for
		1881	C<$detect>.
		1882
		1883	The callback could use this information to decide whether or not to start
		1884	TLS negotiation.
		1885
		1886	In all cases the data read so far is passed to the following read
		1887	handlers.
		1888
		1889	Usually you want to use the C<tls_autostart> read type instead.
		1890
		1891	If you want to design a protocol that works in the presence of TLS
		1892	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1893	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1894	read type does are a bit more strict, but might losen in the future to
		1895	accomodate protocol changes.
		1896
		1897	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1898	L<Net::SSLeay>).
		1899
		1900	=item tls_autostart => $tls[, $tls_ctx]
		1901
		1902	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1903	to start tls by calling C<starttls> with the given arguments.
		1904
		1905	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1906	been configured to accept, as servers do not normally send a handshake on
		1907	their own and ths cannot be detected in this way.
		1908
		1909	See C<tls_detect> above for more details.
		1910
		1911	Example: give the client a chance to start TLS before accepting a text
		1912	line.
		1913
		1914	$hdl->push_read (tls_detect => "accept");
		1915	$hdl->push_read (line => sub {
		1916	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1917	});
		1918
		1919	=cut
		1920
		1921	register_read_type tls_detect => sub {
		1922	my ($self, $cb) = @_;
		1923
		1924	sub {
		1925	# this regex matches a full or partial tls record
		1926	if (
		1927	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1928	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1929	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1930	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1931	) {
		1932	return if 3 != length $1; # partial match, can't decide yet
		1933
		1934	# full match, valid TLS record
		1935	my ($major, $minor) = unpack "CC", $1;
		1936	$cb->($self, "accept", $major + $minor * 0.1);
		1937	} else {
		1938	# mismatch == guaranteed not TLS
		1939	$cb->($self, undef);
		1940	}
		1941
		1942	1
		1943	}
		1944	};
		1945
		1946	register_read_type tls_autostart => sub {
		1947	my ($self, @tls) = @_;
		1948
		1949	$RH{tls_detect}($self, sub {
		1950	return unless $_[1];
		1951	$_[0]->starttls (@tls);
		1952	})
1737	};	1953	};
1738		1954
1739	=back	1955	=back
1740		1956
1741	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1957	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1783	some readings of the the SSL/TLS specifications basically require this	1999	some readings of the the SSL/TLS specifications basically require this
1784	attack to be working, as SSL/TLS implementations might stall sending data	2000	attack to be working, as SSL/TLS implementations might stall sending data
1785	during a rehandshake.	2001	during a rehandshake.
1786		2002
1787	As a guideline, during the initial handshake, you should not stop reading,	2003	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.	2004	and as a client, it might cause problems, depending on your application.
1789		2005
1790	=cut	2006	=cut
1791		2007
1792	sub stop_read {	2008	sub stop_read {
1793	my ($self) = @_;	2009	my ($self) = @_;
…		…
1825	} elsif (defined $len) {	2041	} elsif (defined $len) {
1826	delete $self->{_rw};	2042	delete $self->{_rw};
1827	$self->{_eof} = 1;	2043	$self->{_eof} = 1;
1828	$self->_drain_rbuf;	2044	$self->_drain_rbuf;
1829		2045
1830	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2046	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
1831	return $self->_error ($!, 1);	2047	return $self->_error ($!, 1);
1832	}	2048	}
1833	};	2049	};
1834	}	2050	}
1835	}	2051	}
…		…
1841	my ($self, $err) = @_;	2057	my ($self, $err) = @_;
1842		2058
1843	return $self->_error ($!, 1)	2059	return $self->_error ($!, 1)
1844	if $err == Net::SSLeay::ERROR_SYSCALL ();	2060	if $err == Net::SSLeay::ERROR_SYSCALL ();
1845		2061
1846	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2062	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1847		2063
1848	# reduce error string to look less scary	2064	# reduce error string to look less scary
1849	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2065	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1850		2066
1851	if ($self->{_on_starttls}) {	2067	if ($self->{_on_starttls}) {
…		…
1865	sub _dotls {	2081	sub _dotls {
1866	my ($self) = @_;	2082	my ($self) = @_;
1867		2083
1868	my $tmp;	2084	my $tmp;
1869		2085
1870	if (length $self->{_tls_wbuf}) {	2086	while (length $self->{_tls_wbuf}) {
1871	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2087	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1872	substr $self->{_tls_wbuf}, 0, $tmp, "";	2088	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2089
		2090	return $self->_tls_error ($tmp)
		2091	if $tmp != $ERROR_WANT_READ
		2092	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		2093
		2094	last;
1873	}	2095	}
1874		2096
1875	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2097	substr $self->{_tls_wbuf}, 0, $tmp, "";
1876	return $self->_tls_error ($tmp)
1877	if $tmp != $ERROR_WANT_READ
1878	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1879	}	2098	}
1880		2099
1881	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2100	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1882	unless (length $tmp) {	2101	unless (length $tmp) {
1883	$self->{_on_starttls}	2102	$self->{_on_starttls}
…		…
1897	$self->{_tls_rbuf} .= $tmp;	2116	$self->{_tls_rbuf} .= $tmp;
1898	$self->_drain_rbuf;	2117	$self->_drain_rbuf;
1899	$self->{tls} or return; # tls session might have gone away in callback	2118	$self->{tls} or return; # tls session might have gone away in callback
1900	}	2119	}
1901		2120
1902	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	2121	$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)	2122	return $self->_tls_error ($tmp)
1904	if $tmp != $ERROR_WANT_READ	2123	if $tmp != $ERROR_WANT_READ
1905	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2124	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1906		2125
1907	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2126	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1917		2136
1918	=item $handle->starttls ($tls[, $tls_ctx])	2137	=item $handle->starttls ($tls[, $tls_ctx])
1919		2138
1920	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2139	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	2140	object is created, you can also do that at a later time by calling
1922	C<starttls>.	2141	C<starttls>. See the C<tls> constructor argument for general info.
1923		2142
1924	Starting TLS is currently an asynchronous operation - when you push some	2143	Starting TLS is currently an asynchronous operation - when you push some
1925	write data and then call C<< ->starttls >> then TLS negotiation will start	2144	write data and then call C<< ->starttls >> then TLS negotiation will start
1926	immediately, after which the queued write data is then sent.	2145	immediately, after which the queued write data is then sent. This might
		2146	change in future versions, so best make sure you have no outstanding write
		2147	data when calling this method.
1927		2148
1928	The first argument is the same as the C<tls> constructor argument (either	2149	The first argument is the same as the C<tls> constructor argument (either
1929	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2150	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1930		2151
1931	The second argument is the optional C<AnyEvent::TLS> object that is used	2152	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1953	my ($self, $tls, $ctx) = @_;	2174	my ($self, $tls, $ctx) = @_;
1954		2175
1955	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2176	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1956	if $self->{tls};	2177	if $self->{tls};
1957		2178
		2179	unless (defined $AnyEvent::TLS::VERSION) {
		2180	eval {
		2181	require Net::SSLeay;
		2182	require AnyEvent::TLS;
		2183	1
		2184	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2185	}
		2186
1958	$self->{tls} = $tls;	2187	$self->{tls} = $tls;
1959	$self->{tls_ctx} = $ctx if @_ > 2;	2188	$self->{tls_ctx} = $ctx if @_ > 2;
1960		2189
1961	return unless $self->{fh};	2190	return unless $self->{fh};
1962		2191
1963	require Net::SSLeay;
1964
1965	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2192	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1966	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2193	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1967		2194
1968	$tls = delete $self->{tls};	2195	$tls = delete $self->{tls};
1969	$ctx = $self->{tls_ctx};	2196	$ctx = $self->{tls_ctx};
1970		2197
1971	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2198	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1972		2199
1973	if ("HASH" eq ref $ctx) {	2200	if ("HASH" eq ref $ctx) {
1974	require AnyEvent::TLS;
1975
1976	if ($ctx->{cache}) {	2201	if ($ctx->{cache}) {
1977	my $key = $ctx+0;	2202	my $key = $ctx+0;
1978	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2203	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1979	} else {	2204	} else {
1980	$ctx = new AnyEvent::TLS %$ctx;	2205	$ctx = new AnyEvent::TLS %$ctx;
…		…
2002	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2227	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
2003		2228
2004	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2229	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
2005	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2230	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
2006		2231
2007	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2232	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2233	$self->{rbuf} = "";
2008		2234
2009	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2235	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
2010		2236
2011	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2237	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
2012	if $self->{on_starttls};	2238	if $self->{on_starttls};
…		…
2050	if $self->{tls} > 0;	2276	if $self->{tls} > 0;
2051		2277
2052	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2278	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
2053	}	2279	}
2054		2280
		2281	=item $handle->resettls
		2282
		2283	This rarely-used method simply resets and TLS state on the handle, usually
		2284	causing data loss.
		2285
		2286	One case where it may be useful is when you want to skip over the data in
		2287	the stream but you are not interested in interpreting it, so data loss is
		2288	no concern.
		2289
		2290	=cut
		2291
		2292	*resettls = \&_freetls;
		2293
2055	sub DESTROY {	2294	sub DESTROY {
2056	my ($self) = @_;	2295	my ($self) = @_;
2057		2296
2058	&_freetls;	2297	&_freetls;
2059		2298
…		…
2068	push @linger, AE::io $fh, 1, sub {	2307	push @linger, AE::io $fh, 1, sub {
2069	my $len = syswrite $fh, $wbuf, length $wbuf;	2308	my $len = syswrite $fh, $wbuf, length $wbuf;
2070		2309
2071	if ($len > 0) {	2310	if ($len > 0) {
2072	substr $wbuf, 0, $len, "";	2311	substr $wbuf, 0, $len, "";
2073	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {	2312	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) {
2074	@linger = (); # end	2313	@linger = (); # end
2075	}	2314	}
2076	};	2315	};
2077	push @linger, AE::timer $linger, 0, sub {	2316	push @linger, AE::timer $linger, 0, sub {
2078	@linger = ();	2317	@linger = ();
…		…
2181	Probably because your C<on_error> callback is being called instead: When	2420	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	2421	you have outstanding requests in your read queue, then an EOF is
2183	considered an error as you clearly expected some data.	2422	considered an error as you clearly expected some data.
2184		2423
2185	To avoid this, make sure you have an empty read queue whenever your handle	2424	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	2425	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	2426	an C<on_read> handler that simply pushes the first read requests in the
2188	queue.	2427	queue.
2189		2428
2190	See also the next question, which explains this in a bit more detail.	2429	See also the next question, which explains this in a bit more detail.
2191		2430
…		…
2199	handles requests until the server gets some QUIT command, causing it to	2438	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	2439	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	2440	client dropping the connection is an error, which means this variant can
2202	detect an unexpected detection close.	2441	detect an unexpected detection close.
2203		2442
2204	To handle this case, always make sure you have a on-empty read queue, by	2443	To handle this case, always make sure you have a non-empty read queue, by
2205	pushing the "read request start" handler on it:	2444	pushing the "read request start" handler on it:
2206		2445
2207	# we assume a request starts with a single line	2446	# we assume a request starts with a single line
2208	my @start_request; @start_request = (line => sub {	2447	my @start_request; @start_request = (line => sub {
2209	my ($hdl, $line) = @_;	2448	my ($hdl, $line) = @_;
…		…
2222	some data and raises the C<EPIPE> error when the connction is dropped	2461	some data and raises the C<EPIPE> error when the connction is dropped
2223	unexpectedly.	2462	unexpectedly.
2224		2463
2225	The second variant is a protocol where the client can drop the connection	2464	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	2465	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	2466	sockets easier, and in general, it means you cannot distinguish a protocl
2228	failure/client crash from a normal connection close. Nevertheless, these	2467	failure/client crash from a normal connection close. Nevertheless, these
2229	kinds of protocols are common (and sometimes even the best solution to the	2468	kinds of protocols are common (and sometimes even the best solution to the
2230	problem).	2469	problem).
2231		2470
2232	Having an outstanding read request at all times is possible if you ignore	2471	Having an outstanding read request at all times is possible if you ignore
…		…
2284	$handle->on_eof (undef);	2523	$handle->on_eof (undef);
2285	$handle->on_error (sub {	2524	$handle->on_error (sub {
2286	my $data = delete $_[0]{rbuf};	2525	my $data = delete $_[0]{rbuf};
2287	});	2526	});
2288		2527
		2528	Note that this example removes the C<rbuf> member from the handle object,
		2529	which is not normally allowed by the API. It is expressly permitted in
		2530	this case only, as the handle object needs to be destroyed afterwards.
		2531
2289	The reason to use C<on_error> is that TCP connections, due to latencies	2532	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	2533	and packets loss, might get closed quite violently with an error, when in
2291	fact all data has been received.	2534	fact all data has been received.
2292		2535
2293	It is usually better to use acknowledgements when transferring data,	2536	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	2546	C<low_water_mark> this will be called precisely when all data has been
2304	written to the socket:	2547	written to the socket:
2305		2548
2306	$handle->push_write (...);	2549	$handle->push_write (...);
2307	$handle->on_drain (sub {	2550	$handle->on_drain (sub {
2308	warn "all data submitted to the kernel\n";	2551	AE::log debug => "All data submitted to the kernel.";
2309	undef $handle;	2552	undef $handle;
2310	});	2553	});
2311		2554
2312	If you just want to queue some data and then signal EOF to the other side,	2555	If you just want to queue some data and then signal EOF to the other side,
2313	consider using C<< ->push_shutdown >> instead.	2556	consider using C<< ->push_shutdown >> instead.
…		…
2397	When you have intermediate CA certificates that your clients might not	2640	When you have intermediate CA certificates that your clients might not
2398	know about, just append them to the C<cert_file>.	2641	know about, just append them to the C<cert_file>.
2399		2642
2400	=back	2643	=back
2401		2644
2402
2403	=head1 SUBCLASSING AnyEvent::Handle	2645	=head1 SUBCLASSING AnyEvent::Handle
2404		2646
2405	In many cases, you might want to subclass AnyEvent::Handle.	2647	In many cases, you might want to subclass AnyEvent::Handle.
2406		2648
2407	To make this easier, a given version of AnyEvent::Handle uses these	2649	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2433		2675
2434	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2676	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2435		2677
2436	=cut	2678	=cut
2437		2679
2438	1; # End of AnyEvent::Handle	2680	1
		2681

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.246 by root, Sun Jun 28 09:30:37 2015 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.246 by root, Sun Jun 28 09:30:37 2015 UTC