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.159 by root, Fri Jul 24 12:35:58 2009 UTC vs.
Revision 1.220 by root, Sun Jul 24 13:10:43 2011 UTC

1	package AnyEvent::Handle;
2
3	use Scalar::Util ();
4	use Carp ();
5	use Errno qw(EAGAIN EINTR);
6
7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
9
10	=head1 NAME	1	=head1 NAME
11		2
12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
13
14	=cut
15
16	our $VERSION = 4.86;
17		4
18	=head1 SYNOPSIS	5	=head1 SYNOPSIS
19		6
20	use AnyEvent;	7	use AnyEvent;
21	use AnyEvent::Handle;	8	use AnyEvent::Handle;
…		…
27	on_error => sub {	14	on_error => sub {
28	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
29	warn "got error $msg\n";	16	warn "got error $msg\n";
30	$hdl->destroy;	17	$hdl->destroy;
31	$cv->send;	18	$cv->send;
32	);	19	};
33		20
34	# send some request line	21	# send some request line
35	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
36		23
37	# read the response line	24	# read the response line
…		…
43		30
44	$cv->recv;	31	$cv->recv;
45		32
46	=head1 DESCRIPTION	33	=head1 DESCRIPTION
47		34
48	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
49	filehandles.	36	stream-based filehandles (sockets, pipes, and other stream things).
50		37
51	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
52	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
53		40
54	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
55	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
56	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
57		44
58	At the very minimum, you should specify C<fh> or C<connect>, and the	45	At the very minimum, you should specify C<fh> or C<connect>, and the
59	C<on_error> callback.	46	C<on_error> callback.
60		47
61	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
62	argument.	49	argument.
63		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
		80	sub MAX_READ_SIZE() { 131072 }
		81
64	=head1 METHODS	82	=head1 METHODS
65		83
66	=over 4	84	=over 4
67		85
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69		87
70	The constructor supports these arguments (all as C<< key => value >> pairs).	88	The constructor supports these arguments (all as C<< key => value >> pairs).
71		89
72	=over 4	90	=over 4
73		91
…		…
84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the	102	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
85	default C<peername>.	103	default C<peername>.
86		104
87	You have to specify either this parameter, or C<fh>, above.	105	You have to specify either this parameter, or C<fh>, above.
88		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
89	When this parameter is specified, then the C<on_prepare>,	110	When this parameter is specified, then the C<on_prepare>,
90	C<on_connect_error> and C<on_connect> callbacks will be called under the	111	C<on_connect_error> and C<on_connect> callbacks will be called under the
91	appropriate circumstances:	112	appropriate circumstances:
92		113
93	=over 4	114	=over 4
94		115
95	=item on_prepare => $cb->($handle)	116	=item on_prepare => $cb->($handle)
96		117
97	This (rarely used) callback is called before a new connection is	118	This (rarely used) callback is called before a new connection is
98	attempted, but after the file handle has been created. It could be used to	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
99	prepare the file handle with parameters required for the actual connect	121	file handle with parameters required for the actual connect (as opposed to
100	(as opposed to settings that can be changed when the connection is already	122	settings that can be changed when the connection is already established).
101	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).
102		127
103	=item on_connect => $cb->($handle, $host, $port, $retry->())	128	=item on_connect => $cb->($handle, $host, $port, $retry->())
104		129
105	This callback is called when a connection has been successfully established.	130	This callback is called when a connection has been successfully established.
106		131
107	The actual numeric host and port (the socket peername) are passed as	132	The peer's numeric host and port (the socket peername) are passed as
108	parameters, together with a retry callback.	133	parameters, together with a retry callback.
109		134
110	When, for some reason, the handle is not acceptable, then calling	135	If, for some reason, the handle is not acceptable, calling C<$retry>
111	C<$retry> will continue with the next conenction target (in case of	136	will continue with the next connection target (in case of multi-homed
112	multi-homed hosts or SRV records there can be multiple connection	137	hosts or SRV records there can be multiple connection endpoints). At the
113	endpoints). When it is called then the read and write queues, eof status,	138	time it is called the read and write queues, eof status, tls status and
114	tls status and similar properties of the handle are being reset.	139	similar properties of the handle will have been reset.
115		140
116	In most cases, ignoring the C<$retry> parameter is the way to go.	141	In most cases, you should ignore the C<$retry> parameter.
117		142
118	=item on_connect_error => $cb->($handle, $message)	143	=item on_connect_error => $cb->($handle, $message)
119		144
120	This callback is called when the conenction could not be	145	This callback is called when the connection could not be
121	established. C<$!> will contain the relevant error code, and C<$message> a	146	established. C<$!> will contain the relevant error code, and C<$message> a
122	message describing it (usually the same as C<"$!">).	147	message describing it (usually the same as C<"$!">).
123		148
124	If this callback isn't specified, then C<on_error> will be called with a	149	If this callback isn't specified, then C<on_error> will be called with a
125	fatal error instead.	150	fatal error instead.
…		…
128		153
129	=item on_error => $cb->($handle, $fatal, $message)	154	=item on_error => $cb->($handle, $fatal, $message)
130		155
131	This is the error callback, which is called when, well, some error	156	This is the error callback, which is called when, well, some error
132	occured, such as not being able to resolve the hostname, failure to	157	occured, such as not being able to resolve the hostname, failure to
133	connect or a read error.	158	connect, or a read error.
134		159
135	Some errors are fatal (which is indicated by C<$fatal> being true). On	160	Some errors are fatal (which is indicated by C<$fatal> being true). On
136	fatal errors the handle object will be destroyed (by a call to C<< ->	161	fatal errors the handle object will be destroyed (by a call to C<< ->
137	destroy >>) after invoking the error callback (which means you are free to	162	destroy >>) after invoking the error callback (which means you are free to
138	examine the handle object). Examples of fatal errors are an EOF condition	163	examine the handle object). Examples of fatal errors are an EOF condition
139	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In	164	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
140	cases where the other side can close the connection at their will it is	165	cases where the other side can close the connection at will, it is
141	often easiest to not report C<EPIPE> errors in this callback.	166	often easiest to not report C<EPIPE> errors in this callback.
142		167
143	AnyEvent::Handle tries to find an appropriate error code for you to check	168	AnyEvent::Handle tries to find an appropriate error code for you to check
144	against, but in some cases (TLS errors), this does not work well. It is	169	against, but in some cases (TLS errors), this does not work well. It is
145	recommended to always output the C<$message> argument in human-readable	170	recommended to always output the C<$message> argument in human-readable
146	error messages (it's usually the same as C<"$!">).	171	error messages (it's usually the same as C<"$!">).
147		172
148	Non-fatal errors can be retried by simply returning, but it is recommended	173	Non-fatal errors can be retried by returning, but it is recommended
149	to simply ignore this parameter and instead abondon the handle object	174	to simply ignore this parameter and instead abondon the handle object
150	when this callback is invoked. Examples of non-fatal errors are timeouts	175	when this callback is invoked. Examples of non-fatal errors are timeouts
151	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
152		177
153	On callback entrance, the value of C<$!> contains the operating system	178	On entry to the callback, the value of C<$!> contains the operating
154	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or	179	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
155	C<EPROTO>).	180	C<EPROTO>).
156		181
157	While not mandatory, it is I<highly> recommended to set this callback, as	182	While not mandatory, it is I<highly> recommended to set this callback, as
158	you will not be notified of errors otherwise. The default simply calls	183	you will not be notified of errors otherwise. The default just calls
159	C<croak>.	184	C<croak>.
160		185
161	=item on_read => $cb->($handle)	186	=item on_read => $cb->($handle)
162		187
163	This sets the default read callback, which is called when data arrives	188	This sets the default read callback, which is called when data arrives
…		…
168	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	193	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
169	method or access the C<< $handle->{rbuf} >> member directly. Note that you	194	method or access the C<< $handle->{rbuf} >> member directly. Note that you
170	must not enlarge or modify the read buffer, you can only remove data at	195	must not enlarge or modify the read buffer, you can only remove data at
171	the beginning from it.	196	the beginning from it.
172		197
		198	You can also call C<< ->push_read (...) >> or any other function that
		199	modifies the read queue. Or do both. Or ...
		200
