ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.151 by root, Thu Jul 16 04:20:23 2009 UTC vs.
Revision 1.241 by root, Fri Sep 5 22:17:26 2014 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.82;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
…		…
27		11
28	my $hdl; $hdl = new AnyEvent::Handle	12	my $hdl; $hdl = new AnyEvent::Handle
29	fh => \*STDIN,	13	fh => \*STDIN,
30	on_error => sub {	14	on_error => sub {
31	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
32	warn "got error $msg\n";	16	AE::log error => $msg;
33	$hdl->destroy;	17	$hdl->destroy;
34	$cv->send;	18	$cv->send;
35	);	19	};
36		20
37	# send some request line	21	# send some request line
38	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
39		23
40	# read the response line	24	# read the response line
41	$hdl->push_read (line => sub {	25	$hdl->push_read (line => sub {
42	my ($hdl, $line) = @_;	26	my ($hdl, $line) = @_;
43	warn "got line <$line>\n";	27	say "got line <$line>";
44	$cv->send;	28	$cv->send;
45	});	29	});
46		30
47	$cv->recv;	31	$cv->recv;
48		32
49	=head1 DESCRIPTION	33	=head1 DESCRIPTION
50		34
51	This module is a helper module to make it easier to do event-based I/O on	35	This is a helper module to make it easier to do event-based I/O on
52	filehandles. For utility functions for doing non-blocking connects and accepts	36	stream-based filehandles (sockets, pipes, and other stream things).
53	on sockets see L<AnyEvent::Util>.
54		37
55	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
56	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
57		40
58	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
59	means characters. As sysread and syswrite are used for all I/O, their	42	characters. As sysread and syswrite are used for all I/O, their
60	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
61		47
62	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
63	argument.	49	argument.
64		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
		80	sub MAX_READ_SIZE() { 131072 }
		81
65	=head1 METHODS	82	=head1 METHODS
66		83
67	=over 4	84	=over 4
68		85
69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
70		87
71	The constructor supports these arguments (all as C<< key => value >> pairs).	88	The constructor supports these arguments (all as C<< key => value >> pairs).
72		89
73	=over 4	90	=over 4
74		91
75	=item fh => $filehandle [MANDATORY]	92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
76		93
77	The filehandle this L<AnyEvent::Handle> object will operate on.	94	The filehandle this L<AnyEvent::Handle> object will operate on.
78
79	NOTE: The filehandle will be set to non-blocking mode (using	95	NOTE: The filehandle will be set to non-blocking mode (using
80	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	96	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
81	that mode.	97	that mode.
		98
		99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		100
		101	Try to connect to the specified host and service (port), using
		102	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		103	default C<peername>.
		104
		105	You have to specify either this parameter, or C<fh>, above.
		106
		107	It is possible to push requests on the read and write queues, and modify
		108	properties of the stream, even while AnyEvent::Handle is connecting.
		109
		110	When this parameter is specified, then the C<on_prepare>,
		111	C<on_connect_error> and C<on_connect> callbacks will be called under the
		112	appropriate circumstances:
		113
		114	=over 4
		115
		116	=item on_prepare => $cb->($handle)
		117
		118	This (rarely used) callback is called before a new connection is
		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
		121	file handle with parameters required for the actual connect (as opposed to
		122	settings that can be changed when the connection is already established).
		123
		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
		126	default timeout is to be used).
		127
		128	=item on_connect => $cb->($handle, $host, $port, $retry->())
		129
		130	This callback is called when a connection has been successfully established.
		131
		132	The peer's numeric host and port (the socket peername) are passed as
		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.
		136
		137	It is not allowed to use the read or write queues while the handle object
		138	is connecting.
		139
		140	If, for some reason, the handle is not acceptable, calling C<$retry> will
		141	continue with the next connection target (in case of multi-homed hosts or
		142	SRV records there can be multiple connection endpoints). The C<$retry>
		143	callback can be invoked after the connect callback returns, i.e. one can
		144	start a handshake and then decide to retry with the next host if the
		145	handshake fails.
		146
		147	In most cases, you should ignore the C<$retry> parameter.
		148
		149	=item on_connect_error => $cb->($handle, $message)
		150
		151	This callback is called when the connection could not be
		152	established. C<$!> will contain the relevant error code, and C<$message> a
		153	message describing it (usually the same as C<"$!">).
		154
		155	If this callback isn't specified, then C<on_error> will be called with a
		156	fatal error instead.
		157
		158	=back
		159
		160	=item on_error => $cb->($handle, $fatal, $message)
		161
		162	This is the error callback, which is called when, well, some error
		163	occured, such as not being able to resolve the hostname, failure to
		164	connect, or a read error.
		165
		166	Some errors are fatal (which is indicated by C<$fatal> being true). On
		167	fatal errors the handle object will be destroyed (by a call to C<< ->
		168	destroy >>) after invoking the error callback (which means you are free to
		169	examine the handle object). Examples of fatal errors are an EOF condition
		170	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
		171	cases where the other side can close the connection at will, it is
		172	often easiest to not report C<EPIPE> errors in this callback.
		173
		174	AnyEvent::Handle tries to find an appropriate error code for you to check
		175	against, but in some cases (TLS errors), this does not work well.
		176
		177	If you report the error to the user, it is recommended to always output
		178	the C<$message> argument in human-readable error messages (you don't need
		179	to report C<"$!"> if you report C<$message>).
		180
		181	If you want to react programmatically to the error, then looking at C<$!>
		182	and comparing it against some of the documented C<Errno> values is usually
		183	better than looking at the C<$message>.
		184
		185	Non-fatal errors can be retried by returning, but it is recommended
		186	to simply ignore this parameter and instead abondon the handle object
		187	when this callback is invoked. Examples of non-fatal errors are timeouts
		188	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		189
		190	On entry to the callback, the value of C<$!> contains the operating
		191	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		192	C<EPROTO>).
		193
		194	While not mandatory, it is I<highly> recommended to set this callback, as
		195	you will not be notified of errors otherwise. The default just calls
		196	C<croak>.
		197
		198	=item on_read => $cb->($handle)
		199
		200	This sets the default read callback, which is called when data arrives
		201	and no read request is in the queue (unlike read queue callbacks, this
		202	callback will only be called when at least one octet of data is in the
		203	read buffer).
		204
		205	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		206	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		207	must not enlarge or modify the read buffer, you can only remove data at
		208	the beginning from it.
		209
		210	You can also call C<< ->push_read (...) >> or any other function that
		211	modifies the read queue. Or do both. Or ...
		212
		213	When an EOF condition is detected, AnyEvent::Handle will first try to
		214	feed all the remaining data to the queued callbacks and C<on_read> before
		215	calling the C<on_eof> callback. If no progress can be made, then a fatal
		216	error will be raised (with C<$!> set to C<EPIPE>).
		217
		218	Note that, unlike requests in the read queue, an C<on_read> callback
		219	doesn't mean you I<require> some data: if there is an EOF and there
		220	are outstanding read requests then an error will be flagged. With an
		221	C<on_read> callback, the C<on_eof> callback will be invoked.
82		222
83	=item on_eof => $cb->($handle)	223	=item on_eof => $cb->($handle)
84		224
85	Set the callback to be called when an end-of-file condition is detected,	225	Set the callback to be called when an end-of-file condition is detected,
86	i.e. in the case of a socket, when the other side has closed the	226	i.e. in the case of a socket, when the other side has closed the
…		…
94	down.	234	down.
95		235
96	If an EOF condition has been detected but no C<on_eof> callback has been	236	If an EOF condition has been detected but no C<on_eof> callback has been
97	set, then a fatal error will be raised with C<$!> set to <0>.	237	set, then a fatal error will be raised with C<$!> set to <0>.
98		238
99	=item on_error => $cb->($handle, $fatal, $message)
100
101	This is the error callback, which is called when, well, some error
102	occured, such as not being able to resolve the hostname, failure to
103	connect or a read error.
104
105	Some errors are fatal (which is indicated by C<$fatal> being true). On
106	fatal errors the handle object will be destroyed (by a call to C<< ->
107	destroy >>) after invoking the error callback (which means you are free to
108	examine the handle object). Examples of fatal errors are an EOF condition
109	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
110
111	AnyEvent::Handle tries to find an appropriate error code for you to check
112	against, but in some cases (TLS errors), this does not work well. It is
113	recommended to always output the C<$message> argument in human-readable
114	error messages (it's usually the same as C<"$!">).
115
116	Non-fatal errors can be retried by simply returning, but it is recommended
117	to simply ignore this parameter and instead abondon the handle object
118	when this callback is invoked. Examples of non-fatal errors are timeouts
119	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
120
121	On callback entrance, the value of C<$!> contains the operating system
122	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
123	C<EPROTO>).
124
125	While not mandatory, it is I<highly> recommended to set this callback, as
126	you will not be notified of errors otherwise. The default simply calls
127	C<croak>.
128
129	=item on_read => $cb->($handle)
130
131	This sets the default read callback, which is called when data arrives
132	and no read request is in the queue (unlike read queue callbacks, this
133	callback will only be called when at least one octet of data is in the
134	read buffer).
135
136	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
137	method or access the C<< $handle->{rbuf} >> member directly. Note that you
138	must not enlarge or modify the read buffer, you can only remove data at
139	the beginning from it.
140
141	When an EOF condition is detected then AnyEvent::Handle will first try to
142	feed all the remaining data to the queued callbacks and C<on_read> before
143	calling the C<on_eof> callback. If no progress can be made, then a fatal
144	error will be raised (with C<$!> set to C<EPIPE>).
145
146	Note that, unlike requests in the read queue, an C<on_read> callback
147	doesn't mean you I<require> some data: if there is an EOF and there
148	are outstanding read requests then an error will be flagged. With an
149	C<on_read> callback, the C<on_eof> callback will be invoked.
150
151	=item on_drain => $cb->($handle)	239	=item on_drain => $cb->($handle)
152		240
153	This sets the callback that is called when the write buffer becomes empty	241	This sets the callback that is called once when the write buffer becomes
154	(or when the callback is set and the buffer is empty already).	242	empty (and immediately when the handle object is created).
155		243
156	To append to the write buffer, use the C<< ->push_write >> method.	244	To append to the write buffer, use the C<< ->push_write >> method.
157		245
158	This callback is useful when you don't want to put all of your write data	246	This callback is useful when you don't want to put all of your write data
159	into the queue at once, for example, when you want to write the contents	247	into the queue at once, for example, when you want to write the contents
…		…
161	memory and push it into the queue, but instead only read more data from	249	memory and push it into the queue, but instead only read more data from
162	the file when the write queue becomes empty.	250	the file when the write queue becomes empty.
163		251
164	=item timeout => $fractional_seconds	252	=item timeout => $fractional_seconds
165		253
		254	=item rtimeout => $fractional_seconds
		255
		256	=item wtimeout => $fractional_seconds
		257
166	If non-zero, then this enables an "inactivity" timeout: whenever this many	258	If non-zero, then these enables an "inactivity" timeout: whenever this
167	seconds pass without a successful read or write on the underlying file	259	many seconds pass without a successful read or write on the underlying
168	handle, the C<on_timeout> callback will be invoked (and if that one is	260	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
169	missing, a non-fatal C<ETIMEDOUT> error will be raised).	261	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		262	error will be raised).
170		263
		264	There are three variants of the timeouts that work independently of each
		265	other, for both read and write (triggered when nothing was read I<OR>
		266	written), just read (triggered when nothing was read), and just write:
		267	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		268	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		269	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
		270
171	Note that timeout processing is also active when you currently do not have	271	Note that timeout processing is active even when you do not have any
172	any outstanding read or write requests: If you plan to keep the connection	272	outstanding read or write requests: If you plan to keep the connection
173	idle then you should disable the timout temporarily or ignore the timeout	273	idle then you should disable the timeout temporarily or ignore the
174	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	274	timeout in the corresponding C<on_timeout> callback, in which case
175	restart the timeout.	275	AnyEvent::Handle will simply restart the timeout.
176		276
177	Zero (the default) disables this timeout.	277	Zero (the default) disables the corresponding timeout.
178		278
179	=item on_timeout => $cb->($handle)	279	=item on_timeout => $cb->($handle)
		280
		281	=item on_rtimeout => $cb->($handle)
		282
		283	=item on_wtimeout => $cb->($handle)
