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.150 by root, Thu Jul 16 04:16:25 2009 UTC vs.
Revision 1.213 by root, Sat Jan 15 20:32:45 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.82;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
…		…
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $hdl; $hdl = new AnyEvent::Handle	12	my $hdl; $hdl = new AnyEvent::Handle
29	fh => \*STDIN,	13	fh => \*STDIN,
30	on_error => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
31	warn "got error $_[2]\n";	16	warn "got error $msg\n";
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	);	19	};
34		20
35	# send some request line	21	# send some request line
36	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
37		23
38	# read the response line	24	# read the response line
…		…
44		30
45	$cv->recv;	31	$cv->recv;
46		32
47	=head1 DESCRIPTION	33	=head1 DESCRIPTION
48		34
49	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
50	filehandles. For utility functions for doing non-blocking connects and accepts	36	stream-based filehandles (sockets, pipes, and other stream things).
51	on sockets see L<AnyEvent::Util>.
52		37
53	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
54	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
55		40
56	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
57	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
58	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.
59		47
60	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
61	argument.	49	argument.
62		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
		80	sub MAX_READ_SIZE() { 131072 }
		81
63	=head1 METHODS	82	=head1 METHODS
64		83
65	=over 4	84	=over 4
66		85
67	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
68		87
69	The constructor supports these arguments (all as C<< key => value >> pairs).	88	The constructor supports these arguments (all as C<< key => value >> pairs).
70		89
71	=over 4	90	=over 4
72		91
73	=item fh => $filehandle [MANDATORY]	92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
74		93
75	The filehandle this L<AnyEvent::Handle> object will operate on.	94	The filehandle this L<AnyEvent::Handle> object will operate on.
76
77	NOTE: The filehandle will be set to non-blocking mode (using	95	NOTE: The filehandle will be set to non-blocking mode (using
78	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
79	that mode.	97	that mode.
		98
		99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		100
		101	Try to connect to the specified host and service (port), using
		102	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		103	default C<peername>.
		104
		105	You have to specify either this parameter, or C<fh>, above.
		106
		107	It is possible to push requests on the read and write queues, and modify
		108	properties of the stream, even while AnyEvent::Handle is connecting.
		109
		110	When this parameter is specified, then the C<on_prepare>,
		111	C<on_connect_error> and C<on_connect> callbacks will be called under the
		112	appropriate circumstances:
		113
		114	=over 4
		115
		116	=item on_prepare => $cb->($handle)
		117
		118	This (rarely used) callback is called before a new connection is
		119	attempted, but after the file handle has been created (you can access that
		120	file handle via C<< $handle->{fh} >>). It could be used to prepare the
		121	file handle with parameters required for the actual connect (as opposed to
		122	settings that can be changed when the connection is already established).
		123
		124	The return value of this callback should be the connect timeout value in
		125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
		126	default timeout is to be used).
		127
		128	=item on_connect => $cb->($handle, $host, $port, $retry->())
		129
		130	This callback is called when a connection has been successfully established.
		131
		132	The peer's numeric host and port (the socket peername) are passed as
		133	parameters, together with a retry callback.
		134
		135	If, for some reason, the handle is not acceptable, calling C<$retry>
		136	will continue with the next connection target (in case of multi-homed
		137	hosts or SRV records there can be multiple connection endpoints). At the
		138	time it is called the read and write queues, eof status, tls status and
		139	similar properties of the handle will have been reset.
		140
		141	In most cases, you should ignore the C<$retry> parameter.
		142
		143	=item on_connect_error => $cb->($handle, $message)
		144
		145	This callback is called when the connection could not be
		146	established. C<$!> will contain the relevant error code, and C<$message> a
		147	message describing it (usually the same as C<"$!">).
		148
		149	If this callback isn't specified, then C<on_error> will be called with a
		150	fatal error instead.
		151
		152	=back
		153
		154	=item on_error => $cb->($handle, $fatal, $message)
		155
		156	This is the error callback, which is called when, well, some error
		157	occured, such as not being able to resolve the hostname, failure to
		158	connect, or a read error.
		159
		160	Some errors are fatal (which is indicated by C<$fatal> being true). On
		161	fatal errors the handle object will be destroyed (by a call to C<< ->
		162	destroy >>) after invoking the error callback (which means you are free to
		163	examine the handle object). Examples of fatal errors are an EOF condition
		164	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
		165	cases where the other side can close the connection at will, it is
		166	often easiest to not report C<EPIPE> errors in this callback.
		167
		168	AnyEvent::Handle tries to find an appropriate error code for you to check
		169	against, but in some cases (TLS errors), this does not work well. It is
		170	recommended to always output the C<$message> argument in human-readable
		171	error messages (it's usually the same as C<"$!">).
		172
		173	Non-fatal errors can be retried by returning, but it is recommended
		174	to simply ignore this parameter and instead abondon the handle object
		175	when this callback is invoked. Examples of non-fatal errors are timeouts
		176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		177
		178	On entry to the callback, the value of C<$!> contains the operating
		179	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		180	C<EPROTO>).
		181
		182	While not mandatory, it is I<highly> recommended to set this callback, as
		183	you will not be notified of errors otherwise. The default just calls
		184	C<croak>.
		185
		186	=item on_read => $cb->($handle)
		187
		188	This sets the default read callback, which is called when data arrives
		189	and no read request is in the queue (unlike read queue callbacks, this
		190	callback will only be called when at least one octet of data is in the
		191	read buffer).
		192
		193	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		194	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		195	must not enlarge or modify the read buffer, you can only remove data at
		196	the beginning from it.
		197
		198	You can also call C<< ->push_read (...) >> or any other function that
		199	modifies the read queue. Or do both. Or ...
		200
		201	When an EOF condition is detected, AnyEvent::Handle will first try to
		202	feed all the remaining data to the queued callbacks and C<on_read> before
		203	calling the C<on_eof> callback. If no progress can be made, then a fatal
		204	error will be raised (with C<$!> set to C<EPIPE>).
		205
		206	Note that, unlike requests in the read queue, an C<on_read> callback
		207	doesn't mean you I<require> some data: if there is an EOF and there
		208	are outstanding read requests then an error will be flagged. With an
		209	C<on_read> callback, the C<on_eof> callback will be invoked.
80		210
81	=item on_eof => $cb->($handle)	211	=item on_eof => $cb->($handle)
82		212
83	Set the callback to be called when an end-of-file condition is detected,	213	Set the callback to be called when an end-of-file condition is detected,
84	i.e. in the case of a socket, when the other side has closed the	214	i.e. in the case of a socket, when the other side has closed the
…		…
92	down.	222	down.
93		223
94	If an EOF condition has been detected but no C<on_eof> callback has been	224	If an EOF condition has been detected but no C<on_eof> callback has been
95	set, then a fatal error will be raised with C<$!> set to <0>.	225	set, then a fatal error will be raised with C<$!> set to <0>.
96		226
97	=item on_error => $cb->($handle, $fatal, $message)
98
99	This is the error callback, which is called when, well, some error
100	occured, such as not being able to resolve the hostname, failure to
101	connect or a read error.
102
103	Some errors are fatal (which is indicated by C<$fatal> being true). On
104	fatal errors the handle object will be destroyed (by a call to C<< ->
105	destroy >>) after invoking the error callback (which means you are free to
106	examine the handle object). Examples of fatal errors are an EOF condition
107	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
108
109	AnyEvent::Handle tries to find an appropriate error code for you to check
110	against, but in some cases (TLS errors), this does not work well. It is
111	recommended to always output the C<$message> argument in human-readable
112	error messages (it's usually the same as C<"$!">).
113
114	Non-fatal errors can be retried by simply returning, but it is recommended
115	to simply ignore this parameter and instead abondon the handle object
116	when this callback is invoked. Examples of non-fatal errors are timeouts
117	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
118
119	On callback entrance, the value of C<$!> contains the operating system
120	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
121	C<EPROTO>).
122
123	While not mandatory, it is I<highly> recommended to set this callback, as
124	you will not be notified of errors otherwise. The default simply calls
125	C<croak>.
126
127	=item on_read => $cb->($handle)
128
129	This sets the default read callback, which is called when data arrives
130	and no read request is in the queue (unlike read queue callbacks, this
131	callback will only be called when at least one octet of data is in the
132	read buffer).
133
134	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
135	method or access the C<< $handle->{rbuf} >> member directly. Note that you
136	must not enlarge or modify the read buffer, you can only remove data at
137	the beginning from it.
138
139	When an EOF condition is detected then AnyEvent::Handle will first try to
140	feed all the remaining data to the queued callbacks and C<on_read> before
141	calling the C<on_eof> callback. If no progress can be made, then a fatal
142	error will be raised (with C<$!> set to C<EPIPE>).
143
144	Note that, unlike requests in the read queue, an C<on_read> callback
145	doesn't mean you I<require> some data: if there is an EOF and there
146	are outstanding read requests then an error will be flagged. With an
147	C<on_read> callback, the C<on_eof> callback will be invoked.
148
149	=item on_drain => $cb->($handle)	227	=item on_drain => $cb->($handle)
150		228
151	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
152	(or when the callback is set and the buffer is empty already).	230	(or immediately if the buffer is empty already).
153		231
154	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.
155		233
156	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
157	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
…		…
159	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
160	the file when the write queue becomes empty.	238	the file when the write queue becomes empty.
161		239
162	=item timeout => $fractional_seconds	240	=item timeout => $fractional_seconds
163		241
		242	=item rtimeout => $fractional_seconds
		243
		244	=item wtimeout => $fractional_seconds
		245
164	If non-zero, then this enables an "inactivity" timeout: whenever this many	246	If non-zero, then these enables an "inactivity" timeout: whenever this
165	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
166	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
167	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).
168		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
169	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
170	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
171	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
172	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
173	restart the timeout.	262	restart the timeout.
174		263
175	Zero (the default) disables this timeout.	264	Zero (the default) disables this timeout.
176		265
…		…
190	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
191	(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
192	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
193	isn't finished).	282	isn't finished).
194		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
195	=item autocork => <boolean>	299	=item autocork => <boolean>
196		300
197	When disabled (the default), then C<push_write> will try to immediately	301	When disabled (the default), C<push_write> will try to immediately
198	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
199	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
200	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
201	disadvantage is usually avoided by your kernel's nagle algorithm, see	305	disadvantage is usually avoided by your kernel's nagle algorithm, see
202	C<no_delay>, but this option can save costly syscalls).	306	C<no_delay>, but this option can save costly syscalls).
203		307
204	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
205	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,
206	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
207	the write buffer often is full). It also increases write latency.	311	the write buffer often is full). It also increases write latency.
208		312
209	=item no_delay => <boolean>	313	=item no_delay => <boolean>
…		…
213	the Nagle algorithm, and usually it is beneficial.	317	the Nagle algorithm, and usually it is beneficial.
214		318
215	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
216	accomplishd by setting this option to a true value.	320	accomplishd by setting this option to a true value.
217		321
218	The default is your opertaing system's default behaviour (most likely	322	The default is your operating system's default behaviour (most likely
219	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.
220		356
221	=item read_size => <bytes>	357	=item read_size => <bytes>
222		358
223	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
224	try to read during each loop iteration, which affects memory	360	read during each loop iteration. Each handle object will consume at least
225	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.
226		370
227	=item low_water_mark => <bytes>	371	=item low_water_mark => <bytes>
228		372
229	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
230	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
231	considered empty.	375	considered empty.
232		376
233	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
234	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
235	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
236	is good in almost all cases.	380	is good in almost all cases.
237		381
238	=item linger => <seconds>	382	=item linger => <seconds>
239		383
240	If non-zero (default: C<3600>), then the destructor of the	384	If this is non-zero (default: C<3600>), the destructor of the
241	AnyEvent::Handle object will check whether there is still outstanding	385	AnyEvent::Handle object will check whether there is still outstanding
242	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
243	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
244	system treats outstanding data at socket close time).	388	system treats outstanding data at socket close time).
245		389
…		…
252	A string used to identify the remote site - usually the DNS hostname	396	A string used to identify the remote site - usually the DNS hostname
253	(I<not> IDN!) used to create the connection, rarely the IP address.	397	(I<not> IDN!) used to create the connection, rarely the IP address.
254		398
255	Apart from being useful in error messages, this string is also used in TLS	399	Apart from being useful in error messages, this string is also used in TLS
256	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	400	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
257	verification will be skipped when C<peername> is not specified or	401	verification will be skipped when C<peername> is not specified or is
258	C<undef>.	402	C<undef>.
259		403
260	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	404	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
261		405
262	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
263	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
264	established and will transparently encrypt/decrypt data afterwards.	408	established and will transparently encrypt/decrypt data afterwards.
265		409
266	All TLS protocol errors will be signalled as C<EPROTO>, with an	410	All TLS protocol errors will be signalled as C<EPROTO>, with an
267	appropriate error message.	411	appropriate error message.
268		412
…		…
288	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	432	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
289	passing in the wrong integer will lead to certain crash. This most often	433	passing in the wrong integer will lead to certain crash. This most often
290	happens when one uses a stylish C<< tls => 1 >> and is surprised about the	434	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
291	segmentation fault.	435	segmentation fault.
292		436
293	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.
294		438
295	=item tls_ctx => $anyevent_tls	439	=item tls_ctx => $anyevent_tls
296		440
297	Use the given C<AnyEvent::TLS> object to create the new TLS connection	441	Use the given C<AnyEvent::TLS> object to create the new TLS connection
298	(unless a connection object was specified directly). If this parameter is	442	(unless a connection object was specified directly). If this
299	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>.
300		445
301	Instead of an object, you can also specify a hash reference with C<< key	446	Instead of an object, you can also specify a hash reference with C<< key
302	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	447	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
303	new TLS context object.	448	new TLS context object.
304		449
…		…
313		458
314	TLS handshake failures will not cause C<on_error> to be invoked when this	459	TLS handshake failures will not cause C<on_error> to be invoked when this
315	callback is in effect, instead, the error message will be passed to C<on_starttls>.	460	callback is in effect, instead, the error message will be passed to C<on_starttls>.
316		461
317	Without this callback, handshake failures lead to C<on_error> being	462	Without this callback, handshake failures lead to C<on_error> being
318	called, as normal.	463	called as usual.
319		464
320	Note that you cannot call C<starttls> right again in this callback. If you	465	Note that you cannot just call C<starttls> again in this callback. If you
321	need to do that, start an zero-second timer instead whose callback can	466	need to do that, start an zero-second timer instead whose callback can
322	then call C<< ->starttls >> again.	467	then call C<< ->starttls >> again.
323		468
324	=item on_stoptls => $cb->($handle)	469	=item on_stoptls => $cb->($handle)
325		470
…		…
351		496
352	sub new {	497	sub new {
353	my $class = shift;	498	my $class = shift;
354	my $self = bless { @_ }, $class;	499	my $self = bless { @_ }, $class;
355		500
356	$self->{fh} or Carp::croak "mandatory argument fh is missing";	501	if ($self->{fh}) {
		502	$self->_start;
		503	return unless $self->{fh}; # could be gone by now
		504
		505	} elsif ($self->{connect}) {
		506	require AnyEvent::Socket;
		507
		508	$self->{peername} = $self->{connect}[0]
		509	unless exists $self->{peername};
		510
		511	$self->{_skip_drain_rbuf} = 1;
		512
		513	{
		514	Scalar::Util::weaken (my $self = $self);
		515
		516	$self->{_connect} =
		517	AnyEvent::Socket::tcp_connect (
		518	$self->{connect}[0],
		519	$self->{connect}[1],
		520	sub {
		521	my ($fh, $host, $port, $retry) = @_;
		522
		523	delete $self->{_connect}; # no longer needed
		524
		525	if ($fh) {
		526	$self->{fh} = $fh;
		527
		528	delete $self->{_skip_drain_rbuf};
		529	$self->_start;
		530
		531	$self->{on_connect}
		532	and $self->{on_connect}($self, $host, $port, sub {
		533	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		534	$self->{_skip_drain_rbuf} = 1;
		535	&$retry;
		536	});
		537
		538	} else {
		539	if ($self->{on_connect_error}) {
		540	$self->{on_connect_error}($self, "$!");
		541	$self->destroy;
		542	} else {
		543	$self->_error ($!, 1);
		544	}
		545	}
		546	},
		547	sub {
		548	local $self->{fh} = $_[0];
		549
		550	$self->{on_prepare}
		551	? $self->{on_prepare}->($self)
		552	: ()
		553	}
		554	);
		555	}
		556
		557	} else {
		558	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		559	}
		560
		561	$self
		562	}
		563
		564	sub _start {
		565	my ($self) = @_;
		566
		567	# too many clueless people try to use udp and similar sockets
		568	# with AnyEvent::Handle, do them a favour.
		569	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		570	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		571	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
357		572
358	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	573	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
359		574
		575	$self->{_activity} =
		576	$self->{_ractivity} =
360	$self->{_activity} = AnyEvent->now;	577	$self->{_wactivity} = AE::now;
361	$self->_timeout;
362		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
363	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	587	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		588	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
364		589
		590	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		591
365	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	592	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
366	if $self->{tls};	593	if $self->{tls};
367		594
368	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	595	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
369		596
370	$self->start_read	597	$self->start_read
371	if $self->{on_read};	598	if $self->{on_read} || @{ $self->{_queue} };
372		599
373	$self->{fh} && $self	600	$self->_drain_wbuf;
374	}	601	}
375
376	#sub _shutdown {
377	# my ($self) = @_;
378	#
379	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
380	# $self->{_eof} = 1; # tell starttls et. al to stop trying
381	#
382	# &_freetls;
383	#}
384		602
385	sub _error {	603	sub _error {
386	my ($self, $errno, $fatal, $message) = @_;	604	my ($self, $errno, $fatal, $message) = @_;
387		605
388	$! = $errno;	606	$! = $errno;
389	$message ||= "$!";	607	$message ||= "$!";
390		608
391	if ($self->{on_error}) {	609	if ($self->{on_error}) {
392	$self->{on_error}($self, $fatal, $message);	610	$self->{on_error}($self, $fatal, $message);
393	$self->destroy;	611	$self->destroy if $fatal;
394	} elsif ($self->{fh}) {	612	} elsif ($self->{fh} || $self->{connect}) {
395	$self->destroy;	613	$self->destroy;
396	Carp::croak "AnyEvent::Handle uncaught error: $message";	614	Carp::croak "AnyEvent::Handle uncaught error: $message";
397	}	615	}
398	}	616	}
399		617
…		…
425	$_[0]{on_eof} = $_[1];	643	$_[0]{on_eof} = $_[1];
426	}	644	}
427		645
428	=item $handle->on_timeout ($cb)	646	=item $handle->on_timeout ($cb)
429		647
430	Replace the current C<on_timeout> callback, or disables the callback (but	648	=item $handle->on_rtimeout ($cb)
431	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
432	argument and method.
433		649
434	=cut	650	=item $handle->on_wtimeout ($cb)
435		651
436	sub on_timeout {	652	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
437	$_[0]{on_timeout} = $_[1];	653	callback, or disables the callback (but not the timeout) if C<$cb> =
438	}	654	C<undef>. See the C<timeout> constructor argument and method.
		655
		656	=cut
		657
		658	# see below
439		659
440	=item $handle->autocork ($boolean)	660	=item $handle->autocork ($boolean)
441		661
442	Enables or disables the current autocork behaviour (see C<autocork>	662	Enables or disables the current autocork behaviour (see C<autocork>
443	constructor argument). Changes will only take effect on the next write.	663	constructor argument). Changes will only take effect on the next write.
…		…
456	=cut	676	=cut
457		677
458	sub no_delay {	678	sub no_delay {
459	$_[0]{no_delay} = $_[1];	679	$_[0]{no_delay} = $_[1];
460		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
461	eval {	695	eval {
462	local $SIG{__DIE__};	696	local $SIG{__DIE__};
463	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	697	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		698	if $_[0]{fh};
		699	};
		700	}
		701
		702	=item $handle->oobinline ($boolean)
		703
		704	Enables or disables the C<oobinline> setting (see constructor argument of
		705	the same name for details).
		706
		707	=cut
		708
		709	sub oobinline {
		710	$_[0]{oobinline} = $_[1];
		711
		712	eval {
		713	local $SIG{__DIE__};
		714	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		715	if $_[0]{fh};
		716	};
		717	}
		718
		719	=item $handle->keepalive ($boolean)
		720
		721	Enables or disables the C<keepalive> setting (see constructor argument of
		722	the same name for details).
		723
		724	=cut
		725
		726	sub keepalive {
		727	$_[0]{keepalive} = $_[1];
		728
		729	eval {
		730	local $SIG{__DIE__};
		731	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		732	if $_[0]{fh};
464	};	733	};
465	}	734	}
466		735
467	=item $handle->on_starttls ($cb)	736	=item $handle->on_starttls ($cb)
468		737
…		…
478		747
479	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	748	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
480		749
481	=cut	750	=cut
482		751
483	sub on_starttls {	752	sub on_stoptls {
484	$_[0]{on_stoptls} = $_[1];	753	$_[0]{on_stoptls} = $_[1];
485	}	754	}
486		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 rbuf_max {
		771	$_[0]{wbuf_max} = $_[1];
		772	}
		773
487	#############################################################################	774	#############################################################################
488		775
489	=item $handle->timeout ($seconds)	776	=item $handle->timeout ($seconds)
490		777
		778	=item $handle->rtimeout ($seconds)
		779
		780	=item $handle->wtimeout ($seconds)
		781
491	Configures (or disables) the inactivity timeout.	782	Configures (or disables) the inactivity timeout.
492		783
493	=cut	784	=item $handle->timeout_reset
494		785
495	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 {
496	my ($self, $timeout) = @_;	808	my ($self, $new_value) = @_;
497		809
		810	$new_value >= 0
		811	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		812
498	$self->{timeout} = $timeout;	813	$self->{$timeout} = $new_value;
499	$self->_timeout;	814	delete $self->{$tw}; &$cb;
500	}	815	};
501		816
		817	*{"${dir}timeout_reset"} = sub {
		818	$_[0]{$activity} = AE::now;
		819	};
		820
		821	# main workhorse:
