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.213 by root, Sat Jan 15 20:32:45 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
		253	of each other, for both read and write, just read, and just write:
		254	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		255	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		256	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
		257
219	Note that timeout processing is also active when you currently do not have	258	Note that timeout processing is active even when you do not have
220	any outstanding read or write requests: If you plan to keep the connection	259	any outstanding read or write requests: If you plan to keep the connection
221	idle then you should disable the timout temporarily or ignore the timeout	260	idle then you should disable the timeout temporarily or ignore the timeout
222	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	261	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
223	restart the timeout.	262	restart the timeout.
224		263
225	Zero (the default) disables this timeout.	264	Zero (the default) disables this timeout.
226		265
…		…
240	be configured to accept only so-and-so much data that it cannot act on	279	be configured to accept only so-and-so much data that it cannot act on
241	(for example, when expecting a line, an attacker could send an unlimited	280	(for example, when expecting a line, an attacker could send an unlimited
242	amount of data without a callback ever being called as long as the line	281	amount of data without a callback ever being called as long as the line
243	isn't finished).	282	isn't finished).
244		283
		284	=item wbuf_max => <bytes>
		285
		286	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
		287	when the write buffer ever (strictly) exceeds this size. This is useful to
		288	avoid some forms of denial-of-service attacks.
		289
		290	Although the units of this parameter is bytes, this is the I<raw> number
		291	of bytes not yet accepted by the kernel. This can make a difference when
		292	you e.g. use TLS, as TLS typically makes your write data larger (but it
		293	can also make it smaller due to compression).
		294
		295	As an example of when this limit is useful, take a chat server that sends
		296	chat messages to a client. If the client does not read those in a timely
		297	manner then the send buffer in the server would grow unbounded.
		298
245	=item autocork => <boolean>	299	=item autocork => <boolean>
246		300
247	When disabled (the default), then C<push_write> will try to immediately	301	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	302	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	303	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	304	be inefficient if you write multiple small chunks (on the wire, this
251	disadvantage is usually avoided by your kernel's nagle algorithm, see	305	disadvantage is usually avoided by your kernel's nagle algorithm, see
252	C<no_delay>, but this option can save costly syscalls).	306	C<no_delay>, but this option can save costly syscalls).
253		307
254	When enabled, then writes will always be queued till the next event loop	308	When enabled, writes will always be queued till the next event loop
255	iteration. This is efficient when you do many small writes per iteration,	309	iteration. This is efficient when you do many small writes per iteration,
256	but less efficient when you do a single write only per iteration (or when	310	but less efficient when you do a single write only per iteration (or when
257	the write buffer often is full). It also increases write latency.	311	the write buffer often is full). It also increases write latency.
258		312
259	=item no_delay => <boolean>	313	=item no_delay => <boolean>
…		…
263	the Nagle algorithm, and usually it is beneficial.	317	the Nagle algorithm, and usually it is beneficial.
264		318
265	In some situations you want as low a delay as possible, which can be	319	In some situations you want as low a delay as possible, which can be
266	accomplishd by setting this option to a true value.	320	accomplishd by setting this option to a true value.
267		321
268	The default is your opertaing system's default behaviour (most likely	322	The default is your operating system's default behaviour (most likely
269	enabled), this option explicitly enables or disables it, if possible.	323	enabled). This option explicitly enables or disables it, if possible.
		324
		325	=item keepalive => <boolean>
		326
		327	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		328	normally, TCP connections have no time-out once established, so TCP
		329	connections, once established, can stay alive forever even when the other
		330	side has long gone. TCP keepalives are a cheap way to take down long-lived
		331	TCP connections when the other side becomes unreachable. While the default
		332	is OS-dependent, TCP keepalives usually kick in after around two hours,
		333	and, if the other side doesn't reply, take down the TCP connection some 10
		334	to 15 minutes later.
		335
		336	It is harmless to specify this option for file handles that do not support
		337	keepalives, and enabling it on connections that are potentially long-lived
		338	is usually a good idea.
		339
		340	=item oobinline => <boolean>
		341
		342	BSD majorly fucked up the implementation of TCP urgent data. The result
		343	is that almost no OS implements TCP according to the specs, and every OS
		344	implements it slightly differently.
		345
		346	If you want to handle TCP urgent data, then setting this flag (the default
		347	is enabled) gives you the most portable way of getting urgent data, by
		348	putting it into the stream.
		349
		350	Since BSD emulation of OOB data on top of TCP's urgent data can have
		351	security implications, AnyEvent::Handle sets this flag automatically
		352	unless explicitly specified. Note that setting this flag after
		353	establishing a connection I<may> be a bit too late (data loss could
		354	already have occured on BSD systems), but at least it will protect you
		355	from most attacks.
270		356
271	=item read_size => <bytes>	357	=item read_size => <bytes>
272		358
273	The default read block size (the amount of bytes this module will	359	The initial read block size, the number of bytes this module will try to
274	try to read during each loop iteration, which affects memory	360	read during each loop iteration. Each handle object will consume at least
275	requirements). Default: C<8192>.	361	this amount of memory for the read buffer as well, so when handling many
		362	connections requirements). See also C<max_read_size>. Default: C<2048>.
		363
		364	=item max_read_size => <bytes>
		365
		366	The maximum read buffer size used by the dynamic adjustment
		367	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
		368	one go it will double C<read_size> up to the maximum given by this
		369	option. Default: C<131072> or C<read_size>, whichever is higher.
276		370
277	=item low_water_mark => <bytes>	371	=item low_water_mark => <bytes>
278		372
279	Sets the amount of bytes (default: C<0>) that make up an "empty" write	373	Sets the number of bytes (default: C<0>) that make up an "empty" write
280	buffer: If the write reaches this size or gets even samller it is	374	buffer: If the buffer reaches this size or gets even samller it is
281	considered empty.	375	considered empty.
282		376
283	Sometimes it can be beneficial (for performance reasons) to add data to	377	Sometimes it can be beneficial (for performance reasons) to add data to
284	the write buffer before it is fully drained, but this is a rare case, as	378	the write buffer before it is fully drained, but this is a rare case, as
285	the operating system kernel usually buffers data as well, so the default	379	the operating system kernel usually buffers data as well, so the default
286	is good in almost all cases.	380	is good in almost all cases.
287		381
288	=item linger => <seconds>	382	=item linger => <seconds>
289		383
290	If non-zero (default: C<3600>), then the destructor of the	384	If this is non-zero (default: C<3600>), the destructor of the
291	AnyEvent::Handle object will check whether there is still outstanding	385	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	386	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	387	socket. No errors will be reported (this mostly matches how the operating
294	system treats outstanding data at socket close time).	388	system treats outstanding data at socket close time).
295		389
…		…
302	A string used to identify the remote site - usually the DNS hostname	396	A string used to identify the remote site - usually the DNS hostname
303	(I<not> IDN!) used to create the connection, rarely the IP address.	397	(I<not> IDN!) used to create the connection, rarely the IP address.
304		398
305	Apart from being useful in error messages, this string is also used in TLS	399	Apart from being useful in error messages, this string is also used in TLS
306	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	400	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
307	verification will be skipped when C<peername> is not specified or	401	verification will be skipped when C<peername> is not specified or is
308	C<undef>.	402	C<undef>.
309		403
310	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	404	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
311		405
312	When this parameter is given, it enables TLS (SSL) mode, that means	406	When this parameter is given, it enables TLS (SSL) mode, that means
313	AnyEvent will start a TLS handshake as soon as the conenction has been	407	AnyEvent will start a TLS handshake as soon as the connection has been
314	established and will transparently encrypt/decrypt data afterwards.	408	established and will transparently encrypt/decrypt data afterwards.
315		409
316	All TLS protocol errors will be signalled as C<EPROTO>, with an	410	All TLS protocol errors will be signalled as C<EPROTO>, with an
317	appropriate error message.	411	appropriate error message.
318		412
…		…
338	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	432	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
339	passing in the wrong integer will lead to certain crash. This most often	433	passing in the wrong integer will lead to certain crash. This most often
340	happens when one uses a stylish C<< tls => 1 >> and is surprised about the	434	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
341	segmentation fault.	435	segmentation fault.
342		436
343	See the C<< ->starttls >> method for when need to start TLS negotiation later.	437	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
344		438
345	=item tls_ctx => $anyevent_tls	439	=item tls_ctx => $anyevent_tls
346		440
347	Use the given C<AnyEvent::TLS> object to create the new TLS connection	441	Use the given C<AnyEvent::TLS> object to create the new TLS connection
348	(unless a connection object was specified directly). If this parameter is	442	(unless a connection object was specified directly). If this
349	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	443	parameter is missing (or C<undef>), then AnyEvent::Handle will use
		444	C<AnyEvent::Handle::TLS_CTX>.