180		284
181	Called whenever the inactivity timeout passes. If you return from this	285	Called whenever the inactivity timeout passes. If you return from this
182	callback, then the timeout will be reset as if some activity had happened,	286	callback, then the timeout will be reset as if some activity had happened,
183	so this condition is not fatal in any way.	287	so this condition is not fatal in any way.
184		288
…		…
192	be configured to accept only so-and-so much data that it cannot act on	296	be configured to accept only so-and-so much data that it cannot act on
193	(for example, when expecting a line, an attacker could send an unlimited	297	(for example, when expecting a line, an attacker could send an unlimited
194	amount of data without a callback ever being called as long as the line	298	amount of data without a callback ever being called as long as the line
195	isn't finished).	299	isn't finished).
196		300
		301	=item wbuf_max => <bytes>
		302
		303	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
		304	when the write buffer ever (strictly) exceeds this size. This is useful to
		305	avoid some forms of denial-of-service attacks.
		306
		307	Although the units of this parameter is bytes, this is the I<raw> number
		308	of bytes not yet accepted by the kernel. This can make a difference when
		309	you e.g. use TLS, as TLS typically makes your write data larger (but it
		310	can also make it smaller due to compression).
		311
		312	As an example of when this limit is useful, take a chat server that sends
		313	chat messages to a client. If the client does not read those in a timely
		314	manner then the send buffer in the server would grow unbounded.
		315
197	=item autocork => <boolean>	316	=item autocork => <boolean>
198		317
199	When disabled (the default), then C<push_write> will try to immediately	318	When disabled (the default), C<push_write> will try to immediately
200	write the data to the handle, if possible. This avoids having to register	319	write the data to the handle if possible. This avoids having to register
201	a write watcher and wait for the next event loop iteration, but can	320	a write watcher and wait for the next event loop iteration, but can
202	be inefficient if you write multiple small chunks (on the wire, this	321	be inefficient if you write multiple small chunks (on the wire, this
203	disadvantage is usually avoided by your kernel's nagle algorithm, see	322	disadvantage is usually avoided by your kernel's nagle algorithm, see
204	C<no_delay>, but this option can save costly syscalls).	323	C<no_delay>, but this option can save costly syscalls).
205		324
206	When enabled, then writes will always be queued till the next event loop	325	When enabled, writes will always be queued till the next event loop
207	iteration. This is efficient when you do many small writes per iteration,	326	iteration. This is efficient when you do many small writes per iteration,
208	but less efficient when you do a single write only per iteration (or when	327	but less efficient when you do a single write only per iteration (or when
209	the write buffer often is full). It also increases write latency.	328	the write buffer often is full). It also increases write latency.
210		329
211	=item no_delay => <boolean>	330	=item no_delay => <boolean>
…		…
215	the Nagle algorithm, and usually it is beneficial.	334	the Nagle algorithm, and usually it is beneficial.
216		335
217	In some situations you want as low a delay as possible, which can be	336	In some situations you want as low a delay as possible, which can be
218	accomplishd by setting this option to a true value.	337	accomplishd by setting this option to a true value.
219		338
220	The default is your opertaing system's default behaviour (most likely	339	The default is your operating system's default behaviour (most likely
221	enabled), this option explicitly enables or disables it, if possible.	340	enabled). This option explicitly enables or disables it, if possible.
		341
		342	=item keepalive => <boolean>
		343
		344	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		345	normally, TCP connections have no time-out once established, so TCP
		346	connections, once established, can stay alive forever even when the other
		347	side has long gone. TCP keepalives are a cheap way to take down long-lived
		348	TCP connections when the other side becomes unreachable. While the default
		349	is OS-dependent, TCP keepalives usually kick in after around two hours,
		350	and, if the other side doesn't reply, take down the TCP connection some 10
		351	to 15 minutes later.
		352
		353	It is harmless to specify this option for file handles that do not support
		354	keepalives, and enabling it on connections that are potentially long-lived
		355	is usually a good idea.
		356
		357	=item oobinline => <boolean>
		358
		359	BSD majorly fucked up the implementation of TCP urgent data. The result
		360	is that almost no OS implements TCP according to the specs, and every OS
		361	implements it slightly differently.
		362
		363	If you want to handle TCP urgent data, then setting this flag (the default
		364	is enabled) gives you the most portable way of getting urgent data, by
		365	putting it into the stream.
		366
		367	Since BSD emulation of OOB data on top of TCP's urgent data can have
		368	security implications, AnyEvent::Handle sets this flag automatically
		369	unless explicitly specified. Note that setting this flag after
		370	establishing a connection I<may> be a bit too late (data loss could
		371	already have occured on BSD systems), but at least it will protect you
		372	from most attacks.
222		373
223	=item read_size => <bytes>	374	=item read_size => <bytes>
224		375
225	The default read block size (the amount of bytes this module will	376	The initial read block size, the number of bytes this module will try
226	try to read during each loop iteration, which affects memory	377	to read during each loop iteration. Each handle object will consume
227	requirements). Default: C<8192>.	378	at least this amount of memory for the read buffer as well, so when
		379	handling many connections watch out for memory requirements). See also
		380	C<max_read_size>. Default: C<2048>.
		381
		382	=item max_read_size => <bytes>
		383
		384	The maximum read buffer size used by the dynamic adjustment
		385	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
		386	one go it will double C<read_size> up to the maximum given by this
		387	option. Default: C<131072> or C<read_size>, whichever is higher.
