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.96 by root, Thu Oct 2 08:10:27 2008 UTC vs.
Revision 1.217 by root, Thu Feb 3 00:29:33 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.3;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
32	$cv->broadcast;	15	my ($hdl, $fatal, $msg) = @_;
33	},	16	warn "got error $msg\n";
		17	$hdl->destroy;
		18	$cv->send;
34	);	19	};
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	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
64	=head2 SIGPIPE is not handled by this module	51	=cut
65		52
66	SIGPIPE is not handled by this module, so one of the practical	53	package AnyEvent::Handle;
67	requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} =	54
68	'IGNORE'>). At least, this is highly recommend in a networked program: If	55	use Scalar::Util ();
69	you use AnyEvent::Handle in a filter program (like sort), exiting on	56	use List::Util ();
70	SIGPIPE is probably the right thing to do.	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 }
71		81
72	=head1 METHODS	82	=head1 METHODS
73		83
74	=over 4	84	=over 4
75		85
76	=item B<new (%args)>	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
77		87
78	The constructor supports these arguments (all as key => value pairs).	88	The constructor supports these arguments (all as C<< key => value >> pairs).
79		89
80	=over 4	90	=over 4
81		91
82	=item fh => $filehandle [MANDATORY]	92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
83		93
84	The filehandle this L<AnyEvent::Handle> object will operate on.	94	The filehandle this L<AnyEvent::Handle> object will operate on.
85
86	NOTE: The filehandle will be set to non-blocking mode (using	95	NOTE: The filehandle will be set to non-blocking mode (using
87	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
88	that mode.	97	that mode.
89		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
90	=item on_eof => $cb->($handle)	116	=item on_prepare => $cb->($handle)
91		117
92	Set the callback to be called when an end-of-file condition is detected,	118	This (rarely used) callback is called before a new connection is
93	i.e. in the case of a socket, when the other side has closed the	119	attempted, but after the file handle has been created (you can access that
94	connection cleanly.	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).
95		123
96	For sockets, this just means that the other side has stopped sending data,	124	The return value of this callback should be the connect timeout value in
97	you can still try to write data, and, in fact, one can return from the eof	125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
98	callback and continue writing data, as only the read part has been shut	126	default timeout is to be used).
99	down.
100		127
101	While not mandatory, it is I<highly> recommended to set an eof callback,	128	=item on_connect => $cb->($handle, $host, $port, $retry->())
102	otherwise you might end up with a closed socket while you are still
103	waiting for data.
104		129
105	If an EOF condition has been detected but no C<on_eof> callback has been	130	This callback is called when a connection has been successfully established.
106	set, then a fatal error will be raised with C<$!> set to <0>.
107		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
108	=item on_error => $cb->($handle, $fatal)	154	=item on_error => $cb->($handle, $fatal, $message)
109		155
110	This is the error callback, which is called when, well, some error	156	This is the error callback, which is called when, well, some error
111	occured, such as not being able to resolve the hostname, failure to	157	occured, such as not being able to resolve the hostname, failure to
112	connect or a read error.	158	connect, or a read error.
113		159
114	Some errors are fatal (which is indicated by C<$fatal> being true). On	160	Some errors are fatal (which is indicated by C<$fatal> being true). On
115	fatal errors the handle object will be shut down and will not be usable	161	fatal errors the handle object will be destroyed (by a call to C<< ->
116	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal	162	destroy >>) after invoking the error callback (which means you are free to
117	errors are an EOF condition with active (but unsatisifable) read watchers	163	examine the handle object). Examples of fatal errors are an EOF condition
118	(C<EPIPE>) or I/O errors.	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.
119		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
120	Non-fatal errors can be retried by simply returning, but it is recommended	173	Non-fatal errors can be retried by returning, but it is recommended
121	to simply ignore this parameter and instead abondon the handle object	174	to simply ignore this parameter and instead abondon the handle object
122	when this callback is invoked. Examples of non-fatal errors are timeouts	175	when this callback is invoked. Examples of non-fatal errors are timeouts
123	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
124		177
125	On callback entrance, the value of C<$!> contains the operating system	178	On entry to the callback, the value of C<$!> contains the operating
126	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	179	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		180	C<EPROTO>).
127		181
128	While not mandatory, it is I<highly> recommended to set this callback, as	182	While not mandatory, it is I<highly> recommended to set this callback, as
129	you will not be notified of errors otherwise. The default simply calls	183	you will not be notified of errors otherwise. The default just calls
130	C<croak>.	184	C<croak>.
131		185
132	=item on_read => $cb->($handle)	186	=item on_read => $cb->($handle)
133		187
134	This sets the default read callback, which is called when data arrives	188	This sets the default read callback, which is called when data arrives
135	and no read request is in the queue (unlike read queue callbacks, this	189	and no read request is in the queue (unlike read queue callbacks, this
136	callback will only be called when at least one octet of data is in the	190	callback will only be called when at least one octet of data is in the
137	read buffer).	191	read buffer).
138		192
139	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	193	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
140	method or access the C<$handle->{rbuf}> member directly.	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.
141		197
		198	You can also call C<< ->push_read (...) >> or any other function that
		199	modifies the read queue. Or do both. Or ...
		200
142	When an EOF condition is detected then AnyEvent::Handle will first try to	201	When an EOF condition is detected, AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before	202	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	203	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>).	204	error will be raised (with C<$!> set to C<EPIPE>).
146		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
		211	=item on_eof => $cb->($handle)
		212
		213	Set the callback to be called when an end-of-file condition is detected,
		214	i.e. in the case of a socket, when the other side has closed the
		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).
		218
		219	For sockets, this just means that the other side has stopped sending data,
		220	you can still try to write data, and, in fact, one can return from the EOF
		221	callback and continue writing data, as only the read part has been shut
		222	down.
		223
		224	If an EOF condition has been detected but no C<on_eof> callback has been
		225	set, then a fatal error will be raised with C<$!> set to <0>.
		226
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
244	This will not work for partial TLS data that could not be encoded	390	This will not work for partial TLS data that could not be encoded
245	yet. This data will be lost. Calling the C<stoptls> method in time might	391	yet. This data will be lost. Calling the C<stoptls> method in time might
246	help.	392	help.
247		393
		394	=item peername => $string
		395
		396	A string used to identify the remote site - usually the DNS hostname
		397	(I<not> IDN!) used to create the connection, rarely the IP address.
		398
		399	Apart from being useful in error messages, this string is also used in 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>.
		403
248	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	404	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
249		405
250	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
251	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
252	established and will transparently encrypt/decrypt data afterwards.	408	established and will transparently encrypt/decrypt data afterwards.
		409
		410	All TLS protocol errors will be signalled as C<EPROTO>, with an
		411	appropriate error message.