350		445
351	Instead of an object, you can also specify a hash reference with C<< key	446	Instead of an object, you can also specify a hash reference with C<< key
352	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	447	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
353	new TLS context object.	448	new TLS context object.
354		449
…		…
363		458
364	TLS handshake failures will not cause C<on_error> to be invoked when this	459	TLS handshake failures will not cause C<on_error> to be invoked when this
365	callback is in effect, instead, the error message will be passed to C<on_starttls>.	460	callback is in effect, instead, the error message will be passed to C<on_starttls>.
366		461
367	Without this callback, handshake failures lead to C<on_error> being	462	Without this callback, handshake failures lead to C<on_error> being
368	called, as normal.	463	called as usual.
369		464
370	Note that you cannot call C<starttls> right again in this callback. If you	465	Note that you cannot just call C<starttls> again in this callback. If you
371	need to do that, start an zero-second timer instead whose callback can	466	need to do that, start an zero-second timer instead whose callback can
372	then call C<< ->starttls >> again.	467	then call C<< ->starttls >> again.
373		468
374	=item on_stoptls => $cb->($handle)	469	=item on_stoptls => $cb->($handle)
375		470
…		…
423	$self->{connect}[0],	518	$self->{connect}[0],
424	$self->{connect}[1],	519	$self->{connect}[1],
425	sub {	520	sub {
426	my ($fh, $host, $port, $retry) = @_;	521	my ($fh, $host, $port, $retry) = @_;
427		522
		523	delete $self->{_connect}; # no longer needed
		524
428	if ($fh) {	525	if ($fh) {
429	$self->{fh} = $fh;	526	$self->{fh} = $fh;
430		527
431	delete $self->{_skip_drain_rbuf};	528	delete $self->{_skip_drain_rbuf};
432	$self->_start;	529	$self->_start;
433		530
434	$self->{on_connect}	531	$self->{on_connect}
435	and $self->{on_connect}($self, $host, $port, sub {	532	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)};	533	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
437	$self->{_skip_drain_rbuf} = 1;	534	$self->{_skip_drain_rbuf} = 1;
438	&$retry;	535	&$retry;
439	});	536	});
440		537
441	} else {	538	} else {
442	if ($self->{on_connect_error}) {	539	if ($self->{on_connect_error}) {
443	$self->{on_connect_error}($self, "$!");	540	$self->{on_connect_error}($self, "$!");
444	$self->destroy;	541	$self->destroy;
445	} else {	542	} else {
446	$self->fatal ($!, 1);	543	$self->_error ($!, 1);
447	}	544	}
448	}	545	}
449	},	546	},
450	sub {	547	sub {
451	local $self->{fh} = $_[0];	548	local $self->{fh} = $_[0];
452		549
		550	$self->{on_prepare}
453	$self->{on_prepare}->($self)	551	? $self->{on_prepare}->($self)
454	if $self->{on_prepare};	552	: ()
455	}	553	}
456	);	554	);
457	}	555	}
458		556
459	} else {	557	} else {
…		…
464	}	562	}
465		563
466	sub _start {	564	sub _start {
467	my ($self) = @_;	565	my ($self) = @_;
468		566
		567	# too many clueless people try to use udp and similar sockets
		568	# with AnyEvent::Handle, do them a favour.
		569	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		570	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		571	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
		572
469	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	573	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
470		574
		575	$self->{_activity} =
		576	$self->{_ractivity} =
471	$self->{_activity} = AnyEvent->now;	577	$self->{_wactivity} = AE::now;
472	$self->_timeout;
473		578
		579	$self->{read_size} ||= 2048;
		580	$self->{max_read_size} = $self->{read_size}
		581	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		582
		583	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		584	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		585	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		586
474	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	587	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		588	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
475		589
		590	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		591
476	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	592	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
477	if $self->{tls};	593	if $self->{tls};
478		594
479	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	595	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
480		596
481	$self->start_read	597	$self->start_read
482	if $self->{on_read} || @{ $self->{_queue} };	598	if $self->{on_read} || @{ $self->{_queue} };
483	}
484		599
485	#sub _shutdown {	600	$self->_drain_wbuf;
486	# my ($self) = @_;	601	}
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		602
494	sub _error {	603	sub _error {
495	my ($self, $errno, $fatal, $message) = @_;	604	my ($self, $errno, $fatal, $message) = @_;
496		605
497	$! = $errno;	606	$! = $errno;
498	$message ||= "$!";	607	$message ||= "$!";
499		608
500	if ($self->{on_error}) {	609	if ($self->{on_error}) {
501	$self->{on_error}($self, $fatal, $message);	610	$self->{on_error}($self, $fatal, $message);
502	$self->destroy if $fatal;	611	$self->destroy if $fatal;
503	} elsif ($self->{fh}) {	612	} elsif ($self->{fh} || $self->{connect}) {
504	$self->destroy;	613	$self->destroy;
505	Carp::croak "AnyEvent::Handle uncaught error: $message";	614	Carp::croak "AnyEvent::Handle uncaught error: $message";
506	}	615	}
507	}	616	}
508		617
…		…
534	$_[0]{on_eof} = $_[1];	643	$_[0]{on_eof} = $_[1];
535	}	644	}
536		645
537	=item $handle->on_timeout ($cb)	646	=item $handle->on_timeout ($cb)
538		647
539	Replace the current C<on_timeout> callback, or disables the callback (but	648	=item $handle->on_rtimeout ($cb)
540	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
541	argument and method.
542		649
543	=cut	650	=item $handle->on_wtimeout ($cb)
544		651
545	sub on_timeout {	652	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
546	$_[0]{on_timeout} = $_[1];	653	callback, or disables the callback (but not the timeout) if C<$cb> =
547	}	654	C<undef>. See the C<timeout> constructor argument and method.
		655
		656	=cut
		657
		658	# see below
548		659
549	=item $handle->autocork ($boolean)	660	=item $handle->autocork ($boolean)
550		661
551	Enables or disables the current autocork behaviour (see C<autocork>	662	Enables or disables the current autocork behaviour (see C<autocork>
552	constructor argument). Changes will only take effect on the next write.	663	constructor argument). Changes will only take effect on the next write.
…		…
565	=cut	676	=cut
566		677
567	sub no_delay {	678	sub no_delay {
568	$_[0]{no_delay} = $_[1];	679	$_[0]{no_delay} = $_[1];
569		680
		681	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		682	if $_[0]{fh};
		683	}
		684
		685	=item $handle->keepalive ($boolean)
		686
		687	Enables or disables the C<keepalive> setting (see constructor argument of
		688	the same name for details).
		689
		690	=cut
		691
		692	sub keepalive {
		693	$_[0]{keepalive} = $_[1];
		694
570	eval {	695	eval {
571	local $SIG{__DIE__};	696	local $SIG{__DIE__};
572	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	697	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
573	if $_[0]{fh};	698	if $_[0]{fh};
574	};	699	};
575	}	700	}
576		701
		702	=item $handle->oobinline ($boolean)
		703
		704	Enables or disables the C<oobinline> setting (see constructor argument of
		705	the same name for details).
		706
		707	=cut
		708
		709	sub oobinline {
		710	$_[0]{oobinline} = $_[1];
		711
		712	eval {
		713	local $SIG{__DIE__};
		714	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		715	if $_[0]{fh};
		716	};
		717	}
		718
		719	=item $handle->keepalive ($boolean)
		720
		721	Enables or disables the C<keepalive> setting (see constructor argument of
		722	the same name for details).
		723
		724	=cut
		725
		726	sub keepalive {
		727	$_[0]{keepalive} = $_[1];
		728
		729	eval {
		730	local $SIG{__DIE__};
		731	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		732	if $_[0]{fh};
		733	};
		734	}
		735
577	=item $handle->on_starttls ($cb)	736	=item $handle->on_starttls ($cb)
578		737
579	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).	738	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
580		739
581	=cut	740	=cut
…		…
588		747
589	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	748	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
590		749
591	=cut	750	=cut
592		751
593	sub on_starttls {	752	sub on_stoptls {
594	$_[0]{on_stoptls} = $_[1];	753	$_[0]{on_stoptls} = $_[1];
595	}	754	}
596		755
		756	=item $handle->rbuf_max ($max_octets)
		757
		758	Configures the C<rbuf_max> setting (C<undef> disables it).
		759
		760	=item $handle->wbuf_max ($max_octets)
		761
		762	Configures the C<wbuf_max> setting (C<undef> disables it).
		763
		764	=cut
		765
		766	sub rbuf_max {
		767	$_[0]{rbuf_max} = $_[1];
		768	}
		769
		770	sub rbuf_max {
		771	$_[0]{wbuf_max} = $_[1];
		772	}
		773
