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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.203 by root, Sat Oct 16 03:22:10 2010 UTC vs.
Revision 1.240 by root, Tue Dec 17 16:43:15 2013 UTC

…		…
11		11
12	my $hdl; $hdl = new AnyEvent::Handle	12	my $hdl; $hdl = new AnyEvent::Handle
13	fh => \*STDIN,	13	fh => \*STDIN,
14	on_error => sub {	14	on_error => sub {
15	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
16	warn "got error $msg\n";	16	AE::log error => $msg;
17	$hdl->destroy;	17	$hdl->destroy;
18	$cv->send;	18	$cv->send;
19	};	19	};
20		20
21	# send some request line	21	# send some request line
22	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
23		23
24	# read the response line	24	# read the response line
25	$hdl->push_read (line => sub {	25	$hdl->push_read (line => sub {
26	my ($hdl, $line) = @_;	26	my ($hdl, $line) = @_;
27	warn "got line <$line>\n";	27	say "got line <$line>";
28	$cv->send;	28	$cv->send;
29	});	29	});
30		30
31	$cv->recv;	31	$cv->recv;
32		32
…		…
114	=over 4	114	=over 4
115		115
116	=item on_prepare => $cb->($handle)	116	=item on_prepare => $cb->($handle)
117		117
118	This (rarely used) callback is called before a new connection is	118	This (rarely used) callback is called before a new connection is
119	attempted, but after the file handle has been created. It could be used to	119	attempted, but after the file handle has been created (you can access that
		120	file handle via C<< $handle->{fh} >>). It could be used to prepare the
120	prepare the file handle with parameters required for the actual connect	121	file handle with parameters required for the actual connect (as opposed to
121	(as opposed to settings that can be changed when the connection is already	122	settings that can be changed when the connection is already established).
122	established).
123		123
124	The return value of this callback should be the connect timeout value in	124	The return value of this callback should be the connect timeout value in
125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the	125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
126	default timeout is to be used).	126	default timeout is to be used).
127		127
128	=item on_connect => $cb->($handle, $host, $port, $retry->())	128	=item on_connect => $cb->($handle, $host, $port, $retry->())
129		129
130	This callback is called when a connection has been successfully established.	130	This callback is called when a connection has been successfully established.
131		131
132	The peer's numeric host and port (the socket peername) are passed as	132	The peer's numeric host and port (the socket peername) are passed as
133	parameters, together with a retry callback.	133	parameters, together with a retry callback. At the time it is called the
		134	read and write queues, EOF status, TLS status and similar properties of
		135	the handle will have been reset.
134		136
		137	It is not allowed to use the read or write queues while the handle object
		138	is connecting.
		139
135	If, for some reason, the handle is not acceptable, calling C<$retry>	140	If, for some reason, the handle is not acceptable, calling C<$retry> will
136	will continue with the next connection target (in case of multi-homed	141	continue with the next connection target (in case of multi-homed hosts or
137	hosts or SRV records there can be multiple connection endpoints). At the	142	SRV records there can be multiple connection endpoints). The C<$retry>
138	time it is called the read and write queues, eof status, tls status and	143	callback can be invoked after the connect callback returns, i.e. one can
139	similar properties of the handle will have been reset.	144	start a handshake and then decide to retry with the next host if the
		145	handshake fails.
140		146
141	In most cases, you should ignore the C<$retry> parameter.	147	In most cases, you should ignore the C<$retry> parameter.
142		148
143	=item on_connect_error => $cb->($handle, $message)	149	=item on_connect_error => $cb->($handle, $message)
144		150
…		…
159		165
160	Some errors are fatal (which is indicated by C<$fatal> being true). On	166	Some errors are fatal (which is indicated by C<$fatal> being true). On
161	fatal errors the handle object will be destroyed (by a call to C<< ->	167	fatal errors the handle object will be destroyed (by a call to C<< ->
162	destroy >>) after invoking the error callback (which means you are free to	168	destroy >>) after invoking the error callback (which means you are free to
163	examine the handle object). Examples of fatal errors are an EOF condition	169	examine the handle object). Examples of fatal errors are an EOF condition
164	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In	170	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
165	cases where the other side can close the connection at will, it is	171	cases where the other side can close the connection at will, it is
166	often easiest to not report C<EPIPE> errors in this callback.	172	often easiest to not report C<EPIPE> errors in this callback.
167		173
168	AnyEvent::Handle tries to find an appropriate error code for you to check	174	AnyEvent::Handle tries to find an appropriate error code for you to check
169	against, but in some cases (TLS errors), this does not work well. It is	175	against, but in some cases (TLS errors), this does not work well.
170	recommended to always output the C<$message> argument in human-readable	176
171	error messages (it's usually the same as C<"$!">).	177	If you report the error to the user, it is recommended to always output
		178	the C<$message> argument in human-readable error messages (you don't need
		179	to report C<"$!"> if you report C<$message>).
		180
		181	If you want to react programmatically to the error, then looking at C<$!>
		182	and comparing it against some of the documented C<Errno> values is usually
		183	better than looking at the C<$message>.
172		184
173	Non-fatal errors can be retried by returning, but it is recommended	185	Non-fatal errors can be retried by returning, but it is recommended
174	to simply ignore this parameter and instead abondon the handle object	186	to simply ignore this parameter and instead abondon the handle object
175	when this callback is invoked. Examples of non-fatal errors are timeouts	187	when this callback is invoked. Examples of non-fatal errors are timeouts
176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	188	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
…		…
224	If an EOF condition has been detected but no C<on_eof> callback has been	236	If an EOF condition has been detected but no C<on_eof> callback has been
225	set, then a fatal error will be raised with C<$!> set to <0>.	237	set, then a fatal error will be raised with C<$!> set to <0>.
226		238
227	=item on_drain => $cb->($handle)	239	=item on_drain => $cb->($handle)
228		240
229	This sets the callback that is called when the write buffer becomes empty	241	This sets the callback that is called once when the write buffer becomes
230	(or immediately if the buffer is empty already).	242	empty (and immediately when the handle object is created).
231		243
232	To append to the write buffer, use the C<< ->push_write >> method.	244	To append to the write buffer, use the C<< ->push_write >> method.
233		245
234	This callback is useful when you don't want to put all of your write data	246	This callback is useful when you don't want to put all of your write data
235	into the queue at once, for example, when you want to write the contents	247	into the queue at once, for example, when you want to write the contents
…		…
247	many seconds pass without a successful read or write on the underlying	259	many seconds pass without a successful read or write on the underlying
248	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback	260	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
249	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>	261	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
250	error will be raised).	262	error will be raised).
251		263
252	There are three variants of the timeouts that work independently	264	There are three variants of the timeouts that work independently of each
253	of each other, for both read and write, just read, and just write:	265	other, for both read and write (triggered when nothing was read I<OR>
		266	written), just read (triggered when nothing was read), and just write:
254	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks	267	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
255	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions	268	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
256	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.	269	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
257		270
258	Note that timeout processing is active even when you do not have	271	Note that timeout processing is active even when you do not have any
259	any outstanding read or write requests: If you plan to keep the connection	272	outstanding read or write requests: If you plan to keep the connection
260	idle then you should disable the timeout temporarily or ignore the timeout	273	idle then you should disable the timeout temporarily or ignore the
261	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	274	timeout in the corresponding C<on_timeout> callback, in which case
262	restart the timeout.	275	AnyEvent::Handle will simply restart the timeout.
263		276
264	Zero (the default) disables this timeout.	277	Zero (the default) disables the corresponding timeout.
265		278
266	=item on_timeout => $cb->($handle)	279	=item on_timeout => $cb->($handle)
		280
		281	=item on_rtimeout => $cb->($handle)
		282
		283	=item on_wtimeout => $cb->($handle)
267		284
268	Called whenever the inactivity timeout passes. If you return from this	285	Called whenever the inactivity timeout passes. If you return from this
269	callback, then the timeout will be reset as if some activity had happened,	286	callback, then the timeout will be reset as if some activity had happened,
270	so this condition is not fatal in any way.	287	so this condition is not fatal in any way.
271		288
…		…
278	For example, a server accepting connections from untrusted sources should	295	For example, a server accepting connections from untrusted sources should
279	be configured to accept only so-and-so much data that it cannot act on	296	be configured to accept only so-and-so much data that it cannot act on
280	(for example, when expecting a line, an attacker could send an unlimited	297	(for example, when expecting a line, an attacker could send an unlimited
281	amount of data without a callback ever being called as long as the line	298	amount of data without a callback ever being called as long as the line
282	isn't finished).	299	isn't finished).
		300
		301	=item wbuf_max => <bytes>
		302
		303	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
		304	when the write buffer ever (strictly) exceeds this size. This is useful to
		305	avoid some forms of denial-of-service attacks.
		306
		307	Although the units of this parameter is bytes, this is the I<raw> number
		308	of bytes not yet accepted by the kernel. This can make a difference when
		309	you e.g. use TLS, as TLS typically makes your write data larger (but it
		310	can also make it smaller due to compression).
		311
		312	As an example of when this limit is useful, take a chat server that sends
		313	chat messages to a client. If the client does not read those in a timely
		314	manner then the send buffer in the server would grow unbounded.
283		315
284	=item autocork => <boolean>	316	=item autocork => <boolean>
285		317
286	When disabled (the default), C<push_write> will try to immediately	318	When disabled (the default), C<push_write> will try to immediately
287	write the data to the handle if possible. This avoids having to register	319	write the data to the handle if possible. This avoids having to register
…		…
339	already have occured on BSD systems), but at least it will protect you	371	already have occured on BSD systems), but at least it will protect you
340	from most attacks.	372	from most attacks.
341		373
342	=item read_size => <bytes>	374	=item read_size => <bytes>
343		375
344	The initial read block size, the number of bytes this module will try to	376	The initial read block size, the number of bytes this module will try
345	read during each loop iteration. Each handle object will consume at least	377	to read during each loop iteration. Each handle object will consume
346	this amount of memory for the read buffer as well, so when handling many	378	at least this amount of memory for the read buffer as well, so when
347	connections requirements). See also C<max_read_size>. Default: C<2048>.	379	handling many connections watch out for memory requirements). See also
		380	C<max_read_size>. Default: C<2048>.