173	When an EOF condition is detected then AnyEvent::Handle will first try to	201	When an EOF condition is detected, AnyEvent::Handle will first try to
174	feed all the remaining data to the queued callbacks and C<on_read> before	202	feed all the remaining data to the queued callbacks and C<on_read> before
175	calling the C<on_eof> callback. If no progress can be made, then a fatal	203	calling the C<on_eof> callback. If no progress can be made, then a fatal
176	error will be raised (with C<$!> set to C<EPIPE>).	204	error will be raised (with C<$!> set to C<EPIPE>).
177		205
178	Note that, unlike requests in the read queue, an C<on_read> callback	206	Note that, unlike requests in the read queue, an C<on_read> callback
…		…
197	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>.
198		226
199	=item on_drain => $cb->($handle)	227	=item on_drain => $cb->($handle)
200		228
201	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
202	(or when the callback is set and the buffer is empty already).	230	(or immediately if the buffer is empty already).
203		231
204	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.
205		233
206	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
207	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
…		…
209	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
210	the file when the write queue becomes empty.	238	the file when the write queue becomes empty.
211		239
212	=item timeout => $fractional_seconds	240	=item timeout => $fractional_seconds
213		241
		242	=item rtimeout => $fractional_seconds
		243
		244	=item wtimeout => $fractional_seconds
		245