597	#############################################################################	774	#############################################################################
598		775
599	=item $handle->timeout ($seconds)	776	=item $handle->timeout ($seconds)
600		777
		778	=item $handle->rtimeout ($seconds)
		779
		780	=item $handle->wtimeout ($seconds)
		781
601	Configures (or disables) the inactivity timeout.	782	Configures (or disables) the inactivity timeout.
602		783
603	=cut	784	=item $handle->timeout_reset
604		785
605	sub timeout {	786	=item $handle->rtimeout_reset
		787
		788	=item $handle->wtimeout_reset
		789
		790	Reset the activity timeout, as if data was received or sent.
		791
		792	These methods are cheap to call.
		793
		794	=cut
		795
		796	for my $dir ("", "r", "w") {
		797	my $timeout = "${dir}timeout";
		798	my $tw = "_${dir}tw";
		799	my $on_timeout = "on_${dir}timeout";
		800	my $activity = "_${dir}activity";
		801	my $cb;
		802
		803	*$on_timeout = sub {
		804	$_[0]{$on_timeout} = $_[1];
		805	};
		806
		807	*$timeout = sub {
606	my ($self, $timeout) = @_;	808	my ($self, $new_value) = @_;
607		809
		810	$new_value >= 0
		811	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		812
608	$self->{timeout} = $timeout;	813	$self->{$timeout} = $new_value;
609	$self->_timeout;	814	delete $self->{$tw}; &$cb;
610	}	815	};
611		816
		817	*{"${dir}timeout_reset"} = sub {
		818	$_[0]{$activity} = AE::now;
		819	};
		820
		821	# main workhorse:
612	# reset the timeout watcher, as neccessary	822	# reset the timeout watcher, as neccessary
613	# also check for time-outs	823	# also check for time-outs
614	sub _timeout {	824	$cb = sub {
615	my ($self) = @_;	825	my ($self) = @_;
616		826
617	if ($self->{timeout} && $self->{fh}) {	827	if ($self->{$timeout} && $self->{fh}) {
618	my $NOW = AnyEvent->now;	828	my $NOW = AE::now;
619		829
620	# when would the timeout trigger?	830	# when would the timeout trigger?
621	my $after = $self->{_activity} + $self->{timeout} - $NOW;	831	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
622		832
623	# now or in the past already?	833	# now or in the past already?
624	if ($after <= 0) {	834	if ($after <= 0) {
625	$self->{_activity} = $NOW;	835	$self->{$activity} = $NOW;
626		836
627	if ($self->{on_timeout}) {	837	if ($self->{$on_timeout}) {
628	$self->{on_timeout}($self);	838	$self->{$on_timeout}($self);
629	} else {	839	} else {
630	$self->_error (Errno::ETIMEDOUT);	840	$self->_error (Errno::ETIMEDOUT);
		841	}
		842
		843	# callback could have changed timeout value, optimise
		844	return unless $self->{$timeout};
		845
		846	# calculate new after
		847	$after = $self->{$timeout};
631	}	848	}
632		849
633	# callback could have changed timeout value, optimise	850	Scalar::Util::weaken $self;
634	return unless $self->{timeout};	851	return unless $self; # ->error could have destroyed $self
635		852
636	# calculate new after	853	$self->{$tw} ||= AE::timer $after, 0, sub {
637	$after = $self->{timeout};	854	delete $self->{$tw};
		855	$cb->($self);
		856	};
		857	} else {
		858	delete $self->{$tw};
638	}	859	}
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	}	860	}
650	}	861	}
651		862
652	#############################################################################	863	#############################################################################
653		864
…		…
669	=item $handle->on_drain ($cb)	880	=item $handle->on_drain ($cb)
670		881
671	Sets the C<on_drain> callback or clears it (see the description of	882	Sets the C<on_drain> callback or clears it (see the description of
672	C<on_drain> in the constructor).	883	C<on_drain> in the constructor).
673		884
		885	This method may invoke callbacks (and therefore the handle might be
		886	destroyed after it returns).
		887
674	=cut	888	=cut
675		889
676	sub on_drain {	890	sub on_drain {
677	my ($self, $cb) = @_;	891	my ($self, $cb) = @_;
678		892
…		…
682	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});	896	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
683	}	897	}
684		898
685	=item $handle->push_write ($data)	899	=item $handle->push_write ($data)
686		900
687	Queues the given scalar to be written. You can push as much data as you	901	Queues the given scalar to be written. You can push as much data as
688	want (only limited by the available memory), as C<AnyEvent::Handle>	902	you want (only limited by the available memory and C<wbuf_max>), as
689	buffers it independently of the kernel.	903	C<AnyEvent::Handle> buffers it independently of the kernel.
		904
		905	This method may invoke callbacks (and therefore the handle might be
		906	destroyed after it returns).