502	# reset the timeout watcher, as neccessary	822	# reset the timeout watcher, as neccessary
503	# also check for time-outs	823	# also check for time-outs
504	sub _timeout {	824	$cb = sub {
505	my ($self) = @_;	825	my ($self) = @_;
506		826
507	if ($self->{timeout}) {	827	if ($self->{$timeout} && $self->{fh}) {
508	my $NOW = AnyEvent->now;	828	my $NOW = AE::now;
509		829
510	# when would the timeout trigger?	830	# when would the timeout trigger?
511	my $after = $self->{_activity} + $self->{timeout} - $NOW;	831	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
512		832
513	# now or in the past already?	833	# now or in the past already?
514	if ($after <= 0) {	834	if ($after <= 0) {
515	$self->{_activity} = $NOW;	835	$self->{$activity} = $NOW;
516		836
517	if ($self->{on_timeout}) {	837	if ($self->{$on_timeout}) {
518	$self->{on_timeout}($self);	838	$self->{$on_timeout}($self);
519	} else {	839	} else {
520	$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};
521	}	848	}
522		849
523	# callback could have changed timeout value, optimise	850	Scalar::Util::weaken $self;
524	return unless $self->{timeout};	851	return unless $self; # ->error could have destroyed $self
525		852
526	# calculate new after	853	$self->{$tw} ||= AE::timer $after, 0, sub {
527	$after = $self->{timeout};	854	delete $self->{$tw};
		855	$cb->($self);
		856	};
		857	} else {
		858	delete $self->{$tw};
528	}	859	}
529
530	Scalar::Util::weaken $self;
531	return unless $self; # ->error could have destroyed $self
532
533	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
534	delete $self->{_tw};
535	$self->_timeout;
536	});
537	} else {
538	delete $self->{_tw};
539	}	860	}
540	}	861	}
541		862
542	#############################################################################	863	#############################################################################
543		864
…		…
559	=item $handle->on_drain ($cb)	880	=item $handle->on_drain ($cb)
560		881
561	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
562	C<on_drain> in the constructor).	883	C<on_drain> in the constructor).
563		884
		885	This method may invoke callbacks (and therefore the handle might be
		886	destroyed after it returns).
		887
