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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.202 by root, Sat Oct 16 02:01:54 2010 UTC vs.
Revision 1.238 by root, Tue Dec 10 15:54:51 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
…		…
75	}	75	}
76		76
77	\&$func	77	\&$func
78	}	78	}
79		79
		80	sub MAX_READ_SIZE() { 131072 }
		81
80	=head1 METHODS	82	=head1 METHODS
81		83
82	=over 4	84	=over 4
83		85
84	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
…		…
112	=over 4	114	=over 4
113		115
114	=item on_prepare => $cb->($handle)	116	=item on_prepare => $cb->($handle)
115		117
116	This (rarely used) callback is called before a new connection is	118	This (rarely used) callback is called before a new connection is
117	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
118	prepare the file handle with parameters required for the actual connect	121	file handle with parameters required for the actual connect (as opposed to
119	(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).
120	established).
121		123
122	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
123	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
124	default timeout is to be used).	126	default timeout is to be used).
125		127
126	=item on_connect => $cb->($handle, $host, $port, $retry->())	128	=item on_connect => $cb->($handle, $host, $port, $retry->())
127		129
128	This callback is called when a connection has been successfully established.	130	This callback is called when a connection has been successfully established.
129		131
130	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
131	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.
132		136
		137	It is not allowed to use the read or write queues while the handle object
		138	is connecting.
		139
133	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
134	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
135	hosts or SRV records there can be multiple connection endpoints). At the	142	SRV records there can be multiple connection endpoints). The C<$retry>
136	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
137	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.
138		146
139	In most cases, you should ignore the C<$retry> parameter.	147	In most cases, you should ignore the C<$retry> parameter.
140		148
141	=item on_connect_error => $cb->($handle, $message)	149	=item on_connect_error => $cb->($handle, $message)
142		150
…		…
157		165
158	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
159	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<< ->
160	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
161	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
162	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
163	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
164	often easiest to not report C<EPIPE> errors in this callback.	172	often easiest to not report C<EPIPE> errors in this callback.
165		173
166	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
167	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.
168	recommended to always output the C<$message> argument in human-readable	176
169	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>.
170		184
171	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
172	to simply ignore this parameter and instead abondon the handle object	186	to simply ignore this parameter and instead abondon the handle object
173	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
174	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	188	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
…		…
222	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
223	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>.
224		238
225	=item on_drain => $cb->($handle)	239	=item on_drain => $cb->($handle)
226		240
227	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
228	(or immediately if the buffer is empty already).	242	empty (and immediately when the handle object is created).
229		243
230	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.
231		245
232	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
233	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
…		…
245	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
246	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
247	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>
248	error will be raised).	262	error will be raised).
249		263
250	There are three variants of the timeouts that work independently	264	There are three variants of the timeouts that work independently of each
251	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:
252	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks	267	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
253	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
254	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.	269	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
255		270
256	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
257	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
258	idle then you should disable the timeout temporarily or ignore the timeout	273	idle then you should disable the timeout temporarily or ignore the
259	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
260	restart the timeout.	275	AnyEvent::Handle will simply restart the timeout.
261		276
262	Zero (the default) disables this timeout.	277	Zero (the default) disables the corresponding timeout.
263		278
264	=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)
265		284
266	Called whenever the inactivity timeout passes. If you return from this	285	Called whenever the inactivity timeout passes. If you return from this
267	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,
268	so this condition is not fatal in any way.	287	so this condition is not fatal in any way.
269		288
…		…
276	For example, a server accepting connections from untrusted sources should	295	For example, a server accepting connections from untrusted sources should
277	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
278	(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
279	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
280	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.
281		315
282	=item autocork => <boolean>	316	=item autocork => <boolean>
283		317
284	When disabled (the default), C<push_write> will try to immediately	318	When disabled (the default), C<push_write> will try to immediately
285	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
…		…
337	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
338	from most attacks.	372	from most attacks.
339		373
340	=item read_size => <bytes>	374	=item read_size => <bytes>
341		375
342	The default read block size (the number of bytes this module will	376	The initial read block size, the number of bytes this module will try
343	try to read during each loop iteration, which affects memory	377	to read during each loop iteration. Each handle object will consume
344	requirements). Default: C<8192>.	378	at least this amount of memory for the read buffer as well, so when
		379	handling many connections watch out for memory requirements). See also
		380	C<max_read_size>. Default: C<2048>.
		381
		382	=item max_read_size => <bytes>
		383
		384	The maximum read buffer size used by the dynamic adjustment
		385	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
		386	one go it will double C<read_size> up to the maximum given by this
		387	option. Default: C<131072> or C<read_size>, whichever is higher.