690		907
691	=cut	908	=cut
692		909
693	sub _drain_wbuf {	910	sub _drain_wbuf {
694	my ($self) = @_;	911	my ($self) = @_;
…		…
701	my $len = syswrite $self->{fh}, $self->{wbuf};	918	my $len = syswrite $self->{fh}, $self->{wbuf};
702		919
703	if (defined $len) {	920	if (defined $len) {
704	substr $self->{wbuf}, 0, $len, "";	921	substr $self->{wbuf}, 0, $len, "";
705		922
706	$self->{_activity} = AnyEvent->now;	923	$self->{_activity} = $self->{_wactivity} = AE::now;
707		924
708	$self->{on_drain}($self)	925	$self->{on_drain}($self)
709	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	926	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
710	&& $self->{on_drain};	927	&& $self->{on_drain};
711		928
…		…
717		934
718	# try to write data immediately	935	# try to write data immediately
719	$cb->() unless $self->{autocork};	936	$cb->() unless $self->{autocork};
720		937
721	# if still data left in wbuf, we need to poll	938	# if still data left in wbuf, we need to poll
722	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	939	$self->{_ww} = AE::io $self->{fh}, 1, $cb
723	if length $self->{wbuf};	940	if length $self->{wbuf};
		941
		942	if (
		943	defined $self->{wbuf_max}
		944	&& $self->{wbuf_max} < length $self->{wbuf}
		945	) {
		946	$self->_error (Errno::ENOSPC, 1), return;
		947	}
724	};	948	};
725	}	949	}
726		950
727	our %WH;	951	our %WH;
728		952
		953	# deprecated
729	sub register_write_type($$) {	954	sub register_write_type($$) {
730	$WH{$_[0]} = $_[1];	955	$WH{$_[0]} = $_[1];
731	}	956	}
732		957
733	sub push_write {	958	sub push_write {
734	my $self = shift;	959	my $self = shift;
735		960
736	if (@_ > 1) {	961	if (@_ > 1) {
737	my $type = shift;	962	my $type = shift;
738		963
		964	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
739	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	965	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
740	->($self, @_);	966	->($self, @_);
741	}	967	}
742		968
		969	# we downgrade here to avoid hard-to-track-down bugs,
		970	# and diagnose the problem earlier and better.
		971
743	if ($self->{tls}) {	972	if ($self->{tls}) {
744	$self->{_tls_wbuf} .= $_[0];	973	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
745		974	&_dotls ($self) if $self->{fh};
746	&_dotls ($self);
747	} else {	975	} else {
748	$self->{wbuf} .= $_[0];	976	utf8::downgrade $self->{wbuf} .= $_[0];
749	$self->_drain_wbuf if $self->{fh};	977	$self->_drain_wbuf if $self->{fh};
750	}	978	}
751	}	979	}
752		980
753	=item $handle->push_write (type => @args)	981	=item $handle->push_write (type => @args)
754		982
755	Instead of formatting your data yourself, you can also let this module do	983	Instead of formatting your data yourself, you can also let this module
756	the job by specifying a type and type-specific arguments.	984	do the job by specifying a type and type-specific arguments. You
		985	can also specify the (fully qualified) name of a package, in which
		986	case AnyEvent tries to load the package and then expects to find the
		987	C<anyevent_write_type> function inside (see "custom write types", below).
757		988
758	Predefined types are (if you have ideas for additional types, feel free to	989	Predefined types are (if you have ideas for additional types, feel free to
759	drop by and tell us):	990	drop by and tell us):
760		991
761	=over 4	992	=over 4
…		…
818	Other languages could read single lines terminated by a newline and pass	1049	Other languages could read single lines terminated by a newline and pass
819	this line into their JSON decoder of choice.	1050	this line into their JSON decoder of choice.
820		1051
821	=cut	1052	=cut
822		1053
		1054	sub json_coder() {
		1055	eval { require JSON::XS; JSON::XS->new->utf8 }
		1056	|| do { require JSON; JSON->new->utf8 }
		1057	}
		1058
823	register_write_type json => sub {	1059	register_write_type json => sub {
824	my ($self, $ref) = @_;	1060	my ($self, $ref) = @_;
825		1061
826	require JSON;	1062	my $json = $self->{json} ||= json_coder;
827		1063
828	$self->{json} ? $self->{json}->encode ($ref)	1064	$json->encode ($ref)
829	: JSON::encode_json ($ref)
830	};	1065	};
831		1066
832	=item storable => $reference	1067	=item storable => $reference
833		1068
834	Freezes the given reference using L<Storable> and writes it to the	1069	Freezes the given reference using L<Storable> and writes it to the
…		…
860	the peer.	1095	the peer.
861		1096
862	You can rely on the normal read queue and C<on_eof> handling	1097	You can rely on the normal read queue and C<on_eof> handling
863	afterwards. This is the cleanest way to close a connection.	1098	afterwards. This is the cleanest way to close a connection.
864		1099
		1100	This method may invoke callbacks (and therefore the handle might be
		1101	destroyed after it returns).
		1102
865	=cut	1103	=cut
866		1104
867	sub push_shutdown {	1105	sub push_shutdown {
868	my ($self) = @_;	1106	my ($self) = @_;
869		1107
870	delete $self->{low_water_mark};	1108	delete $self->{low_water_mark};
871	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1109	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
872	}	1110	}
873		1111
874	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1112	=item custom write types - Package::anyevent_write_type $handle, @args
875		1113
876	This function (not method) lets you add your own types to C<push_write>.	1114	Instead of one of the predefined types, you can also specify the name of
		1115	a package. AnyEvent will try to load the package and then expects to find
		1116	a function named C<anyevent_write_type> inside. If it isn't found, it
		1117	progressively tries to load the parent package until it either finds the
		1118	function (good) or runs out of packages (bad).
		1119
877	Whenever the given C<type> is used, C<push_write> will invoke the code	1120	Whenever the given C<type> is used, C<push_write> will the function with
878	reference with the handle object and the remaining arguments.	1121	the handle object and the remaining arguments.
879		1122
880	The code reference is supposed to return a single octet string that will	1123	The function is supposed to return a single octet string that will be
881	be appended to the write buffer.	1124	appended to the write buffer, so you cna mentally treat this function as a
		1125	"arguments to on-the-wire-format" converter.
882		1126
883	Note that this is a function, and all types registered this way will be	1127	Example: implement a custom write type C<join> that joins the remaining
884	global, so try to use unique names.	1128	arguments using the first one.
		1129
		1130	$handle->push_write (My::Type => " ", 1,2,3);
		1131
		1132	# uses the following package, which can be defined in the "My::Type" or in
		1133	# the "My" modules to be auto-loaded, or just about anywhere when the
		1134	# My::Type::anyevent_write_type is defined before invoking it.
		1135
		1136	package My::Type;
		1137
		1138	sub anyevent_write_type {
		1139	my ($handle, $delim, @args) = @_;
		1140
		1141	join $delim, @args
		1142	}
