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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.205 by root, Mon Nov 15 17:11:00 2010 UTC vs.
Revision 1.244 by root, Wed Apr 1 19:59:01 2015 UTC

…		…
11		11
12	my $hdl; $hdl = new AnyEvent::Handle	12	my $hdl; $hdl = new AnyEvent::Handle
13	fh => \*STDIN,	13	fh => \*STDIN,
14	on_error => sub {	14	on_error => sub {
15	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
16	warn "got error $msg\n";	16	AE::log error => $msg;
17	$hdl->destroy;	17	$hdl->destroy;
18	$cv->send;	18	$cv->send;
19	};	19	};
20		20
21	# send some request line	21	# send some request line
22	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
23		23
24	# read the response line	24	# read the response line
25	$hdl->push_read (line => sub {	25	$hdl->push_read (line => sub {
26	my ($hdl, $line) = @_;	26	my ($hdl, $line) = @_;
27	warn "got line <$line>\n";	27	say "got line <$line>";
28	$cv->send;	28	$cv->send;
29	});	29	});
30		30
31	$cv->recv;	31	$cv->recv;
32		32
…		…
53	package AnyEvent::Handle;	53	package AnyEvent::Handle;
54		54
55	use Scalar::Util ();	55	use Scalar::Util ();
56	use List::Util ();	56	use List::Util ();
57	use Carp ();	57	use Carp ();
58	use Errno qw(EAGAIN EINTR);	58	use Errno qw(EAGAIN EWOULDBLOCK EINTR);
59		59
60	use AnyEvent (); BEGIN { AnyEvent::common_sense }	60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
61	use AnyEvent::Util qw(WSAEWOULDBLOCK);	61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
62		62
63	our $VERSION = $AnyEvent::VERSION;	63	our $VERSION = $AnyEvent::VERSION;
…		…
114	=over 4	114	=over 4
115		115
116	=item on_prepare => $cb->($handle)	116	=item on_prepare => $cb->($handle)
117		117
118	This (rarely used) callback is called before a new connection is	118	This (rarely used) callback is called before a new connection is
119	attempted, but after the file handle has been created. It could be used to	119	attempted, but after the file handle has been created (you can access that
		120	file handle via C<< $handle->{fh} >>). It could be used to prepare the
120	prepare the file handle with parameters required for the actual connect	121	file handle with parameters required for the actual connect (as opposed to
121	(as opposed to settings that can be changed when the connection is already	122	settings that can be changed when the connection is already established).
122	established).
123		123
124	The return value of this callback should be the connect timeout value in	124	The return value of this callback should be the connect timeout value in
125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the	125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
126	default timeout is to be used).	126	default timeout is to be used).
127		127
128	=item on_connect => $cb->($handle, $host, $port, $retry->())	128	=item on_connect => $cb->($handle, $host, $port, $retry->())
129		129
130	This callback is called when a connection has been successfully established.	130	This callback is called when a connection has been successfully established.
131		131
132	The peer's numeric host and port (the socket peername) are passed as	132	The peer's numeric host and port (the socket peername) are passed as
133	parameters, together with a retry callback.	133	parameters, together with a retry callback. At the time it is called the
		134	read and write queues, EOF status, TLS status and similar properties of
		135	the handle will have been reset.
134		136
135	If, for some reason, the handle is not acceptable, calling C<$retry>	137	If, for some reason, the handle is not acceptable, calling C<$retry> will
136	will continue with the next connection target (in case of multi-homed	138	continue with the next connection target (in case of multi-homed hosts or
137	hosts or SRV records there can be multiple connection endpoints). At the	139	SRV records there can be multiple connection endpoints). The C<$retry>
138	time it is called the read and write queues, eof status, tls status and	140	callback can be invoked after the connect callback returns, i.e. one can
139	similar properties of the handle will have been reset.	141	start a handshake and then decide to retry with the next host if the
		142	handshake fails.
140		143
141	In most cases, you should ignore the C<$retry> parameter.	144	In most cases, you should ignore the C<$retry> parameter.
142		145
143	=item on_connect_error => $cb->($handle, $message)	146	=item on_connect_error => $cb->($handle, $message)
144		147
…		…
164	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In	167	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
165	cases where the other side can close the connection at will, it is	168	cases where the other side can close the connection at will, it is
166	often easiest to not report C<EPIPE> errors in this callback.	169	often easiest to not report C<EPIPE> errors in this callback.
167		170
168	AnyEvent::Handle tries to find an appropriate error code for you to check	171	AnyEvent::Handle tries to find an appropriate error code for you to check
169	against, but in some cases (TLS errors), this does not work well. It is	172	against, but in some cases (TLS errors), this does not work well.
170	recommended to always output the C<$message> argument in human-readable	173
171	error messages (it's usually the same as C<"$!">).	174	If you report the error to the user, it is recommended to always output
		175	the C<$message> argument in human-readable error messages (you don't need
		176	to report C<"$!"> if you report C<$message>).
		177
		178	If you want to react programmatically to the error, then looking at C<$!>
		179	and comparing it against some of the documented C<Errno> values is usually
		180	better than looking at the C<$message>.
172		181
173	Non-fatal errors can be retried by returning, but it is recommended	182	Non-fatal errors can be retried by returning, but it is recommended
174	to simply ignore this parameter and instead abondon the handle object	183	to simply ignore this parameter and instead abondon the handle object
175	when this callback is invoked. Examples of non-fatal errors are timeouts	184	when this callback is invoked. Examples of non-fatal errors are timeouts
176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	185	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
…		…
224	If an EOF condition has been detected but no C<on_eof> callback has been	233	If an EOF condition has been detected but no C<on_eof> callback has been
225	set, then a fatal error will be raised with C<$!> set to <0>.	234	set, then a fatal error will be raised with C<$!> set to <0>.
226		235
227	=item on_drain => $cb->($handle)	236	=item on_drain => $cb->($handle)
228		237
229	This sets the callback that is called when the write buffer becomes empty	238	This sets the callback that is called once when the write buffer becomes
230	(or immediately if the buffer is empty already).	239	empty (and immediately when the handle object is created).
231		240
232	To append to the write buffer, use the C<< ->push_write >> method.	241	To append to the write buffer, use the C<< ->push_write >> method.
233		242
234	This callback is useful when you don't want to put all of your write data	243	This callback is useful when you don't want to put all of your write data
235	into the queue at once, for example, when you want to write the contents	244	into the queue at once, for example, when you want to write the contents
…		…
247	many seconds pass without a successful read or write on the underlying	256	many seconds pass without a successful read or write on the underlying
248	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback	257	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
249	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>	258	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
250	error will be raised).	259	error will be raised).
251		260
252	There are three variants of the timeouts that work independently	261	There are three variants of the timeouts that work independently of each
253	of each other, for both read and write, just read, and just write:	262	other, for both read and write (triggered when nothing was read I<OR>
		263	written), just read (triggered when nothing was read), and just write:
