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.159 by root, Fri Jul 24 12:35:58 2009 UTC vs.
Revision 1.249 by root, Sat Nov 26 03:34:50 2016 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.86;
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
84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the	104	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
85	default C<peername>.	105	default C<peername>.
86		106
87	You have to specify either this parameter, or C<fh>, above.	107	You have to specify either this parameter, or C<fh>, above.
88		108
		109	It is possible to push requests on the read and write queues, and modify
		110	properties of the stream, even while AnyEvent::Handle is connecting.
		111
89	When this parameter is specified, then the C<on_prepare>,	112	When this parameter is specified, then the C<on_prepare>,
90	C<on_connect_error> and C<on_connect> callbacks will be called under the	113	C<on_connect_error> and C<on_connect> callbacks will be called under the
91	appropriate circumstances:	114	appropriate circumstances:
92		115
93	=over 4	116	=over 4
94		117
95	=item on_prepare => $cb->($handle)	118	=item on_prepare => $cb->($handle)
96		119
97	This (rarely used) callback is called before a new connection is	120	This (rarely used) callback is called before a new connection is
98	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
99	prepare the file handle with parameters required for the actual connect	123	file handle with parameters required for the actual connect (as opposed to
100	(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).
101	established).	125
		126	The return value of this callback should be the connect timeout value in
		127	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
		128	default timeout is to be used).
102		129
103	=item on_connect => $cb->($handle, $host, $port, $retry->())	130	=item on_connect => $cb->($handle, $host, $port, $retry->())
104		131
105	This callback is called when a connection has been successfully established.	132	This callback is called when a connection has been successfully established.
106		133
107	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
108	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.
109		138
110	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
111	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
112	multi-homed hosts or SRV records there can be multiple connection	141	SRV records there can be multiple connection endpoints). The C<$retry>
113	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
114	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.
115		145
116	In most cases, ignoring the C<$retry> parameter is the way to go.	146	In most cases, you should ignore the C<$retry> parameter.
117		147
118	=item on_connect_error => $cb->($handle, $message)	148	=item on_connect_error => $cb->($handle, $message)
119		149
120	This callback is called when the conenction could not be	150	This callback is called when the connection could not be
121	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
122	message describing it (usually the same as C<"$!">).	152	message describing it (usually the same as C<"$!">).
123		153
124	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
125	fatal error instead.	155	fatal error instead.
…		…
128		158
129	=item on_error => $cb->($handle, $fatal, $message)	159	=item on_error => $cb->($handle, $fatal, $message)
130		160
131	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
132	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
133	connect or a read error.	163	connect, or a read error.
134		164
135	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
136	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<< ->
137	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
138	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
139	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
140	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
141	often easiest to not report C<EPIPE> errors in this callback.	171	often easiest to not report C<EPIPE> errors in this callback.
142		172
143	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
144	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.
145	recommended to always output the C<$message> argument in human-readable
146	error messages (it's usually the same as C<"$!">).
147		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
148	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
149	to simply ignore this parameter and instead abondon the handle object	185	to simply ignore this parameter and instead abondon the handle object
150	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
151	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	187	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
152		188
153	On callback entrance, the value of C<$!> contains the operating system	189	On entry to the callback, the value of C<$!> contains the operating
154	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
155	C<EPROTO>).	191	C<EPROTO>).
156		192
157	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
158	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
159	C<croak>.	195	C<croak>.
160		196
161	=item on_read => $cb->($handle)	197	=item on_read => $cb->($handle)
162		198
163	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
…		…
168	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 >>
169	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
170	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
171	the beginning from it.	207	the beginning from it.
172		208
		209	You can also call C<< ->push_read (...) >> or any other function that
		210	modifies the read queue. Or do both. Or ...
		211
173	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
174	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
175	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
176	error will be raised (with C<$!> set to C<EPIPE>).	215	error will be raised (with C<$!> set to C<EPIPE>).
177		216
178	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
…		…
196	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
197	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>.
198		237
199	=item on_drain => $cb->($handle)	238	=item on_drain => $cb->($handle)
200		239
201	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
202	(or when the callback is set and the buffer is empty already).	241	empty (and immediately when the handle object is created).
203		242
204	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.
205		244
206	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
207	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
…		…
209	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
210	the file when the write queue becomes empty.	249	the file when the write queue becomes empty.
211		250
212	=item timeout => $fractional_seconds	251	=item timeout => $fractional_seconds
213		252
		253	=item rtimeout => $fractional_seconds
		254
		255	=item wtimeout => $fractional_seconds
		256
214	If non-zero, then this enables an "inactivity" timeout: whenever this many	257	If non-zero, then these enables an "inactivity" timeout: whenever this
215	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
216	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
217	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).
218		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
219	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
220	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
221	idle then you should disable the timout temporarily or ignore the timeout	272	idle then you should disable the timeout temporarily or ignore the
222	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
223	restart the timeout.	274	AnyEvent::Handle will simply restart the timeout.
224		275
225	Zero (the default) disables this timeout.	276	Zero (the default) disables the corresponding timeout.
226		277
227	=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)
228		283
229	Called whenever the inactivity timeout passes. If you return from this	284	Called whenever the inactivity timeout passes. If you return from this
230	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,
231	so this condition is not fatal in any way.	286	so this condition is not fatal in any way.
232		287
…		…
240	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
241	(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
242	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
243	isn't finished).	298	isn't finished).
244		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
245	=item autocork => <boolean>	315	=item autocork => <boolean>
246		316
247	When disabled (the default), then C<push_write> will try to immediately	317	When disabled (the default), C<push_write> will try to immediately
248	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
249	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
250	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
251	disadvantage is usually avoided by your kernel's nagle algorithm, see	321	disadvantage is usually avoided by your kernel's nagle algorithm, see
252	C<no_delay>, but this option can save costly syscalls).	322	C<no_delay>, but this option can save costly syscalls).
253		323
254	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
255	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,
256	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
257	the write buffer often is full). It also increases write latency.	327	the write buffer often is full). It also increases write latency.
258		328
259	=item no_delay => <boolean>	329	=item no_delay => <boolean>
…		…
263	the Nagle algorithm, and usually it is beneficial.	333	the Nagle algorithm, and usually it is beneficial.
264		334
265	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
266	accomplishd by setting this option to a true value.	336	accomplishd by setting this option to a true value.
267		337
268	The default is your opertaing system's default behaviour (most likely	338	The default is your operating system's default behaviour (most likely
269	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.
270		372
271	=item read_size => <bytes>	373	=item read_size => <bytes>
272		374
273	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
274	try to read during each loop iteration, which affects memory	376	to read during each loop iteration. Each handle object will consume
275	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.
276		387
277	=item low_water_mark => <bytes>	388	=item low_water_mark => <bytes>
278		389
279	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
280	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
281	considered empty.	392	considered empty.
282		393
283	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
284	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
285	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
286	is good in almost all cases.	397	is good in almost all cases.
287		398
288	=item linger => <seconds>	399	=item linger => <seconds>
289		400
290	If non-zero (default: C<3600>), then the destructor of the	401	If this is non-zero (default: C<3600>), the destructor of the
291	AnyEvent::Handle object will check whether there is still outstanding	402	AnyEvent::Handle object will check whether there is still outstanding
292	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
293	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
294	system treats outstanding data at socket close time).	405	system treats outstanding data at socket close time).
295		406
…		…
302	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
303	(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.
304		415
305	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
306	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	417	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
307	verification will be skipped when C<peername> is not specified or	418	verification will be skipped when C<peername> is not specified or is
308	C<undef>.	419	C<undef>.
309		420
310	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	421	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
311		422
312	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
313	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
314	established and will transparently encrypt/decrypt data afterwards.	425	established and will transparently encrypt/decrypt data afterwards.
315		426
316	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
317	appropriate error message.	428	appropriate error message.
318		429
319	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
320	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
321	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
322	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.
323		435
324	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
325	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>
326	mode.	438	mode.
327		439
…		…
338	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	450	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
339	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
340	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
341	segmentation fault.	453	segmentation fault.
342		454
343	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.
344		456
345	=item tls_ctx => $anyevent_tls	457	=item tls_ctx => $anyevent_tls
346		458
347	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
348	(unless a connection object was specified directly). If this parameter is	460	(unless a connection object was specified directly). If this
349	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>.
350		463
351	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
352	=> 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
353	new TLS context object.	466	new TLS context object.
354		467
…		…
363		476
364	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
365	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>.
366		479
367	Without this callback, handshake failures lead to C<on_error> being	480	Without this callback, handshake failures lead to C<on_error> being
368	called, as normal.	481	called as usual.
369		482
370	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
371	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
372	then call C<< ->starttls >> again.	485	then call C<< ->starttls >> again.
373		486
374	=item on_stoptls => $cb->($handle)	487	=item on_stoptls => $cb->($handle)
375		488
…		…
382	callback.	495	callback.
383		496
384	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
385	underlying handle signals EOF.	498	underlying handle signals EOF.
386		499
387	=item json => JSON or JSON::XS object	500	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
388		501
389	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.
390		503
391	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
392	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
393	texts.	516	text.
394		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
395	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
396	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.
397		537
398	=back	538	=back
399		539
400	=cut	540	=cut
401		541
…		…
423	$self->{connect}[0],	563	$self->{connect}[0],
424	$self->{connect}[1],	564	$self->{connect}[1],
425	sub {	565	sub {
426	my ($fh, $host, $port, $retry) = @_;	566	my ($fh, $host, $port, $retry) = @_;
427		567
		568	delete $self->{_connect}; # no longer needed
		569
428	if ($fh) {	570	if ($fh) {
429	$self->{fh} = $fh;	571	$self->{fh} = $fh;
430		572
431	delete $self->{_skip_drain_rbuf};	573	delete $self->{_skip_drain_rbuf};
432	$self->_start;	574	$self->_start;
433		575
434	$self->{on_connect}	576	$self->{on_connect}
435	and $self->{on_connect}($self, $host, $port, sub {	577	and $self->{on_connect}($self, $host, $port, sub {
436	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)};
437	$self->{_skip_drain_rbuf} = 1;	579	$self->{_skip_drain_rbuf} = 1;
438	&$retry;	580	&$retry;
439	});	581	});
440		582
441	} else {	583	} else {
442	if ($self->{on_connect_error}) {	584	if ($self->{on_connect_error}) {
443	$self->{on_connect_error}($self, "$!");	585	$self->{on_connect_error}($self, "$!");
444	$self->destroy;	586	$self->destroy if $self;
445	} else {	587	} else {
446	$self->fatal ($!, 1);	588	$self->_error ($!, 1);
447	}	589	}
448	}	590	}
449	},	591	},
450	sub {	592	sub {
451	local $self->{fh} = $_[0];	593	local $self->{fh} = $_[0];
452		594
		595	$self->{on_prepare}
453	$self->{on_prepare}->($self)	596	? $self->{on_prepare}->($self)
454	if $self->{on_prepare};	597	: ()
455	}	598	}
456	);	599	);
457	}	600	}
458		601
459	} else {	602	} else {
…		…
464	}	607	}
465		608
466	sub _start {	609	sub _start {
467	my ($self) = @_;	610	my ($self) = @_;
468		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
469	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	618	AnyEvent::fh_unblock $self->{fh};
470		619
		620	$self->{_activity} =
		621	$self->{_ractivity} =
471	$self->{_activity} = AnyEvent->now;	622	$self->{_wactivity} = AE::now;
472	$self->_timeout;
473		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
474	$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};
475		634
		635	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		636
476	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	637	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
477	if $self->{tls};	638	if $self->{tls};
478		639
479	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	640	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
480		641
481	$self->start_read	642	$self->start_read
482	if $self->{on_read} || @{ $self->{_queue} };	643	if $self->{on_read} || @{ $self->{_queue} };
483	}
484		644
485	#sub _shutdown {	645	$self->_drain_wbuf;
486	# my ($self) = @_;	646	}
487	#
488	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
489	# $self->{_eof} = 1; # tell starttls et. al to stop trying
490	#
491	# &_freetls;
492	#}
493		647
494	sub _error {	648	sub _error {
495	my ($self, $errno, $fatal, $message) = @_;	649	my ($self, $errno, $fatal, $message) = @_;
496		650
497	$! = $errno;	651	$! = $errno;
498	$message ||= "$!";	652	$message ||= "$!";
499		653
500	if ($self->{on_error}) {	654	if ($self->{on_error}) {
501	$self->{on_error}($self, $fatal, $message);	655	$self->{on_error}($self, $fatal, $message);
502	$self->destroy if $fatal;	656	$self->destroy if $fatal;
503	} elsif ($self->{fh}) {	657	} elsif ($self->{fh} || $self->{connect}) {
504	$self->destroy;	658	$self->destroy;
505	Carp::croak "AnyEvent::Handle uncaught error: $message";	659	Carp::croak "AnyEvent::Handle uncaught error: $message";
506	}	660	}
507	}	661	}
508		662
…		…
534	$_[0]{on_eof} = $_[1];	688	$_[0]{on_eof} = $_[1];
535	}	689	}
536		690
537	=item $handle->on_timeout ($cb)	691	=item $handle->on_timeout ($cb)
538		692
539	Replace the current C<on_timeout> callback, or disables the callback (but	693	=item $handle->on_rtimeout ($cb)
540	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
541	argument and method.
542		694
543	=cut	695	=item $handle->on_wtimeout ($cb)
544		696
545	sub on_timeout {	697	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
546	$_[0]{on_timeout} = $_[1];	698	callback, or disables the callback (but not the timeout) if C<$cb> =
547	}	699	C<undef>. See the C<timeout> constructor argument and method.
		700
		701	=cut
		702
		703	# see below
548		704
549	=item $handle->autocork ($boolean)	705	=item $handle->autocork ($boolean)
550		706
551	Enables or disables the current autocork behaviour (see C<autocork>	707	Enables or disables the current autocork behaviour (see C<autocork>
552	constructor argument). Changes will only take effect on the next write.	708	constructor argument). Changes will only take effect on the next write.
…		…
565	=cut	721	=cut
566		722
567	sub no_delay {	723	sub no_delay {
568	$_[0]{no_delay} = $_[1];	724	$_[0]{no_delay} = $_[1];
569		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
570	eval {	740	eval {
571	local $SIG{__DIE__};	741	local $SIG{__DIE__};
572	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	742	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
573	if $_[0]{fh};	743	if $_[0]{fh};
574	};	744	};
575	}	745	}
576		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
577	=item $handle->on_starttls ($cb)	764	=item $handle->on_starttls ($cb)
578		765
579	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).	766	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
580		767
581	=cut	768	=cut
…		…
588		775
589	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	776	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
590		777
591	=cut	778	=cut
592		779
593	sub on_starttls {	780	sub on_stoptls {
594	$_[0]{on_stoptls} = $_[1];	781	$_[0]{on_stoptls} = $_[1];
595	}	782	}
596		783
		784	=item $handle->rbuf_max ($max_octets)
		785
		786	Configures the C<rbuf_max> setting (C<undef> disables it).
		787
		788	=item $handle->wbuf_max ($max_octets)
		789
		790	Configures the C<wbuf_max> setting (C<undef> disables it).
		791
		792	=cut
		793
		794	sub rbuf_max {
		795	$_[0]{rbuf_max} = $_[1];
		796	}
		797
		798	sub wbuf_max {
		799	$_[0]{wbuf_max} = $_[1];
		800	}
		801