885		1143
886	=cut	1144	=cut
887		1145
888	#############################################################################	1146	#############################################################################
889		1147
…		…
898	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1156	ways, the "simple" way, using only C<on_read> and the "complex" way, using
899	a queue.	1157	a queue.
900		1158
901	In the simple case, you just install an C<on_read> callback and whenever	1159	In the simple case, you just install an C<on_read> callback and whenever
902	new data arrives, it will be called. You can then remove some data (if	1160	new data arrives, it will be called. You can then remove some data (if
903	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1161	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
904	leave the data there if you want to accumulate more (e.g. when only a	1162	leave the data there if you want to accumulate more (e.g. when only a
905	partial message has been received so far).	1163	partial message has been received so far), or change the read queue with
		1164	e.g. C<push_read>.
906		1165
907	In the more complex case, you want to queue multiple callbacks. In this	1166	In the more complex case, you want to queue multiple callbacks. In this
908	case, AnyEvent::Handle will call the first queued callback each time new	1167	case, AnyEvent::Handle will call the first queued callback each time new
909	data arrives (also the first time it is queued) and removes it when it has	1168	data arrives (also the first time it is queued) and remove it when it has
910	done its job (see C<push_read>, below).	1169	done its job (see C<push_read>, below).
911		1170
912	This way you can, for example, push three line-reads, followed by reading	1171	This way you can, for example, push three line-reads, followed by reading
913	a chunk of data, and AnyEvent::Handle will execute them in order.	1172	a chunk of data, and AnyEvent::Handle will execute them in order.
914		1173
…		…
972		1231
973	sub _drain_rbuf {	1232	sub _drain_rbuf {
974	my ($self) = @_;	1233	my ($self) = @_;
975		1234
976	# avoid recursion	1235	# avoid recursion
977	return if exists $self->{_skip_drain_rbuf};	1236	return if $self->{_skip_drain_rbuf};
978	local $self->{_skip_drain_rbuf} = 1;	1237	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		1238
987	while () {	1239	while () {
988	# we need to use a separate tls read buffer, as we must not receive data while	1240	# we need to use a separate tls read buffer, as we must not receive data while
989	# we are draining the buffer, and this can only happen with TLS.	1241	# we are draining the buffer, and this can only happen with TLS.
990	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1242	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1243	if exists $self->{_tls_rbuf};
991		1244
992	my $len = length $self->{rbuf};	1245	my $len = length $self->{rbuf};
993		1246
994	if (my $cb = shift @{ $self->{_queue} }) {	1247	if (my $cb = shift @{ $self->{_queue} }) {
995	unless ($cb->($self)) {	1248	unless ($cb->($self)) {
996	if ($self->{_eof}) {	1249	# no progress can be made
997	# no progress can be made (not enough data and no data forthcoming)	1250	# (not enough data and no data forthcoming)
998	$self->_error (Errno::EPIPE, 1), return;	1251	$self->_error (Errno::EPIPE, 1), return
999	}	1252	if $self->{_eof};
1000		1253
1001	unshift @{ $self->{_queue} }, $cb;	1254	unshift @{ $self->{_queue} }, $cb;
1002	last;	1255	last;
1003	}	1256	}
1004	} elsif ($self->{on_read}) {	1257	} elsif ($self->{on_read}) {
…		…
1024	last;	1277	last;
1025	}	1278	}
1026	}	1279	}
1027		1280
1028	if ($self->{_eof}) {	1281	if ($self->{_eof}) {
1029	if ($self->{on_eof}) {	1282	$self->{on_eof}
1030	$self->{on_eof}($self)	1283	? $self->{on_eof}($self)
1031	} else {
1032	$self->_error (0, 1, "Unexpected end-of-file");	1284	: $self->_error (0, 1, "Unexpected end-of-file");
1033	}	1285
		1286	return;
		1287	}
		1288
		1289	if (
		1290	defined $self->{rbuf_max}
		1291	&& $self->{rbuf_max} < length $self->{rbuf}
		1292	) {
		1293	$self->_error (Errno::ENOSPC, 1), return;
1034	}	1294	}
1035		1295
1036	# may need to restart read watcher	1296	# may need to restart read watcher
1037	unless ($self->{_rw}) {	1297	unless ($self->{_rw}) {
1038	$self->start_read	1298	$self->start_read
…		…
1044		1304
1045	This replaces the currently set C<on_read> callback, or clears it (when	1305	This replaces the currently set C<on_read> callback, or clears it (when
1046	the new callback is C<undef>). See the description of C<on_read> in the	1306	the new callback is C<undef>). See the description of C<on_read> in the
1047	constructor.	1307	constructor.
1048		1308
		1309	This method may invoke callbacks (and therefore the handle might be
		1310	destroyed after it returns).
		1311
1049	=cut	1312	=cut
1050		1313
1051	sub on_read {	1314	sub on_read {
1052	my ($self, $cb) = @_;	1315	my ($self, $cb) = @_;
1053		1316
…		…
1055	$self->_drain_rbuf if $cb;	1318	$self->_drain_rbuf if $cb;
1056	}	1319	}
1057		1320
1058	=item $handle->rbuf	1321	=item $handle->rbuf
1059		1322
1060	Returns the read buffer (as a modifiable lvalue).	1323	Returns the read buffer (as a modifiable lvalue). You can also access the
		1324	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1325	much faster, and no less clean).
1061		1326
1062	You can access the read buffer directly as the C<< ->{rbuf} >>	1327	The only operation allowed on the read buffer (apart from looking at it)
1063	member, if you want. However, the only operation allowed on the	1328	is removing data from its beginning. Otherwise modifying or appending to
1064	read buffer (apart from looking at it) is removing data from its	1329	it is not allowed and will lead to hard-to-track-down bugs.
1065	beginning. Otherwise modifying or appending to it is not allowed and will
1066	lead to hard-to-track-down bugs.
1067		1330
1068	NOTE: The read buffer should only be used or modified if the C<on_read>,	1331	NOTE: The read buffer should only be used or modified in the C<on_read>
1069	C<push_read> or C<unshift_read> methods are used. The other read methods	1332	callback or when C<push_read> or C<unshift_read> are used with a single
1070	automatically manage the read buffer.	1333	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1334	will manage the read buffer on their own.
1071		1335
1072	=cut	1336	=cut
1073		1337
1074	sub rbuf : lvalue {	1338	sub rbuf : lvalue {
1075	$_[0]{rbuf}	1339	$_[0]{rbuf}
…		…
1092		1356
1093	If enough data was available, then the callback must remove all data it is	1357	If enough data was available, then the callback must remove all data it is
1094	interested in (which can be none at all) and return a true value. After returning	1358	interested in (which can be none at all) and return a true value. After returning
1095	true, it will be removed from the queue.	1359	true, it will be removed from the queue.
1096		1360
		1361	These methods may invoke callbacks (and therefore the handle might be
		1362	destroyed after it returns).
		1363
1097	=cut	1364	=cut
1098		1365
1099	our %RH;	1366	our %RH;
1100		1367
1101	sub register_read_type($$) {	1368	sub register_read_type($$) {
…		…
1107	my $cb = pop;	1374	my $cb = pop;
1108		1375
1109	if (@_) {	1376	if (@_) {
1110	my $type = shift;	1377	my $type = shift;
1111		1378
		1379	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1112	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1380	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1113	->($self, $cb, @_);	1381	->($self, $cb, @_);
1114	}	1382	}
1115		1383
1116	push @{ $self->{_queue} }, $cb;	1384	push @{ $self->{_queue} }, $cb;
1117	$self->_drain_rbuf;	1385	$self->_drain_rbuf;
…		…
1122	my $cb = pop;	1390	my $cb = pop;
1123		1391
1124	if (@_) {	1392	if (@_) {
1125	my $type = shift;	1393	my $type = shift;
1126		1394
		1395	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1127	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1396	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1128	->($self, $cb, @_);	1397	->($self, $cb, @_);
1129	}	1398	}
1130
1131		1399
1132	unshift @{ $self->{_queue} }, $cb;	1400	unshift @{ $self->{_queue} }, $cb;
1133	$self->_drain_rbuf;	1401	$self->_drain_rbuf;
1134	}	1402	}
1135		1403
…		…
1137		1405
1138	=item $handle->unshift_read (type => @args, $cb)	1406	=item $handle->unshift_read (type => @args, $cb)
1139		1407
1140	Instead of providing a callback that parses the data itself you can chose	1408	Instead of providing a callback that parses the data itself you can chose
1141	between a number of predefined parsing formats, for chunks of data, lines	1409	between a number of predefined parsing formats, for chunks of data, lines
1142	etc.	1410	etc. You can also specify the (fully qualified) name of a package, in
		1411	which case AnyEvent tries to load the package and then expects to find the
		1412	C<anyevent_read_type> function inside (see "custom read types", below).
1143		1413
1144	Predefined types are (if you have ideas for additional types, feel free to	1414	Predefined types are (if you have ideas for additional types, feel free to
1145	drop by and tell us):	1415	drop by and tell us):
1146		1416
1147	=over 4	1417	=over 4
…		…
1239	the receive buffer when neither C<$accept> nor C<$reject> match,	1509	the receive buffer when neither C<$accept> nor C<$reject> match,
1240	and everything preceding and including the match will be accepted	1510	and everything preceding and including the match will be accepted
1241	unconditionally. This is useful to skip large amounts of data that you	1511	unconditionally. This is useful to skip large amounts of data that you
1242	know cannot be matched, so that the C<$accept> or C<$reject> regex do not	1512	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1243	have to start matching from the beginning. This is purely an optimisation	1513	have to start matching from the beginning. This is purely an optimisation
1244	and is usually worth only when you expect more than a few kilobytes.	1514	and is usually worth it only when you expect more than a few kilobytes.
1245		1515
1246	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1516	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1247	expect the header to be very large (it isn't in practise, but...), we use	1517	expect the header to be very large (it isn't in practice, but...), we use
1248	a skip regex to skip initial portions. The skip regex is tricky in that	1518	a skip regex to skip initial portions. The skip regex is tricky in that
1249	it only accepts something not ending in either \015 or \012, as these are	1519	it only accepts something not ending in either \015 or \012, as these are
1250	required for the accept regex.	1520	required for the accept regex.
1251		1521
1252	$handle->push_read (regex =>	1522	$handle->push_read (regex =>
…		…
1387	=cut	1657	=cut
1388		1658
1389	register_read_type json => sub {	1659	register_read_type json => sub {
1390	my ($self, $cb) = @_;	1660	my ($self, $cb) = @_;
1391		1661
1392	my $json = $self->{json} ||=	1662	my $json = $self->{json} ||= json_coder;
1393	eval { require JSON::XS; JSON::XS->new->utf8 }
1394	|| do { require JSON; JSON->new->utf8 };
1395		1663
1396	my $data;	1664	my $data;
1397	my $rbuf = \$self->{rbuf};	1665	my $rbuf = \$self->{rbuf};
1398		1666
1399	sub {	1667	sub {
…		…
1468	}	1736	}
1469	};	1737	};
1470		1738
1471	=back	1739	=back
1472		1740
1473	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1741	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1474		1742
1475	This function (not method) lets you add your own types to C<push_read>.	1743	Instead of one of the predefined types, you can also specify the name
		1744	of a package. AnyEvent will try to load the package and then expects to
		1745	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1746	progressively tries to load the parent package until it either finds the
		1747	function (good) or runs out of packages (bad).
1476		1748
1477	Whenever the given C<type> is used, C<push_read> will invoke the code	1749	Whenever this type is used, C<push_read> will invoke the function with the
1478	reference with the handle object, the callback and the remaining	1750	handle object, the original callback and the remaining arguments.
1479	arguments.
1480		1751
1481	The code reference is supposed to return a callback (usually a closure)	1752	The function is supposed to return a callback (usually a closure) that
1482	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1753	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1754	mentally treat the function as a "configurable read type to read callback"
		1755	converter.
1483		1756
1484	It should invoke the passed callback when it is done reading (remember to	1757	It should invoke the original callback when it is done reading (remember
1485	pass C<$handle> as first argument as all other callbacks do that).	1758	to pass C<$handle> as first argument as all other callbacks do that,
		1759	although there is no strict requirement on this).
1486		1760
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>,	1761	For examples, see the source of this module (F<perldoc -m
1491	search for C<register_read_type>)).	1762	AnyEvent::Handle>, search for C<register_read_type>)).
1492		1763
1493	=item $handle->stop_read	1764	=item $handle->stop_read
1494		1765
1495	=item $handle->start_read	1766	=item $handle->start_read
1496		1767
…		…
1502	Note that AnyEvent::Handle will automatically C<start_read> for you when	1773	Note that AnyEvent::Handle will automatically C<start_read> for you when
1503	you change the C<on_read> callback or push/unshift a read callback, and it	1774	you change the C<on_read> callback or push/unshift a read callback, and it
1504	will automatically C<stop_read> for you when neither C<on_read> is set nor	1775	will automatically C<stop_read> for you when neither C<on_read> is set nor
1505	there are any read requests in the queue.	1776	there are any read requests in the queue.
1506		1777
1507	These methods will have no effect when in TLS mode (as TLS doesn't support	1778	In older versions of this module (<= 5.3), these methods had no effect,
1508	half-duplex connections).	1779	as TLS does not support half-duplex connections. In current versions they
		1780	work as expected, as this behaviour is required to avoid certain resource
		1781	attacks, where the program would be forced to read (and buffer) arbitrary
		1782	amounts of data before being able to send some data. The drawback is that
		1783	some readings of the the SSL/TLS specifications basically require this
		1784	attack to be working, as SSL/TLS implementations might stall sending data
		1785	during a rehandshake.
		1786
		1787	As a guideline, during the initial handshake, you should not stop reading,
		1788	and as a client, it might cause problems, depending on your applciation.
1509		1789
1510	=cut	1790	=cut
1511		1791
1512	sub stop_read {	1792	sub stop_read {
1513	my ($self) = @_;	1793	my ($self) = @_;
1514		1794
1515	delete $self->{_rw} unless $self->{tls};	1795	delete $self->{_rw};
1516	}	1796	}
1517		1797
1518	sub start_read {	1798	sub start_read {
1519	my ($self) = @_;	1799	my ($self) = @_;
1520		1800
1521	unless ($self->{_rw} || $self->{_eof}) {	1801	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1522	Scalar::Util::weaken $self;	1802	Scalar::Util::weaken $self;
1523		1803
1524	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1804	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1525	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1805	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1526	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1806	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1527		1807
1528	if ($len > 0) {	1808	if ($len > 0) {
1529	$self->{_activity} = AnyEvent->now;	1809	$self->{_activity} = $self->{_ractivity} = AE::now;
1530		1810
1531	if ($self->{tls}) {	1811	if ($self->{tls}) {
1532	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1812	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1533		1813
1534	&_dotls ($self);	1814	&_dotls ($self);
1535	} else {	1815	} else {
1536	$self->_drain_rbuf;	1816	$self->_drain_rbuf;
1537	}	1817	}
1538		1818
		1819	if ($len == $self->{read_size}) {
		1820	$self->{read_size} *= 2;
		1821	$self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
		1822	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		1823	}
		1824
1539	} elsif (defined $len) {	1825	} elsif (defined $len) {
1540	delete $self->{_rw};	1826	delete $self->{_rw};
1541	$self->{_eof} = 1;	1827	$self->{_eof} = 1;
1542	$self->_drain_rbuf;	1828	$self->_drain_rbuf;
1543		1829
1544	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1830	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1545	return $self->_error ($!, 1);	1831	return $self->_error ($!, 1);
1546	}	1832	}
1547	});	1833	};
1548	}	1834	}
1549	}	1835	}
1550		1836
1551	our $ERROR_SYSCALL;	1837	our $ERROR_SYSCALL;
1552	our $ERROR_WANT_READ;	1838	our $ERROR_WANT_READ;
…		…
1619	&& ($tmp != $ERROR_SYSCALL || $!);	1905	&& ($tmp != $ERROR_SYSCALL || $!);
1620		1906
1621	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1907	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1622	$self->{wbuf} .= $tmp;	1908	$self->{wbuf} .= $tmp;
1623	$self->_drain_wbuf;	1909	$self->_drain_wbuf;
		1910	$self->{tls} or return; # tls session might have gone away in callback
1624	}	1911	}
1625		1912
1626	$self->{_on_starttls}	1913	$self->{_on_starttls}
1627	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1914	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1628	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1915	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	1936	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	1937	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	1938	changed to your liking. Note that the handshake might have already started
1652	when this function returns.	1939	when this function returns.
1653		1940
1654	If it an error to start a TLS handshake more than once per	1941	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1655	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1942	handshakes on the same stream. It is best to not attempt to use the
		1943	stream after stopping TLS.
		1944
		1945	This method may invoke callbacks (and therefore the handle might be
		1946	destroyed after it returns).