253		412
254	TLS mode requires Net::SSLeay to be installed (it will be loaded	413	TLS mode requires Net::SSLeay to be installed (it will be loaded
255	automatically when you try to create a TLS handle): this module doesn't	414	automatically when you try to create a TLS handle): this module doesn't
256	have a dependency on that module, so if your module requires it, you have	415	have a dependency on that module, so if your module requires it, you have
257	to add the dependency yourself.	416	to add the dependency yourself.
…		…
261	mode.	420	mode.
262		421
263	You can also provide your own TLS connection object, but you have	422	You can also provide your own TLS connection object, but you have
264	to make sure that you call either C<Net::SSLeay::set_connect_state>	423	to make sure that you call either C<Net::SSLeay::set_connect_state>
265	or C<Net::SSLeay::set_accept_state> on it before you pass it to	424	or C<Net::SSLeay::set_accept_state> on it before you pass it to
266	AnyEvent::Handle.	425	AnyEvent::Handle. Also, this module will take ownership of this connection
		426	object.
267		427
		428	At some future point, AnyEvent::Handle might switch to another TLS
		429	implementation, then the option to use your own session object will go
		430	away.
		431
		432	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		433	passing in the wrong integer will lead to certain crash. This most often
		434	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		435	segmentation fault.
		436
268	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.
269		438
270	=item tls_ctx => $ssl_ctx	439	=item tls_ctx => $anyevent_tls
271		440
272	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	441	Use the given C<AnyEvent::TLS> object to create the new TLS connection
273	(unless a connection object was specified directly). If this parameter is	442	(unless a connection object was specified directly). If this
274	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>.
		445
		446	Instead of an object, you can also specify a hash reference with C<< key
		447	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		448	new TLS context object.
		449
		450	=item on_starttls => $cb->($handle, $success[, $error_message])
		451
		452	This callback will be invoked when the TLS/SSL handshake has finished. If
		453	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		454	(C<on_stoptls> will not be called in this case).
		455
		456	The session in C<< $handle->{tls} >> can still be examined in this
		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.
		468
		469	=item on_stoptls => $cb->($handle)
		470
		471	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		472	set, then it will be invoked after freeing the TLS session. If it is not,
		473	then a TLS shutdown condition will be treated like a normal EOF condition
		474	on the handle.
		475
		476	The session in C<< $handle->{tls} >> can still be examined in this
		477	callback.
		478
		479	This callback will only be called on TLS shutdowns, not when the
		480	underlying handle signals EOF.
275		481
276	=item json => JSON or JSON::XS object	482	=item json => JSON or JSON::XS object
277		483
278	This is the json coder object used by the C<json> read and write types.	484	This is the json coder object used by the C<json> read and write types.
279		485
…		…
288		494
289	=cut	495	=cut
290		496
291	sub new {	497	sub new {
292	my $class = shift;	498	my $class = shift;
293
294	my $self = bless { @_ }, $class;	499	my $self = bless { @_ }, $class;
295		500
296	$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 if $self;
		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;
297		572
298	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	573	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
299		574
		575	$self->{_activity} =
		576	$self->{_ractivity} =
		577	$self->{_wactivity} = AE::now;
		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
		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};
		589
		590	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		591
300	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	592	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
301	if $self->{tls};	593	if $self->{tls};
302		594
303	$self->{_activity} = AnyEvent->now;
304	$self->_timeout;
305
306	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	595	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
307	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
308		596
309	$self->start_read	597	$self->start_read
310	if $self->{on_read};	598	if $self->{on_read} || @{ $self->{_queue} };
311		599
312	$self	600	$self->_drain_wbuf;
313	}
314
315	sub _shutdown {
316	my ($self) = @_;
317
318	delete $self->{_tw};
319	delete $self->{_rw};
320	delete $self->{_ww};
321	delete $self->{fh};
322
323	&_freetls;
324
325	delete $self->{on_read};
326	delete $self->{_queue};
327	}	601	}
328		602
329	sub _error {	603	sub _error {
330	my ($self, $errno, $fatal) = @_;	604	my ($self, $errno, $fatal, $message) = @_;
331
332	$self->_shutdown
333	if $fatal;
334		605
335	$! = $errno;	606	$! = $errno;
		607	$message ||= "$!";
336		608
337	if ($self->{on_error}) {	609	if ($self->{on_error}) {
338	$self->{on_error}($self, $fatal);	610	$self->{on_error}($self, $fatal, $message);
339	} else {	611	$self->destroy if $fatal;
		612	} elsif ($self->{fh} || $self->{connect}) {
		613	$self->destroy;
340	Carp::croak "AnyEvent::Handle uncaught error: $!";	614	Carp::croak "AnyEvent::Handle uncaught error: $message";
341	}	615	}
342	}	616	}
343		617
344	=item $fh = $handle->fh	618	=item $fh = $handle->fh
345		619
…		…
369	$_[0]{on_eof} = $_[1];	643	$_[0]{on_eof} = $_[1];
370	}	644	}
371		645
372	=item $handle->on_timeout ($cb)	646	=item $handle->on_timeout ($cb)
373		647
374	Replace the current C<on_timeout> callback, or disables the callback (but	648	=item $handle->on_rtimeout ($cb)
375	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
376	argument and method.
377		649
378	=cut	650	=item $handle->on_wtimeout ($cb)
379		651
380	sub on_timeout {	652	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
381	$_[0]{on_timeout} = $_[1];	653	callback, or disables the callback (but not the timeout) if C<$cb> =
382	}	654	C<undef>. See the C<timeout> constructor argument and method.
		655
		656	=cut
		657
		658	# see below
383		659
384	=item $handle->autocork ($boolean)	660	=item $handle->autocork ($boolean)
385		661
386	Enables or disables the current autocork behaviour (see C<autocork>	662	Enables or disables the current autocork behaviour (see C<autocork>
387	constructor argument).	663	constructor argument). Changes will only take effect on the next write.
388		664
389	=cut	665	=cut
		666
		667	sub autocork {
		668	$_[0]{autocork} = $_[1];
		669	}
390		670
391	=item $handle->no_delay ($boolean)	671	=item $handle->no_delay ($boolean)
392		672
393	Enables or disables the C<no_delay> setting (see constructor argument of	673	Enables or disables the C<no_delay> setting (see constructor argument of
394	the same name for details).	674	the same name for details).
…		…
396	=cut	676	=cut
397		677
398	sub no_delay {	678	sub no_delay {
399	$_[0]{no_delay} = $_[1];	679	$_[0]{no_delay} = $_[1];
400		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
401	eval {	695	eval {
402	local $SIG{__DIE__};	696	local $SIG{__DIE__};
403	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};
404	};	699	};
405	}	700	}
406		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};
		733	};
		734	}
		735
		736	=item $handle->on_starttls ($cb)
		737
		738	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		739
		740	=cut
		741
		742	sub on_starttls {
		743	$_[0]{on_starttls} = $_[1];
		744	}
		745
		746	=item $handle->on_stoptls ($cb)
		747
		748	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		749
		750	=cut
		751
		752	sub on_stoptls {
		753	$_[0]{on_stoptls} = $_[1];
		754	}
		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