348		381
349	=item max_read_size => <bytes>	382	=item max_read_size => <bytes>
350		383
351	The maximum read buffer size used by the dynamic adjustment	384	The maximum read buffer size used by the dynamic adjustment
352	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in	385	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
…		…
396	appropriate error message.	429	appropriate error message.
397		430
398	TLS mode requires Net::SSLeay to be installed (it will be loaded	431	TLS mode requires Net::SSLeay to be installed (it will be loaded
399	automatically when you try to create a TLS handle): this module doesn't	432	automatically when you try to create a TLS handle): this module doesn't
400	have a dependency on that module, so if your module requires it, you have	433	have a dependency on that module, so if your module requires it, you have
401	to add the dependency yourself.	434	to add the dependency yourself. If Net::SSLeay cannot be loaded or is too
		435	old, you get an C<EPROTO> error.
402		436
403	Unlike TCP, TLS has a server and client side: for the TLS server side, use	437	Unlike TCP, TLS has a server and client side: for the TLS server side, use
404	C<accept>, and for the TLS client side of a connection, use C<connect>	438	C<accept>, and for the TLS client side of a connection, use C<connect>
405	mode.	439	mode.
406		440
…		…
422	Use the C<< ->starttls >> method if you need to start TLS negotiation later.	456	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
423		457
424	=item tls_ctx => $anyevent_tls	458	=item tls_ctx => $anyevent_tls
425		459
426	Use the given C<AnyEvent::TLS> object to create the new TLS connection	460	Use the given C<AnyEvent::TLS> object to create the new TLS connection
427	(unless a connection object was specified directly). If this parameter is	461	(unless a connection object was specified directly). If this
428	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	462	parameter is missing (or C<undef>), then AnyEvent::Handle will use
		463	C<AnyEvent::Handle::TLS_CTX>.
429		464
430	Instead of an object, you can also specify a hash reference with C<< key	465	Instead of an object, you can also specify a hash reference with C<< key
431	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	466	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
432	new TLS context object.	467	new TLS context object.
433		468
…		…
461	callback.	496	callback.
462		497
463	This callback will only be called on TLS shutdowns, not when the	498	This callback will only be called on TLS shutdowns, not when the
464	underlying handle signals EOF.	499	underlying handle signals EOF.
465		500
466	=item json => JSON or JSON::XS object	501	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
467		502
468	This is the json coder object used by the C<json> read and write types.	503	This is the json coder object used by the C<json> read and write types.
469		504
470	If you don't supply it, then AnyEvent::Handle will create and use a	505	If you don't supply it, then AnyEvent::Handle will create and use a
471	suitable one (on demand), which will write and expect UTF-8 encoded JSON	506	suitable one (on demand), which will write and expect UTF-8 encoded JSON
472	texts.	507	texts.
473		508
		509	=item cbor => L<CBOR::XS> object
		510
		511	This is the cbor coder object used by the C<cbor> read and write types.
		512
		513	If you don't supply it, then AnyEvent::Handle will create and use a
		514	suitable one (on demand), which will write CBOR without using extensions,
		515	if possible. texts.
		516
474	Note that you are responsible to depend on the JSON module if you want to	517	Note that you are responsible to depend on the L<CBOR::XS> module if you
475	use this functionality, as AnyEvent does not have a dependency itself.	518	want to use this functionality, as AnyEvent does not have a dependency on
		519	it itself.
476		520
477	=back	521	=back
478		522
479	=cut	523	=cut
480		524
…		…
502	$self->{connect}[0],	546	$self->{connect}[0],
503	$self->{connect}[1],	547	$self->{connect}[1],
504	sub {	548	sub {
505	my ($fh, $host, $port, $retry) = @_;	549	my ($fh, $host, $port, $retry) = @_;
506		550
		551	delete $self->{_connect}; # no longer needed
		552
507	if ($fh) {	553	if ($fh) {
508	$self->{fh} = $fh;	554	$self->{fh} = $fh;
509		555
510	delete $self->{_skip_drain_rbuf};	556	delete $self->{_skip_drain_rbuf};
511	$self->_start;	557	$self->_start;
…		…
518	});	564	});
519		565
520	} else {	566	} else {
521	if ($self->{on_connect_error}) {	567	if ($self->{on_connect_error}) {
522	$self->{on_connect_error}($self, "$!");	568	$self->{on_connect_error}($self, "$!");
523	$self->destroy;	569	$self->destroy if $self;
524	} else {	570	} else {
525	$self->_error ($!, 1);	571	$self->_error ($!, 1);
526	}	572	}
527	}	573	}
528	},	574	},
529	sub {	575	sub {
530	local $self->{fh} = $_[0];	576	local $self->{fh} = $_[0];
531		577
532	$self->{on_prepare}	578	$self->{on_prepare}
533	? $self->{on_prepare}->($self)	579	? $self->{on_prepare}->($self)
534	: ()	580	: ()
535	}	581	}
536	);	582	);
537	}	583	}
538		584
…		…
737		783
738	=item $handle->rbuf_max ($max_octets)	784	=item $handle->rbuf_max ($max_octets)
739		785
740	Configures the C<rbuf_max> setting (C<undef> disables it).	786	Configures the C<rbuf_max> setting (C<undef> disables it).
741		787
		788	=item $handle->wbuf_max ($max_octets)
		789
		790	Configures the C<wbuf_max> setting (C<undef> disables it).
		791
742	=cut	792	=cut
743		793
744	sub rbuf_max {	794	sub rbuf_max {
745	$_[0]{rbuf_max} = $_[1];	795	$_[0]{rbuf_max} = $_[1];
746	}	796	}
747		797
		798	sub wbuf_max {
		799	$_[0]{wbuf_max} = $_[1];
		800	}
		801
748	#############################################################################	802	#############################################################################
749		803
750	=item $handle->timeout ($seconds)	804	=item $handle->timeout ($seconds)
751		805
752	=item $handle->rtimeout ($seconds)	806	=item $handle->rtimeout ($seconds)
753		807
754	=item $handle->wtimeout ($seconds)	808	=item $handle->wtimeout ($seconds)
755		809
756	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.
757		814
758	=item $handle->timeout_reset	815	=item $handle->timeout_reset
759		816
760	=item $handle->rtimeout_reset	817	=item $handle->rtimeout_reset
761		818
…		…
845		902
846	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
847	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.
848		905
849	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
850	water mark, the C<on_drain> callback will be invoked.	907	water mark, the C<on_drain> callback will be invoked once.
851		908
852	=over 4	909	=over 4
853		910
854	=item $handle->on_drain ($cb)	911	=item $handle->on_drain ($cb)
855		912
…		…
870	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});	927	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
871	}	928	}
872		929
873	=item $handle->push_write ($data)	930	=item $handle->push_write ($data)
874		931
875	Queues the given scalar to be written. You can push as much data as you	932	Queues the given scalar to be written. You can push as much data as
876	want (only limited by the available memory), as C<AnyEvent::Handle>	933	you want (only limited by the available memory and C<wbuf_max>), as
877	buffers it independently of the kernel.	934	C<AnyEvent::Handle> buffers it independently of the kernel.
878		935
879	This method may invoke callbacks (and therefore the handle might be	936	This method may invoke callbacks (and therefore the handle might be
880	destroyed after it returns).	937	destroyed after it returns).
881		938
882	=cut	939	=cut
…		…
910	$cb->() unless $self->{autocork};	967	$cb->() unless $self->{autocork};
911		968
912	# if still data left in wbuf, we need to poll	969	# if still data left in wbuf, we need to poll
913	$self->{_ww} = AE::io $self->{fh}, 1, $cb	970	$self->{_ww} = AE::io $self->{fh}, 1, $cb
914	if length $self->{wbuf};	971	if length $self->{wbuf};
		972
		973	if (
		974	defined $self->{wbuf_max}
		975	&& $self->{wbuf_max} < length $self->{wbuf}
		976	) {
		977	$self->_error (Errno::ENOSPC, 1), return;
		978	}
