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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.208 by root, Sun Dec 5 11:41:45 2010 UTC vs.
Revision 1.245 by root, Tue Jun 16 03:22:20 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;
…		…
91		91
92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]	92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
93		93
94	The filehandle this L<AnyEvent::Handle> object will operate on.	94	The filehandle this L<AnyEvent::Handle> object will operate on.
95	NOTE: The filehandle will be set to non-blocking mode (using	95	NOTE: The filehandle will be set to non-blocking mode (using
96	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	96	C<AnyEvent::fh_unblock>) by the constructor and needs to stay in
97	that mode.	97	that mode.
98		98
99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]	99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
100		100
101	Try to connect to the specified host and service (port), using	101	Try to connect to the specified host and service (port), using
…		…
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
…		…
462	callback.	493	callback.
463		494
464	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
465	underlying handle signals EOF.	496	underlying handle signals EOF.
466		497
467	=item json => JSON or JSON::XS object	498	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
468		499
469	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.
470		501
471	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
472	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
473	texts.	514	text.
474		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
475	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
476	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.
477		535
478	=back	536	=back
479		537
480	=cut	538	=cut
481		539
…		…
521	});	579	});
522		580
523	} else {	581	} else {
524	if ($self->{on_connect_error}) {	582	if ($self->{on_connect_error}) {
525	$self->{on_connect_error}($self, "$!");	583	$self->{on_connect_error}($self, "$!");
526	$self->destroy;	584	$self->destroy if $self;
527	} else {	585	} else {
528	$self->_error ($!, 1);	586	$self->_error ($!, 1);
529	}	587	}
530	}	588	}
531	},	589	},
532	sub {	590	sub {
533	local $self->{fh} = $_[0];	591	local $self->{fh} = $_[0];
534		592
535	$self->{on_prepare}	593	$self->{on_prepare}
536	? $self->{on_prepare}->($self)	594	? $self->{on_prepare}->($self)
537	: ()	595	: ()
538	}	596	}
539	);	597	);
540	}	598	}
541		599
…		…
553	# with AnyEvent::Handle, do them a favour.	611	# with AnyEvent::Handle, do them a favour.
554	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();	612	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
555	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"	613	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
556	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;	614	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
557		615
558	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	616	AnyEvent::fh_unblock $self->{fh};
559		617
560	$self->{_activity} =	618	$self->{_activity} =
561	$self->{_ractivity} =	619	$self->{_ractivity} =
562	$self->{_wactivity} = AE::now;	620	$self->{_wactivity} = AE::now;
563		621
…		…
740		798
741	=item $handle->rbuf_max ($max_octets)	799	=item $handle->rbuf_max ($max_octets)
742		800
743	Configures the C<rbuf_max> setting (C<undef> disables it).	801	Configures the C<rbuf_max> setting (C<undef> disables it).
744		802
		803	=item $handle->wbuf_max ($max_octets)
		804
		805	Configures the C<wbuf_max> setting (C<undef> disables it).
		806
745	=cut	807	=cut
746		808
747	sub rbuf_max {	809	sub rbuf_max {
748	$_[0]{rbuf_max} = $_[1];	810	$_[0]{rbuf_max} = $_[1];
749	}	811	}
750		812
		813	sub wbuf_max {
		814	$_[0]{wbuf_max} = $_[1];
		815	}
		816