345		388
346	=item low_water_mark => <bytes>	389	=item low_water_mark => <bytes>
347		390
348	Sets the number of bytes (default: C<0>) that make up an "empty" write	391	Sets the number of bytes (default: C<0>) that make up an "empty" write
349	buffer: If the buffer reaches this size or gets even samller it is	392	buffer: If the buffer reaches this size or gets even samller it is
…		…
386	appropriate error message.	429	appropriate error message.
387		430
388	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
389	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
390	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
391	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.
392		436
393	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
394	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>
395	mode.	439	mode.
396		440
…		…
412	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.
413		457
414	=item tls_ctx => $anyevent_tls	458	=item tls_ctx => $anyevent_tls
415		459
416	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
417	(unless a connection object was specified directly). If this parameter is	461	(unless a connection object was specified directly). If this
418	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>.
419		464
420	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
421	=> 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
422	new TLS context object.	467	new TLS context object.
423		468
…		…
451	callback.	496	callback.
452		497
453	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
454	underlying handle signals EOF.	499	underlying handle signals EOF.
455		500
456	=item json => JSON or JSON::XS object	501	=item json => L<JSON> or L<JSON::XS> object
457		502
458	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.
459		504
460	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
461	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
462	texts.	507	texts.
463		508
464	Note that you are responsible to depend on the JSON module if you want to	509	Note that you are responsible to depend on the L<JSON> module if you want
465	use this functionality, as AnyEvent does not have a dependency itself.	510	to use this functionality, as AnyEvent does not have a dependency on it
		511	itself.
		512
		513	=item cbor => L<CBOR::XS> object
		514
		515	This is the cbor coder object used by the C<cbor> read and write types.
		516
		517	If you don't supply it, then AnyEvent::Handle will create and use a
		518	suitable one (on demand), which will write CBOR without using extensions,
		519	if possible. texts.
		520
		521	Note that you are responsible to depend on the L<CBOR::XS> module if you
		522	want to use this functionality, as AnyEvent does not have a dependency on
		523	it itself.
466		524
467	=back	525	=back
468		526
469	=cut	527	=cut
470		528
…		…
492	$self->{connect}[0],	550	$self->{connect}[0],
493	$self->{connect}[1],	551	$self->{connect}[1],
494	sub {	552	sub {
495	my ($fh, $host, $port, $retry) = @_;	553	my ($fh, $host, $port, $retry) = @_;
496		554
		555	delete $self->{_connect}; # no longer needed
		556
497	if ($fh) {	557	if ($fh) {
498	$self->{fh} = $fh;	558	$self->{fh} = $fh;
499		559
500	delete $self->{_skip_drain_rbuf};	560	delete $self->{_skip_drain_rbuf};
501	$self->_start;	561	$self->_start;
…		…
508	});	568	});
509		569
510	} else {	570	} else {
511	if ($self->{on_connect_error}) {	571	if ($self->{on_connect_error}) {
512	$self->{on_connect_error}($self, "$!");	572	$self->{on_connect_error}($self, "$!");
513	$self->destroy;	573	$self->destroy if $self;
514	} else {	574	} else {
515	$self->_error ($!, 1);	575	$self->_error ($!, 1);
516	}	576	}
517	}	577	}
518	},	578	},
519	sub {	579	sub {
520	local $self->{fh} = $_[0];	580	local $self->{fh} = $_[0];
521		581
522	$self->{on_prepare}	582	$self->{on_prepare}
523	? $self->{on_prepare}->($self)	583	? $self->{on_prepare}->($self)
524	: ()	584	: ()
525	}	585	}
526	);	586	);
527	}	587	}
528		588
…		…
545	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	605	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
546		606
547	$self->{_activity} =	607	$self->{_activity} =
548	$self->{_ractivity} =	608	$self->{_ractivity} =
549	$self->{_wactivity} = AE::now;	609	$self->{_wactivity} = AE::now;
		610
		611	$self->{read_size} \|\|= 2048;
		612	$self->{max_read_size} = $self->{read_size}
		613	if $self->{read_size} > ($self->{max_read_size} \|\| MAX_READ_SIZE);
550		614
551	$self->timeout (delete $self->{timeout} ) if $self->{timeout};	615	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
552	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};	616	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
553	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};	617	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
554		618
…		…
723		787
724	=item $handle->rbuf_max ($max_octets)	788	=item $handle->rbuf_max ($max_octets)
725		789
726	Configures the C<rbuf_max> setting (C<undef> disables it).	790	Configures the C<rbuf_max> setting (C<undef> disables it).
727		791
		792	=item $handle->wbuf_max ($max_octets)
		793
		794	Configures the C<wbuf_max> setting (C<undef> disables it).
		795
728	=cut	796	=cut
729		797
730	sub rbuf_max {	798	sub rbuf_max {
731	$_[0]{rbuf_max} = $_[1];	799	$_[0]{rbuf_max} = $_[1];
732	}	800	}
733		801
		802	sub wbuf_max {
		803	$_[0]{wbuf_max} = $_[1];
		804	}
		805
734	#############################################################################	806	#############################################################################
735		807
736	=item $handle->timeout ($seconds)	808	=item $handle->timeout ($seconds)
737		809
738	=item $handle->rtimeout ($seconds)	810	=item $handle->rtimeout ($seconds)
739		811
740	=item $handle->wtimeout ($seconds)	812	=item $handle->wtimeout ($seconds)
741		813
742	Configures (or disables) the inactivity timeout.	814	Configures (or disables) the inactivity timeout.
		815
		816	The timeout will be checked instantly, so this method might destroy the
		817	handle before it returns.