915	};	979	};
916	}	980	}
917		981
918	our %WH;	982	our %WH;
919		983
…		…
998		1062
999	The generated JSON text is guaranteed not to contain any newlines: While	1063	The generated JSON text is guaranteed not to contain any newlines: While
1000	this module doesn't need delimiters after or between JSON texts to be	1064	this module doesn't need delimiters after or between JSON texts to be
1001	able to read them, many other languages depend on that.	1065	able to read them, many other languages depend on that.
1002		1066
1003	A simple RPC protocol that interoperates easily with others is to send	1067	A simple RPC protocol that interoperates easily with other languages is
1004	JSON arrays (or objects, although arrays are usually the better choice as	1068	to send JSON arrays (or objects, although arrays are usually the better
1005	they mimic how function argument passing works) and a newline after each	1069	choice as they mimic how function argument passing works) and a newline
1006	JSON text:	1070	after each JSON text:
1007		1071
1008	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1072	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1009	$handle->push_write ("\012");	1073	$handle->push_write ("\012");
1010		1074
1011	An AnyEvent::Handle receiver would simply use the C<json> read type and	1075	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
1014	$handle->push_read (json => sub { my $array = $_[1]; ... });	1078	$handle->push_read (json => sub { my $array = $_[1]; ... });
1015		1079
1016	Other languages could read single lines terminated by a newline and pass	1080	Other languages could read single lines terminated by a newline and pass
1017	this line into their JSON decoder of choice.	1081	this line into their JSON decoder of choice.
1018		1082
		1083	=item cbor => $perl_scalar
		1084
		1085	Encodes the given scalar into a CBOR value. Unless you provide your own
		1086	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1087	using any extensions, if possible.
		1088
		1089	CBOR values are self-delimiting, so you can write CBOR at one end of
		1090	a handle and read them at the other end without using any additional
		1091	framing.
		1092
		1093	A simple nd very very fast RPC protocol that interoperates with
		1094	other languages is to send CBOR and receive CBOR values (arrays are
		1095	recommended):
		1096
		1097	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1098
		1099	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1100
		1101	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1102