214	If non-zero, then this enables an "inactivity" timeout: whenever this many	246	If non-zero, then these enables an "inactivity" timeout: whenever this
215	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
216	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
217	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).
218		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
219	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
220	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
221	idle then you should disable the timout temporarily or ignore the timeout	261	idle then you should disable the timeout temporarily or ignore the
222	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
223	restart the timeout.	263	AnyEvent::Handle will simply restart the timeout.
224		264
225	Zero (the default) disables this timeout.	265	Zero (the default) disables the corresponding timeout.
226		266
227	=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)
228		272
229	Called whenever the inactivity timeout passes. If you return from this	273	Called whenever the inactivity timeout passes. If you return from this
230	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,
231	so this condition is not fatal in any way.	275	so this condition is not fatal in any way.
232		276
…		…
240	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
241	(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
242	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
243	isn't finished).	287	isn't finished).
244		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
245	=item autocork => <boolean>	304	=item autocork => <boolean>
246		305
247	When disabled (the default), then C<push_write> will try to immediately	306	When disabled (the default), C<push_write> will try to immediately
248	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
249	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
250	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
251	disadvantage is usually avoided by your kernel's nagle algorithm, see	310	disadvantage is usually avoided by your kernel's nagle algorithm, see
252	C<no_delay>, but this option can save costly syscalls).	311	C<no_delay>, but this option can save costly syscalls).
253		312
254	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
255	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,
256	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
257	the write buffer often is full). It also increases write latency.	316	the write buffer often is full). It also increases write latency.
258		317
259	=item no_delay => <boolean>	318	=item no_delay => <boolean>
…		…
263	the Nagle algorithm, and usually it is beneficial.	322	the Nagle algorithm, and usually it is beneficial.
264		323
265	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
266	accomplishd by setting this option to a true value.	325	accomplishd by setting this option to a true value.
267		326
268	The default is your opertaing system's default behaviour (most likely	327	The default is your operating system's default behaviour (most likely
269	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.
270		361
271	=item read_size => <bytes>	362	=item read_size => <bytes>
272		363
273	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
274	try to read during each loop iteration, which affects memory	365	read during each loop iteration. Each handle object will consume at least
275	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.
276		375
277	=item low_water_mark => <bytes>	376	=item low_water_mark => <bytes>
278		377
279	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
280	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
281	considered empty.	380	considered empty.
282		381
283	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
284	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
285	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
286	is good in almost all cases.	385	is good in almost all cases.
287		386
288	=item linger => <seconds>	387	=item linger => <seconds>
289		388
290	If non-zero (default: C<3600>), then the destructor of the	389	If this is non-zero (default: C<3600>), the destructor of the
291	AnyEvent::Handle object will check whether there is still outstanding	390	AnyEvent::Handle object will check whether there is still outstanding
292	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
293	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
294	system treats outstanding data at socket close time).	393	system treats outstanding data at socket close time).
295		394
…		…
302	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
303	(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.
304		403
305	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
306	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	405	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
307	verification will be skipped when C<peername> is not specified or	406	verification will be skipped when C<peername> is not specified or is
308	C<undef>.	407	C<undef>.
309		408
310	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	409	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
311		410
312	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
313	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
314	established and will transparently encrypt/decrypt data afterwards.	413	established and will transparently encrypt/decrypt data afterwards.
315		414
316	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
317	appropriate error message.	416	appropriate error message.
318		417
…		…
338	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	437	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
339	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
340	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
341	segmentation fault.	440	segmentation fault.
342		441
343	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.
344		443
345	=item tls_ctx => $anyevent_tls	444	=item tls_ctx => $anyevent_tls
346		445
347	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
348	(unless a connection object was specified directly). If this parameter is	447	(unless a connection object was specified directly). If this
349	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>.
350		450
351	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
352	=> 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
353	new TLS context object.	453	new TLS context object.
354		454
…		…
363		463
364	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
365	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>.
366		466
367	Without this callback, handshake failures lead to C<on_error> being	467	Without this callback, handshake failures lead to C<on_error> being
368	called, as normal.	468	called as usual.
369		469
370	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
371	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
372	then call C<< ->starttls >> again.	472	then call C<< ->starttls >> again.
373		473
374	=item on_stoptls => $cb->($handle)	474	=item on_stoptls => $cb->($handle)
375		475
…		…
423	$self->{connect}[0],	523	$self->{connect}[0],
424	$self->{connect}[1],	524	$self->{connect}[1],
425	sub {	525	sub {
426	my ($fh, $host, $port, $retry) = @_;	526	my ($fh, $host, $port, $retry) = @_;
427		527
		528	delete $self->{_connect}; # no longer needed
		529
428	if ($fh) {	530	if ($fh) {
429	$self->{fh} = $fh;	531	$self->{fh} = $fh;
430		532
431	delete $self->{_skip_drain_rbuf};	533	delete $self->{_skip_drain_rbuf};
432	$self->_start;	534	$self->_start;
433		535
434	$self->{on_connect}	536	$self->{on_connect}
435	and $self->{on_connect}($self, $host, $port, sub {	537	and $self->{on_connect}($self, $host, $port, sub {
436	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};	538	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
437	$self->{_skip_drain_rbuf} = 1;	539	$self->{_skip_drain_rbuf} = 1;
438	&$retry;	540	&$retry;
439	});	541	});
440		542
441	} else {	543	} else {
442	if ($self->{on_connect_error}) {	544	if ($self->{on_connect_error}) {
443	$self->{on_connect_error}($self, "$!");	545	$self->{on_connect_error}($self, "$!");
444	$self->destroy;	546	$self->destroy if $self;
445	} else {	547	} else {
446	$self->fatal ($!, 1);	548	$self->_error ($!, 1);
447	}	549	}
448	}	550	}
449	},	551	},
450	sub {	552	sub {
451	local $self->{fh} = $_[0];	553	local $self->{fh} = $_[0];
452		554
		555	$self->{on_prepare}
453	$self->{on_prepare}->($self)	556	? $self->{on_prepare}->($self)
454	if $self->{on_prepare};	557	: ()
455	}	558	}
456	);	559	);
457	}	560	}
458		561
459	} else {	562	} else {
…		…
464	}	567	}
465		568
466	sub _start {	569	sub _start {
467	my ($self) = @_;	570	my ($self) = @_;
468		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;
		577
469	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	578	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
470		579
		580	$self->{_activity} =
		581	$self->{_ractivity} =
471	$self->{_activity} = AnyEvent->now;	582	$self->{_wactivity} = AE::now;
472	$self->_timeout;
473		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
474	$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};
475		594
		595	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		596
476	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	597	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
477	if $self->{tls};	598	if $self->{tls};
478		599
479	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	600	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
480		601
481	$self->start_read	602	$self->start_read
482	if $self->{on_read} || @{ $self->{_queue} };	603	if $self->{on_read} || @{ $self->{_queue} };
483	}
484		604
485	#sub _shutdown {	605	$self->_drain_wbuf;
486	# my ($self) = @_;	606	}
487	#
488	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
489	# $self->{_eof} = 1; # tell starttls et. al to stop trying
490	#
491	# &_freetls;
492	#}
493		607
494	sub _error {	608	sub _error {
495	my ($self, $errno, $fatal, $message) = @_;	609	my ($self, $errno, $fatal, $message) = @_;
496		610
497	$! = $errno;	611	$! = $errno;
498	$message ||= "$!";	612	$message ||= "$!";
499		613
500	if ($self->{on_error}) {	614	if ($self->{on_error}) {
501	$self->{on_error}($self, $fatal, $message);	615	$self->{on_error}($self, $fatal, $message);
502	$self->destroy if $fatal;	616	$self->destroy if $fatal;
503	} elsif ($self->{fh}) {	617	} elsif ($self->{fh} || $self->{connect}) {
504	$self->destroy;	618	$self->destroy;
505	Carp::croak "AnyEvent::Handle uncaught error: $message";	619	Carp::croak "AnyEvent::Handle uncaught error: $message";
506	}	620	}
507	}	621	}
508		622
…		…
534	$_[0]{on_eof} = $_[1];	648	$_[0]{on_eof} = $_[1];
535	}	649	}
536		650
537	=item $handle->on_timeout ($cb)	651	=item $handle->on_timeout ($cb)
538		652
539	Replace the current C<on_timeout> callback, or disables the callback (but	653	=item $handle->on_rtimeout ($cb)
540	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
541	argument and method.
542		654
543	=cut	655	=item $handle->on_wtimeout ($cb)
544		656
545	sub on_timeout {	657	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
546	$_[0]{on_timeout} = $_[1];	658	callback, or disables the callback (but not the timeout) if C<$cb> =
547	}	659	C<undef>. See the C<timeout> constructor argument and method.
		660
		661	=cut
		662
		663	# see below
548		664
549	=item $handle->autocork ($boolean)	665	=item $handle->autocork ($boolean)
550		666
551	Enables or disables the current autocork behaviour (see C<autocork>	667	Enables or disables the current autocork behaviour (see C<autocork>
552	constructor argument). Changes will only take effect on the next write.	668	constructor argument). Changes will only take effect on the next write.
…		…
565	=cut	681	=cut
566		682
567	sub no_delay {	683	sub no_delay {
568	$_[0]{no_delay} = $_[1];	684	$_[0]{no_delay} = $_[1];
569		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
570	eval {	700	eval {
571	local $SIG{__DIE__};	701	local $SIG{__DIE__};
572	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	702	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
573	if $_[0]{fh};	703	if $_[0]{fh};
574	};	704	};
575	}	705	}
576		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};
		738	};
		739	}
		740
