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.162 by root, Sun Jul 26 00:17:25 2009 UTC vs.
Revision 1.246 by root, Sun Jun 28 09:30:37 2015 UTC

1	package AnyEvent::Handle;
2
3	use Scalar::Util ();
4	use Carp ();
5	use Errno qw(EAGAIN EINTR);
6
7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
9
10	=head1 NAME	1	=head1 NAME
11		2
12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
13
14	=cut
15
16	our $VERSION = 4.87;
17		4
18	=head1 SYNOPSIS	5	=head1 SYNOPSIS
19		6
20	use AnyEvent;	7	use AnyEvent;
21	use AnyEvent::Handle;	8	use AnyEvent::Handle;
…		…
24		11
25	my $hdl; $hdl = new AnyEvent::Handle	12	my $hdl; $hdl = new AnyEvent::Handle
26	fh => \*STDIN,	13	fh => \*STDIN,
27	on_error => sub {	14	on_error => sub {
28	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
29	warn "got error $msg\n";	16	AE::log error => $msg;
30	$hdl->destroy;	17	$hdl->destroy;
31	$cv->send;	18	$cv->send;
32	);	19	};
33		20
34	# send some request line	21	# send some request line
35	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
36		23
37	# read the response line	24	# read the response line
38	$hdl->push_read (line => sub {	25	$hdl->push_read (line => sub {
39	my ($hdl, $line) = @_;	26	my ($hdl, $line) = @_;
40	warn "got line <$line>\n";	27	say "got line <$line>";
41	$cv->send;	28	$cv->send;
42	});	29	});
43		30
44	$cv->recv;	31	$cv->recv;
45		32
46	=head1 DESCRIPTION	33	=head1 DESCRIPTION
47		34
48	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
49	filehandles.	36	on stream-based filehandles (sockets, pipes, and other stream
		37	things). Specifically, it doesn't work as expected on files, packet-based
		38	sockets or similar things.
50		39
51	The L<AnyEvent::Intro> tutorial contains some well-documented	40	The L<AnyEvent::Intro> tutorial contains some well-documented
52	AnyEvent::Handle examples.	41	AnyEvent::Handle examples.
53		42
54	In the following, when the documentation refers to of "bytes" then this	43	In the following, where the documentation refers to "bytes", it means
55	means characters. As sysread and syswrite are used for all I/O, their	44	characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	45	treatment of characters applies to this module as well.
57		46
58	At the very minimum, you should specify C<fh> or C<connect>, and the	47	At the very minimum, you should specify C<fh> or C<connect>, and the
59	C<on_error> callback.	48	C<on_error> callback.
60		49
61	All callbacks will be invoked with the handle object as their first	50	All callbacks will be invoked with the handle object as their first
62	argument.	51	argument.
63		52
		53	=cut
		54
		55	package AnyEvent::Handle;
		56
		57	use Scalar::Util ();
		58	use List::Util ();
		59	use Carp ();
		60	use Errno qw(EAGAIN EWOULDBLOCK EINTR);
		61
		62	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		63	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		64
		65	our $VERSION = $AnyEvent::VERSION;
		66
		67	sub _load_func($) {
		68	my $func = $_[0];
		69
		70	unless (defined &$func) {
		71	my $pkg = $func;
		72	do {
		73	$pkg =~ s/::[^:]+$//
		74	or return;
		75	eval "require $pkg";
		76	} until defined &$func;
		77	}
		78
		79	\&$func
		80	}
		81
		82	sub MAX_READ_SIZE() { 131072 }
		83
64	=head1 METHODS	84	=head1 METHODS
65		85
66	=over 4	86	=over 4
67		87
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	88	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69		89
70	The constructor supports these arguments (all as C<< key => value >> pairs).	90	The constructor supports these arguments (all as C<< key => value >> pairs).
71		91
72	=over 4	92	=over 4
73		93
74	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]	94	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		95
76	The filehandle this L<AnyEvent::Handle> object will operate on.	96	The filehandle this L<AnyEvent::Handle> object will operate on.
77	NOTE: The filehandle will be set to non-blocking mode (using	97	NOTE: The filehandle will be set to non-blocking mode (using
78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	98	C<AnyEvent::fh_unblock>) by the constructor and needs to stay in
79	that mode.	99	that mode.
80		100
81	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]	101	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
82		102
83	Try to connect to the specified host and service (port), using	103	Try to connect to the specified host and service (port), using
…		…
96	=over 4	116	=over 4
97		117
98	=item on_prepare => $cb->($handle)	118	=item on_prepare => $cb->($handle)
99		119
100	This (rarely used) callback is called before a new connection is	120	This (rarely used) callback is called before a new connection is
101	attempted, but after the file handle has been created. It could be used to	121	attempted, but after the file handle has been created (you can access that
		122	file handle via C<< $handle->{fh} >>). It could be used to prepare the
102	prepare the file handle with parameters required for the actual connect	123	file handle with parameters required for the actual connect (as opposed to
103	(as opposed to settings that can be changed when the connection is already	124	settings that can be changed when the connection is already established).
104	established).
105		125
106	The return value of this callback should be the connect timeout value in	126	The return value of this callback should be the connect timeout value in
107	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default	127	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
108	timeout is to be used).	128	default timeout is to be used).
109		129
110	=item on_connect => $cb->($handle, $host, $port, $retry->())	130	=item on_connect => $cb->($handle, $host, $port, $retry->())
111		131
112	This callback is called when a connection has been successfully established.	132	This callback is called when a connection has been successfully established.
113		133
114	The actual numeric host and port (the socket peername) are passed as	134	The peer's numeric host and port (the socket peername) are passed as
115	parameters, together with a retry callback.	135	parameters, together with a retry callback. At the time it is called the
		136	read and write queues, EOF status, TLS status and similar properties of
		137	the handle will have been reset.
116		138
117	When, for some reason, the handle is not acceptable, then calling	139	If, for some reason, the handle is not acceptable, calling C<$retry> will
118	C<$retry> will continue with the next conenction target (in case of	140	continue with the next connection target (in case of multi-homed hosts or
119	multi-homed hosts or SRV records there can be multiple connection	141	SRV records there can be multiple connection endpoints). The C<$retry>
120	endpoints). When it is called then the read and write queues, eof status,	142	callback can be invoked after the connect callback returns, i.e. one can
121	tls status and similar properties of the handle are being reset.	143	start a handshake and then decide to retry with the next host if the
		144	handshake fails.
122		145
123	In most cases, ignoring the C<$retry> parameter is the way to go.	146	In most cases, you should ignore the C<$retry> parameter.
124		147
125	=item on_connect_error => $cb->($handle, $message)	148	=item on_connect_error => $cb->($handle, $message)
126		149
127	This callback is called when the conenction could not be	150	This callback is called when the connection could not be
128	established. C<$!> will contain the relevant error code, and C<$message> a	151	established. C<$!> will contain the relevant error code, and C<$message> a
129	message describing it (usually the same as C<"$!">).	152	message describing it (usually the same as C<"$!">).
130		153
131	If this callback isn't specified, then C<on_error> will be called with a	154	If this callback isn't specified, then C<on_error> will be called with a
132	fatal error instead.	155	fatal error instead.
…		…
135		158
136	=item on_error => $cb->($handle, $fatal, $message)	159	=item on_error => $cb->($handle, $fatal, $message)
137		160
138	This is the error callback, which is called when, well, some error	161	This is the error callback, which is called when, well, some error
139	occured, such as not being able to resolve the hostname, failure to	162	occured, such as not being able to resolve the hostname, failure to
140	connect or a read error.	163	connect, or a read error.
141		164
142	Some errors are fatal (which is indicated by C<$fatal> being true). On	165	Some errors are fatal (which is indicated by C<$fatal> being true). On
143	fatal errors the handle object will be destroyed (by a call to C<< ->	166	fatal errors the handle object will be destroyed (by a call to C<< ->
144	destroy >>) after invoking the error callback (which means you are free to	167	destroy >>) after invoking the error callback (which means you are free to
145	examine the handle object). Examples of fatal errors are an EOF condition	168	examine the handle object). Examples of fatal errors are an EOF condition
146	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In	169	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
147	cases where the other side can close the connection at their will it is	170	cases where the other side can close the connection at will, it is
148	often easiest to not report C<EPIPE> errors in this callback.	171	often easiest to not report C<EPIPE> errors in this callback.
149		172
150	AnyEvent::Handle tries to find an appropriate error code for you to check	173	AnyEvent::Handle tries to find an appropriate error code for you to check
151	against, but in some cases (TLS errors), this does not work well. It is	174	against, but in some cases (TLS errors), this does not work well.
152	recommended to always output the C<$message> argument in human-readable
153	error messages (it's usually the same as C<"$!">).
154		175
		176	If you report the error to the user, it is recommended to always output
		177	the C<$message> argument in human-readable error messages (you don't need
		178	to report C<"$!"> if you report C<$message>).
		179
		180	If you want to react programmatically to the error, then looking at C<$!>
		181	and comparing it against some of the documented C<Errno> values is usually
		182	better than looking at the C<$message>.
		183
155	Non-fatal errors can be retried by simply returning, but it is recommended	184	Non-fatal errors can be retried by returning, but it is recommended
156	to simply ignore this parameter and instead abondon the handle object	185	to simply ignore this parameter and instead abondon the handle object
157	when this callback is invoked. Examples of non-fatal errors are timeouts	186	when this callback is invoked. Examples of non-fatal errors are timeouts
158	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	187	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
159		188
160	On callback entrance, the value of C<$!> contains the operating system	189	On entry to the callback, the value of C<$!> contains the operating
161	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or	190	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
162	C<EPROTO>).	191	C<EPROTO>).
163		192
164	While not mandatory, it is I<highly> recommended to set this callback, as	193	While not mandatory, it is I<highly> recommended to set this callback, as
165	you will not be notified of errors otherwise. The default simply calls	194	you will not be notified of errors otherwise. The default just calls
166	C<croak>.	195	C<croak>.
167		196
168	=item on_read => $cb->($handle)	197	=item on_read => $cb->($handle)
169		198
170	This sets the default read callback, which is called when data arrives	199	This sets the default read callback, which is called when data arrives
…		…
175	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	204	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
176	method or access the C<< $handle->{rbuf} >> member directly. Note that you	205	method or access the C<< $handle->{rbuf} >> member directly. Note that you
177	must not enlarge or modify the read buffer, you can only remove data at	206	must not enlarge or modify the read buffer, you can only remove data at
178	the beginning from it.	207	the beginning from it.
179		208
		209	You can also call C<< ->push_read (...) >> or any other function that
		210	modifies the read queue. Or do both. Or ...
		211
