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

Diff Legend

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