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

Diff Legend

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