577	=item $handle->on_starttls ($cb)	741	=item $handle->on_starttls ($cb)
578		742
579	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).	743	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
580		744
581	=cut	745	=cut
…		…
588		752
589	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).
590		754
591	=cut	755	=cut
592		756
593	sub on_starttls {	757	sub on_stoptls {
594	$_[0]{on_stoptls} = $_[1];	758	$_[0]{on_stoptls} = $_[1];
595	}	759	}
596		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
597	#############################################################################	779	#############################################################################
598		780
599	=item $handle->timeout ($seconds)	781	=item $handle->timeout ($seconds)
600		782
		783	=item $handle->rtimeout ($seconds)
		784
		785	=item $handle->wtimeout ($seconds)
		786
601	Configures (or disables) the inactivity timeout.	787	Configures (or disables) the inactivity timeout.
602		788
603	=cut	789	The timeout will be checked instantly, so this method might destroy the
		790	handle before it returns.
604		791
605	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 {
606	my ($self, $timeout) = @_;	816	my ($self, $new_value) = @_;
607		817
		818	$new_value >= 0
		819	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		820
608	$self->{timeout} = $timeout;	821	$self->{$timeout} = $new_value;
609	$self->_timeout;	822	delete $self->{$tw}; &$cb;
610	}	823	};
611		824
		825	*{"${dir}timeout_reset"} = sub {
		826	$_[0]{$activity} = AE::now;
		827	};
		828
		829	# main workhorse:
612	# reset the timeout watcher, as neccessary	830	# reset the timeout watcher, as neccessary
613	# also check for time-outs	831	# also check for time-outs
614	sub _timeout {	832	$cb = sub {
615	my ($self) = @_;	833	my ($self) = @_;
616		834
617	if ($self->{timeout} && $self->{fh}) {	835	if ($self->{$timeout} && $self->{fh}) {
618	my $NOW = AnyEvent->now;	836	my $NOW = AE::now;
619		837
620	# when would the timeout trigger?	838	# when would the timeout trigger?
621	my $after = $self->{_activity} + $self->{timeout} - $NOW;	839	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
622		840
623	# now or in the past already?	841	# now or in the past already?
624	if ($after <= 0) {	842	if ($after <= 0) {
625	$self->{_activity} = $NOW;	843	$self->{$activity} = $NOW;
626		844
627	if ($self->{on_timeout}) {	845	if ($self->{$on_timeout}) {
628	$self->{on_timeout}($self);	846	$self->{$on_timeout}($self);
629	} else {	847	} else {
630	$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};
631	}	856	}
632		857
633	# callback could have changed timeout value, optimise	858	Scalar::Util::weaken $self;
634	return unless $self->{timeout};	859	return unless $self; # ->error could have destroyed $self
635		860
636	# calculate new after	861	$self->{$tw} ||= AE::timer $after, 0, sub {
637	$after = $self->{timeout};	862	delete $self->{$tw};
		863	$cb->($self);
		864	};
		865	} else {
		866	delete $self->{$tw};
638	}	867	}
639
640	Scalar::Util::weaken $self;
641	return unless $self; # ->error could have destroyed $self
642
643	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
644	delete $self->{_tw};
645	$self->_timeout;
646	});
647	} else {
648	delete $self->{_tw};
649	}	868	}
650	}	869	}
651		870
652	#############################################################################	871	#############################################################################
653		872
…		…
669	=item $handle->on_drain ($cb)	888	=item $handle->on_drain ($cb)
670		889
671	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
672	C<on_drain> in the constructor).	891	C<on_drain> in the constructor).
673		892
		893	This method may invoke callbacks (and therefore the handle might be
		894	destroyed after it returns).
		895
674	=cut	896	=cut
675		897
676	sub on_drain {	898	sub on_drain {
677	my ($self, $cb) = @_;	899	my ($self, $cb) = @_;
678		900
…		…
682	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});
683	}	905	}
684		906
685	=item $handle->push_write ($data)	907	=item $handle->push_write ($data)
686		908
687	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
688	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
689	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).
690		915
691	=cut	916	=cut
692		917
693	sub _drain_wbuf {	918	sub _drain_wbuf {
694	my ($self) = @_;	919	my ($self) = @_;
…		…
701	my $len = syswrite $self->{fh}, $self->{wbuf};	926	my $len = syswrite $self->{fh}, $self->{wbuf};
702		927
703	if (defined $len) {	928	if (defined $len) {
704	substr $self->{wbuf}, 0, $len, "";	929	substr $self->{wbuf}, 0, $len, "";
705		930
706	$self->{_activity} = AnyEvent->now;	931	$self->{_activity} = $self->{_wactivity} = AE::now;
707		932
708	$self->{on_drain}($self)	933	$self->{on_drain}($self)
709	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})
710	&& $self->{on_drain};	935	&& $self->{on_drain};
711		936
…		…
717		942
718	# try to write data immediately	943	# try to write data immediately
719	$cb->() unless $self->{autocork};	944	$cb->() unless $self->{autocork};
720		945
721	# if still data left in wbuf, we need to poll	946	# if still data left in wbuf, we need to poll
722	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	947	$self->{_ww} = AE::io $self->{fh}, 1, $cb
723	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	}
724	};	956	};
725	}	957	}
726		958
727	our %WH;	959	our %WH;
728		960
		961	# deprecated
729	sub register_write_type($$) {	962	sub register_write_type($$) {
730	$WH{$_[0]} = $_[1];	963	$WH{$_[0]} = $_[1];
731	}	964	}
732		965
733	sub push_write {	966	sub push_write {
734	my $self = shift;	967	my $self = shift;
735		968
736	if (@_ > 1) {	969	if (@_ > 1) {
737	my $type = shift;	970	my $type = shift;
738		971
		972	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
739	@_ = ($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")
740	->($self, @_);	974	->($self, @_);
741	}	975	}
742		976
		977	# we downgrade here to avoid hard-to-track-down bugs,
		978	# and diagnose the problem earlier and better.
		979
743	if ($self->{tls}) {	980	if ($self->{tls}) {
744	$self->{_tls_wbuf} .= $_[0];	981	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
745		982	&_dotls ($self) if $self->{fh};
746	&_dotls ($self);
747	} else {	983	} else {
748	$self->{wbuf} .= $_[0];	984	utf8::downgrade $self->{wbuf} .= $_[0];
749	$self->_drain_wbuf if $self->{fh};	985	$self->_drain_wbuf if $self->{fh};
750	}	986	}
751	}	987	}
752		988
753	=item $handle->push_write (type => @args)	989	=item $handle->push_write (type => @args)
754		990
755	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
756	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).
757		996
758	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
759	drop by and tell us):	998	drop by and tell us):
760		999
761	=over 4	1000	=over 4
…		…
818	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
819	this line into their JSON decoder of choice.	1058	this line into their JSON decoder of choice.
820		1059
821	=cut	1060	=cut
822		1061
		1062	sub json_coder() {
		1063	eval { require JSON::XS; JSON::XS->new->utf8 }
		1064	|| do { require JSON; JSON->new->utf8 }
		1065	}
		1066