597	#############################################################################	802	#############################################################################
598		803
599	=item $handle->timeout ($seconds)	804	=item $handle->timeout ($seconds)
600		805
		806	=item $handle->rtimeout ($seconds)
		807
		808	=item $handle->wtimeout ($seconds)
		809
601	Configures (or disables) the inactivity timeout.	810	Configures (or disables) the inactivity timeout.
602		811
603	=cut	812	The timeout will be checked instantly, so this method might destroy the
		813	handle before it returns.
604		814
605	sub timeout {	815	=item $handle->timeout_reset
		816
		817	=item $handle->rtimeout_reset
		818
		819	=item $handle->wtimeout_reset
		820
		821	Reset the activity timeout, as if data was received or sent.
		822
		823	These methods are cheap to call.
		824
		825	=cut
		826
		827	for my $dir ("", "r", "w") {
		828	my $timeout = "${dir}timeout";
		829	my $tw = "_${dir}tw";
		830	my $on_timeout = "on_${dir}timeout";
		831	my $activity = "_${dir}activity";
		832	my $cb;
		833
		834	*$on_timeout = sub {
		835	$_[0]{$on_timeout} = $_[1];
		836	};
		837
		838	*$timeout = sub {
606	my ($self, $timeout) = @_;	839	my ($self, $new_value) = @_;
607		840
		841	$new_value >= 0
		842	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		843
608	$self->{timeout} = $timeout;	844	$self->{$timeout} = $new_value;
609	$self->_timeout;	845	delete $self->{$tw}; &$cb;
610	}	846	};
611		847
		848	*{"${dir}timeout_reset"} = sub {
		849	$_[0]{$activity} = AE::now;
		850	};
		851
		852	# main workhorse:
612	# reset the timeout watcher, as neccessary	853	# reset the timeout watcher, as neccessary
613	# also check for time-outs	854	# also check for time-outs
614	sub _timeout {	855	$cb = sub {
615	my ($self) = @_;	856	my ($self) = @_;
616		857
617	if ($self->{timeout} && $self->{fh}) {	858	if ($self->{$timeout} && $self->{fh}) {
618	my $NOW = AnyEvent->now;	859	my $NOW = AE::now;
619		860
620	# when would the timeout trigger?	861	# when would the timeout trigger?
621	my $after = $self->{_activity} + $self->{timeout} - $NOW;	862	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
622		863
623	# now or in the past already?	864	# now or in the past already?
624	if ($after <= 0) {	865	if ($after <= 0) {
625	$self->{_activity} = $NOW;	866	$self->{$activity} = $NOW;
626		867
627	if ($self->{on_timeout}) {	868	if ($self->{$on_timeout}) {
628	$self->{on_timeout}($self);	869	$self->{$on_timeout}($self);
629	} else {	870	} else {
630	$self->_error (Errno::ETIMEDOUT);	871	$self->_error (Errno::ETIMEDOUT);
		872	}
		873
		874	# callback could have changed timeout value, optimise
		875	return unless $self->{$timeout};
		876
		877	# calculate new after
		878	$after = $self->{$timeout};
631	}	879	}
632		880
633	# callback could have changed timeout value, optimise	881	Scalar::Util::weaken $self;
634	return unless $self->{timeout};	882	return unless $self; # ->error could have destroyed $self
635		883
636	# calculate new after	884	$self->{$tw} ||= AE::timer $after, 0, sub {
637	$after = $self->{timeout};	885	delete $self->{$tw};
		886	$cb->($self);
		887	};
		888	} else {
		889	delete $self->{$tw};
638	}	890	}
639
640	Scalar::Util::weaken $self;
641	return unless $self; # ->error could have destroyed $self
642
643	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
644	delete $self->{_tw};
645	$self->_timeout;
646	});
647	} else {
648	delete $self->{_tw};
649	}	891	}
650	}	892	}
651		893
652	#############################################################################	894	#############################################################################
653		895
…		…
660		902
661	The write queue is very simple: you can add data to its end, and	903	The write queue is very simple: you can add data to its end, and
662	AnyEvent::Handle will automatically try to get rid of it for you.	904	AnyEvent::Handle will automatically try to get rid of it for you.
663		905
664	When data could be written and the write buffer is shorter then the low	906	When data could be written and the write buffer is shorter then the low
665	water mark, the C<on_drain> callback will be invoked.	907	water mark, the C<on_drain> callback will be invoked once.
666		908
667	=over 4	909	=over 4
668		910
669	=item $handle->on_drain ($cb)	911	=item $handle->on_drain ($cb)
670		912
671	Sets the C<on_drain> callback or clears it (see the description of	913	Sets the C<on_drain> callback or clears it (see the description of
672	C<on_drain> in the constructor).	914	C<on_drain> in the constructor).
673		915
		916	This method may invoke callbacks (and therefore the handle might be
		917	destroyed after it returns).
		918
674	=cut	919	=cut
675		920
676	sub on_drain {	921	sub on_drain {
677	my ($self, $cb) = @_;	922	my ($self, $cb) = @_;
678		923
…		…
682	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});	927	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
683	}	928	}
684		929
685	=item $handle->push_write ($data)	930	=item $handle->push_write ($data)
686		931
687	Queues the given scalar to be written. You can push as much data as you	932	Queues the given scalar to be written. You can push as much data as
688	want (only limited by the available memory), as C<AnyEvent::Handle>	933	you want (only limited by the available memory and C<wbuf_max>), as
689	buffers it independently of the kernel.	934	C<AnyEvent::Handle> buffers it independently of the kernel.
		935
		936	This method may invoke callbacks (and therefore the handle might be
		937	destroyed after it returns).