407	#############################################################################	774	#############################################################################
408		775
409	=item $handle->timeout ($seconds)	776	=item $handle->timeout ($seconds)
410		777
		778	=item $handle->rtimeout ($seconds)
		779
		780	=item $handle->wtimeout ($seconds)
		781
411	Configures (or disables) the inactivity timeout.	782	Configures (or disables) the inactivity timeout.
412		783
413	=cut	784	=item $handle->timeout_reset
414		785
415	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 {
416	my ($self, $timeout) = @_;	808	my ($self, $new_value) = @_;
417		809
		810	$new_value >= 0
		811	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		812
418	$self->{timeout} = $timeout;	813	$self->{$timeout} = $new_value;
419	$self->_timeout;	814	delete $self->{$tw}; &$cb;
420	}	815	};
421		816
		817	*{"${dir}timeout_reset"} = sub {
		818	$_[0]{$activity} = AE::now;
		819	};
		820
		821	# main workhorse:
422	# reset the timeout watcher, as neccessary	822	# reset the timeout watcher, as neccessary
423	# also check for time-outs	823	# also check for time-outs
424	sub _timeout {	824	$cb = sub {
425	my ($self) = @_;	825	my ($self) = @_;
426		826
427	if ($self->{timeout}) {	827	if ($self->{$timeout} && $self->{fh}) {
428	my $NOW = AnyEvent->now;	828	my $NOW = AE::now;
429		829
430	# when would the timeout trigger?	830	# when would the timeout trigger?
431	my $after = $self->{_activity} + $self->{timeout} - $NOW;	831	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
432		832
433	# now or in the past already?	833	# now or in the past already?
434	if ($after <= 0) {	834	if ($after <= 0) {
435	$self->{_activity} = $NOW;	835	$self->{$activity} = $NOW;
436		836
437	if ($self->{on_timeout}) {	837	if ($self->{$on_timeout}) {
438	$self->{on_timeout}($self);	838	$self->{$on_timeout}($self);
439	} else {	839	} else {
440	$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};
441	}	848	}
442		849
443	# callback could have changed timeout value, optimise	850	Scalar::Util::weaken $self;
444	return unless $self->{timeout};	851	return unless $self; # ->error could have destroyed $self
445		852
446	# calculate new after	853	$self->{$tw} ||= AE::timer $after, 0, sub {
447	$after = $self->{timeout};	854	delete $self->{$tw};
		855	$cb->($self);
		856	};
		857	} else {
		858	delete $self->{$tw};
448	}	859	}
449
450	Scalar::Util::weaken $self;
451	return unless $self; # ->error could have destroyed $self
452
453	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
454	delete $self->{_tw};
455	$self->_timeout;
456	});
457	} else {
458	delete $self->{_tw};
459	}	860	}
460	}	861	}
461		862
462	#############################################################################	863	#############################################################################
463		864
…		…
479	=item $handle->on_drain ($cb)	880	=item $handle->on_drain ($cb)
480		881
481	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
482	C<on_drain> in the constructor).	883	C<on_drain> in the constructor).
483		884
		885	This method may invoke callbacks (and therefore the handle might be
		886	destroyed after it returns).
		887
484	=cut	888	=cut
485		889
486	sub on_drain {	890	sub on_drain {
487	my ($self, $cb) = @_;	891	my ($self, $cb) = @_;
488		892
…		…
492	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});
493	}	897	}
494		898
495	=item $handle->push_write ($data)	899	=item $handle->push_write ($data)
496		900
497	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
498	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
499	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).
500		907
501	=cut	908	=cut
502		909
503	sub _drain_wbuf {	910	sub _drain_wbuf {
504	my ($self) = @_;	911	my ($self) = @_;
…		…
508	Scalar::Util::weaken $self;	915	Scalar::Util::weaken $self;
509		916
510	my $cb = sub {	917	my $cb = sub {
511	my $len = syswrite $self->{fh}, $self->{wbuf};	918	my $len = syswrite $self->{fh}, $self->{wbuf};
512		919
513	if ($len >= 0) {	920	if (defined $len) {
514	substr $self->{wbuf}, 0, $len, "";	921	substr $self->{wbuf}, 0, $len, "";
515		922
516	$self->{_activity} = AnyEvent->now;	923	$self->{_activity} = $self->{_wactivity} = AE::now;
517		924
518	$self->{on_drain}($self)	925	$self->{on_drain}($self)
519	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})
520	&& $self->{on_drain};	927	&& $self->{on_drain};
521		928
…		…
527		934
528	# try to write data immediately	935	# try to write data immediately
529	$cb->() unless $self->{autocork};	936	$cb->() unless $self->{autocork};
530		937
531	# if still data left in wbuf, we need to poll	938	# if still data left in wbuf, we need to poll
532	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	939	$self->{_ww} = AE::io $self->{fh}, 1, $cb
533	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	}
534	};	948	};
535	}	949	}
536		950
537	our %WH;	951	our %WH;
538		952
		953	# deprecated
539	sub register_write_type($$) {	954	sub register_write_type($$) {
540	$WH{$_[0]} = $_[1];	955	$WH{$_[0]} = $_[1];
541	}	956	}
542		957
543	sub push_write {	958	sub push_write {
544	my $self = shift;	959	my $self = shift;
545		960
546	if (@_ > 1) {	961	if (@_ > 1) {
547	my $type = shift;	962	my $type = shift;
548		963
		964	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
549	@_ = ($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")
550	->($self, @_);	966	->($self, @_);
551	}	967	}
552		968
		969	# we downgrade here to avoid hard-to-track-down bugs,
		970	# and diagnose the problem earlier and better.
		971
553	if ($self->{tls}) {	972	if ($self->{tls}) {
554	$self->{_tls_wbuf} .= $_[0];	973	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
555	&_dotls ($self);	974	&_dotls ($self) if $self->{fh};
556	} else {	975	} else {
557	$self->{wbuf} .= $_[0];	976	utf8::downgrade $self->{wbuf} .= $_[0];
558	$self->_drain_wbuf;	977	$self->_drain_wbuf if $self->{fh};
559	}	978	}
560	}	979	}
561		980
562	=item $handle->push_write (type => @args)	981	=item $handle->push_write (type => @args)
563		982
564	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
565	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).
566		988
567	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
568	drop by and tell us):	990	drop by and tell us):
569		991
570	=over 4	992	=over 4
…		…
627	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
628	this line into their JSON decoder of choice.	1050	this line into their JSON decoder of choice.
629		1051
630	=cut	1052	=cut
631		1053
		1054	sub json_coder() {
		1055	eval { require JSON::XS; JSON::XS->new->utf8 }
		1056	|| do { require JSON; JSON->new->utf8 }
		1057	}
		1058