254	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks	264	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
255	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions	265	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
256	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.	266	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
257		267
258	Note that timeout processing is active even when you do not have	268	Note that timeout processing is active even when you do not have any
259	any outstanding read or write requests: If you plan to keep the connection	269	outstanding read or write requests: If you plan to keep the connection
260	idle then you should disable the timeout temporarily or ignore the timeout	270	idle then you should disable the timeout temporarily or ignore the
261	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	271	timeout in the corresponding C<on_timeout> callback, in which case
262	restart the timeout.	272	AnyEvent::Handle will simply restart the timeout.
263		273
264	Zero (the default) disables this timeout.	274	Zero (the default) disables the corresponding timeout.
265		275
266	=item on_timeout => $cb->($handle)	276	=item on_timeout => $cb->($handle)
		277
		278	=item on_rtimeout => $cb->($handle)
		279
		280	=item on_wtimeout => $cb->($handle)
267		281
268	Called whenever the inactivity timeout passes. If you return from this	282	Called whenever the inactivity timeout passes. If you return from this
269	callback, then the timeout will be reset as if some activity had happened,	283	callback, then the timeout will be reset as if some activity had happened,
270	so this condition is not fatal in any way.	284	so this condition is not fatal in any way.
271		285
…		…
278	For example, a server accepting connections from untrusted sources should	292	For example, a server accepting connections from untrusted sources should
279	be configured to accept only so-and-so much data that it cannot act on	293	be configured to accept only so-and-so much data that it cannot act on
280	(for example, when expecting a line, an attacker could send an unlimited	294	(for example, when expecting a line, an attacker could send an unlimited
281	amount of data without a callback ever being called as long as the line	295	amount of data without a callback ever being called as long as the line
282	isn't finished).	296	isn't finished).
		297
		298	=item wbuf_max => <bytes>
		299
		300	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
		301	when the write buffer ever (strictly) exceeds this size. This is useful to
		302	avoid some forms of denial-of-service attacks.
		303
		304	Although the units of this parameter is bytes, this is the I<raw> number
		305	of bytes not yet accepted by the kernel. This can make a difference when
		306	you e.g. use TLS, as TLS typically makes your write data larger (but it
		307	can also make it smaller due to compression).
		308
		309	As an example of when this limit is useful, take a chat server that sends
		310	chat messages to a client. If the client does not read those in a timely
		311	manner then the send buffer in the server would grow unbounded.
283		312
284	=item autocork => <boolean>	313	=item autocork => <boolean>
285		314
286	When disabled (the default), C<push_write> will try to immediately	315	When disabled (the default), C<push_write> will try to immediately
287	write the data to the handle if possible. This avoids having to register	316	write the data to the handle if possible. This avoids having to register
…		…
339	already have occured on BSD systems), but at least it will protect you	368	already have occured on BSD systems), but at least it will protect you
340	from most attacks.	369	from most attacks.
341		370
342	=item read_size => <bytes>	371	=item read_size => <bytes>
343		372
344	The initial read block size, the number of bytes this module will try to	373	The initial read block size, the number of bytes this module will try
345	read during each loop iteration. Each handle object will consume at least	374	to read during each loop iteration. Each handle object will consume
346	this amount of memory for the read buffer as well, so when handling many	375	at least this amount of memory for the read buffer as well, so when
347	connections requirements). See also C<max_read_size>. Default: C<2048>.	376	handling many connections watch out for memory requirements). See also
		377	C<max_read_size>. Default: C<2048>.
348		378
349	=item max_read_size => <bytes>	379	=item max_read_size => <bytes>
350		380
351	The maximum read buffer size used by the dynamic adjustment	381	The maximum read buffer size used by the dynamic adjustment
352	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in	382	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
…		…
396	appropriate error message.	426	appropriate error message.
397		427
398	TLS mode requires Net::SSLeay to be installed (it will be loaded	428	TLS mode requires Net::SSLeay to be installed (it will be loaded
399	automatically when you try to create a TLS handle): this module doesn't	429	automatically when you try to create a TLS handle): this module doesn't
400	have a dependency on that module, so if your module requires it, you have	430	have a dependency on that module, so if your module requires it, you have
401	to add the dependency yourself.	431	to add the dependency yourself. If Net::SSLeay cannot be loaded or is too
		432	old, you get an C<EPROTO> error.
402		433
403	Unlike TCP, TLS has a server and client side: for the TLS server side, use	434	Unlike TCP, TLS has a server and client side: for the TLS server side, use
404	C<accept>, and for the TLS client side of a connection, use C<connect>	435	C<accept>, and for the TLS client side of a connection, use C<connect>
405	mode.	436	mode.
406		437
…		…
422	Use the C<< ->starttls >> method if you need to start TLS negotiation later.	453	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
423		454
424	=item tls_ctx => $anyevent_tls	455	=item tls_ctx => $anyevent_tls
425		456
426	Use the given C<AnyEvent::TLS> object to create the new TLS connection	457	Use the given C<AnyEvent::TLS> object to create the new TLS connection
427	(unless a connection object was specified directly). If this parameter is	458	(unless a connection object was specified directly). If this
428	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	459	parameter is missing (or C<undef>), then AnyEvent::Handle will use
		460	C<AnyEvent::Handle::TLS_CTX>.
429		461
430	Instead of an object, you can also specify a hash reference with C<< key	462	Instead of an object, you can also specify a hash reference with C<< key
431	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	463	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
432	new TLS context object.	464	new TLS context object.
433		465
…		…
461	callback.	493	callback.
462		494
463	This callback will only be called on TLS shutdowns, not when the	495	This callback will only be called on TLS shutdowns, not when the
464	underlying handle signals EOF.	496	underlying handle signals EOF.
465		497
466	=item json => JSON or JSON::XS object	498	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
467		499
468	This is the json coder object used by the C<json> read and write types.	500	This is the json coder object used by the C<json> read and write types.
469		501
470	If you don't supply it, then AnyEvent::Handle will create and use a	502	If you don't supply it, then AnyEvent::Handle will create and use a
471	suitable one (on demand), which will write and expect UTF-8 encoded JSON	503	suitable one (on demand), which will write and expect UTF-8 encoded
		504	JSON texts (either using L<JSON::XS> or L<JSON>). The written texts are
		505	guaranteed not to contain any newline character.
		506
		507	For security reasons, this encoder will likely I<not> handle numbers and
		508	strings, only arrays and objects/hashes. The reason is that originally
		509	JSON was self-delimited, but Dougles Crockford thought it was a splendid
		510	idea to redefine JSON incompatibly, so this is no longer true.
		511
		512	For protocols that used back-to-back JSON texts, this might lead to
		513	run-ins, where two or more JSON texts will be interpreted as one JSON
472	texts.	514	text.
473		515
		516	For this reason, if the default encoder uses L<JSON::XS>, it will default
		517	to not allowing anything but arrays and objects/hashes, at least for the
		518	forseeable future (it will change at some point). This might or might not
		519	be true for the L<JSON> module, so this might cause a security issue.
		520
		521	If you depend on either behaviour, you should create your own json object
		522	and pass it in explicitly.
		523
		524	=item cbor => L<CBOR::XS> object
		525
		526	This is the cbor coder object used by the C<cbor> read and write types.
		527
		528	If you don't supply it, then AnyEvent::Handle will create and use a
		529	suitable one (on demand), which will write CBOR without using extensions,
		530	if possible.
		531
474	Note that you are responsible to depend on the JSON module if you want to	532	Note that you are responsible to depend on the L<CBOR::XS> module if you
475	use this functionality, as AnyEvent does not have a dependency itself.	533	want to use this functionality, as AnyEvent does not have a dependency on
		534	it itself.
476		535
477	=back	536	=back
478		537
479	=cut	538	=cut
480		539
…		…
502	$self->{connect}[0],	561	$self->{connect}[0],
503	$self->{connect}[1],	562	$self->{connect}[1],
504	sub {	563	sub {
505	my ($fh, $host, $port, $retry) = @_;	564	my ($fh, $host, $port, $retry) = @_;
506		565
507	delete $self->{_connect};	566	delete $self->{_connect}; # no longer needed
508		567
509	if ($fh) {	568	if ($fh) {
510	$self->{fh} = $fh;	569	$self->{fh} = $fh;
511		570
512	delete $self->{_skip_drain_rbuf};	571	delete $self->{_skip_drain_rbuf};
…		…
520	});	579	});
521		580
522	} else {	581	} else {
523	if ($self->{on_connect_error}) {	582	if ($self->{on_connect_error}) {
524	$self->{on_connect_error}($self, "$!");	583	$self->{on_connect_error}($self, "$!");
525	$self->destroy;	584	$self->destroy if $self;
526	} else {	585	} else {
527	$self->_error ($!, 1);	586	$self->_error ($!, 1);
528	}	587	}
529	}	588	}
530	},	589	},
531	sub {	590	sub {
532	local $self->{fh} = $_[0];	591	local $self->{fh} = $_[0];
533		592
534	$self->{on_prepare}	593	$self->{on_prepare}
535	? $self->{on_prepare}->($self)	594	? $self->{on_prepare}->($self)
536	: ()	595	: ()
537	}	596	}
538	);	597	);
539	}	598	}
540		599
…		…
739		798
740	=item $handle->rbuf_max ($max_octets)	799	=item $handle->rbuf_max ($max_octets)
741		800
742	Configures the C<rbuf_max> setting (C<undef> disables it).	801	Configures the C<rbuf_max> setting (C<undef> disables it).
743		802
		803	=item $handle->wbuf_max ($max_octets)
		804
		805	Configures the C<wbuf_max> setting (C<undef> disables it).
		806
