[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.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
…		…
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>, L<JSON::PP> 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
		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
464	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
465	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.
466		520
467	=back	521	=back
468		522
469	=cut	523	=cut
470		524
…		…
492	$self->{connect}[0],	546	$self->{connect}[0],
493	$self->{connect}[1],	547	$self->{connect}[1],
494	sub {	548	sub {
495	my ($fh, $host, $port, $retry) = @_;	549	my ($fh, $host, $port, $retry) = @_;
496		550
		551	delete $self->{_connect}; # no longer needed
		552
497	if ($fh) {	553	if ($fh) {
498	$self->{fh} = $fh;	554	$self->{fh} = $fh;
499		555
500	delete $self->{_skip_drain_rbuf};	556	delete $self->{_skip_drain_rbuf};
501	$self->_start;	557	$self->_start;
…		…
508	});	564	});
509		565
510	} else {	566	} else {
511	if ($self->{on_connect_error}) {	567	if ($self->{on_connect_error}) {
512	$self->{on_connect_error}($self, "$!");	568	$self->{on_connect_error}($self, "$!");
513	$self->destroy;	569	$self->destroy if $self;
514	} else {	570	} else {
515	$self->_error ($!, 1);	571	$self->_error ($!, 1);
516	}	572	}
517	}	573	}
518	},	574	},
519	sub {	575	sub {
520	local $self->{fh} = $_[0];	576	local $self->{fh} = $_[0];
521		577
522	$self->{on_prepare}	578	$self->{on_prepare}
523	? $self->{on_prepare}->($self)	579	? $self->{on_prepare}->($self)
524	: ()	580	: ()
525	}	581	}
526	);	582	);
527	}	583	}
528		584
…		…
545	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	601	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
546		602
547	$self->{_activity} =	603	$self->{_activity} =
548	$self->{_ractivity} =	604	$self->{_ractivity} =
549	$self->{_wactivity} = AE::now;	605	$self->{_wactivity} = AE::now;
		606
		607	$self->{read_size} \|\|= 2048;
		608	$self->{max_read_size} = $self->{read_size}
		609	if $self->{read_size} > ($self->{max_read_size} \|\| MAX_READ_SIZE);
550		610
551	$self->timeout (delete $self->{timeout} ) if $self->{timeout};	611	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
552	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};	612	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
553	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};	613	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
554		614
…		…
723		783
724	=item $handle->rbuf_max ($max_octets)	784	=item $handle->rbuf_max ($max_octets)
725		785
726	Configures the C<rbuf_max> setting (C<undef> disables it).	786	Configures the C<rbuf_max> setting (C<undef> disables it).
727		787
		788	=item $handle->wbuf_max ($max_octets)
		789
		790	Configures the C<wbuf_max> setting (C<undef> disables it).
		791
728	=cut	792	=cut
729		793
730	sub rbuf_max {	794	sub rbuf_max {
731	$_[0]{rbuf_max} = $_[1];	795	$_[0]{rbuf_max} = $_[1];
732	}	796	}
733		797
		798	sub wbuf_max {
		799	$_[0]{wbuf_max} = $_[1];
		800	}
		801