564	=cut	888	=cut
565		889
566	sub on_drain {	890	sub on_drain {
567	my ($self, $cb) = @_;	891	my ($self, $cb) = @_;
568		892
…		…
572	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});
573	}	897	}
574		898
575	=item $handle->push_write ($data)	899	=item $handle->push_write ($data)
576		900
577	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
578	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
579	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).
580		907
581	=cut	908	=cut
582		909
583	sub _drain_wbuf {	910	sub _drain_wbuf {
584	my ($self) = @_;	911	my ($self) = @_;
…		…
591	my $len = syswrite $self->{fh}, $self->{wbuf};	918	my $len = syswrite $self->{fh}, $self->{wbuf};
592		919
593	if (defined $len) {	920	if (defined $len) {
594	substr $self->{wbuf}, 0, $len, "";	921	substr $self->{wbuf}, 0, $len, "";
595		922
596	$self->{_activity} = AnyEvent->now;	923	$self->{_activity} = $self->{_wactivity} = AE::now;
597		924
598	$self->{on_drain}($self)	925	$self->{on_drain}($self)
599	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})
600	&& $self->{on_drain};	927	&& $self->{on_drain};
601		928
…		…
607		934
608	# try to write data immediately	935	# try to write data immediately
609	$cb->() unless $self->{autocork};	936	$cb->() unless $self->{autocork};
610		937
611	# if still data left in wbuf, we need to poll	938	# if still data left in wbuf, we need to poll
612	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	939	$self->{_ww} = AE::io $self->{fh}, 1, $cb
613	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	}
614	};	948	};
615	}	949	}
616		950
617	our %WH;	951	our %WH;
618		952
		953	# deprecated