180	When an EOF condition is detected then AnyEvent::Handle will first try to	212	When an EOF condition is detected, AnyEvent::Handle will first try to
181	feed all the remaining data to the queued callbacks and C<on_read> before	213	feed all the remaining data to the queued callbacks and C<on_read> before
182	calling the C<on_eof> callback. If no progress can be made, then a fatal	214	calling the C<on_eof> callback. If no progress can be made, then a fatal
183	error will be raised (with C<$!> set to C<EPIPE>).	215	error will be raised (with C<$!> set to C<EPIPE>).
184		216
185	Note that, unlike requests in the read queue, an C<on_read> callback	217	Note that, unlike requests in the read queue, an C<on_read> callback
…		…
203	If an EOF condition has been detected but no C<on_eof> callback has been	235	If an EOF condition has been detected but no C<on_eof> callback has been
204	set, then a fatal error will be raised with C<$!> set to <0>.	236	set, then a fatal error will be raised with C<$!> set to <0>.
205		237
206	=item on_drain => $cb->($handle)	238	=item on_drain => $cb->($handle)
207		239
208	This sets the callback that is called when the write buffer becomes empty	240	This sets the callback that is called once when the write buffer becomes
209	(or when the callback is set and the buffer is empty already).	241	empty (and immediately when the handle object is created).
210		242
211	To append to the write buffer, use the C<< ->push_write >> method.	243	To append to the write buffer, use the C<< ->push_write >> method.
212		244
213	This callback is useful when you don't want to put all of your write data	245	This callback is useful when you don't want to put all of your write data
214	into the queue at once, for example, when you want to write the contents	246	into the queue at once, for example, when you want to write the contents
…		…
216	memory and push it into the queue, but instead only read more data from	248	memory and push it into the queue, but instead only read more data from
217	the file when the write queue becomes empty.	249	the file when the write queue becomes empty.
218		250
219	=item timeout => $fractional_seconds	251	=item timeout => $fractional_seconds
220		252
		253	=item rtimeout => $fractional_seconds
		254
		255	=item wtimeout => $fractional_seconds
		256
221	If non-zero, then this enables an "inactivity" timeout: whenever this many	257	If non-zero, then these enables an "inactivity" timeout: whenever this
222	seconds pass without a successful read or write on the underlying file	258	many seconds pass without a successful read or write on the underlying
223	handle, the C<on_timeout> callback will be invoked (and if that one is	259	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
224	missing, a non-fatal C<ETIMEDOUT> error will be raised).	260	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		261	error will be raised).
225		262
		263	There are three variants of the timeouts that work independently of each
		264	other, for both read and write (triggered when nothing was read I<OR>
		265	written), just read (triggered when nothing was read), and just write:
		266	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		267	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		268	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
		269
226	Note that timeout processing is also active when you currently do not have	270	Note that timeout processing is active even when you do not have any
227	any outstanding read or write requests: If you plan to keep the connection	271	outstanding read or write requests: If you plan to keep the connection
228	idle then you should disable the timout temporarily or ignore the timeout	272	idle then you should disable the timeout temporarily or ignore the
229	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	273	timeout in the corresponding C<on_timeout> callback, in which case
230	restart the timeout.	274	AnyEvent::Handle will simply restart the timeout.
231		275
232	Zero (the default) disables this timeout.	276	Zero (the default) disables the corresponding timeout.
233		277
234	=item on_timeout => $cb->($handle)	278	=item on_timeout => $cb->($handle)
		279
		280	=item on_rtimeout => $cb->($handle)
		281
		282	=item on_wtimeout => $cb->($handle)
235		283
236	Called whenever the inactivity timeout passes. If you return from this	284	Called whenever the inactivity timeout passes. If you return from this
237	callback, then the timeout will be reset as if some activity had happened,	285	callback, then the timeout will be reset as if some activity had happened,
238	so this condition is not fatal in any way.	286	so this condition is not fatal in any way.
239		287
…		…
247	be configured to accept only so-and-so much data that it cannot act on	295	be configured to accept only so-and-so much data that it cannot act on
248	(for example, when expecting a line, an attacker could send an unlimited	296	(for example, when expecting a line, an attacker could send an unlimited
249	amount of data without a callback ever being called as long as the line	297	amount of data without a callback ever being called as long as the line
250	isn't finished).	298	isn't finished).
251		299
		300	=item wbuf_max => <bytes>
		301
		302	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
		303	when the write buffer ever (strictly) exceeds this size. This is useful to
		304	avoid some forms of denial-of-service attacks.
		305
		306	Although the units of this parameter is bytes, this is the I<raw> number
		307	of bytes not yet accepted by the kernel. This can make a difference when
		308	you e.g. use TLS, as TLS typically makes your write data larger (but it
		309	can also make it smaller due to compression).
		310
		311	As an example of when this limit is useful, take a chat server that sends
		312	chat messages to a client. If the client does not read those in a timely
		313	manner then the send buffer in the server would grow unbounded.
		314
252	=item autocork => <boolean>	315	=item autocork => <boolean>
253		316
254	When disabled (the default), then C<push_write> will try to immediately	317	When disabled (the default), C<push_write> will try to immediately
255	write the data to the handle, if possible. This avoids having to register	318	write the data to the handle if possible. This avoids having to register
256	a write watcher and wait for the next event loop iteration, but can	319	a write watcher and wait for the next event loop iteration, but can
257	be inefficient if you write multiple small chunks (on the wire, this	320	be inefficient if you write multiple small chunks (on the wire, this
258	disadvantage is usually avoided by your kernel's nagle algorithm, see	321	disadvantage is usually avoided by your kernel's nagle algorithm, see
259	C<no_delay>, but this option can save costly syscalls).	322	C<no_delay>, but this option can save costly syscalls).
260		323
261	When enabled, then writes will always be queued till the next event loop	324	When enabled, writes will always be queued till the next event loop
262	iteration. This is efficient when you do many small writes per iteration,	325	iteration. This is efficient when you do many small writes per iteration,
263	but less efficient when you do a single write only per iteration (or when	326	but less efficient when you do a single write only per iteration (or when
264	the write buffer often is full). It also increases write latency.	327	the write buffer often is full). It also increases write latency.
265		328
266	=item no_delay => <boolean>	329	=item no_delay => <boolean>
…		…
270	the Nagle algorithm, and usually it is beneficial.	333	the Nagle algorithm, and usually it is beneficial.
271		334
272	In some situations you want as low a delay as possible, which can be	335	In some situations you want as low a delay as possible, which can be
273	accomplishd by setting this option to a true value.	336	accomplishd by setting this option to a true value.
274		337
275	The default is your opertaing system's default behaviour (most likely	338	The default is your operating system's default behaviour (most likely
276	enabled), this option explicitly enables or disables it, if possible.	339	enabled). This option explicitly enables or disables it, if possible.
		340
		341	=item keepalive => <boolean>
		342
		343	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		344	normally, TCP connections have no time-out once established, so TCP
		345	connections, once established, can stay alive forever even when the other
		346	side has long gone. TCP keepalives are a cheap way to take down long-lived
		347	TCP connections when the other side becomes unreachable. While the default
		348	is OS-dependent, TCP keepalives usually kick in after around two hours,
		349	and, if the other side doesn't reply, take down the TCP connection some 10
		350	to 15 minutes later.
		351
		352	It is harmless to specify this option for file handles that do not support
		353	keepalives, and enabling it on connections that are potentially long-lived
		354	is usually a good idea.
		355
		356	=item oobinline => <boolean>
		357
		358	BSD majorly fucked up the implementation of TCP urgent data. The result
		359	is that almost no OS implements TCP according to the specs, and every OS
		360	implements it slightly differently.
		361
		362	If you want to handle TCP urgent data, then setting this flag (the default
		363	is enabled) gives you the most portable way of getting urgent data, by
		364	putting it into the stream.
		365
		366	Since BSD emulation of OOB data on top of TCP's urgent data can have
		367	security implications, AnyEvent::Handle sets this flag automatically
		368	unless explicitly specified. Note that setting this flag after
		369	establishing a connection I<may> be a bit too late (data loss could
		370	already have occured on BSD systems), but at least it will protect you
		371	from most attacks.
277		372
278	=item read_size => <bytes>	373	=item read_size => <bytes>
279		374
280	The default read block size (the amount of bytes this module will	375	The initial read block size, the number of bytes this module will try
281	try to read during each loop iteration, which affects memory	376	to read during each loop iteration. Each handle object will consume
282	requirements). Default: C<8192>.	377	at least this amount of memory for the read buffer as well, so when
		378	handling many connections watch out for memory requirements). See also
		379	C<max_read_size>. Default: C<2048>.
		380
		381	=item max_read_size => <bytes>
		382
		383	The maximum read buffer size used by the dynamic adjustment
		384	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
		385	one go it will double C<read_size> up to the maximum given by this
		386	option. Default: C<131072> or C<read_size>, whichever is higher.