823	register_write_type json => sub {	1067	register_write_type json => sub {
824	my ($self, $ref) = @_;	1068	my ($self, $ref) = @_;
825		1069
826	require JSON;	1070	my $json = $self->{json} ||= json_coder;
827		1071
828	$self->{json} ? $self->{json}->encode ($ref)	1072	$json->encode ($ref)
829	: JSON::encode_json ($ref)
830	};	1073	};
831		1074
832	=item storable => $reference	1075	=item storable => $reference
833		1076
834	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
…		…
852	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
853	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
854	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
855	replaces the C<on_drain> callback with:	1098	replaces the C<on_drain> callback with:
856		1099
857	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1100	sub { shutdown $_[0]{fh}, 1 }
858		1101
859	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
860	the peer.	1103	the peer.
861		1104
862	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
863	afterwards. This is the cleanest way to close a connection.	1106	afterwards. This is the cleanest way to close a connection.
864		1107
		1108	This method may invoke callbacks (and therefore the handle might be
		1109	destroyed after it returns).
		1110
865	=cut	1111	=cut
866		1112
867	sub push_shutdown {	1113	sub push_shutdown {
868	my ($self) = @_;	1114	my ($self) = @_;
869		1115
870	delete $self->{low_water_mark};	1116	delete $self->{low_water_mark};
871	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1117	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
872	}	1118	}
873		1119
874	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1120	=item custom write types - Package::anyevent_write_type $handle, @args
875		1121
876	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
877	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
878	reference with the handle object and the remaining arguments.	1129	the handle object and the remaining arguments.
879		1130
880	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
881	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.
882		1134
883	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
884	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	}
885		1151
886	=cut	1152	=cut
887		1153
888	#############################################################################	1154	#############################################################################
889		1155
…		…
898	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
899	a queue.	1165	a queue.
900		1166
901	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
902	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
903	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
904	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
905	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>.
906		1173
907	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
908	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
909	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
910	done its job (see C<push_read>, below).	1177	done its job (see C<push_read>, below).
911		1178
912	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
913	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.
914		1181
…		…
972		1239
973	sub _drain_rbuf {	1240	sub _drain_rbuf {
974	my ($self) = @_;	1241	my ($self) = @_;
975		1242
976	# avoid recursion	1243	# avoid recursion
977	return if exists $self->{_skip_drain_rbuf};	1244	return if $self->{_skip_drain_rbuf};
978	local $self->{_skip_drain_rbuf} = 1;	1245	local $self->{_skip_drain_rbuf} = 1;
979
980	if (
981	defined $self->{rbuf_max}
982	&& $self->{rbuf_max} < length $self->{rbuf}
983	) {
984	$self->_error (Errno::ENOSPC, 1), return;
985	}
986		1246
987	while () {	1247	while () {
988	# 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
989	# 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.
990	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1250	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1251	if exists $self->{_tls_rbuf};
991		1252
992	my $len = length $self->{rbuf};	1253	my $len = length $self->{rbuf};
993		1254
994	if (my $cb = shift @{ $self->{_queue} }) {	1255	if (my $cb = shift @{ $self->{_queue} }) {
995	unless ($cb->($self)) {	1256	unless ($cb->($self)) {
996	if ($self->{_eof}) {	1257	# no progress can be made
997	# no progress can be made (not enough data and no data forthcoming)	1258	# (not enough data and no data forthcoming)
998	$self->_error (Errno::EPIPE, 1), return;	1259	$self->_error (Errno::EPIPE, 1), return
999	}	1260	if $self->{_eof};
1000		1261
1001	unshift @{ $self->{_queue} }, $cb;	1262	unshift @{ $self->{_queue} }, $cb;
1002	last;	1263	last;
1003	}	1264	}
1004	} elsif ($self->{on_read}) {	1265	} elsif ($self->{on_read}) {
…		…
1024	last;	1285	last;
1025	}	1286	}
1026	}	1287	}
1027		1288
1028	if ($self->{_eof}) {	1289	if ($self->{_eof}) {
1029	if ($self->{on_eof}) {	1290	$self->{on_eof}
1030	$self->{on_eof}($self)	1291	? $self->{on_eof}($self)
1031	} else {
1032	$self->_error (0, 1, "Unexpected end-of-file");	1292	: $self->_error (0, 1, "Unexpected end-of-file");
1033	}	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;
1034	}	1302	}
1035		1303
1036	# may need to restart read watcher	1304	# may need to restart read watcher
1037	unless ($self->{_rw}) {	1305	unless ($self->{_rw}) {
1038	$self->start_read	1306	$self->start_read
…		…
1044		1312
1045	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
1046	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
1047	constructor.	1315	constructor.
1048		1316
		1317	This method may invoke callbacks (and therefore the handle might be
		1318	destroyed after it returns).
		1319
1049	=cut	1320	=cut
1050		1321
1051	sub on_read {	1322	sub on_read {
1052	my ($self, $cb) = @_;	1323	my ($self, $cb) = @_;
1053		1324
…		…
1055	$self->_drain_rbuf if $cb;	1326	$self->_drain_rbuf if $cb;
1056	}	1327	}
1057		1328
1058	=item $handle->rbuf	1329	=item $handle->rbuf
1059		1330
1060	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).
1061		1334
1062	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)
1063	member, if you want. However, the only operation allowed on the	1336	is removing data from its beginning. Otherwise modifying or appending to
1064	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.
1065	beginning. Otherwise modifying or appending to it is not allowed and will
1066	lead to hard-to-track-down bugs.
1067		1338
1068	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>
1069	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
1070	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.
1071		1343
1072	=cut	1344	=cut
1073		1345
1074	sub rbuf : lvalue {	1346	sub rbuf : lvalue {
1075	$_[0]{rbuf}	1347	$_[0]{rbuf}
…		…
1092		1364
1093	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
1094	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
1095	true, it will be removed from the queue.	1367	true, it will be removed from the queue.
1096		1368
		1369	These methods may invoke callbacks (and therefore the handle might be
		1370	destroyed after it returns).
		1371
1097	=cut	1372	=cut
1098		1373
1099	our %RH;	1374	our %RH;
1100		1375
1101	sub register_read_type($$) {	1376	sub register_read_type($$) {
…		…
1107	my $cb = pop;	1382	my $cb = pop;
1108		1383
1109	if (@_) {	1384	if (@_) {
1110	my $type = shift;	1385	my $type = shift;
1111		1386
		1387	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1112	$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")
1113	->($self, $cb, @_);	1389	->($self, $cb, @_);
1114	}	1390	}
1115		1391
1116	push @{ $self->{_queue} }, $cb;	1392	push @{ $self->{_queue} }, $cb;
1117	$self->_drain_rbuf;	1393	$self->_drain_rbuf;
…		…
1122	my $cb = pop;	1398	my $cb = pop;
1123		1399
1124	if (@_) {	1400	if (@_) {
1125	my $type = shift;	1401	my $type = shift;
1126		1402
		1403	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1127	$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")
1128	->($self, $cb, @_);	1405	->($self, $cb, @_);
1129	}	1406	}
1130
1131		1407
1132	unshift @{ $self->{_queue} }, $cb;	1408	unshift @{ $self->{_queue} }, $cb;
1133	$self->_drain_rbuf;	1409	$self->_drain_rbuf;
1134	}	1410	}
1135		1411
…		…
1137		1413
1138	=item $handle->unshift_read (type => @args, $cb)	1414	=item $handle->unshift_read (type => @args, $cb)
1139		1415
1140	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
1141	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
1142	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).
1143		1421
1144	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
1145	drop by and tell us):	1423	drop by and tell us):
1146		1424
1147	=over 4	1425	=over 4
…		…
1239	the receive buffer when neither C<$accept> nor C<$reject> match,	1517	the receive buffer when neither C<$accept> nor C<$reject> match,
1240	and everything preceding and including the match will be accepted	1518	and everything preceding and including the match will be accepted
1241	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
1242	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
1243	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
1244	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.
1245		1523
1246	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
1247	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
1248	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
1249	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
1250	required for the accept regex.	1528	required for the accept regex.
1251		1529
1252	$handle->push_read (regex =>	1530	$handle->push_read (regex =>
…		…
1265		1543
1266	sub {	1544	sub {
1267	# accept	1545	# accept
1268	if ($$rbuf =~ $accept) {	1546	if ($$rbuf =~ $accept) {
1269	$data .= substr $$rbuf, 0, $+[0], "";	1547	$data .= substr $$rbuf, 0, $+[0], "";
1270	$cb->($self, $data);	1548	$cb->($_[0], $data);
1271	return 1;	1549	return 1;
1272	}	1550	}
1273		1551
1274	# reject	1552	# reject
1275	if ($reject && $$rbuf =~ $reject) {	1553	if ($reject && $$rbuf =~ $reject) {
1276	$self->_error (Errno::EBADMSG);	1554	$_[0]->_error (Errno::EBADMSG);
1277	}	1555	}
1278		1556
1279	# skip	1557	# skip
1280	if ($skip && $$rbuf =~ $skip) {	1558	if ($skip && $$rbuf =~ $skip) {
1281	$data .= substr $$rbuf, 0, $+[0], "";	1559	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1297	my ($self, $cb) = @_;	1575	my ($self, $cb) = @_;
1298		1576
1299	sub {	1577	sub {
1300	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1578	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1301	if ($_[0]{rbuf} =~ /[^0-9]/) {	1579	if ($_[0]{rbuf} =~ /[^0-9]/) {
1302	$self->_error (Errno::EBADMSG);	1580	$_[0]->_error (Errno::EBADMSG);
1303	}	1581	}
1304	return;	1582	return;
1305	}	1583	}
1306		1584
1307	my $len = $1;	1585	my $len = $1;
1308		1586
1309	$self->unshift_read (chunk => $len, sub {	1587	$_[0]->unshift_read (chunk => $len, sub {
1310	my $string = $_[1];	1588	my $string = $_[1];
1311	$_[0]->unshift_read (chunk => 1, sub {	1589	$_[0]->unshift_read (chunk => 1, sub {
1312	if ($_[1] eq ",") {	1590	if ($_[1] eq ",") {
1313	$cb->($_[0], $string);	1591	$cb->($_[0], $string);
1314	} else {	1592	} else {
1315	$self->_error (Errno::EBADMSG);	1593	$_[0]->_error (Errno::EBADMSG);
1316	}	1594	}
1317	});	1595	});
1318	});	1596	});
1319		1597
1320	1	1598	1
…		…
1387	=cut	1665	=cut
1388		1666
1389	register_read_type json => sub {	1667	register_read_type json => sub {
1390	my ($self, $cb) = @_;	1668	my ($self, $cb) = @_;
1391		1669
1392	my $json = $self->{json} ||=	1670	my $json = $self->{json} ||= json_coder;
1393	eval { require JSON::XS; JSON::XS->new->utf8 }
1394	|| do { require JSON; JSON->new->utf8 };
1395		1671
1396	my $data;	1672	my $data;
1397	my $rbuf = \$self->{rbuf};	1673	my $rbuf = \$self->{rbuf};
1398		1674
1399	sub {	1675	sub {
1400	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1676	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1401		1677
1402	if ($ref) {	1678	if ($ref) {
1403	$self->{rbuf} = $json->incr_text;	1679	$_[0]{rbuf} = $json->incr_text;
1404	$json->incr_text = "";	1680	$json->incr_text = "";
1405	$cb->($self, $ref);	1681	$cb->($_[0], $ref);
1406		1682
1407	1	1683	1
1408	} elsif ($@) {	1684	} elsif ($@) {
1409	# error case	1685	# error case
1410	$json->incr_skip;	1686	$json->incr_skip;
1411		1687
1412	$self->{rbuf} = $json->incr_text;	1688	$_[0]{rbuf} = $json->incr_text;
1413	$json->incr_text = "";	1689	$json->incr_text = "";
1414		1690
1415	$self->_error (Errno::EBADMSG);	1691	$_[0]->_error (Errno::EBADMSG);
1416		1692
1417	()	1693	()
1418	} else {	1694	} else {
1419	$self->{rbuf} = "";	1695	$_[0]{rbuf} = "";
1420		1696
1421	()	1697	()
1422	}	1698	}
1423	}	1699	}
1424	};	1700	};
…		…
1457	# read remaining chunk	1733	# read remaining chunk
1458	$_[0]->unshift_read (chunk => $len, sub {	1734	$_[0]->unshift_read (chunk => $len, sub {
1459	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1735	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1460	$cb->($_[0], $ref);	1736	$cb->($_[0], $ref);
1461	} else {	1737	} else {
1462	$self->_error (Errno::EBADMSG);	1738	$_[0]->_error (Errno::EBADMSG);
1463	}	1739	}
1464	});	1740	});
1465	}	1741	}
1466		1742
1467	1	1743	1
1468	}	1744	}
1469	};	1745	};
1470		1746
1471	=back	1747	=back
1472		1748
1473	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1749	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1474		1750
1475	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).
1476		1756
1477	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
1478	reference with the handle object, the callback and the remaining	1758	handle object, the original callback and the remaining arguments.
1479	arguments.
1480		1759
1481	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
1482	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.
1483		1764
1484	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
1485	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).
1486		1768
1487	Note that this is a function, and all types registered this way will be
1488	global, so try to use unique names.
1489
1490	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
1491	search for C<register_read_type>)).	1770	AnyEvent::Handle>, search for C<register_read_type>)).
1492		1771
1493	=item $handle->stop_read	1772	=item $handle->stop_read
1494		1773
1495	=item $handle->start_read	1774	=item $handle->start_read
1496		1775
…		…
1502	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
1503	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
1504	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
1505	there are any read requests in the queue.	1784	there are any read requests in the queue.
1506		1785
1507	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,
1508	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.
1509		1797
1510	=cut	1798	=cut
1511		1799
1512	sub stop_read {	1800	sub stop_read {
1513	my ($self) = @_;	1801	my ($self) = @_;
1514		1802
1515	delete $self->{_rw} unless $self->{tls};	1803	delete $self->{_rw};
1516	}	1804	}
1517		1805
1518	sub start_read {	1806	sub start_read {
1519	my ($self) = @_;	1807	my ($self) = @_;
1520		1808
1521	unless ($self->{_rw} || $self->{_eof}) {	1809	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1522	Scalar::Util::weaken $self;	1810	Scalar::Util::weaken $self;
1523		1811
1524	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1812	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1525	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1813	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1526	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1814	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1527		1815
1528	if ($len > 0) {	1816	if ($len > 0) {
1529	$self->{_activity} = AnyEvent->now;	1817	$self->{_activity} = $self->{_ractivity} = AE::now;
1530		1818
1531	if ($self->{tls}) {	1819	if ($self->{tls}) {
1532	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1820	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1533		1821
1534	&_dotls ($self);	1822	&_dotls ($self);
1535	} else {	1823	} else {
1536	$self->_drain_rbuf;	1824	$self->_drain_rbuf;
1537	}	1825	}
1538		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);
		1831	}
		1832
1539	} elsif (defined $len) {	1833	} elsif (defined $len) {
1540	delete $self->{_rw};	1834	delete $self->{_rw};
1541	$self->{_eof} = 1;	1835	$self->{_eof} = 1;
1542	$self->_drain_rbuf;	1836	$self->_drain_rbuf;
1543		1837
1544	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1838	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1545	return $self->_error ($!, 1);	1839	return $self->_error ($!, 1);
1546	}	1840	}
1547	});	1841	};
1548	}	1842	}
1549	}	1843	}
1550		1844
1551	our $ERROR_SYSCALL;	1845	our $ERROR_SYSCALL;
1552	our $ERROR_WANT_READ;	1846	our $ERROR_WANT_READ;
…		…
1619	&& ($tmp != $ERROR_SYSCALL || $!);	1913	&& ($tmp != $ERROR_SYSCALL || $!);
1620		1914
1621	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1915	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1622	$self->{wbuf} .= $tmp;	1916	$self->{wbuf} .= $tmp;
1623	$self->_drain_wbuf;	1917	$self->_drain_wbuf;
		1918	$self->{tls} or return; # tls session might have gone away in callback