1656		1947
1657	=cut	1948	=cut
1658		1949
1659	our %TLS_CACHE; #TODO not yet documented, should we?	1950	our %TLS_CACHE; #TODO not yet documented, should we?
1660		1951
1661	sub starttls {	1952	sub starttls {
1662	my ($self, $ssl, $ctx) = @_;	1953	my ($self, $tls, $ctx) = @_;
		1954
		1955	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1956	if $self->{tls};
		1957
		1958	$self->{tls} = $tls;
		1959	$self->{tls_ctx} = $ctx if @_ > 2;
		1960
		1961	return unless $self->{fh};
1663		1962
1664	require Net::SSLeay;	1963	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		1964
1669	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1965	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1670	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1966	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1671		1967
		1968	$tls = delete $self->{tls};
1672	$ctx ||= $self->{tls_ctx};	1969	$ctx = $self->{tls_ctx};
1673		1970
1674	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1971	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1675		1972
1676	if ("HASH" eq ref $ctx) {	1973	if ("HASH" eq ref $ctx) {
1677	require AnyEvent::TLS;	1974	require AnyEvent::TLS;
…		…
1683	$ctx = new AnyEvent::TLS %$ctx;	1980	$ctx = new AnyEvent::TLS %$ctx;
1684	}	1981	}
1685	}	1982	}
1686		1983
1687	$self->{tls_ctx} = $ctx || TLS_CTX ();	1984	$self->{tls_ctx} = $ctx || TLS_CTX ();
1688	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1985	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1689		1986
1690	# basically, this is deep magic (because SSL_read should have the same issues)	1987	# basically, this is deep magic (because SSL_read should have the same issues)
1691	# but the openssl maintainers basically said: "trust us, it just works".	1988	# but the openssl maintainers basically said: "trust us, it just works".
1692	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1989	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1693	# and mismaintained ssleay-module doesn't even offer them).	1990	# 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	1997	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1701	# have identity issues in that area.	1998	# have identity issues in that area.
1702	# Net::SSLeay::CTX_set_mode ($ssl,	1999	# Net::SSLeay::CTX_set_mode ($ssl,
1703	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	2000	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1704	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	2001	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1705	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	2002	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1706		2003
1707	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2004	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1708	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2005	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1709		2006
		2007	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		2008