619	sub register_write_type($$) {	954	sub register_write_type($$) {
620	$WH{$_[0]} = $_[1];	955	$WH{$_[0]} = $_[1];
621	}	956	}
622		957
623	sub push_write {	958	sub push_write {
624	my $self = shift;	959	my $self = shift;
625		960
626	if (@_ > 1) {	961	if (@_ > 1) {
627	my $type = shift;	962	my $type = shift;
628		963
		964	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
629	@_ = ($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")
630	->($self, @_);	966	->($self, @_);
631	}	967	}
632		968
		969	# we downgrade here to avoid hard-to-track-down bugs,
		970	# and diagnose the problem earlier and better.
		971
633	if ($self->{tls}) {	972	if ($self->{tls}) {
634	$self->{_tls_wbuf} .= $_[0];	973	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
635		974	&_dotls ($self) if $self->{fh};
636	&_dotls ($self);
637	} else {	975	} else {
638	$self->{wbuf} .= $_[0];	976	utf8::downgrade $self->{wbuf} .= $_[0];
639	$self->_drain_wbuf;	977	$self->_drain_wbuf if $self->{fh};
640	}	978	}
641	}	979	}
642		980
643	=item $handle->push_write (type => @args)	981	=item $handle->push_write (type => @args)
644		982
645	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
646	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).
647		988
648	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
649	drop by and tell us):	990	drop by and tell us):
650		991
651	=over 4	992	=over 4
…		…
708	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
709	this line into their JSON decoder of choice.	1050	this line into their JSON decoder of choice.
710		1051
711	=cut	1052	=cut
712		1053
		1054	sub json_coder() {
		1055	eval { require JSON::XS; JSON::XS->new->utf8 }
		1056	|| do { require JSON; JSON->new->utf8 }
		1057	}
		1058
713	register_write_type json => sub {	1059	register_write_type json => sub {
714	my ($self, $ref) = @_;	1060	my ($self, $ref) = @_;
715		1061
716	require JSON;	1062	my $json = $self->{json} ||= json_coder;
717		1063
718	$self->{json} ? $self->{json}->encode ($ref)	1064	$json->encode ($ref)
719	: JSON::encode_json ($ref)
720	};	1065	};
721		1066
722	=item storable => $reference	1067	=item storable => $reference
723		1068
724	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
…		…
750	the peer.	1095	the peer.
751		1096
752	You can rely on the normal read queue and C<on_eof> handling	1097	You can rely on the normal read queue and C<on_eof> handling
753	afterwards. This is the cleanest way to close a connection.	1098	afterwards. This is the cleanest way to close a connection.
754		1099
		1100	This method may invoke callbacks (and therefore the handle might be
		1101	destroyed after it returns).
		1102