744	=cut	807	=cut
745		808
746	sub rbuf_max {	809	sub rbuf_max {
747	$_[0]{rbuf_max} = $_[1];	810	$_[0]{rbuf_max} = $_[1];
748	}	811	}
749		812
		813	sub wbuf_max {
		814	$_[0]{wbuf_max} = $_[1];
		815	}
		816
750	#############################################################################	817	#############################################################################
751		818
752	=item $handle->timeout ($seconds)	819	=item $handle->timeout ($seconds)
753		820
754	=item $handle->rtimeout ($seconds)	821	=item $handle->rtimeout ($seconds)
755		822
756	=item $handle->wtimeout ($seconds)	823	=item $handle->wtimeout ($seconds)
757		824
758	Configures (or disables) the inactivity timeout.	825	Configures (or disables) the inactivity timeout.
		826
		827	The timeout will be checked instantly, so this method might destroy the
		828	handle before it returns.
759		829
760	=item $handle->timeout_reset	830	=item $handle->timeout_reset
761		831
762	=item $handle->rtimeout_reset	832	=item $handle->rtimeout_reset
763		833
…		…
847		917
848	The write queue is very simple: you can add data to its end, and	918	The write queue is very simple: you can add data to its end, and
849	AnyEvent::Handle will automatically try to get rid of it for you.	919	AnyEvent::Handle will automatically try to get rid of it for you.
850		920
851	When data could be written and the write buffer is shorter then the low	921	When data could be written and the write buffer is shorter then the low
852	water mark, the C<on_drain> callback will be invoked.	922	water mark, the C<on_drain> callback will be invoked once.
853		923
854	=over 4	924	=over 4
855		925
856	=item $handle->on_drain ($cb)	926	=item $handle->on_drain ($cb)
857		927
…		…
872	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});	942	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
873	}	943	}
874		944
875	=item $handle->push_write ($data)	945	=item $handle->push_write ($data)
876		946
877	Queues the given scalar to be written. You can push as much data as you	947	Queues the given scalar to be written. You can push as much data as
878	want (only limited by the available memory), as C<AnyEvent::Handle>	948	you want (only limited by the available memory and C<wbuf_max>), as
879	buffers it independently of the kernel.	949	C<AnyEvent::Handle> buffers it independently of the kernel.
880		950
881	This method may invoke callbacks (and therefore the handle might be	951	This method may invoke callbacks (and therefore the handle might be
882	destroyed after it returns).	952	destroyed after it returns).
883		953
884	=cut	954	=cut
…		…
901	$self->{on_drain}($self)	971	$self->{on_drain}($self)
902	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	972	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
903	&& $self->{on_drain};	973	&& $self->{on_drain};
904		974
905	delete $self->{_ww} unless length $self->{wbuf};	975	delete $self->{_ww} unless length $self->{wbuf};
906	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	976	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
907	$self->_error ($!, 1);	977	$self->_error ($!, 1);
908	}	978	}
909	};	979	};
910		980
911	# try to write data immediately	981	# try to write data immediately
912	$cb->() unless $self->{autocork};	982	$cb->() unless $self->{autocork};
913		983
914	# if still data left in wbuf, we need to poll	984	# if still data left in wbuf, we need to poll
915	$self->{_ww} = AE::io $self->{fh}, 1, $cb	985	$self->{_ww} = AE::io $self->{fh}, 1, $cb
916	if length $self->{wbuf};	986	if length $self->{wbuf};
		987
		988	if (
		989	defined $self->{wbuf_max}
		990	&& $self->{wbuf_max} < length $self->{wbuf}
		991	) {
		992	$self->_error (Errno::ENOSPC, 1), return;
		993	}
917	};	994	};
918	}	995	}
919		996
920	our %WH;	997	our %WH;
921		998
…		…
992		1069
993	Encodes the given hash or array reference into a JSON object. Unless you	1070	Encodes the given hash or array reference into a JSON object. Unless you
994	provide your own JSON object, this means it will be encoded to JSON text	1071	provide your own JSON object, this means it will be encoded to JSON text
995	in UTF-8.	1072	in UTF-8.
996		1073
		1074	The default encoder might or might not handle every type of JSON value -
		1075	it might be limited to arrays and objects for security reasons. See the
		1076	C<json> constructor attribute for more details.
		1077