743		818
744	=item $handle->timeout_reset	819	=item $handle->timeout_reset
745		820
746	=item $handle->rtimeout_reset	821	=item $handle->rtimeout_reset
747		822
…		…
831		906
832	The write queue is very simple: you can add data to its end, and	907	The write queue is very simple: you can add data to its end, and
833	AnyEvent::Handle will automatically try to get rid of it for you.	908	AnyEvent::Handle will automatically try to get rid of it for you.
834		909
835	When data could be written and the write buffer is shorter then the low	910	When data could be written and the write buffer is shorter then the low
836	water mark, the C<on_drain> callback will be invoked.	911	water mark, the C<on_drain> callback will be invoked once.
837		912
838	=over 4	913	=over 4
839		914
840	=item $handle->on_drain ($cb)	915	=item $handle->on_drain ($cb)
841		916
…		…
856	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});	931	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
857	}	932	}
858		933
859	=item $handle->push_write ($data)	934	=item $handle->push_write ($data)
860		935
861	Queues the given scalar to be written. You can push as much data as you	936	Queues the given scalar to be written. You can push as much data as
862	want (only limited by the available memory), as C<AnyEvent::Handle>	937	you want (only limited by the available memory and C<wbuf_max>), as
863	buffers it independently of the kernel.	938	C<AnyEvent::Handle> buffers it independently of the kernel.
864		939
865	This method may invoke callbacks (and therefore the handle might be	940	This method may invoke callbacks (and therefore the handle might be
866	destroyed after it returns).	941	destroyed after it returns).
867		942
868	=cut	943	=cut
…		…
896	$cb->() unless $self->{autocork};	971	$cb->() unless $self->{autocork};
897		972
898	# if still data left in wbuf, we need to poll	973	# if still data left in wbuf, we need to poll
899	$self->{_ww} = AE::io $self->{fh}, 1, $cb	974	$self->{_ww} = AE::io $self->{fh}, 1, $cb
900	if length $self->{wbuf};	975	if length $self->{wbuf};
		976
		977	if (
		978	defined $self->{wbuf_max}
		979	&& $self->{wbuf_max} < length $self->{wbuf}
		980	) {
		981	$self->_error (Errno::ENOSPC, 1), return;
		982	}
901	};	983	};
902	}	984	}
903		985
904	our %WH;	986	our %WH;
905		987
…		…
984		1066
985	The generated JSON text is guaranteed not to contain any newlines: While	1067	The generated JSON text is guaranteed not to contain any newlines: While
986	this module doesn't need delimiters after or between JSON texts to be	1068	this module doesn't need delimiters after or between JSON texts to be
987	able to read them, many other languages depend on that.	1069	able to read them, many other languages depend on that.
988		1070
989	A simple RPC protocol that interoperates easily with others is to send	1071	A simple RPC protocol that interoperates easily with other languages is
990	JSON arrays (or objects, although arrays are usually the better choice as	1072	to send JSON arrays (or objects, although arrays are usually the better
991	they mimic how function argument passing works) and a newline after each	1073	choice as they mimic how function argument passing works) and a newline
992	JSON text:	1074	after each JSON text:
993		1075
994	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1076	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
995	$handle->push_write ("\012");	1077	$handle->push_write ("\012");
996		1078
997	An AnyEvent::Handle receiver would simply use the C<json> read type and	1079	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
1000	$handle->push_read (json => sub { my $array = $_[1]; ... });	1082	$handle->push_read (json => sub { my $array = $_[1]; ... });
1001		1083
1002	Other languages could read single lines terminated by a newline and pass	1084	Other languages could read single lines terminated by a newline and pass
1003	this line into their JSON decoder of choice.	1085	this line into their JSON decoder of choice.
1004		1086
		1087	=item cbor => $perl_scalar
		1088
		1089	Encodes the given scalar into a CBOR value. Unless you provide your own
		1090	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1091	using any extensions, if possible.
		1092
		1093	CBOR values are self-delimiting, so you can write CBOR at one end of
		1094	a handle and read them at the other end without using any additional
		1095	framing.
		1096
		1097	A simple nd very very fast RPC protocol that interoperates with
		1098	other languages is to send CBOR and receive CBOR values (arrays are
		1099	recommended):
		1100
		1101	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1102
		1103	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1104
		1105	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1106