283		387
284	=item low_water_mark => <bytes>	388	=item low_water_mark => <bytes>
285		389
286	Sets the amount of bytes (default: C<0>) that make up an "empty" write	390	Sets the number of bytes (default: C<0>) that make up an "empty" write
287	buffer: If the write reaches this size or gets even samller it is	391	buffer: If the buffer reaches this size or gets even samller it is
288	considered empty.	392	considered empty.
289		393
290	Sometimes it can be beneficial (for performance reasons) to add data to	394	Sometimes it can be beneficial (for performance reasons) to add data to
291	the write buffer before it is fully drained, but this is a rare case, as	395	the write buffer before it is fully drained, but this is a rare case, as
292	the operating system kernel usually buffers data as well, so the default	396	the operating system kernel usually buffers data as well, so the default
293	is good in almost all cases.	397	is good in almost all cases.
294		398
295	=item linger => <seconds>	399	=item linger => <seconds>
296		400
297	If non-zero (default: C<3600>), then the destructor of the	401	If this is non-zero (default: C<3600>), the destructor of the
298	AnyEvent::Handle object will check whether there is still outstanding	402	AnyEvent::Handle object will check whether there is still outstanding
299	write data and will install a watcher that will write this data to the	403	write data and will install a watcher that will write this data to the
300	socket. No errors will be reported (this mostly matches how the operating	404	socket. No errors will be reported (this mostly matches how the operating
301	system treats outstanding data at socket close time).	405	system treats outstanding data at socket close time).
302		406
…		…
309	A string used to identify the remote site - usually the DNS hostname	413	A string used to identify the remote site - usually the DNS hostname
310	(I<not> IDN!) used to create the connection, rarely the IP address.	414	(I<not> IDN!) used to create the connection, rarely the IP address.
311		415
312	Apart from being useful in error messages, this string is also used in TLS	416	Apart from being useful in error messages, this string is also used in TLS
313	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	417	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
314	verification will be skipped when C<peername> is not specified or	418	verification will be skipped when C<peername> is not specified or is
315	C<undef>.	419	C<undef>.
316		420
317	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	421	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
318		422
319	When this parameter is given, it enables TLS (SSL) mode, that means	423	When this parameter is given, it enables TLS (SSL) mode, that means
320	AnyEvent will start a TLS handshake as soon as the conenction has been	424	AnyEvent will start a TLS handshake as soon as the connection has been
321	established and will transparently encrypt/decrypt data afterwards.	425	established and will transparently encrypt/decrypt data afterwards.
322		426
323	All TLS protocol errors will be signalled as C<EPROTO>, with an	427	All TLS protocol errors will be signalled as C<EPROTO>, with an
324	appropriate error message.	428	appropriate error message.
325		429
326	TLS mode requires Net::SSLeay to be installed (it will be loaded	430	TLS mode requires Net::SSLeay to be installed (it will be loaded
327	automatically when you try to create a TLS handle): this module doesn't	431	automatically when you try to create a TLS handle): this module doesn't
328	have a dependency on that module, so if your module requires it, you have	432	have a dependency on that module, so if your module requires it, you have
329	to add the dependency yourself.	433	to add the dependency yourself. If Net::SSLeay cannot be loaded or is too
		434	old, you get an C<EPROTO> error.
330		435
331	Unlike TCP, TLS has a server and client side: for the TLS server side, use	436	Unlike TCP, TLS has a server and client side: for the TLS server side, use
332	C<accept>, and for the TLS client side of a connection, use C<connect>	437	C<accept>, and for the TLS client side of a connection, use C<connect>
333	mode.	438	mode.
334		439
…		…
345	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	450	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
346	passing in the wrong integer will lead to certain crash. This most often	451	passing in the wrong integer will lead to certain crash. This most often
347	happens when one uses a stylish C<< tls => 1 >> and is surprised about the	452	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
348	segmentation fault.	453	segmentation fault.
349		454
350	See the C<< ->starttls >> method for when need to start TLS negotiation later.	455	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
351		456
352	=item tls_ctx => $anyevent_tls	457	=item tls_ctx => $anyevent_tls
353		458
354	Use the given C<AnyEvent::TLS> object to create the new TLS connection	459	Use the given C<AnyEvent::TLS> object to create the new TLS connection
355	(unless a connection object was specified directly). If this parameter is	460	(unless a connection object was specified directly). If this
356	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	461	parameter is missing (or C<undef>), then AnyEvent::Handle will use
		462	C<AnyEvent::Handle::TLS_CTX>.
357		463
358	Instead of an object, you can also specify a hash reference with C<< key	464	Instead of an object, you can also specify a hash reference with C<< key
359	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	465	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
360	new TLS context object.	466	new TLS context object.
361		467
…		…
370		476
371	TLS handshake failures will not cause C<on_error> to be invoked when this	477	TLS handshake failures will not cause C<on_error> to be invoked when this
372	callback is in effect, instead, the error message will be passed to C<on_starttls>.	478	callback is in effect, instead, the error message will be passed to C<on_starttls>.
373		479
374	Without this callback, handshake failures lead to C<on_error> being	480	Without this callback, handshake failures lead to C<on_error> being
375	called, as normal.	481	called as usual.
376		482
377	Note that you cannot call C<starttls> right again in this callback. If you	483	Note that you cannot just call C<starttls> again in this callback. If you
378	need to do that, start an zero-second timer instead whose callback can	484	need to do that, start an zero-second timer instead whose callback can
379	then call C<< ->starttls >> again.	485	then call C<< ->starttls >> again.
380		486
381	=item on_stoptls => $cb->($handle)	487	=item on_stoptls => $cb->($handle)
382		488
…		…
389	callback.	495	callback.
390		496
391	This callback will only be called on TLS shutdowns, not when the	497	This callback will only be called on TLS shutdowns, not when the
392	underlying handle signals EOF.	498	underlying handle signals EOF.
393		499
394	=item json => JSON or JSON::XS object	500	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
395		501
396	This is the json coder object used by the C<json> read and write types.	502	This is the json coder object used by the C<json> read and write types.
397		503
398	If you don't supply it, then AnyEvent::Handle will create and use a	504	If you don't supply it, then AnyEvent::Handle will create and use a
399	suitable one (on demand), which will write and expect UTF-8 encoded JSON	505	suitable one (on demand), which will write and expect UTF-8 encoded
		506	JSON texts (either using L<JSON::XS> or L<JSON>). The written texts are
		507	guaranteed not to contain any newline character.
		508
		509	For security reasons, this encoder will likely I<not> handle numbers and
		510	strings, only arrays and objects/hashes. The reason is that originally
		511	JSON was self-delimited, but Dougles Crockford thought it was a splendid
		512	idea to redefine JSON incompatibly, so this is no longer true.
		513
		514	For protocols that used back-to-back JSON texts, this might lead to
		515	run-ins, where two or more JSON texts will be interpreted as one JSON
400	texts.	516	text.
401		517
		518	For this reason, if the default encoder uses L<JSON::XS>, it will default
		519	to not allowing anything but arrays and objects/hashes, at least for the
		520	forseeable future (it will change at some point). This might or might not
		521	be true for the L<JSON> module, so this might cause a security issue.
		522
		523	If you depend on either behaviour, you should create your own json object
		524	and pass it in explicitly.
		525
		526	=item cbor => L<CBOR::XS> object
		527
		528	This is the cbor coder object used by the C<cbor> read and write types.
		529
		530	If you don't supply it, then AnyEvent::Handle will create and use a
		531	suitable one (on demand), which will write CBOR without using extensions,
		532	if possible.
		533
402	Note that you are responsible to depend on the JSON module if you want to	534	Note that you are responsible to depend on the L<CBOR::XS> module if you
403	use this functionality, as AnyEvent does not have a dependency itself.	535	want to use this functionality, as AnyEvent does not have a dependency on
		536	it itself.
404		537
405	=back	538	=back
406		539
407	=cut	540	=cut
408		541
…		…
430	$self->{connect}[0],	563	$self->{connect}[0],
431	$self->{connect}[1],	564	$self->{connect}[1],
432	sub {	565	sub {
433	my ($fh, $host, $port, $retry) = @_;	566	my ($fh, $host, $port, $retry) = @_;
434		567
		568	delete $self->{_connect}; # no longer needed
		569
435	if ($fh) {	570	if ($fh) {
436	$self->{fh} = $fh;	571	$self->{fh} = $fh;
437		572
438	delete $self->{_skip_drain_rbuf};	573	delete $self->{_skip_drain_rbuf};
439	$self->_start;	574	$self->_start;
440		575
441	$self->{on_connect}	576	$self->{on_connect}
442	and $self->{on_connect}($self, $host, $port, sub {	577	and $self->{on_connect}($self, $host, $port, sub {
443	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};	578	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
444	$self->{_skip_drain_rbuf} = 1;	579	$self->{_skip_drain_rbuf} = 1;
445	&$retry;	580	&$retry;
446	});	581	});
447		582
448	} else {	583	} else {
449	if ($self->{on_connect_error}) {	584	if ($self->{on_connect_error}) {
450	$self->{on_connect_error}($self, "$!");	585	$self->{on_connect_error}($self, "$!");
451	$self->destroy;	586	$self->destroy if $self;
452	} else {	587	} else {
453	$self->_error ($!, 1);	588	$self->_error ($!, 1);
454	}	589	}
455	}	590	}
456	},	591	},
457	sub {	592	sub {
458	local $self->{fh} = $_[0];	593	local $self->{fh} = $_[0];
459		594
460	$self->{on_prepare}	595	$self->{on_prepare}
461	? $self->{on_prepare}->($self)	596	? $self->{on_prepare}->($self)
462	: ()	597	: ()
463	}	598	}
464	);	599	);
465	}	600	}
466		601
…		…
472	}	607	}
473		608
474	sub _start {	609	sub _start {
475	my ($self) = @_;	610	my ($self) = @_;
476		611
		612	# too many clueless people try to use udp and similar sockets
		613	# with AnyEvent::Handle, do them a favour.
		614	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		615	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		616	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
		617
477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	618	AnyEvent::fh_unblock $self->{fh};
478		619
		620	$self->{_activity} =
		621	$self->{_ractivity} =
479	$self->{_activity} = AnyEvent->now;	622	$self->{_wactivity} = AE::now;
480	$self->_timeout;
481		623
		624	$self->{read_size} ||= 2048;
		625	$self->{max_read_size} = $self->{read_size}
		626	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		627
		628	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		629	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		630	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		631
482	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	632	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		633	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
483		634
		635	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		636
484	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	637	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
485	if $self->{tls};	638	if $self->{tls};
486		639
487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	640	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
488		641
489	$self->start_read	642	$self->start_read
490	if $self->{on_read} || @{ $self->{_queue} };	643	if $self->{on_read} || @{ $self->{_queue} };
491		644
492	$self->_drain_wbuf;	645	$self->_drain_wbuf;
493	}	646	}
494
495	#sub _shutdown {
496	# my ($self) = @_;
497	#
498	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
499	# $self->{_eof} = 1; # tell starttls et. al to stop trying
500	#
501	# &_freetls;
502	#}
503		647
504	sub _error {	648	sub _error {
505	my ($self, $errno, $fatal, $message) = @_;	649	my ($self, $errno, $fatal, $message) = @_;
506		650
507	$! = $errno;	651	$! = $errno;
508	$message ||= "$!";	652	$message ||= "$!";
509		653
510	if ($self->{on_error}) {	654	if ($self->{on_error}) {
511	$self->{on_error}($self, $fatal, $message);	655	$self->{on_error}($self, $fatal, $message);
512	$self->destroy if $fatal;	656	$self->destroy if $fatal;
513	} elsif ($self->{fh}) {	657	} elsif ($self->{fh} || $self->{connect}) {
514	$self->destroy;	658	$self->destroy;
515	Carp::croak "AnyEvent::Handle uncaught error: $message";	659	Carp::croak "AnyEvent::Handle uncaught error: $message";
516	}	660	}
517	}	661	}
518		662
…		…
544	$_[0]{on_eof} = $_[1];	688	$_[0]{on_eof} = $_[1];
545	}	689	}
546		690
547	=item $handle->on_timeout ($cb)	691	=item $handle->on_timeout ($cb)
548		692
549	Replace the current C<on_timeout> callback, or disables the callback (but	693	=item $handle->on_rtimeout ($cb)
550	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
551	argument and method.
552		694
553	=cut	695	=item $handle->on_wtimeout ($cb)
554		696
555	sub on_timeout {	697	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
556	$_[0]{on_timeout} = $_[1];	698	callback, or disables the callback (but not the timeout) if C<$cb> =
557	}	699	C<undef>. See the C<timeout> constructor argument and method.
		700
		701	=cut
		702
		703	# see below
558		704
559	=item $handle->autocork ($boolean)	705	=item $handle->autocork ($boolean)
560		706
561	Enables or disables the current autocork behaviour (see C<autocork>	707	Enables or disables the current autocork behaviour (see C<autocork>
562	constructor argument). Changes will only take effect on the next write.	708	constructor argument). Changes will only take effect on the next write.
…		…
575	=cut	721	=cut
576		722
577	sub no_delay {	723	sub no_delay {
578	$_[0]{no_delay} = $_[1];	724	$_[0]{no_delay} = $_[1];
579		725
		726	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		727	if $_[0]{fh};
		728	}
		729
		730	=item $handle->keepalive ($boolean)
		731
		732	Enables or disables the C<keepalive> setting (see constructor argument of
		733	the same name for details).
		734
		735	=cut
		736
		737	sub keepalive {
		738	$_[0]{keepalive} = $_[1];
		739
580	eval {	740	eval {
581	local $SIG{__DIE__};	741	local $SIG{__DIE__};
582	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	742	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
583	if $_[0]{fh};	743	if $_[0]{fh};
584	};	744	};
585	}	745	}
586		746
		747	=item $handle->oobinline ($boolean)
		748
		749	Enables or disables the C<oobinline> setting (see constructor argument of
		750	the same name for details).
		751
		752	=cut
		753
		754	sub oobinline {
		755	$_[0]{oobinline} = $_[1];
		756
		757	eval {
		758	local $SIG{__DIE__};
		759	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		760	if $_[0]{fh};
		761	};
		762	}
		763
		764	=item $handle->keepalive ($boolean)
		765
		766	Enables or disables the C<keepalive> setting (see constructor argument of
		767	the same name for details).
		768
		769	=cut
		770
		771	sub keepalive {
		772	$_[0]{keepalive} = $_[1];
		773
		774	eval {
		775	local $SIG{__DIE__};
		776	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		777	if $_[0]{fh};
		778	};
		779	}
		780
587	=item $handle->on_starttls ($cb)	781	=item $handle->on_starttls ($cb)
588		782
589	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).	783	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
590		784
591	=cut	785	=cut
…		…
598		792
599	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	793	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
600		794
601	=cut	795	=cut
602		796
603	sub on_starttls {	797	sub on_stoptls {
604	$_[0]{on_stoptls} = $_[1];	798	$_[0]{on_stoptls} = $_[1];
605	}	799	}
606		800
		801	=item $handle->rbuf_max ($max_octets)
		802
		803	Configures the C<rbuf_max> setting (C<undef> disables it).
		804
		805	=item $handle->wbuf_max ($max_octets)
		806
		807	Configures the C<wbuf_max> setting (C<undef> disables it).
		808
		809	=cut
		810
		811	sub rbuf_max {
		812	$_[0]{rbuf_max} = $_[1];
		813	}
		814
		815	sub wbuf_max {
		816	$_[0]{wbuf_max} = $_[1];
		817	}
		818