632	register_write_type json => sub {	1059	register_write_type json => sub {
633	my ($self, $ref) = @_;	1060	my ($self, $ref) = @_;
634		1061
635	require JSON;	1062	my $json = $self->{json} ||= json_coder;
636		1063
637	$self->{json} ? $self->{json}->encode ($ref)	1064	$json->encode ($ref)
638	: JSON::encode_json ($ref)
639	};	1065	};
640		1066
641	=item storable => $reference	1067	=item storable => $reference
642		1068
643	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
…		…
653	pack "w/a*", Storable::nfreeze ($ref)	1079	pack "w/a*", Storable::nfreeze ($ref)
654	};	1080	};
655		1081
656	=back	1082	=back
657		1083
658	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1084	=item $handle->push_shutdown
659		1085
660	This function (not method) lets you add your own types to C<push_write>.	1086	Sometimes you know you want to close the socket after writing your data
		1087	before it was actually written. One way to do that is to replace your
		1088	C<on_drain> handler by a callback that shuts down the socket (and set
		1089	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1090	replaces the C<on_drain> callback with:
		1091
		1092	sub { shutdown $_[0]{fh}, 1 }
		1093
		1094	This simply shuts down the write side and signals an EOF condition to the
		1095	the peer.
		1096
		1097	You can rely on the normal read queue and C<on_eof> handling
		1098	afterwards. This is the cleanest way to close a connection.
		1099
		1100	This method may invoke callbacks (and therefore the handle might be
		1101	destroyed after it returns).
		1102
		1103	=cut
		1104
		1105	sub push_shutdown {
		1106	my ($self) = @_;
		1107
		1108	delete $self->{low_water_mark};
		1109	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1110	}
		1111
		1112	=item custom write types - Package::anyevent_write_type $handle, @args
		1113
		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
661	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
662	reference with the handle object and the remaining arguments.	1121	the handle object and the remaining arguments.
663		1122
664	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
665	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.
666		1126
667	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
668	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	}
669		1143
670	=cut	1144	=cut
671		1145
672	#############################################################################	1146	#############################################################################
673		1147
…		…
682	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
683	a queue.	1157	a queue.
684		1158
685	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
686	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
687	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
688	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
689	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>.
690		1165
691	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
692	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
693	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
694	done its job (see C<push_read>, below).	1169	done its job (see C<push_read>, below).
695		1170
696	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
697	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.
698		1173
…		…
755	=cut	1230	=cut
756		1231
757	sub _drain_rbuf {	1232	sub _drain_rbuf {
758	my ($self) = @_;	1233	my ($self) = @_;
759		1234
		1235	# avoid recursion
		1236	return if $self->{_skip_drain_rbuf};
760	local $self->{_in_drain} = 1;	1237	local $self->{_skip_drain_rbuf} = 1;
761
762	if (
763	defined $self->{rbuf_max}
764	&& $self->{rbuf_max} < length $self->{rbuf}
765	) {
766	$self->_error (&Errno::ENOSPC, 1), return;
767	}
768		1238
769	while () {	1239	while () {
		1240	# we need to use a separate tls read buffer, as we must not receive data while
		1241	# we are draining the buffer, and this can only happen with TLS.
		1242	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1243	if exists $self->{_tls_rbuf};
		1244
770	my $len = length $self->{rbuf};	1245	my $len = length $self->{rbuf};
771		1246
772	if (my $cb = shift @{ $self->{_queue} }) {	1247	if (my $cb = shift @{ $self->{_queue} }) {
773	unless ($cb->($self)) {	1248	unless ($cb->($self)) {
774	if ($self->{_eof}) {	1249	# no progress can be made
775	# no progress can be made (not enough data and no data forthcoming)	1250	# (not enough data and no data forthcoming)
776	$self->_error (&Errno::EPIPE, 1), return;	1251	$self->_error (Errno::EPIPE, 1), return
777	}	1252	if $self->{_eof};
778		1253
779	unshift @{ $self->{_queue} }, $cb;	1254	unshift @{ $self->{_queue} }, $cb;
780	last;	1255	last;
781	}	1256	}
782	} elsif ($self->{on_read}) {	1257	} elsif ($self->{on_read}) {
…		…
789	&& !@{ $self->{_queue} } # and the queue is still empty	1264	&& !@{ $self->{_queue} } # and the queue is still empty
790	&& $self->{on_read} # but we still have on_read	1265	&& $self->{on_read} # but we still have on_read
791	) {	1266	) {
792	# no further data will arrive	1267	# no further data will arrive
793	# so no progress can be made	1268	# so no progress can be made
794	$self->_error (&Errno::EPIPE, 1), return	1269	$self->_error (Errno::EPIPE, 1), return
795	if $self->{_eof};	1270	if $self->{_eof};
796		1271
797	last; # more data might arrive	1272	last; # more data might arrive
798	}	1273	}
799	} else {	1274	} else {
…		…
802	last;	1277	last;
803	}	1278	}
804	}	1279	}
805		1280
806	if ($self->{_eof}) {	1281	if ($self->{_eof}) {
807	if ($self->{on_eof}) {	1282	$self->{on_eof}
808	$self->{on_eof}($self)	1283	? $self->{on_eof}($self)
809	} else {	1284	: $self->_error (0, 1, "Unexpected end-of-file");
810	$self->_error (0, 1);	1285
811	}	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;
812	}	1294	}
813		1295
814	# may need to restart read watcher	1296	# may need to restart read watcher
815	unless ($self->{_rw}) {	1297	unless ($self->{_rw}) {
816	$self->start_read	1298	$self->start_read
…		…
822		1304
823	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
824	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
825	constructor.	1307	constructor.
826		1308
		1309	This method may invoke callbacks (and therefore the handle might be
		1310	destroyed after it returns).
		1311
827	=cut	1312	=cut
828		1313
829	sub on_read {	1314	sub on_read {
830	my ($self, $cb) = @_;	1315	my ($self, $cb) = @_;
831		1316
832	$self->{on_read} = $cb;	1317	$self->{on_read} = $cb;
833	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1318	$self->_drain_rbuf if $cb;
834	}	1319	}
835		1320
836	=item $handle->rbuf	1321	=item $handle->rbuf
837		1322
838	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).
839		1326
840	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1327	The only operation allowed on the read buffer (apart from looking at it)
841	you want.	1328	is removing data from its beginning. Otherwise modifying or appending to
		1329	it is not allowed and will lead to hard-to-track-down bugs.
842		1330
843	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>
844	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
845	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.
846		1335
847	=cut	1336	=cut
848		1337
849	sub rbuf : lvalue {	1338	sub rbuf : lvalue {
850	$_[0]{rbuf}	1339	$_[0]{rbuf}
…		…
867		1356
868	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
869	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
870	true, it will be removed from the queue.	1359	true, it will be removed from the queue.
871		1360
		1361	These methods may invoke callbacks (and therefore the handle might be
		1362	destroyed after it returns).
		1363
872	=cut	1364	=cut
873		1365
874	our %RH;	1366	our %RH;
875		1367
876	sub register_read_type($$) {	1368	sub register_read_type($$) {
…		…
882	my $cb = pop;	1374	my $cb = pop;
883		1375
884	if (@_) {	1376	if (@_) {
885	my $type = shift;	1377	my $type = shift;
886		1378
		1379	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
887	$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")
888	->($self, $cb, @_);	1381	->($self, $cb, @_);
889	}	1382	}
890		1383
891	push @{ $self->{_queue} }, $cb;	1384	push @{ $self->{_queue} }, $cb;
892	$self->_drain_rbuf unless $self->{_in_drain};	1385	$self->_drain_rbuf;
893	}	1386	}
894		1387
895	sub unshift_read {	1388	sub unshift_read {
896	my $self = shift;	1389	my $self = shift;
897	my $cb = pop;	1390	my $cb = pop;
898		1391
899	if (@_) {	1392	if (@_) {
900	my $type = shift;	1393	my $type = shift;
901		1394
		1395	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
902	$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")
903	->($self, $cb, @_);	1397	->($self, $cb, @_);
904	}	1398	}
905		1399
906
907	unshift @{ $self->{_queue} }, $cb;	1400	unshift @{ $self->{_queue} }, $cb;
908	$self->_drain_rbuf unless $self->{_in_drain};	1401	$self->_drain_rbuf;
909	}	1402	}
910		1403
911	=item $handle->push_read (type => @args, $cb)	1404	=item $handle->push_read (type => @args, $cb)
912		1405
913	=item $handle->unshift_read (type => @args, $cb)	1406	=item $handle->unshift_read (type => @args, $cb)
914		1407
915	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
916	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
917	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).
918		1413
919	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
920	drop by and tell us):	1415	drop by and tell us):
921		1416
922	=over 4	1417	=over 4
…		…
1014	the receive buffer when neither C<$accept> nor C<$reject> match,	1509	the receive buffer when neither C<$accept> nor C<$reject> match,
1015	and everything preceding and including the match will be accepted	1510	and everything preceding and including the match will be accepted
1016	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
1017	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
1018	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
1019	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.
1020		1515
1021	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
1022	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
1023	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
1024	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
1025	required for the accept regex.	1520	required for the accept regex.
1026		1521
1027	$handle->push_read (regex =>	1522	$handle->push_read (regex =>
…		…
1046	return 1;	1541	return 1;
1047	}	1542	}
1048		1543
1049	# reject	1544	# reject
1050	if ($reject && $$rbuf =~ $reject) {	1545	if ($reject && $$rbuf =~ $reject) {
1051	$self->_error (&Errno::EBADMSG);	1546	$self->_error (Errno::EBADMSG);
1052	}	1547	}
1053		1548
1054	# skip	1549	# skip
1055	if ($skip && $$rbuf =~ $skip) {	1550	if ($skip && $$rbuf =~ $skip) {
1056	$data .= substr $$rbuf, 0, $+[0], "";	1551	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1072	my ($self, $cb) = @_;	1567	my ($self, $cb) = @_;
1073		1568
1074	sub {	1569	sub {
1075	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1570	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1076	if ($_[0]{rbuf} =~ /[^0-9]/) {	1571	if ($_[0]{rbuf} =~ /[^0-9]/) {
1077	$self->_error (&Errno::EBADMSG);	1572	$self->_error (Errno::EBADMSG);
1078	}	1573	}
1079	return;	1574	return;
1080	}	1575	}
1081		1576
1082	my $len = $1;	1577	my $len = $1;
…		…
1085	my $string = $_[1];	1580	my $string = $_[1];
1086	$_[0]->unshift_read (chunk => 1, sub {	1581	$_[0]->unshift_read (chunk => 1, sub {
1087	if ($_[1] eq ",") {	1582	if ($_[1] eq ",") {
1088	$cb->($_[0], $string);	1583	$cb->($_[0], $string);
1089	} else {	1584	} else {
1090	$self->_error (&Errno::EBADMSG);	1585	$self->_error (Errno::EBADMSG);
1091	}	1586	}
1092	});	1587	});
1093	});	1588	});
1094		1589
1095	1	1590	1
…		…
1142	}	1637	}
1143	};	1638	};
1144		1639
1145	=item json => $cb->($handle, $hash_or_arrayref)	1640	=item json => $cb->($handle, $hash_or_arrayref)
1146		1641
1147	Reads a JSON object or array, decodes it and passes it to the callback.	1642	Reads a JSON object or array, decodes it and passes it to the
		1643	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1148		1644