997	JSON objects (and arrays) are self-delimiting, so you can write JSON at	1078	JSON objects (and arrays) are self-delimiting, so if you only use arrays
998	one end of a handle and read them at the other end without using any	1079	and hashes, you can write JSON at one end of a handle and read them at the
999	additional framing.	1080	other end without using any additional framing.
1000		1081
1001	The generated JSON text is guaranteed not to contain any newlines: While	1082	The JSON text generated by the default encoder is guaranteed not to
1002	this module doesn't need delimiters after or between JSON texts to be	1083	contain any newlines: While this module doesn't need delimiters after or
1003	able to read them, many other languages depend on that.	1084	between JSON texts to be able to read them, many other languages depend on
		1085	them.
1004		1086
1005	A simple RPC protocol that interoperates easily with others is to send	1087	A simple RPC protocol that interoperates easily with other languages is
1006	JSON arrays (or objects, although arrays are usually the better choice as	1088	to send JSON arrays (or objects, although arrays are usually the better
1007	they mimic how function argument passing works) and a newline after each	1089	choice as they mimic how function argument passing works) and a newline
1008	JSON text:	1090	after each JSON text:
1009		1091
1010	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1092	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1011	$handle->push_write ("\012");	1093	$handle->push_write ("\012");
1012		1094
1013	An AnyEvent::Handle receiver would simply use the C<json> read type and	1095	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
1016	$handle->push_read (json => sub { my $array = $_[1]; ... });	1098	$handle->push_read (json => sub { my $array = $_[1]; ... });
1017		1099
1018	Other languages could read single lines terminated by a newline and pass	1100	Other languages could read single lines terminated by a newline and pass
1019	this line into their JSON decoder of choice.	1101	this line into their JSON decoder of choice.
1020		1102
		1103	=item cbor => $perl_scalar
		1104
		1105	Encodes the given scalar into a CBOR value. Unless you provide your own
		1106	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1107	using any extensions, if possible.
		1108
		1109	CBOR values are self-delimiting, so you can write CBOR at one end of
		1110	a handle and read them at the other end without using any additional
		1111	framing.
		1112
		1113	A simple nd very very fast RPC protocol that interoperates with
		1114	other languages is to send CBOR and receive CBOR values (arrays are
		1115	recommended):
		1116
		1117	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1118
		1119	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1120
		1121	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1122