607	#############################################################################	819	#############################################################################
608		820
609	=item $handle->timeout ($seconds)	821	=item $handle->timeout ($seconds)
610		822
		823	=item $handle->rtimeout ($seconds)
		824
		825	=item $handle->wtimeout ($seconds)
		826
611	Configures (or disables) the inactivity timeout.	827	Configures (or disables) the inactivity timeout.
612		828
613	=cut	829	The timeout will be checked instantly, so this method might destroy the
		830	handle before it returns.
614		831
615	sub timeout {	832	=item $handle->timeout_reset
		833
		834	=item $handle->rtimeout_reset
		835
		836	=item $handle->wtimeout_reset
		837
		838	Reset the activity timeout, as if data was received or sent.
		839
		840	These methods are cheap to call.
		841
		842	=cut
		843
		844	for my $dir ("", "r", "w") {
		845	my $timeout = "${dir}timeout";
		846	my $tw = "_${dir}tw";
		847	my $on_timeout = "on_${dir}timeout";
		848	my $activity = "_${dir}activity";
		849	my $cb;
		850
		851	*$on_timeout = sub {
		852	$_[0]{$on_timeout} = $_[1];
		853	};
		854
		855	*$timeout = sub {
616	my ($self, $timeout) = @_;	856	my ($self, $new_value) = @_;
617		857
		858	$new_value >= 0
		859	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		860
618	$self->{timeout} = $timeout;	861	$self->{$timeout} = $new_value;
619	$self->_timeout;	862	delete $self->{$tw}; &$cb;
620	}	863	};
621		864
		865	*{"${dir}timeout_reset"} = sub {
		866	$_[0]{$activity} = AE::now;
		867	};
		868
		869	# main workhorse:
622	# reset the timeout watcher, as neccessary	870	# reset the timeout watcher, as neccessary
623	# also check for time-outs	871	# also check for time-outs
624	sub _timeout {	872	$cb = sub {
625	my ($self) = @_;	873	my ($self) = @_;
626		874
627	if ($self->{timeout} && $self->{fh}) {	875	if ($self->{$timeout} && $self->{fh}) {
628	my $NOW = AnyEvent->now;	876	my $NOW = AE::now;
629		877
630	# when would the timeout trigger?	878	# when would the timeout trigger?
631	my $after = $self->{_activity} + $self->{timeout} - $NOW;	879	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
632		880
633	# now or in the past already?	881	# now or in the past already?
634	if ($after <= 0) {	882	if ($after <= 0) {
635	$self->{_activity} = $NOW;	883	$self->{$activity} = $NOW;
636		884
637	if ($self->{on_timeout}) {	885	if ($self->{$on_timeout}) {
638	$self->{on_timeout}($self);	886	$self->{$on_timeout}($self);
639	} else {	887	} else {
640	$self->_error (Errno::ETIMEDOUT);	888	$self->_error (Errno::ETIMEDOUT);
		889	}
		890
		891	# callback could have changed timeout value, optimise
		892	return unless $self->{$timeout};
		893
		894	# calculate new after
		895	$after = $self->{$timeout};
641	}	896	}
642		897
643	# callback could have changed timeout value, optimise	898	Scalar::Util::weaken $self;
644	return unless $self->{timeout};	899	return unless $self; # ->error could have destroyed $self
645		900
646	# calculate new after	901	$self->{$tw} ||= AE::timer $after, 0, sub {
647	$after = $self->{timeout};	902	delete $self->{$tw};
		903	$cb->($self);
		904	};
		905	} else {
		906	delete $self->{$tw};
648	}	907	}
649
650	Scalar::Util::weaken $self;
651	return unless $self; # ->error could have destroyed $self
652
653	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
654	delete $self->{_tw};
655	$self->_timeout;
656	});
657	} else {
658	delete $self->{_tw};
659	}	908	}
660	}	909	}
661		910
662	#############################################################################	911	#############################################################################
663		912
…		…
670		919
671	The write queue is very simple: you can add data to its end, and	920	The write queue is very simple: you can add data to its end, and
672	AnyEvent::Handle will automatically try to get rid of it for you.	921	AnyEvent::Handle will automatically try to get rid of it for you.
673		922
674	When data could be written and the write buffer is shorter then the low	923	When data could be written and the write buffer is shorter then the low
675	water mark, the C<on_drain> callback will be invoked.	924	water mark, the C<on_drain> callback will be invoked once.
676		925
677	=over 4	926	=over 4
678		927
679	=item $handle->on_drain ($cb)	928	=item $handle->on_drain ($cb)
680		929
681	Sets the C<on_drain> callback or clears it (see the description of	930	Sets the C<on_drain> callback or clears it (see the description of
682	C<on_drain> in the constructor).	931	C<on_drain> in the constructor).
683		932
		933	This method may invoke callbacks (and therefore the handle might be
		934	destroyed after it returns).
		935
684	=cut	936	=cut
685		937
686	sub on_drain {	938	sub on_drain {
687	my ($self, $cb) = @_;	939	my ($self, $cb) = @_;
688		940
…		…
692	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});	944	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
693	}	945	}
694		946
695	=item $handle->push_write ($data)	947	=item $handle->push_write ($data)
696		948
697	Queues the given scalar to be written. You can push as much data as you	949	Queues the given scalar to be written. You can push as much data as
698	want (only limited by the available memory), as C<AnyEvent::Handle>	950	you want (only limited by the available memory and C<wbuf_max>), as
699	buffers it independently of the kernel.	951	C<AnyEvent::Handle> buffers it independently of the kernel.
		952
		953	This method may invoke callbacks (and therefore the handle might be
		954	destroyed after it returns).
700		955
701	=cut	956	=cut
702		957
703	sub _drain_wbuf {	958	sub _drain_wbuf {
704	my ($self) = @_;	959	my ($self) = @_;
…		…
711	my $len = syswrite $self->{fh}, $self->{wbuf};	966	my $len = syswrite $self->{fh}, $self->{wbuf};
712		967
713	if (defined $len) {	968	if (defined $len) {
714	substr $self->{wbuf}, 0, $len, "";	969	substr $self->{wbuf}, 0, $len, "";
715		970
716	$self->{_activity} = AnyEvent->now;	971	$self->{_activity} = $self->{_wactivity} = AE::now;
717		972
718	$self->{on_drain}($self)	973	$self->{on_drain}($self)
719	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	974	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
720	&& $self->{on_drain};	975	&& $self->{on_drain};
721		976
722	delete $self->{_ww} unless length $self->{wbuf};	977	delete $self->{_ww} unless length $self->{wbuf};
723	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	978	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
724	$self->_error ($!, 1);	979	$self->_error ($!, 1);
725	}	980	}
726	};	981	};
727		982
728	# try to write data immediately	983	# try to write data immediately
729	$cb->() unless $self->{autocork};	984	$cb->() unless $self->{autocork};
730		985
731	# if still data left in wbuf, we need to poll	986	# if still data left in wbuf, we need to poll
732	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	987	$self->{_ww} = AE::io $self->{fh}, 1, $cb
733	if length $self->{wbuf};	988	if length $self->{wbuf};
		989
		990	if (
		991	defined $self->{wbuf_max}
		992	&& $self->{wbuf_max} < length $self->{wbuf}
		993	) {
		994	$self->_error (Errno::ENOSPC, 1), return;
		995	}
734	};	996	};
735	}	997	}
736		998
737	our %WH;	999	our %WH;
738		1000
		1001	# deprecated