1149	If a C<json> object was passed to the constructor, then that will be used	1645	If a C<json> object was passed to the constructor, then that will be used
1150	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1646	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1151		1647
1152	This read type uses the incremental parser available with JSON version	1648	This read type uses the incremental parser available with JSON version
…		…
1161	=cut	1657	=cut
1162		1658
1163	register_read_type json => sub {	1659	register_read_type json => sub {
1164	my ($self, $cb) = @_;	1660	my ($self, $cb) = @_;
1165		1661
1166	require JSON;	1662	my $json = $self->{json} ||= json_coder;
1167		1663
1168	my $data;	1664	my $data;
1169	my $rbuf = \$self->{rbuf};	1665	my $rbuf = \$self->{rbuf};
1170		1666
1171	my $json = $self->{json} ||= JSON->new->utf8;
1172
1173	sub {	1667	sub {
1174	my $ref = $json->incr_parse ($self->{rbuf});	1668	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1175		1669
1176	if ($ref) {	1670	if ($ref) {
1177	$self->{rbuf} = $json->incr_text;	1671	$self->{rbuf} = $json->incr_text;
1178	$json->incr_text = "";	1672	$json->incr_text = "";
1179	$cb->($self, $ref);	1673	$cb->($self, $ref);
1180		1674
1181	1	1675	1
		1676	} elsif ($@) {
		1677	# error case
		1678	$json->incr_skip;
		1679
		1680	$self->{rbuf} = $json->incr_text;
		1681	$json->incr_text = "";
		1682
		1683	$self->_error (Errno::EBADMSG);
		1684
		1685	()
1182	} else {	1686	} else {
1183	$self->{rbuf} = "";	1687	$self->{rbuf} = "";
		1688
1184	()	1689	()
1185	}	1690	}
1186	}	1691	}
1187	};	1692	};
1188		1693
…		…
1220	# read remaining chunk	1725	# read remaining chunk
1221	$_[0]->unshift_read (chunk => $len, sub {	1726	$_[0]->unshift_read (chunk => $len, sub {
1222	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1727	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1223	$cb->($_[0], $ref);	1728	$cb->($_[0], $ref);
1224	} else {	1729	} else {
1225	$self->_error (&Errno::EBADMSG);	1730	$self->_error (Errno::EBADMSG);
1226	}	1731	}
1227	});	1732	});
1228	}	1733	}
1229		1734
1230	1	1735	1
1231	}	1736	}
1232	};	1737	};
1233		1738
1234	=back	1739	=back
1235		1740
1236	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1741	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1237		1742
1238	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).
1239		1748
1240	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
1241	reference with the handle object, the callback and the remaining	1750	handle object, the original callback and the remaining arguments.
1242	arguments.
1243		1751
1244	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
1245	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.
1246		1756
1247	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
1248	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).
1249		1760
1250	Note that this is a function, and all types registered this way will be
1251	global, so try to use unique names.
1252
1253	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
1254	search for C<register_read_type>)).	1762	AnyEvent::Handle>, search for C<register_read_type>)).
1255		1763
1256	=item $handle->stop_read	1764	=item $handle->stop_read
1257		1765
1258	=item $handle->start_read	1766	=item $handle->start_read
1259		1767
…		…
1265	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
1266	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
1267	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
1268	there are any read requests in the queue.	1776	there are any read requests in the queue.
1269		1777
1270	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,
1271	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.
1272		1789
1273	=cut	1790	=cut
1274		1791
1275	sub stop_read {	1792	sub stop_read {
1276	my ($self) = @_;	1793	my ($self) = @_;
1277		1794
1278	delete $self->{_rw} unless $self->{tls};	1795	delete $self->{_rw};
1279	}	1796	}
1280		1797
1281	sub start_read {	1798	sub start_read {
1282	my ($self) = @_;	1799	my ($self) = @_;
1283		1800
1284	unless ($self->{_rw} || $self->{_eof}) {	1801	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1285	Scalar::Util::weaken $self;	1802	Scalar::Util::weaken $self;
1286		1803
1287	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1804	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1288	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1805	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1289	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1806	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1290		1807
1291	if ($len > 0) {	1808	if ($len > 0) {
1292	$self->{_activity} = AnyEvent->now;	1809	$self->{_activity} = $self->{_ractivity} = AE::now;
1293		1810
1294	if ($self->{tls}) {	1811	if ($self->{tls}) {
1295	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1812	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
		1813
1296	&_dotls ($self);	1814	&_dotls ($self);
1297	} else {	1815	} else {
1298	$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);
1299	}	1823	}
1300		1824
1301	} elsif (defined $len) {	1825	} elsif (defined $len) {
1302	delete $self->{_rw};	1826	delete $self->{_rw};
1303	$self->{_eof} = 1;	1827	$self->{_eof} = 1;
1304	$self->_drain_rbuf unless $self->{_in_drain};	1828	$self->_drain_rbuf;
1305		1829
1306	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1830	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1307	return $self->_error ($!, 1);	1831	return $self->_error ($!, 1);
1308	}	1832	}
1309	});	1833	};
1310	}	1834	}
1311	}	1835	}
1312		1836
		1837	our $ERROR_SYSCALL;
		1838	our $ERROR_WANT_READ;
		1839
		1840	sub _tls_error {
		1841	my ($self, $err) = @_;
		1842
		1843	return $self->_error ($!, 1)
		1844	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1845
		1846	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1847
		1848	# reduce error string to look less scary
		1849	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1850
		1851	if ($self->{_on_starttls}) {
		1852	(delete $self->{_on_starttls})->($self, undef, $err);
		1853	&_freetls;
		1854	} else {
		1855	&_freetls;
		1856	$self->_error (Errno::EPROTO, 1, $err);
		1857	}
		1858	}
		1859
		1860	# poll the write BIO and send the data if applicable
		1861	# also decode read data if possible
		1862	# this is basiclaly our TLS state machine
		1863	# more efficient implementations are possible with openssl,
		1864	# but not with the buggy and incomplete Net::SSLeay.
