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

Diff Legend

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