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.118 by root, Thu Feb 12 17:33:38 2009 UTC vs.
Revision 1.255 by root, Wed Jul 29 13:02:48 2020 UTC

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

Diff Legend

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