751	#############################################################################	817	#############################################################################
752		818
753	=item $handle->timeout ($seconds)	819	=item $handle->timeout ($seconds)
754		820
755	=item $handle->rtimeout ($seconds)	821	=item $handle->rtimeout ($seconds)
756		822
757	=item $handle->wtimeout ($seconds)	823	=item $handle->wtimeout ($seconds)
758		824
759	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.
760		829
761	=item $handle->timeout_reset	830	=item $handle->timeout_reset
762		831
763	=item $handle->rtimeout_reset	832	=item $handle->rtimeout_reset
764		833
…		…
848		917
849	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
850	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.
851		920
852	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
853	water mark, the C<on_drain> callback will be invoked.	922	water mark, the C<on_drain> callback will be invoked once.
854		923
855	=over 4	924	=over 4
856		925
857	=item $handle->on_drain ($cb)	926	=item $handle->on_drain ($cb)
858		927
…		…
873	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});
874	}	943	}
875		944
876	=item $handle->push_write ($data)	945	=item $handle->push_write ($data)
877		946
878	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
879	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
880	buffers it independently of the kernel.	949	C<AnyEvent::Handle> buffers it independently of the kernel.
881		950
882	This method may invoke callbacks (and therefore the handle might be	951	This method may invoke callbacks (and therefore the handle might be
883	destroyed after it returns).	952	destroyed after it returns).
884		953
885	=cut	954	=cut
…		…
902	$self->{on_drain}($self)	971	$self->{on_drain}($self)
903	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})
904	&& $self->{on_drain};	973	&& $self->{on_drain};
905		974
906	delete $self->{_ww} unless length $self->{wbuf};	975	delete $self->{_ww} unless length $self->{wbuf};
907	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	976	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
908	$self->_error ($!, 1);	977	$self->_error ($!, 1);
909	}	978	}
910	};	979	};
911		980
912	# try to write data immediately	981	# try to write data immediately
913	$cb->() unless $self->{autocork};	982	$cb->() unless $self->{autocork};
914		983
915	# if still data left in wbuf, we need to poll	984	# if still data left in wbuf, we need to poll
916	$self->{_ww} = AE::io $self->{fh}, 1, $cb	985	$self->{_ww} = AE::io $self->{fh}, 1, $cb
917	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	}
918	};	994	};
919	}	995	}
920		996
921	our %WH;	997	our %WH;
922		998
…		…
993		1069
994	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
995	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
996	in UTF-8.	1072	in UTF-8.
997		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
998	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
999	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
1000	additional framing.	1080	other end without using any additional framing.
1001		1081
1002	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
1003	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
1004	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.
1005		1086
1006	A simple RPC protocol that interoperates easily with others is to send	1087	A simple RPC protocol that interoperates easily with other languages is
1007	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
1008	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
1009	JSON text:	1090	after each JSON text:
1010		1091
1011	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1092	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1012	$handle->push_write ("\012");	1093	$handle->push_write ("\012");
1013		1094
1014	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
…		…
1017	$handle->push_read (json => sub { my $array = $_[1]; ... });	1098	$handle->push_read (json => sub { my $array = $_[1]; ... });
1018		1099
1019	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
1020	this line into their JSON decoder of choice.	1101	this line into their JSON decoder of choice.
1021		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
1022	=cut	1123	=cut
1023		1124
1024	sub json_coder() {	1125	sub json_coder() {
1025	eval { require JSON::XS; JSON::XS->new->utf8 }	1126	eval { require JSON::XS; JSON::XS->new->utf8 }
1026	\|\| do { require JSON; JSON->new->utf8 }	1127	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1027	}	1128	}
1028		1129
1029	register_write_type json => sub {	1130	register_write_type json => sub {
1030	my ($self, $ref) = @_;	1131	my ($self, $ref) = @_;
1031		1132
1032	my $json = $self->{json} \|\|= json_coder;	1133	($self->{json} \|\|= json_coder)
1033
1034	$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)
1035	};	1147	};
1036		1148
1037	=item storable => $reference	1149	=item storable => $reference
1038		1150
1039	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
…		…
1042	=cut	1154	=cut
1043		1155
1044	register_write_type storable => sub {	1156	register_write_type storable => sub {
1045	my ($self, $ref) = @_;	1157	my ($self, $ref) = @_;
1046		1158
1047	require Storable;	1159	require Storable unless $Storable::VERSION;
1048		1160
1049	pack "w/a*", Storable::nfreeze ($ref)	1161	pack "w/a*", Storable::nfreeze ($ref)
1050	};	1162	};
1051		1163
1052	=back	1164	=back
…		…
1057	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
1058	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
1059	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
1060	replaces the C<on_drain> callback with:	1172	replaces the C<on_drain> callback with:
1061		1173
1062	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1174	sub { shutdown $_[0]{fh}, 1 }
1063		1175
1064	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
1065	the peer.	1177	the peer.
1066		1178
1067	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
…		…
1089		1201
1090	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
1091	the handle object and the remaining arguments.	1203	the handle object and the remaining arguments.
1092		1204
1093	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
1094	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
1095	"arguments to on-the-wire-format" converter.	1207	"arguments to on-the-wire-format" converter.
1096		1208
1097	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
1098	arguments using the first one.	1210	arguments using the first one.
1099		1211
…		…
1393	data.	1505	data.
1394		1506
1395	Example: read 2 bytes.	1507	Example: read 2 bytes.
1396		1508
1397	$handle->push_read (chunk => 2, sub {	1509	$handle->push_read (chunk => 2, sub {
1398	warn "yay ", unpack "H*", $_[1];	1510	say "yay " . unpack "H*", $_[1];
1399	});	1511	});
1400		1512
1401	=cut	1513	=cut
1402		1514
1403	register_read_type chunk => sub {	1515	register_read_type chunk => sub {
…		…
1433		1545
1434	register_read_type line => sub {	1546	register_read_type line => sub {
1435	my ($self, $cb, $eol) = @_;	1547	my ($self, $cb, $eol) = @_;
1436		1548
1437	if (@_ < 3) {	1549	if (@_ < 3) {
1438	# this is more than twice as fast as the generic code below	1550	# this is faster then the generic code below
1439	sub {	1551	sub {
1440	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1552	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1553	or return;
1441		1554
		1555	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1442	$cb->($_[0], $1, $2);	1556	$cb->($_[0], $str, "$1");
1443	1	1557	1
1444	}	1558	}
1445	} else {	1559	} else {
1446	$eol = quotemeta $eol unless ref $eol;	1560	$eol = quotemeta $eol unless ref $eol;
1447	$eol = qr\|^(.*?)($eol)\|s;	1561	$eol = qr\|^(.*?)($eol)\|s;
1448		1562
1449	sub {	1563	sub {
1450	$_[0]{rbuf} =~ s/$eol// or return;	1564	$_[0]{rbuf} =~ s/$eol// or return;
1451		1565
1452	$cb->($_[0], $1, $2);	1566	$cb->($_[0], "$1", "$2");
1453	1	1567	1
1454	}	1568	}
1455	}	1569	}
1456	};	1570	};
1457		1571
1458	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1572	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
1459		1573
1460	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
1461	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.
1462		1577
1463	Example: read a single line terminated by '\n'.	1578	Example: read a single line terminated by '\n'.
1464		1579
1465	$handle->push_read (regex => qr<\n>, sub { ... });	1580	$handle->push_read (regex => qr<\n>, sub { ... });
1466		1581
…		…
1505		1620
1506	sub {	1621	sub {
1507	# accept	1622	# accept
1508	if ($$rbuf =~ $accept) {	1623	if ($$rbuf =~ $accept) {
1509	$data .= substr $$rbuf, 0, $+[0], "";	1624	$data .= substr $$rbuf, 0, $+[0], "";
1510	$cb->($self, $data);	1625	$cb->($_[0], $data);
1511	return 1;	1626	return 1;
1512	}	1627	}
1513		1628
1514	# reject	1629	# reject
1515	if ($reject && $$rbuf =~ $reject) {	1630	if ($reject && $$rbuf =~ $reject) {
1516	$self->_error (Errno::EBADMSG);	1631	$_[0]->_error (Errno::EBADMSG);
1517	}	1632	}
1518		1633
1519	# skip	1634	# skip
1520	if ($skip && $$rbuf =~ $skip) {	1635	if ($skip && $$rbuf =~ $skip) {
1521	$data .= substr $$rbuf, 0, $+[0], "";	1636	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1537	my ($self, $cb) = @_;	1652	my ($self, $cb) = @_;
1538		1653
1539	sub {	1654	sub {
1540	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1655	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1541	if ($_[0]{rbuf} =~ /[^0-9]/) {	1656	if ($_[0]{rbuf} =~ /[^0-9]/) {
1542	$self->_error (Errno::EBADMSG);	1657	$_[0]->_error (Errno::EBADMSG);
1543	}	1658	}
1544	return;	1659	return;
1545	}	1660	}
1546		1661
1547	my $len = $1;	1662	my $len = $1;
1548		1663
1549	$self->unshift_read (chunk => $len, sub {	1664	$_[0]->unshift_read (chunk => $len, sub {
1550	my $string = $_[1];	1665	my $string = $_[1];
1551	$_[0]->unshift_read (chunk => 1, sub {	1666	$_[0]->unshift_read (chunk => 1, sub {
1552	if ($_[1] eq ",") {	1667	if ($_[1] eq ",") {
1553	$cb->($_[0], $string);	1668	$cb->($_[0], $string);
1554	} else {	1669	} else {
1555	$self->_error (Errno::EBADMSG);	1670	$_[0]->_error (Errno::EBADMSG);
1556	}	1671	}
1557	});	1672	});
1558	});	1673	});
1559		1674
1560	1	1675	1
…		…
1610	=item json => $cb->($handle, $hash_or_arrayref)	1725	=item json => $cb->($handle, $hash_or_arrayref)
1611		1726
1612	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
1613	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.
1614		1729
1615	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
1616	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.
1617		1733
1618	This read type uses the incremental parser available with JSON version	1734	This read type uses the incremental parser available with JSON version
1619	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.
1620	dependency on your own: this module will load the JSON module, but
1621	AnyEvent does not depend on it itself.
1622		1736
1623	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
1624	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
1625	the C<json> write type description, above, for an actual example.	1739	the C<json> write type description, above, for an actual example.
1626		1740
…		…
1630	my ($self, $cb) = @_;	1744	my ($self, $cb) = @_;
1631		1745
1632	my $json = $self->{json} \|\|= json_coder;	1746	my $json = $self->{json} \|\|= json_coder;
1633		1747
1634	my $data;	1748	my $data;
1635	my $rbuf = \$self->{rbuf};
1636		1749
1637	sub {	1750	sub {
1638	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1751	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1639		1752
1640	if ($ref) {	1753	if ($ref) {
1641	$self->{rbuf} = $json->incr_text;	1754	$_[0]{rbuf} = $json->incr_text;
1642	$json->incr_text = "";	1755	$json->incr_text = "";
1643	$cb->($self, $ref);	1756	$cb->($_[0], $ref);
1644		1757
1645	1	1758	1
1646	} elsif ($@) {	1759	} elsif ($@) {
1647	# error case	1760	# error case
1648	$json->incr_skip;	1761	$json->incr_skip;
1649		1762
1650	$self->{rbuf} = $json->incr_text;	1763	$_[0]{rbuf} = $json->incr_text;
1651	$json->incr_text = "";	1764	$json->incr_text = "";
1652		1765
1653	$self->_error (Errno::EBADMSG);	1766	$_[0]->_error (Errno::EBADMSG);
1654		1767
1655	()	1768	()
1656	} else {	1769	} else {
1657	$self->{rbuf} = "";	1770	$_[0]{rbuf} = "";
1658		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 {
1659	()	1818	()
1660	}	1819	}
1661	}	1820	}
1662	};	1821	};
1663		1822
…		…
1672	=cut	1831	=cut
1673		1832
1674	register_read_type storable => sub {	1833	register_read_type storable => sub {
1675	my ($self, $cb) = @_;	1834	my ($self, $cb) = @_;
1676		1835
1677	require Storable;	1836	require Storable unless $Storable::VERSION;
1678		1837
1679	sub {	1838	sub {
1680	# 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
1681	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1840	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1682	or return;	1841	or return;
…		…
1685		1844
1686	# bypass unshift if we already have the remaining chunk	1845	# bypass unshift if we already have the remaining chunk
1687	if ($format + $len <= length $_[0]{rbuf}) {	1846	if ($format + $len <= length $_[0]{rbuf}) {
1688	my $data = substr $_[0]{rbuf}, $format, $len;	1847	my $data = substr $_[0]{rbuf}, $format, $len;
1689	substr $_[0]{rbuf}, 0, $format + $len, "";	1848	substr $_[0]{rbuf}, 0, $format + $len, "";
		1849
1690	$cb->($_[0], Storable::thaw ($data));	1850	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1851	or return $_[0]->_error (Errno::EBADMSG);
1691	} else {	1852	} else {
1692	# remove prefix	1853	# remove prefix
1693	substr $_[0]{rbuf}, 0, $format, "";	1854	substr $_[0]{rbuf}, 0, $format, "";
1694		1855
1695	# read remaining chunk	1856	# read remaining chunk
1696	$_[0]->unshift_read (chunk => $len, sub {	1857	$_[0]->unshift_read (chunk => $len, sub {
1697	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1858	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1698	$cb->($_[0], $ref);
1699	} else {
1700	$self->_error (Errno::EBADMSG);	1859	or $_[0]->_error (Errno::EBADMSG);
1701	}
1702	});	1860	});
1703	}	1861	}
1704		1862
1705	1	1863	1
1706	}	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	})
1707	};	1951	};
1708		1952
1709	=back	1953	=back
1710		1954
1711	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1955	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1743	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
1744	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
1745	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
1746	there are any read requests in the queue.	1990	there are any read requests in the queue.
1747		1991
1748	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,
1749	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.
1750		2003
1751	=cut	2004	=cut
1752		2005
1753	sub stop_read {	2006	sub stop_read {
1754	my ($self) = @_;	2007	my ($self) = @_;
1755		2008
1756	delete $self->{_rw} unless $self->{tls};	2009	delete $self->{_rw};
1757	}	2010	}
1758		2011
1759	sub start_read {	2012	sub start_read {
1760	my ($self) = @_;	2013	my ($self) = @_;
1761		2014
…		…
1786	} elsif (defined $len) {	2039	} elsif (defined $len) {
1787	delete $self->{_rw};	2040	delete $self->{_rw};
1788	$self->{_eof} = 1;	2041	$self->{_eof} = 1;
1789	$self->_drain_rbuf;	2042	$self->_drain_rbuf;
1790		2043
1791	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2044	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
1792	return $self->_error ($!, 1);	2045	return $self->_error ($!, 1);
1793	}	2046	}
1794	};	2047	};
1795	}	2048	}
1796	}	2049	}
…		…
1802	my ($self, $err) = @_;	2055	my ($self, $err) = @_;
1803		2056
1804	return $self->_error ($!, 1)	2057	return $self->_error ($!, 1)
1805	if $err == Net::SSLeay::ERROR_SYSCALL ();	2058	if $err == Net::SSLeay::ERROR_SYSCALL ();
1806		2059
1807	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 ());
1808		2061
1809	# reduce error string to look less scary	2062	# reduce error string to look less scary
1810	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2063	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1811		2064
1812	if ($self->{_on_starttls}) {	2065	if ($self->{_on_starttls}) {
…		…
1826	sub _dotls {	2079	sub _dotls {
1827	my ($self) = @_;	2080	my ($self) = @_;
1828		2081
1829	my $tmp;	2082	my $tmp;
1830		2083
1831	if (length $self->{_tls_wbuf}) {	2084	while (length $self->{_tls_wbuf}) {
1832	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2085	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1833	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;
1834	}	2093	}
1835		2094
1836	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2095	substr $self->{_tls_wbuf}, 0, $tmp, "";
1837	return $self->_tls_error ($tmp)
1838	if $tmp != $ERROR_WANT_READ
1839	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1840	}	2096	}
1841		2097
1842	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2098	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1843	unless (length $tmp) {	2099	unless (length $tmp) {
1844	$self->{_on_starttls}	2100	$self->{_on_starttls}
…		…
1858	$self->{_tls_rbuf} .= $tmp;	2114	$self->{_tls_rbuf} .= $tmp;
1859	$self->_drain_rbuf;	2115	$self->_drain_rbuf;
1860	$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
1861	}	2117	}
1862		2118
1863	$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
1864	return $self->_tls_error ($tmp)	2120	return $self->_tls_error ($tmp)
1865	if $tmp != $ERROR_WANT_READ	2121	if $tmp != $ERROR_WANT_READ
1866	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2122	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1867		2123
1868	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2124	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1878		2134
1879	=item $handle->starttls ($tls[, $tls_ctx])	2135	=item $handle->starttls ($tls[, $tls_ctx])
1880		2136
1881	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2137	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1882	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
1883	C<starttls>.	2139	C<starttls>. See the C<tls> constructor argument for general info.
1884		2140
1885	Starting TLS is currently an asynchronous operation - when you push some	2141	Starting TLS is currently an asynchronous operation - when you push some
1886	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
1887	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.
1888		2146
1889	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
1890	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2148	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1891		2149
1892	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
…		…
1914	my ($self, $tls, $ctx) = @_;	2172	my ($self, $tls, $ctx) = @_;
1915		2173
1916	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"
1917	if $self->{tls};	2175	if $self->{tls};
1918		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
1919	$self->{tls} = $tls;	2185	$self->{tls} = $tls;
1920	$self->{tls_ctx} = $ctx if @_ > 2;	2186	$self->{tls_ctx} = $ctx if @_ > 2;
1921		2187
1922	return unless $self->{fh};	2188	return unless $self->{fh};
1923		2189
1924	require Net::SSLeay;
1925
1926	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2190	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1927	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2191	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1928		2192
1929	$tls = delete $self->{tls};	2193	$tls = delete $self->{tls};
1930	$ctx = $self->{tls_ctx};	2194	$ctx = $self->{tls_ctx};
1931		2195
1932	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
1933		2197
1934	if ("HASH" eq ref $ctx) {	2198	if ("HASH" eq ref $ctx) {
1935	require AnyEvent::TLS;
1936
1937	if ($ctx->{cache}) {	2199	if ($ctx->{cache}) {
1938	my $key = $ctx+0;	2200	my $key = $ctx+0;
1939	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2201	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1940	} else {	2202	} else {
1941	$ctx = new AnyEvent::TLS %$ctx;	2203	$ctx = new AnyEvent::TLS %$ctx;
…		…
1963	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2225	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1964		2226
1965	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2227	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1966	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2228	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1967		2229
1968	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2230	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2231	$self->{rbuf} = "";
1969		2232
1970	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2233	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1971		2234
1972	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2235	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1973	if $self->{on_starttls};	2236	if $self->{on_starttls};
…		…
2011	if $self->{tls} > 0;	2274	if $self->{tls} > 0;
2012		2275
2013	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2276	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
2014	}	2277	}
2015		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
2016	sub DESTROY {	2292	sub DESTROY {
2017	my ($self) = @_;	2293	my ($self) = @_;
2018		2294
2019	&_freetls;	2295	&_freetls;
2020		2296
…		…
2029	push @linger, AE::io $fh, 1, sub {	2305	push @linger, AE::io $fh, 1, sub {
2030	my $len = syswrite $fh, $wbuf, length $wbuf;	2306	my $len = syswrite $fh, $wbuf, length $wbuf;
2031		2307
2032	if ($len > 0) {	2308	if ($len > 0) {
2033	substr $wbuf, 0, $len, "";	2309	substr $wbuf, 0, $len, "";
2034	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {	2310	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) {
2035	@linger = (); # end	2311	@linger = (); # end
2036	}	2312	}
2037	};	2313	};
2038	push @linger, AE::timer $linger, 0, sub {	2314	push @linger, AE::timer $linger, 0, sub {
2039	@linger = ();	2315	@linger = ();
…		…
2142	Probably because your C<on_error> callback is being called instead: When	2418	Probably because your C<on_error> callback is being called instead: When
2143	you have outstanding requests in your read queue, then an EOF is	2419	you have outstanding requests in your read queue, then an EOF is
2144	considered an error as you clearly expected some data.	2420	considered an error as you clearly expected some data.
2145		2421
2146	To avoid this, make sure you have an empty read queue whenever your handle	2422	To avoid this, make sure you have an empty read queue whenever your handle
2147	is supposed to be "idle" (i.e. connection closes are O.K.). You cna set	2423	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
2148	an C<on_read> handler that simply pushes the first read requests in the	2424	an C<on_read> handler that simply pushes the first read requests in the
2149	queue.	2425	queue.
2150		2426
2151	See also the next question, which explains this in a bit more detail.	2427	See also the next question, which explains this in a bit more detail.
2152		2428
…		…
2160	handles requests until the server gets some QUIT command, causing it to	2436	handles requests until the server gets some QUIT command, causing it to
2161	close the connection first (highly desirable for a busy TCP server). A	2437	close the connection first (highly desirable for a busy TCP server). A
2162	client dropping the connection is an error, which means this variant can	2438	client dropping the connection is an error, which means this variant can
2163	detect an unexpected detection close.	2439	detect an unexpected detection close.
2164		2440
2165	To handle this case, always make sure you have a on-empty read queue, by	2441	To handle this case, always make sure you have a non-empty read queue, by
2166	pushing the "read request start" handler on it:	2442	pushing the "read request start" handler on it:
2167		2443
2168	# we assume a request starts with a single line	2444	# we assume a request starts with a single line
2169	my @start_request; @start_request = (line => sub {	2445	my @start_request; @start_request = (line => sub {
2170	my ($hdl, $line) = @_;	2446	my ($hdl, $line) = @_;
…		…
2183	some data and raises the C<EPIPE> error when the connction is dropped	2459	some data and raises the C<EPIPE> error when the connction is dropped
2184	unexpectedly.	2460	unexpectedly.
2185		2461
2186	The second variant is a protocol where the client can drop the connection	2462	The second variant is a protocol where the client can drop the connection
2187	at any time. For TCP, this means that the server machine may run out of	2463	at any time. For TCP, this means that the server machine may run out of
2188	sockets easier, and in general, it means you cnanot distinguish a protocl	2464	sockets easier, and in general, it means you cannot distinguish a protocl
2189	failure/client crash from a normal connection close. Nevertheless, these	2465	failure/client crash from a normal connection close. Nevertheless, these
2190	kinds of protocols are common (and sometimes even the best solution to the	2466	kinds of protocols are common (and sometimes even the best solution to the
2191	problem).	2467	problem).
2192		2468
2193	Having an outstanding read request at all times is possible if you ignore	2469	Having an outstanding read request at all times is possible if you ignore
…		…
2245	$handle->on_eof (undef);	2521	$handle->on_eof (undef);
2246	$handle->on_error (sub {	2522	$handle->on_error (sub {
2247	my $data = delete $_[0]{rbuf};	2523	my $data = delete $_[0]{rbuf};
2248	});	2524	});
2249		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
2250	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
2251	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
2252	fact all data has been received.	2532	fact all data has been received.
2253		2533
2254	It is usually better to use acknowledgements when transferring data,	2534	It is usually better to use acknowledgements when transferring data,
…		…
2264	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
2265	written to the socket:	2545	written to the socket:
2266		2546
2267	$handle->push_write (...);	2547	$handle->push_write (...);
2268	$handle->on_drain (sub {	2548	$handle->on_drain (sub {
2269	warn "all data submitted to the kernel\n";	2549	AE::log debug => "All data submitted to the kernel.";
2270	undef $handle;	2550	undef $handle;
2271	});	2551	});
2272		2552
2273	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,
2274	consider using C<< ->push_shutdown >> instead.	2554	consider using C<< ->push_shutdown >> instead.
…		…
2358	When you have intermediate CA certificates that your clients might not	2638	When you have intermediate CA certificates that your clients might not
2359	know about, just append them to the C<cert_file>.	2639	know about, just append them to the C<cert_file>.
2360		2640
2361	=back	2641	=back
2362		2642
2363
2364	=head1 SUBCLASSING AnyEvent::Handle	2643	=head1 SUBCLASSING AnyEvent::Handle
2365		2644
2366	In many cases, you might want to subclass AnyEvent::Handle.	2645	In many cases, you might want to subclass AnyEvent::Handle.
2367		2646
2368	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
…		…
2394		2673
2395	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>.
2396		2675
2397	=cut	2676	=cut
2398		2677
2399	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.208 by root, Sun Dec 5 11:41:45 2010 UTC vs. Revision 1.245 by root, Tue Jun 16 03:22:20 2015 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.208 by root, Sun Dec 5 11:41:45 2010 UTC vs.
Revision 1.245 by root, Tue Jun 16 03:22:20 2015 UTC