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

Diff Legend

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