690		938
691	=cut	939	=cut
692		940
693	sub _drain_wbuf {	941	sub _drain_wbuf {
694	my ($self) = @_;	942	my ($self) = @_;
…		…
701	my $len = syswrite $self->{fh}, $self->{wbuf};	949	my $len = syswrite $self->{fh}, $self->{wbuf};
702		950
703	if (defined $len) {	951	if (defined $len) {
704	substr $self->{wbuf}, 0, $len, "";	952	substr $self->{wbuf}, 0, $len, "";
705		953
706	$self->{_activity} = AnyEvent->now;	954	$self->{_activity} = $self->{_wactivity} = AE::now;
707		955
708	$self->{on_drain}($self)	956	$self->{on_drain}($self)
709	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	957	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
710	&& $self->{on_drain};	958	&& $self->{on_drain};
711		959
712	delete $self->{_ww} unless length $self->{wbuf};	960	delete $self->{_ww} unless length $self->{wbuf};
713	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	961	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
714	$self->_error ($!, 1);	962	$self->_error ($!, 1);
715	}	963	}
716	};	964	};
717		965
718	# try to write data immediately	966	# try to write data immediately
719	$cb->() unless $self->{autocork};	967	$cb->() unless $self->{autocork};
720		968
721	# if still data left in wbuf, we need to poll	969	# if still data left in wbuf, we need to poll
722	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	970	$self->{_ww} = AE::io $self->{fh}, 1, $cb
723	if length $self->{wbuf};	971	if length $self->{wbuf};
		972
		973	if (
		974	defined $self->{wbuf_max}
		975	&& $self->{wbuf_max} < length $self->{wbuf}
		976	) {
		977	$self->_error (Errno::ENOSPC, 1), return;
		978	}
724	};	979	};
725	}	980	}
726		981
727	our %WH;	982	our %WH;
728		983
		984	# deprecated
729	sub register_write_type($$) {	985	sub register_write_type($$) {
730	$WH{$_[0]} = $_[1];	986	$WH{$_[0]} = $_[1];
731	}	987	}
732		988
733	sub push_write {	989	sub push_write {
734	my $self = shift;	990	my $self = shift;
735		991
736	if (@_ > 1) {	992	if (@_ > 1) {
737	my $type = shift;	993	my $type = shift;
738		994
		995	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
739	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	996	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
740	->($self, @_);	997	->($self, @_);
741	}	998	}
742		999
		1000	# we downgrade here to avoid hard-to-track-down bugs,
		1001	# and diagnose the problem earlier and better.
		1002
743	if ($self->{tls}) {	1003	if ($self->{tls}) {
744	$self->{_tls_wbuf} .= $_[0];	1004	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
745		1005	&_dotls ($self) if $self->{fh};
746	&_dotls ($self);
747	} else {	1006	} else {
748	$self->{wbuf} .= $_[0];	1007	utf8::downgrade $self->{wbuf} .= $_[0];
749	$self->_drain_wbuf if $self->{fh};	1008	$self->_drain_wbuf if $self->{fh};
750	}	1009	}
751	}	1010	}
752		1011
753	=item $handle->push_write (type => @args)	1012	=item $handle->push_write (type => @args)
754		1013
755	Instead of formatting your data yourself, you can also let this module do	1014	Instead of formatting your data yourself, you can also let this module
756	the job by specifying a type and type-specific arguments.	1015	do the job by specifying a type and type-specific arguments. You
		1016	can also specify the (fully qualified) name of a package, in which
		1017	case AnyEvent tries to load the package and then expects to find the
		1018	C<anyevent_write_type> function inside (see "custom write types", below).
757		1019
758	Predefined types are (if you have ideas for additional types, feel free to	1020	Predefined types are (if you have ideas for additional types, feel free to
759	drop by and tell us):	1021	drop by and tell us):
760		1022
761	=over 4	1023	=over 4
…		…
792		1054
793	Encodes the given hash or array reference into a JSON object. Unless you	1055	Encodes the given hash or array reference into a JSON object. Unless you
794	provide your own JSON object, this means it will be encoded to JSON text	1056	provide your own JSON object, this means it will be encoded to JSON text
795	in UTF-8.	1057	in UTF-8.
796		1058
		1059	The default encoder might or might not handle every type of JSON value -
		1060	it might be limited to arrays and objects for security reasons. See the
		1061	C<json> constructor attribute for more details.
		1062
797	JSON objects (and arrays) are self-delimiting, so you can write JSON at	1063	JSON objects (and arrays) are self-delimiting, so if you only use arrays
798	one end of a handle and read them at the other end without using any	1064	and hashes, you can write JSON at one end of a handle and read them at the
799	additional framing.	1065	other end without using any additional framing.
800		1066
801	The generated JSON text is guaranteed not to contain any newlines: While	1067	The JSON text generated by the default encoder is guaranteed not to
802	this module doesn't need delimiters after or between JSON texts to be	1068	contain any newlines: While this module doesn't need delimiters after or
803	able to read them, many other languages depend on that.	1069	between JSON texts to be able to read them, many other languages depend on
		1070	them.
804		1071
805	A simple RPC protocol that interoperates easily with others is to send	1072	A simple RPC protocol that interoperates easily with other languages is
806	JSON arrays (or objects, although arrays are usually the better choice as	1073	to send JSON arrays (or objects, although arrays are usually the better
807	they mimic how function argument passing works) and a newline after each	1074	choice as they mimic how function argument passing works) and a newline
808	JSON text:	1075	after each JSON text:
809		1076
810	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1077	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
811	$handle->push_write ("\012");	1078	$handle->push_write ("\012");
812		1079
813	An AnyEvent::Handle receiver would simply use the C<json> read type and	1080	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
816	$handle->push_read (json => sub { my $array = $_[1]; ... });	1083	$handle->push_read (json => sub { my $array = $_[1]; ... });
817		1084
818	Other languages could read single lines terminated by a newline and pass	1085	Other languages could read single lines terminated by a newline and pass
819	this line into their JSON decoder of choice.	1086	this line into their JSON decoder of choice.
820		1087
		1088	=item cbor => $perl_scalar
		1089
		1090	Encodes the given scalar into a CBOR value. Unless you provide your own
		1091	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1092	using any extensions, if possible.
		1093
		1094	CBOR values are self-delimiting, so you can write CBOR at one end of
		1095	a handle and read them at the other end without using any additional
		1096	framing.
		1097
		1098	A simple nd very very fast RPC protocol that interoperates with
		1099	other languages is to send CBOR and receive CBOR values (arrays are
		1100	recommended):
		1101
		1102	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1103
		1104	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1105
		1106	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1107
821	=cut	1108	=cut
		1109
		1110	sub json_coder() {
		1111	eval { require JSON::XS; JSON::XS->new->utf8 }
		1112	|| do { require JSON::PP; JSON::PP->new->utf8 }
		1113	}