1005	=cut	1107	=cut
1006		1108
1007	sub json_coder() {	1109	sub json_coder() {
1008	eval { require JSON::XS; JSON::XS->new->utf8 }	1110	eval { require JSON::XS; JSON::XS->new->utf8 }
1009	\|\| do { require JSON; JSON->new->utf8 }	1111	\|\| do { require JSON; JSON->new->utf8 }
1010	}	1112	}
1011		1113
1012	register_write_type json => sub {	1114	register_write_type json => sub {
1013	my ($self, $ref) = @_;	1115	my ($self, $ref) = @_;
1014		1116
1015	my $json = $self->{json} \|\|= json_coder;	1117	($self->{json} \|\|= json_coder)
1016
1017	$json->encode ($ref)	1118	->encode ($ref)
		1119	};
		1120
		1121	sub cbor_coder() {
		1122	require CBOR::XS;
		1123	CBOR::XS->new
		1124	}
		1125
		1126	register_write_type cbor => sub {
		1127	my ($self, $scalar) = @_;
		1128
		1129	($self->{cbor} \|\|= cbor_coder)
		1130	->encode ($scalar)
1018	};	1131	};
1019		1132
1020	=item storable => $reference	1133	=item storable => $reference
1021		1134
1022	Freezes the given reference using L<Storable> and writes it to the	1135	Freezes the given reference using L<Storable> and writes it to the
…		…
1025	=cut	1138	=cut
1026		1139
1027	register_write_type storable => sub {	1140	register_write_type storable => sub {
1028	my ($self, $ref) = @_;	1141	my ($self, $ref) = @_;
1029		1142
1030	require Storable;	1143	require Storable unless $Storable::VERSION;
1031		1144
1032	pack "w/a*", Storable::nfreeze ($ref)	1145	pack "w/a*", Storable::nfreeze ($ref)
1033	};	1146	};
1034		1147
1035	=back	1148	=back
…		…
1040	before it was actually written. One way to do that is to replace your	1153	before it was actually written. One way to do that is to replace your
1041	C<on_drain> handler by a callback that shuts down the socket (and set	1154	C<on_drain> handler by a callback that shuts down the socket (and set
1042	C<low_water_mark> to C<0>). This method is a shorthand for just that, and	1155	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
1043	replaces the C<on_drain> callback with:	1156	replaces the C<on_drain> callback with:
1044		1157
1045	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1158	sub { shutdown $_[0]{fh}, 1 }
1046		1159
1047	This simply shuts down the write side and signals an EOF condition to the	1160	This simply shuts down the write side and signals an EOF condition to the
1048	the peer.	1161	the peer.
1049		1162
1050	You can rely on the normal read queue and C<on_eof> handling	1163	You can rely on the normal read queue and C<on_eof> handling
…		…
1072		1185
1073	Whenever the given C<type> is used, C<push_write> will the function with	1186	Whenever the given C<type> is used, C<push_write> will the function with
1074	the handle object and the remaining arguments.	1187	the handle object and the remaining arguments.
1075		1188
1076	The function is supposed to return a single octet string that will be	1189	The function is supposed to return a single octet string that will be
1077	appended to the write buffer, so you cna mentally treat this function as a	1190	appended to the write buffer, so you can mentally treat this function as a
1078	"arguments to on-the-wire-format" converter.	1191	"arguments to on-the-wire-format" converter.
1079		1192
1080	Example: implement a custom write type C<join> that joins the remaining	1193	Example: implement a custom write type C<join> that joins the remaining
1081	arguments using the first one.	1194	arguments using the first one.
1082		1195
…		…
1376	data.	1489	data.
1377		1490
1378	Example: read 2 bytes.	1491	Example: read 2 bytes.
1379		1492
1380	$handle->push_read (chunk => 2, sub {	1493	$handle->push_read (chunk => 2, sub {
1381	warn "yay ", unpack "H*", $_[1];	1494	say "yay " . unpack "H*", $_[1];
1382	});	1495	});
1383		1496
1384	=cut	1497	=cut
1385		1498
1386	register_read_type chunk => sub {	1499	register_read_type chunk => sub {
…		…
1416		1529
1417	register_read_type line => sub {	1530	register_read_type line => sub {
1418	my ($self, $cb, $eol) = @_;	1531	my ($self, $cb, $eol) = @_;
1419		1532
1420	if (@_ < 3) {	1533	if (@_ < 3) {
1421	# this is more than twice as fast as the generic code below	1534	# this is faster then the generic code below
1422	sub {	1535	sub {
1423	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1536	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1537	or return;
1424		1538
		1539	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1425	$cb->($_[0], $1, $2);	1540	$cb->($_[0], $str, "$1");
1426	1	1541	1
1427	}	1542	}
1428	} else {	1543	} else {
1429	$eol = quotemeta $eol unless ref $eol;	1544	$eol = quotemeta $eol unless ref $eol;
1430	$eol = qr\|^(.*?)($eol)\|s;	1545	$eol = qr\|^(.*?)($eol)\|s;
1431		1546
1432	sub {	1547	sub {
1433	$_[0]{rbuf} =~ s/$eol// or return;	1548	$_[0]{rbuf} =~ s/$eol// or return;
1434		1549
1435	$cb->($_[0], $1, $2);	1550	$cb->($_[0], "$1", "$2");
1436	1	1551	1
1437	}	1552	}
1438	}	1553	}
1439	};	1554	};
1440		1555
…		…
1488		1603
1489	sub {	1604	sub {
1490	# accept	1605	# accept
1491	if ($$rbuf =~ $accept) {	1606	if ($$rbuf =~ $accept) {
1492	$data .= substr $$rbuf, 0, $+[0], "";	1607	$data .= substr $$rbuf, 0, $+[0], "";
1493	$cb->($self, $data);	1608	$cb->($_[0], $data);
1494	return 1;	1609	return 1;
1495	}	1610	}
1496		1611
1497	# reject	1612	# reject
1498	if ($reject && $$rbuf =~ $reject) {	1613	if ($reject && $$rbuf =~ $reject) {
1499	$self->_error (Errno::EBADMSG);	1614	$_[0]->_error (Errno::EBADMSG);
1500	}	1615	}
1501		1616
1502	# skip	1617	# skip
1503	if ($skip && $$rbuf =~ $skip) {	1618	if ($skip && $$rbuf =~ $skip) {
1504	$data .= substr $$rbuf, 0, $+[0], "";	1619	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1520	my ($self, $cb) = @_;	1635	my ($self, $cb) = @_;
1521		1636
1522	sub {	1637	sub {
1523	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1638	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1524	if ($_[0]{rbuf} =~ /[^0-9]/) {	1639	if ($_[0]{rbuf} =~ /[^0-9]/) {
1525	$self->_error (Errno::EBADMSG);	1640	$_[0]->_error (Errno::EBADMSG);
1526	}	1641	}
1527	return;	1642	return;
1528	}	1643	}
1529		1644
1530	my $len = $1;	1645	my $len = $1;
1531		1646
1532	$self->unshift_read (chunk => $len, sub {	1647	$_[0]->unshift_read (chunk => $len, sub {
1533	my $string = $_[1];	1648	my $string = $_[1];
1534	$_[0]->unshift_read (chunk => 1, sub {	1649	$_[0]->unshift_read (chunk => 1, sub {
1535	if ($_[1] eq ",") {	1650	if ($_[1] eq ",") {
1536	$cb->($_[0], $string);	1651	$cb->($_[0], $string);
1537	} else {	1652	} else {
1538	$self->_error (Errno::EBADMSG);	1653	$_[0]->_error (Errno::EBADMSG);
1539	}	1654	}
1540	});	1655	});
1541	});	1656	});
1542		1657
1543	1	1658	1
…		…
1613	my ($self, $cb) = @_;	1728	my ($self, $cb) = @_;
1614		1729
1615	my $json = $self->{json} \|\|= json_coder;	1730	my $json = $self->{json} \|\|= json_coder;
1616		1731
1617	my $data;	1732	my $data;
1618	my $rbuf = \$self->{rbuf};
1619		1733
1620	sub {	1734	sub {
1621	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1735	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1622		1736
1623	if ($ref) {	1737	if ($ref) {
1624	$self->{rbuf} = $json->incr_text;	1738	$_[0]{rbuf} = $json->incr_text;
1625	$json->incr_text = "";	1739	$json->incr_text = "";
1626	$cb->($self, $ref);	1740	$cb->($_[0], $ref);
1627		1741
1628	1	1742	1
1629	} elsif ($@) {	1743	} elsif ($@) {
1630	# error case	1744	# error case
1631	$json->incr_skip;	1745	$json->incr_skip;
1632		1746
1633	$self->{rbuf} = $json->incr_text;	1747	$_[0]{rbuf} = $json->incr_text;
1634	$json->incr_text = "";	1748	$json->incr_text = "";
1635		1749
1636	$self->_error (Errno::EBADMSG);	1750	$_[0]->_error (Errno::EBADMSG);
1637		1751
1638	()	1752	()
1639	} else {	1753	} else {
1640	$self->{rbuf} = "";	1754	$_[0]{rbuf} = "";
1641		1755
		1756	()
		1757	}
		1758	}
		1759	};
		1760
		1761	=item cbor => $cb->($handle, $scalar)
		1762
		1763	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1764	error occurs, an C<EBADMSG> error will be raised.
		1765
		1766	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1767	used for the final decode, otherwise it will create a CBOR coder without
		1768	enabling any options.
		1769
		1770	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1771	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1772	itself.
		1773
		1774	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1775	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1776	the C<cbor> write type description, above, for an actual example.
		1777
		1778	=cut
		1779
		1780	register_read_type cbor => sub {
		1781	my ($self, $cb) = @_;
		1782
		1783	my $cbor = $self->{cbor} \|\|= cbor_coder;
		1784
		1785	my $data;
		1786
		1787	sub {
		1788	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1789
		1790	if (@value) {
		1791	$cb->($_[0], @value);
		1792
		1793	1
		1794	} elsif ($@) {
		1795	# error case
		1796	$cbor->incr_reset;
		1797
		1798	$_[0]->_error (Errno::EBADMSG);
		1799
		1800	()
		1801	} else {
1642	()	1802	()
1643	}	1803	}
1644	}	1804	}
1645	};	1805	};
1646		1806
…		…
1655	=cut	1815	=cut
1656		1816
1657	register_read_type storable => sub {	1817	register_read_type storable => sub {
1658	my ($self, $cb) = @_;	1818	my ($self, $cb) = @_;
1659		1819
1660	require Storable;	1820	require Storable unless $Storable::VERSION;
1661		1821
1662	sub {	1822	sub {
1663	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1823	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1664	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1824	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1665	or return;	1825	or return;
…		…
1668		1828
1669	# bypass unshift if we already have the remaining chunk	1829	# bypass unshift if we already have the remaining chunk
1670	if ($format + $len <= length $_[0]{rbuf}) {	1830	if ($format + $len <= length $_[0]{rbuf}) {
1671	my $data = substr $_[0]{rbuf}, $format, $len;	1831	my $data = substr $_[0]{rbuf}, $format, $len;
1672	substr $_[0]{rbuf}, 0, $format + $len, "";	1832	substr $_[0]{rbuf}, 0, $format + $len, "";
		1833
1673	$cb->($_[0], Storable::thaw ($data));	1834	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1835	or return $_[0]->_error (Errno::EBADMSG);
1674	} else {	1836	} else {
1675	# remove prefix	1837	# remove prefix
1676	substr $_[0]{rbuf}, 0, $format, "";	1838	substr $_[0]{rbuf}, 0, $format, "";
1677		1839
1678	# read remaining chunk	1840	# read remaining chunk
1679	$_[0]->unshift_read (chunk => $len, sub {	1841	$_[0]->unshift_read (chunk => $len, sub {
1680	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1842	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1681	$cb->($_[0], $ref);
1682	} else {
1683	$self->_error (Errno::EBADMSG);	1843	or $_[0]->_error (Errno::EBADMSG);
1684	}
1685	});	1844	});
1686	}	1845	}
1687		1846
1688	1	1847	1
1689	}	1848	}
		1849	};
		1850
		1851	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1852
		1853	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1854	record without consuming anything. Only SSL version 3 or higher
		1855	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1856	SSL2-compatible framing is supported).
		1857
		1858	If it detects that the input data is likely TLS, it calls the callback
		1859	with a true value for C<$detect> and the (on-wire) TLS version as second
		1860	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1861	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1862	be definitely not TLS, it calls the callback with a false value for
		1863	C<$detect>.
		1864
		1865	The callback could use this information to decide whether or not to start
		1866	TLS negotiation.
		1867
		1868	In all cases the data read so far is passed to the following read
		1869	handlers.
		1870
		1871	Usually you want to use the C<tls_autostart> read type instead.
		1872
		1873	If you want to design a protocol that works in the presence of TLS
		1874	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1875	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1876	read type does are a bit more strict, but might losen in the future to
		1877	accomodate protocol changes.
		1878
		1879	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1880	L<Net::SSLeay>).
		1881
		1882	=item tls_autostart => $tls[, $tls_ctx]
		1883
		1884	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1885	to start tls by calling C<starttls> with the given arguments.
		1886
		1887	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1888	been configured to accept, as servers do not normally send a handshake on
		1889	their own and ths cannot be detected in this way.
		1890
		1891	See C<tls_detect> above for more details.
		1892
		1893	Example: give the client a chance to start TLS before accepting a text
		1894	line.
		1895
		1896	$hdl->push_read (tls_detect => "accept");
		1897	$hdl->push_read (line => sub {
		1898	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1899	});
		1900
		1901	=cut
		1902
		1903	register_read_type tls_detect => sub {
		1904	my ($self, $cb) = @_;
		1905
		1906	sub {
		1907	# this regex matches a full or partial tls record
		1908	if (
		1909	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1910	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1911	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1912	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1913	) {
		1914	return if 3 != length $1; # partial match, can't decide yet
		1915
		1916	# full match, valid TLS record
		1917	my ($major, $minor) = unpack "CC", $1;
		1918	$cb->($self, "accept", $major + $minor * 0.1);
		1919	} else {
		1920	# mismatch == guaranteed not TLS
		1921	$cb->($self, undef);
		1922	}
		1923
		1924	1
		1925	}
		1926	};
		1927
		1928	register_read_type tls_autostart => sub {
		1929	my ($self, @tls) = @_;
		1930
		1931	$RH{tls_detect}($self, sub {
		1932	return unless $_[1];
		1933	$_[0]->starttls (@tls);
		1934	})
1690	};	1935	};
1691		1936
1692	=back	1937	=back
1693		1938
1694	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1939	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1726	Note that AnyEvent::Handle will automatically C<start_read> for you when	1971	Note that AnyEvent::Handle will automatically C<start_read> for you when
1727	you change the C<on_read> callback or push/unshift a read callback, and it	1972	you change the C<on_read> callback or push/unshift a read callback, and it
1728	will automatically C<stop_read> for you when neither C<on_read> is set nor	1973	will automatically C<stop_read> for you when neither C<on_read> is set nor
1729	there are any read requests in the queue.	1974	there are any read requests in the queue.
1730		1975
1731	These methods will have no effect when in TLS mode (as TLS doesn't support	1976	In older versions of this module (<= 5.3), these methods had no effect,
1732	half-duplex connections).	1977	as TLS does not support half-duplex connections. In current versions they
		1978	work as expected, as this behaviour is required to avoid certain resource
		1979	attacks, where the program would be forced to read (and buffer) arbitrary
		1980	amounts of data before being able to send some data. The drawback is that
		1981	some readings of the the SSL/TLS specifications basically require this
		1982	attack to be working, as SSL/TLS implementations might stall sending data
		1983	during a rehandshake.
		1984
		1985	As a guideline, during the initial handshake, you should not stop reading,
		1986	and as a client, it might cause problems, depending on your application.
1733		1987
1734	=cut	1988	=cut
1735		1989
1736	sub stop_read {	1990	sub stop_read {
1737	my ($self) = @_;	1991	my ($self) = @_;
1738		1992
1739	delete $self->{_rw} unless $self->{tls};	1993	delete $self->{_rw};
1740	}	1994	}
1741		1995
1742	sub start_read {	1996	sub start_read {
1743	my ($self) = @_;	1997	my ($self) = @_;
1744		1998
1745	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {	1999	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1746	Scalar::Util::weaken $self;	2000	Scalar::Util::weaken $self;
1747		2001
1748	$self->{_rw} = AE::io $self->{fh}, 0, sub {	2002	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1749	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	2003	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1750	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	2004	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1751		2005
1752	if ($len > 0) {	2006	if ($len > 0) {
1753	$self->{_activity} = $self->{_ractivity} = AE::now;	2007	$self->{_activity} = $self->{_ractivity} = AE::now;
1754		2008
1755	if ($self->{tls}) {	2009	if ($self->{tls}) {
…		…
1758	&_dotls ($self);	2012	&_dotls ($self);
1759	} else {	2013	} else {
1760	$self->_drain_rbuf;	2014	$self->_drain_rbuf;
1761	}	2015	}
1762		2016
		2017	if ($len == $self->{read_size}) {
		2018	$self->{read_size} *= 2;
		2019	$self->{read_size} = $self->{max_read_size} \|\| MAX_READ_SIZE
		2020	if $self->{read_size} > ($self->{max_read_size} \|\| MAX_READ_SIZE);
		2021	}
		2022
1763	} elsif (defined $len) {	2023	} elsif (defined $len) {
1764	delete $self->{_rw};	2024	delete $self->{_rw};
1765	$self->{_eof} = 1;	2025	$self->{_eof} = 1;
1766	$self->_drain_rbuf;	2026	$self->_drain_rbuf;
1767		2027
…		…
1779	my ($self, $err) = @_;	2039	my ($self, $err) = @_;
1780		2040
1781	return $self->_error ($!, 1)	2041	return $self->_error ($!, 1)
1782	if $err == Net::SSLeay::ERROR_SYSCALL ();	2042	if $err == Net::SSLeay::ERROR_SYSCALL ();
1783		2043
1784	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2044	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1785		2045
1786	# reduce error string to look less scary	2046	# reduce error string to look less scary
1787	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2047	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1788		2048
1789	if ($self->{_on_starttls}) {	2049	if ($self->{_on_starttls}) {
…		…
1855		2115
1856	=item $handle->starttls ($tls[, $tls_ctx])	2116	=item $handle->starttls ($tls[, $tls_ctx])
1857		2117
1858	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2118	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1859	object is created, you can also do that at a later time by calling	2119	object is created, you can also do that at a later time by calling
1860	C<starttls>.	2120	C<starttls>. See the C<tls> constructor argument for general info.
1861		2121
1862	Starting TLS is currently an asynchronous operation - when you push some	2122	Starting TLS is currently an asynchronous operation - when you push some
1863	write data and then call C<< ->starttls >> then TLS negotiation will start	2123	write data and then call C<< ->starttls >> then TLS negotiation will start
1864	immediately, after which the queued write data is then sent.	2124	immediately, after which the queued write data is then sent. This might
		2125	change in future versions, so best make sure you have no outstanding write
		2126	data when calling this method.
1865		2127
1866	The first argument is the same as the C<tls> constructor argument (either	2128	The first argument is the same as the C<tls> constructor argument (either
1867	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2129	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1868		2130
1869	The second argument is the optional C<AnyEvent::TLS> object that is used	2131	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1891	my ($self, $tls, $ctx) = @_;	2153	my ($self, $tls, $ctx) = @_;
1892		2154
1893	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2155	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1894	if $self->{tls};	2156	if $self->{tls};
1895		2157
		2158	unless (defined $AnyEvent::TLS::VERSION) {
		2159	eval {
		2160	require Net::SSLeay;
		2161	require AnyEvent::TLS;
		2162	1
		2163	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2164	}
		2165
1896	$self->{tls} = $tls;	2166	$self->{tls} = $tls;
1897	$self->{tls_ctx} = $ctx if @_ > 2;	2167	$self->{tls_ctx} = $ctx if @_ > 2;
1898		2168
1899	return unless $self->{fh};	2169	return unless $self->{fh};
1900		2170
1901	require Net::SSLeay;
1902
1903	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2171	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1904	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2172	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1905		2173
1906	$tls = delete $self->{tls};	2174	$tls = delete $self->{tls};
1907	$ctx = $self->{tls_ctx};	2175	$ctx = $self->{tls_ctx};
1908		2176
1909	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2177	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1910		2178
1911	if ("HASH" eq ref $ctx) {	2179	if ("HASH" eq ref $ctx) {
1912	require AnyEvent::TLS;
1913
1914	if ($ctx->{cache}) {	2180	if ($ctx->{cache}) {
1915	my $key = $ctx+0;	2181	my $key = $ctx+0;
1916	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2182	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1917	} else {	2183	} else {
1918	$ctx = new AnyEvent::TLS %$ctx;	2184	$ctx = new AnyEvent::TLS %$ctx;
…		…
1940	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2206	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1941		2207
1942	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2208	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1943	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2209	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1944		2210
1945	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2211	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2212	$self->{rbuf} = "";
1946		2213
1947	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2214	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1948		2215
1949	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2216	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1950	if $self->{on_starttls};	2217	if $self->{on_starttls};
…		…
1987	$self->{tls_ctx}->_put_session (delete $self->{tls})	2254	$self->{tls_ctx}->_put_session (delete $self->{tls})
1988	if $self->{tls} > 0;	2255	if $self->{tls} > 0;
1989		2256
1990	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2257	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1991	}	2258	}
		2259
		2260	=item $handle->resettls
		2261
		2262	This rarely-used method simply resets and TLS state on the handle, usually
		2263	causing data loss.
		2264
		2265	One case where it may be useful is when you want to skip over the data in
		2266	the stream but you are not interested in interpreting it, so data loss is
		2267	no concern.
		2268
		2269	=cut
		2270
		2271	*resettls = \&_freetls;
1992		2272
1993	sub DESTROY {	2273	sub DESTROY {
1994	my ($self) = @_;	2274	my ($self) = @_;
1995		2275
1996	&_freetls;	2276	&_freetls;
…		…
2112		2392
2113	It is only safe to "forget" the reference inside EOF or error callbacks,	2393	It is only safe to "forget" the reference inside EOF or error callbacks,
2114	from within all other callbacks, you need to explicitly call the C<<	2394	from within all other callbacks, you need to explicitly call the C<<
2115	->destroy >> method.	2395	->destroy >> method.
2116		2396
		2397	=item Why is my C<on_eof> callback never called?
		2398
		2399	Probably because your C<on_error> callback is being called instead: When
		2400	you have outstanding requests in your read queue, then an EOF is
		2401	considered an error as you clearly expected some data.
		2402
		2403	To avoid this, make sure you have an empty read queue whenever your handle
		2404	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2405	an C<on_read> handler that simply pushes the first read requests in the
		2406	queue.
		2407
		2408	See also the next question, which explains this in a bit more detail.
		2409
		2410	=item How can I serve requests in a loop?
		2411
		2412	Most protocols consist of some setup phase (authentication for example)
		2413	followed by a request handling phase, where the server waits for requests
		2414	and handles them, in a loop.
		2415
		2416	There are two important variants: The first (traditional, better) variant
		2417	handles requests until the server gets some QUIT command, causing it to
		2418	close the connection first (highly desirable for a busy TCP server). A
		2419	client dropping the connection is an error, which means this variant can
		2420	detect an unexpected detection close.
		2421
		2422	To handle this case, always make sure you have a non-empty read queue, by
		2423	pushing the "read request start" handler on it:
		2424
		2425	# we assume a request starts with a single line
		2426	my @start_request; @start_request = (line => sub {
		2427	my ($hdl, $line) = @_;
		2428
		2429	... handle request
		2430
		2431	# push next request read, possibly from a nested callback
		2432	$hdl->push_read (@start_request);
		2433	});
		2434
		2435	# auth done, now go into request handling loop
		2436	# now push the first @start_request
		2437	$hdl->push_read (@start_request);
		2438
		2439	By always having an outstanding C<push_read>, the handle always expects
		2440	some data and raises the C<EPIPE> error when the connction is dropped
		2441	unexpectedly.
		2442
		2443	The second variant is a protocol where the client can drop the connection
		2444	at any time. For TCP, this means that the server machine may run out of
		2445	sockets easier, and in general, it means you cannot distinguish a protocl
		2446	failure/client crash from a normal connection close. Nevertheless, these
		2447	kinds of protocols are common (and sometimes even the best solution to the
		2448	problem).
		2449
		2450	Having an outstanding read request at all times is possible if you ignore
		2451	C<EPIPE> errors, but this doesn't help with when the client drops the
		2452	connection during a request, which would still be an error.
		2453
		2454	A better solution is to push the initial request read in an C<on_read>
		2455	callback. This avoids an error, as when the server doesn't expect data
		2456	(i.e. is idly waiting for the next request, an EOF will not raise an
		2457	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2458	and simpler:
		2459
		2460	# auth done, now go into request handling loop
		2461	$hdl->on_read (sub {
		2462	my ($hdl) = @_;
		2463
		2464	# called each time we receive data but the read queue is empty
		2465	# simply start read the request
		2466
		2467	$hdl->push_read (line => sub {
		2468	my ($hdl, $line) = @_;
		2469
		2470	... handle request
		2471
		2472	# do nothing special when the request has been handled, just
		2473	# let the request queue go empty.
		2474	});
		2475	});
		2476
2117	=item I get different callback invocations in TLS mode/Why can't I pause	2477	=item I get different callback invocations in TLS mode/Why can't I pause
2118	reading?	2478	reading?
2119		2479
2120	Unlike, say, TCP, TLS connections do not consist of two independent	2480	Unlike, say, TCP, TLS connections do not consist of two independent
2121	communication channels, one for each direction. Or put differently, the	2481	communication channels, one for each direction. Or put differently, the
…		…
2142	$handle->on_eof (undef);	2502	$handle->on_eof (undef);
2143	$handle->on_error (sub {	2503	$handle->on_error (sub {
2144	my $data = delete $_[0]{rbuf};	2504	my $data = delete $_[0]{rbuf};
2145	});	2505	});
2146		2506
		2507	Note that this example removes the C<rbuf> member from the handle object,
		2508	which is not normally allowed by the API. It is expressly permitted in
		2509	this case only, as the handle object needs to be destroyed afterwards.
		2510
2147	The reason to use C<on_error> is that TCP connections, due to latencies	2511	The reason to use C<on_error> is that TCP connections, due to latencies
2148	and packets loss, might get closed quite violently with an error, when in	2512	and packets loss, might get closed quite violently with an error, when in
2149	fact all data has been received.	2513	fact all data has been received.
2150		2514
2151	It is usually better to use acknowledgements when transferring data,	2515	It is usually better to use acknowledgements when transferring data,
…		…
2161	C<low_water_mark> this will be called precisely when all data has been	2525	C<low_water_mark> this will be called precisely when all data has been
2162	written to the socket:	2526	written to the socket:
2163		2527
2164	$handle->push_write (...);	2528	$handle->push_write (...);
2165	$handle->on_drain (sub {	2529	$handle->on_drain (sub {
2166	warn "all data submitted to the kernel\n";	2530	AE::log debug => "All data submitted to the kernel.";
2167	undef $handle;	2531	undef $handle;
2168	});	2532	});
2169		2533
2170	If you just want to queue some data and then signal EOF to the other side,	2534	If you just want to queue some data and then signal EOF to the other side,
2171	consider using C<< ->push_shutdown >> instead.	2535	consider using C<< ->push_shutdown >> instead.
…		…
2255	When you have intermediate CA certificates that your clients might not	2619	When you have intermediate CA certificates that your clients might not
2256	know about, just append them to the C<cert_file>.	2620	know about, just append them to the C<cert_file>.
2257		2621
2258	=back	2622	=back
2259		2623
2260
2261	=head1 SUBCLASSING AnyEvent::Handle	2624	=head1 SUBCLASSING AnyEvent::Handle
2262		2625
2263	In many cases, you might want to subclass AnyEvent::Handle.	2626	In many cases, you might want to subclass AnyEvent::Handle.
2264		2627
2265	To make this easier, a given version of AnyEvent::Handle uses these	2628	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2291		2654
2292	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2655	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2293		2656
2294	=cut	2657	=cut
2295		2658
2296	1; # End of AnyEvent::Handle	2659	1
		2660

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.202 by root, Sat Oct 16 02:01:54 2010 UTC vs. Revision 1.238 by root, Tue Dec 10 15:54:51 2013 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.202 by root, Sat Oct 16 02:01:54 2010 UTC vs.
Revision 1.238 by root, Tue Dec 10 15:54:51 2013 UTC