1710	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	2009	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1711		2010
1712	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2011	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1713	if $self->{on_starttls};	2012	if $self->{on_starttls};
1714		2013
1715	&_dotls; # need to trigger the initial handshake	2014	&_dotls; # need to trigger the initial handshake
…		…
1718		2017
1719	=item $handle->stoptls	2018	=item $handle->stoptls
1720		2019
1721	Shuts down the SSL connection - this makes a proper EOF handshake by	2020	Shuts down the SSL connection - this makes a proper EOF handshake by
1722	sending a close notify to the other side, but since OpenSSL doesn't	2021	sending a close notify to the other side, but since OpenSSL doesn't
1723	support non-blocking shut downs, it is not possible to re-use the stream	2022	support non-blocking shut downs, it is not guaranteed that you can re-use
1724	afterwards.	2023	the stream afterwards.
		2024
		2025	This method may invoke callbacks (and therefore the handle might be
		2026	destroyed after it returns).
1725		2027
1726	=cut	2028	=cut
1727		2029
1728	sub stoptls {	2030	sub stoptls {
1729	my ($self) = @_;	2031	my ($self) = @_;
1730		2032
1731	if ($self->{tls}) {	2033	if ($self->{tls} && $self->{fh}) {
1732	Net::SSLeay::shutdown ($self->{tls});	2034	Net::SSLeay::shutdown ($self->{tls});
1733		2035
1734	&_dotls;	2036	&_dotls;
1735		2037
1736	# # we don't give a shit. no, we do, but we can't. no...#d#	2038	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1742	sub _freetls {	2044	sub _freetls {
1743	my ($self) = @_;	2045	my ($self) = @_;
1744		2046
1745	return unless $self->{tls};	2047	return unless $self->{tls};
1746		2048
1747	$self->{tls_ctx}->_put_session (delete $self->{tls});	2049	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2050	if $self->{tls} > 0;
1748		2051
1749	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2052	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1750	}	2053	}
1751		2054
1752	sub DESTROY {	2055	sub DESTROY {
…		…
1760	my $fh = delete $self->{fh};	2063	my $fh = delete $self->{fh};
1761	my $wbuf = delete $self->{wbuf};	2064	my $wbuf = delete $self->{wbuf};
1762		2065
1763	my @linger;	2066	my @linger;
1764		2067
1765	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2068	push @linger, AE::io $fh, 1, sub {
1766	my $len = syswrite $fh, $wbuf, length $wbuf;	2069	my $len = syswrite $fh, $wbuf, length $wbuf;
1767		2070
1768	if ($len > 0) {	2071	if ($len > 0) {
1769	substr $wbuf, 0, $len, "";	2072	substr $wbuf, 0, $len, "";
1770	} else {	2073	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1771	@linger = (); # end	2074	@linger = (); # end
1772	}	2075	}
1773	});	2076	};
1774	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2077	push @linger, AE::timer $linger, 0, sub {
1775	@linger = ();	2078	@linger = ();
1776	});	2079	};
1777	}	2080	}
1778	}	2081	}
1779		2082
1780	=item $handle->destroy	2083	=item $handle->destroy
1781		2084
1782	Shuts down the handle object as much as possible - this call ensures that	2085	Shuts down the handle object as much as possible - this call ensures that
1783	no further callbacks will be invoked and as many resources as possible	2086	no further callbacks will be invoked and as many resources as possible
1784	will be freed. You must not call any methods on the object afterwards.	2087	will be freed. Any method you will call on the handle object after
		2088	destroying it in this way will be silently ignored (and it will return the
		2089	empty list).