822		1114
823	register_write_type json => sub {	1115	register_write_type json => sub {
824	my ($self, $ref) = @_;	1116	my ($self, $ref) = @_;
825		1117
826	require JSON;	1118	($self->{json} ||= json_coder)
		1119	->encode ($ref)
		1120	};
827		1121
828	$self->{json} ? $self->{json}->encode ($ref)	1122	sub cbor_coder() {
829	: JSON::encode_json ($ref)	1123	require CBOR::XS;
		1124	CBOR::XS->new
		1125	}
		1126
		1127	register_write_type cbor => sub {
		1128	my ($self, $scalar) = @_;
		1129
		1130	($self->{cbor} ||= cbor_coder)
		1131	->encode ($scalar)
830	};	1132	};
831		1133
832	=item storable => $reference	1134	=item storable => $reference
833		1135
834	Freezes the given reference using L<Storable> and writes it to the	1136	Freezes the given reference using L<Storable> and writes it to the
…		…
837	=cut	1139	=cut
838		1140
839	register_write_type storable => sub {	1141	register_write_type storable => sub {
840	my ($self, $ref) = @_;	1142	my ($self, $ref) = @_;
841		1143
842	require Storable;	1144	require Storable unless $Storable::VERSION;
843		1145
844	pack "w/a*", Storable::nfreeze ($ref)	1146	pack "w/a*", Storable::nfreeze ($ref)
845	};	1147	};
846		1148
847	=back	1149	=back
…		…
852	before it was actually written. One way to do that is to replace your	1154	before it was actually written. One way to do that is to replace your
853	C<on_drain> handler by a callback that shuts down the socket (and set	1155	C<on_drain> handler by a callback that shuts down the socket (and set
854	C<low_water_mark> to C<0>). This method is a shorthand for just that, and	1156	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
855	replaces the C<on_drain> callback with:	1157	replaces the C<on_drain> callback with:
856		1158
857	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1159	sub { shutdown $_[0]{fh}, 1 }
858		1160
859	This simply shuts down the write side and signals an EOF condition to the	1161	This simply shuts down the write side and signals an EOF condition to the
860	the peer.	1162	the peer.
861		1163
862	You can rely on the normal read queue and C<on_eof> handling	1164	You can rely on the normal read queue and C<on_eof> handling
863	afterwards. This is the cleanest way to close a connection.	1165	afterwards. This is the cleanest way to close a connection.
864		1166
		1167	This method may invoke callbacks (and therefore the handle might be
		1168	destroyed after it returns).
		1169
865	=cut	1170	=cut
866		1171
867	sub push_shutdown {	1172	sub push_shutdown {
868	my ($self) = @_;	1173	my ($self) = @_;
869		1174
870	delete $self->{low_water_mark};	1175	delete $self->{low_water_mark};
871	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1176	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
872	}	1177	}
873		1178
874	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1179	=item custom write types - Package::anyevent_write_type $handle, @args
875		1180
876	This function (not method) lets you add your own types to C<push_write>.	1181	Instead of one of the predefined types, you can also specify the name of
		1182	a package. AnyEvent will try to load the package and then expects to find
		1183	a function named C<anyevent_write_type> inside. If it isn't found, it
		1184	progressively tries to load the parent package until it either finds the
		1185	function (good) or runs out of packages (bad).
		1186
877	Whenever the given C<type> is used, C<push_write> will invoke the code	1187	Whenever the given C<type> is used, C<push_write> will the function with
878	reference with the handle object and the remaining arguments.	1188	the handle object and the remaining arguments.
879		1189
880	The code reference is supposed to return a single octet string that will	1190	The function is supposed to return a single octet string that will be
881	be appended to the write buffer.	1191	appended to the write buffer, so you can mentally treat this function as a
		1192	"arguments to on-the-wire-format" converter.
882		1193
883	Note that this is a function, and all types registered this way will be	1194	Example: implement a custom write type C<join> that joins the remaining
884	global, so try to use unique names.	1195	arguments using the first one.
		1196
		1197	$handle->push_write (My::Type => " ", 1,2,3);
		1198
		1199	# uses the following package, which can be defined in the "My::Type" or in
		1200	# the "My" modules to be auto-loaded, or just about anywhere when the
		1201	# My::Type::anyevent_write_type is defined before invoking it.
		1202
		1203	package My::Type;
		1204
		1205	sub anyevent_write_type {
		1206	my ($handle, $delim, @args) = @_;
		1207
		1208	join $delim, @args
		1209	}
885		1210
886	=cut	1211	=cut
887		1212
888	#############################################################################	1213	#############################################################################
889		1214
…		…
898	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1223	ways, the "simple" way, using only C<on_read> and the "complex" way, using
899	a queue.	1224	a queue.
900		1225
901	In the simple case, you just install an C<on_read> callback and whenever	1226	In the simple case, you just install an C<on_read> callback and whenever
902	new data arrives, it will be called. You can then remove some data (if	1227	new data arrives, it will be called. You can then remove some data (if
903	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1228	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
904	leave the data there if you want to accumulate more (e.g. when only a	1229	leave the data there if you want to accumulate more (e.g. when only a
905	partial message has been received so far).	1230	partial message has been received so far), or change the read queue with
		1231	e.g. C<push_read>.
906		1232
907	In the more complex case, you want to queue multiple callbacks. In this	1233	In the more complex case, you want to queue multiple callbacks. In this
908	case, AnyEvent::Handle will call the first queued callback each time new	1234	case, AnyEvent::Handle will call the first queued callback each time new
909	data arrives (also the first time it is queued) and removes it when it has	1235	data arrives (also the first time it is queued) and remove it when it has
910	done its job (see C<push_read>, below).	1236	done its job (see C<push_read>, below).
911		1237
912	This way you can, for example, push three line-reads, followed by reading	1238	This way you can, for example, push three line-reads, followed by reading
913	a chunk of data, and AnyEvent::Handle will execute them in order.	1239	a chunk of data, and AnyEvent::Handle will execute them in order.
914		1240
…		…
972		1298
973	sub _drain_rbuf {	1299	sub _drain_rbuf {
974	my ($self) = @_;	1300	my ($self) = @_;
975		1301
976	# avoid recursion	1302	# avoid recursion
977	return if exists $self->{_skip_drain_rbuf};	1303	return if $self->{_skip_drain_rbuf};
978	local $self->{_skip_drain_rbuf} = 1;	1304	local $self->{_skip_drain_rbuf} = 1;
979
980	if (
981	defined $self->{rbuf_max}
982	&& $self->{rbuf_max} < length $self->{rbuf}
983	) {
984	$self->_error (Errno::ENOSPC, 1), return;
985	}
986		1305
987	while () {	1306	while () {
988	# we need to use a separate tls read buffer, as we must not receive data while	1307	# we need to use a separate tls read buffer, as we must not receive data while
989	# we are draining the buffer, and this can only happen with TLS.	1308	# we are draining the buffer, and this can only happen with TLS.
990	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1309	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1310	if exists $self->{_tls_rbuf};
991		1311
992	my $len = length $self->{rbuf};	1312	my $len = length $self->{rbuf};
993		1313
994	if (my $cb = shift @{ $self->{_queue} }) {	1314	if (my $cb = shift @{ $self->{_queue} }) {
995	unless ($cb->($self)) {	1315	unless ($cb->($self)) {
996	if ($self->{_eof}) {	1316	# no progress can be made
997	# no progress can be made (not enough data and no data forthcoming)	1317	# (not enough data and no data forthcoming)
998	$self->_error (Errno::EPIPE, 1), return;	1318	$self->_error (Errno::EPIPE, 1), return
999	}	1319	if $self->{_eof};
1000		1320
1001	unshift @{ $self->{_queue} }, $cb;	1321	unshift @{ $self->{_queue} }, $cb;
1002	last;	1322	last;
1003	}	1323	}
1004	} elsif ($self->{on_read}) {	1324	} elsif ($self->{on_read}) {
…		…
1024	last;	1344	last;
1025	}	1345	}
1026	}	1346	}
1027		1347
1028	if ($self->{_eof}) {	1348	if ($self->{_eof}) {
1029	if ($self->{on_eof}) {	1349	$self->{on_eof}
1030	$self->{on_eof}($self)	1350	? $self->{on_eof}($self)
1031	} else {
1032	$self->_error (0, 1, "Unexpected end-of-file");	1351	: $self->_error (0, 1, "Unexpected end-of-file");
1033	}	1352
		1353	return;
		1354	}
		1355
		1356	if (
		1357	defined $self->{rbuf_max}
		1358	&& $self->{rbuf_max} < length $self->{rbuf}
		1359	) {
		1360	$self->_error (Errno::ENOSPC, 1), return;
1034	}	1361	}
1035		1362
1036	# may need to restart read watcher	1363	# may need to restart read watcher
1037	unless ($self->{_rw}) {	1364	unless ($self->{_rw}) {
1038	$self->start_read	1365	$self->start_read
…		…
1044		1371
1045	This replaces the currently set C<on_read> callback, or clears it (when	1372	This replaces the currently set C<on_read> callback, or clears it (when
1046	the new callback is C<undef>). See the description of C<on_read> in the	1373	the new callback is C<undef>). See the description of C<on_read> in the
1047	constructor.	1374	constructor.
1048		1375
		1376	This method may invoke callbacks (and therefore the handle might be
		1377	destroyed after it returns).
		1378
1049	=cut	1379	=cut
1050		1380
1051	sub on_read {	1381	sub on_read {
1052	my ($self, $cb) = @_;	1382	my ($self, $cb) = @_;
1053		1383
…		…
1055	$self->_drain_rbuf if $cb;	1385	$self->_drain_rbuf if $cb;
1056	}	1386	}
1057		1387
1058	=item $handle->rbuf	1388	=item $handle->rbuf
1059		1389
1060	Returns the read buffer (as a modifiable lvalue).	1390	Returns the read buffer (as a modifiable lvalue). You can also access the
		1391	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1392	much faster, and no less clean).
1061		1393
1062	You can access the read buffer directly as the C<< ->{rbuf} >>	1394	The only operation allowed on the read buffer (apart from looking at it)
1063	member, if you want. However, the only operation allowed on the	1395	is removing data from its beginning. Otherwise modifying or appending to
1064	read buffer (apart from looking at it) is removing data from its	1396	it is not allowed and will lead to hard-to-track-down bugs.
1065	beginning. Otherwise modifying or appending to it is not allowed and will
1066	lead to hard-to-track-down bugs.
1067		1397
1068	NOTE: The read buffer should only be used or modified if the C<on_read>,	1398	NOTE: The read buffer should only be used or modified in the C<on_read>
1069	C<push_read> or C<unshift_read> methods are used. The other read methods	1399	callback or when C<push_read> or C<unshift_read> are used with a single
1070	automatically manage the read buffer.	1400	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1401	will manage the read buffer on their own.
1071		1402
1072	=cut	1403	=cut
1073		1404
1074	sub rbuf : lvalue {	1405	sub rbuf : lvalue {
1075	$_[0]{rbuf}	1406	$_[0]{rbuf}
…		…
1092		1423
1093	If enough data was available, then the callback must remove all data it is	1424	If enough data was available, then the callback must remove all data it is
1094	interested in (which can be none at all) and return a true value. After returning	1425	interested in (which can be none at all) and return a true value. After returning
1095	true, it will be removed from the queue.	1426	true, it will be removed from the queue.
1096		1427
		1428	These methods may invoke callbacks (and therefore the handle might be
		1429	destroyed after it returns).
		1430
1097	=cut	1431	=cut
1098		1432
1099	our %RH;	1433	our %RH;
1100		1434
1101	sub register_read_type($$) {	1435	sub register_read_type($$) {
…		…
1107	my $cb = pop;	1441	my $cb = pop;
1108		1442
1109	if (@_) {	1443	if (@_) {
1110	my $type = shift;	1444	my $type = shift;
1111		1445
		1446	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1112	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1447	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1113	->($self, $cb, @_);	1448	->($self, $cb, @_);
1114	}	1449	}
1115		1450
1116	push @{ $self->{_queue} }, $cb;	1451	push @{ $self->{_queue} }, $cb;
1117	$self->_drain_rbuf;	1452	$self->_drain_rbuf;
…		…
1122	my $cb = pop;	1457	my $cb = pop;
1123		1458
1124	if (@_) {	1459	if (@_) {
1125	my $type = shift;	1460	my $type = shift;
1126		1461
		1462	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1127	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1463	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1128	->($self, $cb, @_);	1464	->($self, $cb, @_);
1129	}	1465	}
1130
1131		1466
1132	unshift @{ $self->{_queue} }, $cb;	1467	unshift @{ $self->{_queue} }, $cb;
1133	$self->_drain_rbuf;	1468	$self->_drain_rbuf;
1134	}	1469	}
1135		1470
…		…
1137		1472
1138	=item $handle->unshift_read (type => @args, $cb)	1473	=item $handle->unshift_read (type => @args, $cb)
1139		1474
1140	Instead of providing a callback that parses the data itself you can chose	1475	Instead of providing a callback that parses the data itself you can chose
1141	between a number of predefined parsing formats, for chunks of data, lines	1476	between a number of predefined parsing formats, for chunks of data, lines
1142	etc.	1477	etc. You can also specify the (fully qualified) name of a package, in
		1478	which case AnyEvent tries to load the package and then expects to find the
		1479	C<anyevent_read_type> function inside (see "custom read types", below).
1143		1480
1144	Predefined types are (if you have ideas for additional types, feel free to	1481	Predefined types are (if you have ideas for additional types, feel free to
1145	drop by and tell us):	1482	drop by and tell us):
1146		1483
1147	=over 4	1484	=over 4
…		…
1153	data.	1490	data.
1154		1491
1155	Example: read 2 bytes.	1492	Example: read 2 bytes.
1156		1493
1157	$handle->push_read (chunk => 2, sub {	1494	$handle->push_read (chunk => 2, sub {
1158	warn "yay ", unpack "H*", $_[1];	1495	say "yay " . unpack "H*", $_[1];
1159	});	1496	});
1160		1497
1161	=cut	1498	=cut
1162		1499
1163	register_read_type chunk => sub {	1500	register_read_type chunk => sub {
…		…
1193		1530
1194	register_read_type line => sub {	1531	register_read_type line => sub {
1195	my ($self, $cb, $eol) = @_;	1532	my ($self, $cb, $eol) = @_;
1196		1533
1197	if (@_ < 3) {	1534	if (@_ < 3) {
1198	# this is more than twice as fast as the generic code below	1535	# this is faster then the generic code below
1199	sub {	1536	sub {
1200	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1537	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1538	or return;
1201		1539
		1540	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1202	$cb->($_[0], $1, $2);	1541	$cb->($_[0], $str, "$1");
1203	1	1542	1
1204	}	1543	}
1205	} else {	1544	} else {
1206	$eol = quotemeta $eol unless ref $eol;	1545	$eol = quotemeta $eol unless ref $eol;
1207	$eol = qr|^(.*?)($eol)|s;	1546	$eol = qr|^(.*?)($eol)|s;
1208		1547
1209	sub {	1548	sub {
1210	$_[0]{rbuf} =~ s/$eol// or return;	1549	$_[0]{rbuf} =~ s/$eol// or return;
1211		1550
1212	$cb->($_[0], $1, $2);	1551	$cb->($_[0], "$1", "$2");
1213	1	1552	1
1214	}	1553	}
1215	}	1554	}
1216	};	1555	};
1217		1556
1218	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1557	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
1219		1558
1220	Makes a regex match against the regex object C<$accept> and returns	1559	Makes a regex match against the regex object C<$accept> and returns
1221	everything up to and including the match.	1560	everything up to and including the match. All the usual regex variables
		1561	($1, %+ etc.) from the regex match are available in the callback.
1222		1562
1223	Example: read a single line terminated by '\n'.	1563	Example: read a single line terminated by '\n'.
1224		1564
1225	$handle->push_read (regex => qr<\n>, sub { ... });	1565	$handle->push_read (regex => qr<\n>, sub { ... });
1226		1566
…		…
1239	the receive buffer when neither C<$accept> nor C<$reject> match,	1579	the receive buffer when neither C<$accept> nor C<$reject> match,
1240	and everything preceding and including the match will be accepted	1580	and everything preceding and including the match will be accepted
1241	unconditionally. This is useful to skip large amounts of data that you	1581	unconditionally. This is useful to skip large amounts of data that you
1242	know cannot be matched, so that the C<$accept> or C<$reject> regex do not	1582	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1243	have to start matching from the beginning. This is purely an optimisation	1583	have to start matching from the beginning. This is purely an optimisation
1244	and is usually worth only when you expect more than a few kilobytes.	1584	and is usually worth it only when you expect more than a few kilobytes.
1245		1585
1246	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1586	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1247	expect the header to be very large (it isn't in practise, but...), we use	1587	expect the header to be very large (it isn't in practice, but...), we use
1248	a skip regex to skip initial portions. The skip regex is tricky in that	1588	a skip regex to skip initial portions. The skip regex is tricky in that
1249	it only accepts something not ending in either \015 or \012, as these are	1589	it only accepts something not ending in either \015 or \012, as these are
1250	required for the accept regex.	1590	required for the accept regex.
1251		1591
1252	$handle->push_read (regex =>	1592	$handle->push_read (regex =>
…		…
1265		1605
1266	sub {	1606	sub {
1267	# accept	1607	# accept
1268	if ($$rbuf =~ $accept) {	1608	if ($$rbuf =~ $accept) {
1269	$data .= substr $$rbuf, 0, $+[0], "";	1609	$data .= substr $$rbuf, 0, $+[0], "";
1270	$cb->($self, $data);	1610	$cb->($_[0], $data);
1271	return 1;	1611	return 1;
1272	}	1612	}
1273		1613
1274	# reject	1614	# reject
1275	if ($reject && $$rbuf =~ $reject) {	1615	if ($reject && $$rbuf =~ $reject) {
1276	$self->_error (Errno::EBADMSG);	1616	$_[0]->_error (Errno::EBADMSG);
1277	}	1617	}
1278		1618
1279	# skip	1619	# skip
1280	if ($skip && $$rbuf =~ $skip) {	1620	if ($skip && $$rbuf =~ $skip) {
1281	$data .= substr $$rbuf, 0, $+[0], "";	1621	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1297	my ($self, $cb) = @_;	1637	my ($self, $cb) = @_;
1298		1638
1299	sub {	1639	sub {
1300	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1640	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1301	if ($_[0]{rbuf} =~ /[^0-9]/) {	1641	if ($_[0]{rbuf} =~ /[^0-9]/) {
1302	$self->_error (Errno::EBADMSG);	1642	$_[0]->_error (Errno::EBADMSG);
1303	}	1643	}
1304	return;	1644	return;
1305	}	1645	}
1306		1646
1307	my $len = $1;	1647	my $len = $1;
1308		1648
1309	$self->unshift_read (chunk => $len, sub {	1649	$_[0]->unshift_read (chunk => $len, sub {
1310	my $string = $_[1];	1650	my $string = $_[1];
1311	$_[0]->unshift_read (chunk => 1, sub {	1651	$_[0]->unshift_read (chunk => 1, sub {
1312	if ($_[1] eq ",") {	1652	if ($_[1] eq ",") {
1313	$cb->($_[0], $string);	1653	$cb->($_[0], $string);
1314	} else {	1654	} else {
1315	$self->_error (Errno::EBADMSG);	1655	$_[0]->_error (Errno::EBADMSG);
1316	}	1656	}
1317	});	1657	});
1318	});	1658	});
1319		1659
1320	1	1660	1
…		…
1370	=item json => $cb->($handle, $hash_or_arrayref)	1710	=item json => $cb->($handle, $hash_or_arrayref)
1371		1711
1372	Reads a JSON object or array, decodes it and passes it to the	1712	Reads a JSON object or array, decodes it and passes it to the
1373	callback. When a parse error occurs, an C<EBADMSG> error will be raised.	1713	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1374		1714
1375	If a C<json> object was passed to the constructor, then that will be used	1715	If a C<json> object was passed to the constructor, then that will be
1376	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1716	used for the final decode, otherwise it will create a L<JSON::XS> or
		1717	L<JSON::PP> coder object expecting UTF-8.
1377		1718
1378	This read type uses the incremental parser available with JSON version	1719	This read type uses the incremental parser available with JSON version
1379	2.09 (and JSON::XS version 2.2) and above. You have to provide a	1720	2.09 (and JSON::XS version 2.2) and above.
1380	dependency on your own: this module will load the JSON module, but
1381	AnyEvent does not depend on it itself.
1382		1721
1383	Since JSON texts are fully self-delimiting, the C<json> read and write	1722	Since JSON texts are fully self-delimiting, the C<json> read and write
1384	types are an ideal simple RPC protocol: just exchange JSON datagrams. See	1723	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1385	the C<json> write type description, above, for an actual example.	1724	the C<json> write type description, above, for an actual example.
1386		1725
1387	=cut	1726	=cut
1388		1727
1389	register_read_type json => sub {	1728	register_read_type json => sub {
1390	my ($self, $cb) = @_;	1729	my ($self, $cb) = @_;
1391		1730
1392	my $json = $self->{json} ||=	1731	my $json = $self->{json} ||= json_coder;
1393	eval { require JSON::XS; JSON::XS->new->utf8 }
1394	|| do { require JSON; JSON->new->utf8 };
1395		1732
1396	my $data;	1733	my $data;
1397	my $rbuf = \$self->{rbuf};
1398		1734
1399	sub {	1735	sub {
1400	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1736	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1401		1737
1402	if ($ref) {	1738	if ($ref) {
1403	$self->{rbuf} = $json->incr_text;	1739	$_[0]{rbuf} = $json->incr_text;
1404	$json->incr_text = "";	1740	$json->incr_text = "";
1405	$cb->($self, $ref);	1741	$cb->($_[0], $ref);
1406		1742
1407	1	1743	1
1408	} elsif ($@) {	1744	} elsif ($@) {
1409	# error case	1745	# error case
1410	$json->incr_skip;	1746	$json->incr_skip;
1411		1747
1412	$self->{rbuf} = $json->incr_text;	1748	$_[0]{rbuf} = $json->incr_text;
1413	$json->incr_text = "";	1749	$json->incr_text = "";
1414		1750
1415	$self->_error (Errno::EBADMSG);	1751	$_[0]->_error (Errno::EBADMSG);
1416		1752
1417	()	1753	()
1418	} else {	1754	} else {
1419	$self->{rbuf} = "";	1755	$_[0]{rbuf} = "";
1420		1756
		1757	()
		1758	}
		1759	}
		1760	};
		1761
		1762	=item cbor => $cb->($handle, $scalar)
		1763
		1764	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1765	error occurs, an C<EBADMSG> error will be raised.
		1766
		1767	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1768	used for the final decode, otherwise it will create a CBOR coder without
		1769	enabling any options.
		1770
		1771	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1772	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1773	itself.
		1774
		1775	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1776	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1777	the C<cbor> write type description, above, for an actual example.
		1778
		1779	=cut
		1780
		1781	register_read_type cbor => sub {
		1782	my ($self, $cb) = @_;
		1783
		1784	my $cbor = $self->{cbor} ||= cbor_coder;
		1785
		1786	my $data;
		1787
		1788	sub {
		1789	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1790
		1791	if (@value) {
		1792	$cb->($_[0], @value);
		1793
		1794	1
		1795	} elsif ($@) {
		1796	# error case
		1797	$cbor->incr_reset;
		1798
		1799	$_[0]->_error (Errno::EBADMSG);
		1800
		1801	()
		1802	} else {
1421	()	1803	()
1422	}	1804	}
1423	}	1805	}
1424	};	1806	};
1425		1807
…		…
1434	=cut	1816	=cut
1435		1817
1436	register_read_type storable => sub {	1818	register_read_type storable => sub {
1437	my ($self, $cb) = @_;	1819	my ($self, $cb) = @_;
1438		1820
1439	require Storable;	1821	require Storable unless $Storable::VERSION;
1440		1822
1441	sub {	1823	sub {
1442	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1824	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1443	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1825	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1444	or return;	1826	or return;
…		…
1447		1829
1448	# bypass unshift if we already have the remaining chunk	1830	# bypass unshift if we already have the remaining chunk
1449	if ($format + $len <= length $_[0]{rbuf}) {	1831	if ($format + $len <= length $_[0]{rbuf}) {
1450	my $data = substr $_[0]{rbuf}, $format, $len;	1832	my $data = substr $_[0]{rbuf}, $format, $len;
1451	substr $_[0]{rbuf}, 0, $format + $len, "";	1833	substr $_[0]{rbuf}, 0, $format + $len, "";
		1834
1452	$cb->($_[0], Storable::thaw ($data));	1835	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1836	or return $_[0]->_error (Errno::EBADMSG);
1453	} else {	1837	} else {
1454	# remove prefix	1838	# remove prefix
1455	substr $_[0]{rbuf}, 0, $format, "";	1839	substr $_[0]{rbuf}, 0, $format, "";
1456		1840
1457	# read remaining chunk	1841	# read remaining chunk
1458	$_[0]->unshift_read (chunk => $len, sub {	1842	$_[0]->unshift_read (chunk => $len, sub {
1459	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1843	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1460	$cb->($_[0], $ref);
1461	} else {
1462	$self->_error (Errno::EBADMSG);	1844	or $_[0]->_error (Errno::EBADMSG);
1463	}
1464	});	1845	});
1465	}	1846	}
1466		1847
1467	1	1848	1
1468	}	1849	}
1469	};	1850	};
1470		1851
		1852	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1853
		1854	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1855	record without consuming anything. Only SSL version 3 or higher
		1856	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1857	SSL2-compatible framing is supported).
		1858
		1859	If it detects that the input data is likely TLS, it calls the callback
		1860	with a true value for C<$detect> and the (on-wire) TLS version as second
		1861	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1862	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1863	be definitely not TLS, it calls the callback with a false value for
		1864	C<$detect>.
		1865
		1866	The callback could use this information to decide whether or not to start
		1867	TLS negotiation.
		1868
		1869	In all cases the data read so far is passed to the following read
		1870	handlers.
		1871
		1872	Usually you want to use the C<tls_autostart> read type instead.
		1873
		1874	If you want to design a protocol that works in the presence of TLS
		1875	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1876	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1877	read type does are a bit more strict, but might losen in the future to
		1878	accomodate protocol changes.
		1879
		1880	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1881	L<Net::SSLeay>).
		1882
		1883	=item tls_autostart => [$tls_ctx, ]$tls
		1884
		1885	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1886	to start tls by calling C<starttls> with the given arguments.
		1887
		1888	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1889	been configured to accept, as servers do not normally send a handshake on
		1890	their own and ths cannot be detected in this way.
		1891
		1892	See C<tls_detect> above for more details.
		1893
		1894	Example: give the client a chance to start TLS before accepting a text
		1895	line.
		1896
		1897	$hdl->push_read (tls_autostart => "accept");
		1898	$hdl->push_read (line => sub {
		1899	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1900	});
		1901
		1902	=cut
		1903
		1904	register_read_type tls_detect => sub {
		1905	my ($self, $cb) = @_;
		1906
		1907	sub {
		1908	# this regex matches a full or partial tls record
		1909	if (
		1910	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1911	$self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs
		1912	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1913	or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs
		1914	) {
		1915	return if 3 != length $1; # partial match, can't decide yet
		1916
		1917	# full match, valid TLS record
		1918	my ($major, $minor) = unpack "CC", $1;
		1919	$cb->($self, "accept", $major + $minor * 0.1);
		1920	} else {
		1921	# mismatch == guaranteed not TLS
		1922	$cb->($self, undef);
		1923	}
		1924
		1925	1
		1926	}
		1927	};
		1928
		1929	register_read_type tls_autostart => sub {
		1930	my ($self, @tls) = @_;
		1931
		1932	$RH{tls_detect}($self, sub {
		1933	return unless $_[1];
		1934	$_[0]->starttls (@tls);
		1935	})
		1936	};
		1937
1471	=back	1938	=back
1472		1939
1473	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1940	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1474		1941
1475	This function (not method) lets you add your own types to C<push_read>.	1942	Instead of one of the predefined types, you can also specify the name
		1943	of a package. AnyEvent will try to load the package and then expects to
		1944	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1945	progressively tries to load the parent package until it either finds the
		1946	function (good) or runs out of packages (bad).
1476		1947
1477	Whenever the given C<type> is used, C<push_read> will invoke the code	1948	Whenever this type is used, C<push_read> will invoke the function with the
1478	reference with the handle object, the callback and the remaining	1949	handle object, the original callback and the remaining arguments.
1479	arguments.
1480		1950
1481	The code reference is supposed to return a callback (usually a closure)	1951	The function is supposed to return a callback (usually a closure) that
1482	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1952	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1953	mentally treat the function as a "configurable read type to read callback"
		1954	converter.
1483		1955
1484	It should invoke the passed callback when it is done reading (remember to	1956	It should invoke the original callback when it is done reading (remember
1485	pass C<$handle> as first argument as all other callbacks do that).	1957	to pass C<$handle> as first argument as all other callbacks do that,
		1958	although there is no strict requirement on this).
1486		1959
1487	Note that this is a function, and all types registered this way will be
1488	global, so try to use unique names.
1489
1490	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1960	For examples, see the source of this module (F<perldoc -m
1491	search for C<register_read_type>)).	1961	AnyEvent::Handle>, search for C<register_read_type>)).
1492		1962
1493	=item $handle->stop_read	1963	=item $handle->stop_read
1494		1964
1495	=item $handle->start_read	1965	=item $handle->start_read
1496		1966
…		…
1502	Note that AnyEvent::Handle will automatically C<start_read> for you when	1972	Note that AnyEvent::Handle will automatically C<start_read> for you when
1503	you change the C<on_read> callback or push/unshift a read callback, and it	1973	you change the C<on_read> callback or push/unshift a read callback, and it
1504	will automatically C<stop_read> for you when neither C<on_read> is set nor	1974	will automatically C<stop_read> for you when neither C<on_read> is set nor
1505	there are any read requests in the queue.	1975	there are any read requests in the queue.
1506		1976
1507	These methods will have no effect when in TLS mode (as TLS doesn't support	1977	In older versions of this module (<= 5.3), these methods had no effect,
1508	half-duplex connections).	1978	as TLS does not support half-duplex connections. In current versions they
		1979	work as expected, as this behaviour is required to avoid certain resource
		1980	attacks, where the program would be forced to read (and buffer) arbitrary
		1981	amounts of data before being able to send some data. The drawback is that
		1982	some readings of the the SSL/TLS specifications basically require this
		1983	attack to be working, as SSL/TLS implementations might stall sending data
		1984	during a rehandshake.
		1985
		1986	As a guideline, during the initial handshake, you should not stop reading,
		1987	and as a client, it might cause problems, depending on your application.
1509		1988
1510	=cut	1989	=cut
1511		1990
1512	sub stop_read {	1991	sub stop_read {
1513	my ($self) = @_;	1992	my ($self) = @_;
1514		1993
1515	delete $self->{_rw} unless $self->{tls};	1994	delete $self->{_rw};
1516	}	1995	}
1517		1996
1518	sub start_read {	1997	sub start_read {
1519	my ($self) = @_;	1998	my ($self) = @_;
1520		1999
1521	unless ($self->{_rw} || $self->{_eof}) {	2000	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1522	Scalar::Util::weaken $self;	2001	Scalar::Util::weaken $self;
1523		2002
1524	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	2003	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1525	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	2004	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1526	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	2005	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1527		2006
1528	if ($len > 0) {	2007	if ($len > 0) {
1529	$self->{_activity} = AnyEvent->now;	2008	$self->{_activity} = $self->{_ractivity} = AE::now;
1530		2009
1531	if ($self->{tls}) {	2010	if ($self->{tls}) {
1532	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	2011	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1533		2012
1534	&_dotls ($self);	2013	&_dotls ($self);
1535	} else {	2014	} else {
1536	$self->_drain_rbuf;	2015	$self->_drain_rbuf;
1537	}	2016	}
1538		2017
		2018	if ($len == $self->{read_size}) {
		2019	$self->{read_size} *= 2;
		2020	$self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
		2021	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		2022	}
		2023
1539	} elsif (defined $len) {	2024	} elsif (defined $len) {
1540	delete $self->{_rw};	2025	delete $self->{_rw};
1541	$self->{_eof} = 1;	2026	$self->{_eof} = 1;
1542	$self->_drain_rbuf;	2027	$self->_drain_rbuf;
1543		2028
1544	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2029	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
1545	return $self->_error ($!, 1);	2030	return $self->_error ($!, 1);
1546	}	2031	}
1547	});	2032	};
1548	}	2033	}
1549	}	2034	}
1550		2035
1551	our $ERROR_SYSCALL;	2036	our $ERROR_SYSCALL;
1552	our $ERROR_WANT_READ;	2037	our $ERROR_WANT_READ;
…		…
1555	my ($self, $err) = @_;	2040	my ($self, $err) = @_;
1556		2041
1557	return $self->_error ($!, 1)	2042	return $self->_error ($!, 1)
1558	if $err == Net::SSLeay::ERROR_SYSCALL ();	2043	if $err == Net::SSLeay::ERROR_SYSCALL ();
1559		2044
1560	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2045	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1561		2046
1562	# reduce error string to look less scary	2047	# reduce error string to look less scary
1563	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2048	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1564		2049
1565	if ($self->{_on_starttls}) {	2050	if ($self->{_on_starttls}) {
…		…
1579	sub _dotls {	2064	sub _dotls {
1580	my ($self) = @_;	2065	my ($self) = @_;
1581		2066
1582	my $tmp;	2067	my $tmp;
1583		2068
1584	if (length $self->{_tls_wbuf}) {	2069	while (length $self->{_tls_wbuf}) {
1585	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2070	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1586	substr $self->{_tls_wbuf}, 0, $tmp, "";	2071	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2072
		2073	return $self->_tls_error ($tmp)
		2074	if $tmp != $ERROR_WANT_READ
		2075	&& ($tmp != $ERROR_SYSCALL || $!);
		2076
		2077	last;
1587	}	2078	}
1588		2079
1589	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2080	substr $self->{_tls_wbuf}, 0, $tmp, "";
1590	return $self->_tls_error ($tmp)
1591	if $tmp != $ERROR_WANT_READ
1592	&& ($tmp != $ERROR_SYSCALL || $!);
1593	}	2081	}
1594		2082
1595	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2083	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1596	unless (length $tmp) {	2084	unless (length $tmp) {
1597	$self->{_on_starttls}	2085	$self->{_on_starttls}
…		…
1611	$self->{_tls_rbuf} .= $tmp;	2099	$self->{_tls_rbuf} .= $tmp;
1612	$self->_drain_rbuf;	2100	$self->_drain_rbuf;
1613	$self->{tls} or return; # tls session might have gone away in callback	2101	$self->{tls} or return; # tls session might have gone away in callback
1614	}	2102	}
1615		2103
1616	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	2104	$tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us
1617	return $self->_tls_error ($tmp)	2105	return $self->_tls_error ($tmp)
1618	if $tmp != $ERROR_WANT_READ	2106	if $tmp != $ERROR_WANT_READ
1619	&& ($tmp != $ERROR_SYSCALL || $!);	2107	&& ($tmp != $ERROR_SYSCALL || $!);
1620		2108
1621	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2109	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1622	$self->{wbuf} .= $tmp;	2110	$self->{wbuf} .= $tmp;
1623	$self->_drain_wbuf;	2111	$self->_drain_wbuf;
		2112	$self->{tls} or return; # tls session might have gone away in callback
1624	}	2113	}
1625		2114
1626	$self->{_on_starttls}	2115	$self->{_on_starttls}
1627	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	2116	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1628	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	2117	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1630		2119
1631	=item $handle->starttls ($tls[, $tls_ctx])	2120	=item $handle->starttls ($tls[, $tls_ctx])
1632		2121
1633	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2122	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1634	object is created, you can also do that at a later time by calling	2123	object is created, you can also do that at a later time by calling
1635	C<starttls>.	2124	C<starttls>. See the C<tls> constructor argument for general info.
1636		2125
1637	Starting TLS is currently an asynchronous operation - when you push some	2126	Starting TLS is currently an asynchronous operation - when you push some
1638	write data and then call C<< ->starttls >> then TLS negotiation will start	2127	write data and then call C<< ->starttls >> then TLS negotiation will start
1639	immediately, after which the queued write data is then sent.	2128	immediately, after which the queued write data is then sent. This might
		2129	change in future versions, so best make sure you have no outstanding write
		2130	data when calling this method.
1640		2131
1641	The first argument is the same as the C<tls> constructor argument (either	2132	The first argument is the same as the C<tls> constructor argument (either
1642	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2133	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1643		2134
1644	The second argument is the optional C<AnyEvent::TLS> object that is used	2135	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1649	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	2140	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1650	context in C<< $handle->{tls_ctx} >> after this call and can be used or	2141	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1651	changed to your liking. Note that the handshake might have already started	2142	changed to your liking. Note that the handshake might have already started
1652	when this function returns.	2143	when this function returns.
1653		2144
1654	If it an error to start a TLS handshake more than once per	2145	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1655	AnyEvent::Handle object (this is due to bugs in OpenSSL).	2146	handshakes on the same stream. It is best to not attempt to use the
		2147	stream after stopping TLS.
		2148
		2149	This method may invoke callbacks (and therefore the handle might be
		2150	destroyed after it returns).
1656		2151
1657	=cut	2152	=cut
1658		2153
1659	our %TLS_CACHE; #TODO not yet documented, should we?	2154	our %TLS_CACHE; #TODO not yet documented, should we?
1660		2155
1661	sub starttls {	2156	sub starttls {
1662	my ($self, $ssl, $ctx) = @_;	2157	my ($self, $tls, $ctx) = @_;
1663		2158
1664	require Net::SSLeay;	2159	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1665
1666	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1667	if $self->{tls};	2160	if $self->{tls};
		2161
		2162	unless (defined $AnyEvent::TLS::VERSION) {
		2163	eval {
		2164	require Net::SSLeay;
		2165	require AnyEvent::TLS;
		2166	1
		2167	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2168	}
		2169
		2170	$self->{tls} = $tls;
		2171	$self->{tls_ctx} = $ctx if @_ > 2;
		2172
		2173	return unless $self->{fh};
1668		2174
1669	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2175	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1670	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2176	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1671		2177
		2178	$tls = delete $self->{tls};
1672	$ctx ||= $self->{tls_ctx};	2179	$ctx = $self->{tls_ctx};
1673		2180
1674	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2181	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1675		2182
1676	if ("HASH" eq ref $ctx) {	2183	if ("HASH" eq ref $ctx) {
1677	require AnyEvent::TLS;
1678
1679	if ($ctx->{cache}) {	2184	if ($ctx->{cache}) {
1680	my $key = $ctx+0;	2185	my $key = $ctx+0;
1681	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;	2186	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1682	} else {	2187	} else {
1683	$ctx = new AnyEvent::TLS %$ctx;	2188	$ctx = new AnyEvent::TLS %$ctx;
1684	}	2189	}
1685	}	2190	}
1686		2191
1687	$self->{tls_ctx} = $ctx || TLS_CTX ();	2192	$self->{tls_ctx} = $ctx || TLS_CTX ();
1688	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	2193	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1689		2194
1690	# basically, this is deep magic (because SSL_read should have the same issues)	2195	# basically, this is deep magic (because SSL_read should have the same issues)
1691	# but the openssl maintainers basically said: "trust us, it just works".	2196	# but the openssl maintainers basically said: "trust us, it just works".
1692	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	2197	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1693	# and mismaintained ssleay-module doesn't even offer them).	2198	# and mismaintained ssleay-module didn't offer them for a decade or so).
1694	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	2199	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1695	#	2200	#
1696	# in short: this is a mess.	2201	# in short: this is a mess.
1697	#	2202	#
1698	# note that we do not try to keep the length constant between writes as we are required to do.	2203	# note that we do not try to keep the length constant between writes as we are required to do.
1699	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	2204	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1700	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	2205	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1701	# have identity issues in that area.	2206	# have identity issues in that area.
1702	# Net::SSLeay::CTX_set_mode ($ssl,	2207	# Net::SSLeay::set_mode ($ssl,
1703	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	2208	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1704	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	2209	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1705	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	2210	Net::SSLeay::set_mode ($tls, 1|2);
1706		2211
1707	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2212	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1708	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2213	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1709		2214
		2215	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2216	$self->{rbuf} = "";
		2217
1710	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	2218	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1711		2219
1712	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2220	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1713	if $self->{on_starttls};	2221	if $self->{on_starttls};
1714		2222
1715	&_dotls; # need to trigger the initial handshake	2223	&_dotls; # need to trigger the initial handshake
…		…
1718		2226
1719	=item $handle->stoptls	2227	=item $handle->stoptls
1720		2228
1721	Shuts down the SSL connection - this makes a proper EOF handshake by	2229	Shuts down the SSL connection - this makes a proper EOF handshake by
1722	sending a close notify to the other side, but since OpenSSL doesn't	2230	sending a close notify to the other side, but since OpenSSL doesn't
1723	support non-blocking shut downs, it is not possible to re-use the stream	2231	support non-blocking shut downs, it is not guaranteed that you can re-use
1724	afterwards.	2232	the stream afterwards.
		2233
		2234	This method may invoke callbacks (and therefore the handle might be
		2235	destroyed after it returns).
1725		2236
1726	=cut	2237	=cut
1727		2238
1728	sub stoptls {	2239	sub stoptls {
1729	my ($self) = @_;	2240	my ($self) = @_;
1730		2241
1731	if ($self->{tls}) {	2242	if ($self->{tls} && $self->{fh}) {
1732	Net::SSLeay::shutdown ($self->{tls});	2243	Net::SSLeay::shutdown ($self->{tls});
1733		2244
1734	&_dotls;	2245	&_dotls;
1735		2246
1736	# # we don't give a shit. no, we do, but we can't. no...#d#	2247	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1742	sub _freetls {	2253	sub _freetls {
1743	my ($self) = @_;	2254	my ($self) = @_;
1744		2255
1745	return unless $self->{tls};	2256	return unless $self->{tls};
1746		2257
1747	$self->{tls_ctx}->_put_session (delete $self->{tls});	2258	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2259	if $self->{tls} > 0;
1748		2260
1749	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2261	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1750	}	2262	}
		2263
		2264	=item $handle->resettls
		2265
		2266	This rarely-used method simply resets and TLS state on the handle, usually
		2267	causing data loss.
		2268
		2269	One case where it may be useful is when you want to skip over the data in
		2270	the stream but you are not interested in interpreting it, so data loss is
		2271	no concern.
		2272
		2273	=cut
		2274
		2275	*resettls = \&_freetls;
1751		2276
1752	sub DESTROY {	2277	sub DESTROY {
1753	my ($self) = @_;	2278	my ($self) = @_;
1754		2279
1755	&_freetls;	2280	&_freetls;
…		…
1760	my $fh = delete $self->{fh};	2285	my $fh = delete $self->{fh};
1761	my $wbuf = delete $self->{wbuf};	2286	my $wbuf = delete $self->{wbuf};
1762		2287
1763	my @linger;	2288	my @linger;
1764		2289
1765	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2290	push @linger, AE::io $fh, 1, sub {
1766	my $len = syswrite $fh, $wbuf, length $wbuf;	2291	my $len = syswrite $fh, $wbuf, length $wbuf;
1767		2292
1768	if ($len > 0) {	2293	if ($len > 0) {
1769	substr $wbuf, 0, $len, "";	2294	substr $wbuf, 0, $len, "";
1770	} else {	2295	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) {
1771	@linger = (); # end	2296	@linger = (); # end
1772	}	2297	}
1773	});	2298	};
1774	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2299	push @linger, AE::timer $linger, 0, sub {
1775	@linger = ();	2300	@linger = ();
1776	});	2301	};
1777	}	2302	}
1778	}	2303	}
1779		2304
1780	=item $handle->destroy	2305	=item $handle->destroy
1781		2306
1782	Shuts down the handle object as much as possible - this call ensures that	2307	Shuts down the handle object as much as possible - this call ensures that
1783	no further callbacks will be invoked and as many resources as possible	2308	no further callbacks will be invoked and as many resources as possible
1784	will be freed. You must not call any methods on the object afterwards.	2309	will be freed. Any method you will call on the handle object after
		2310	destroying it in this way will be silently ignored (and it will return the
		2311	empty list).
1785		2312
1786	Normally, you can just "forget" any references to an AnyEvent::Handle	2313	Normally, you can just "forget" any references to an AnyEvent::Handle
1787	object and it will simply shut down. This works in fatal error and EOF	2314	object and it will simply shut down. This works in fatal error and EOF
1788	callbacks, as well as code outside. It does I<NOT> work in a read or write	2315	callbacks, as well as code outside. It does I<NOT> work in a read or write
1789	callback, so when you want to destroy the AnyEvent::Handle object from	2316	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1803	sub destroy {	2330	sub destroy {
1804	my ($self) = @_;	2331	my ($self) = @_;
1805		2332
1806	$self->DESTROY;	2333	$self->DESTROY;
1807	%$self = ();	2334	%$self = ();
		2335	bless $self, "AnyEvent::Handle::destroyed";
1808	}	2336	}
		2337
		2338	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2339	#nop
		2340	}
		2341
		2342	=item $handle->destroyed
		2343
		2344	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2345	->destroy >>, true otherwise.
		2346
		2347	Can be useful to decide whether the handle is still valid after some
		2348	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2349	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2350	can destroy the handle, so work can be avoided by checking sometimes:
		2351
		2352	$hdl->starttls ("accept");
		2353	return if $hdl->destroyed;
		2354	$hdl->push_write (...
		2355
		2356	Note that the call to C<push_write> will silently be ignored if the handle
		2357	has been destroyed, so often you can just ignore the possibility of the
		2358	handle being destroyed.
		2359
		2360	=cut
		2361
		2362	sub destroyed { 0 }
		2363	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1809		2364
1810	=item AnyEvent::Handle::TLS_CTX	2365	=item AnyEvent::Handle::TLS_CTX
1811		2366
1812	This function creates and returns the AnyEvent::TLS object used by default	2367	This function creates and returns the AnyEvent::TLS object used by default
1813	for TLS mode.	2368	for TLS mode.
…		…
1841		2396
1842	It is only safe to "forget" the reference inside EOF or error callbacks,	2397	It is only safe to "forget" the reference inside EOF or error callbacks,
1843	from within all other callbacks, you need to explicitly call the C<<	2398	from within all other callbacks, you need to explicitly call the C<<
1844	->destroy >> method.	2399	->destroy >> method.
1845		2400
		2401	=item Why is my C<on_eof> callback never called?
		2402
		2403	Probably because your C<on_error> callback is being called instead: When
		2404	you have outstanding requests in your read queue, then an EOF is
		2405	considered an error as you clearly expected some data.
		2406
		2407	To avoid this, make sure you have an empty read queue whenever your handle
		2408	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2409	an C<on_read> handler that simply pushes the first read requests in the
		2410	queue.
		2411
		2412	See also the next question, which explains this in a bit more detail.
		2413
		2414	=item How can I serve requests in a loop?
		2415
		2416	Most protocols consist of some setup phase (authentication for example)
		2417	followed by a request handling phase, where the server waits for requests
		2418	and handles them, in a loop.
		2419
		2420	There are two important variants: The first (traditional, better) variant
		2421	handles requests until the server gets some QUIT command, causing it to
		2422	close the connection first (highly desirable for a busy TCP server). A
		2423	client dropping the connection is an error, which means this variant can
		2424	detect an unexpected detection close.
		2425
		2426	To handle this case, always make sure you have a non-empty read queue, by
		2427	pushing the "read request start" handler on it:
		2428
		2429	# we assume a request starts with a single line
		2430	my @start_request; @start_request = (line => sub {
		2431	my ($hdl, $line) = @_;
		2432
		2433	... handle request
		2434
		2435	# push next request read, possibly from a nested callback
		2436	$hdl->push_read (@start_request);
		2437	});
		2438
		2439	# auth done, now go into request handling loop
		2440	# now push the first @start_request
		2441	$hdl->push_read (@start_request);
		2442
		2443	By always having an outstanding C<push_read>, the handle always expects
		2444	some data and raises the C<EPIPE> error when the connction is dropped
		2445	unexpectedly.
		2446
		2447	The second variant is a protocol where the client can drop the connection
		2448	at any time. For TCP, this means that the server machine may run out of
		2449	sockets easier, and in general, it means you cannot distinguish a protocl
		2450	failure/client crash from a normal connection close. Nevertheless, these
		2451	kinds of protocols are common (and sometimes even the best solution to the
		2452	problem).
		2453
		2454	Having an outstanding read request at all times is possible if you ignore
		2455	C<EPIPE> errors, but this doesn't help with when the client drops the
		2456	connection during a request, which would still be an error.
		2457
		2458	A better solution is to push the initial request read in an C<on_read>
		2459	callback. This avoids an error, as when the server doesn't expect data
		2460	(i.e. is idly waiting for the next request, an EOF will not raise an
		2461	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2462	and simpler:
		2463
		2464	# auth done, now go into request handling loop
		2465	$hdl->on_read (sub {
		2466	my ($hdl) = @_;
		2467
		2468	# called each time we receive data but the read queue is empty
		2469	# simply start read the request
		2470
		2471	$hdl->push_read (line => sub {
		2472	my ($hdl, $line) = @_;
		2473
		2474	... handle request
		2475
		2476	# do nothing special when the request has been handled, just
		2477	# let the request queue go empty.
		2478	});
		2479	});
		2480
1846	=item I get different callback invocations in TLS mode/Why can't I pause	2481	=item I get different callback invocations in TLS mode/Why can't I pause
1847	reading?	2482	reading?
1848		2483
1849	Unlike, say, TCP, TLS connections do not consist of two independent	2484	Unlike, say, TCP, TLS connections do not consist of two independent
1850	communication channels, one for each direction. Or put differently. The	2485	communication channels, one for each direction. Or put differently, the
1851	read and write directions are not independent of each other: you cannot	2486	read and write directions are not independent of each other: you cannot
1852	write data unless you are also prepared to read, and vice versa.	2487	write data unless you are also prepared to read, and vice versa.
1853		2488
1854	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2489	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1855	callback invocations when you are not expecting any read data - the reason	2490	callback invocations when you are not expecting any read data - the reason
1856	is that AnyEvent::Handle always reads in TLS mode.	2491	is that AnyEvent::Handle always reads in TLS mode.
1857		2492
1858	During the connection, you have to make sure that you always have a	2493	During the connection, you have to make sure that you always have a
1859	non-empty read-queue, or an C<on_read> watcher. At the end of the	2494	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1871	$handle->on_eof (undef);	2506	$handle->on_eof (undef);
1872	$handle->on_error (sub {	2507	$handle->on_error (sub {
1873	my $data = delete $_[0]{rbuf};	2508	my $data = delete $_[0]{rbuf};
1874	});	2509	});
1875		2510
		2511	Note that this example removes the C<rbuf> member from the handle object,
		2512	which is not normally allowed by the API. It is expressly permitted in
		2513	this case only, as the handle object needs to be destroyed afterwards.
		2514
1876	The reason to use C<on_error> is that TCP connections, due to latencies	2515	The reason to use C<on_error> is that TCP connections, due to latencies
1877	and packets loss, might get closed quite violently with an error, when in	2516	and packets loss, might get closed quite violently with an error, when in
1878	fact, all data has been received.	2517	fact all data has been received.
1879		2518
1880	It is usually better to use acknowledgements when transferring data,	2519	It is usually better to use acknowledgements when transferring data,
1881	to make sure the other side hasn't just died and you got the data	2520	to make sure the other side hasn't just died and you got the data
1882	intact. This is also one reason why so many internet protocols have an	2521	intact. This is also one reason why so many internet protocols have an
1883	explicit QUIT command.	2522	explicit QUIT command.
…		…
1890	C<low_water_mark> this will be called precisely when all data has been	2529	C<low_water_mark> this will be called precisely when all data has been
1891	written to the socket:	2530	written to the socket:
1892		2531
1893	$handle->push_write (...);	2532	$handle->push_write (...);
1894	$handle->on_drain (sub {	2533	$handle->on_drain (sub {
1895	warn "all data submitted to the kernel\n";	2534	AE::log debug => "All data submitted to the kernel.";
1896	undef $handle;	2535	undef $handle;
1897	});	2536	});
1898		2537
1899	If you just want to queue some data and then signal EOF to the other side,	2538	If you just want to queue some data and then signal EOF to the other side,
1900	consider using C<< ->push_shutdown >> instead.	2539	consider using C<< ->push_shutdown >> instead.
1901		2540
1902	=item I want to contact a TLS/SSL server, I don't care about security.	2541	=item I want to contact a TLS/SSL server, I don't care about security.
1903		2542
1904	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	2543	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1905	simply connect to it and then create the AnyEvent::Handle with the C<tls>	2544	connect to it and then create the AnyEvent::Handle with the C<tls>
1906	parameter:	2545	parameter:
1907		2546
1908	tcp_connect $host, $port, sub {	2547	tcp_connect $host, $port, sub {
1909	my ($fh) = @_;	2548	my ($fh) = @_;
1910		2549
…		…
1984	When you have intermediate CA certificates that your clients might not	2623	When you have intermediate CA certificates that your clients might not
1985	know about, just append them to the C<cert_file>.	2624	know about, just append them to the C<cert_file>.
1986		2625
1987	=back	2626	=back
1988		2627
1989
1990	=head1 SUBCLASSING AnyEvent::Handle	2628	=head1 SUBCLASSING AnyEvent::Handle
1991		2629
1992	In many cases, you might want to subclass AnyEvent::Handle.	2630	In many cases, you might want to subclass AnyEvent::Handle.
1993		2631
1994	To make this easier, a given version of AnyEvent::Handle uses these	2632	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2010		2648
2011	=item * all members not documented here and not prefixed with an underscore	2649	=item * all members not documented here and not prefixed with an underscore
2012	are free to use in subclasses.	2650	are free to use in subclasses.
2013		2651
2014	Of course, new versions of AnyEvent::Handle may introduce more "public"	2652	Of course, new versions of AnyEvent::Handle may introduce more "public"
2015	member variables, but thats just life, at least it is documented.	2653	member variables, but that's just life. At least it is documented.
2016		2654
2017	=back	2655	=back
2018		2656
2019	=head1 AUTHOR	2657	=head1 AUTHOR
2020		2658
2021	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2659	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2022		2660
2023	=cut	2661	=cut
2024		2662
2025	1; # End of AnyEvent::Handle	2663	1
		2664

Diff Legend

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