739	sub register_write_type($$) {	1002	sub register_write_type($$) {
740	$WH{$_[0]} = $_[1];	1003	$WH{$_[0]} = $_[1];
741	}	1004	}
742		1005
743	sub push_write {	1006	sub push_write {
744	my $self = shift;	1007	my $self = shift;
745		1008
746	if (@_ > 1) {	1009	if (@_ > 1) {
747	my $type = shift;	1010	my $type = shift;
748		1011
		1012	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
749	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	1013	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
750	->($self, @_);	1014	->($self, @_);
751	}	1015	}
752		1016
		1017	# we downgrade here to avoid hard-to-track-down bugs,
		1018	# and diagnose the problem earlier and better.
		1019
753	if ($self->{tls}) {	1020	if ($self->{tls}) {
754	$self->{_tls_wbuf} .= $_[0];	1021	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
755	&_dotls ($self) if $self->{fh};	1022	&_dotls ($self) if $self->{fh};
756	} else {	1023	} else {
757	$self->{wbuf} .= $_[0];	1024	utf8::downgrade $self->{wbuf} .= $_[0];
758	$self->_drain_wbuf if $self->{fh};	1025	$self->_drain_wbuf if $self->{fh};
759	}	1026	}
760	}	1027	}
761		1028
762	=item $handle->push_write (type => @args)	1029	=item $handle->push_write (type => @args)
763		1030
764	Instead of formatting your data yourself, you can also let this module do	1031	Instead of formatting your data yourself, you can also let this module
765	the job by specifying a type and type-specific arguments.	1032	do the job by specifying a type and type-specific arguments. You
		1033	can also specify the (fully qualified) name of a package, in which
		1034	case AnyEvent tries to load the package and then expects to find the
		1035	C<anyevent_write_type> function inside (see "custom write types", below).
766		1036
767	Predefined types are (if you have ideas for additional types, feel free to	1037	Predefined types are (if you have ideas for additional types, feel free to
768	drop by and tell us):	1038	drop by and tell us):
769		1039
770	=over 4	1040	=over 4
…		…
801		1071
802	Encodes the given hash or array reference into a JSON object. Unless you	1072	Encodes the given hash or array reference into a JSON object. Unless you
803	provide your own JSON object, this means it will be encoded to JSON text	1073	provide your own JSON object, this means it will be encoded to JSON text
804	in UTF-8.	1074	in UTF-8.
805		1075
		1076	The default encoder might or might not handle every type of JSON value -
		1077	it might be limited to arrays and objects for security reasons. See the
		1078	C<json> constructor attribute for more details.
		1079
806	JSON objects (and arrays) are self-delimiting, so you can write JSON at	1080	JSON objects (and arrays) are self-delimiting, so if you only use arrays
807	one end of a handle and read them at the other end without using any	1081	and hashes, you can write JSON at one end of a handle and read them at the
808	additional framing.	1082	other end without using any additional framing.
809		1083
810	The generated JSON text is guaranteed not to contain any newlines: While	1084	The JSON text generated by the default encoder is guaranteed not to
811	this module doesn't need delimiters after or between JSON texts to be	1085	contain any newlines: While this module doesn't need delimiters after or
812	able to read them, many other languages depend on that.	1086	between JSON texts to be able to read them, many other languages depend on
		1087	them.
813		1088
814	A simple RPC protocol that interoperates easily with others is to send	1089	A simple RPC protocol that interoperates easily with other languages is
815	JSON arrays (or objects, although arrays are usually the better choice as	1090	to send JSON arrays (or objects, although arrays are usually the better
816	they mimic how function argument passing works) and a newline after each	1091	choice as they mimic how function argument passing works) and a newline
817	JSON text:	1092	after each JSON text:
818		1093
819	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1094	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
820	$handle->push_write ("\012");	1095	$handle->push_write ("\012");
821		1096
822	An AnyEvent::Handle receiver would simply use the C<json> read type and	1097	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
825	$handle->push_read (json => sub { my $array = $_[1]; ... });	1100	$handle->push_read (json => sub { my $array = $_[1]; ... });
826		1101
827	Other languages could read single lines terminated by a newline and pass	1102	Other languages could read single lines terminated by a newline and pass
828	this line into their JSON decoder of choice.	1103	this line into their JSON decoder of choice.
829		1104
		1105	=item cbor => $perl_scalar
		1106
		1107	Encodes the given scalar into a CBOR value. Unless you provide your own
		1108	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1109	using any extensions, if possible.
		1110
		1111	CBOR values are self-delimiting, so you can write CBOR at one end of
		1112	a handle and read them at the other end without using any additional
		1113	framing.
		1114
		1115	A simple nd very very fast RPC protocol that interoperates with
		1116	other languages is to send CBOR and receive CBOR values (arrays are
		1117	recommended):
		1118
		1119	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1120
		1121	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1122
		1123	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1124
830	=cut	1125	=cut
		1126
		1127	sub json_coder() {
		1128	eval { require JSON::XS; JSON::XS->new->utf8 }
		1129	|| do { require JSON::PP; JSON::PP->new->utf8 }
		1130	}