1019	=cut	1103	=cut
1020		1104
1021	sub json_coder() {	1105	sub json_coder() {
1022	eval { require JSON::XS; JSON::XS->new->utf8 }	1106	eval { require JSON::XS; JSON::XS->new->utf8 }
1023	\|\| do { require JSON; JSON->new->utf8 }	1107	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1024	}	1108	}
1025		1109
1026	register_write_type json => sub {	1110	register_write_type json => sub {
1027	my ($self, $ref) = @_;	1111	my ($self, $ref) = @_;
1028		1112
1029	my $json = $self->{json} \|\|= json_coder;	1113	($self->{json} \|\|= json_coder)
1030
1031	$json->encode ($ref)	1114	->encode ($ref)
		1115	};
		1116
		1117	sub cbor_coder() {
		1118	require CBOR::XS;
		1119	CBOR::XS->new
		1120	}
		1121
		1122	register_write_type cbor => sub {
		1123	my ($self, $scalar) = @_;
		1124
		1125	($self->{cbor} \|\|= cbor_coder)
		1126	->encode ($scalar)
1032	};	1127	};
1033		1128
1034	=item storable => $reference	1129	=item storable => $reference
1035		1130
1036	Freezes the given reference using L<Storable> and writes it to the	1131	Freezes the given reference using L<Storable> and writes it to the
…		…
1039	=cut	1134	=cut
1040		1135
1041	register_write_type storable => sub {	1136	register_write_type storable => sub {
1042	my ($self, $ref) = @_;	1137	my ($self, $ref) = @_;
1043		1138
1044	require Storable;	1139	require Storable unless $Storable::VERSION;
1045		1140
1046	pack "w/a*", Storable::nfreeze ($ref)	1141	pack "w/a*", Storable::nfreeze ($ref)
1047	};	1142	};
1048		1143
1049	=back	1144	=back
…		…
1054	before it was actually written. One way to do that is to replace your	1149	before it was actually written. One way to do that is to replace your
1055	C<on_drain> handler by a callback that shuts down the socket (and set	1150	C<on_drain> handler by a callback that shuts down the socket (and set
1056	C<low_water_mark> to C<0>). This method is a shorthand for just that, and	1151	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
1057	replaces the C<on_drain> callback with:	1152	replaces the C<on_drain> callback with:
1058		1153
1059	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1154	sub { shutdown $_[0]{fh}, 1 }
1060		1155
1061	This simply shuts down the write side and signals an EOF condition to the	1156	This simply shuts down the write side and signals an EOF condition to the
1062	the peer.	1157	the peer.
1063		1158
1064	You can rely on the normal read queue and C<on_eof> handling	1159	You can rely on the normal read queue and C<on_eof> handling
…		…
1086		1181
1087	Whenever the given C<type> is used, C<push_write> will the function with	1182	Whenever the given C<type> is used, C<push_write> will the function with
1088	the handle object and the remaining arguments.	1183	the handle object and the remaining arguments.
1089		1184
1090	The function is supposed to return a single octet string that will be	1185	The function is supposed to return a single octet string that will be
1091	appended to the write buffer, so you cna mentally treat this function as a	1186	appended to the write buffer, so you can mentally treat this function as a
1092	"arguments to on-the-wire-format" converter.	1187	"arguments to on-the-wire-format" converter.
1093		1188
1094	Example: implement a custom write type C<join> that joins the remaining	1189	Example: implement a custom write type C<join> that joins the remaining
1095	arguments using the first one.	1190	arguments using the first one.
1096		1191
…		…
1390	data.	1485	data.
1391		1486
1392	Example: read 2 bytes.	1487	Example: read 2 bytes.
1393		1488
1394	$handle->push_read (chunk => 2, sub {	1489	$handle->push_read (chunk => 2, sub {
1395	warn "yay ", unpack "H*", $_[1];	1490	say "yay " . unpack "H*", $_[1];
1396	});	1491	});
1397		1492
1398	=cut	1493	=cut
1399		1494
1400	register_read_type chunk => sub {	1495	register_read_type chunk => sub {
…		…
1430		1525
1431	register_read_type line => sub {	1526	register_read_type line => sub {
1432	my ($self, $cb, $eol) = @_;	1527	my ($self, $cb, $eol) = @_;
1433		1528
1434	if (@_ < 3) {	1529	if (@_ < 3) {
1435	# this is more than twice as fast as the generic code below	1530	# this is faster then the generic code below
1436	sub {	1531	sub {
1437	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1532	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1533	or return;
1438		1534
		1535	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1439	$cb->($_[0], $1, $2);	1536	$cb->($_[0], $str, "$1");
1440	1	1537	1
1441	}	1538	}
1442	} else {	1539	} else {
1443	$eol = quotemeta $eol unless ref $eol;	1540	$eol = quotemeta $eol unless ref $eol;
1444	$eol = qr\|^(.*?)($eol)\|s;	1541	$eol = qr\|^(.*?)($eol)\|s;
1445		1542
1446	sub {	1543	sub {
1447	$_[0]{rbuf} =~ s/$eol// or return;	1544	$_[0]{rbuf} =~ s/$eol// or return;
1448		1545
1449	$cb->($_[0], $1, $2);	1546	$cb->($_[0], "$1", "$2");
1450	1	1547	1
1451	}	1548	}
1452	}	1549	}
1453	};	1550	};
1454		1551
…		…
1502		1599
1503	sub {	1600	sub {
1504	# accept	1601	# accept
1505	if ($$rbuf =~ $accept) {	1602	if ($$rbuf =~ $accept) {
1506	$data .= substr $$rbuf, 0, $+[0], "";	1603	$data .= substr $$rbuf, 0, $+[0], "";
1507	$cb->($self, $data);	1604	$cb->($_[0], $data);
1508	return 1;	1605	return 1;
1509	}	1606	}
1510		1607
1511	# reject	1608	# reject
1512	if ($reject && $$rbuf =~ $reject) {	1609	if ($reject && $$rbuf =~ $reject) {
1513	$self->_error (Errno::EBADMSG);	1610	$_[0]->_error (Errno::EBADMSG);
1514	}	1611	}
1515		1612
1516	# skip	1613	# skip
1517	if ($skip && $$rbuf =~ $skip) {	1614	if ($skip && $$rbuf =~ $skip) {
1518	$data .= substr $$rbuf, 0, $+[0], "";	1615	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1534	my ($self, $cb) = @_;	1631	my ($self, $cb) = @_;
1535		1632
1536	sub {	1633	sub {
1537	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1634	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1538	if ($_[0]{rbuf} =~ /[^0-9]/) {	1635	if ($_[0]{rbuf} =~ /[^0-9]/) {
1539	$self->_error (Errno::EBADMSG);	1636	$_[0]->_error (Errno::EBADMSG);
1540	}	1637	}
1541	return;	1638	return;
1542	}	1639	}
1543		1640
1544	my $len = $1;	1641	my $len = $1;
1545		1642
1546	$self->unshift_read (chunk => $len, sub {	1643	$_[0]->unshift_read (chunk => $len, sub {
1547	my $string = $_[1];	1644	my $string = $_[1];
1548	$_[0]->unshift_read (chunk => 1, sub {	1645	$_[0]->unshift_read (chunk => 1, sub {
1549	if ($_[1] eq ",") {	1646	if ($_[1] eq ",") {
1550	$cb->($_[0], $string);	1647	$cb->($_[0], $string);
1551	} else {	1648	} else {
1552	$self->_error (Errno::EBADMSG);	1649	$_[0]->_error (Errno::EBADMSG);
1553	}	1650	}
1554	});	1651	});
1555	});	1652	});
1556		1653
1557	1	1654	1
…		…
1607	=item json => $cb->($handle, $hash_or_arrayref)	1704	=item json => $cb->($handle, $hash_or_arrayref)
1608		1705
1609	Reads a JSON object or array, decodes it and passes it to the	1706	Reads a JSON object or array, decodes it and passes it to the
1610	callback. When a parse error occurs, an C<EBADMSG> error will be raised.	1707	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1611		1708
1612	If a C<json> object was passed to the constructor, then that will be used	1709	If a C<json> object was passed to the constructor, then that will be
1613	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1710	used for the final decode, otherwise it will create a L<JSON::XS> or
		1711	L<JSON::PP> coder object expecting UTF-8.
1614		1712
1615	This read type uses the incremental parser available with JSON version	1713	This read type uses the incremental parser available with JSON version
1616	2.09 (and JSON::XS version 2.2) and above. You have to provide a	1714	2.09 (and JSON::XS version 2.2) and above.
1617	dependency on your own: this module will load the JSON module, but
1618	AnyEvent does not depend on it itself.
1619		1715
1620	Since JSON texts are fully self-delimiting, the C<json> read and write	1716	Since JSON texts are fully self-delimiting, the C<json> read and write
1621	types are an ideal simple RPC protocol: just exchange JSON datagrams. See	1717	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1622	the C<json> write type description, above, for an actual example.	1718	the C<json> write type description, above, for an actual example.
1623		1719
…		…
1627	my ($self, $cb) = @_;	1723	my ($self, $cb) = @_;
1628		1724
1629	my $json = $self->{json} \|\|= json_coder;	1725	my $json = $self->{json} \|\|= json_coder;
1630		1726
1631	my $data;	1727	my $data;
1632	my $rbuf = \$self->{rbuf};
1633		1728
1634	sub {	1729	sub {
1635	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1730	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1636		1731
1637	if ($ref) {	1732	if ($ref) {
1638	$self->{rbuf} = $json->incr_text;	1733	$_[0]{rbuf} = $json->incr_text;
1639	$json->incr_text = "";	1734	$json->incr_text = "";
1640	$cb->($self, $ref);	1735	$cb->($_[0], $ref);
1641		1736
1642	1	1737	1
1643	} elsif ($@) {	1738	} elsif ($@) {
1644	# error case	1739	# error case
1645	$json->incr_skip;	1740	$json->incr_skip;
1646		1741
1647	$self->{rbuf} = $json->incr_text;	1742	$_[0]{rbuf} = $json->incr_text;
1648	$json->incr_text = "";	1743	$json->incr_text = "";
1649		1744
1650	$self->_error (Errno::EBADMSG);	1745	$_[0]->_error (Errno::EBADMSG);
1651		1746
1652	()	1747	()
1653	} else {	1748	} else {
1654	$self->{rbuf} = "";	1749	$_[0]{rbuf} = "";
1655		1750
		1751	()
		1752	}
		1753	}
		1754	};
		1755
		1756	=item cbor => $cb->($handle, $scalar)
		1757
		1758	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1759	error occurs, an C<EBADMSG> error will be raised.
		1760
		1761	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1762	used for the final decode, otherwise it will create a CBOR coder without
		1763	enabling any options.
		1764
		1765	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1766	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1767	itself.
		1768
		1769	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1770	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1771	the C<cbor> write type description, above, for an actual example.
		1772
		1773	=cut
		1774
		1775	register_read_type cbor => sub {
		1776	my ($self, $cb) = @_;
		1777
		1778	my $cbor = $self->{cbor} \|\|= cbor_coder;
		1779
		1780	my $data;
		1781
		1782	sub {
		1783	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1784
		1785	if (@value) {
		1786	$cb->($_[0], @value);
		1787
		1788	1
		1789	} elsif ($@) {
		1790	# error case
		1791	$cbor->incr_reset;
		1792
		1793	$_[0]->_error (Errno::EBADMSG);
		1794
		1795	()
		1796	} else {
1656	()	1797	()
1657	}	1798	}
1658	}	1799	}
1659	};	1800	};
1660		1801
…		…
1669	=cut	1810	=cut
1670		1811
1671	register_read_type storable => sub {	1812	register_read_type storable => sub {
1672	my ($self, $cb) = @_;	1813	my ($self, $cb) = @_;
1673		1814
1674	require Storable;	1815	require Storable unless $Storable::VERSION;
1675		1816
1676	sub {	1817	sub {
1677	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1818	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1678	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1819	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1679	or return;	1820	or return;
…		…
1682		1823
1683	# bypass unshift if we already have the remaining chunk	1824	# bypass unshift if we already have the remaining chunk
1684	if ($format + $len <= length $_[0]{rbuf}) {	1825	if ($format + $len <= length $_[0]{rbuf}) {
1685	my $data = substr $_[0]{rbuf}, $format, $len;	1826	my $data = substr $_[0]{rbuf}, $format, $len;
1686	substr $_[0]{rbuf}, 0, $format + $len, "";	1827	substr $_[0]{rbuf}, 0, $format + $len, "";
		1828
1687	$cb->($_[0], Storable::thaw ($data));	1829	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1830	or return $_[0]->_error (Errno::EBADMSG);
1688	} else {	1831	} else {
1689	# remove prefix	1832	# remove prefix
1690	substr $_[0]{rbuf}, 0, $format, "";	1833	substr $_[0]{rbuf}, 0, $format, "";
1691		1834
1692	# read remaining chunk	1835	# read remaining chunk
1693	$_[0]->unshift_read (chunk => $len, sub {	1836	$_[0]->unshift_read (chunk => $len, sub {
1694	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1837	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1695	$cb->($_[0], $ref);
1696	} else {
1697	$self->_error (Errno::EBADMSG);	1838	or $_[0]->_error (Errno::EBADMSG);
1698	}
1699	});	1839	});
1700	}	1840	}
1701		1841
1702	1	1842	1
1703	}	1843	}
		1844	};
		1845
		1846	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1847
		1848	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1849	record without consuming anything. Only SSL version 3 or higher
		1850	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1851	SSL2-compatible framing is supported).
		1852
		1853	If it detects that the input data is likely TLS, it calls the callback
		1854	with a true value for C<$detect> and the (on-wire) TLS version as second
		1855	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1856	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1857	be definitely not TLS, it calls the callback with a false value for
		1858	C<$detect>.
		1859
		1860	The callback could use this information to decide whether or not to start
		1861	TLS negotiation.
		1862
		1863	In all cases the data read so far is passed to the following read
		1864	handlers.
		1865
		1866	Usually you want to use the C<tls_autostart> read type instead.
		1867
		1868	If you want to design a protocol that works in the presence of TLS
		1869	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1870	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1871	read type does are a bit more strict, but might losen in the future to
		1872	accomodate protocol changes.
		1873
		1874	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1875	L<Net::SSLeay>).
		1876
		1877	=item tls_autostart => $tls[, $tls_ctx]
		1878
		1879	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1880	to start tls by calling C<starttls> with the given arguments.
		1881
		1882	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1883	been configured to accept, as servers do not normally send a handshake on
		1884	their own and ths cannot be detected in this way.
		1885
		1886	See C<tls_detect> above for more details.
		1887
		1888	Example: give the client a chance to start TLS before accepting a text
		1889	line.
		1890
		1891	$hdl->push_read (tls_detect => "accept");
		1892	$hdl->push_read (line => sub {
		1893	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1894	});
		1895
		1896	=cut
		1897
		1898	register_read_type tls_detect => sub {
		1899	my ($self, $cb) = @_;
		1900
		1901	sub {
		1902	# this regex matches a full or partial tls record
		1903	if (
		1904	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1905	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1906	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1907	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1908	) {
		1909	return if 3 != length $1; # partial match, can't decide yet
		1910
		1911	# full match, valid TLS record
		1912	my ($major, $minor) = unpack "CC", $1;
		1913	$cb->($self, "accept", $major + $minor * 0.1);
		1914	} else {
		1915	# mismatch == guaranteed not TLS
		1916	$cb->($self, undef);
		1917	}
		1918
		1919	1
		1920	}
		1921	};
		1922
		1923	register_read_type tls_autostart => sub {
		1924	my ($self, @tls) = @_;
		1925
		1926	$RH{tls_detect}($self, sub {
		1927	return unless $_[1];
		1928	$_[0]->starttls (@tls);
		1929	})
1704	};	1930	};
1705		1931
1706	=back	1932	=back
1707		1933
1708	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1934	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1740	Note that AnyEvent::Handle will automatically C<start_read> for you when	1966	Note that AnyEvent::Handle will automatically C<start_read> for you when
1741	you change the C<on_read> callback or push/unshift a read callback, and it	1967	you change the C<on_read> callback or push/unshift a read callback, and it
1742	will automatically C<stop_read> for you when neither C<on_read> is set nor	1968	will automatically C<stop_read> for you when neither C<on_read> is set nor
1743	there are any read requests in the queue.	1969	there are any read requests in the queue.
1744		1970
1745	These methods will have no effect when in TLS mode (as TLS doesn't support	1971	In older versions of this module (<= 5.3), these methods had no effect,
1746	half-duplex connections).	1972	as TLS does not support half-duplex connections. In current versions they
		1973	work as expected, as this behaviour is required to avoid certain resource
		1974	attacks, where the program would be forced to read (and buffer) arbitrary
		1975	amounts of data before being able to send some data. The drawback is that
		1976	some readings of the the SSL/TLS specifications basically require this
		1977	attack to be working, as SSL/TLS implementations might stall sending data
		1978	during a rehandshake.
		1979
		1980	As a guideline, during the initial handshake, you should not stop reading,
		1981	and as a client, it might cause problems, depending on your application.
1747		1982
1748	=cut	1983	=cut
1749		1984
1750	sub stop_read {	1985	sub stop_read {
1751	my ($self) = @_;	1986	my ($self) = @_;
1752		1987
1753	delete $self->{_rw} unless $self->{tls};	1988	delete $self->{_rw};
1754	}	1989	}
1755		1990
1756	sub start_read {	1991	sub start_read {
1757	my ($self) = @_;	1992	my ($self) = @_;
1758		1993
…		…
1799	my ($self, $err) = @_;	2034	my ($self, $err) = @_;
1800		2035
1801	return $self->_error ($!, 1)	2036	return $self->_error ($!, 1)
1802	if $err == Net::SSLeay::ERROR_SYSCALL ();	2037	if $err == Net::SSLeay::ERROR_SYSCALL ();
1803		2038
1804	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2039	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1805		2040
1806	# reduce error string to look less scary	2041	# reduce error string to look less scary
1807	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2042	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1808		2043
1809	if ($self->{_on_starttls}) {	2044	if ($self->{_on_starttls}) {
…		…
1823	sub _dotls {	2058	sub _dotls {
1824	my ($self) = @_;	2059	my ($self) = @_;
1825		2060
1826	my $tmp;	2061	my $tmp;
1827		2062
1828	if (length $self->{_tls_wbuf}) {	2063	while (length $self->{_tls_wbuf}) {
1829	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2064	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1830	substr $self->{_tls_wbuf}, 0, $tmp, "";	2065	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2066
		2067	return $self->_tls_error ($tmp)
		2068	if $tmp != $ERROR_WANT_READ
		2069	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		2070
		2071	last;
1831	}	2072	}
1832		2073
1833	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2074	substr $self->{_tls_wbuf}, 0, $tmp, "";
1834	return $self->_tls_error ($tmp)
1835	if $tmp != $ERROR_WANT_READ
1836	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1837	}	2075	}
1838		2076
1839	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2077	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1840	unless (length $tmp) {	2078	unless (length $tmp) {
1841	$self->{_on_starttls}	2079	$self->{_on_starttls}
…		…
1855	$self->{_tls_rbuf} .= $tmp;	2093	$self->{_tls_rbuf} .= $tmp;
1856	$self->_drain_rbuf;	2094	$self->_drain_rbuf;
1857	$self->{tls} or return; # tls session might have gone away in callback	2095	$self->{tls} or return; # tls session might have gone away in callback
1858	}	2096	}
1859		2097
1860	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	2098	$tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us
1861	return $self->_tls_error ($tmp)	2099	return $self->_tls_error ($tmp)
1862	if $tmp != $ERROR_WANT_READ	2100	if $tmp != $ERROR_WANT_READ
1863	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2101	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1864		2102
1865	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2103	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1875		2113
1876	=item $handle->starttls ($tls[, $tls_ctx])	2114	=item $handle->starttls ($tls[, $tls_ctx])
1877		2115
1878	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2116	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1879	object is created, you can also do that at a later time by calling	2117	object is created, you can also do that at a later time by calling
1880	C<starttls>.	2118	C<starttls>. See the C<tls> constructor argument for general info.
1881		2119
1882	Starting TLS is currently an asynchronous operation - when you push some	2120	Starting TLS is currently an asynchronous operation - when you push some
1883	write data and then call C<< ->starttls >> then TLS negotiation will start	2121	write data and then call C<< ->starttls >> then TLS negotiation will start
1884	immediately, after which the queued write data is then sent.	2122	immediately, after which the queued write data is then sent. This might
		2123	change in future versions, so best make sure you have no outstanding write
		2124	data when calling this method.
1885		2125
1886	The first argument is the same as the C<tls> constructor argument (either	2126	The first argument is the same as the C<tls> constructor argument (either
1887	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2127	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1888		2128
1889	The second argument is the optional C<AnyEvent::TLS> object that is used	2129	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1911	my ($self, $tls, $ctx) = @_;	2151	my ($self, $tls, $ctx) = @_;
1912		2152
1913	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2153	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1914	if $self->{tls};	2154	if $self->{tls};
1915		2155
		2156	unless (defined $AnyEvent::TLS::VERSION) {
		2157	eval {
		2158	require Net::SSLeay;
		2159	require AnyEvent::TLS;
		2160	1
		2161	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2162	}
		2163
1916	$self->{tls} = $tls;	2164	$self->{tls} = $tls;
1917	$self->{tls_ctx} = $ctx if @_ > 2;	2165	$self->{tls_ctx} = $ctx if @_ > 2;
1918		2166
1919	return unless $self->{fh};	2167	return unless $self->{fh};
1920		2168
1921	require Net::SSLeay;
1922
1923	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2169	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1924	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2170	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1925		2171
1926	$tls = delete $self->{tls};	2172	$tls = delete $self->{tls};
1927	$ctx = $self->{tls_ctx};	2173	$ctx = $self->{tls_ctx};
1928		2174
1929	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2175	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1930		2176
1931	if ("HASH" eq ref $ctx) {	2177	if ("HASH" eq ref $ctx) {
1932	require AnyEvent::TLS;
1933
1934	if ($ctx->{cache}) {	2178	if ($ctx->{cache}) {
1935	my $key = $ctx+0;	2179	my $key = $ctx+0;
1936	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2180	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1937	} else {	2181	} else {
1938	$ctx = new AnyEvent::TLS %$ctx;	2182	$ctx = new AnyEvent::TLS %$ctx;
…		…
1960	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2204	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1961		2205
1962	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2206	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1963	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2207	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1964		2208
1965	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2209	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2210	$self->{rbuf} = "";
1966		2211
1967	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2212	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1968		2213
1969	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2214	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1970	if $self->{on_starttls};	2215	if $self->{on_starttls};
…		…
2007	$self->{tls_ctx}->_put_session (delete $self->{tls})	2252	$self->{tls_ctx}->_put_session (delete $self->{tls})
2008	if $self->{tls} > 0;	2253	if $self->{tls} > 0;
2009		2254
2010	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2255	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
2011	}	2256	}
		2257
		2258	=item $handle->resettls
		2259
		2260	This rarely-used method simply resets and TLS state on the handle, usually
		2261	causing data loss.
		2262
		2263	One case where it may be useful is when you want to skip over the data in
		2264	the stream but you are not interested in interpreting it, so data loss is
		2265	no concern.
		2266
		2267	=cut
		2268
		2269	*resettls = \&_freetls;
2012		2270
2013	sub DESTROY {	2271	sub DESTROY {
2014	my ($self) = @_;	2272	my ($self) = @_;
2015		2273
2016	&_freetls;	2274	&_freetls;
…		…
2132		2390
2133	It is only safe to "forget" the reference inside EOF or error callbacks,	2391	It is only safe to "forget" the reference inside EOF or error callbacks,
2134	from within all other callbacks, you need to explicitly call the C<<	2392	from within all other callbacks, you need to explicitly call the C<<
2135	->destroy >> method.	2393	->destroy >> method.
2136		2394
		2395	=item Why is my C<on_eof> callback never called?
		2396
		2397	Probably because your C<on_error> callback is being called instead: When
		2398	you have outstanding requests in your read queue, then an EOF is
		2399	considered an error as you clearly expected some data.
		2400
		2401	To avoid this, make sure you have an empty read queue whenever your handle
		2402	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2403	an C<on_read> handler that simply pushes the first read requests in the
		2404	queue.
		2405
		2406	See also the next question, which explains this in a bit more detail.
		2407
		2408	=item How can I serve requests in a loop?
		2409
		2410	Most protocols consist of some setup phase (authentication for example)
		2411	followed by a request handling phase, where the server waits for requests
		2412	and handles them, in a loop.
		2413
		2414	There are two important variants: The first (traditional, better) variant
		2415	handles requests until the server gets some QUIT command, causing it to
		2416	close the connection first (highly desirable for a busy TCP server). A
		2417	client dropping the connection is an error, which means this variant can
		2418	detect an unexpected detection close.
		2419
		2420	To handle this case, always make sure you have a non-empty read queue, by
		2421	pushing the "read request start" handler on it:
		2422
		2423	# we assume a request starts with a single line
		2424	my @start_request; @start_request = (line => sub {
		2425	my ($hdl, $line) = @_;
		2426
		2427	... handle request
		2428
		2429	# push next request read, possibly from a nested callback
		2430	$hdl->push_read (@start_request);
		2431	});
		2432
		2433	# auth done, now go into request handling loop
		2434	# now push the first @start_request
		2435	$hdl->push_read (@start_request);
		2436
		2437	By always having an outstanding C<push_read>, the handle always expects
		2438	some data and raises the C<EPIPE> error when the connction is dropped
		2439	unexpectedly.
		2440
		2441	The second variant is a protocol where the client can drop the connection
		2442	at any time. For TCP, this means that the server machine may run out of
		2443	sockets easier, and in general, it means you cannot distinguish a protocl
		2444	failure/client crash from a normal connection close. Nevertheless, these
		2445	kinds of protocols are common (and sometimes even the best solution to the
		2446	problem).
		2447
		2448	Having an outstanding read request at all times is possible if you ignore
		2449	C<EPIPE> errors, but this doesn't help with when the client drops the
		2450	connection during a request, which would still be an error.
		2451
		2452	A better solution is to push the initial request read in an C<on_read>
		2453	callback. This avoids an error, as when the server doesn't expect data
		2454	(i.e. is idly waiting for the next request, an EOF will not raise an
		2455	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2456	and simpler:
		2457
		2458	# auth done, now go into request handling loop
		2459	$hdl->on_read (sub {
		2460	my ($hdl) = @_;
		2461
		2462	# called each time we receive data but the read queue is empty
		2463	# simply start read the request
		2464
		2465	$hdl->push_read (line => sub {
		2466	my ($hdl, $line) = @_;
		2467
		2468	... handle request
		2469
		2470	# do nothing special when the request has been handled, just
		2471	# let the request queue go empty.
		2472	});
		2473	});
		2474
2137	=item I get different callback invocations in TLS mode/Why can't I pause	2475	=item I get different callback invocations in TLS mode/Why can't I pause
2138	reading?	2476	reading?
2139		2477
2140	Unlike, say, TCP, TLS connections do not consist of two independent	2478	Unlike, say, TCP, TLS connections do not consist of two independent
2141	communication channels, one for each direction. Or put differently, the	2479	communication channels, one for each direction. Or put differently, the
…		…
2162	$handle->on_eof (undef);	2500	$handle->on_eof (undef);
2163	$handle->on_error (sub {	2501	$handle->on_error (sub {
2164	my $data = delete $_[0]{rbuf};	2502	my $data = delete $_[0]{rbuf};
2165	});	2503	});
2166		2504
		2505	Note that this example removes the C<rbuf> member from the handle object,
		2506	which is not normally allowed by the API. It is expressly permitted in
		2507	this case only, as the handle object needs to be destroyed afterwards.
		2508
2167	The reason to use C<on_error> is that TCP connections, due to latencies	2509	The reason to use C<on_error> is that TCP connections, due to latencies
2168	and packets loss, might get closed quite violently with an error, when in	2510	and packets loss, might get closed quite violently with an error, when in
2169	fact all data has been received.	2511	fact all data has been received.
2170		2512
2171	It is usually better to use acknowledgements when transferring data,	2513	It is usually better to use acknowledgements when transferring data,
…		…
2181	C<low_water_mark> this will be called precisely when all data has been	2523	C<low_water_mark> this will be called precisely when all data has been
2182	written to the socket:	2524	written to the socket:
2183		2525
2184	$handle->push_write (...);	2526	$handle->push_write (...);
2185	$handle->on_drain (sub {	2527	$handle->on_drain (sub {
2186	warn "all data submitted to the kernel\n";	2528	AE::log debug => "All data submitted to the kernel.";
2187	undef $handle;	2529	undef $handle;
2188	});	2530	});
2189		2531
2190	If you just want to queue some data and then signal EOF to the other side,	2532	If you just want to queue some data and then signal EOF to the other side,
2191	consider using C<< ->push_shutdown >> instead.	2533	consider using C<< ->push_shutdown >> instead.
…		…
2275	When you have intermediate CA certificates that your clients might not	2617	When you have intermediate CA certificates that your clients might not
2276	know about, just append them to the C<cert_file>.	2618	know about, just append them to the C<cert_file>.
2277		2619
2278	=back	2620	=back
2279		2621
2280
2281	=head1 SUBCLASSING AnyEvent::Handle	2622	=head1 SUBCLASSING AnyEvent::Handle
2282		2623
2283	In many cases, you might want to subclass AnyEvent::Handle.	2624	In many cases, you might want to subclass AnyEvent::Handle.
2284		2625
2285	To make this easier, a given version of AnyEvent::Handle uses these	2626	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2311		2652
2312	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2653	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2313		2654
2314	=cut	2655	=cut
2315		2656
2316	1; # End of AnyEvent::Handle	2657	1
		2658

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.203 by root, Sat Oct 16 03:22:10 2010 UTC vs. Revision 1.240 by root, Tue Dec 17 16:43:15 2013 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.203 by root, Sat Oct 16 03:22:10 2010 UTC vs.
Revision 1.240 by root, Tue Dec 17 16:43:15 2013 UTC