1785		2090
1786	Normally, you can just "forget" any references to an AnyEvent::Handle	2091	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	2092	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	2093	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	2094	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1803	sub destroy {	2108	sub destroy {
1804	my ($self) = @_;	2109	my ($self) = @_;
1805		2110
1806	$self->DESTROY;	2111	$self->DESTROY;
1807	%$self = ();	2112	%$self = ();
		2113	bless $self, "AnyEvent::Handle::destroyed";
1808	}	2114	}
		2115
		2116	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2117	#nop
		2118	}
		2119
		2120	=item $handle->destroyed
		2121
		2122	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2123	->destroy >>, true otherwise.
		2124
		2125	Can be useful to decide whether the handle is still valid after some
		2126	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2127	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2128	can destroy the handle, so work can be avoided by checking sometimes:
		2129
		2130	$hdl->starttls ("accept");
		2131	return if $hdl->destroyed;
		2132	$hdl->push_write (...
		2133
		2134	Note that the call to C<push_write> will silently be ignored if the handle
		2135	has been destroyed, so often you can just ignore the possibility of the
		2136	handle being destroyed.
		2137
		2138	=cut
		2139
		2140	sub destroyed { 0 }
		2141	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1809		2142
1810	=item AnyEvent::Handle::TLS_CTX	2143	=item AnyEvent::Handle::TLS_CTX
1811		2144
1812	This function creates and returns the AnyEvent::TLS object used by default	2145	This function creates and returns the AnyEvent::TLS object used by default
1813	for TLS mode.	2146	for TLS mode.
…		…
1841		2174
1842	It is only safe to "forget" the reference inside EOF or error callbacks,	2175	It is only safe to "forget" the reference inside EOF or error callbacks,
1843	from within all other callbacks, you need to explicitly call the C<<	2176	from within all other callbacks, you need to explicitly call the C<<
1844	->destroy >> method.	2177	->destroy >> method.
1845		2178
		2179	=item Why is my C<on_eof> callback never called?
		2180
		2181	Probably because your C<on_error> callback is being called instead: When
		2182	you have outstanding requests in your read queue, then an EOF is
		2183	considered an error as you clearly expected some data.
		2184
		2185	To avoid this, make sure you have an empty read queue whenever your handle
		2186	is supposed to be "idle" (i.e. connection closes are O.K.). You cna set
		2187	an C<on_read> handler that simply pushes the first read requests in the
		2188	queue.
		2189
		2190	See also the next question, which explains this in a bit more detail.
		2191
		2192	=item How can I serve requests in a loop?
		2193
		2194	Most protocols consist of some setup phase (authentication for example)
		2195	followed by a request handling phase, where the server waits for requests
		2196	and handles them, in a loop.
		2197
		2198	There are two important variants: The first (traditional, better) variant
		2199	handles requests until the server gets some QUIT command, causing it to
		2200	close the connection first (highly desirable for a busy TCP server). A
		2201	client dropping the connection is an error, which means this variant can
		2202	detect an unexpected detection close.
		2203
		2204	To handle this case, always make sure you have a on-empty read queue, by
		2205	pushing the "read request start" handler on it:
		2206
		2207	# we assume a request starts with a single line
		2208	my @start_request; @start_request = (line => sub {
		2209	my ($hdl, $line) = @_;
		2210
		2211	... handle request
		2212
		2213	# push next request read, possibly from a nested callback
		2214	$hdl->push_read (@start_request);
		2215	});
		2216
		2217	# auth done, now go into request handling loop
		2218	# now push the first @start_request
		2219	$hdl->push_read (@start_request);
		2220
		2221	By always having an outstanding C<push_read>, the handle always expects
		2222	some data and raises the C<EPIPE> error when the connction is dropped
		2223	unexpectedly.
		2224
		2225	The second variant is a protocol where the client can drop the connection
		2226	at any time. For TCP, this means that the server machine may run out of
		2227	sockets easier, and in general, it means you cnanot distinguish a protocl
		2228	failure/client crash from a normal connection close. Nevertheless, these
		2229	kinds of protocols are common (and sometimes even the best solution to the
		2230	problem).
		2231
		2232	Having an outstanding read request at all times is possible if you ignore
		2233	C<EPIPE> errors, but this doesn't help with when the client drops the
		2234	connection during a request, which would still be an error.
		2235
		2236	A better solution is to push the initial request read in an C<on_read>
		2237	callback. This avoids an error, as when the server doesn't expect data
		2238	(i.e. is idly waiting for the next request, an EOF will not raise an
		2239	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2240	and simpler:
		2241
		2242	# auth done, now go into request handling loop
		2243	$hdl->on_read (sub {
		2244	my ($hdl) = @_;
		2245
		2246	# called each time we receive data but the read queue is empty
		2247	# simply start read the request
		2248
		2249	$hdl->push_read (line => sub {
		2250	my ($hdl, $line) = @_;
		2251
		2252	... handle request
		2253
		2254	# do nothing special when the request has been handled, just
		2255	# let the request queue go empty.
		2256	});
		2257	});
		2258
1846	=item I get different callback invocations in TLS mode/Why can't I pause	2259	=item I get different callback invocations in TLS mode/Why can't I pause
1847	reading?	2260	reading?
1848		2261
1849	Unlike, say, TCP, TLS connections do not consist of two independent	2262	Unlike, say, TCP, TLS connections do not consist of two independent
1850	communication channels, one for each direction. Or put differently. The	2263	communication channels, one for each direction. Or put differently, the
1851	read and write directions are not independent of each other: you cannot	2264	read and write directions are not independent of each other: you cannot
1852	write data unless you are also prepared to read, and vice versa.	2265	write data unless you are also prepared to read, and vice versa.
1853		2266
1854	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2267	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1855	callback invocations when you are not expecting any read data - the reason	2268	callback invocations when you are not expecting any read data - the reason
1856	is that AnyEvent::Handle always reads in TLS mode.	2269	is that AnyEvent::Handle always reads in TLS mode.
1857		2270
1858	During the connection, you have to make sure that you always have a	2271	During the connection, you have to make sure that you always have a
1859	non-empty read-queue, or an C<on_read> watcher. At the end of the	2272	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1873	my $data = delete $_[0]{rbuf};	2286	my $data = delete $_[0]{rbuf};
1874	});	2287	});
1875		2288
1876	The reason to use C<on_error> is that TCP connections, due to latencies	2289	The reason to use C<on_error> is that TCP connections, due to latencies
1877	and packets loss, might get closed quite violently with an error, when in	2290	and packets loss, might get closed quite violently with an error, when in
1878	fact, all data has been received.	2291	fact all data has been received.
1879		2292
1880	It is usually better to use acknowledgements when transferring data,	2293	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	2294	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	2295	intact. This is also one reason why so many internet protocols have an
1883	explicit QUIT command.	2296	explicit QUIT command.
…		…
1900	consider using C<< ->push_shutdown >> instead.	2313	consider using C<< ->push_shutdown >> instead.
1901		2314
1902	=item I want to contact a TLS/SSL server, I don't care about security.	2315	=item I want to contact a TLS/SSL server, I don't care about security.
1903		2316
1904	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	2317	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1905	simply connect to it and then create the AnyEvent::Handle with the C<tls>	2318	connect to it and then create the AnyEvent::Handle with the C<tls>
1906	parameter:	2319	parameter:
1907		2320
1908	tcp_connect $host, $port, sub {	2321	tcp_connect $host, $port, sub {
1909	my ($fh) = @_;	2322	my ($fh) = @_;
1910		2323
…		…
2010		2423
2011	=item * all members not documented here and not prefixed with an underscore	2424	=item * all members not documented here and not prefixed with an underscore
2012	are free to use in subclasses.	2425	are free to use in subclasses.
2013		2426
2014	Of course, new versions of AnyEvent::Handle may introduce more "public"	2427	Of course, new versions of AnyEvent::Handle may introduce more "public"
2015	member variables, but thats just life, at least it is documented.	2428	member variables, but that's just life. At least it is documented.
2016		2429
2017	=back	2430	=back
2018		2431
2019	=head1 AUTHOR	2432	=head1 AUTHOR
2020		2433

Diff Legend

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