1021	=cut	1123	=cut
1022		1124
1023	sub json_coder() {	1125	sub json_coder() {
1024	eval { require JSON::XS; JSON::XS->new->utf8 }	1126	eval { require JSON::XS; JSON::XS->new->utf8 }
1025	\|\| do { require JSON; JSON->new->utf8 }	1127	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1026	}	1128	}
1027		1129
1028	register_write_type json => sub {	1130	register_write_type json => sub {
1029	my ($self, $ref) = @_;	1131	my ($self, $ref) = @_;
1030		1132
1031	my $json = $self->{json} \|\|= json_coder;	1133	($self->{json} \|\|= json_coder)
1032
1033	$json->encode ($ref)	1134	->encode ($ref)
		1135	};
		1136
		1137	sub cbor_coder() {
		1138	require CBOR::XS;
		1139	CBOR::XS->new
		1140	}
		1141
		1142	register_write_type cbor => sub {
		1143	my ($self, $scalar) = @_;
		1144
		1145	($self->{cbor} \|\|= cbor_coder)
		1146	->encode ($scalar)
1034	};	1147	};
1035		1148
1036	=item storable => $reference	1149	=item storable => $reference
1037		1150
1038	Freezes the given reference using L<Storable> and writes it to the	1151	Freezes the given reference using L<Storable> and writes it to the
…		…
1041	=cut	1154	=cut
1042		1155
1043	register_write_type storable => sub {	1156	register_write_type storable => sub {
1044	my ($self, $ref) = @_;	1157	my ($self, $ref) = @_;
1045		1158
1046	require Storable;	1159	require Storable unless $Storable::VERSION;
1047		1160
1048	pack "w/a*", Storable::nfreeze ($ref)	1161	pack "w/a*", Storable::nfreeze ($ref)
1049	};	1162	};
1050		1163
1051	=back	1164	=back
…		…
1056	before it was actually written. One way to do that is to replace your	1169	before it was actually written. One way to do that is to replace your
1057	C<on_drain> handler by a callback that shuts down the socket (and set	1170	C<on_drain> handler by a callback that shuts down the socket (and set
1058	C<low_water_mark> to C<0>). This method is a shorthand for just that, and	1171	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
1059	replaces the C<on_drain> callback with:	1172	replaces the C<on_drain> callback with:
1060		1173
1061	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1174	sub { shutdown $_[0]{fh}, 1 }
1062		1175
1063	This simply shuts down the write side and signals an EOF condition to the	1176	This simply shuts down the write side and signals an EOF condition to the
1064	the peer.	1177	the peer.
1065		1178
1066	You can rely on the normal read queue and C<on_eof> handling	1179	You can rely on the normal read queue and C<on_eof> handling
…		…
1088		1201
1089	Whenever the given C<type> is used, C<push_write> will the function with	1202	Whenever the given C<type> is used, C<push_write> will the function with
1090	the handle object and the remaining arguments.	1203	the handle object and the remaining arguments.
1091		1204
1092	The function is supposed to return a single octet string that will be	1205	The function is supposed to return a single octet string that will be
1093	appended to the write buffer, so you cna mentally treat this function as a	1206	appended to the write buffer, so you can mentally treat this function as a
1094	"arguments to on-the-wire-format" converter.	1207	"arguments to on-the-wire-format" converter.
1095		1208
1096	Example: implement a custom write type C<join> that joins the remaining	1209	Example: implement a custom write type C<join> that joins the remaining
1097	arguments using the first one.	1210	arguments using the first one.
1098		1211
…		…
1392	data.	1505	data.
1393		1506
1394	Example: read 2 bytes.	1507	Example: read 2 bytes.
1395		1508
1396	$handle->push_read (chunk => 2, sub {	1509	$handle->push_read (chunk => 2, sub {
1397	warn "yay ", unpack "H*", $_[1];	1510	say "yay " . unpack "H*", $_[1];
1398	});	1511	});
1399		1512
1400	=cut	1513	=cut
1401		1514
1402	register_read_type chunk => sub {	1515	register_read_type chunk => sub {
…		…
1432		1545
1433	register_read_type line => sub {	1546	register_read_type line => sub {
1434	my ($self, $cb, $eol) = @_;	1547	my ($self, $cb, $eol) = @_;
1435		1548
1436	if (@_ < 3) {	1549	if (@_ < 3) {
1437	# this is more than twice as fast as the generic code below	1550	# this is faster then the generic code below
1438	sub {	1551	sub {
1439	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1552	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1553	or return;
1440		1554
		1555	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1441	$cb->($_[0], $1, $2);	1556	$cb->($_[0], $str, "$1");
1442	1	1557	1
1443	}	1558	}
1444	} else {	1559	} else {
1445	$eol = quotemeta $eol unless ref $eol;	1560	$eol = quotemeta $eol unless ref $eol;
1446	$eol = qr\|^(.*?)($eol)\|s;	1561	$eol = qr\|^(.*?)($eol)\|s;
1447		1562
1448	sub {	1563	sub {
1449	$_[0]{rbuf} =~ s/$eol// or return;	1564	$_[0]{rbuf} =~ s/$eol// or return;
1450		1565
1451	$cb->($_[0], $1, $2);	1566	$cb->($_[0], "$1", "$2");
1452	1	1567	1
1453	}	1568	}
1454	}	1569	}
1455	};	1570	};
1456		1571
1457	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1572	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
1458		1573
1459	Makes a regex match against the regex object C<$accept> and returns	1574	Makes a regex match against the regex object C<$accept> and returns
1460	everything up to and including the match.	1575	everything up to and including the match. All the usual regex variables
		1576	($1, %+ etc.) from the regex match are available in the callback.
1461		1577
1462	Example: read a single line terminated by '\n'.	1578	Example: read a single line terminated by '\n'.
1463		1579
1464	$handle->push_read (regex => qr<\n>, sub { ... });	1580	$handle->push_read (regex => qr<\n>, sub { ... });
1465		1581
…		…
1504		1620
1505	sub {	1621	sub {
1506	# accept	1622	# accept
1507	if ($$rbuf =~ $accept) {	1623	if ($$rbuf =~ $accept) {
1508	$data .= substr $$rbuf, 0, $+[0], "";	1624	$data .= substr $$rbuf, 0, $+[0], "";
1509	$cb->($self, $data);	1625	$cb->($_[0], $data);
1510	return 1;	1626	return 1;
1511	}	1627	}
1512		1628
1513	# reject	1629	# reject
1514	if ($reject && $$rbuf =~ $reject) {	1630	if ($reject && $$rbuf =~ $reject) {
1515	$self->_error (Errno::EBADMSG);	1631	$_[0]->_error (Errno::EBADMSG);
1516	}	1632	}
1517		1633
1518	# skip	1634	# skip
1519	if ($skip && $$rbuf =~ $skip) {	1635	if ($skip && $$rbuf =~ $skip) {
1520	$data .= substr $$rbuf, 0, $+[0], "";	1636	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1536	my ($self, $cb) = @_;	1652	my ($self, $cb) = @_;
1537		1653
1538	sub {	1654	sub {
1539	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1655	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1540	if ($_[0]{rbuf} =~ /[^0-9]/) {	1656	if ($_[0]{rbuf} =~ /[^0-9]/) {
1541	$self->_error (Errno::EBADMSG);	1657	$_[0]->_error (Errno::EBADMSG);
1542	}	1658	}
1543	return;	1659	return;
1544	}	1660	}
1545		1661
1546	my $len = $1;	1662	my $len = $1;
1547		1663
1548	$self->unshift_read (chunk => $len, sub {	1664	$_[0]->unshift_read (chunk => $len, sub {
1549	my $string = $_[1];	1665	my $string = $_[1];
1550	$_[0]->unshift_read (chunk => 1, sub {	1666	$_[0]->unshift_read (chunk => 1, sub {
1551	if ($_[1] eq ",") {	1667	if ($_[1] eq ",") {
1552	$cb->($_[0], $string);	1668	$cb->($_[0], $string);
1553	} else {	1669	} else {
1554	$self->_error (Errno::EBADMSG);	1670	$_[0]->_error (Errno::EBADMSG);
1555	}	1671	}
1556	});	1672	});
1557	});	1673	});
1558		1674
1559	1	1675	1
…		…
1609	=item json => $cb->($handle, $hash_or_arrayref)	1725	=item json => $cb->($handle, $hash_or_arrayref)
1610		1726
1611	Reads a JSON object or array, decodes it and passes it to the	1727	Reads a JSON object or array, decodes it and passes it to the
1612	callback. When a parse error occurs, an C<EBADMSG> error will be raised.	1728	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1613		1729
1614	If a C<json> object was passed to the constructor, then that will be used	1730	If a C<json> object was passed to the constructor, then that will be
1615	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1731	used for the final decode, otherwise it will create a L<JSON::XS> or
		1732	L<JSON::PP> coder object expecting UTF-8.
1616		1733
1617	This read type uses the incremental parser available with JSON version	1734	This read type uses the incremental parser available with JSON version
1618	2.09 (and JSON::XS version 2.2) and above. You have to provide a	1735	2.09 (and JSON::XS version 2.2) and above.
1619	dependency on your own: this module will load the JSON module, but
1620	AnyEvent does not depend on it itself.
1621		1736
1622	Since JSON texts are fully self-delimiting, the C<json> read and write	1737	Since JSON texts are fully self-delimiting, the C<json> read and write
1623	types are an ideal simple RPC protocol: just exchange JSON datagrams. See	1738	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1624	the C<json> write type description, above, for an actual example.	1739	the C<json> write type description, above, for an actual example.
1625		1740
…		…
1629	my ($self, $cb) = @_;	1744	my ($self, $cb) = @_;
1630		1745
1631	my $json = $self->{json} \|\|= json_coder;	1746	my $json = $self->{json} \|\|= json_coder;
1632		1747
1633	my $data;	1748	my $data;
1634	my $rbuf = \$self->{rbuf};
1635		1749
1636	sub {	1750	sub {
1637	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1751	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1638		1752
1639	if ($ref) {	1753	if ($ref) {
1640	$self->{rbuf} = $json->incr_text;	1754	$_[0]{rbuf} = $json->incr_text;
1641	$json->incr_text = "";	1755	$json->incr_text = "";
1642	$cb->($self, $ref);	1756	$cb->($_[0], $ref);
1643		1757
1644	1	1758	1
1645	} elsif ($@) {	1759	} elsif ($@) {
1646	# error case	1760	# error case
1647	$json->incr_skip;	1761	$json->incr_skip;
1648		1762
1649	$self->{rbuf} = $json->incr_text;	1763	$_[0]{rbuf} = $json->incr_text;
1650	$json->incr_text = "";	1764	$json->incr_text = "";
1651		1765
1652	$self->_error (Errno::EBADMSG);	1766	$_[0]->_error (Errno::EBADMSG);
1653		1767
1654	()	1768	()
1655	} else {	1769	} else {
1656	$self->{rbuf} = "";	1770	$_[0]{rbuf} = "";
1657		1771
		1772	()
		1773	}
		1774	}
		1775	};
		1776
		1777	=item cbor => $cb->($handle, $scalar)
		1778
		1779	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1780	error occurs, an C<EBADMSG> error will be raised.
		1781
		1782	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1783	used for the final decode, otherwise it will create a CBOR coder without
		1784	enabling any options.
		1785
		1786	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1787	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1788	itself.
		1789
		1790	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1791	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1792	the C<cbor> write type description, above, for an actual example.
		1793
		1794	=cut
		1795
		1796	register_read_type cbor => sub {
		1797	my ($self, $cb) = @_;
		1798
		1799	my $cbor = $self->{cbor} \|\|= cbor_coder;
		1800
		1801	my $data;
		1802
		1803	sub {
		1804	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1805
		1806	if (@value) {
		1807	$cb->($_[0], @value);
		1808
		1809	1
		1810	} elsif ($@) {
		1811	# error case
		1812	$cbor->incr_reset;
		1813
		1814	$_[0]->_error (Errno::EBADMSG);
		1815
		1816	()
		1817	} else {
1658	()	1818	()
1659	}	1819	}
1660	}	1820	}
1661	};	1821	};
1662		1822
…		…
1671	=cut	1831	=cut
1672		1832
1673	register_read_type storable => sub {	1833	register_read_type storable => sub {
1674	my ($self, $cb) = @_;	1834	my ($self, $cb) = @_;
1675		1835
1676	require Storable;	1836	require Storable unless $Storable::VERSION;
1677		1837
1678	sub {	1838	sub {
1679	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1839	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1680	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1840	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1681	or return;	1841	or return;
…		…
1684		1844
1685	# bypass unshift if we already have the remaining chunk	1845	# bypass unshift if we already have the remaining chunk
1686	if ($format + $len <= length $_[0]{rbuf}) {	1846	if ($format + $len <= length $_[0]{rbuf}) {
1687	my $data = substr $_[0]{rbuf}, $format, $len;	1847	my $data = substr $_[0]{rbuf}, $format, $len;
1688	substr $_[0]{rbuf}, 0, $format + $len, "";	1848	substr $_[0]{rbuf}, 0, $format + $len, "";
		1849
1689	$cb->($_[0], Storable::thaw ($data));	1850	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1851	or return $_[0]->_error (Errno::EBADMSG);
1690	} else {	1852	} else {
1691	# remove prefix	1853	# remove prefix
1692	substr $_[0]{rbuf}, 0, $format, "";	1854	substr $_[0]{rbuf}, 0, $format, "";
1693		1855
1694	# read remaining chunk	1856	# read remaining chunk
1695	$_[0]->unshift_read (chunk => $len, sub {	1857	$_[0]->unshift_read (chunk => $len, sub {
1696	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1858	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1697	$cb->($_[0], $ref);
1698	} else {
1699	$self->_error (Errno::EBADMSG);	1859	or $_[0]->_error (Errno::EBADMSG);
1700	}
1701	});	1860	});
1702	}	1861	}
1703		1862
1704	1	1863	1
1705	}	1864	}
		1865	};
		1866
		1867	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1868
		1869	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1870	record without consuming anything. Only SSL version 3 or higher
		1871	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1872	SSL2-compatible framing is supported).
		1873
		1874	If it detects that the input data is likely TLS, it calls the callback
		1875	with a true value for C<$detect> and the (on-wire) TLS version as second
		1876	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1877	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1878	be definitely not TLS, it calls the callback with a false value for
		1879	C<$detect>.
		1880
		1881	The callback could use this information to decide whether or not to start
		1882	TLS negotiation.
		1883
		1884	In all cases the data read so far is passed to the following read
		1885	handlers.
		1886
		1887	Usually you want to use the C<tls_autostart> read type instead.
		1888
		1889	If you want to design a protocol that works in the presence of TLS
		1890	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1891	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1892	read type does are a bit more strict, but might losen in the future to
		1893	accomodate protocol changes.
		1894
		1895	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1896	L<Net::SSLeay>).
		1897
		1898	=item tls_autostart => $tls[, $tls_ctx]
		1899
		1900	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1901	to start tls by calling C<starttls> with the given arguments.
		1902
		1903	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1904	been configured to accept, as servers do not normally send a handshake on
		1905	their own and ths cannot be detected in this way.
		1906
		1907	See C<tls_detect> above for more details.
		1908
		1909	Example: give the client a chance to start TLS before accepting a text
		1910	line.
		1911
		1912	$hdl->push_read (tls_detect => "accept");
		1913	$hdl->push_read (line => sub {
		1914	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1915	});
		1916
		1917	=cut
		1918
		1919	register_read_type tls_detect => sub {
		1920	my ($self, $cb) = @_;
		1921
		1922	sub {
		1923	# this regex matches a full or partial tls record
		1924	if (
		1925	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1926	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1927	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1928	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1929	) {
		1930	return if 3 != length $1; # partial match, can't decide yet
		1931
		1932	# full match, valid TLS record
		1933	my ($major, $minor) = unpack "CC", $1;
		1934	$cb->($self, "accept", $major + $minor * 0.1);
		1935	} else {
		1936	# mismatch == guaranteed not TLS
		1937	$cb->($self, undef);
		1938	}
		1939
		1940	1
		1941	}
		1942	};
		1943
		1944	register_read_type tls_autostart => sub {
		1945	my ($self, @tls) = @_;
		1946
		1947	$RH{tls_detect}($self, sub {
		1948	return unless $_[1];
		1949	$_[0]->starttls (@tls);
		1950	})
1706	};	1951	};
1707		1952
1708	=back	1953	=back
1709		1954
1710	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1955	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1742	Note that AnyEvent::Handle will automatically C<start_read> for you when	1987	Note that AnyEvent::Handle will automatically C<start_read> for you when
1743	you change the C<on_read> callback or push/unshift a read callback, and it	1988	you change the C<on_read> callback or push/unshift a read callback, and it
1744	will automatically C<stop_read> for you when neither C<on_read> is set nor	1989	will automatically C<stop_read> for you when neither C<on_read> is set nor
1745	there are any read requests in the queue.	1990	there are any read requests in the queue.
1746		1991
1747	These methods will have no effect when in TLS mode (as TLS doesn't support	1992	In older versions of this module (<= 5.3), these methods had no effect,
1748	half-duplex connections).	1993	as TLS does not support half-duplex connections. In current versions they
		1994	work as expected, as this behaviour is required to avoid certain resource
		1995	attacks, where the program would be forced to read (and buffer) arbitrary
		1996	amounts of data before being able to send some data. The drawback is that
		1997	some readings of the the SSL/TLS specifications basically require this
		1998	attack to be working, as SSL/TLS implementations might stall sending data
		1999	during a rehandshake.
		2000
		2001	As a guideline, during the initial handshake, you should not stop reading,
		2002	and as a client, it might cause problems, depending on your application.
1749		2003
1750	=cut	2004	=cut
1751		2005
1752	sub stop_read {	2006	sub stop_read {
1753	my ($self) = @_;	2007	my ($self) = @_;
1754		2008
1755	delete $self->{_rw} unless $self->{tls};	2009	delete $self->{_rw};
1756	}	2010	}
1757		2011
1758	sub start_read {	2012	sub start_read {
1759	my ($self) = @_;	2013	my ($self) = @_;
1760		2014
…		…
1785	} elsif (defined $len) {	2039	} elsif (defined $len) {
1786	delete $self->{_rw};	2040	delete $self->{_rw};
1787	$self->{_eof} = 1;	2041	$self->{_eof} = 1;
1788	$self->_drain_rbuf;	2042	$self->_drain_rbuf;
1789		2043
1790	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2044	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
1791	return $self->_error ($!, 1);	2045	return $self->_error ($!, 1);
1792	}	2046	}
1793	};	2047	};
1794	}	2048	}
1795	}	2049	}
…		…
1801	my ($self, $err) = @_;	2055	my ($self, $err) = @_;
1802		2056
1803	return $self->_error ($!, 1)	2057	return $self->_error ($!, 1)
1804	if $err == Net::SSLeay::ERROR_SYSCALL ();	2058	if $err == Net::SSLeay::ERROR_SYSCALL ();
1805		2059
1806	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2060	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1807		2061
1808	# reduce error string to look less scary	2062	# reduce error string to look less scary
1809	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2063	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1810		2064
1811	if ($self->{_on_starttls}) {	2065	if ($self->{_on_starttls}) {
…		…
1825	sub _dotls {	2079	sub _dotls {
1826	my ($self) = @_;	2080	my ($self) = @_;
1827		2081
1828	my $tmp;	2082	my $tmp;
1829		2083
1830	if (length $self->{_tls_wbuf}) {	2084	while (length $self->{_tls_wbuf}) {
1831	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2085	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1832	substr $self->{_tls_wbuf}, 0, $tmp, "";	2086	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2087
		2088	return $self->_tls_error ($tmp)
		2089	if $tmp != $ERROR_WANT_READ
		2090	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		2091
		2092	last;
1833	}	2093	}
1834		2094
1835	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2095	substr $self->{_tls_wbuf}, 0, $tmp, "";
1836	return $self->_tls_error ($tmp)
1837	if $tmp != $ERROR_WANT_READ
1838	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1839	}	2096	}
1840		2097
1841	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2098	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1842	unless (length $tmp) {	2099	unless (length $tmp) {
1843	$self->{_on_starttls}	2100	$self->{_on_starttls}
…		…
1857	$self->{_tls_rbuf} .= $tmp;	2114	$self->{_tls_rbuf} .= $tmp;
1858	$self->_drain_rbuf;	2115	$self->_drain_rbuf;
1859	$self->{tls} or return; # tls session might have gone away in callback	2116	$self->{tls} or return; # tls session might have gone away in callback
1860	}	2117	}
1861		2118
1862	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	2119	$tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us
1863	return $self->_tls_error ($tmp)	2120	return $self->_tls_error ($tmp)
1864	if $tmp != $ERROR_WANT_READ	2121	if $tmp != $ERROR_WANT_READ
1865	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2122	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1866		2123
1867	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2124	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1877		2134
1878	=item $handle->starttls ($tls[, $tls_ctx])	2135	=item $handle->starttls ($tls[, $tls_ctx])
1879		2136
1880	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2137	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1881	object is created, you can also do that at a later time by calling	2138	object is created, you can also do that at a later time by calling
1882	C<starttls>.	2139	C<starttls>. See the C<tls> constructor argument for general info.
1883		2140
1884	Starting TLS is currently an asynchronous operation - when you push some	2141	Starting TLS is currently an asynchronous operation - when you push some
1885	write data and then call C<< ->starttls >> then TLS negotiation will start	2142	write data and then call C<< ->starttls >> then TLS negotiation will start
1886	immediately, after which the queued write data is then sent.	2143	immediately, after which the queued write data is then sent. This might
		2144	change in future versions, so best make sure you have no outstanding write
		2145	data when calling this method.
1887		2146
1888	The first argument is the same as the C<tls> constructor argument (either	2147	The first argument is the same as the C<tls> constructor argument (either
1889	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2148	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1890		2149
1891	The second argument is the optional C<AnyEvent::TLS> object that is used	2150	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1913	my ($self, $tls, $ctx) = @_;	2172	my ($self, $tls, $ctx) = @_;
1914		2173
1915	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2174	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1916	if $self->{tls};	2175	if $self->{tls};
1917		2176
		2177	unless (defined $AnyEvent::TLS::VERSION) {
		2178	eval {
		2179	require Net::SSLeay;
		2180	require AnyEvent::TLS;
		2181	1
		2182	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2183	}
		2184
1918	$self->{tls} = $tls;	2185	$self->{tls} = $tls;
1919	$self->{tls_ctx} = $ctx if @_ > 2;	2186	$self->{tls_ctx} = $ctx if @_ > 2;
1920		2187
1921	return unless $self->{fh};	2188	return unless $self->{fh};
1922		2189
1923	require Net::SSLeay;
1924
1925	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2190	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1926	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2191	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1927		2192
1928	$tls = delete $self->{tls};	2193	$tls = delete $self->{tls};
1929	$ctx = $self->{tls_ctx};	2194	$ctx = $self->{tls_ctx};
1930		2195
1931	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2196	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1932		2197
1933	if ("HASH" eq ref $ctx) {	2198	if ("HASH" eq ref $ctx) {
1934	require AnyEvent::TLS;
1935
1936	if ($ctx->{cache}) {	2199	if ($ctx->{cache}) {
1937	my $key = $ctx+0;	2200	my $key = $ctx+0;
1938	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2201	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1939	} else {	2202	} else {
1940	$ctx = new AnyEvent::TLS %$ctx;	2203	$ctx = new AnyEvent::TLS %$ctx;
…		…
1962	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2225	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1963		2226
1964	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2227	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1965	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2228	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1966		2229
1967	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2230	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2231	$self->{rbuf} = "";
1968		2232
1969	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2233	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1970		2234
1971	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2235	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1972	if $self->{on_starttls};	2236	if $self->{on_starttls};
…		…
2010	if $self->{tls} > 0;	2274	if $self->{tls} > 0;
2011		2275
2012	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2276	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
2013	}	2277	}
2014		2278
		2279	=item $handle->resettls
		2280
		2281	This rarely-used method simply resets and TLS state on the handle, usually
		2282	causing data loss.
		2283
		2284	One case where it may be useful is when you want to skip over the data in
		2285	the stream but you are not interested in interpreting it, so data loss is
		2286	no concern.
		2287
		2288	=cut
		2289
		2290	*resettls = \&_freetls;
		2291
2015	sub DESTROY {	2292	sub DESTROY {
2016	my ($self) = @_;	2293	my ($self) = @_;
2017		2294
2018	&_freetls;	2295	&_freetls;
2019		2296
…		…
2028	push @linger, AE::io $fh, 1, sub {	2305	push @linger, AE::io $fh, 1, sub {
2029	my $len = syswrite $fh, $wbuf, length $wbuf;	2306	my $len = syswrite $fh, $wbuf, length $wbuf;
2030		2307
2031	if ($len > 0) {	2308	if ($len > 0) {
2032	substr $wbuf, 0, $len, "";	2309	substr $wbuf, 0, $len, "";
2033	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {	2310	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) {
2034	@linger = (); # end	2311	@linger = (); # end
2035	}	2312	}
2036	};	2313	};
2037	push @linger, AE::timer $linger, 0, sub {	2314	push @linger, AE::timer $linger, 0, sub {
2038	@linger = ();	2315	@linger = ();
…		…
2134		2411
2135	It is only safe to "forget" the reference inside EOF or error callbacks,	2412	It is only safe to "forget" the reference inside EOF or error callbacks,
2136	from within all other callbacks, you need to explicitly call the C<<	2413	from within all other callbacks, you need to explicitly call the C<<
2137	->destroy >> method.	2414	->destroy >> method.
2138		2415
		2416	=item Why is my C<on_eof> callback never called?
		2417
		2418	Probably because your C<on_error> callback is being called instead: When
		2419	you have outstanding requests in your read queue, then an EOF is
		2420	considered an error as you clearly expected some data.
		2421
		2422	To avoid this, make sure you have an empty read queue whenever your handle
		2423	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2424	an C<on_read> handler that simply pushes the first read requests in the
		2425	queue.
		2426
		2427	See also the next question, which explains this in a bit more detail.
		2428
		2429	=item How can I serve requests in a loop?
		2430
		2431	Most protocols consist of some setup phase (authentication for example)
		2432	followed by a request handling phase, where the server waits for requests
		2433	and handles them, in a loop.
		2434
		2435	There are two important variants: The first (traditional, better) variant
		2436	handles requests until the server gets some QUIT command, causing it to
		2437	close the connection first (highly desirable for a busy TCP server). A
		2438	client dropping the connection is an error, which means this variant can
		2439	detect an unexpected detection close.
		2440
		2441	To handle this case, always make sure you have a non-empty read queue, by
		2442	pushing the "read request start" handler on it:
		2443
		2444	# we assume a request starts with a single line
		2445	my @start_request; @start_request = (line => sub {
		2446	my ($hdl, $line) = @_;
		2447
		2448	... handle request
		2449
		2450	# push next request read, possibly from a nested callback
		2451	$hdl->push_read (@start_request);
		2452	});
		2453
		2454	# auth done, now go into request handling loop
		2455	# now push the first @start_request
		2456	$hdl->push_read (@start_request);
		2457
		2458	By always having an outstanding C<push_read>, the handle always expects
		2459	some data and raises the C<EPIPE> error when the connction is dropped
		2460	unexpectedly.
		2461
		2462	The second variant is a protocol where the client can drop the connection
		2463	at any time. For TCP, this means that the server machine may run out of
		2464	sockets easier, and in general, it means you cannot distinguish a protocl
		2465	failure/client crash from a normal connection close. Nevertheless, these
		2466	kinds of protocols are common (and sometimes even the best solution to the
		2467	problem).
		2468
		2469	Having an outstanding read request at all times is possible if you ignore
		2470	C<EPIPE> errors, but this doesn't help with when the client drops the
		2471	connection during a request, which would still be an error.
		2472
		2473	A better solution is to push the initial request read in an C<on_read>
		2474	callback. This avoids an error, as when the server doesn't expect data
		2475	(i.e. is idly waiting for the next request, an EOF will not raise an
		2476	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2477	and simpler:
		2478
		2479	# auth done, now go into request handling loop
		2480	$hdl->on_read (sub {
		2481	my ($hdl) = @_;
		2482
		2483	# called each time we receive data but the read queue is empty
		2484	# simply start read the request
		2485
		2486	$hdl->push_read (line => sub {
		2487	my ($hdl, $line) = @_;
		2488
		2489	... handle request
		2490
		2491	# do nothing special when the request has been handled, just
		2492	# let the request queue go empty.
		2493	});
		2494	});
		2495
2139	=item I get different callback invocations in TLS mode/Why can't I pause	2496	=item I get different callback invocations in TLS mode/Why can't I pause
2140	reading?	2497	reading?
2141		2498
2142	Unlike, say, TCP, TLS connections do not consist of two independent	2499	Unlike, say, TCP, TLS connections do not consist of two independent
2143	communication channels, one for each direction. Or put differently, the	2500	communication channels, one for each direction. Or put differently, the
…		…
2164	$handle->on_eof (undef);	2521	$handle->on_eof (undef);
2165	$handle->on_error (sub {	2522	$handle->on_error (sub {
2166	my $data = delete $_[0]{rbuf};	2523	my $data = delete $_[0]{rbuf};
2167	});	2524	});
2168		2525
		2526	Note that this example removes the C<rbuf> member from the handle object,
		2527	which is not normally allowed by the API. It is expressly permitted in
		2528	this case only, as the handle object needs to be destroyed afterwards.
		2529
2169	The reason to use C<on_error> is that TCP connections, due to latencies	2530	The reason to use C<on_error> is that TCP connections, due to latencies
2170	and packets loss, might get closed quite violently with an error, when in	2531	and packets loss, might get closed quite violently with an error, when in
2171	fact all data has been received.	2532	fact all data has been received.
2172		2533
2173	It is usually better to use acknowledgements when transferring data,	2534	It is usually better to use acknowledgements when transferring data,
…		…
2183	C<low_water_mark> this will be called precisely when all data has been	2544	C<low_water_mark> this will be called precisely when all data has been
2184	written to the socket:	2545	written to the socket:
2185		2546
2186	$handle->push_write (...);	2547	$handle->push_write (...);
2187	$handle->on_drain (sub {	2548	$handle->on_drain (sub {
2188	warn "all data submitted to the kernel\n";	2549	AE::log debug => "All data submitted to the kernel.";
2189	undef $handle;	2550	undef $handle;
2190	});	2551	});
2191		2552
2192	If you just want to queue some data and then signal EOF to the other side,	2553	If you just want to queue some data and then signal EOF to the other side,
2193	consider using C<< ->push_shutdown >> instead.	2554	consider using C<< ->push_shutdown >> instead.
…		…
2277	When you have intermediate CA certificates that your clients might not	2638	When you have intermediate CA certificates that your clients might not
2278	know about, just append them to the C<cert_file>.	2639	know about, just append them to the C<cert_file>.
2279		2640
2280	=back	2641	=back
2281		2642
2282
2283	=head1 SUBCLASSING AnyEvent::Handle	2643	=head1 SUBCLASSING AnyEvent::Handle
2284		2644
2285	In many cases, you might want to subclass AnyEvent::Handle.	2645	In many cases, you might want to subclass AnyEvent::Handle.
2286		2646
2287	To make this easier, a given version of AnyEvent::Handle uses these	2647	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2313		2673
2314	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2674	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2315		2675
2316	=cut	2676	=cut
2317		2677
2318	1; # End of AnyEvent::Handle	2678	1
		2679

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.205 by root, Mon Nov 15 17:11:00 2010 UTC vs. Revision 1.244 by root, Wed Apr 1 19:59:01 2015 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.205 by root, Mon Nov 15 17:11:00 2010 UTC vs.
Revision 1.244 by root, Wed Apr 1 19:59:01 2015 UTC