755	=cut	1103	=cut
756		1104
757	sub push_shutdown {	1105	sub push_shutdown {
758	my ($self) = @_;	1106	my ($self) = @_;
759		1107
760	delete $self->{low_water_mark};	1108	delete $self->{low_water_mark};
761	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1109	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
762	}	1110	}
763		1111
764	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1112	=item custom write types - Package::anyevent_write_type $handle, @args
765		1113
766	This function (not method) lets you add your own types to C<push_write>.	1114	Instead of one of the predefined types, you can also specify the name of
		1115	a package. AnyEvent will try to load the package and then expects to find
		1116	a function named C<anyevent_write_type> inside. If it isn't found, it
		1117	progressively tries to load the parent package until it either finds the
		1118	function (good) or runs out of packages (bad).
		1119
767	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
768	reference with the handle object and the remaining arguments.	1121	the handle object and the remaining arguments.
769		1122
770	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
771	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.
772		1126
773	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
774	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	}
775		1143
776	=cut	1144	=cut
777		1145
778	#############################################################################	1146	#############################################################################
779		1147
…		…
788	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
789	a queue.	1157	a queue.
790		1158
791	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
792	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
793	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
794	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
795	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>.
796		1165
797	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
798	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
799	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
800	done its job (see C<push_read>, below).	1169	done its job (see C<push_read>, below).
801		1170
802	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
803	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.
804		1173
…		…
861	=cut	1230	=cut
862		1231
863	sub _drain_rbuf {	1232	sub _drain_rbuf {
864	my ($self) = @_;	1233	my ($self) = @_;
865		1234
		1235	# avoid recursion
		1236	return if $self->{_skip_drain_rbuf};
866	local $self->{_in_drain} = 1;	1237	local $self->{_skip_drain_rbuf} = 1;
867
868	if (
869	defined $self->{rbuf_max}
870	&& $self->{rbuf_max} < length $self->{rbuf}
871	) {
872	$self->_error (Errno::ENOSPC, 1), return;
873	}
874		1238
875	while () {	1239	while () {
876	# we need to use a separate tls read buffer, as we must not receive data while	1240	# we need to use a separate tls read buffer, as we must not receive data while
877	# we are draining the buffer, and this can only happen with TLS.	1241	# we are draining the buffer, and this can only happen with TLS.
878	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1242	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1243	if exists $self->{_tls_rbuf};
879		1244
880	my $len = length $self->{rbuf};	1245	my $len = length $self->{rbuf};
881		1246
882	if (my $cb = shift @{ $self->{_queue} }) {	1247	if (my $cb = shift @{ $self->{_queue} }) {
883	unless ($cb->($self)) {	1248	unless ($cb->($self)) {
884	if ($self->{_eof}) {	1249	# no progress can be made
885	# no progress can be made (not enough data and no data forthcoming)	1250	# (not enough data and no data forthcoming)
886	$self->_error (Errno::EPIPE, 1), return;	1251	$self->_error (Errno::EPIPE, 1), return
887	}	1252	if $self->{_eof};
888		1253
889	unshift @{ $self->{_queue} }, $cb;	1254	unshift @{ $self->{_queue} }, $cb;
890	last;	1255	last;
891	}	1256	}
892	} elsif ($self->{on_read}) {	1257	} elsif ($self->{on_read}) {
…		…
912	last;	1277	last;
913	}	1278	}
914	}	1279	}
915		1280
916	if ($self->{_eof}) {	1281	if ($self->{_eof}) {
917	if ($self->{on_eof}) {	1282	$self->{on_eof}
918	$self->{on_eof}($self)	1283	? $self->{on_eof}($self)
919	} else {
920	$self->_error (0, 1, "Unexpected end-of-file");	1284	: $self->_error (0, 1, "Unexpected end-of-file");
921	}	1285
		1286	return;
		1287	}
		1288
		1289	if (
		1290	defined $self->{rbuf_max}
		1291	&& $self->{rbuf_max} < length $self->{rbuf}
		1292	) {
		1293	$self->_error (Errno::ENOSPC, 1), return;
922	}	1294	}
923		1295
924	# may need to restart read watcher	1296	# may need to restart read watcher
925	unless ($self->{_rw}) {	1297	unless ($self->{_rw}) {
926	$self->start_read	1298	$self->start_read
…		…
932		1304
933	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
934	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
935	constructor.	1307	constructor.
936		1308
		1309	This method may invoke callbacks (and therefore the handle might be
		1310	destroyed after it returns).
		1311
937	=cut	1312	=cut
938		1313
939	sub on_read {	1314	sub on_read {
940	my ($self, $cb) = @_;	1315	my ($self, $cb) = @_;
941		1316
942	$self->{on_read} = $cb;	1317	$self->{on_read} = $cb;
943	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1318	$self->_drain_rbuf if $cb;
944	}	1319	}
945		1320
946	=item $handle->rbuf	1321	=item $handle->rbuf
947		1322
948	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).
949		1326
950	You can access the read buffer directly as the C<< ->{rbuf} >>	1327	The only operation allowed on the read buffer (apart from looking at it)
951	member, if you want. However, the only operation allowed on the	1328	is removing data from its beginning. Otherwise modifying or appending to
952	read buffer (apart from looking at it) is removing data from its	1329	it is not allowed and will lead to hard-to-track-down bugs.
953	beginning. Otherwise modifying or appending to it is not allowed and will
954	lead to hard-to-track-down bugs.
955		1330
956	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>
957	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
958	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.
959		1335
960	=cut	1336	=cut
961		1337
962	sub rbuf : lvalue {	1338	sub rbuf : lvalue {
963	$_[0]{rbuf}	1339	$_[0]{rbuf}
…		…
980		1356
981	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
982	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
983	true, it will be removed from the queue.	1359	true, it will be removed from the queue.
984		1360
		1361	These methods may invoke callbacks (and therefore the handle might be
		1362	destroyed after it returns).
		1363
985	=cut	1364	=cut
986		1365
987	our %RH;	1366	our %RH;
988		1367
989	sub register_read_type($$) {	1368	sub register_read_type($$) {
…		…
995	my $cb = pop;	1374	my $cb = pop;
996		1375
997	if (@_) {	1376	if (@_) {
998	my $type = shift;	1377	my $type = shift;
999		1378
		1379	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1000	$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")
1001	->($self, $cb, @_);	1381	->($self, $cb, @_);
1002	}	1382	}
1003		1383
1004	push @{ $self->{_queue} }, $cb;	1384	push @{ $self->{_queue} }, $cb;
1005	$self->_drain_rbuf unless $self->{_in_drain};	1385	$self->_drain_rbuf;
1006	}	1386	}
1007		1387
1008	sub unshift_read {	1388	sub unshift_read {
1009	my $self = shift;	1389	my $self = shift;
1010	my $cb = pop;	1390	my $cb = pop;
1011		1391
1012	if (@_) {	1392	if (@_) {
1013	my $type = shift;	1393	my $type = shift;
1014		1394
		1395	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1015	$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")
1016	->($self, $cb, @_);	1397	->($self, $cb, @_);
1017	}	1398	}
1018		1399
1019
1020	unshift @{ $self->{_queue} }, $cb;	1400	unshift @{ $self->{_queue} }, $cb;
1021	$self->_drain_rbuf unless $self->{_in_drain};	1401	$self->_drain_rbuf;
1022	}	1402	}
1023		1403
1024	=item $handle->push_read (type => @args, $cb)	1404	=item $handle->push_read (type => @args, $cb)
1025		1405
1026	=item $handle->unshift_read (type => @args, $cb)	1406	=item $handle->unshift_read (type => @args, $cb)
1027		1407
1028	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
1029	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
1030	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).
1031		1413
1032	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
1033	drop by and tell us):	1415	drop by and tell us):
1034		1416
1035	=over 4	1417	=over 4
…		…
1127	the receive buffer when neither C<$accept> nor C<$reject> match,	1509	the receive buffer when neither C<$accept> nor C<$reject> match,
1128	and everything preceding and including the match will be accepted	1510	and everything preceding and including the match will be accepted
1129	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
1130	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
1131	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
1132	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.
1133		1515
1134	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
1135	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
1136	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
1137	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
1138	required for the accept regex.	1520	required for the accept regex.
1139		1521
1140	$handle->push_read (regex =>	1522	$handle->push_read (regex =>
…		…
1275	=cut	1657	=cut
1276		1658
1277	register_read_type json => sub {	1659	register_read_type json => sub {
1278	my ($self, $cb) = @_;	1660	my ($self, $cb) = @_;
1279		1661
1280	my $json = $self->{json} ||=	1662	my $json = $self->{json} ||= json_coder;
1281	eval { require JSON::XS; JSON::XS->new->utf8 }
1282	|| do { require JSON; JSON->new->utf8 };
1283		1663
1284	my $data;	1664	my $data;
1285	my $rbuf = \$self->{rbuf};	1665	my $rbuf = \$self->{rbuf};
1286		1666
1287	sub {	1667	sub {
…		…
1356	}	1736	}
1357	};	1737	};
1358		1738
1359	=back	1739	=back
1360		1740
1361	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1741	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1362		1742
1363	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).
1364		1748
1365	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
1366	reference with the handle object, the callback and the remaining	1750	handle object, the original callback and the remaining arguments.
1367	arguments.
1368		1751
1369	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
1370	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.
1371		1756
1372	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
1373	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).
1374		1760
1375	Note that this is a function, and all types registered this way will be
1376	global, so try to use unique names.
1377
1378	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
1379	search for C<register_read_type>)).	1762	AnyEvent::Handle>, search for C<register_read_type>)).
1380		1763
1381	=item $handle->stop_read	1764	=item $handle->stop_read
1382		1765
1383	=item $handle->start_read	1766	=item $handle->start_read
1384		1767
…		…
1390	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
1391	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
1392	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
1393	there are any read requests in the queue.	1776	there are any read requests in the queue.
1394		1777
1395	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,
1396	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.
1397		1789
1398	=cut	1790	=cut
1399		1791
1400	sub stop_read {	1792	sub stop_read {
1401	my ($self) = @_;	1793	my ($self) = @_;
1402		1794
1403	delete $self->{_rw} unless $self->{tls};	1795	delete $self->{_rw};
1404	}	1796	}
1405		1797
1406	sub start_read {	1798	sub start_read {
1407	my ($self) = @_;	1799	my ($self) = @_;
1408		1800
1409	unless ($self->{_rw} || $self->{_eof}) {	1801	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1410	Scalar::Util::weaken $self;	1802	Scalar::Util::weaken $self;
1411		1803
1412	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1804	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1413	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1805	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1414	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1806	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1415		1807
1416	if ($len > 0) {	1808	if ($len > 0) {
1417	$self->{_activity} = AnyEvent->now;	1809	$self->{_activity} = $self->{_ractivity} = AE::now;
1418		1810
1419	if ($self->{tls}) {	1811	if ($self->{tls}) {
1420	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1812	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1421		1813
1422	&_dotls ($self);	1814	&_dotls ($self);
1423	} else {	1815	} else {
1424	$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);
1425	}	1823	}
1426		1824
1427	} elsif (defined $len) {	1825	} elsif (defined $len) {
1428	delete $self->{_rw};	1826	delete $self->{_rw};
1429	$self->{_eof} = 1;	1827	$self->{_eof} = 1;
1430	$self->_drain_rbuf unless $self->{_in_drain};	1828	$self->_drain_rbuf;
1431		1829
1432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1830	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1433	return $self->_error ($!, 1);	1831	return $self->_error ($!, 1);
1434	}	1832	}
1435	});	1833	};
1436	}	1834	}
1437	}	1835	}
1438		1836
1439	our $ERROR_SYSCALL;	1837	our $ERROR_SYSCALL;
1440	our $ERROR_WANT_READ;	1838	our $ERROR_WANT_READ;
…		…
1495	$self->{_eof} = 1;	1893	$self->{_eof} = 1;
1496	}	1894	}
1497	}	1895	}
1498		1896
1499	$self->{_tls_rbuf} .= $tmp;	1897	$self->{_tls_rbuf} .= $tmp;
1500	$self->_drain_rbuf unless $self->{_in_drain};	1898	$self->_drain_rbuf;
1501	$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
1502	}	1900	}
1503		1901
1504	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1902	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1505	return $self->_tls_error ($tmp)	1903	return $self->_tls_error ($tmp)
…		…
1507	&& ($tmp != $ERROR_SYSCALL || $!);	1905	&& ($tmp != $ERROR_SYSCALL || $!);
1508		1906
1509	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1907	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1510	$self->{wbuf} .= $tmp;	1908	$self->{wbuf} .= $tmp;
1511	$self->_drain_wbuf;	1909	$self->_drain_wbuf;
		1910	$self->{tls} or return; # tls session might have gone away in callback