831		1131
832	register_write_type json => sub {	1132	register_write_type json => sub {
833	my ($self, $ref) = @_;	1133	my ($self, $ref) = @_;
834		1134
835	require JSON;	1135	($self->{json} ||= json_coder)
		1136	->encode ($ref)
		1137	};
836		1138
837	$self->{json} ? $self->{json}->encode ($ref)	1139	sub cbor_coder() {
838	: JSON::encode_json ($ref)	1140	require CBOR::XS;
		1141	CBOR::XS->new
		1142	}
		1143
		1144	register_write_type cbor => sub {
		1145	my ($self, $scalar) = @_;
		1146
		1147	($self->{cbor} ||= cbor_coder)
		1148	->encode ($scalar)
839	};	1149	};
840		1150
841	=item storable => $reference	1151	=item storable => $reference
842		1152
843	Freezes the given reference using L<Storable> and writes it to the	1153	Freezes the given reference using L<Storable> and writes it to the
…		…
846	=cut	1156	=cut
847		1157
848	register_write_type storable => sub {	1158	register_write_type storable => sub {
849	my ($self, $ref) = @_;	1159	my ($self, $ref) = @_;
850		1160
851	require Storable;	1161	require Storable unless $Storable::VERSION;
852		1162
853	pack "w/a*", Storable::nfreeze ($ref)	1163	pack "w/a*", Storable::nfreeze ($ref)
854	};	1164	};
855		1165
856	=back	1166	=back
…		…
861	before it was actually written. One way to do that is to replace your	1171	before it was actually written. One way to do that is to replace your
862	C<on_drain> handler by a callback that shuts down the socket (and set	1172	C<on_drain> handler by a callback that shuts down the socket (and set
863	C<low_water_mark> to C<0>). This method is a shorthand for just that, and	1173	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
864	replaces the C<on_drain> callback with:	1174	replaces the C<on_drain> callback with:
865		1175
866	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1176	sub { shutdown $_[0]{fh}, 1 }
867		1177
868	This simply shuts down the write side and signals an EOF condition to the	1178	This simply shuts down the write side and signals an EOF condition to the
869	the peer.	1179	the peer.
870		1180
871	You can rely on the normal read queue and C<on_eof> handling	1181	You can rely on the normal read queue and C<on_eof> handling
872	afterwards. This is the cleanest way to close a connection.	1182	afterwards. This is the cleanest way to close a connection.
873		1183
		1184	This method may invoke callbacks (and therefore the handle might be
		1185	destroyed after it returns).
		1186
874	=cut	1187	=cut
875		1188
876	sub push_shutdown {	1189	sub push_shutdown {
877	my ($self) = @_;	1190	my ($self) = @_;
878		1191
879	delete $self->{low_water_mark};	1192	delete $self->{low_water_mark};
880	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1193	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
881	}	1194	}
882		1195
883	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1196	=item custom write types - Package::anyevent_write_type $handle, @args
884		1197
885	This function (not method) lets you add your own types to C<push_write>.	1198	Instead of one of the predefined types, you can also specify the name of
		1199	a package. AnyEvent will try to load the package and then expects to find
		1200	a function named C<anyevent_write_type> inside. If it isn't found, it
		1201	progressively tries to load the parent package until it either finds the
		1202	function (good) or runs out of packages (bad).
		1203
886	Whenever the given C<type> is used, C<push_write> will invoke the code	1204	Whenever the given C<type> is used, C<push_write> will the function with
887	reference with the handle object and the remaining arguments.	1205	the handle object and the remaining arguments.
888		1206
889	The code reference is supposed to return a single octet string that will	1207	The function is supposed to return a single octet string that will be
890	be appended to the write buffer.	1208	appended to the write buffer, so you can mentally treat this function as a
		1209	"arguments to on-the-wire-format" converter.
891		1210
892	Note that this is a function, and all types registered this way will be	1211	Example: implement a custom write type C<join> that joins the remaining
893	global, so try to use unique names.	1212	arguments using the first one.
		1213
		1214	$handle->push_write (My::Type => " ", 1,2,3);
		1215
		1216	# uses the following package, which can be defined in the "My::Type" or in
		1217	# the "My" modules to be auto-loaded, or just about anywhere when the
		1218	# My::Type::anyevent_write_type is defined before invoking it.
		1219
		1220	package My::Type;
		1221
		1222	sub anyevent_write_type {
		1223	my ($handle, $delim, @args) = @_;
		1224
		1225	join $delim, @args
		1226	}
894		1227
895	=cut	1228	=cut
896		1229
897	#############################################################################	1230	#############################################################################
898		1231
…		…
907	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1240	ways, the "simple" way, using only C<on_read> and the "complex" way, using
908	a queue.	1241	a queue.
909		1242
910	In the simple case, you just install an C<on_read> callback and whenever	1243	In the simple case, you just install an C<on_read> callback and whenever
911	new data arrives, it will be called. You can then remove some data (if	1244	new data arrives, it will be called. You can then remove some data (if
912	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1245	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
913	leave the data there if you want to accumulate more (e.g. when only a	1246	leave the data there if you want to accumulate more (e.g. when only a
914	partial message has been received so far).	1247	partial message has been received so far), or change the read queue with
		1248	e.g. C<push_read>.
915		1249
916	In the more complex case, you want to queue multiple callbacks. In this	1250	In the more complex case, you want to queue multiple callbacks. In this
917	case, AnyEvent::Handle will call the first queued callback each time new	1251	case, AnyEvent::Handle will call the first queued callback each time new
918	data arrives (also the first time it is queued) and removes it when it has	1252	data arrives (also the first time it is queued) and remove it when it has
919	done its job (see C<push_read>, below).	1253	done its job (see C<push_read>, below).
920		1254
921	This way you can, for example, push three line-reads, followed by reading	1255	This way you can, for example, push three line-reads, followed by reading
922	a chunk of data, and AnyEvent::Handle will execute them in order.	1256	a chunk of data, and AnyEvent::Handle will execute them in order.
923		1257
…		…
981		1315
982	sub _drain_rbuf {	1316	sub _drain_rbuf {
983	my ($self) = @_;	1317	my ($self) = @_;
984		1318
985	# avoid recursion	1319	# avoid recursion
986	return if exists $self->{_skip_drain_rbuf};	1320	return if $self->{_skip_drain_rbuf};
987	local $self->{_skip_drain_rbuf} = 1;	1321	local $self->{_skip_drain_rbuf} = 1;
988
989	if (
990	defined $self->{rbuf_max}
991	&& $self->{rbuf_max} < length $self->{rbuf}
992	) {
993	$self->_error (Errno::ENOSPC, 1), return;
994	}
995		1322
996	while () {	1323	while () {
997	# we need to use a separate tls read buffer, as we must not receive data while	1324	# we need to use a separate tls read buffer, as we must not receive data while
998	# we are draining the buffer, and this can only happen with TLS.	1325	# we are draining the buffer, and this can only happen with TLS.
999	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1326	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1327	if exists $self->{_tls_rbuf};
1000		1328
1001	my $len = length $self->{rbuf};	1329	my $len = length $self->{rbuf};
1002		1330
1003	if (my $cb = shift @{ $self->{_queue} }) {	1331	if (my $cb = shift @{ $self->{_queue} }) {
1004	unless ($cb->($self)) {	1332	unless ($cb->($self)) {
1005	if ($self->{_eof}) {	1333	# no progress can be made
1006	# no progress can be made (not enough data and no data forthcoming)	1334	# (not enough data and no data forthcoming)
1007	$self->_error (Errno::EPIPE, 1), return;	1335	$self->_error (Errno::EPIPE, 1), return
1008	}	1336	if $self->{_eof};
1009		1337
1010	unshift @{ $self->{_queue} }, $cb;	1338	unshift @{ $self->{_queue} }, $cb;
1011	last;	1339	last;
1012	}	1340	}
1013	} elsif ($self->{on_read}) {	1341	} elsif ($self->{on_read}) {
…		…
1033	last;	1361	last;
1034	}	1362	}
1035	}	1363	}
1036		1364
1037	if ($self->{_eof}) {	1365	if ($self->{_eof}) {
1038	if ($self->{on_eof}) {	1366	$self->{on_eof}
1039	$self->{on_eof}($self)	1367	? $self->{on_eof}($self)
1040	} else {
1041	$self->_error (0, 1, "Unexpected end-of-file");	1368	: $self->_error (0, 1, "Unexpected end-of-file");
1042	}	1369
		1370	return;
		1371	}
		1372
		1373	if (
		1374	defined $self->{rbuf_max}
		1375	&& $self->{rbuf_max} < length $self->{rbuf}
		1376	) {
		1377	$self->_error (Errno::ENOSPC, 1), return;
1043	}	1378	}
1044		1379
1045	# may need to restart read watcher	1380	# may need to restart read watcher
1046	unless ($self->{_rw}) {	1381	unless ($self->{_rw}) {
1047	$self->start_read	1382	$self->start_read
…		…
1053		1388
1054	This replaces the currently set C<on_read> callback, or clears it (when	1389	This replaces the currently set C<on_read> callback, or clears it (when
1055	the new callback is C<undef>). See the description of C<on_read> in the	1390	the new callback is C<undef>). See the description of C<on_read> in the
1056	constructor.	1391	constructor.
1057		1392
		1393	This method may invoke callbacks (and therefore the handle might be
		1394	destroyed after it returns).
		1395
1058	=cut	1396	=cut
1059		1397
1060	sub on_read {	1398	sub on_read {
1061	my ($self, $cb) = @_;	1399	my ($self, $cb) = @_;
1062		1400
…		…
1064	$self->_drain_rbuf if $cb;	1402	$self->_drain_rbuf if $cb;
1065	}	1403	}
1066		1404
1067	=item $handle->rbuf	1405	=item $handle->rbuf
1068		1406
1069	Returns the read buffer (as a modifiable lvalue).	1407	Returns the read buffer (as a modifiable lvalue). You can also access the
		1408	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1409	much faster, and no less clean).
1070		1410
1071	You can access the read buffer directly as the C<< ->{rbuf} >>	1411	The only operation allowed on the read buffer (apart from looking at it)
1072	member, if you want. However, the only operation allowed on the	1412	is removing data from its beginning. Otherwise modifying or appending to
1073	read buffer (apart from looking at it) is removing data from its	1413	it is not allowed and will lead to hard-to-track-down bugs.
1074	beginning. Otherwise modifying or appending to it is not allowed and will
1075	lead to hard-to-track-down bugs.
1076		1414
1077	NOTE: The read buffer should only be used or modified if the C<on_read>,	1415	NOTE: The read buffer should only be used or modified in the C<on_read>
1078	C<push_read> or C<unshift_read> methods are used. The other read methods	1416	callback or when C<push_read> or C<unshift_read> are used with a single
1079	automatically manage the read buffer.	1417	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1418	will manage the read buffer on their own.
1080		1419
1081	=cut	1420	=cut
1082		1421
1083	sub rbuf : lvalue {	1422	sub rbuf : lvalue {
1084	$_[0]{rbuf}	1423	$_[0]{rbuf}
…		…
1101		1440
1102	If enough data was available, then the callback must remove all data it is	1441	If enough data was available, then the callback must remove all data it is
1103	interested in (which can be none at all) and return a true value. After returning	1442	interested in (which can be none at all) and return a true value. After returning
1104	true, it will be removed from the queue.	1443	true, it will be removed from the queue.
1105		1444
		1445	These methods may invoke callbacks (and therefore the handle might be
		1446	destroyed after it returns).
		1447
1106	=cut	1448	=cut
1107		1449
1108	our %RH;	1450	our %RH;
1109		1451
1110	sub register_read_type($$) {	1452	sub register_read_type($$) {
…		…
1116	my $cb = pop;	1458	my $cb = pop;
1117		1459
1118	if (@_) {	1460	if (@_) {
1119	my $type = shift;	1461	my $type = shift;
1120		1462
		1463	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1121	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1464	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1122	->($self, $cb, @_);	1465	->($self, $cb, @_);
1123	}	1466	}
1124		1467
1125	push @{ $self->{_queue} }, $cb;	1468	push @{ $self->{_queue} }, $cb;
1126	$self->_drain_rbuf;	1469	$self->_drain_rbuf;
…		…
1131	my $cb = pop;	1474	my $cb = pop;
1132		1475
1133	if (@_) {	1476	if (@_) {
1134	my $type = shift;	1477	my $type = shift;
1135		1478
		1479	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1136	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1480	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1137	->($self, $cb, @_);	1481	->($self, $cb, @_);
1138	}	1482	}
1139
1140		1483
1141	unshift @{ $self->{_queue} }, $cb;	1484	unshift @{ $self->{_queue} }, $cb;
1142	$self->_drain_rbuf;	1485	$self->_drain_rbuf;
1143	}	1486	}
1144		1487
…		…
1146		1489
1147	=item $handle->unshift_read (type => @args, $cb)	1490	=item $handle->unshift_read (type => @args, $cb)
1148		1491
1149	Instead of providing a callback that parses the data itself you can chose	1492	Instead of providing a callback that parses the data itself you can chose
1150	between a number of predefined parsing formats, for chunks of data, lines	1493	between a number of predefined parsing formats, for chunks of data, lines
1151	etc.	1494	etc. You can also specify the (fully qualified) name of a package, in
		1495	which case AnyEvent tries to load the package and then expects to find the
		1496	C<anyevent_read_type> function inside (see "custom read types", below).
1152		1497
1153	Predefined types are (if you have ideas for additional types, feel free to	1498	Predefined types are (if you have ideas for additional types, feel free to
1154	drop by and tell us):	1499	drop by and tell us):
1155		1500
1156	=over 4	1501	=over 4
…		…
1162	data.	1507	data.
1163		1508
1164	Example: read 2 bytes.	1509	Example: read 2 bytes.
1165		1510
1166	$handle->push_read (chunk => 2, sub {	1511	$handle->push_read (chunk => 2, sub {
1167	warn "yay ", unpack "H*", $_[1];	1512	say "yay " . unpack "H*", $_[1];
1168	});	1513	});
1169		1514
1170	=cut	1515	=cut
1171		1516
1172	register_read_type chunk => sub {	1517	register_read_type chunk => sub {
…		…
1202		1547
1203	register_read_type line => sub {	1548	register_read_type line => sub {
1204	my ($self, $cb, $eol) = @_;	1549	my ($self, $cb, $eol) = @_;
1205		1550
1206	if (@_ < 3) {	1551	if (@_ < 3) {
1207	# this is more than twice as fast as the generic code below	1552	# this is faster then the generic code below
1208	sub {	1553	sub {
1209	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1554	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1555	or return;
1210		1556
		1557	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1211	$cb->($_[0], $1, $2);	1558	$cb->($_[0], $str, "$1");
1212	1	1559	1
1213	}	1560	}
1214	} else {	1561	} else {
1215	$eol = quotemeta $eol unless ref $eol;	1562	$eol = quotemeta $eol unless ref $eol;
1216	$eol = qr|^(.*?)($eol)|s;	1563	$eol = qr|^(.*?)($eol)|s;
1217		1564
1218	sub {	1565	sub {
1219	$_[0]{rbuf} =~ s/$eol// or return;	1566	$_[0]{rbuf} =~ s/$eol// or return;
1220		1567
1221	$cb->($_[0], $1, $2);	1568	$cb->($_[0], "$1", "$2");
1222	1	1569	1
1223	}	1570	}
1224	}	1571	}
1225	};	1572	};
1226		1573
1227	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1574	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
1228		1575
1229	Makes a regex match against the regex object C<$accept> and returns	1576	Makes a regex match against the regex object C<$accept> and returns
1230	everything up to and including the match.	1577	everything up to and including the match. All the usual regex variables
		1578	($1, %+ etc.) from the regex match are available in the callback.
1231		1579
1232	Example: read a single line terminated by '\n'.	1580	Example: read a single line terminated by '\n'.
1233		1581
1234	$handle->push_read (regex => qr<\n>, sub { ... });	1582	$handle->push_read (regex => qr<\n>, sub { ... });
1235		1583
…		…
1248	the receive buffer when neither C<$accept> nor C<$reject> match,	1596	the receive buffer when neither C<$accept> nor C<$reject> match,
1249	and everything preceding and including the match will be accepted	1597	and everything preceding and including the match will be accepted
1250	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
1251	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
1252	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
1253	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.
1254		1602
1255	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
1256	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
1257	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
1258	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
1259	required for the accept regex.	1607	required for the accept regex.
1260		1608
1261	$handle->push_read (regex =>	1609	$handle->push_read (regex =>
…		…
1274		1622
1275	sub {	1623	sub {
1276	# accept	1624	# accept
1277	if ($$rbuf =~ $accept) {	1625	if ($$rbuf =~ $accept) {
1278	$data .= substr $$rbuf, 0, $+[0], "";	1626	$data .= substr $$rbuf, 0, $+[0], "";
1279	$cb->($self, $data);	1627	$cb->($_[0], $data);
1280	return 1;	1628	return 1;
1281	}	1629	}
1282		1630
1283	# reject	1631	# reject
1284	if ($reject && $$rbuf =~ $reject) {	1632	if ($reject && $$rbuf =~ $reject) {
1285	$self->_error (Errno::EBADMSG);	1633	$_[0]->_error (Errno::EBADMSG);
1286	}	1634	}
1287		1635
1288	# skip	1636	# skip
1289	if ($skip && $$rbuf =~ $skip) {	1637	if ($skip && $$rbuf =~ $skip) {
1290	$data .= substr $$rbuf, 0, $+[0], "";	1638	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1306	my ($self, $cb) = @_;	1654	my ($self, $cb) = @_;
1307		1655
1308	sub {	1656	sub {
1309	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1657	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1310	if ($_[0]{rbuf} =~ /[^0-9]/) {	1658	if ($_[0]{rbuf} =~ /[^0-9]/) {
1311	$self->_error (Errno::EBADMSG);	1659	$_[0]->_error (Errno::EBADMSG);
1312	}	1660	}
1313	return;	1661	return;
1314	}	1662	}
1315		1663
1316	my $len = $1;	1664	my $len = $1;
1317		1665
1318	$self->unshift_read (chunk => $len, sub {	1666	$_[0]->unshift_read (chunk => $len, sub {
1319	my $string = $_[1];	1667	my $string = $_[1];
1320	$_[0]->unshift_read (chunk => 1, sub {	1668	$_[0]->unshift_read (chunk => 1, sub {
1321	if ($_[1] eq ",") {	1669	if ($_[1] eq ",") {
1322	$cb->($_[0], $string);	1670	$cb->($_[0], $string);
1323	} else {	1671	} else {
1324	$self->_error (Errno::EBADMSG);	1672	$_[0]->_error (Errno::EBADMSG);
1325	}	1673	}
1326	});	1674	});
1327	});	1675	});
1328		1676
1329	1	1677	1
…		…
1379	=item json => $cb->($handle, $hash_or_arrayref)	1727	=item json => $cb->($handle, $hash_or_arrayref)
1380		1728
1381	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
1382	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.
1383		1731
1384	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
1385	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.
1386		1735
1387	This read type uses the incremental parser available with JSON version	1736	This read type uses the incremental parser available with JSON version
1388	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.
1389	dependency on your own: this module will load the JSON module, but
1390	AnyEvent does not depend on it itself.
1391		1738
1392	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
1393	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
1394	the C<json> write type description, above, for an actual example.	1741	the C<json> write type description, above, for an actual example.
1395		1742
1396	=cut	1743	=cut
1397		1744
1398	register_read_type json => sub {	1745	register_read_type json => sub {
1399	my ($self, $cb) = @_;	1746	my ($self, $cb) = @_;
1400		1747
1401	my $json = $self->{json} ||=	1748	my $json = $self->{json} ||= json_coder;
1402	eval { require JSON::XS; JSON::XS->new->utf8 }
1403	|| do { require JSON; JSON->new->utf8 };
1404		1749
1405	my $data;	1750	my $data;
1406	my $rbuf = \$self->{rbuf};
1407		1751
1408	sub {	1752	sub {
1409	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1753	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1410		1754
1411	if ($ref) {	1755	if ($ref) {
1412	$self->{rbuf} = $json->incr_text;	1756	$_[0]{rbuf} = $json->incr_text;
1413	$json->incr_text = "";	1757	$json->incr_text = "";
1414	$cb->($self, $ref);	1758	$cb->($_[0], $ref);
1415		1759
1416	1	1760	1
1417	} elsif ($@) {	1761	} elsif ($@) {
1418	# error case	1762	# error case
1419	$json->incr_skip;	1763	$json->incr_skip;
1420		1764
1421	$self->{rbuf} = $json->incr_text;	1765	$_[0]{rbuf} = $json->incr_text;
1422	$json->incr_text = "";	1766	$json->incr_text = "";
1423		1767
1424	$self->_error (Errno::EBADMSG);	1768	$_[0]->_error (Errno::EBADMSG);
1425		1769
1426	()	1770	()
1427	} else {	1771	} else {
1428	$self->{rbuf} = "";	1772	$_[0]{rbuf} = "";
1429		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 {
1430	()	1820	()
1431	}	1821	}
1432	}	1822	}
1433	};	1823	};
1434		1824
…		…
1443	=cut	1833	=cut
1444		1834
1445	register_read_type storable => sub {	1835	register_read_type storable => sub {
1446	my ($self, $cb) = @_;	1836	my ($self, $cb) = @_;
1447		1837
1448	require Storable;	1838	require Storable unless $Storable::VERSION;
1449		1839
1450	sub {	1840	sub {
1451	# 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
1452	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1842	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1453	or return;	1843	or return;
…		…
1456		1846
1457	# bypass unshift if we already have the remaining chunk	1847	# bypass unshift if we already have the remaining chunk
1458	if ($format + $len <= length $_[0]{rbuf}) {	1848	if ($format + $len <= length $_[0]{rbuf}) {
1459	my $data = substr $_[0]{rbuf}, $format, $len;	1849	my $data = substr $_[0]{rbuf}, $format, $len;
1460	substr $_[0]{rbuf}, 0, $format + $len, "";	1850	substr $_[0]{rbuf}, 0, $format + $len, "";
		1851
1461	$cb->($_[0], Storable::thaw ($data));	1852	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1853	or return $_[0]->_error (Errno::EBADMSG);
1462	} else {	1854	} else {
1463	# remove prefix	1855	# remove prefix
1464	substr $_[0]{rbuf}, 0, $format, "";	1856	substr $_[0]{rbuf}, 0, $format, "";
1465		1857
1466	# read remaining chunk	1858	# read remaining chunk
1467	$_[0]->unshift_read (chunk => $len, sub {	1859	$_[0]->unshift_read (chunk => $len, sub {
1468	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1860	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1469	$cb->($_[0], $ref);
1470	} else {
1471	$self->_error (Errno::EBADMSG);	1861	or $_[0]->_error (Errno::EBADMSG);
1472	}
1473	});	1862	});
1474	}	1863	}
1475		1864
1476	1	1865	1
1477	}	1866	}
1478	};	1867	};
1479		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
1480	=back	1955	=back
1481		1956
1482	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1957	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1483		1958
1484	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).
1485		1964
1486	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
1487	reference with the handle object, the callback and the remaining	1966	handle object, the original callback and the remaining arguments.
1488	arguments.
1489		1967
1490	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
1491	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.
1492		1972
1493	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
1494	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).
1495		1976
1496	Note that this is a function, and all types registered this way will be
1497	global, so try to use unique names.
1498
1499	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
1500	search for C<register_read_type>)).	1978	AnyEvent::Handle>, search for C<register_read_type>)).
1501		1979
1502	=item $handle->stop_read	1980	=item $handle->stop_read
1503		1981
1504	=item $handle->start_read	1982	=item $handle->start_read
1505		1983
…		…
1511	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
1512	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
1513	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
1514	there are any read requests in the queue.	1992	there are any read requests in the queue.
1515		1993
1516	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,
1517	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.
1518		2005
1519	=cut	2006	=cut
1520		2007
1521	sub stop_read {	2008	sub stop_read {
1522	my ($self) = @_;	2009	my ($self) = @_;
1523		2010
1524	delete $self->{_rw} unless $self->{tls};	2011	delete $self->{_rw};
1525	}	2012	}
1526		2013
1527	sub start_read {	2014	sub start_read {
1528	my ($self) = @_;	2015	my ($self) = @_;
1529		2016
1530	unless ($self->{_rw} || $self->{_eof}) {	2017	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1531	Scalar::Util::weaken $self;	2018	Scalar::Util::weaken $self;
1532		2019
1533	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	2020	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1534	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	2021	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1535	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	2022	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1536		2023
1537	if ($len > 0) {	2024	if ($len > 0) {
1538	$self->{_activity} = AnyEvent->now;	2025	$self->{_activity} = $self->{_ractivity} = AE::now;
1539		2026
1540	if ($self->{tls}) {	2027	if ($self->{tls}) {
1541	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	2028	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1542		2029
1543	&_dotls ($self);	2030	&_dotls ($self);
1544	} else {	2031	} else {
1545	$self->_drain_rbuf;	2032	$self->_drain_rbuf;
1546	}	2033	}
1547		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);
		2039	}
		2040
1548	} elsif (defined $len) {	2041	} elsif (defined $len) {
1549	delete $self->{_rw};	2042	delete $self->{_rw};
1550	$self->{_eof} = 1;	2043	$self->{_eof} = 1;
1551	$self->_drain_rbuf;	2044	$self->_drain_rbuf;
1552		2045
1553	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2046	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
1554	return $self->_error ($!, 1);	2047	return $self->_error ($!, 1);
1555	}	2048	}
1556	});	2049	};
1557	}	2050	}
1558	}	2051	}
1559		2052
1560	our $ERROR_SYSCALL;	2053	our $ERROR_SYSCALL;
1561	our $ERROR_WANT_READ;	2054	our $ERROR_WANT_READ;
…		…
1564	my ($self, $err) = @_;	2057	my ($self, $err) = @_;
1565		2058
1566	return $self->_error ($!, 1)	2059	return $self->_error ($!, 1)
1567	if $err == Net::SSLeay::ERROR_SYSCALL ();	2060	if $err == Net::SSLeay::ERROR_SYSCALL ();
1568		2061
1569	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 ());
1570		2063
1571	# reduce error string to look less scary	2064	# reduce error string to look less scary
1572	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2065	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1573		2066
1574	if ($self->{_on_starttls}) {	2067	if ($self->{_on_starttls}) {
…		…
1588	sub _dotls {	2081	sub _dotls {
1589	my ($self) = @_;	2082	my ($self) = @_;
1590		2083
1591	my $tmp;	2084	my $tmp;
1592		2085
1593	if (length $self->{_tls_wbuf}) {	2086	while (length $self->{_tls_wbuf}) {
1594	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2087	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1595	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;
1596	}	2095	}
1597		2096
1598	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2097	substr $self->{_tls_wbuf}, 0, $tmp, "";
1599	return $self->_tls_error ($tmp)
1600	if $tmp != $ERROR_WANT_READ
1601	&& ($tmp != $ERROR_SYSCALL || $!);
1602	}	2098	}
1603		2099
1604	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2100	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1605	unless (length $tmp) {	2101	unless (length $tmp) {
1606	$self->{_on_starttls}	2102	$self->{_on_starttls}
…		…
1620	$self->{_tls_rbuf} .= $tmp;	2116	$self->{_tls_rbuf} .= $tmp;
1621	$self->_drain_rbuf;	2117	$self->_drain_rbuf;
1622	$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
1623	}	2119	}
1624		2120
1625	$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
1626	return $self->_tls_error ($tmp)	2122	return $self->_tls_error ($tmp)
1627	if $tmp != $ERROR_WANT_READ	2123	if $tmp != $ERROR_WANT_READ
1628	&& ($tmp != $ERROR_SYSCALL || $!);	2124	&& ($tmp != $ERROR_SYSCALL || $!);
1629		2125
1630	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2126	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1631	$self->{wbuf} .= $tmp;	2127	$self->{wbuf} .= $tmp;
1632	$self->_drain_wbuf;	2128	$self->_drain_wbuf;
		2129	$self->{tls} or return; # tls session might have gone away in callback
1633	}	2130	}
1634		2131
1635	$self->{_on_starttls}	2132	$self->{_on_starttls}
1636	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	2133	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1637	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	2134	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1639		2136
1640	=item $handle->starttls ($tls[, $tls_ctx])	2137	=item $handle->starttls ($tls[, $tls_ctx])
1641		2138
1642	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2139	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1643	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
1644	C<starttls>.	2141	C<starttls>. See the C<tls> constructor argument for general info.
1645		2142
1646	Starting TLS is currently an asynchronous operation - when you push some	2143	Starting TLS is currently an asynchronous operation - when you push some
1647	write data and then call C<< ->starttls >> then TLS negotiation will start	2144	write data and then call C<< ->starttls >> then TLS negotiation will start
1648	immediately, after which the queued write data is then sent.	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.
1649		2148
1650	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
1651	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2150	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1652		2151
1653	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
…		…
1659	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
1660	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
1661	when this function returns.	2160	when this function returns.
1662		2161
1663	Due to bugs in OpenSSL, it might or might not be possible to do multiple	2162	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1664	handshakes on the same stream. Best do not attempt to use the stream after	2163	handshakes on the same stream. It is best to not attempt to use the
1665	stopping TLS.	2164	stream after stopping TLS.
		2165
		2166	This method may invoke callbacks (and therefore the handle might be
		2167	destroyed after it returns).
1666		2168
1667	=cut	2169	=cut
1668		2170
1669	our %TLS_CACHE; #TODO not yet documented, should we?	2171	our %TLS_CACHE; #TODO not yet documented, should we?
1670		2172
…		…
1672	my ($self, $tls, $ctx) = @_;	2174	my ($self, $tls, $ctx) = @_;
1673		2175
1674	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2176	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1675	if $self->{tls};	2177	if $self->{tls};
1676		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
1677	$self->{tls} = $tls;	2187	$self->{tls} = $tls;
1678	$self->{tls_ctx} = $ctx if @_ > 2;	2188	$self->{tls_ctx} = $ctx if @_ > 2;
1679		2189
1680	return unless $self->{fh};	2190	return unless $self->{fh};
1681		2191
1682	require Net::SSLeay;
1683
1684	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2192	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1685	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2193	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1686		2194
1687	$tls = $self->{tls};	2195	$tls = delete $self->{tls};
1688	$ctx = $self->{tls_ctx};	2196	$ctx = $self->{tls_ctx};
1689		2197
1690	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2198	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1691		2199
1692	if ("HASH" eq ref $ctx) {	2200	if ("HASH" eq ref $ctx) {
1693	require AnyEvent::TLS;
1694
1695	if ($ctx->{cache}) {	2201	if ($ctx->{cache}) {
1696	my $key = $ctx+0;	2202	my $key = $ctx+0;
1697	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;	2203	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1698	} else {	2204	} else {
1699	$ctx = new AnyEvent::TLS %$ctx;	2205	$ctx = new AnyEvent::TLS %$ctx;
…		…
1721	Net::SSLeay::CTX_set_mode ($tls, 1|2);	2227	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1722		2228
1723	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2229	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1724	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2230	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1725		2231
		2232	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2233	$self->{rbuf} = "";
		2234
1726	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2235	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1727		2236
1728	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2237	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1729	if $self->{on_starttls};	2238	if $self->{on_starttls};
1730		2239
…		…
1734		2243
1735	=item $handle->stoptls	2244	=item $handle->stoptls
1736		2245
1737	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
1738	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
1739	support non-blocking shut downs, it is not guarenteed that you can re-use	2248	support non-blocking shut downs, it is not guaranteed that you can re-use
1740	the stream afterwards.	2249	the stream afterwards.
		2250
		2251	This method may invoke callbacks (and therefore the handle might be
		2252	destroyed after it returns).
1741		2253
1742	=cut	2254	=cut
1743		2255
1744	sub stoptls {	2256	sub stoptls {
1745	my ($self) = @_;	2257	my ($self) = @_;
1746		2258
1747	if ($self->{tls}) {	2259	if ($self->{tls} && $self->{fh}) {
1748	Net::SSLeay::shutdown ($self->{tls});	2260	Net::SSLeay::shutdown ($self->{tls});
1749		2261
1750	&_dotls;	2262	&_dotls;
1751		2263
1752	# # 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#
…		…
1759	my ($self) = @_;	2271	my ($self) = @_;
1760		2272
1761	return unless $self->{tls};	2273	return unless $self->{tls};
1762		2274
1763	$self->{tls_ctx}->_put_session (delete $self->{tls})	2275	$self->{tls_ctx}->_put_session (delete $self->{tls})
1764	if ref $self->{tls};	2276	if $self->{tls} > 0;
1765		2277
1766	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2278	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1767	}	2279	}
		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;
1768		2293
1769	sub DESTROY {	2294	sub DESTROY {
1770	my ($self) = @_;	2295	my ($self) = @_;
1771		2296
1772	&_freetls;	2297	&_freetls;
…		…
1777	my $fh = delete $self->{fh};	2302	my $fh = delete $self->{fh};
1778	my $wbuf = delete $self->{wbuf};	2303	my $wbuf = delete $self->{wbuf};
1779		2304
1780	my @linger;	2305	my @linger;
1781		2306
1782	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2307	push @linger, AE::io $fh, 1, sub {
1783	my $len = syswrite $fh, $wbuf, length $wbuf;	2308	my $len = syswrite $fh, $wbuf, length $wbuf;
1784		2309
1785	if ($len > 0) {	2310	if ($len > 0) {
1786	substr $wbuf, 0, $len, "";	2311	substr $wbuf, 0, $len, "";
1787	} else {	2312	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) {
1788	@linger = (); # end	2313	@linger = (); # end
1789	}	2314	}
1790	});	2315	};
1791	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2316	push @linger, AE::timer $linger, 0, sub {
1792	@linger = ();	2317	@linger = ();
1793	});	2318	};
1794	}	2319	}
1795	}	2320	}
1796		2321
1797	=item $handle->destroy	2322	=item $handle->destroy
1798		2323
1799	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
1800	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
1801	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).
1802		2329
1803	Normally, you can just "forget" any references to an AnyEvent::Handle	2330	Normally, you can just "forget" any references to an AnyEvent::Handle
1804	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
1805	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
1806	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
…		…
1820	sub destroy {	2347	sub destroy {
1821	my ($self) = @_;	2348	my ($self) = @_;
1822		2349
1823	$self->DESTROY;	2350	$self->DESTROY;
1824	%$self = ();	2351	%$self = ();
		2352	bless $self, "AnyEvent::Handle::destroyed";
1825	}	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 }
1826		2381
1827	=item AnyEvent::Handle::TLS_CTX	2382	=item AnyEvent::Handle::TLS_CTX
1828		2383
1829	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
1830	for TLS mode.	2385	for TLS mode.
…		…
1858		2413
1859	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,
1860	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<<
1861	->destroy >> method.	2416	->destroy >> method.
1862		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
1863	=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
1864	reading?	2499	reading?
1865		2500
1866	Unlike, say, TCP, TLS connections do not consist of two independent	2501	Unlike, say, TCP, TLS connections do not consist of two independent
1867	communication channels, one for each direction. Or put differently. The	2502	communication channels, one for each direction. Or put differently, the
1868	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
1869	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.
1870		2505
1871	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>
1872	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
1873	is that AnyEvent::Handle always reads in TLS mode.	2508	is that AnyEvent::Handle always reads in TLS mode.
1874		2509
1875	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
1876	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
…		…
1888	$handle->on_eof (undef);	2523	$handle->on_eof (undef);
1889	$handle->on_error (sub {	2524	$handle->on_error (sub {
1890	my $data = delete $_[0]{rbuf};	2525	my $data = delete $_[0]{rbuf};
1891	});	2526	});
1892		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
1893	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
1894	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
1895	fact, all data has been received.	2534	fact all data has been received.
1896		2535
1897	It is usually better to use acknowledgements when transferring data,	2536	It is usually better to use acknowledgements when transferring data,
1898	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
1899	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
1900	explicit QUIT command.	2539	explicit QUIT command.
…		…
1907	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
1908	written to the socket:	2547	written to the socket:
1909		2548
1910	$handle->push_write (...);	2549	$handle->push_write (...);
1911	$handle->on_drain (sub {	2550	$handle->on_drain (sub {
1912	warn "all data submitted to the kernel\n";	2551	AE::log debug => "All data submitted to the kernel.";
1913	undef $handle;	2552	undef $handle;
1914	});	2553	});
1915		2554
1916	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,
1917	consider using C<< ->push_shutdown >> instead.	2556	consider using C<< ->push_shutdown >> instead.
1918		2557
1919	=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.
1920		2559
1921	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,
1922	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>
1923	parameter:	2562	parameter:
1924		2563
1925	tcp_connect $host, $port, sub {	2564	tcp_connect $host, $port, sub {
1926	my ($fh) = @_;	2565	my ($fh) = @_;
1927		2566
…		…
2001	When you have intermediate CA certificates that your clients might not	2640	When you have intermediate CA certificates that your clients might not
2002	know about, just append them to the C<cert_file>.	2641	know about, just append them to the C<cert_file>.
2003		2642
2004	=back	2643	=back
2005		2644
2006
2007	=head1 SUBCLASSING AnyEvent::Handle	2645	=head1 SUBCLASSING AnyEvent::Handle
2008		2646
2009	In many cases, you might want to subclass AnyEvent::Handle.	2647	In many cases, you might want to subclass AnyEvent::Handle.
2010		2648
2011	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
…		…
2027		2665
2028	=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
2029	are free to use in subclasses.	2667	are free to use in subclasses.
2030		2668
2031	Of course, new versions of AnyEvent::Handle may introduce more "public"	2669	Of course, new versions of AnyEvent::Handle may introduce more "public"
2032	member variables, but thats just life, at least it is documented.	2670	member variables, but that's just life. At least it is documented.
2033		2671
2034	=back	2672	=back
2035		2673
2036	=head1 AUTHOR	2674	=head1 AUTHOR
2037		2675
2038	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>.
2039		2677
2040	=cut	2678	=cut
2041		2679
2042	1; # End of AnyEvent::Handle	2680	1
		2681

Diff Legend

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