228		388
229	=item low_water_mark => <bytes>	389	=item low_water_mark => <bytes>
230		390
231	Sets the amount of bytes (default: C<0>) that make up an "empty" write	391	Sets the number of bytes (default: C<0>) that make up an "empty" write
232	buffer: If the write reaches this size or gets even samller it is	392	buffer: If the buffer reaches this size or gets even samller it is
233	considered empty.	393	considered empty.
234		394
235	Sometimes it can be beneficial (for performance reasons) to add data to	395	Sometimes it can be beneficial (for performance reasons) to add data to
236	the write buffer before it is fully drained, but this is a rare case, as	396	the write buffer before it is fully drained, but this is a rare case, as
237	the operating system kernel usually buffers data as well, so the default	397	the operating system kernel usually buffers data as well, so the default
238	is good in almost all cases.	398	is good in almost all cases.
239		399
240	=item linger => <seconds>	400	=item linger => <seconds>
241		401
242	If non-zero (default: C<3600>), then the destructor of the	402	If this is non-zero (default: C<3600>), the destructor of the
243	AnyEvent::Handle object will check whether there is still outstanding	403	AnyEvent::Handle object will check whether there is still outstanding
244	write data and will install a watcher that will write this data to the	404	write data and will install a watcher that will write this data to the
245	socket. No errors will be reported (this mostly matches how the operating	405	socket. No errors will be reported (this mostly matches how the operating
246	system treats outstanding data at socket close time).	406	system treats outstanding data at socket close time).
247		407
…		…
254	A string used to identify the remote site - usually the DNS hostname	414	A string used to identify the remote site - usually the DNS hostname
255	(I<not> IDN!) used to create the connection, rarely the IP address.	415	(I<not> IDN!) used to create the connection, rarely the IP address.
256		416
257	Apart from being useful in error messages, this string is also used in TLS	417	Apart from being useful in error messages, this string is also used in TLS
258	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	418	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
259	verification will be skipped when C<peername> is not specified or	419	verification will be skipped when C<peername> is not specified or is
260	C<undef>.	420	C<undef>.
261		421
262	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	422	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
263		423
264	When this parameter is given, it enables TLS (SSL) mode, that means	424	When this parameter is given, it enables TLS (SSL) mode, that means
265	AnyEvent will start a TLS handshake as soon as the conenction has been	425	AnyEvent will start a TLS handshake as soon as the connection has been
266	established and will transparently encrypt/decrypt data afterwards.	426	established and will transparently encrypt/decrypt data afterwards.
267		427
268	All TLS protocol errors will be signalled as C<EPROTO>, with an	428	All TLS protocol errors will be signalled as C<EPROTO>, with an
269	appropriate error message.	429	appropriate error message.
270		430
271	TLS mode requires Net::SSLeay to be installed (it will be loaded	431	TLS mode requires Net::SSLeay to be installed (it will be loaded
272	automatically when you try to create a TLS handle): this module doesn't	432	automatically when you try to create a TLS handle): this module doesn't
273	have a dependency on that module, so if your module requires it, you have	433	have a dependency on that module, so if your module requires it, you have
274	to add the dependency yourself.	434	to add the dependency yourself. If Net::SSLeay cannot be loaded or is too
		435	old, you get an C<EPROTO> error.
275		436
276	Unlike TCP, TLS has a server and client side: for the TLS server side, use	437	Unlike TCP, TLS has a server and client side: for the TLS server side, use
277	C<accept>, and for the TLS client side of a connection, use C<connect>	438	C<accept>, and for the TLS client side of a connection, use C<connect>
278	mode.	439	mode.
279		440
…		…
290	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	451	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
291	passing in the wrong integer will lead to certain crash. This most often	452	passing in the wrong integer will lead to certain crash. This most often
292	happens when one uses a stylish C<< tls => 1 >> and is surprised about the	453	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
293	segmentation fault.	454	segmentation fault.
294		455
295	See the C<< ->starttls >> method for when need to start TLS negotiation later.	456	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
296		457
297	=item tls_ctx => $anyevent_tls	458	=item tls_ctx => $anyevent_tls
298		459
299	Use the given C<AnyEvent::TLS> object to create the new TLS connection	460	Use the given C<AnyEvent::TLS> object to create the new TLS connection
300	(unless a connection object was specified directly). If this parameter is	461	(unless a connection object was specified directly). If this
301	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	462	parameter is missing (or C<undef>), then AnyEvent::Handle will use
		463	C<AnyEvent::Handle::TLS_CTX>.
302		464
303	Instead of an object, you can also specify a hash reference with C<< key	465	Instead of an object, you can also specify a hash reference with C<< key
304	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	466	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
305	new TLS context object.	467	new TLS context object.
306		468
…		…
315		477
316	TLS handshake failures will not cause C<on_error> to be invoked when this	478	TLS handshake failures will not cause C<on_error> to be invoked when this
317	callback is in effect, instead, the error message will be passed to C<on_starttls>.	479	callback is in effect, instead, the error message will be passed to C<on_starttls>.
318		480
319	Without this callback, handshake failures lead to C<on_error> being	481	Without this callback, handshake failures lead to C<on_error> being
320	called, as normal.	482	called as usual.
321		483
322	Note that you cannot call C<starttls> right again in this callback. If you	484	Note that you cannot just call C<starttls> again in this callback. If you
323	need to do that, start an zero-second timer instead whose callback can	485	need to do that, start an zero-second timer instead whose callback can
324	then call C<< ->starttls >> again.	486	then call C<< ->starttls >> again.
325		487
326	=item on_stoptls => $cb->($handle)	488	=item on_stoptls => $cb->($handle)
327		489
…		…
334	callback.	496	callback.
335		497
336	This callback will only be called on TLS shutdowns, not when the	498	This callback will only be called on TLS shutdowns, not when the
337	underlying handle signals EOF.	499	underlying handle signals EOF.
338		500
339	=item json => JSON or JSON::XS object	501	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
340		502
341	This is the json coder object used by the C<json> read and write types.	503	This is the json coder object used by the C<json> read and write types.
342		504
343	If you don't supply it, then AnyEvent::Handle will create and use a	505	If you don't supply it, then AnyEvent::Handle will create and use a
344	suitable one (on demand), which will write and expect UTF-8 encoded JSON	506	suitable one (on demand), which will write and expect UTF-8 encoded
		507	JSON texts (either using L<JSON::XS> or L<JSON>). The written texts are
		508	guaranteed not to contain any newline character.
		509
		510	For security reasons, this encoder will likely I<not> handle numbers and
		511	strings, only arrays and objects/hashes. The reason is that originally
		512	JSON was self-delimited, but Dougles Crockford thought it was a splendid
		513	idea to redefine JSON incompatibly, so this is no longer true.
		514
		515	For protocols that used back-to-back JSON texts, this might lead to
		516	run-ins, where two or more JSON texts will be interpreted as one JSON
345	texts.	517	text.
346		518
		519	For this reason, if the default encoder uses L<JSON::XS>, it will default
		520	to not allowing anything but arrays and objects/hashes, at least for the
		521	forseeable future (it will change at some point). This might or might not
		522	be true for the L<JSON> module, so this might cause a security issue.
		523
		524	If you depend on either behaviour, you should create your own json object
		525	and pass it in explicitly.
		526
		527	=item cbor => L<CBOR::XS> object
		528
		529	This is the cbor coder object used by the C<cbor> read and write types.
		530
		531	If you don't supply it, then AnyEvent::Handle will create and use a
		532	suitable one (on demand), which will write CBOR without using extensions,
		533	if possible.
		534
347	Note that you are responsible to depend on the JSON module if you want to	535	Note that you are responsible to depend on the L<CBOR::XS> module if you
348	use this functionality, as AnyEvent does not have a dependency itself.	536	want to use this functionality, as AnyEvent does not have a dependency on
		537	it itself.
349		538
350	=back	539	=back
351		540
352	=cut	541	=cut
353		542
354	sub new {	543	sub new {
355	my $class = shift;	544	my $class = shift;
356	my $self = bless { @_ }, $class;	545	my $self = bless { @_ }, $class;
357		546
358	$self->{fh} or Carp::croak "mandatory argument fh is missing";	547	if ($self->{fh}) {
		548	$self->_start;
		549	return unless $self->{fh}; # could be gone by now
		550
		551	} elsif ($self->{connect}) {
		552	require AnyEvent::Socket;
		553
		554	$self->{peername} = $self->{connect}[0]
		555	unless exists $self->{peername};
		556
		557	$self->{_skip_drain_rbuf} = 1;
		558
		559	{
		560	Scalar::Util::weaken (my $self = $self);
		561
		562	$self->{_connect} =
		563	AnyEvent::Socket::tcp_connect (
		564	$self->{connect}[0],
		565	$self->{connect}[1],
		566	sub {
		567	my ($fh, $host, $port, $retry) = @_;
		568
		569	delete $self->{_connect}; # no longer needed
		570
		571	if ($fh) {
		572	$self->{fh} = $fh;
		573
		574	delete $self->{_skip_drain_rbuf};
		575	$self->_start;
		576
		577	$self->{on_connect}
		578	and $self->{on_connect}($self, $host, $port, sub {
		579	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		580	$self->{_skip_drain_rbuf} = 1;
		581	&$retry;
		582	});
		583
		584	} else {
		585	if ($self->{on_connect_error}) {
		586	$self->{on_connect_error}($self, "$!");
		587	$self->destroy if $self;
		588	} else {
		589	$self->_error ($!, 1);
		590	}
		591	}
		592	},
		593	sub {
		594	local $self->{fh} = $_[0];
		595
		596	$self->{on_prepare}
		597	? $self->{on_prepare}->($self)
		598	: ()
		599	}
		600	);
		601	}
		602
		603	} else {
		604	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		605	}
		606
		607	$self
		608	}
		609
		610	sub _start {
		611	my ($self) = @_;
		612
		613	# too many clueless people try to use udp and similar sockets
		614	# with AnyEvent::Handle, do them a favour.
		615	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		616	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		617	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
359		618
360	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	619	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
361		620
		621	$self->{_activity} =
		622	$self->{_ractivity} =
362	$self->{_activity} = AnyEvent->now;	623	$self->{_wactivity} = AE::now;
363	$self->_timeout;
364		624
		625	$self->{read_size} ||= 2048;
		626	$self->{max_read_size} = $self->{read_size}
		627	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		628
		629	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		630	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		631	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		632
365	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	633	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		634	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
366		635
		636	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		637
367	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	638	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
368	if $self->{tls};	639	if $self->{tls};
369		640
370	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	641	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
371		642
372	$self->start_read	643	$self->start_read
373	if $self->{on_read};	644	if $self->{on_read} || @{ $self->{_queue} };
374		645
375	$self->{fh} && $self	646	$self->_drain_wbuf;
376	}	647	}
377
378	#sub _shutdown {
379	# my ($self) = @_;
380	#
381	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
382	# $self->{_eof} = 1; # tell starttls et. al to stop trying
383	#
384	# &_freetls;
385	#}
386		648
387	sub _error {	649	sub _error {
388	my ($self, $errno, $fatal, $message) = @_;	650	my ($self, $errno, $fatal, $message) = @_;
389		651
390	$! = $errno;	652	$! = $errno;
391	$message ||= "$!";	653	$message ||= "$!";
392		654
393	if ($self->{on_error}) {	655	if ($self->{on_error}) {
394	$self->{on_error}($self, $fatal, $message);	656	$self->{on_error}($self, $fatal, $message);
395	$self->destroy if $fatal;	657	$self->destroy if $fatal;
396	} elsif ($self->{fh}) {	658	} elsif ($self->{fh} || $self->{connect}) {
397	$self->destroy;	659	$self->destroy;
398	Carp::croak "AnyEvent::Handle uncaught error: $message";	660	Carp::croak "AnyEvent::Handle uncaught error: $message";
399	}	661	}
400	}	662	}
401		663
…		…
427	$_[0]{on_eof} = $_[1];	689	$_[0]{on_eof} = $_[1];
428	}	690	}
429		691
430	=item $handle->on_timeout ($cb)	692	=item $handle->on_timeout ($cb)
431		693
432	Replace the current C<on_timeout> callback, or disables the callback (but	694	=item $handle->on_rtimeout ($cb)
433	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
434	argument and method.
435		695
436	=cut	696	=item $handle->on_wtimeout ($cb)
437		697
438	sub on_timeout {	698	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
439	$_[0]{on_timeout} = $_[1];	699	callback, or disables the callback (but not the timeout) if C<$cb> =
440	}	700	C<undef>. See the C<timeout> constructor argument and method.
		701
		702	=cut
		703
		704	# see below
441		705
442	=item $handle->autocork ($boolean)	706	=item $handle->autocork ($boolean)
443		707
444	Enables or disables the current autocork behaviour (see C<autocork>	708	Enables or disables the current autocork behaviour (see C<autocork>
445	constructor argument). Changes will only take effect on the next write.	709	constructor argument). Changes will only take effect on the next write.
…		…
458	=cut	722	=cut
459		723
460	sub no_delay {	724	sub no_delay {
461	$_[0]{no_delay} = $_[1];	725	$_[0]{no_delay} = $_[1];
462		726
		727	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		728	if $_[0]{fh};
		729	}
		730
		731	=item $handle->keepalive ($boolean)
		732
		733	Enables or disables the C<keepalive> setting (see constructor argument of
		734	the same name for details).
		735
		736	=cut
		737
		738	sub keepalive {
		739	$_[0]{keepalive} = $_[1];
		740
463	eval {	741	eval {
464	local $SIG{__DIE__};	742	local $SIG{__DIE__};
465	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	743	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		744	if $_[0]{fh};
		745	};
		746	}
		747
		748	=item $handle->oobinline ($boolean)
		749
		750	Enables or disables the C<oobinline> setting (see constructor argument of
		751	the same name for details).
		752
		753	=cut
		754
		755	sub oobinline {
		756	$_[0]{oobinline} = $_[1];
		757
		758	eval {
		759	local $SIG{__DIE__};
		760	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		761	if $_[0]{fh};
		762	};
		763	}
		764
		765	=item $handle->keepalive ($boolean)
		766
		767	Enables or disables the C<keepalive> setting (see constructor argument of
		768	the same name for details).
		769
		770	=cut
		771
		772	sub keepalive {
		773	$_[0]{keepalive} = $_[1];
		774
		775	eval {
		776	local $SIG{__DIE__};
		777	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		778	if $_[0]{fh};
466	};	779	};
467	}	780	}
468		781
469	=item $handle->on_starttls ($cb)	782	=item $handle->on_starttls ($cb)
470		783
…		…
480		793
481	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	794	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
482		795
483	=cut	796	=cut
484		797
485	sub on_starttls {	798	sub on_stoptls {
486	$_[0]{on_stoptls} = $_[1];	799	$_[0]{on_stoptls} = $_[1];
487	}	800	}
488		801
		802	=item $handle->rbuf_max ($max_octets)
		803
		804	Configures the C<rbuf_max> setting (C<undef> disables it).
		805
		806	=item $handle->wbuf_max ($max_octets)
		807
		808	Configures the C<wbuf_max> setting (C<undef> disables it).
		809
		810	=cut
		811
		812	sub rbuf_max {
		813	$_[0]{rbuf_max} = $_[1];
		814	}
		815
		816	sub wbuf_max {
		817	$_[0]{wbuf_max} = $_[1];
		818	}
		819
489	#############################################################################	820	#############################################################################
490		821
491	=item $handle->timeout ($seconds)	822	=item $handle->timeout ($seconds)
492		823
		824	=item $handle->rtimeout ($seconds)
		825
		826	=item $handle->wtimeout ($seconds)
		827
493	Configures (or disables) the inactivity timeout.	828	Configures (or disables) the inactivity timeout.
494		829
495	=cut	830	The timeout will be checked instantly, so this method might destroy the
		831	handle before it returns.
496		832
497	sub timeout {	833	=item $handle->timeout_reset
		834
		835	=item $handle->rtimeout_reset
		836
		837	=item $handle->wtimeout_reset
		838
		839	Reset the activity timeout, as if data was received or sent.
		840
		841	These methods are cheap to call.
		842
		843	=cut
		844
		845	for my $dir ("", "r", "w") {
		846	my $timeout = "${dir}timeout";
		847	my $tw = "_${dir}tw";
		848	my $on_timeout = "on_${dir}timeout";
		849	my $activity = "_${dir}activity";
		850	my $cb;
		851
		852	*$on_timeout = sub {
		853	$_[0]{$on_timeout} = $_[1];
		854	};
		855
		856	*$timeout = sub {
498	my ($self, $timeout) = @_;	857	my ($self, $new_value) = @_;
499		858
		859	$new_value >= 0
		860	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		861
500	$self->{timeout} = $timeout;	862	$self->{$timeout} = $new_value;
501	$self->_timeout;	863	delete $self->{$tw}; &$cb;
502	}	864	};
503		865
		866	*{"${dir}timeout_reset"} = sub {
		867	$_[0]{$activity} = AE::now;
		868	};
		869
		870	# main workhorse:
504	# reset the timeout watcher, as neccessary	871	# reset the timeout watcher, as neccessary
505	# also check for time-outs	872	# also check for time-outs
506	sub _timeout {	873	$cb = sub {
507	my ($self) = @_;	874	my ($self) = @_;
508		875
509	if ($self->{timeout}) {	876	if ($self->{$timeout} && $self->{fh}) {
510	my $NOW = AnyEvent->now;	877	my $NOW = AE::now;
511		878
512	# when would the timeout trigger?	879	# when would the timeout trigger?
513	my $after = $self->{_activity} + $self->{timeout} - $NOW;	880	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
514		881
515	# now or in the past already?	882	# now or in the past already?
516	if ($after <= 0) {	883	if ($after <= 0) {
517	$self->{_activity} = $NOW;	884	$self->{$activity} = $NOW;
518		885
519	if ($self->{on_timeout}) {	886	if ($self->{$on_timeout}) {
520	$self->{on_timeout}($self);	887	$self->{$on_timeout}($self);
521	} else {	888	} else {
522	$self->_error (Errno::ETIMEDOUT);	889	$self->_error (Errno::ETIMEDOUT);
		890	}
		891
		892	# callback could have changed timeout value, optimise
		893	return unless $self->{$timeout};
		894
		895	# calculate new after
		896	$after = $self->{$timeout};
523	}	897	}
524		898
525	# callback could have changed timeout value, optimise	899	Scalar::Util::weaken $self;
526	return unless $self->{timeout};	900	return unless $self; # ->error could have destroyed $self
527		901
528	# calculate new after	902	$self->{$tw} ||= AE::timer $after, 0, sub {
529	$after = $self->{timeout};	903	delete $self->{$tw};
		904	$cb->($self);
		905	};
		906	} else {
		907	delete $self->{$tw};
530	}	908	}
531
532	Scalar::Util::weaken $self;
533	return unless $self; # ->error could have destroyed $self
534
535	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
536	delete $self->{_tw};
537	$self->_timeout;
538	});
539	} else {
540	delete $self->{_tw};
541	}	909	}
542	}	910	}
543		911
544	#############################################################################	912	#############################################################################
545		913
…		…
552		920
553	The write queue is very simple: you can add data to its end, and	921	The write queue is very simple: you can add data to its end, and
554	AnyEvent::Handle will automatically try to get rid of it for you.	922	AnyEvent::Handle will automatically try to get rid of it for you.
555		923
556	When data could be written and the write buffer is shorter then the low	924	When data could be written and the write buffer is shorter then the low
557	water mark, the C<on_drain> callback will be invoked.	925	water mark, the C<on_drain> callback will be invoked once.
558		926
559	=over 4	927	=over 4
560		928
561	=item $handle->on_drain ($cb)	929	=item $handle->on_drain ($cb)
562		930
563	Sets the C<on_drain> callback or clears it (see the description of	931	Sets the C<on_drain> callback or clears it (see the description of
564	C<on_drain> in the constructor).	932	C<on_drain> in the constructor).
565		933
		934	This method may invoke callbacks (and therefore the handle might be
		935	destroyed after it returns).
		936