1512	}	1911	}
1513		1912
1514	$self->{_on_starttls}	1913	$self->{_on_starttls}
1515	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1914	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1516	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1915	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1519	=item $handle->starttls ($tls[, $tls_ctx])	1918	=item $handle->starttls ($tls[, $tls_ctx])
1520		1919
1521	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1920	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1522	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
1523	C<starttls>.	1922	C<starttls>.
		1923
		1924	Starting TLS is currently an asynchronous operation - when you push some
		1925	write data and then call C<< ->starttls >> then TLS negotiation will start
		1926	immediately, after which the queued write data is then sent.
1524		1927
1525	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
1526	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1929	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1527		1930
1528	The second argument is the optional C<AnyEvent::TLS> object that is used	1931	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1533	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1936	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1534	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1937	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1535	changed to your liking. Note that the handshake might have already started	1938	changed to your liking. Note that the handshake might have already started
1536	when this function returns.	1939	when this function returns.
1537		1940
1538	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
1539	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1942	handshakes on the same stream. It is best to not attempt to use the
		1943	stream after stopping TLS.
		1944
		1945	This method may invoke callbacks (and therefore the handle might be
		1946	destroyed after it returns).
1540		1947
1541	=cut	1948	=cut
1542		1949
1543	our %TLS_CACHE; #TODO not yet documented, should we?	1950	our %TLS_CACHE; #TODO not yet documented, should we?
1544		1951
1545	sub starttls {	1952	sub starttls {
1546	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};
1547		1962
1548	require Net::SSLeay;	1963	require Net::SSLeay;
1549
1550	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1551	if $self->{tls};
1552		1964
1553	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1965	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1554	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1966	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1555		1967
		1968	$tls = delete $self->{tls};
1556	$ctx ||= $self->{tls_ctx};	1969	$ctx = $self->{tls_ctx};
		1970
		1971	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1557		1972
1558	if ("HASH" eq ref $ctx) {	1973	if ("HASH" eq ref $ctx) {
1559	require AnyEvent::TLS;	1974	require AnyEvent::TLS;
1560
1561	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1562		1975
1563	if ($ctx->{cache}) {	1976	if ($ctx->{cache}) {
1564	my $key = $ctx+0;	1977	my $key = $ctx+0;
1565	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;	1978	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1566	} else {	1979	} else {
1567	$ctx = new AnyEvent::TLS %$ctx;	1980	$ctx = new AnyEvent::TLS %$ctx;
1568	}	1981	}
1569	}	1982	}
1570		1983
1571	$self->{tls_ctx} = $ctx || TLS_CTX ();	1984	$self->{tls_ctx} = $ctx || TLS_CTX ();
1572	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1985	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1573		1986
1574	# 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)
1575	# but the openssl maintainers basically said: "trust us, it just works".	1988	# but the openssl maintainers basically said: "trust us, it just works".
1576	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1989	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1577	# and mismaintained ssleay-module doesn't even offer them).	1990	# and mismaintained ssleay-module doesn't even offer them).
…		…
1584	# 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
1585	# have identity issues in that area.	1998	# have identity issues in that area.
1586	# Net::SSLeay::CTX_set_mode ($ssl,	1999	# Net::SSLeay::CTX_set_mode ($ssl,
1587	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	2000	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1588	# | (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));
1589	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	2002	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1590		2003
1591	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2004	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2005	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1593		2006
		2007	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		2008
1594	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	2009	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1595		2010
1596	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2011	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1597	if $self->{on_starttls};	2012	if $self->{on_starttls};
1598		2013
1599	&_dotls; # need to trigger the initial handshake	2014	&_dotls; # need to trigger the initial handshake
…		…
1602		2017
1603	=item $handle->stoptls	2018	=item $handle->stoptls
1604		2019
1605	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
1606	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
1607	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
1608	afterwards.	2023	the stream afterwards.
		2024
		2025	This method may invoke callbacks (and therefore the handle might be
		2026	destroyed after it returns).
1609		2027
1610	=cut	2028	=cut
1611		2029
1612	sub stoptls {	2030	sub stoptls {
1613	my ($self) = @_;	2031	my ($self) = @_;
1614		2032
1615	if ($self->{tls}) {	2033	if ($self->{tls} && $self->{fh}) {
1616	Net::SSLeay::shutdown ($self->{tls});	2034	Net::SSLeay::shutdown ($self->{tls});
1617		2035
1618	&_dotls;	2036	&_dotls;
1619		2037
1620	# # we don't give a shit. no, we do, but we can't. no...#d#	2038	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1626	sub _freetls {	2044	sub _freetls {
1627	my ($self) = @_;	2045	my ($self) = @_;
1628		2046
1629	return unless $self->{tls};	2047	return unless $self->{tls};
1630		2048
1631	$self->{tls_ctx}->_put_session (delete $self->{tls});	2049	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2050	if $self->{tls} > 0;
1632		2051
1633	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2052	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1634	}	2053	}
1635		2054
1636	sub DESTROY {	2055	sub DESTROY {
…		…
1638		2057
1639	&_freetls;	2058	&_freetls;
1640		2059
1641	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	2060	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1642		2061
1643	if ($linger && length $self->{wbuf}) {	2062	if ($linger && length $self->{wbuf} && $self->{fh}) {
1644	my $fh = delete $self->{fh};	2063	my $fh = delete $self->{fh};
1645	my $wbuf = delete $self->{wbuf};	2064	my $wbuf = delete $self->{wbuf};
1646		2065
1647	my @linger;	2066	my @linger;
1648		2067
1649	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2068	push @linger, AE::io $fh, 1, sub {
1650	my $len = syswrite $fh, $wbuf, length $wbuf;	2069	my $len = syswrite $fh, $wbuf, length $wbuf;
1651		2070
1652	if ($len > 0) {	2071	if ($len > 0) {
1653	substr $wbuf, 0, $len, "";	2072	substr $wbuf, 0, $len, "";
1654	} else {	2073	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1655	@linger = (); # end	2074	@linger = (); # end
1656	}	2075	}
1657	});	2076	};
1658	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2077	push @linger, AE::timer $linger, 0, sub {
1659	@linger = ();	2078	@linger = ();
1660	});	2079	};
1661	}	2080	}
1662	}	2081	}
1663		2082
1664	=item $handle->destroy	2083	=item $handle->destroy
1665		2084
1666	Shuts down the handle object as much as possible - this call ensures that	2085	Shuts down the handle object as much as possible - this call ensures that
1667	no further callbacks will be invoked and as many resources as possible	2086	no further callbacks will be invoked and as many resources as possible
1668	will be freed. You must not call any methods on the object afterwards.	2087	will be freed. Any method you will call on the handle object after
		2088	destroying it in this way will be silently ignored (and it will return the
		2089	empty list).