1313	sub _dotls {	1865	sub _dotls {
1314	my ($self) = @_;	1866	my ($self) = @_;
1315		1867
1316	my $buf;	1868	my $tmp;
1317		1869
1318	if (length $self->{_tls_wbuf}) {	1870	if (length $self->{_tls_wbuf}) {
1319	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1871	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1320	substr $self->{_tls_wbuf}, 0, $len, "";	1872	substr $self->{_tls_wbuf}, 0, $tmp, "";
1321	}	1873	}
1322	}
1323		1874
		1875	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1876	return $self->_tls_error ($tmp)
		1877	if $tmp != $ERROR_WANT_READ
		1878	&& ($tmp != $ERROR_SYSCALL || $!);
		1879	}
		1880
1324	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1881	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1325	unless (length $buf) {	1882	unless (length $tmp) {
1326	# let's treat SSL-eof as we treat normal EOF	1883	$self->{_on_starttls}
1327	delete $self->{_rw};	1884	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1328	$self->{_eof} = 1;
1329	&_freetls;	1885	&_freetls;
		1886
		1887	if ($self->{on_stoptls}) {
		1888	$self->{on_stoptls}($self);
		1889	return;
		1890	} else {
		1891	# let's treat SSL-eof as we treat normal EOF
		1892	delete $self->{_rw};
		1893	$self->{_eof} = 1;
		1894	}
1330	}	1895	}
1331		1896
1332	$self->{rbuf} .= $buf;	1897	$self->{_tls_rbuf} .= $tmp;
1333	$self->_drain_rbuf unless $self->{_in_drain};	1898	$self->_drain_rbuf;
1334	$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
1335	}	1900	}
1336		1901
1337	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1902	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1338
1339	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1340	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1341	return $self->_error ($!, 1);	1903	return $self->_tls_error ($tmp)
1342	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1904	if $tmp != $ERROR_WANT_READ
1343	return $self->_error (&Errno::EIO, 1);	1905	&& ($tmp != $ERROR_SYSCALL || $!);
1344	}
1345		1906
1346	# all others are fine for our purposes
1347	}
1348
1349	while (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1907	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1350	$self->{wbuf} .= $buf;	1908	$self->{wbuf} .= $tmp;
1351	$self->_drain_wbuf;	1909	$self->_drain_wbuf;
		1910	$self->{tls} or return; # tls session might have gone away in callback
1352	}	1911	}
		1912
		1913	$self->{_on_starttls}
		1914	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1915	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1353	}	1916	}