566	=cut	937	=cut
567		938
568	sub on_drain {	939	sub on_drain {
569	my ($self, $cb) = @_;	940	my ($self, $cb) = @_;
570		941
…		…
574	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});	945	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
575	}	946	}
576		947
577	=item $handle->push_write ($data)	948	=item $handle->push_write ($data)
578		949
579	Queues the given scalar to be written. You can push as much data as you	950	Queues the given scalar to be written. You can push as much data as
580	want (only limited by the available memory), as C<AnyEvent::Handle>	951	you want (only limited by the available memory and C<wbuf_max>), as
581	buffers it independently of the kernel.	952	C<AnyEvent::Handle> buffers it independently of the kernel.
		953
		954	This method may invoke callbacks (and therefore the handle might be
		955	destroyed after it returns).
582		956
583	=cut	957	=cut
584		958
585	sub _drain_wbuf {	959	sub _drain_wbuf {
586	my ($self) = @_;	960	my ($self) = @_;
…		…
593	my $len = syswrite $self->{fh}, $self->{wbuf};	967	my $len = syswrite $self->{fh}, $self->{wbuf};
594		968
595	if (defined $len) {	969	if (defined $len) {
596	substr $self->{wbuf}, 0, $len, "";	970	substr $self->{wbuf}, 0, $len, "";
597		971
598	$self->{_activity} = AnyEvent->now;	972	$self->{_activity} = $self->{_wactivity} = AE::now;
599		973
600	$self->{on_drain}($self)	974	$self->{on_drain}($self)
601	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	975	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
602	&& $self->{on_drain};	976	&& $self->{on_drain};
603		977
…		…
609		983
610	# try to write data immediately	984	# try to write data immediately
611	$cb->() unless $self->{autocork};	985	$cb->() unless $self->{autocork};
612		986
613	# if still data left in wbuf, we need to poll	987	# if still data left in wbuf, we need to poll
614	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	988	$self->{_ww} = AE::io $self->{fh}, 1, $cb
615	if length $self->{wbuf};	989	if length $self->{wbuf};
		990
		991	if (
		992	defined $self->{wbuf_max}
		993	&& $self->{wbuf_max} < length $self->{wbuf}
		994	) {
		995	$self->_error (Errno::ENOSPC, 1), return;
		996	}
616	};	997	};
617	}	998	}
618		999
619	our %WH;	1000	our %WH;
620		1001
		1002	# deprecated
621	sub register_write_type($$) {	1003	sub register_write_type($$) {
622	$WH{$_[0]} = $_[1];	1004	$WH{$_[0]} = $_[1];
623	}	1005	}
624		1006
625	sub push_write {	1007	sub push_write {
626	my $self = shift;	1008	my $self = shift;
627		1009
628	if (@_ > 1) {	1010	if (@_ > 1) {
629	my $type = shift;	1011	my $type = shift;
630		1012
		1013	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
631	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	1014	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
632	->($self, @_);	1015	->($self, @_);
633	}	1016	}
634		1017
		1018	# we downgrade here to avoid hard-to-track-down bugs,
		1019	# and diagnose the problem earlier and better.
		1020
635	if ($self->{tls}) {	1021	if ($self->{tls}) {
636	$self->{_tls_wbuf} .= $_[0];	1022	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
637		1023	&_dotls ($self) if $self->{fh};
638	&_dotls ($self);
639	} else {	1024	} else {
640	$self->{wbuf} .= $_[0];	1025	utf8::downgrade $self->{wbuf} .= $_[0];
641	$self->_drain_wbuf;	1026	$self->_drain_wbuf if $self->{fh};
642	}	1027	}
643	}	1028	}
644		1029
645	=item $handle->push_write (type => @args)	1030	=item $handle->push_write (type => @args)
646		1031
647	Instead of formatting your data yourself, you can also let this module do	1032	Instead of formatting your data yourself, you can also let this module
648	the job by specifying a type and type-specific arguments.	1033	do the job by specifying a type and type-specific arguments. You
		1034	can also specify the (fully qualified) name of a package, in which
		1035	case AnyEvent tries to load the package and then expects to find the
		1036	C<anyevent_write_type> function inside (see "custom write types", below).
649		1037
650	Predefined types are (if you have ideas for additional types, feel free to	1038	Predefined types are (if you have ideas for additional types, feel free to
651	drop by and tell us):	1039	drop by and tell us):
652		1040
653	=over 4	1041	=over 4
…		…
684		1072
685	Encodes the given hash or array reference into a JSON object. Unless you	1073	Encodes the given hash or array reference into a JSON object. Unless you
686	provide your own JSON object, this means it will be encoded to JSON text	1074	provide your own JSON object, this means it will be encoded to JSON text
687	in UTF-8.	1075	in UTF-8.
688		1076
		1077	The default encoder might or might not handle every type of JSON value -
		1078	it might be limited to arrays and objects for security reasons. See the
		1079	C<json> constructor attribute for more details.
		1080
689	JSON objects (and arrays) are self-delimiting, so you can write JSON at	1081	JSON objects (and arrays) are self-delimiting, so if you only use arrays
690	one end of a handle and read them at the other end without using any	1082	and hashes, you can write JSON at one end of a handle and read them at the
691	additional framing.	1083	other end without using any additional framing.
692		1084
693	The generated JSON text is guaranteed not to contain any newlines: While	1085	The JSON text generated by the default encoder is guaranteed not to
694	this module doesn't need delimiters after or between JSON texts to be	1086	contain any newlines: While this module doesn't need delimiters after or
695	able to read them, many other languages depend on that.	1087	between JSON texts to be able to read them, many other languages depend on
		1088	them.
696		1089
697	A simple RPC protocol that interoperates easily with others is to send	1090	A simple RPC protocol that interoperates easily with other languages is
698	JSON arrays (or objects, although arrays are usually the better choice as	1091	to send JSON arrays (or objects, although arrays are usually the better
699	they mimic how function argument passing works) and a newline after each	1092	choice as they mimic how function argument passing works) and a newline
700	JSON text:	1093	after each JSON text:
701		1094
702	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1095	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
703	$handle->push_write ("\012");	1096	$handle->push_write ("\012");
704		1097
705	An AnyEvent::Handle receiver would simply use the C<json> read type and	1098	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
708	$handle->push_read (json => sub { my $array = $_[1]; ... });	1101	$handle->push_read (json => sub { my $array = $_[1]; ... });
709		1102
710	Other languages could read single lines terminated by a newline and pass	1103	Other languages could read single lines terminated by a newline and pass
711	this line into their JSON decoder of choice.	1104	this line into their JSON decoder of choice.
712		1105
		1106	=item cbor => $perl_scalar
		1107
		1108	Encodes the given scalar into a CBOR value. Unless you provide your own
		1109	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1110	using any extensions, if possible.
		1111
		1112	CBOR values are self-delimiting, so you can write CBOR at one end of
		1113	a handle and read them at the other end without using any additional
		1114	framing.
		1115
		1116	A simple nd very very fast RPC protocol that interoperates with
		1117	other languages is to send CBOR and receive CBOR values (arrays are
		1118	recommended):
		1119
		1120	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1121
		1122	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1123
		1124	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1125
713	=cut	1126	=cut
		1127
		1128	sub json_coder() {
		1129	eval { require JSON::XS; JSON::XS->new->utf8 }
		1130	|| do { require JSON::PP; JSON::PP->new->utf8 }
		1131	}