1624	}	1919	}
1625		1920
1626	$self->{_on_starttls}	1921	$self->{_on_starttls}
1627	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1922	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1628	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1923	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1649	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
1650	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
1651	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
1652	when this function returns.	1947	when this function returns.
1653		1948
1654	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
1655	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).
1656		1955
1657	=cut	1956	=cut
1658		1957
1659	our %TLS_CACHE; #TODO not yet documented, should we?	1958	our %TLS_CACHE; #TODO not yet documented, should we?
1660		1959
1661	sub starttls {	1960	sub starttls {
1662	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};
1663		1970
1664	require Net::SSLeay;	1971	require Net::SSLeay;
1665
1666	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1667	if $self->{tls};
1668		1972
1669	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1973	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1670	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1974	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1671		1975
		1976	$tls = delete $self->{tls};
1672	$ctx ||= $self->{tls_ctx};	1977	$ctx = $self->{tls_ctx};
1673		1978
1674	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1979	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1675		1980
1676	if ("HASH" eq ref $ctx) {	1981	if ("HASH" eq ref $ctx) {
1677	require AnyEvent::TLS;	1982	require AnyEvent::TLS;
…		…
1683	$ctx = new AnyEvent::TLS %$ctx;	1988	$ctx = new AnyEvent::TLS %$ctx;
1684	}	1989	}
1685	}	1990	}
1686		1991
1687	$self->{tls_ctx} = $ctx || TLS_CTX ();	1992	$self->{tls_ctx} = $ctx || TLS_CTX ();
1688	$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});
1689		1994
1690	# 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)
1691	# but the openssl maintainers basically said: "trust us, it just works".	1996	# but the openssl maintainers basically said: "trust us, it just works".
1692	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1997	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1693	# and mismaintained ssleay-module doesn't even offer them).	1998	# and mismaintained ssleay-module doesn't even offer them).
…		…
1700	# 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
1701	# have identity issues in that area.	2006	# have identity issues in that area.
1702	# Net::SSLeay::CTX_set_mode ($ssl,	2007	# Net::SSLeay::CTX_set_mode ($ssl,
1703	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	2008	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1704	# | (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));
1705	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	2010	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1706		2011
1707	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2012	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1708	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2013	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1709		2014
		2015	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2016	$self->{rbuf} = "";
		2017
