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

Diff Legend

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