734	#############################################################################	802	#############################################################################
735		803
736	=item $handle->timeout ($seconds)	804	=item $handle->timeout ($seconds)
737		805
738	=item $handle->rtimeout ($seconds)	806	=item $handle->rtimeout ($seconds)
739		807
740	=item $handle->wtimeout ($seconds)	808	=item $handle->wtimeout ($seconds)
741		809
742	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.
743		814
744	=item $handle->timeout_reset	815	=item $handle->timeout_reset
745		816
746	=item $handle->rtimeout_reset	817	=item $handle->rtimeout_reset
747		818
…		…
831		902
832	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
833	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.
834		905
835	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
836	water mark, the C<on_drain> callback will be invoked.	907	water mark, the C<on_drain> callback will be invoked once.
837		908
838	=over 4	909	=over 4
839		910
840	=item $handle->on_drain ($cb)	911	=item $handle->on_drain ($cb)
841		912
…		…
856	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});
857	}	928	}
858		929
859	=item $handle->push_write ($data)	930	=item $handle->push_write ($data)
860		931
861	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
862	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
863	buffers it independently of the kernel.	934	C<AnyEvent::Handle> buffers it independently of the kernel.
864		935
865	This method may invoke callbacks (and therefore the handle might be	936	This method may invoke callbacks (and therefore the handle might be
866	destroyed after it returns).	937	destroyed after it returns).
867		938
868	=cut	939	=cut
…		…
896	$cb->() unless $self->{autocork};	967	$cb->() unless $self->{autocork};
897		968
898	# if still data left in wbuf, we need to poll	969	# if still data left in wbuf, we need to poll
899	$self->{_ww} = AE::io $self->{fh}, 1, $cb	970	$self->{_ww} = AE::io $self->{fh}, 1, $cb
900	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	}
901	};	979	};
902	}	980	}
903		981
904	our %WH;	982	our %WH;
905		983
…		…
984		1062
985	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
986	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
987	able to read them, many other languages depend on that.	1065	able to read them, many other languages depend on that.
988		1066
989	A simple RPC protocol that interoperates easily with others is to send	1067	A simple RPC protocol that interoperates easily with other languages is
990	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
991	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
992	JSON text:	1070	after each JSON text:
993		1071
994	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1072	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
995	$handle->push_write ("\012");	1073	$handle->push_write ("\012");
996		1074
997	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
…		…
1000	$handle->push_read (json => sub { my $array = $_[1]; ... });	1078	$handle->push_read (json => sub { my $array = $_[1]; ... });
1001		1079
1002	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
1003	this line into their JSON decoder of choice.	1081	this line into their JSON decoder of choice.
1004		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
1005	=cut	1103	=cut
1006		1104
1007	sub json_coder() {	1105	sub json_coder() {
1008	eval { require JSON::XS; JSON::XS->new->utf8 }	1106	eval { require JSON::XS; JSON::XS->new->utf8 }
1009	\|\| do { require JSON; JSON->new->utf8 }	1107	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1010	}	1108	}
1011		1109
1012	register_write_type json => sub {	1110	register_write_type json => sub {
1013	my ($self, $ref) = @_;	1111	my ($self, $ref) = @_;
1014		1112
1015	my $json = $self->{json} \|\|= json_coder;	1113	($self->{json} \|\|= json_coder)
1016
1017	$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)
1018	};	1127	};
1019		1128
1020	=item storable => $reference	1129	=item storable => $reference
1021		1130
1022	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
…		…
1025	=cut	1134	=cut
1026		1135
1027	register_write_type storable => sub {	1136	register_write_type storable => sub {
1028	my ($self, $ref) = @_;	1137	my ($self, $ref) = @_;
1029		1138
1030	require Storable;	1139	require Storable unless $Storable::VERSION;
1031		1140
1032	pack "w/a*", Storable::nfreeze ($ref)	1141	pack "w/a*", Storable::nfreeze ($ref)
1033	};	1142	};
1034		1143
1035	=back	1144	=back
…		…
1040	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
1041	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
1042	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
1043	replaces the C<on_drain> callback with:	1152	replaces the C<on_drain> callback with:
1044		1153
1045	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1154	sub { shutdown $_[0]{fh}, 1 }
1046		1155
1047	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
1048	the peer.	1157	the peer.
1049		1158
1050	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
…		…
1072		1181
1073	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
1074	the handle object and the remaining arguments.	1183	the handle object and the remaining arguments.
1075		1184
1076	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
1077	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
1078	"arguments to on-the-wire-format" converter.	1187	"arguments to on-the-wire-format" converter.
1079		1188
1080	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
1081	arguments using the first one.	1190	arguments using the first one.
1082		1191
…		…
1376	data.	1485	data.
1377		1486
1378	Example: read 2 bytes.	1487	Example: read 2 bytes.
1379		1488
1380	$handle->push_read (chunk => 2, sub {	1489	$handle->push_read (chunk => 2, sub {
1381	warn "yay ", unpack "H*", $_[1];	1490	say "yay " . unpack "H*", $_[1];
1382	});	1491	});
1383		1492
1384	=cut	1493	=cut
1385		1494
1386	register_read_type chunk => sub {	1495	register_read_type chunk => sub {
…		…
1416		1525
1417	register_read_type line => sub {	1526	register_read_type line => sub {
1418	my ($self, $cb, $eol) = @_;	1527	my ($self, $cb, $eol) = @_;
1419		1528
1420	if (@_ < 3) {	1529	if (@_ < 3) {
1421	# this is more than twice as fast as the generic code below	1530	# this is faster then the generic code below
1422	sub {	1531	sub {
1423	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1532	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1533	or return;
1424		1534
		1535	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1425	$cb->($_[0], $1, $2);	1536	$cb->($_[0], $str, "$1");
1426	1	1537	1
1427	}	1538	}
1428	} else {	1539	} else {
1429	$eol = quotemeta $eol unless ref $eol;	1540	$eol = quotemeta $eol unless ref $eol;
1430	$eol = qr\|^(.*?)($eol)\|s;	1541	$eol = qr\|^(.*?)($eol)\|s;
1431		1542
1432	sub {	1543	sub {
1433	$_[0]{rbuf} =~ s/$eol// or return;	1544	$_[0]{rbuf} =~ s/$eol// or return;
1434		1545
1435	$cb->($_[0], $1, $2);	1546	$cb->($_[0], "$1", "$2");
1436	1	1547	1
1437	}	1548	}
1438	}	1549	}
1439	};	1550	};
1440		1551
…		…
1488		1599
1489	sub {	1600	sub {
1490	# accept	1601	# accept
1491	if ($$rbuf =~ $accept) {	1602	if ($$rbuf =~ $accept) {
1492	$data .= substr $$rbuf, 0, $+[0], "";	1603	$data .= substr $$rbuf, 0, $+[0], "";
1493	$cb->($self, $data);	1604	$cb->($_[0], $data);
1494	return 1;	1605	return 1;
1495	}	1606	}
1496		1607
1497	# reject	1608	# reject
1498	if ($reject && $$rbuf =~ $reject) {	1609	if ($reject && $$rbuf =~ $reject) {
1499	$self->_error (Errno::EBADMSG);	1610	$_[0]->_error (Errno::EBADMSG);
1500	}	1611	}
1501		1612
1502	# skip	1613	# skip
1503	if ($skip && $$rbuf =~ $skip) {	1614	if ($skip && $$rbuf =~ $skip) {
1504	$data .= substr $$rbuf, 0, $+[0], "";	1615	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1520	my ($self, $cb) = @_;	1631	my ($self, $cb) = @_;
1521		1632
1522	sub {	1633	sub {
1523	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1634	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1524	if ($_[0]{rbuf} =~ /[^0-9]/) {	1635	if ($_[0]{rbuf} =~ /[^0-9]/) {
1525	$self->_error (Errno::EBADMSG);	1636	$_[0]->_error (Errno::EBADMSG);
1526	}	1637	}
1527	return;	1638	return;
1528	}	1639	}
1529		1640
1530	my $len = $1;	1641	my $len = $1;
1531		1642
1532	$self->unshift_read (chunk => $len, sub {	1643	$_[0]->unshift_read (chunk => $len, sub {
1533	my $string = $_[1];	1644	my $string = $_[1];
1534	$_[0]->unshift_read (chunk => 1, sub {	1645	$_[0]->unshift_read (chunk => 1, sub {
1535	if ($_[1] eq ",") {	1646	if ($_[1] eq ",") {
1536	$cb->($_[0], $string);	1647	$cb->($_[0], $string);
1537	} else {	1648	} else {
1538	$self->_error (Errno::EBADMSG);	1649	$_[0]->_error (Errno::EBADMSG);
1539	}	1650	}
1540	});	1651	});
1541	});	1652	});
1542		1653
1543	1	1654	1
…		…
1593	=item json => $cb->($handle, $hash_or_arrayref)	1704	=item json => $cb->($handle, $hash_or_arrayref)
1594		1705
1595	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
1596	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.
1597		1708
1598	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
1599	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.
1600		1712
1601	This read type uses the incremental parser available with JSON version	1713	This read type uses the incremental parser available with JSON version
1602	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.
1603	dependency on your own: this module will load the JSON module, but
1604	AnyEvent does not depend on it itself.
1605		1715
1606	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
1607	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
1608	the C<json> write type description, above, for an actual example.	1718	the C<json> write type description, above, for an actual example.
1609		1719
…		…
1613	my ($self, $cb) = @_;	1723	my ($self, $cb) = @_;
1614		1724
1615	my $json = $self->{json} \|\|= json_coder;	1725	my $json = $self->{json} \|\|= json_coder;
1616		1726
1617	my $data;	1727	my $data;
1618	my $rbuf = \$self->{rbuf};
1619		1728
1620	sub {	1729	sub {
1621	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1730	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1622		1731
1623	if ($ref) {	1732	if ($ref) {
1624	$self->{rbuf} = $json->incr_text;	1733	$_[0]{rbuf} = $json->incr_text;
1625	$json->incr_text = "";	1734	$json->incr_text = "";
1626	$cb->($self, $ref);	1735	$cb->($_[0], $ref);
1627		1736
1628	1	1737	1
1629	} elsif ($@) {	1738	} elsif ($@) {
1630	# error case	1739	# error case
1631	$json->incr_skip;	1740	$json->incr_skip;
1632		1741
1633	$self->{rbuf} = $json->incr_text;	1742	$_[0]{rbuf} = $json->incr_text;
1634	$json->incr_text = "";	1743	$json->incr_text = "";
1635		1744
1636	$self->_error (Errno::EBADMSG);	1745	$_[0]->_error (Errno::EBADMSG);
1637		1746
1638	()	1747	()
1639	} else {	1748	} else {
1640	$self->{rbuf} = "";	1749	$_[0]{rbuf} = "";
1641		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 {
1642	()	1797	()
1643	}	1798	}
1644	}	1799	}
1645	};	1800	};
1646		1801
…		…
1655	=cut	1810	=cut
1656		1811
1657	register_read_type storable => sub {	1812	register_read_type storable => sub {
1658	my ($self, $cb) = @_;	1813	my ($self, $cb) = @_;
1659		1814
1660	require Storable;	1815	require Storable unless $Storable::VERSION;
1661		1816
1662	sub {	1817	sub {
1663	# 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
1664	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1819	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1665	or return;	1820	or return;
…		…
1668		1823
1669	# bypass unshift if we already have the remaining chunk	1824	# bypass unshift if we already have the remaining chunk
1670	if ($format + $len <= length $_[0]{rbuf}) {	1825	if ($format + $len <= length $_[0]{rbuf}) {
1671	my $data = substr $_[0]{rbuf}, $format, $len;	1826	my $data = substr $_[0]{rbuf}, $format, $len;
1672	substr $_[0]{rbuf}, 0, $format + $len, "";	1827	substr $_[0]{rbuf}, 0, $format + $len, "";
		1828
1673	$cb->($_[0], Storable::thaw ($data));	1829	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1830	or return $_[0]->_error (Errno::EBADMSG);
1674	} else {	1831	} else {
1675	# remove prefix	1832	# remove prefix
1676	substr $_[0]{rbuf}, 0, $format, "";	1833	substr $_[0]{rbuf}, 0, $format, "";
1677		1834
1678	# read remaining chunk	1835	# read remaining chunk
1679	$_[0]->unshift_read (chunk => $len, sub {	1836	$_[0]->unshift_read (chunk => $len, sub {
1680	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1837	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1681	$cb->($_[0], $ref);
1682	} else {
1683	$self->_error (Errno::EBADMSG);	1838	or $_[0]->_error (Errno::EBADMSG);
1684	}
1685	});	1839	});
1686	}	1840	}
1687		1841
1688	1	1842	1
1689	}	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	})
1690	};	1930	};
1691		1931
1692	=back	1932	=back
1693		1933
1694	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1934	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1726	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
1727	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
1728	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
1729	there are any read requests in the queue.	1969	there are any read requests in the queue.
1730		1970
1731	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,
1732	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.
1733		1982
1734	=cut	1983	=cut
1735		1984
1736	sub stop_read {	1985	sub stop_read {
1737	my ($self) = @_;	1986	my ($self) = @_;
1738		1987
1739	delete $self->{_rw} unless $self->{tls};	1988	delete $self->{_rw};
1740	}	1989	}
1741		1990
1742	sub start_read {	1991	sub start_read {
1743	my ($self) = @_;	1992	my ($self) = @_;
1744		1993
1745	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {	1994	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1746	Scalar::Util::weaken $self;	1995	Scalar::Util::weaken $self;
1747		1996
1748	$self->{_rw} = AE::io $self->{fh}, 0, sub {	1997	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1749	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1998	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1750	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1999	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1751		2000
1752	if ($len > 0) {	2001	if ($len > 0) {
1753	$self->{_activity} = $self->{_ractivity} = AE::now;	2002	$self->{_activity} = $self->{_ractivity} = AE::now;
1754		2003
1755	if ($self->{tls}) {	2004	if ($self->{tls}) {
…		…
1758	&_dotls ($self);	2007	&_dotls ($self);
1759	} else {	2008	} else {
1760	$self->_drain_rbuf;	2009	$self->_drain_rbuf;
1761	}	2010	}
1762		2011
		2012	if ($len == $self->{read_size}) {
		2013	$self->{read_size} *= 2;
		2014	$self->{read_size} = $self->{max_read_size} \|\| MAX_READ_SIZE
		2015	if $self->{read_size} > ($self->{max_read_size} \|\| MAX_READ_SIZE);
		2016	}
		2017
1763	} elsif (defined $len) {	2018	} elsif (defined $len) {
1764	delete $self->{_rw};	2019	delete $self->{_rw};
1765	$self->{_eof} = 1;	2020	$self->{_eof} = 1;
1766	$self->_drain_rbuf;	2021	$self->_drain_rbuf;
1767		2022
…		…
1779	my ($self, $err) = @_;	2034	my ($self, $err) = @_;
1780		2035
1781	return $self->_error ($!, 1)	2036	return $self->_error ($!, 1)
1782	if $err == Net::SSLeay::ERROR_SYSCALL ();	2037	if $err == Net::SSLeay::ERROR_SYSCALL ();
1783		2038
1784	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 ());
1785		2040
1786	# reduce error string to look less scary	2041	# reduce error string to look less scary
1787	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2042	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1788		2043
1789	if ($self->{_on_starttls}) {	2044	if ($self->{_on_starttls}) {
…		…
1803	sub _dotls {	2058	sub _dotls {
1804	my ($self) = @_;	2059	my ($self) = @_;
1805		2060
1806	my $tmp;	2061	my $tmp;
1807		2062
1808	if (length $self->{_tls_wbuf}) {	2063	while (length $self->{_tls_wbuf}) {
1809	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2064	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1810	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;
1811	}	2072	}
1812		2073
1813	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2074	substr $self->{_tls_wbuf}, 0, $tmp, "";
1814	return $self->_tls_error ($tmp)
1815	if $tmp != $ERROR_WANT_READ
1816	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1817	}	2075	}
1818		2076
1819	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2077	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1820	unless (length $tmp) {	2078	unless (length $tmp) {
1821	$self->{_on_starttls}	2079	$self->{_on_starttls}
…		…
1835	$self->{_tls_rbuf} .= $tmp;	2093	$self->{_tls_rbuf} .= $tmp;
1836	$self->_drain_rbuf;	2094	$self->_drain_rbuf;
1837	$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
1838	}	2096	}
1839		2097
1840	$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
1841	return $self->_tls_error ($tmp)	2099	return $self->_tls_error ($tmp)
1842	if $tmp != $ERROR_WANT_READ	2100	if $tmp != $ERROR_WANT_READ
1843	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2101	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1844		2102
1845	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2103	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1855		2113
1856	=item $handle->starttls ($tls[, $tls_ctx])	2114	=item $handle->starttls ($tls[, $tls_ctx])
1857		2115
1858	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2116	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	2117	object is created, you can also do that at a later time by calling
1860	C<starttls>.	2118	C<starttls>. See the C<tls> constructor argument for general info.
1861		2119
1862	Starting TLS is currently an asynchronous operation - when you push some	2120	Starting TLS is currently an asynchronous operation - when you push some
1863	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
1864	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.
1865		2125
1866	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
1867	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2127	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1868		2128
1869	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
…		…
1891	my ($self, $tls, $ctx) = @_;	2151	my ($self, $tls, $ctx) = @_;
1892		2152
1893	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"
1894	if $self->{tls};	2154	if $self->{tls};
1895		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
1896	$self->{tls} = $tls;	2164	$self->{tls} = $tls;
1897	$self->{tls_ctx} = $ctx if @_ > 2;	2165	$self->{tls_ctx} = $ctx if @_ > 2;
1898		2166
1899	return unless $self->{fh};	2167	return unless $self->{fh};
1900		2168
1901	require Net::SSLeay;
1902
1903	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2169	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1904	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2170	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1905		2171
1906	$tls = delete $self->{tls};	2172	$tls = delete $self->{tls};
1907	$ctx = $self->{tls_ctx};	2173	$ctx = $self->{tls_ctx};
1908		2174
1909	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
1910		2176
1911	if ("HASH" eq ref $ctx) {	2177	if ("HASH" eq ref $ctx) {
1912	require AnyEvent::TLS;
1913
1914	if ($ctx->{cache}) {	2178	if ($ctx->{cache}) {
1915	my $key = $ctx+0;	2179	my $key = $ctx+0;
1916	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2180	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1917	} else {	2181	} else {
1918	$ctx = new AnyEvent::TLS %$ctx;	2182	$ctx = new AnyEvent::TLS %$ctx;
…		…
1940	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2204	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1941		2205
1942	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2206	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1943	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2207	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1944		2208
1945	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2209	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2210	$self->{rbuf} = "";
1946		2211
1947	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2212	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1948		2213
1949	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2214	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1950	if $self->{on_starttls};	2215	if $self->{on_starttls};
…		…
1987	$self->{tls_ctx}->_put_session (delete $self->{tls})	2252	$self->{tls_ctx}->_put_session (delete $self->{tls})
1988	if $self->{tls} > 0;	2253	if $self->{tls} > 0;
1989		2254
1990	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2255	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1991	}	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;
1992		2270
1993	sub DESTROY {	2271	sub DESTROY {
1994	my ($self) = @_;	2272	my ($self) = @_;
1995		2273
1996	&_freetls;	2274	&_freetls;
…		…
2112		2390
2113	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,
2114	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<<
2115	->destroy >> method.	2393	->destroy >> method.
2116		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
2117	=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
2118	reading?	2476	reading?
2119		2477
2120	Unlike, say, TCP, TLS connections do not consist of two independent	2478	Unlike, say, TCP, TLS connections do not consist of two independent
2121	communication channels, one for each direction. Or put differently, the	2479	communication channels, one for each direction. Or put differently, the
…		…
2142	$handle->on_eof (undef);	2500	$handle->on_eof (undef);
2143	$handle->on_error (sub {	2501	$handle->on_error (sub {
2144	my $data = delete $_[0]{rbuf};	2502	my $data = delete $_[0]{rbuf};
2145	});	2503	});
2146		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
2147	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
2148	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
2149	fact all data has been received.	2511	fact all data has been received.
2150		2512
2151	It is usually better to use acknowledgements when transferring data,	2513	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	2523	C<low_water_mark> this will be called precisely when all data has been
2162	written to the socket:	2524	written to the socket:
2163		2525
2164	$handle->push_write (...);	2526	$handle->push_write (...);
2165	$handle->on_drain (sub {	2527	$handle->on_drain (sub {
2166	warn "all data submitted to the kernel\n";	2528	AE::log debug => "All data submitted to the kernel.";
2167	undef $handle;	2529	undef $handle;
2168	});	2530	});
2169		2531
2170	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,
2171	consider using C<< ->push_shutdown >> instead.	2533	consider using C<< ->push_shutdown >> instead.
…		…
2255	When you have intermediate CA certificates that your clients might not	2617	When you have intermediate CA certificates that your clients might not
2256	know about, just append them to the C<cert_file>.	2618	know about, just append them to the C<cert_file>.
2257		2619
2258	=back	2620	=back
2259		2621
2260
2261	=head1 SUBCLASSING AnyEvent::Handle	2622	=head1 SUBCLASSING AnyEvent::Handle
2262		2623
2263	In many cases, you might want to subclass AnyEvent::Handle.	2624	In many cases, you might want to subclass AnyEvent::Handle.
2264		2625
2265	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
…		…
2291		2652
2292	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>.
2293		2654
2294	=cut	2655	=cut
2295		2656
2296	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.202 by root, Sat Oct 16 02:01:54 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.202 by root, Sat Oct 16 02:01:54 2010 UTC vs.
Revision 1.240 by root, Tue Dec 17 16:43:15 2013 UTC