1354		1917
1355	=item $handle->starttls ($tls[, $tls_ctx])	1918	=item $handle->starttls ($tls[, $tls_ctx])
1356		1919
1357	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1920	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1358	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
1359	C<starttls>.	1922	C<starttls>.
1360		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.
		1927
1361	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
1362	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1929	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1363		1930
1364	The second argument is the optional C<Net::SSLeay::CTX> object that is	1931	The second argument is the optional C<AnyEvent::TLS> object that is used
1365	used when AnyEvent::Handle has to create its own TLS connection object.	1932	when AnyEvent::Handle has to create its own TLS connection object, or
		1933	a hash reference with C<< key => value >> pairs that will be used to
		1934	construct a new context.
1366		1935
1367	The TLS connection object will end up in C<< $handle->{tls} >> after this	1936	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1368	call and can be used or changed to your liking. Note that the handshake	1937	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1369	might have already started when this function returns.	1938	changed to your liking. Note that the handshake might have already started
		1939	when this function returns.
1370		1940
1371	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
1372	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.
1373		1944
		1945	This method may invoke callbacks (and therefore the handle might be
		1946	destroyed after it returns).
		1947
1374	=cut	1948	=cut
		1949
		1950	our %TLS_CACHE; #TODO not yet documented, should we?
1375		1951
1376	sub starttls {	1952	sub starttls {
1377	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};
1378		1962
1379	require Net::SSLeay;	1963	require Net::SSLeay;
1380		1964
1381	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"	1965	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1382	if $self->{tls};	1966	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1967
		1968	$tls = delete $self->{tls};
		1969	$ctx = $self->{tls_ctx};
		1970
		1971	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1972
		1973	if ("HASH" eq ref $ctx) {
		1974	require AnyEvent::TLS;
		1975
		1976	if ($ctx->{cache}) {
		1977	my $key = $ctx+0;
		1978	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1979	} else {
		1980	$ctx = new AnyEvent::TLS %$ctx;
		1981	}
		1982	}
1383		1983
1384	if ($ssl eq "accept") {	1984	$self->{tls_ctx} = $ctx || TLS_CTX ();
1385	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1985	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1386	Net::SSLeay::set_accept_state ($ssl);
1387	} elsif ($ssl eq "connect") {
1388	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1389	Net::SSLeay::set_connect_state ($ssl);
1390	}
1391
1392	$self->{tls} = $ssl;
1393		1986
1394	# 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)
1395	# but the openssl maintainers basically said: "trust us, it just works".	1988	# but the openssl maintainers basically said: "trust us, it just works".
1396	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1989	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1397	# and mismaintained ssleay-module doesn't even offer them).	1990	# and mismaintained ssleay-module doesn't even offer them).
…		…
1401	#	1994	#
1402	# note that we do not try to keep the length constant between writes as we are required to do.	1995	# note that we do not try to keep the length constant between writes as we are required to do.
1403	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1996	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1404	# 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
1405	# have identity issues in that area.	1998	# have identity issues in that area.
1406	Net::SSLeay::CTX_set_mode ($self->{tls},	1999	# Net::SSLeay::CTX_set_mode ($ssl,
1407	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	2000	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1408	| (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));
		2002	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1409		2003
1410	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2004	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1411	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2005	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1412		2006
		2007	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		2008
1413	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	2009	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		2010
		2011	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		2012	if $self->{on_starttls};
1414		2013
1415	&_dotls; # need to trigger the initial handshake	2014	&_dotls; # need to trigger the initial handshake
1416	$self->start_read; # make sure we actually do read	2015	$self->start_read; # make sure we actually do read
1417	}	2016	}
1418		2017
1419	=item $handle->stoptls	2018	=item $handle->stoptls
1420		2019
1421	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
1422	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
1423	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
1424	afterwards.	2023	the stream afterwards.
		2024
		2025	This method may invoke callbacks (and therefore the handle might be
		2026	destroyed after it returns).