1669		2090
1670	Normally, you can just "forget" any references to an AnyEvent::Handle	2091	Normally, you can just "forget" any references to an AnyEvent::Handle
1671	object and it will simply shut down. This works in fatal error and EOF	2092	object and it will simply shut down. This works in fatal error and EOF
1672	callbacks, as well as code outside. It does I<NOT> work in a read or write	2093	callbacks, as well as code outside. It does I<NOT> work in a read or write
1673	callback, so when you want to destroy the AnyEvent::Handle object from	2094	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1687	sub destroy {	2108	sub destroy {
1688	my ($self) = @_;	2109	my ($self) = @_;
1689		2110
1690	$self->DESTROY;	2111	$self->DESTROY;
1691	%$self = ();	2112	%$self = ();
		2113	bless $self, "AnyEvent::Handle::destroyed";
1692	}	2114	}
		2115
		2116	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2117	#nop
		2118	}
		2119
		2120	=item $handle->destroyed
		2121
		2122	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2123	->destroy >>, true otherwise.
		2124
		2125	Can be useful to decide whether the handle is still valid after some
		2126	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2127	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2128	can destroy the handle, so work can be avoided by checking sometimes:
		2129
		2130	$hdl->starttls ("accept");
		2131	return if $hdl->destroyed;
		2132	$hdl->push_write (...
		2133
		2134	Note that the call to C<push_write> will silently be ignored if the handle
		2135	has been destroyed, so often you can just ignore the possibility of the
		2136	handle being destroyed.
		2137
		2138	=cut
		2139
		2140	sub destroyed { 0 }
		2141	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1693		2142
1694	=item AnyEvent::Handle::TLS_CTX	2143	=item AnyEvent::Handle::TLS_CTX
1695		2144
1696	This function creates and returns the AnyEvent::TLS object used by default	2145	This function creates and returns the AnyEvent::TLS object used by default
1697	for TLS mode.	2146	for TLS mode.
…		…
1725		2174
1726	It is only safe to "forget" the reference inside EOF or error callbacks,	2175	It is only safe to "forget" the reference inside EOF or error callbacks,
1727	from within all other callbacks, you need to explicitly call the C<<	2176	from within all other callbacks, you need to explicitly call the C<<
1728	->destroy >> method.	2177	->destroy >> method.
1729		2178
		2179	=item Why is my C<on_eof> callback never called?
		2180
		2181	Probably because your C<on_error> callback is being called instead: When
		2182	you have outstanding requests in your read queue, then an EOF is
		2183	considered an error as you clearly expected some data.
		2184
		2185	To avoid this, make sure you have an empty read queue whenever your handle
		2186	is supposed to be "idle" (i.e. connection closes are O.K.). You cna set
		2187	an C<on_read> handler that simply pushes the first read requests in the
		2188	queue.
		2189
		2190	See also the next question, which explains this in a bit more detail.
		2191
		2192	=item How can I serve requests in a loop?
		2193
		2194	Most protocols consist of some setup phase (authentication for example)
		2195	followed by a request handling phase, where the server waits for requests
		2196	and handles them, in a loop.
		2197
		2198	There are two important variants: The first (traditional, better) variant
		2199	handles requests until the server gets some QUIT command, causing it to
		2200	close the connection first (highly desirable for a busy TCP server). A
		2201	client dropping the connection is an error, which means this variant can
		2202	detect an unexpected detection close.
		2203
		2204	To handle this case, always make sure you have a on-empty read queue, by
		2205	pushing the "read request start" handler on it:
		2206
		2207	# we assume a request starts with a single line
		2208	my @start_request; @start_request = (line => sub {
		2209	my ($hdl, $line) = @_;
		2210
		2211	... handle request
		2212
		2213	# push next request read, possibly from a nested callback
		2214	$hdl->push_read (@start_request);
		2215	});
		2216
		2217	# auth done, now go into request handling loop
		2218	# now push the first @start_request
		2219	$hdl->push_read (@start_request);
		2220
		2221	By always having an outstanding C<push_read>, the handle always expects
		2222	some data and raises the C<EPIPE> error when the connction is dropped
		2223	unexpectedly.
		2224
		2225	The second variant is a protocol where the client can drop the connection
		2226	at any time. For TCP, this means that the server machine may run out of
		2227	sockets easier, and in general, it means you cnanot distinguish a protocl
		2228	failure/client crash from a normal connection close. Nevertheless, these
		2229	kinds of protocols are common (and sometimes even the best solution to the
		2230	problem).
		2231
		2232	Having an outstanding read request at all times is possible if you ignore
		2233	C<EPIPE> errors, but this doesn't help with when the client drops the
		2234	connection during a request, which would still be an error.
		2235
		2236	A better solution is to push the initial request read in an C<on_read>
		2237	callback. This avoids an error, as when the server doesn't expect data
		2238	(i.e. is idly waiting for the next request, an EOF will not raise an
		2239	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2240	and simpler:
		2241
		2242	# auth done, now go into request handling loop
		2243	$hdl->on_read (sub {
		2244	my ($hdl) = @_;
		2245
		2246	# called each time we receive data but the read queue is empty
		2247	# simply start read the request
		2248
		2249	$hdl->push_read (line => sub {
		2250	my ($hdl, $line) = @_;
		2251
		2252	... handle request
		2253
		2254	# do nothing special when the request has been handled, just
		2255	# let the request queue go empty.
		2256	});
		2257	});
		2258
1730	=item I get different callback invocations in TLS mode/Why can't I pause	2259	=item I get different callback invocations in TLS mode/Why can't I pause
1731	reading?	2260	reading?
1732		2261
1733	Unlike, say, TCP, TLS connections do not consist of two independent	2262	Unlike, say, TCP, TLS connections do not consist of two independent
1734	communication channels, one for each direction. Or put differently. The	2263	communication channels, one for each direction. Or put differently, the
1735	read and write directions are not independent of each other: you cannot	2264	read and write directions are not independent of each other: you cannot
1736	write data unless you are also prepared to read, and vice versa.	2265	write data unless you are also prepared to read, and vice versa.
1737		2266
1738	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2267	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1739	callback invocations when you are not expecting any read data - the reason	2268	callback invocations when you are not expecting any read data - the reason
1740	is that AnyEvent::Handle always reads in TLS mode.	2269	is that AnyEvent::Handle always reads in TLS mode.
1741		2270
1742	During the connection, you have to make sure that you always have a	2271	During the connection, you have to make sure that you always have a
1743	non-empty read-queue, or an C<on_read> watcher. At the end of the	2272	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1757	my $data = delete $_[0]{rbuf};	2286	my $data = delete $_[0]{rbuf};
1758	});	2287	});
1759		2288
1760	The reason to use C<on_error> is that TCP connections, due to latencies	2289	The reason to use C<on_error> is that TCP connections, due to latencies
1761	and packets loss, might get closed quite violently with an error, when in	2290	and packets loss, might get closed quite violently with an error, when in
1762	fact, all data has been received.	2291	fact all data has been received.
1763		2292
1764	It is usually better to use acknowledgements when transferring data,	2293	It is usually better to use acknowledgements when transferring data,
1765	to make sure the other side hasn't just died and you got the data	2294	to make sure the other side hasn't just died and you got the data
1766	intact. This is also one reason why so many internet protocols have an	2295	intact. This is also one reason why so many internet protocols have an
1767	explicit QUIT command.	2296	explicit QUIT command.
…		…
1784	consider using C<< ->push_shutdown >> instead.	2313	consider using C<< ->push_shutdown >> instead.
1785		2314
1786	=item I want to contact a TLS/SSL server, I don't care about security.	2315	=item I want to contact a TLS/SSL server, I don't care about security.
1787		2316
1788	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	2317	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1789	simply connect to it and then create the AnyEvent::Handle with the C<tls>	2318	connect to it and then create the AnyEvent::Handle with the C<tls>
1790	parameter:	2319	parameter:
1791		2320
1792	tcp_connect $host, $port, sub {	2321	tcp_connect $host, $port, sub {
1793	my ($fh) = @_;	2322	my ($fh) = @_;
1794		2323
…		…
1894		2423
1895	=item * all members not documented here and not prefixed with an underscore	2424	=item * all members not documented here and not prefixed with an underscore
1896	are free to use in subclasses.	2425	are free to use in subclasses.
1897		2426
1898	Of course, new versions of AnyEvent::Handle may introduce more "public"	2427	Of course, new versions of AnyEvent::Handle may introduce more "public"
1899	member variables, but thats just life, at least it is documented.	2428	member variables, but that's just life. At least it is documented.
1900		2429
1901	=back	2430	=back
1902		2431
1903	=head1 AUTHOR	2432	=head1 AUTHOR
1904		2433

Diff Legend

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