1710	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	2018	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1711		2019
1712	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2020	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1713	if $self->{on_starttls};	2021	if $self->{on_starttls};
1714		2022
1715	&_dotls; # need to trigger the initial handshake	2023	&_dotls; # need to trigger the initial handshake
…		…
1718		2026
1719	=item $handle->stoptls	2027	=item $handle->stoptls
1720		2028
1721	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
1722	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
1723	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
1724	afterwards.	2032	the stream afterwards.
		2033
		2034	This method may invoke callbacks (and therefore the handle might be
		2035	destroyed after it returns).
1725		2036
1726	=cut	2037	=cut
1727		2038
1728	sub stoptls {	2039	sub stoptls {
1729	my ($self) = @_;	2040	my ($self) = @_;
1730		2041
1731	if ($self->{tls}) {	2042	if ($self->{tls} && $self->{fh}) {
1732	Net::SSLeay::shutdown ($self->{tls});	2043	Net::SSLeay::shutdown ($self->{tls});
1733		2044
1734	&_dotls;	2045	&_dotls;
1735		2046
1736	# # 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#
…		…
1742	sub _freetls {	2053	sub _freetls {
1743	my ($self) = @_;	2054	my ($self) = @_;
1744		2055
1745	return unless $self->{tls};	2056	return unless $self->{tls};
1746		2057
1747	$self->{tls_ctx}->_put_session (delete $self->{tls});	2058	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2059	if $self->{tls} > 0;
1748		2060
1749	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2061	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1750	}	2062	}
		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;
1751		2076
1752	sub DESTROY {	2077	sub DESTROY {
1753	my ($self) = @_;	2078	my ($self) = @_;
1754		2079
1755	&_freetls;	2080	&_freetls;
…		…
1760	my $fh = delete $self->{fh};	2085	my $fh = delete $self->{fh};
1761	my $wbuf = delete $self->{wbuf};	2086	my $wbuf = delete $self->{wbuf};
1762		2087
1763	my @linger;	2088	my @linger;
1764		2089
1765	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2090	push @linger, AE::io $fh, 1, sub {
1766	my $len = syswrite $fh, $wbuf, length $wbuf;	2091	my $len = syswrite $fh, $wbuf, length $wbuf;
1767		2092
1768	if ($len > 0) {	2093	if ($len > 0) {
1769	substr $wbuf, 0, $len, "";	2094	substr $wbuf, 0, $len, "";
1770	} else {	2095	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1771	@linger = (); # end	2096	@linger = (); # end
1772	}	2097	}
1773	});	2098	};
1774	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2099	push @linger, AE::timer $linger, 0, sub {
1775	@linger = ();	2100	@linger = ();
1776	});	2101	};
1777	}	2102	}
1778	}	2103	}
1779		2104
1780	=item $handle->destroy	2105	=item $handle->destroy
1781		2106
1782	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
1783	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
1784	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).
1785		2112
1786	Normally, you can just "forget" any references to an AnyEvent::Handle	2113	Normally, you can just "forget" any references to an AnyEvent::Handle
1787	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
1788	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
1789	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
…		…
1803	sub destroy {	2130	sub destroy {
1804	my ($self) = @_;	2131	my ($self) = @_;
1805		2132
1806	$self->DESTROY;	2133	$self->DESTROY;
1807	%$self = ();	2134	%$self = ();
		2135	bless $self, "AnyEvent::Handle::destroyed";
1808	}	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 }
1809		2164
1810	=item AnyEvent::Handle::TLS_CTX	2165	=item AnyEvent::Handle::TLS_CTX
1811		2166
1812	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
1813	for TLS mode.	2168	for TLS mode.
…		…
1841		2196
1842	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,
1843	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<<
1844	->destroy >> method.	2199	->destroy >> method.
1845		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
1846	=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
1847	reading?	2282	reading?
1848		2283
1849	Unlike, say, TCP, TLS connections do not consist of two independent	2284	Unlike, say, TCP, TLS connections do not consist of two independent
1850	communication channels, one for each direction. Or put differently. The	2285	communication channels, one for each direction. Or put differently, the
1851	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
1852	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.
1853		2288
1854	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>
1855	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
1856	is that AnyEvent::Handle always reads in TLS mode.	2291	is that AnyEvent::Handle always reads in TLS mode.
1857		2292
1858	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
1859	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
…		…
1871	$handle->on_eof (undef);	2306	$handle->on_eof (undef);
1872	$handle->on_error (sub {	2307	$handle->on_error (sub {
1873	my $data = delete $_[0]{rbuf};	2308	my $data = delete $_[0]{rbuf};
1874	});	2309	});
1875		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
1876	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
1877	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
1878	fact, all data has been received.	2317	fact all data has been received.
1879		2318
1880	It is usually better to use acknowledgements when transferring data,	2319	It is usually better to use acknowledgements when transferring data,
1881	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
1882	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
1883	explicit QUIT command.	2322	explicit QUIT command.
…		…
1900	consider using C<< ->push_shutdown >> instead.	2339	consider using C<< ->push_shutdown >> instead.
1901		2340
1902	=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.
1903		2342
1904	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,
1905	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>
1906	parameter:	2345	parameter:
1907		2346
1908	tcp_connect $host, $port, sub {	2347	tcp_connect $host, $port, sub {
1909	my ($fh) = @_;	2348	my ($fh) = @_;
1910		2349
…		…
2010		2449
2011	=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
2012	are free to use in subclasses.	2451	are free to use in subclasses.
2013		2452
2014	Of course, new versions of AnyEvent::Handle may introduce more "public"	2453	Of course, new versions of AnyEvent::Handle may introduce more "public"
2015	member variables, but thats just life, at least it is documented.	2454	member variables, but that's just life. At least it is documented.
2016		2455
2017	=back	2456	=back
2018		2457
2019	=head1 AUTHOR	2458	=head1 AUTHOR
2020		2459

Diff Legend

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