1425		2027
1426	=cut	2028	=cut
1427		2029
1428	sub stoptls {	2030	sub stoptls {
1429	my ($self) = @_;	2031	my ($self) = @_;
1430		2032
1431	if ($self->{tls}) {	2033	if ($self->{tls} && $self->{fh}) {
1432	Net::SSLeay::shutdown ($self->{tls});	2034	Net::SSLeay::shutdown ($self->{tls});
1433		2035
1434	&_dotls;	2036	&_dotls;
1435		2037
1436	# we don't give a shit. no, we do, but we can't. no...	2038	# # we don't give a shit. no, we do, but we can't. no...#d#
1437	# we, we... have to use openssl :/	2039	# # we, we... have to use openssl :/#d#
1438	&_freetls;	2040	# &_freetls;#d#
1439	}	2041	}
1440	}	2042	}
1441		2043
1442	sub _freetls {	2044	sub _freetls {
1443	my ($self) = @_;	2045	my ($self) = @_;
1444		2046
1445	return unless $self->{tls};	2047	return unless $self->{tls};
1446		2048
1447	Net::SSLeay::free (delete $self->{tls});	2049	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2050	if $self->{tls} > 0;
1448		2051
1449	delete @$self{qw(_rbio _wbio _tls_wbuf)};	2052	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1450	}	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;
1451		2067
1452	sub DESTROY {	2068	sub DESTROY {
1453	my $self = shift;	2069	my ($self) = @_;
1454		2070
1455	&_freetls;	2071	&_freetls;
1456		2072
1457	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	2073	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1458		2074
1459	if ($linger && length $self->{wbuf}) {	2075	if ($linger && length $self->{wbuf} && $self->{fh}) {
1460	my $fh = delete $self->{fh};	2076	my $fh = delete $self->{fh};
1461	my $wbuf = delete $self->{wbuf};	2077	my $wbuf = delete $self->{wbuf};
1462		2078
1463	my @linger;	2079	my @linger;
1464		2080
1465	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2081	push @linger, AE::io $fh, 1, sub {
1466	my $len = syswrite $fh, $wbuf, length $wbuf;	2082	my $len = syswrite $fh, $wbuf, length $wbuf;
1467		2083
1468	if ($len > 0) {	2084	if ($len > 0) {
1469	substr $wbuf, 0, $len, "";	2085	substr $wbuf, 0, $len, "";
1470	} else {	2086	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1471	@linger = (); # end	2087	@linger = (); # end
1472	}	2088	}
		2089	};
		2090	push @linger, AE::timer $linger, 0, sub {
		2091	@linger = ();
		2092	};
		2093	}
		2094	}
		2095
		2096	=item $handle->destroy
		2097
		2098	Shuts down the handle object as much as possible - this call ensures that
		2099	no further callbacks will be invoked and as many resources as possible
		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).
		2103
		2104	Normally, you can just "forget" any references to an AnyEvent::Handle
		2105	object and it will simply shut down. This works in fatal error and EOF
		2106	callbacks, as well as code outside. It does I<NOT> work in a read or write
		2107	callback, so when you want to destroy the AnyEvent::Handle object from
		2108	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		2109	that case.
		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
		2116	The handle might still linger in the background and write out remaining
		2117	data, as specified by the C<linger> option, however.
		2118
		2119	=cut
		2120
		2121	sub destroy {
		2122	my ($self) = @_;
		2123
		2124	$self->DESTROY;
		2125	%$self = ();
		2126	bless $self, "AnyEvent::Handle::destroyed";
		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 }
		2155
		2156	=item AnyEvent::Handle::TLS_CTX
		2157
		2158	This function creates and returns the AnyEvent::TLS object used by default
		2159	for TLS mode.
		2160
		2161	The context is created by calling L<AnyEvent::TLS> without any arguments.
		2162
		2163	=cut
		2164
		2165	our $TLS_CTX;
		2166
		2167	sub TLS_CTX() {
		2168	$TLS_CTX ||= do {
		2169	require AnyEvent::TLS;
		2170
		2171	new AnyEvent::TLS
		2172	}
		2173	}
		2174
		2175	=back
		2176
		2177
		2178	=head1 NONFREQUENTLY ASKED QUESTIONS
		2179
		2180	=over 4
		2181
		2182	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		2183	still get further invocations!
		2184
		2185	That's because AnyEvent::Handle keeps a reference to itself when handling
		2186	read or write callbacks.
		2187
		2188	It is only safe to "forget" the reference inside EOF or error callbacks,
		2189	from within all other callbacks, you need to explicitly call the C<<
		2190	->destroy >> method.
		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.
1473	});	2269	});
1474	push @linger, AnyEvent->timer (after => $linger, cb => sub {
1475	@linger = ();
1476	});	2270	});
1477	}
1478	}
1479		2271
1480	=item AnyEvent::Handle::TLS_CTX	2272	=item I get different callback invocations in TLS mode/Why can't I pause
		2273	reading?
1481		2274
1482	This function creates and returns the Net::SSLeay::CTX object used by	2275	Unlike, say, TCP, TLS connections do not consist of two independent
1483	default for TLS mode.	2276	communication channels, one for each direction. Or put differently, the
		2277	read and write directions are not independent of each other: you cannot
		2278	write data unless you are also prepared to read, and vice versa.
1484		2279
1485	The context is created like this:	2280	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
		2281	callback invocations when you are not expecting any read data - the reason
		2282	is that AnyEvent::Handle always reads in TLS mode.
1486		2283
1487	Net::SSLeay::load_error_strings;	2284	During the connection, you have to make sure that you always have a
1488	Net::SSLeay::SSLeay_add_ssl_algorithms;	2285	non-empty read-queue, or an C<on_read> watcher. At the end of the
1489	Net::SSLeay::randomize;	2286	connection (or when you no longer want to use it) you can call the
1490		2287	C<destroy> method.
1491	my $CTX = Net::SSLeay::CTX_new;
1492
1493	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1494
1495	=cut
1496
1497	our $TLS_CTX;
1498
1499	sub TLS_CTX() {
1500	$TLS_CTX || do {
1501	require Net::SSLeay;
1502
1503	Net::SSLeay::load_error_strings ();
1504	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1505	Net::SSLeay::randomize ();
1506
1507	$TLS_CTX = Net::SSLeay::CTX_new ();
1508
1509	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1510
1511	$TLS_CTX
1512	}
1513	}
1514
1515	=back
1516
1517
1518	=head1 NONFREQUENTLY ASKED QUESTIONS
1519
1520	=over 4
1521		2288
1522	=item How do I read data until the other side closes the connection?	2289	=item How do I read data until the other side closes the connection?
1523		2290
1524	If you just want to read your data into a perl scalar, the easiest way	2291	If you just want to read your data into a perl scalar, the easiest way
1525	to achieve this is by setting an C<on_read> callback that does nothing,	2292	to achieve this is by setting an C<on_read> callback that does nothing,
…		…
1528		2295
1529	$handle->on_read (sub { });	2296	$handle->on_read (sub { });
1530	$handle->on_eof (undef);	2297	$handle->on_eof (undef);
1531	$handle->on_error (sub {	2298	$handle->on_error (sub {
1532	my $data = delete $_[0]{rbuf};	2299	my $data = delete $_[0]{rbuf};
1533	undef $handle;
1534	});	2300	});
1535		2301
1536	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
1537	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
1538	fact, all data has been received.	2304	fact all data has been received.
1539		2305
1540	It is usually better to use acknowledgements when transfering data,	2306	It is usually better to use acknowledgements when transferring data,
1541	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
1542	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
1543	explicit QUIT command.	2309	explicit QUIT command.
1544
1545		2310
1546	=item I don't want to destroy the handle too early - how do I wait until	2311	=item I don't want to destroy the handle too early - how do I wait until
1547	all data has been written?	2312	all data has been written?
1548		2313
1549	After writing your last bits of data, set the C<on_drain> callback	2314	After writing your last bits of data, set the C<on_drain> callback
…		…
1555	$handle->on_drain (sub {	2320	$handle->on_drain (sub {
1556	warn "all data submitted to the kernel\n";	2321	warn "all data submitted to the kernel\n";
1557	undef $handle;	2322	undef $handle;
1558	});	2323	});
1559		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
1560	=back	2413	=back
1561		2414
1562		2415
1563	=head1 SUBCLASSING AnyEvent::Handle	2416	=head1 SUBCLASSING AnyEvent::Handle
1564		2417
…		…
1583		2436
1584	=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
1585	are free to use in subclasses.	2438	are free to use in subclasses.
1586		2439
1587	Of course, new versions of AnyEvent::Handle may introduce more "public"	2440	Of course, new versions of AnyEvent::Handle may introduce more "public"
1588	member variables, but thats just life, at least it is documented.	2441	member variables, but that's just life. At least it is documented.
1589		2442
1590	=back	2443	=back
1591		2444
1592	=head1 AUTHOR	2445	=head1 AUTHOR
1593		2446

Diff Legend

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