714		1132
715	register_write_type json => sub {	1133	register_write_type json => sub {
716	my ($self, $ref) = @_;	1134	my ($self, $ref) = @_;
717		1135
718	require JSON;	1136	($self->{json} ||= json_coder)
		1137	->encode ($ref)
		1138	};
719		1139
720	$self->{json} ? $self->{json}->encode ($ref)	1140	sub cbor_coder() {
721	: JSON::encode_json ($ref)	1141	require CBOR::XS;
		1142	CBOR::XS->new
		1143	}
		1144
		1145	register_write_type cbor => sub {
		1146	my ($self, $scalar) = @_;
		1147
		1148	($self->{cbor} ||= cbor_coder)
		1149	->encode ($scalar)
722	};	1150	};
723		1151
724	=item storable => $reference	1152	=item storable => $reference
725		1153
726	Freezes the given reference using L<Storable> and writes it to the	1154	Freezes the given reference using L<Storable> and writes it to the
…		…
729	=cut	1157	=cut
730		1158
731	register_write_type storable => sub {	1159	register_write_type storable => sub {
732	my ($self, $ref) = @_;	1160	my ($self, $ref) = @_;
733		1161
734	require Storable;	1162	require Storable unless $Storable::VERSION;
735		1163
736	pack "w/a*", Storable::nfreeze ($ref)	1164	pack "w/a*", Storable::nfreeze ($ref)
737	};	1165	};
738		1166
739	=back	1167	=back
…		…
744	before it was actually written. One way to do that is to replace your	1172	before it was actually written. One way to do that is to replace your
745	C<on_drain> handler by a callback that shuts down the socket (and set	1173	C<on_drain> handler by a callback that shuts down the socket (and set
746	C<low_water_mark> to C<0>). This method is a shorthand for just that, and	1174	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
747	replaces the C<on_drain> callback with:	1175	replaces the C<on_drain> callback with:
748		1176
749	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1177	sub { shutdown $_[0]{fh}, 1 }
750		1178
751	This simply shuts down the write side and signals an EOF condition to the	1179	This simply shuts down the write side and signals an EOF condition to the
752	the peer.	1180	the peer.
753		1181
754	You can rely on the normal read queue and C<on_eof> handling	1182	You can rely on the normal read queue and C<on_eof> handling
755	afterwards. This is the cleanest way to close a connection.	1183	afterwards. This is the cleanest way to close a connection.
756		1184
		1185	This method may invoke callbacks (and therefore the handle might be
		1186	destroyed after it returns).
		1187
757	=cut	1188	=cut
758		1189
759	sub push_shutdown {	1190	sub push_shutdown {
760	my ($self) = @_;	1191	my ($self) = @_;
761		1192
762	delete $self->{low_water_mark};	1193	delete $self->{low_water_mark};
763	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1194	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
764	}	1195	}
765		1196
766	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1197	=item custom write types - Package::anyevent_write_type $handle, @args
767		1198
768	This function (not method) lets you add your own types to C<push_write>.	1199	Instead of one of the predefined types, you can also specify the name of
		1200	a package. AnyEvent will try to load the package and then expects to find
		1201	a function named C<anyevent_write_type> inside. If it isn't found, it
		1202	progressively tries to load the parent package until it either finds the
		1203	function (good) or runs out of packages (bad).
		1204
769	Whenever the given C<type> is used, C<push_write> will invoke the code	1205	Whenever the given C<type> is used, C<push_write> will the function with
770	reference with the handle object and the remaining arguments.	1206	the handle object and the remaining arguments.
771		1207
772	The code reference is supposed to return a single octet string that will	1208	The function is supposed to return a single octet string that will be
773	be appended to the write buffer.	1209	appended to the write buffer, so you can mentally treat this function as a
		1210	"arguments to on-the-wire-format" converter.
774		1211
775	Note that this is a function, and all types registered this way will be	1212	Example: implement a custom write type C<join> that joins the remaining
776	global, so try to use unique names.	1213	arguments using the first one.
		1214
		1215	$handle->push_write (My::Type => " ", 1,2,3);
		1216
		1217	# uses the following package, which can be defined in the "My::Type" or in
		1218	# the "My" modules to be auto-loaded, or just about anywhere when the
		1219	# My::Type::anyevent_write_type is defined before invoking it.
		1220
		1221	package My::Type;
		1222
		1223	sub anyevent_write_type {
		1224	my ($handle, $delim, @args) = @_;
		1225
		1226	join $delim, @args
		1227	}
777		1228
778	=cut	1229	=cut
779		1230
780	#############################################################################	1231	#############################################################################
781		1232
…		…
790	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1241	ways, the "simple" way, using only C<on_read> and the "complex" way, using
791	a queue.	1242	a queue.
792		1243
793	In the simple case, you just install an C<on_read> callback and whenever	1244	In the simple case, you just install an C<on_read> callback and whenever
794	new data arrives, it will be called. You can then remove some data (if	1245	new data arrives, it will be called. You can then remove some data (if
795	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1246	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
796	leave the data there if you want to accumulate more (e.g. when only a	1247	leave the data there if you want to accumulate more (e.g. when only a
797	partial message has been received so far).	1248	partial message has been received so far), or change the read queue with
		1249	e.g. C<push_read>.
798		1250
799	In the more complex case, you want to queue multiple callbacks. In this	1251	In the more complex case, you want to queue multiple callbacks. In this
800	case, AnyEvent::Handle will call the first queued callback each time new	1252	case, AnyEvent::Handle will call the first queued callback each time new
801	data arrives (also the first time it is queued) and removes it when it has	1253	data arrives (also the first time it is queued) and remove it when it has
802	done its job (see C<push_read>, below).	1254	done its job (see C<push_read>, below).
803		1255
804	This way you can, for example, push three line-reads, followed by reading	1256	This way you can, for example, push three line-reads, followed by reading
805	a chunk of data, and AnyEvent::Handle will execute them in order.	1257	a chunk of data, and AnyEvent::Handle will execute them in order.
806		1258
…		…
863	=cut	1315	=cut
864		1316
865	sub _drain_rbuf {	1317	sub _drain_rbuf {
866	my ($self) = @_;	1318	my ($self) = @_;
867		1319
		1320	# avoid recursion
		1321	return if $self->{_skip_drain_rbuf};
868	local $self->{_in_drain} = 1;	1322	local $self->{_skip_drain_rbuf} = 1;
869
870	if (
871	defined $self->{rbuf_max}
872	&& $self->{rbuf_max} < length $self->{rbuf}
873	) {
874	$self->_error (Errno::ENOSPC, 1), return;
875	}
876		1323
877	while () {	1324	while () {
878	# we need to use a separate tls read buffer, as we must not receive data while	1325	# we need to use a separate tls read buffer, as we must not receive data while
879	# we are draining the buffer, and this can only happen with TLS.	1326	# we are draining the buffer, and this can only happen with TLS.
880	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1327	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1328	if exists $self->{_tls_rbuf};
881		1329
882	my $len = length $self->{rbuf};	1330	my $len = length $self->{rbuf};
883		1331
884	if (my $cb = shift @{ $self->{_queue} }) {	1332	if (my $cb = shift @{ $self->{_queue} }) {
885	unless ($cb->($self)) {	1333	unless ($cb->($self)) {
886	if ($self->{_eof}) {	1334	# no progress can be made
887	# no progress can be made (not enough data and no data forthcoming)	1335	# (not enough data and no data forthcoming)
888	$self->_error (Errno::EPIPE, 1), return;	1336	$self->_error (Errno::EPIPE, 1), return
889	}	1337	if $self->{_eof};
890		1338
891	unshift @{ $self->{_queue} }, $cb;	1339	unshift @{ $self->{_queue} }, $cb;
892	last;	1340	last;
893	}	1341	}
894	} elsif ($self->{on_read}) {	1342	} elsif ($self->{on_read}) {
…		…
914	last;	1362	last;
915	}	1363	}
916	}	1364	}
917		1365
918	if ($self->{_eof}) {	1366	if ($self->{_eof}) {
919	if ($self->{on_eof}) {	1367	$self->{on_eof}
920	$self->{on_eof}($self)	1368	? $self->{on_eof}($self)
921	} else {
922	$self->_error (0, 1, "Unexpected end-of-file");	1369	: $self->_error (0, 1, "Unexpected end-of-file");
923	}	1370
		1371	return;
		1372	}
		1373
		1374	if (
		1375	defined $self->{rbuf_max}
		1376	&& $self->{rbuf_max} < length $self->{rbuf}
		1377	) {
		1378	$self->_error (Errno::ENOSPC, 1), return;
924	}	1379	}
925		1380
926	# may need to restart read watcher	1381	# may need to restart read watcher
927	unless ($self->{_rw}) {	1382	unless ($self->{_rw}) {
928	$self->start_read	1383	$self->start_read
…		…
934		1389
935	This replaces the currently set C<on_read> callback, or clears it (when	1390	This replaces the currently set C<on_read> callback, or clears it (when
936	the new callback is C<undef>). See the description of C<on_read> in the	1391	the new callback is C<undef>). See the description of C<on_read> in the
937	constructor.	1392	constructor.
938		1393
		1394	This method may invoke callbacks (and therefore the handle might be
		1395	destroyed after it returns).
		1396
939	=cut	1397	=cut
940		1398
941	sub on_read {	1399	sub on_read {
942	my ($self, $cb) = @_;	1400	my ($self, $cb) = @_;
943		1401
944	$self->{on_read} = $cb;	1402	$self->{on_read} = $cb;
945	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1403	$self->_drain_rbuf if $cb;
946	}	1404	}
947		1405
948	=item $handle->rbuf	1406	=item $handle->rbuf
949		1407
950	Returns the read buffer (as a modifiable lvalue).	1408	Returns the read buffer (as a modifiable lvalue). You can also access the
		1409	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1410	much faster, and no less clean).
951		1411
952	You can access the read buffer directly as the C<< ->{rbuf} >>	1412	The only operation allowed on the read buffer (apart from looking at it)
953	member, if you want. However, the only operation allowed on the	1413	is removing data from its beginning. Otherwise modifying or appending to
954	read buffer (apart from looking at it) is removing data from its	1414	it is not allowed and will lead to hard-to-track-down bugs.
955	beginning. Otherwise modifying or appending to it is not allowed and will
956	lead to hard-to-track-down bugs.
957		1415
958	NOTE: The read buffer should only be used or modified if the C<on_read>,	1416	NOTE: The read buffer should only be used or modified in the C<on_read>
959	C<push_read> or C<unshift_read> methods are used. The other read methods	1417	callback or when C<push_read> or C<unshift_read> are used with a single
960	automatically manage the read buffer.	1418	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1419	will manage the read buffer on their own.
961		1420
962	=cut	1421	=cut
963		1422
964	sub rbuf : lvalue {	1423	sub rbuf : lvalue {
965	$_[0]{rbuf}	1424	$_[0]{rbuf}
…		…
982		1441
983	If enough data was available, then the callback must remove all data it is	1442	If enough data was available, then the callback must remove all data it is
984	interested in (which can be none at all) and return a true value. After returning	1443	interested in (which can be none at all) and return a true value. After returning
985	true, it will be removed from the queue.	1444	true, it will be removed from the queue.
986		1445
		1446	These methods may invoke callbacks (and therefore the handle might be
		1447	destroyed after it returns).
		1448
987	=cut	1449	=cut
988		1450
989	our %RH;	1451	our %RH;
990		1452
991	sub register_read_type($$) {	1453	sub register_read_type($$) {
…		…
997	my $cb = pop;	1459	my $cb = pop;
998		1460
999	if (@_) {	1461	if (@_) {
1000	my $type = shift;	1462	my $type = shift;
1001		1463
		1464	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1002	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1465	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1003	->($self, $cb, @_);	1466	->($self, $cb, @_);
1004	}	1467	}
1005		1468
1006	push @{ $self->{_queue} }, $cb;	1469	push @{ $self->{_queue} }, $cb;
1007	$self->_drain_rbuf unless $self->{_in_drain};	1470	$self->_drain_rbuf;
1008	}	1471	}
1009		1472
1010	sub unshift_read {	1473	sub unshift_read {
1011	my $self = shift;	1474	my $self = shift;
1012	my $cb = pop;	1475	my $cb = pop;
1013		1476
1014	if (@_) {	1477	if (@_) {
1015	my $type = shift;	1478	my $type = shift;
1016		1479
		1480	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1017	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1481	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1018	->($self, $cb, @_);	1482	->($self, $cb, @_);
1019	}	1483	}
1020		1484
1021
1022	unshift @{ $self->{_queue} }, $cb;	1485	unshift @{ $self->{_queue} }, $cb;
1023	$self->_drain_rbuf unless $self->{_in_drain};	1486	$self->_drain_rbuf;
1024	}	1487	}
1025		1488
1026	=item $handle->push_read (type => @args, $cb)	1489	=item $handle->push_read (type => @args, $cb)
1027		1490
1028	=item $handle->unshift_read (type => @args, $cb)	1491	=item $handle->unshift_read (type => @args, $cb)
1029		1492
1030	Instead of providing a callback that parses the data itself you can chose	1493	Instead of providing a callback that parses the data itself you can chose
1031	between a number of predefined parsing formats, for chunks of data, lines	1494	between a number of predefined parsing formats, for chunks of data, lines
1032	etc.	1495	etc. You can also specify the (fully qualified) name of a package, in
		1496	which case AnyEvent tries to load the package and then expects to find the
		1497	C<anyevent_read_type> function inside (see "custom read types", below).
1033		1498
1034	Predefined types are (if you have ideas for additional types, feel free to	1499	Predefined types are (if you have ideas for additional types, feel free to
1035	drop by and tell us):	1500	drop by and tell us):
1036		1501
1037	=over 4	1502	=over 4
…		…
1043	data.	1508	data.
1044		1509
1045	Example: read 2 bytes.	1510	Example: read 2 bytes.
1046		1511
1047	$handle->push_read (chunk => 2, sub {	1512	$handle->push_read (chunk => 2, sub {
1048	warn "yay ", unpack "H*", $_[1];	1513	say "yay " . unpack "H*", $_[1];
1049	});	1514	});
1050		1515
1051	=cut	1516	=cut
1052		1517
1053	register_read_type chunk => sub {	1518	register_read_type chunk => sub {
…		…
1083		1548
1084	register_read_type line => sub {	1549	register_read_type line => sub {
1085	my ($self, $cb, $eol) = @_;	1550	my ($self, $cb, $eol) = @_;
1086		1551
1087	if (@_ < 3) {	1552	if (@_ < 3) {
1088	# this is more than twice as fast as the generic code below	1553	# this is faster then the generic code below
1089	sub {	1554	sub {
1090	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1555	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1556	or return;
1091		1557
		1558	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1092	$cb->($_[0], $1, $2);	1559	$cb->($_[0], $str, "$1");
1093	1	1560	1
1094	}	1561	}
1095	} else {	1562	} else {
1096	$eol = quotemeta $eol unless ref $eol;	1563	$eol = quotemeta $eol unless ref $eol;
1097	$eol = qr|^(.*?)($eol)|s;	1564	$eol = qr|^(.*?)($eol)|s;
1098		1565
1099	sub {	1566	sub {
1100	$_[0]{rbuf} =~ s/$eol// or return;	1567	$_[0]{rbuf} =~ s/$eol// or return;
1101		1568
1102	$cb->($_[0], $1, $2);	1569	$cb->($_[0], "$1", "$2");
1103	1	1570	1
1104	}	1571	}
1105	}	1572	}
1106	};	1573	};
1107		1574
…		…
1129	the receive buffer when neither C<$accept> nor C<$reject> match,	1596	the receive buffer when neither C<$accept> nor C<$reject> match,
1130	and everything preceding and including the match will be accepted	1597	and everything preceding and including the match will be accepted
1131	unconditionally. This is useful to skip large amounts of data that you	1598	unconditionally. This is useful to skip large amounts of data that you
1132	know cannot be matched, so that the C<$accept> or C<$reject> regex do not	1599	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1133	have to start matching from the beginning. This is purely an optimisation	1600	have to start matching from the beginning. This is purely an optimisation
1134	and is usually worth only when you expect more than a few kilobytes.	1601	and is usually worth it only when you expect more than a few kilobytes.
1135		1602
1136	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1603	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1137	expect the header to be very large (it isn't in practise, but...), we use	1604	expect the header to be very large (it isn't in practice, but...), we use
1138	a skip regex to skip initial portions. The skip regex is tricky in that	1605	a skip regex to skip initial portions. The skip regex is tricky in that
1139	it only accepts something not ending in either \015 or \012, as these are	1606	it only accepts something not ending in either \015 or \012, as these are
1140	required for the accept regex.	1607	required for the accept regex.
1141		1608
1142	$handle->push_read (regex =>	1609	$handle->push_read (regex =>
…		…
1155		1622
1156	sub {	1623	sub {
1157	# accept	1624	# accept
1158	if ($$rbuf =~ $accept) {	1625	if ($$rbuf =~ $accept) {
1159	$data .= substr $$rbuf, 0, $+[0], "";	1626	$data .= substr $$rbuf, 0, $+[0], "";
1160	$cb->($self, $data);	1627	$cb->($_[0], $data);
1161	return 1;	1628	return 1;
1162	}	1629	}
1163		1630
1164	# reject	1631	# reject
1165	if ($reject && $$rbuf =~ $reject) {	1632	if ($reject && $$rbuf =~ $reject) {
1166	$self->_error (Errno::EBADMSG);	1633	$_[0]->_error (Errno::EBADMSG);
1167	}	1634	}
1168		1635
1169	# skip	1636	# skip
1170	if ($skip && $$rbuf =~ $skip) {	1637	if ($skip && $$rbuf =~ $skip) {
1171	$data .= substr $$rbuf, 0, $+[0], "";	1638	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1187	my ($self, $cb) = @_;	1654	my ($self, $cb) = @_;
1188		1655
1189	sub {	1656	sub {
1190	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1657	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1191	if ($_[0]{rbuf} =~ /[^0-9]/) {	1658	if ($_[0]{rbuf} =~ /[^0-9]/) {
1192	$self->_error (Errno::EBADMSG);	1659	$_[0]->_error (Errno::EBADMSG);
1193	}	1660	}
1194	return;	1661	return;
1195	}	1662	}
1196		1663
1197	my $len = $1;	1664	my $len = $1;
1198		1665
1199	$self->unshift_read (chunk => $len, sub {	1666	$_[0]->unshift_read (chunk => $len, sub {
1200	my $string = $_[1];	1667	my $string = $_[1];
1201	$_[0]->unshift_read (chunk => 1, sub {	1668	$_[0]->unshift_read (chunk => 1, sub {
1202	if ($_[1] eq ",") {	1669	if ($_[1] eq ",") {
1203	$cb->($_[0], $string);	1670	$cb->($_[0], $string);
1204	} else {	1671	} else {
1205	$self->_error (Errno::EBADMSG);	1672	$_[0]->_error (Errno::EBADMSG);
1206	}	1673	}
1207	});	1674	});
1208	});	1675	});
1209		1676
1210	1	1677	1
…		…
1260	=item json => $cb->($handle, $hash_or_arrayref)	1727	=item json => $cb->($handle, $hash_or_arrayref)
1261		1728
1262	Reads a JSON object or array, decodes it and passes it to the	1729	Reads a JSON object or array, decodes it and passes it to the
1263	callback. When a parse error occurs, an C<EBADMSG> error will be raised.	1730	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1264		1731
1265	If a C<json> object was passed to the constructor, then that will be used	1732	If a C<json> object was passed to the constructor, then that will be
1266	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1733	used for the final decode, otherwise it will create a L<JSON::XS> or
		1734	L<JSON::PP> coder object expecting UTF-8.
1267		1735
1268	This read type uses the incremental parser available with JSON version	1736	This read type uses the incremental parser available with JSON version
1269	2.09 (and JSON::XS version 2.2) and above. You have to provide a	1737	2.09 (and JSON::XS version 2.2) and above.
1270	dependency on your own: this module will load the JSON module, but
1271	AnyEvent does not depend on it itself.
1272		1738
1273	Since JSON texts are fully self-delimiting, the C<json> read and write	1739	Since JSON texts are fully self-delimiting, the C<json> read and write
1274	types are an ideal simple RPC protocol: just exchange JSON datagrams. See	1740	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1275	the C<json> write type description, above, for an actual example.	1741	the C<json> write type description, above, for an actual example.
1276		1742
1277	=cut	1743	=cut
1278		1744
1279	register_read_type json => sub {	1745	register_read_type json => sub {
1280	my ($self, $cb) = @_;	1746	my ($self, $cb) = @_;
1281		1747
1282	my $json = $self->{json} ||=	1748	my $json = $self->{json} ||= json_coder;
1283	eval { require JSON::XS; JSON::XS->new->utf8 }
1284	|| do { require JSON; JSON->new->utf8 };
1285		1749
1286	my $data;	1750	my $data;
1287	my $rbuf = \$self->{rbuf};
1288		1751
1289	sub {	1752	sub {
1290	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1753	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1291		1754
1292	if ($ref) {	1755	if ($ref) {
1293	$self->{rbuf} = $json->incr_text;	1756	$_[0]{rbuf} = $json->incr_text;
1294	$json->incr_text = "";	1757	$json->incr_text = "";
1295	$cb->($self, $ref);	1758	$cb->($_[0], $ref);
1296		1759
1297	1	1760	1
1298	} elsif ($@) {	1761	} elsif ($@) {
1299	# error case	1762	# error case
1300	$json->incr_skip;	1763	$json->incr_skip;
1301		1764
1302	$self->{rbuf} = $json->incr_text;	1765	$_[0]{rbuf} = $json->incr_text;
1303	$json->incr_text = "";	1766	$json->incr_text = "";
1304		1767
1305	$self->_error (Errno::EBADMSG);	1768	$_[0]->_error (Errno::EBADMSG);
1306		1769
1307	()	1770	()
1308	} else {	1771	} else {
1309	$self->{rbuf} = "";	1772	$_[0]{rbuf} = "";
1310		1773
		1774	()
		1775	}
		1776	}
		1777	};
		1778
		1779	=item cbor => $cb->($handle, $scalar)
		1780
		1781	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1782	error occurs, an C<EBADMSG> error will be raised.
		1783
		1784	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1785	used for the final decode, otherwise it will create a CBOR coder without
		1786	enabling any options.
		1787
		1788	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1789	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1790	itself.
		1791
		1792	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1793	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1794	the C<cbor> write type description, above, for an actual example.
		1795
		1796	=cut
		1797
		1798	register_read_type cbor => sub {
		1799	my ($self, $cb) = @_;
		1800
		1801	my $cbor = $self->{cbor} ||= cbor_coder;
		1802
		1803	my $data;
		1804
		1805	sub {
		1806	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1807
		1808	if (@value) {
		1809	$cb->($_[0], @value);
		1810
		1811	1
		1812	} elsif ($@) {
		1813	# error case
		1814	$cbor->incr_reset;
		1815
		1816	$_[0]->_error (Errno::EBADMSG);
		1817
		1818	()
		1819	} else {
1311	()	1820	()
1312	}	1821	}
1313	}	1822	}
1314	};	1823	};
1315		1824
…		…
1324	=cut	1833	=cut
1325		1834
1326	register_read_type storable => sub {	1835	register_read_type storable => sub {
1327	my ($self, $cb) = @_;	1836	my ($self, $cb) = @_;
1328		1837
1329	require Storable;	1838	require Storable unless $Storable::VERSION;
1330		1839
1331	sub {	1840	sub {
1332	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1841	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1333	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1842	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1334	or return;	1843	or return;
…		…
1337		1846
1338	# bypass unshift if we already have the remaining chunk	1847	# bypass unshift if we already have the remaining chunk
1339	if ($format + $len <= length $_[0]{rbuf}) {	1848	if ($format + $len <= length $_[0]{rbuf}) {
1340	my $data = substr $_[0]{rbuf}, $format, $len;	1849	my $data = substr $_[0]{rbuf}, $format, $len;
1341	substr $_[0]{rbuf}, 0, $format + $len, "";	1850	substr $_[0]{rbuf}, 0, $format + $len, "";
		1851
1342	$cb->($_[0], Storable::thaw ($data));	1852	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1853	or return $_[0]->_error (Errno::EBADMSG);
1343	} else {	1854	} else {
1344	# remove prefix	1855	# remove prefix
1345	substr $_[0]{rbuf}, 0, $format, "";	1856	substr $_[0]{rbuf}, 0, $format, "";
1346		1857
1347	# read remaining chunk	1858	# read remaining chunk
1348	$_[0]->unshift_read (chunk => $len, sub {	1859	$_[0]->unshift_read (chunk => $len, sub {
1349	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1860	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1350	$cb->($_[0], $ref);
1351	} else {
1352	$self->_error (Errno::EBADMSG);	1861	or $_[0]->_error (Errno::EBADMSG);
1353	}
1354	});	1862	});
1355	}	1863	}
1356		1864
1357	1	1865	1
1358	}	1866	}
1359	};	1867	};
1360		1868
		1869	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1870
		1871	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1872	record without consuming anything. Only SSL version 3 or higher
		1873	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1874	SSL2-compatible framing is supported).
		1875
		1876	If it detects that the input data is likely TLS, it calls the callback
		1877	with a true value for C<$detect> and the (on-wire) TLS version as second
		1878	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1879	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1880	be definitely not TLS, it calls the callback with a false value for
		1881	C<$detect>.
		1882
		1883	The callback could use this information to decide whether or not to start
		1884	TLS negotiation.
		1885
		1886	In all cases the data read so far is passed to the following read
		1887	handlers.
		1888
		1889	Usually you want to use the C<tls_autostart> read type instead.
		1890
		1891	If you want to design a protocol that works in the presence of TLS
		1892	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1893	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1894	read type does are a bit more strict, but might losen in the future to
		1895	accomodate protocol changes.
		1896
		1897	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1898	L<Net::SSLeay>).
		1899
		1900	=item tls_autostart => $tls[, $tls_ctx]
		1901
		1902	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1903	to start tls by calling C<starttls> with the given arguments.
		1904
		1905	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1906	been configured to accept, as servers do not normally send a handshake on
		1907	their own and ths cannot be detected in this way.
		1908
		1909	See C<tls_detect> above for more details.
		1910
		1911	Example: give the client a chance to start TLS before accepting a text
		1912	line.
		1913
		1914	$hdl->push_read (tls_detect => "accept");
		1915	$hdl->push_read (line => sub {
		1916	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1917	});
		1918
		1919	=cut
		1920
		1921	register_read_type tls_detect => sub {
		1922	my ($self, $cb) = @_;
		1923
		1924	sub {
		1925	# this regex matches a full or partial tls record
		1926	if (
		1927	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1928	$self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs
		1929	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1930	or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs
		1931	) {
		1932	return if 3 != length $1; # partial match, can't decide yet
		1933
		1934	# full match, valid TLS record
		1935	my ($major, $minor) = unpack "CC", $1;
		1936	$cb->($self, "accept", $major + $minor * 0.1);
		1937	} else {
		1938	# mismatch == guaranteed not TLS
		1939	$cb->($self, undef);
		1940	}
		1941
		1942	1
		1943	}
		1944	};
		1945
		1946	register_read_type tls_autostart => sub {
		1947	my ($self, @tls) = @_;
		1948
		1949	$RH{tls_detect}($self, sub {
		1950	return unless $_[1];
		1951	$_[0]->starttls (@tls);
		1952	})
		1953	};
		1954
1361	=back	1955	=back
1362		1956
1363	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1957	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1364		1958
1365	This function (not method) lets you add your own types to C<push_read>.	1959	Instead of one of the predefined types, you can also specify the name
		1960	of a package. AnyEvent will try to load the package and then expects to
		1961	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1962	progressively tries to load the parent package until it either finds the
		1963	function (good) or runs out of packages (bad).
1366		1964
1367	Whenever the given C<type> is used, C<push_read> will invoke the code	1965	Whenever this type is used, C<push_read> will invoke the function with the
1368	reference with the handle object, the callback and the remaining	1966	handle object, the original callback and the remaining arguments.
1369	arguments.
1370		1967
1371	The code reference is supposed to return a callback (usually a closure)	1968	The function is supposed to return a callback (usually a closure) that
1372	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1969	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1970	mentally treat the function as a "configurable read type to read callback"
		1971	converter.
1373		1972
1374	It should invoke the passed callback when it is done reading (remember to	1973	It should invoke the original callback when it is done reading (remember
1375	pass C<$handle> as first argument as all other callbacks do that).	1974	to pass C<$handle> as first argument as all other callbacks do that,
		1975	although there is no strict requirement on this).
1376		1976
1377	Note that this is a function, and all types registered this way will be
1378	global, so try to use unique names.
1379
1380	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1977	For examples, see the source of this module (F<perldoc -m
1381	search for C<register_read_type>)).	1978	AnyEvent::Handle>, search for C<register_read_type>)).
1382		1979
1383	=item $handle->stop_read	1980	=item $handle->stop_read
1384		1981
1385	=item $handle->start_read	1982	=item $handle->start_read
1386		1983
…		…
1392	Note that AnyEvent::Handle will automatically C<start_read> for you when	1989	Note that AnyEvent::Handle will automatically C<start_read> for you when
1393	you change the C<on_read> callback or push/unshift a read callback, and it	1990	you change the C<on_read> callback or push/unshift a read callback, and it
1394	will automatically C<stop_read> for you when neither C<on_read> is set nor	1991	will automatically C<stop_read> for you when neither C<on_read> is set nor
1395	there are any read requests in the queue.	1992	there are any read requests in the queue.
1396		1993
1397	These methods will have no effect when in TLS mode (as TLS doesn't support	1994	In older versions of this module (<= 5.3), these methods had no effect,
1398	half-duplex connections).	1995	as TLS does not support half-duplex connections. In current versions they
		1996	work as expected, as this behaviour is required to avoid certain resource
		1997	attacks, where the program would be forced to read (and buffer) arbitrary
		1998	amounts of data before being able to send some data. The drawback is that
		1999	some readings of the the SSL/TLS specifications basically require this
		2000	attack to be working, as SSL/TLS implementations might stall sending data
		2001	during a rehandshake.
		2002
		2003	As a guideline, during the initial handshake, you should not stop reading,
		2004	and as a client, it might cause problems, depending on your application.
1399		2005
1400	=cut	2006	=cut
1401		2007
1402	sub stop_read {	2008	sub stop_read {
1403	my ($self) = @_;	2009	my ($self) = @_;
1404		2010
1405	delete $self->{_rw} unless $self->{tls};	2011	delete $self->{_rw};
1406	}	2012	}
1407		2013
1408	sub start_read {	2014	sub start_read {
1409	my ($self) = @_;	2015	my ($self) = @_;
1410		2016
1411	unless ($self->{_rw} || $self->{_eof}) {	2017	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1412	Scalar::Util::weaken $self;	2018	Scalar::Util::weaken $self;
1413		2019
1414	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	2020	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1415	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	2021	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1416	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	2022	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1417		2023
1418	if ($len > 0) {	2024	if ($len > 0) {
1419	$self->{_activity} = AnyEvent->now;	2025	$self->{_activity} = $self->{_ractivity} = AE::now;
1420		2026
1421	if ($self->{tls}) {	2027	if ($self->{tls}) {
1422	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	2028	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1423		2029
1424	&_dotls ($self);	2030	&_dotls ($self);
1425	} else {	2031	} else {
1426	$self->_drain_rbuf unless $self->{_in_drain};	2032	$self->_drain_rbuf;
		2033	}
		2034
		2035	if ($len == $self->{read_size}) {
		2036	$self->{read_size} *= 2;
		2037	$self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
		2038	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1427	}	2039	}
1428		2040
1429	} elsif (defined $len) {	2041	} elsif (defined $len) {
1430	delete $self->{_rw};	2042	delete $self->{_rw};
1431	$self->{_eof} = 1;	2043	$self->{_eof} = 1;
1432	$self->_drain_rbuf unless $self->{_in_drain};	2044	$self->_drain_rbuf;
1433		2045
1434	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2046	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1435	return $self->_error ($!, 1);	2047	return $self->_error ($!, 1);
1436	}	2048	}
1437	});	2049	};
1438	}	2050	}
1439	}	2051	}
1440		2052
1441	our $ERROR_SYSCALL;	2053	our $ERROR_SYSCALL;
1442	our $ERROR_WANT_READ;	2054	our $ERROR_WANT_READ;
…		…
1445	my ($self, $err) = @_;	2057	my ($self, $err) = @_;
1446		2058
1447	return $self->_error ($!, 1)	2059	return $self->_error ($!, 1)
1448	if $err == Net::SSLeay::ERROR_SYSCALL ();	2060	if $err == Net::SSLeay::ERROR_SYSCALL ();
1449		2061
1450	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2062	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1451		2063
1452	# reduce error string to look less scary	2064	# reduce error string to look less scary
1453	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2065	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1454		2066
1455	if ($self->{_on_starttls}) {	2067	if ($self->{_on_starttls}) {
…		…
1469	sub _dotls {	2081	sub _dotls {
1470	my ($self) = @_;	2082	my ($self) = @_;
1471		2083
1472	my $tmp;	2084	my $tmp;
1473		2085
1474	if (length $self->{_tls_wbuf}) {	2086	while (length $self->{_tls_wbuf}) {
1475	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2087	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1476	substr $self->{_tls_wbuf}, 0, $tmp, "";	2088	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2089
		2090	return $self->_tls_error ($tmp)
		2091	if $tmp != $ERROR_WANT_READ
		2092	&& ($tmp != $ERROR_SYSCALL || $!);
		2093
		2094	last;
1477	}	2095	}
1478		2096
1479	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2097	substr $self->{_tls_wbuf}, 0, $tmp, "";
1480	return $self->_tls_error ($tmp)
1481	if $tmp != $ERROR_WANT_READ
1482	&& ($tmp != $ERROR_SYSCALL || $!);
1483	}	2098	}
1484		2099
1485	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2100	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1486	unless (length $tmp) {	2101	unless (length $tmp) {
1487	$self->{_on_starttls}	2102	$self->{_on_starttls}
…		…
1497	$self->{_eof} = 1;	2112	$self->{_eof} = 1;
1498	}	2113	}
1499	}	2114	}
1500		2115
1501	$self->{_tls_rbuf} .= $tmp;	2116	$self->{_tls_rbuf} .= $tmp;
1502	$self->_drain_rbuf unless $self->{_in_drain};	2117	$self->_drain_rbuf;
1503	$self->{tls} or return; # tls session might have gone away in callback	2118	$self->{tls} or return; # tls session might have gone away in callback
1504	}	2119	}
1505		2120
1506	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	2121	$tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us
1507	return $self->_tls_error ($tmp)	2122	return $self->_tls_error ($tmp)
1508	if $tmp != $ERROR_WANT_READ	2123	if $tmp != $ERROR_WANT_READ
1509	&& ($tmp != $ERROR_SYSCALL || $!);	2124	&& ($tmp != $ERROR_SYSCALL || $!);
1510		2125
1511	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2126	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1512	$self->{wbuf} .= $tmp;	2127	$self->{wbuf} .= $tmp;
1513	$self->_drain_wbuf;	2128	$self->_drain_wbuf;
		2129	$self->{tls} or return; # tls session might have gone away in callback
1514	}	2130	}
1515		2131
1516	$self->{_on_starttls}	2132	$self->{_on_starttls}
1517	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	2133	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1518	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	2134	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1520		2136
1521	=item $handle->starttls ($tls[, $tls_ctx])	2137	=item $handle->starttls ($tls[, $tls_ctx])
1522		2138
1523	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2139	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1524	object is created, you can also do that at a later time by calling	2140	object is created, you can also do that at a later time by calling
1525	C<starttls>.	2141	C<starttls>. See the C<tls> constructor argument for general info.
		2142
		2143	Starting TLS is currently an asynchronous operation - when you push some
		2144	write data and then call C<< ->starttls >> then TLS negotiation will start
		2145	immediately, after which the queued write data is then sent. This might
		2146	change in future versions, so best make sure you have no outstanding write
		2147	data when calling this method.
1526		2148
1527	The first argument is the same as the C<tls> constructor argument (either	2149	The first argument is the same as the C<tls> constructor argument (either
1528	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2150	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1529		2151
1530	The second argument is the optional C<AnyEvent::TLS> object that is used	2152	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1535	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	2157	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1536	context in C<< $handle->{tls_ctx} >> after this call and can be used or	2158	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1537	changed to your liking. Note that the handshake might have already started	2159	changed to your liking. Note that the handshake might have already started
1538	when this function returns.	2160	when this function returns.
1539		2161
1540	If it an error to start a TLS handshake more than once per	2162	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1541	AnyEvent::Handle object (this is due to bugs in OpenSSL).	2163	handshakes on the same stream. It is best to not attempt to use the
		2164	stream after stopping TLS.
		2165
		2166	This method may invoke callbacks (and therefore the handle might be
		2167	destroyed after it returns).
1542		2168
1543	=cut	2169	=cut
1544		2170
1545	our %TLS_CACHE; #TODO not yet documented, should we?	2171	our %TLS_CACHE; #TODO not yet documented, should we?
1546		2172
1547	sub starttls {	2173	sub starttls {
1548	my ($self, $ssl, $ctx) = @_;	2174	my ($self, $tls, $ctx) = @_;
1549		2175
1550	require Net::SSLeay;	2176	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1551
1552	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1553	if $self->{tls};	2177	if $self->{tls};
		2178
		2179	unless (defined $AnyEvent::TLS::VERSION) {
		2180	eval {
		2181	require Net::SSLeay;
		2182	require AnyEvent::TLS;
		2183	1
		2184	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2185	}
		2186
		2187	$self->{tls} = $tls;
		2188	$self->{tls_ctx} = $ctx if @_ > 2;
		2189
		2190	return unless $self->{fh};
1554		2191
1555	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2192	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1556	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2193	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1557		2194
		2195	$tls = delete $self->{tls};
1558	$ctx ||= $self->{tls_ctx};	2196	$ctx = $self->{tls_ctx};
		2197
		2198	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1559		2199
1560	if ("HASH" eq ref $ctx) {	2200	if ("HASH" eq ref $ctx) {
1561	require AnyEvent::TLS;
1562
1563	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1564
1565	if ($ctx->{cache}) {	2201	if ($ctx->{cache}) {
1566	my $key = $ctx+0;	2202	my $key = $ctx+0;
1567	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;	2203	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1568	} else {	2204	} else {
1569	$ctx = new AnyEvent::TLS %$ctx;	2205	$ctx = new AnyEvent::TLS %$ctx;
1570	}	2206	}
1571	}	2207	}
1572		2208
1573	$self->{tls_ctx} = $ctx || TLS_CTX ();	2209	$self->{tls_ctx} = $ctx || TLS_CTX ();
1574	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	2210	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1575		2211
1576	# basically, this is deep magic (because SSL_read should have the same issues)	2212	# basically, this is deep magic (because SSL_read should have the same issues)
1577	# but the openssl maintainers basically said: "trust us, it just works".	2213	# but the openssl maintainers basically said: "trust us, it just works".
1578	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	2214	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1579	# and mismaintained ssleay-module doesn't even offer them).	2215	# and mismaintained ssleay-module doesn't even offer them).
…		…
1586	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	2222	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1587	# have identity issues in that area.	2223	# have identity issues in that area.
1588	# Net::SSLeay::CTX_set_mode ($ssl,	2224	# Net::SSLeay::CTX_set_mode ($ssl,
1589	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	2225	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1590	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	2226	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1591	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	2227	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1592		2228
1593	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2229	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1594	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2230	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1595		2231
		2232	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2233	$self->{rbuf} = "";
		2234
1596	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	2235	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1597		2236
1598	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2237	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1599	if $self->{on_starttls};	2238	if $self->{on_starttls};
1600		2239
1601	&_dotls; # need to trigger the initial handshake	2240	&_dotls; # need to trigger the initial handshake
…		…
1604		2243
1605	=item $handle->stoptls	2244	=item $handle->stoptls
1606		2245
1607	Shuts down the SSL connection - this makes a proper EOF handshake by	2246	Shuts down the SSL connection - this makes a proper EOF handshake by
1608	sending a close notify to the other side, but since OpenSSL doesn't	2247	sending a close notify to the other side, but since OpenSSL doesn't
1609	support non-blocking shut downs, it is not possible to re-use the stream	2248	support non-blocking shut downs, it is not guaranteed that you can re-use
1610	afterwards.	2249	the stream afterwards.
		2250
		2251	This method may invoke callbacks (and therefore the handle might be
		2252	destroyed after it returns).
1611		2253
1612	=cut	2254	=cut
1613		2255
1614	sub stoptls {	2256	sub stoptls {
1615	my ($self) = @_;	2257	my ($self) = @_;
1616		2258
1617	if ($self->{tls}) {	2259	if ($self->{tls} && $self->{fh}) {
1618	Net::SSLeay::shutdown ($self->{tls});	2260	Net::SSLeay::shutdown ($self->{tls});
1619		2261
1620	&_dotls;	2262	&_dotls;
1621		2263
1622	# # we don't give a shit. no, we do, but we can't. no...#d#	2264	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1628	sub _freetls {	2270	sub _freetls {
1629	my ($self) = @_;	2271	my ($self) = @_;
1630		2272
1631	return unless $self->{tls};	2273	return unless $self->{tls};
1632		2274
1633	$self->{tls_ctx}->_put_session (delete $self->{tls});	2275	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2276	if $self->{tls} > 0;
1634		2277
1635	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2278	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1636	}	2279	}
1637		2280
		2281	=item $handle->resettls
		2282
		2283	This rarely-used method simply resets and TLS state on the handle, usually
		2284	causing data loss.
		2285
		2286	One case where it may be useful is when you want to skip over the data in
		2287	the stream but you are not interested in interpreting it, so data loss is
		2288	no concern.
		2289
		2290	=cut
		2291
		2292	*resettls = \&_freetls;
		2293
1638	sub DESTROY {	2294	sub DESTROY {
1639	my ($self) = @_;	2295	my ($self) = @_;
1640		2296
1641	&_freetls;	2297	&_freetls;
1642		2298
1643	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	2299	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1644		2300
1645	if ($linger && length $self->{wbuf}) {	2301	if ($linger && length $self->{wbuf} && $self->{fh}) {
1646	my $fh = delete $self->{fh};	2302	my $fh = delete $self->{fh};
1647	my $wbuf = delete $self->{wbuf};	2303	my $wbuf = delete $self->{wbuf};
1648		2304
1649	my @linger;	2305	my @linger;
1650		2306
1651	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2307	push @linger, AE::io $fh, 1, sub {
1652	my $len = syswrite $fh, $wbuf, length $wbuf;	2308	my $len = syswrite $fh, $wbuf, length $wbuf;
1653		2309
1654	if ($len > 0) {	2310	if ($len > 0) {
1655	substr $wbuf, 0, $len, "";	2311	substr $wbuf, 0, $len, "";
1656	} else {	2312	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1657	@linger = (); # end	2313	@linger = (); # end
1658	}	2314	}
1659	});	2315	};
1660	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2316	push @linger, AE::timer $linger, 0, sub {
1661	@linger = ();	2317	@linger = ();
1662	});	2318	};
1663	}	2319	}
1664	}	2320	}
1665		2321
1666	=item $handle->destroy	2322	=item $handle->destroy
1667		2323
1668	Shuts down the handle object as much as possible - this call ensures that	2324	Shuts down the handle object as much as possible - this call ensures that
1669	no further callbacks will be invoked and as many resources as possible	2325	no further callbacks will be invoked and as many resources as possible
1670	will be freed. You must not call any methods on the object afterwards.	2326	will be freed. Any method you will call on the handle object after
		2327	destroying it in this way will be silently ignored (and it will return the
		2328	empty list).
1671		2329
1672	Normally, you can just "forget" any references to an AnyEvent::Handle	2330	Normally, you can just "forget" any references to an AnyEvent::Handle
1673	object and it will simply shut down. This works in fatal error and EOF	2331	object and it will simply shut down. This works in fatal error and EOF
1674	callbacks, as well as code outside. It does I<NOT> work in a read or write	2332	callbacks, as well as code outside. It does I<NOT> work in a read or write
1675	callback, so when you want to destroy the AnyEvent::Handle object from	2333	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1689	sub destroy {	2347	sub destroy {
1690	my ($self) = @_;	2348	my ($self) = @_;
1691		2349
1692	$self->DESTROY;	2350	$self->DESTROY;
1693	%$self = ();	2351	%$self = ();
		2352	bless $self, "AnyEvent::Handle::destroyed";
1694	}	2353	}
		2354
		2355	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2356	#nop
		2357	}
		2358
		2359	=item $handle->destroyed
		2360
		2361	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2362	->destroy >>, true otherwise.
		2363
		2364	Can be useful to decide whether the handle is still valid after some
		2365	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2366	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2367	can destroy the handle, so work can be avoided by checking sometimes:
		2368
		2369	$hdl->starttls ("accept");
		2370	return if $hdl->destroyed;
		2371	$hdl->push_write (...
		2372
		2373	Note that the call to C<push_write> will silently be ignored if the handle
		2374	has been destroyed, so often you can just ignore the possibility of the
		2375	handle being destroyed.
		2376
		2377	=cut
		2378
		2379	sub destroyed { 0 }
		2380	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1695		2381
1696	=item AnyEvent::Handle::TLS_CTX	2382	=item AnyEvent::Handle::TLS_CTX
1697		2383
1698	This function creates and returns the AnyEvent::TLS object used by default	2384	This function creates and returns the AnyEvent::TLS object used by default
1699	for TLS mode.	2385	for TLS mode.
…		…
1727		2413
1728	It is only safe to "forget" the reference inside EOF or error callbacks,	2414	It is only safe to "forget" the reference inside EOF or error callbacks,
1729	from within all other callbacks, you need to explicitly call the C<<	2415	from within all other callbacks, you need to explicitly call the C<<
1730	->destroy >> method.	2416	->destroy >> method.
1731		2417
		2418	=item Why is my C<on_eof> callback never called?
		2419
		2420	Probably because your C<on_error> callback is being called instead: When
		2421	you have outstanding requests in your read queue, then an EOF is
		2422	considered an error as you clearly expected some data.
		2423
		2424	To avoid this, make sure you have an empty read queue whenever your handle
		2425	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2426	an C<on_read> handler that simply pushes the first read requests in the
		2427	queue.
		2428
		2429	See also the next question, which explains this in a bit more detail.
		2430
		2431	=item How can I serve requests in a loop?
		2432
		2433	Most protocols consist of some setup phase (authentication for example)
		2434	followed by a request handling phase, where the server waits for requests
		2435	and handles them, in a loop.
		2436
		2437	There are two important variants: The first (traditional, better) variant
		2438	handles requests until the server gets some QUIT command, causing it to
		2439	close the connection first (highly desirable for a busy TCP server). A
		2440	client dropping the connection is an error, which means this variant can
		2441	detect an unexpected detection close.
		2442
		2443	To handle this case, always make sure you have a non-empty read queue, by
		2444	pushing the "read request start" handler on it:
		2445
		2446	# we assume a request starts with a single line
		2447	my @start_request; @start_request = (line => sub {
		2448	my ($hdl, $line) = @_;
		2449
		2450	... handle request
		2451
		2452	# push next request read, possibly from a nested callback
		2453	$hdl->push_read (@start_request);
		2454	});
		2455
		2456	# auth done, now go into request handling loop
		2457	# now push the first @start_request
		2458	$hdl->push_read (@start_request);
		2459
		2460	By always having an outstanding C<push_read>, the handle always expects
		2461	some data and raises the C<EPIPE> error when the connction is dropped
		2462	unexpectedly.
		2463
		2464	The second variant is a protocol where the client can drop the connection
		2465	at any time. For TCP, this means that the server machine may run out of
		2466	sockets easier, and in general, it means you cannot distinguish a protocl
		2467	failure/client crash from a normal connection close. Nevertheless, these
		2468	kinds of protocols are common (and sometimes even the best solution to the
		2469	problem).
		2470
		2471	Having an outstanding read request at all times is possible if you ignore
		2472	C<EPIPE> errors, but this doesn't help with when the client drops the
		2473	connection during a request, which would still be an error.
		2474
		2475	A better solution is to push the initial request read in an C<on_read>
		2476	callback. This avoids an error, as when the server doesn't expect data
		2477	(i.e. is idly waiting for the next request, an EOF will not raise an
		2478	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2479	and simpler:
		2480
		2481	# auth done, now go into request handling loop
		2482	$hdl->on_read (sub {
		2483	my ($hdl) = @_;
		2484
		2485	# called each time we receive data but the read queue is empty
		2486	# simply start read the request
		2487
		2488	$hdl->push_read (line => sub {
		2489	my ($hdl, $line) = @_;
		2490
		2491	... handle request
		2492
		2493	# do nothing special when the request has been handled, just
		2494	# let the request queue go empty.
		2495	});
		2496	});
		2497
1732	=item I get different callback invocations in TLS mode/Why can't I pause	2498	=item I get different callback invocations in TLS mode/Why can't I pause
1733	reading?	2499	reading?
1734		2500
1735	Unlike, say, TCP, TLS connections do not consist of two independent	2501	Unlike, say, TCP, TLS connections do not consist of two independent
1736	communication channels, one for each direction. Or put differently. The	2502	communication channels, one for each direction. Or put differently, the
1737	read and write directions are not independent of each other: you cannot	2503	read and write directions are not independent of each other: you cannot
1738	write data unless you are also prepared to read, and vice versa.	2504	write data unless you are also prepared to read, and vice versa.
1739		2505
1740	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2506	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1741	callback invocations when you are not expecting any read data - the reason	2507	callback invocations when you are not expecting any read data - the reason
1742	is that AnyEvent::Handle always reads in TLS mode.	2508	is that AnyEvent::Handle always reads in TLS mode.
1743		2509
1744	During the connection, you have to make sure that you always have a	2510	During the connection, you have to make sure that you always have a
1745	non-empty read-queue, or an C<on_read> watcher. At the end of the	2511	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1757	$handle->on_eof (undef);	2523	$handle->on_eof (undef);
1758	$handle->on_error (sub {	2524	$handle->on_error (sub {
1759	my $data = delete $_[0]{rbuf};	2525	my $data = delete $_[0]{rbuf};
1760	});	2526	});
1761		2527
		2528	Note that this example removes the C<rbuf> member from the handle object,
		2529	which is not normally allowed by the API. It is expressly permitted in
		2530	this case only, as the handle object needs to be destroyed afterwards.
		2531
1762	The reason to use C<on_error> is that TCP connections, due to latencies	2532	The reason to use C<on_error> is that TCP connections, due to latencies
1763	and packets loss, might get closed quite violently with an error, when in	2533	and packets loss, might get closed quite violently with an error, when in
1764	fact, all data has been received.	2534	fact all data has been received.
1765		2535
1766	It is usually better to use acknowledgements when transferring data,	2536	It is usually better to use acknowledgements when transferring data,
1767	to make sure the other side hasn't just died and you got the data	2537	to make sure the other side hasn't just died and you got the data
1768	intact. This is also one reason why so many internet protocols have an	2538	intact. This is also one reason why so many internet protocols have an
1769	explicit QUIT command.	2539	explicit QUIT command.
…		…
1776	C<low_water_mark> this will be called precisely when all data has been	2546	C<low_water_mark> this will be called precisely when all data has been
1777	written to the socket:	2547	written to the socket:
1778		2548
1779	$handle->push_write (...);	2549	$handle->push_write (...);
1780	$handle->on_drain (sub {	2550	$handle->on_drain (sub {
1781	warn "all data submitted to the kernel\n";	2551	AE::log debug => "All data submitted to the kernel.";
1782	undef $handle;	2552	undef $handle;
1783	});	2553	});
1784		2554
1785	If you just want to queue some data and then signal EOF to the other side,	2555	If you just want to queue some data and then signal EOF to the other side,
1786	consider using C<< ->push_shutdown >> instead.	2556	consider using C<< ->push_shutdown >> instead.
1787		2557
1788	=item I want to contact a TLS/SSL server, I don't care about security.	2558	=item I want to contact a TLS/SSL server, I don't care about security.
1789		2559
1790	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	2560	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1791	simply connect to it and then create the AnyEvent::Handle with the C<tls>	2561	connect to it and then create the AnyEvent::Handle with the C<tls>
1792	parameter:	2562	parameter:
1793		2563
1794	tcp_connect $host, $port, sub {	2564	tcp_connect $host, $port, sub {
1795	my ($fh) = @_;	2565	my ($fh) = @_;
1796		2566
…		…
1870	When you have intermediate CA certificates that your clients might not	2640	When you have intermediate CA certificates that your clients might not
1871	know about, just append them to the C<cert_file>.	2641	know about, just append them to the C<cert_file>.
1872		2642
1873	=back	2643	=back
1874		2644
1875
1876	=head1 SUBCLASSING AnyEvent::Handle	2645	=head1 SUBCLASSING AnyEvent::Handle
1877		2646
1878	In many cases, you might want to subclass AnyEvent::Handle.	2647	In many cases, you might want to subclass AnyEvent::Handle.
1879		2648
1880	To make this easier, a given version of AnyEvent::Handle uses these	2649	To make this easier, a given version of AnyEvent::Handle uses these
…		…
1896		2665
1897	=item * all members not documented here and not prefixed with an underscore	2666	=item * all members not documented here and not prefixed with an underscore
1898	are free to use in subclasses.	2667	are free to use in subclasses.
1899		2668
1900	Of course, new versions of AnyEvent::Handle may introduce more "public"	2669	Of course, new versions of AnyEvent::Handle may introduce more "public"
1901	member variables, but thats just life, at least it is documented.	2670	member variables, but that's just life. At least it is documented.
1902		2671
1903	=back	2672	=back
1904		2673
1905	=head1 AUTHOR	2674	=head1 AUTHOR
1906		2675
1907	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2676	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
1908		2677
1909	=cut	2678	=cut
1910		2679
1911	1; # End of AnyEvent::Handle	2680	1
		2681

Diff Legend

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