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.160 by root, Fri Jul 24 22:47:04 2009 UTC vs.
Revision 1.217 by root, Thu Feb 3 00:29:33 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
…		…
96	=over 4	114	=over 4
97		115
98	=item on_prepare => $cb->($handle)	116	=item on_prepare => $cb->($handle)
99		117
100	This (rarely used) callback is called before a new connection is	118	This (rarely used) callback is called before a new connection is
101	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
102	prepare the file handle with parameters required for the actual connect	121	file handle with parameters required for the actual connect (as opposed to
103	(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).
104	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).
105		127
106	=item on_connect => $cb->($handle, $host, $port, $retry->())	128	=item on_connect => $cb->($handle, $host, $port, $retry->())
107		129
108	This callback is called when a connection has been successfully established.	130	This callback is called when a connection has been successfully established.
109		131
110	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
111	parameters, together with a retry callback.	133	parameters, together with a retry callback.
112		134
113	When, for some reason, the handle is not acceptable, then calling	135	If, for some reason, the handle is not acceptable, calling C<$retry>
114	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
115	multi-homed hosts or SRV records there can be multiple connection	137	hosts or SRV records there can be multiple connection endpoints). At the
116	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
117	tls status and similar properties of the handle are being reset.	139	similar properties of the handle will have been reset.
118		140
119	In most cases, ignoring the C<$retry> parameter is the way to go.	141	In most cases, you should ignore the C<$retry> parameter.
120		142
121	=item on_connect_error => $cb->($handle, $message)	143	=item on_connect_error => $cb->($handle, $message)
122		144
123	This callback is called when the conenction could not be	145	This callback is called when the connection could not be
124	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
125	message describing it (usually the same as C<"$!">).	147	message describing it (usually the same as C<"$!">).
126		148
127	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
128	fatal error instead.	150	fatal error instead.
…		…
131		153
132	=item on_error => $cb->($handle, $fatal, $message)	154	=item on_error => $cb->($handle, $fatal, $message)
133		155
134	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
135	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
136	connect or a read error.	158	connect, or a read error.
137		159
138	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
139	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<< ->
140	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
141	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
142	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
143	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
144	often easiest to not report C<EPIPE> errors in this callback.	166	often easiest to not report C<EPIPE> errors in this callback.
145		167
146	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
147	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
148	recommended to always output the C<$message> argument in human-readable	170	recommended to always output the C<$message> argument in human-readable
149	error messages (it's usually the same as C<"$!">).	171	error messages (it's usually the same as C<"$!">).
150		172
151	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
152	to simply ignore this parameter and instead abondon the handle object	174	to simply ignore this parameter and instead abondon the handle object
153	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
154	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
155		177
156	On callback entrance, the value of C<$!> contains the operating system	178	On entry to the callback, the value of C<$!> contains the operating
157	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
158	C<EPROTO>).	180	C<EPROTO>).
159		181
160	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
161	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
162	C<croak>.	184	C<croak>.
163		185
164	=item on_read => $cb->($handle)	186	=item on_read => $cb->($handle)
165		187
166	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
…		…
171	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 >>
172	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
173	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
174	the beginning from it.	196	the beginning from it.
175		197
		198	You can also call C<< ->push_read (...) >> or any other function that
		199	modifies the read queue. Or do both. Or ...
		200
176	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
177	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
178	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
179	error will be raised (with C<$!> set to C<EPIPE>).	204	error will be raised (with C<$!> set to C<EPIPE>).
180		205
181	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
…		…
200	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>.
201		226
202	=item on_drain => $cb->($handle)	227	=item on_drain => $cb->($handle)
203		228
204	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
205	(or when the callback is set and the buffer is empty already).	230	(or immediately if the buffer is empty already).
206		231
207	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.
208		233
209	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
210	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
…		…
212	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
213	the file when the write queue becomes empty.	238	the file when the write queue becomes empty.
214		239
215	=item timeout => $fractional_seconds	240	=item timeout => $fractional_seconds
216		241
		242	=item rtimeout => $fractional_seconds
		243
		244	=item wtimeout => $fractional_seconds
		245
217	If non-zero, then this enables an "inactivity" timeout: whenever this many	246	If non-zero, then these enables an "inactivity" timeout: whenever this
218	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
219	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
220	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).
221		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
222	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
223	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
224	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
225	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
226	restart the timeout.	262	restart the timeout.
227		263
228	Zero (the default) disables this timeout.	264	Zero (the default) disables this timeout.
229		265
…		…
243	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
244	(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
245	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
246	isn't finished).	282	isn't finished).
247		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
248	=item autocork => <boolean>	299	=item autocork => <boolean>
249		300
250	When disabled (the default), then C<push_write> will try to immediately	301	When disabled (the default), C<push_write> will try to immediately
251	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
252	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
253	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
254	disadvantage is usually avoided by your kernel's nagle algorithm, see	305	disadvantage is usually avoided by your kernel's nagle algorithm, see
255	C<no_delay>, but this option can save costly syscalls).	306	C<no_delay>, but this option can save costly syscalls).
256		307
257	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
258	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,
259	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
260	the write buffer often is full). It also increases write latency.	311	the write buffer often is full). It also increases write latency.
261		312
262	=item no_delay => <boolean>	313	=item no_delay => <boolean>
…		…
266	the Nagle algorithm, and usually it is beneficial.	317	the Nagle algorithm, and usually it is beneficial.
267		318
268	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
269	accomplishd by setting this option to a true value.	320	accomplishd by setting this option to a true value.
270		321
271	The default is your opertaing system's default behaviour (most likely	322	The default is your operating system's default behaviour (most likely
272	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.
273		356
274	=item read_size => <bytes>	357	=item read_size => <bytes>
275		358
276	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
277	try to read during each loop iteration, which affects memory	360	read during each loop iteration. Each handle object will consume at least
278	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.
279		370
280	=item low_water_mark => <bytes>	371	=item low_water_mark => <bytes>
281		372
282	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
283	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
284	considered empty.	375	considered empty.
285		376
286	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
287	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
288	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
289	is good in almost all cases.	380	is good in almost all cases.
290		381
291	=item linger => <seconds>	382	=item linger => <seconds>
292		383
293	If non-zero (default: C<3600>), then the destructor of the	384	If this is non-zero (default: C<3600>), the destructor of the
294	AnyEvent::Handle object will check whether there is still outstanding	385	AnyEvent::Handle object will check whether there is still outstanding
295	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
296	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
297	system treats outstanding data at socket close time).	388	system treats outstanding data at socket close time).
298		389
…		…
305	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
306	(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.
307		398
308	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
309	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	400	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
310	verification will be skipped when C<peername> is not specified or	401	verification will be skipped when C<peername> is not specified or is
311	C<undef>.	402	C<undef>.
312		403
313	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	404	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
314		405
315	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
316	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
317	established and will transparently encrypt/decrypt data afterwards.	408	established and will transparently encrypt/decrypt data afterwards.
318		409
319	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
320	appropriate error message.	411	appropriate error message.
321		412
…		…
341	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	432	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
342	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
343	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
344	segmentation fault.	435	segmentation fault.
345		436
346	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.
347		438
348	=item tls_ctx => $anyevent_tls	439	=item tls_ctx => $anyevent_tls
349		440
350	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
351	(unless a connection object was specified directly). If this parameter is	442	(unless a connection object was specified directly). If this
352	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>.
353		445
354	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
355	=> 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
356	new TLS context object.	448	new TLS context object.
357		449
…		…
366		458
367	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
368	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>.
369		461
370	Without this callback, handshake failures lead to C<on_error> being	462	Without this callback, handshake failures lead to C<on_error> being
371	called, as normal.	463	called as usual.
372		464
373	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
374	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
375	then call C<< ->starttls >> again.	467	then call C<< ->starttls >> again.
376		468
377	=item on_stoptls => $cb->($handle)	469	=item on_stoptls => $cb->($handle)
378		470
…		…
426	$self->{connect}[0],	518	$self->{connect}[0],
427	$self->{connect}[1],	519	$self->{connect}[1],
428	sub {	520	sub {
429	my ($fh, $host, $port, $retry) = @_;	521	my ($fh, $host, $port, $retry) = @_;
430		522
		523	delete $self->{_connect}; # no longer needed
		524
431	if ($fh) {	525	if ($fh) {
432	$self->{fh} = $fh;	526	$self->{fh} = $fh;
433		527
434	delete $self->{_skip_drain_rbuf};	528	delete $self->{_skip_drain_rbuf};
435	$self->_start;	529	$self->_start;
436		530
437	$self->{on_connect}	531	$self->{on_connect}
438	and $self->{on_connect}($self, $host, $port, sub {	532	and $self->{on_connect}($self, $host, $port, sub {
439	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)};
440	$self->{_skip_drain_rbuf} = 1;	534	$self->{_skip_drain_rbuf} = 1;
441	&$retry;	535	&$retry;
442	});	536	});
443		537
444	} else {	538	} else {
445	if ($self->{on_connect_error}) {	539	if ($self->{on_connect_error}) {
446	$self->{on_connect_error}($self, "$!");	540	$self->{on_connect_error}($self, "$!");
447	$self->destroy;	541	$self->destroy if $self;
448	} else {	542	} else {
449	$self->fatal ($!, 1);	543	$self->_error ($!, 1);
450	}	544	}
451	}	545	}
452	},	546	},
453	sub {	547	sub {
454	local $self->{fh} = $_[0];	548	local $self->{fh} = $_[0];
455		549
		550	$self->{on_prepare}
456	$self->{on_prepare}->($self)	551	? $self->{on_prepare}->($self)
457	if $self->{on_prepare};	552	: ()
458	}	553	}
459	);	554	);
460	}	555	}
461		556
462	} else {	557	} else {
…		…
467	}	562	}
468		563
469	sub _start {	564	sub _start {
470	my ($self) = @_;	565	my ($self) = @_;
471		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
472	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	573	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
473		574
		575	$self->{_activity} =
		576	$self->{_ractivity} =
474	$self->{_activity} = AnyEvent->now;	577	$self->{_wactivity} = AE::now;
475	$self->_timeout;
476		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
477	$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};
478		589
		590	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		591
479	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	592	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
480	if $self->{tls};	593	if $self->{tls};
481		594
482	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	595	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
483		596
484	$self->start_read	597	$self->start_read
485	if $self->{on_read} || @{ $self->{_queue} };	598	if $self->{on_read} || @{ $self->{_queue} };
486		599
487	$self->_drain_wbuf;	600	$self->_drain_wbuf;
488	}	601	}
489
490	#sub _shutdown {
491	# my ($self) = @_;
492	#
493	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
494	# $self->{_eof} = 1; # tell starttls et. al to stop trying
495	#
496	# &_freetls;
497	#}
498		602
499	sub _error {	603	sub _error {
500	my ($self, $errno, $fatal, $message) = @_;	604	my ($self, $errno, $fatal, $message) = @_;
501		605
502	$! = $errno;	606	$! = $errno;
503	$message ||= "$!";	607	$message ||= "$!";
504		608
505	if ($self->{on_error}) {	609	if ($self->{on_error}) {
506	$self->{on_error}($self, $fatal, $message);	610	$self->{on_error}($self, $fatal, $message);
507	$self->destroy if $fatal;	611	$self->destroy if $fatal;
508	} elsif ($self->{fh}) {	612	} elsif ($self->{fh} || $self->{connect}) {
509	$self->destroy;	613	$self->destroy;
510	Carp::croak "AnyEvent::Handle uncaught error: $message";	614	Carp::croak "AnyEvent::Handle uncaught error: $message";
511	}	615	}
512	}	616	}
513		617
…		…
539	$_[0]{on_eof} = $_[1];	643	$_[0]{on_eof} = $_[1];
540	}	644	}
541		645
542	=item $handle->on_timeout ($cb)	646	=item $handle->on_timeout ($cb)
543		647
544	Replace the current C<on_timeout> callback, or disables the callback (but	648	=item $handle->on_rtimeout ($cb)
545	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
546	argument and method.
547		649
548	=cut	650	=item $handle->on_wtimeout ($cb)
549		651
550	sub on_timeout {	652	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
551	$_[0]{on_timeout} = $_[1];	653	callback, or disables the callback (but not the timeout) if C<$cb> =
552	}	654	C<undef>. See the C<timeout> constructor argument and method.
		655
		656	=cut
		657
		658	# see below
553		659
554	=item $handle->autocork ($boolean)	660	=item $handle->autocork ($boolean)
555		661
556	Enables or disables the current autocork behaviour (see C<autocork>	662	Enables or disables the current autocork behaviour (see C<autocork>
557	constructor argument). Changes will only take effect on the next write.	663	constructor argument). Changes will only take effect on the next write.
…		…
570	=cut	676	=cut
571		677
572	sub no_delay {	678	sub no_delay {
573	$_[0]{no_delay} = $_[1];	679	$_[0]{no_delay} = $_[1];
574		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
575	eval {	695	eval {
576	local $SIG{__DIE__};	696	local $SIG{__DIE__};
577	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	697	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
578	if $_[0]{fh};	698	if $_[0]{fh};
579	};	699	};
580	}	700	}
581		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
582	=item $handle->on_starttls ($cb)	736	=item $handle->on_starttls ($cb)
583		737
584	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).
585		739
586	=cut	740	=cut
…		…
593		747
594	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).
595		749
596	=cut	750	=cut
597		751
598	sub on_starttls {	752	sub on_stoptls {
599	$_[0]{on_stoptls} = $_[1];	753	$_[0]{on_stoptls} = $_[1];
600	}	754	}
601		755
		756	=item $handle->rbuf_max ($max_octets)
		757
		758	Configures the C<rbuf_max> setting (C<undef> disables it).
		759
		760	=item $handle->wbuf_max ($max_octets)
		761
		762	Configures the C<wbuf_max> setting (C<undef> disables it).
		763
		764	=cut
		765
		766	sub rbuf_max {
		767	$_[0]{rbuf_max} = $_[1];
		768	}
		769
		770	sub wbuf_max {
		771	$_[0]{wbuf_max} = $_[1];
		772	}
		773
602	#############################################################################	774	#############################################################################
603		775
604	=item $handle->timeout ($seconds)	776	=item $handle->timeout ($seconds)
605		777
		778	=item $handle->rtimeout ($seconds)
		779
		780	=item $handle->wtimeout ($seconds)
		781
606	Configures (or disables) the inactivity timeout.	782	Configures (or disables) the inactivity timeout.
607		783
608	=cut	784	=item $handle->timeout_reset
609		785
610	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 {
611	my ($self, $timeout) = @_;	808	my ($self, $new_value) = @_;
612		809
		810	$new_value >= 0
		811	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		812
613	$self->{timeout} = $timeout;	813	$self->{$timeout} = $new_value;
614	$self->_timeout;	814	delete $self->{$tw}; &$cb;
615	}	815	};
616		816
		817	*{"${dir}timeout_reset"} = sub {
		818	$_[0]{$activity} = AE::now;
		819	};
		820
		821	# main workhorse:
617	# reset the timeout watcher, as neccessary	822	# reset the timeout watcher, as neccessary
618	# also check for time-outs	823	# also check for time-outs
619	sub _timeout {	824	$cb = sub {
620	my ($self) = @_;	825	my ($self) = @_;
621		826
622	if ($self->{timeout} && $self->{fh}) {	827	if ($self->{$timeout} && $self->{fh}) {
623	my $NOW = AnyEvent->now;	828	my $NOW = AE::now;
624		829
625	# when would the timeout trigger?	830	# when would the timeout trigger?
626	my $after = $self->{_activity} + $self->{timeout} - $NOW;	831	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
627		832
628	# now or in the past already?	833	# now or in the past already?
629	if ($after <= 0) {	834	if ($after <= 0) {
630	$self->{_activity} = $NOW;	835	$self->{$activity} = $NOW;
631		836
632	if ($self->{on_timeout}) {	837	if ($self->{$on_timeout}) {
633	$self->{on_timeout}($self);	838	$self->{$on_timeout}($self);
634	} else {	839	} else {
635	$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};
636	}	848	}
637		849
638	# callback could have changed timeout value, optimise	850	Scalar::Util::weaken $self;
639	return unless $self->{timeout};	851	return unless $self; # ->error could have destroyed $self
640		852
641	# calculate new after	853	$self->{$tw} ||= AE::timer $after, 0, sub {
642	$after = $self->{timeout};	854	delete $self->{$tw};
		855	$cb->($self);
		856	};
		857	} else {
		858	delete $self->{$tw};
643	}	859	}
644
645	Scalar::Util::weaken $self;
646	return unless $self; # ->error could have destroyed $self
647
648	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
649	delete $self->{_tw};
650	$self->_timeout;
651	});
652	} else {
653	delete $self->{_tw};
654	}	860	}
655	}	861	}
656		862
657	#############################################################################	863	#############################################################################
658		864
…		…
674	=item $handle->on_drain ($cb)	880	=item $handle->on_drain ($cb)
675		881
676	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
677	C<on_drain> in the constructor).	883	C<on_drain> in the constructor).
678		884
		885	This method may invoke callbacks (and therefore the handle might be
		886	destroyed after it returns).
		887
679	=cut	888	=cut
680		889
681	sub on_drain {	890	sub on_drain {
682	my ($self, $cb) = @_;	891	my ($self, $cb) = @_;
683		892
…		…
687	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});
688	}	897	}
689		898
690	=item $handle->push_write ($data)	899	=item $handle->push_write ($data)
691		900
692	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
693	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
694	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).
695		907
696	=cut	908	=cut
697		909
698	sub _drain_wbuf {	910	sub _drain_wbuf {
699	my ($self) = @_;	911	my ($self) = @_;
…		…
706	my $len = syswrite $self->{fh}, $self->{wbuf};	918	my $len = syswrite $self->{fh}, $self->{wbuf};
707		919
708	if (defined $len) {	920	if (defined $len) {
709	substr $self->{wbuf}, 0, $len, "";	921	substr $self->{wbuf}, 0, $len, "";
710		922
711	$self->{_activity} = AnyEvent->now;	923	$self->{_activity} = $self->{_wactivity} = AE::now;
712		924
713	$self->{on_drain}($self)	925	$self->{on_drain}($self)
714	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})
715	&& $self->{on_drain};	927	&& $self->{on_drain};
716		928
…		…
722		934
723	# try to write data immediately	935	# try to write data immediately
724	$cb->() unless $self->{autocork};	936	$cb->() unless $self->{autocork};
725		937
726	# if still data left in wbuf, we need to poll	938	# if still data left in wbuf, we need to poll
727	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	939	$self->{_ww} = AE::io $self->{fh}, 1, $cb
728	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	}
729	};	948	};
730	}	949	}
731		950
732	our %WH;	951	our %WH;
733		952
		953	# deprecated
734	sub register_write_type($$) {	954	sub register_write_type($$) {
735	$WH{$_[0]} = $_[1];	955	$WH{$_[0]} = $_[1];
736	}	956	}
737		957
738	sub push_write {	958	sub push_write {
739	my $self = shift;	959	my $self = shift;
740		960
741	if (@_ > 1) {	961	if (@_ > 1) {
742	my $type = shift;	962	my $type = shift;
743		963
		964	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
744	@_ = ($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")
745	->($self, @_);	966	->($self, @_);
746	}	967	}
747		968
		969	# we downgrade here to avoid hard-to-track-down bugs,
		970	# and diagnose the problem earlier and better.
		971
748	if ($self->{tls}) {	972	if ($self->{tls}) {
749	$self->{_tls_wbuf} .= $_[0];	973	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
750	&_dotls ($self) if $self->{fh};	974	&_dotls ($self) if $self->{fh};
751	} else {	975	} else {
752	$self->{wbuf} .= $_[0];	976	utf8::downgrade $self->{wbuf} .= $_[0];
753	$self->_drain_wbuf if $self->{fh};	977	$self->_drain_wbuf if $self->{fh};
754	}	978	}
755	}	979	}
756		980
757	=item $handle->push_write (type => @args)	981	=item $handle->push_write (type => @args)
758		982
759	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
760	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).
761		988
762	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
763	drop by and tell us):	990	drop by and tell us):
764		991
765	=over 4	992	=over 4
…		…
822	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
823	this line into their JSON decoder of choice.	1050	this line into their JSON decoder of choice.
824		1051
825	=cut	1052	=cut
826		1053
		1054	sub json_coder() {
		1055	eval { require JSON::XS; JSON::XS->new->utf8 }
		1056	|| do { require JSON; JSON->new->utf8 }
		1057	}
		1058
827	register_write_type json => sub {	1059	register_write_type json => sub {
828	my ($self, $ref) = @_;	1060	my ($self, $ref) = @_;
829		1061
830	require JSON;	1062	my $json = $self->{json} ||= json_coder;
831		1063
832	$self->{json} ? $self->{json}->encode ($ref)	1064	$json->encode ($ref)
833	: JSON::encode_json ($ref)
834	};	1065	};
835		1066
836	=item storable => $reference	1067	=item storable => $reference
837		1068
838	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
…		…
856	before it was actually written. One way to do that is to replace your	1087	before it was actually written. One way to do that is to replace your
857	C<on_drain> handler by a callback that shuts down the socket (and set	1088	C<on_drain> handler by a callback that shuts down the socket (and set
858	C<low_water_mark> to C<0>). This method is a shorthand for just that, and	1089	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
859	replaces the C<on_drain> callback with:	1090	replaces the C<on_drain> callback with:
860		1091
861	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1092	sub { shutdown $_[0]{fh}, 1 }
862		1093
863	This simply shuts down the write side and signals an EOF condition to the	1094	This simply shuts down the write side and signals an EOF condition to the
864	the peer.	1095	the peer.
865		1096
866	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
867	afterwards. This is the cleanest way to close a connection.	1098	afterwards. This is the cleanest way to close a connection.
868		1099
		1100	This method may invoke callbacks (and therefore the handle might be
		1101	destroyed after it returns).
		1102
869	=cut	1103	=cut
870		1104
871	sub push_shutdown {	1105	sub push_shutdown {
872	my ($self) = @_;	1106	my ($self) = @_;
873		1107
874	delete $self->{low_water_mark};	1108	delete $self->{low_water_mark};
875	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1109	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
876	}	1110	}
877		1111
878	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1112	=item custom write types - Package::anyevent_write_type $handle, @args
879		1113
880	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
881	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
882	reference with the handle object and the remaining arguments.	1121	the handle object and the remaining arguments.
883		1122
884	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
885	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.
886		1126
887	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
888	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	}
889		1143
890	=cut	1144	=cut
891		1145
892	#############################################################################	1146	#############################################################################
893		1147
…		…
902	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
903	a queue.	1157	a queue.
904		1158
905	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
906	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
907	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
908	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
909	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>.
910		1165
911	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
912	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
913	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
914	done its job (see C<push_read>, below).	1169	done its job (see C<push_read>, below).
915		1170
916	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
917	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.
918		1173
…		…
976		1231
977	sub _drain_rbuf {	1232	sub _drain_rbuf {
978	my ($self) = @_;	1233	my ($self) = @_;
979		1234
980	# avoid recursion	1235	# avoid recursion
981	return if exists $self->{_skip_drain_rbuf};	1236	return if $self->{_skip_drain_rbuf};
982	local $self->{_skip_drain_rbuf} = 1;	1237	local $self->{_skip_drain_rbuf} = 1;
983
984	if (
985	defined $self->{rbuf_max}
986	&& $self->{rbuf_max} < length $self->{rbuf}
987	) {
988	$self->_error (Errno::ENOSPC, 1), return;
989	}
990		1238
991	while () {	1239	while () {
992	# 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
993	# 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.
994	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1242	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1243	if exists $self->{_tls_rbuf};
995		1244
996	my $len = length $self->{rbuf};	1245	my $len = length $self->{rbuf};
997		1246
998	if (my $cb = shift @{ $self->{_queue} }) {	1247	if (my $cb = shift @{ $self->{_queue} }) {
999	unless ($cb->($self)) {	1248	unless ($cb->($self)) {
1000	if ($self->{_eof}) {	1249	# no progress can be made
1001	# no progress can be made (not enough data and no data forthcoming)	1250	# (not enough data and no data forthcoming)
1002	$self->_error (Errno::EPIPE, 1), return;	1251	$self->_error (Errno::EPIPE, 1), return
1003	}	1252	if $self->{_eof};
1004		1253
1005	unshift @{ $self->{_queue} }, $cb;	1254	unshift @{ $self->{_queue} }, $cb;
1006	last;	1255	last;
1007	}	1256	}
1008	} elsif ($self->{on_read}) {	1257	} elsif ($self->{on_read}) {
…		…
1028	last;	1277	last;
1029	}	1278	}
1030	}	1279	}
1031		1280
1032	if ($self->{_eof}) {	1281	if ($self->{_eof}) {
1033	if ($self->{on_eof}) {	1282	$self->{on_eof}
1034	$self->{on_eof}($self)	1283	? $self->{on_eof}($self)
1035	} else {
1036	$self->_error (0, 1, "Unexpected end-of-file");	1284	: $self->_error (0, 1, "Unexpected end-of-file");
1037	}	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;
1038	}	1294	}
1039		1295
1040	# may need to restart read watcher	1296	# may need to restart read watcher
1041	unless ($self->{_rw}) {	1297	unless ($self->{_rw}) {
1042	$self->start_read	1298	$self->start_read
…		…
1048		1304
1049	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
1050	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
1051	constructor.	1307	constructor.
1052		1308
		1309	This method may invoke callbacks (and therefore the handle might be
		1310	destroyed after it returns).
		1311
1053	=cut	1312	=cut
1054		1313
1055	sub on_read {	1314	sub on_read {
1056	my ($self, $cb) = @_;	1315	my ($self, $cb) = @_;
1057		1316
…		…
1059	$self->_drain_rbuf if $cb;	1318	$self->_drain_rbuf if $cb;
1060	}	1319	}
1061		1320
1062	=item $handle->rbuf	1321	=item $handle->rbuf
1063		1322
1064	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).
1065		1326
1066	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)
1067	member, if you want. However, the only operation allowed on the	1328	is removing data from its beginning. Otherwise modifying or appending to
1068	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.
1069	beginning. Otherwise modifying or appending to it is not allowed and will
1070	lead to hard-to-track-down bugs.
1071		1330
1072	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>
1073	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
1074	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.
1075		1335
1076	=cut	1336	=cut
1077		1337
1078	sub rbuf : lvalue {	1338	sub rbuf : lvalue {
1079	$_[0]{rbuf}	1339	$_[0]{rbuf}
…		…
1096		1356
1097	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
1098	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
1099	true, it will be removed from the queue.	1359	true, it will be removed from the queue.
1100		1360
		1361	These methods may invoke callbacks (and therefore the handle might be
		1362	destroyed after it returns).
		1363
1101	=cut	1364	=cut
1102		1365
1103	our %RH;	1366	our %RH;
1104		1367
1105	sub register_read_type($$) {	1368	sub register_read_type($$) {
…		…
1111	my $cb = pop;	1374	my $cb = pop;
1112		1375
1113	if (@_) {	1376	if (@_) {
1114	my $type = shift;	1377	my $type = shift;
1115		1378
		1379	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1116	$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")
1117	->($self, $cb, @_);	1381	->($self, $cb, @_);
1118	}	1382	}
1119		1383
1120	push @{ $self->{_queue} }, $cb;	1384	push @{ $self->{_queue} }, $cb;
1121	$self->_drain_rbuf;	1385	$self->_drain_rbuf;
…		…
1126	my $cb = pop;	1390	my $cb = pop;
1127		1391
1128	if (@_) {	1392	if (@_) {
1129	my $type = shift;	1393	my $type = shift;
1130		1394
		1395	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1131	$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")
1132	->($self, $cb, @_);	1397	->($self, $cb, @_);
1133	}	1398	}
1134
1135		1399
1136	unshift @{ $self->{_queue} }, $cb;	1400	unshift @{ $self->{_queue} }, $cb;
1137	$self->_drain_rbuf;	1401	$self->_drain_rbuf;
1138	}	1402	}
1139		1403
…		…
1141		1405
1142	=item $handle->unshift_read (type => @args, $cb)	1406	=item $handle->unshift_read (type => @args, $cb)
1143		1407
1144	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
1145	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
1146	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).
1147		1413
1148	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
1149	drop by and tell us):	1415	drop by and tell us):
1150		1416
1151	=over 4	1417	=over 4
…		…
1243	the receive buffer when neither C<$accept> nor C<$reject> match,	1509	the receive buffer when neither C<$accept> nor C<$reject> match,
1244	and everything preceding and including the match will be accepted	1510	and everything preceding and including the match will be accepted
1245	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
1246	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
1247	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
1248	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.
1249		1515
1250	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
1251	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
1252	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
1253	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
1254	required for the accept regex.	1520	required for the accept regex.
1255		1521
1256	$handle->push_read (regex =>	1522	$handle->push_read (regex =>
…		…
1391	=cut	1657	=cut
1392		1658
1393	register_read_type json => sub {	1659	register_read_type json => sub {
1394	my ($self, $cb) = @_;	1660	my ($self, $cb) = @_;
1395		1661
1396	my $json = $self->{json} ||=	1662	my $json = $self->{json} ||= json_coder;
1397	eval { require JSON::XS; JSON::XS->new->utf8 }
1398	|| do { require JSON; JSON->new->utf8 };
1399		1663
1400	my $data;	1664	my $data;
1401	my $rbuf = \$self->{rbuf};	1665	my $rbuf = \$self->{rbuf};
1402		1666
1403	sub {	1667	sub {
…		…
1472	}	1736	}
1473	};	1737	};
1474		1738
1475	=back	1739	=back
1476		1740
1477	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1741	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1478		1742
1479	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).
1480		1748
1481	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
1482	reference with the handle object, the callback and the remaining	1750	handle object, the original callback and the remaining arguments.
1483	arguments.
1484		1751
1485	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
1486	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.
1487		1756
1488	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
1489	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).
1490		1760
1491	Note that this is a function, and all types registered this way will be
1492	global, so try to use unique names.
1493
1494	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
1495	search for C<register_read_type>)).	1762	AnyEvent::Handle>, search for C<register_read_type>)).
1496		1763
1497	=item $handle->stop_read	1764	=item $handle->stop_read
1498		1765
1499	=item $handle->start_read	1766	=item $handle->start_read
1500		1767
…		…
1506	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
1507	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
1508	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
1509	there are any read requests in the queue.	1776	there are any read requests in the queue.
1510		1777
1511	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,
1512	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.
1513		1789
1514	=cut	1790	=cut
1515		1791
1516	sub stop_read {	1792	sub stop_read {
1517	my ($self) = @_;	1793	my ($self) = @_;
1518		1794
1519	delete $self->{_rw} unless $self->{tls};	1795	delete $self->{_rw};
1520	}	1796	}
1521		1797
1522	sub start_read {	1798	sub start_read {
1523	my ($self) = @_;	1799	my ($self) = @_;
1524		1800
1525	unless ($self->{_rw} || $self->{_eof}) {	1801	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1526	Scalar::Util::weaken $self;	1802	Scalar::Util::weaken $self;
1527		1803
1528	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1804	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1529	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1805	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1530	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1806	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1531		1807
1532	if ($len > 0) {	1808	if ($len > 0) {
1533	$self->{_activity} = AnyEvent->now;	1809	$self->{_activity} = $self->{_ractivity} = AE::now;
1534		1810
1535	if ($self->{tls}) {	1811	if ($self->{tls}) {
1536	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1812	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1537		1813
1538	&_dotls ($self);	1814	&_dotls ($self);
1539	} else {	1815	} else {
1540	$self->_drain_rbuf;	1816	$self->_drain_rbuf;
1541	}	1817	}
1542		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
1543	} elsif (defined $len) {	1825	} elsif (defined $len) {
1544	delete $self->{_rw};	1826	delete $self->{_rw};
1545	$self->{_eof} = 1;	1827	$self->{_eof} = 1;
1546	$self->_drain_rbuf;	1828	$self->_drain_rbuf;
1547		1829
1548	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1830	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1549	return $self->_error ($!, 1);	1831	return $self->_error ($!, 1);
1550	}	1832	}
1551	});	1833	};
1552	}	1834	}
1553	}	1835	}
1554		1836
1555	our $ERROR_SYSCALL;	1837	our $ERROR_SYSCALL;
1556	our $ERROR_WANT_READ;	1838	our $ERROR_WANT_READ;
…		…
1623	&& ($tmp != $ERROR_SYSCALL || $!);	1905	&& ($tmp != $ERROR_SYSCALL || $!);
1624		1906
1625	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1907	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1626	$self->{wbuf} .= $tmp;	1908	$self->{wbuf} .= $tmp;
1627	$self->_drain_wbuf;	1909	$self->_drain_wbuf;
		1910	$self->{tls} or return; # tls session might have gone away in callback
1628	}	1911	}
1629		1912
1630	$self->{_on_starttls}	1913	$self->{_on_starttls}
1631	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1914	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1632	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1915	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1654	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
1655	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
1656	when this function returns.	1939	when this function returns.
1657		1940
1658	Due to bugs in OpenSSL, it might or might not be possible to do multiple	1941	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1659	handshakes on the same stream. Best do not attempt to use the stream after	1942	handshakes on the same stream. It is best to not attempt to use the
1660	stopping TLS.	1943	stream after stopping TLS.
		1944
		1945	This method may invoke callbacks (and therefore the handle might be
		1946	destroyed after it returns).
1661		1947
1662	=cut	1948	=cut
1663		1949
1664	our %TLS_CACHE; #TODO not yet documented, should we?	1950	our %TLS_CACHE; #TODO not yet documented, should we?
1665		1951
…		…
1677	require Net::SSLeay;	1963	require Net::SSLeay;
1678		1964
1679	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1965	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1680	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1966	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1681		1967
1682	$tls = $self->{tls};	1968	$tls = delete $self->{tls};
1683	$ctx = $self->{tls_ctx};	1969	$ctx = $self->{tls_ctx};
1684		1970
1685	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
1686		1972
1687	if ("HASH" eq ref $ctx) {	1973	if ("HASH" eq ref $ctx) {
…		…
1716	Net::SSLeay::CTX_set_mode ($tls, 1|2);	2002	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1717		2003
1718	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2004	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1719	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2005	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1720		2006
		2007	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		2008
1721	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2009	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1722		2010
1723	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2011	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1724	if $self->{on_starttls};	2012	if $self->{on_starttls};
1725		2013
…		…
1729		2017
1730	=item $handle->stoptls	2018	=item $handle->stoptls
1731		2019
1732	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
1733	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
1734	support non-blocking shut downs, it is not guarenteed that you can re-use	2022	support non-blocking shut downs, it is not guaranteed that you can re-use
1735	the stream afterwards.	2023	the stream afterwards.
		2024
		2025	This method may invoke callbacks (and therefore the handle might be
		2026	destroyed after it returns).
1736		2027
1737	=cut	2028	=cut
1738		2029
1739	sub stoptls {	2030	sub stoptls {
1740	my ($self) = @_;	2031	my ($self) = @_;
1741		2032
1742	if ($self->{tls}) {	2033	if ($self->{tls} && $self->{fh}) {
1743	Net::SSLeay::shutdown ($self->{tls});	2034	Net::SSLeay::shutdown ($self->{tls});
1744		2035
1745	&_dotls;	2036	&_dotls;
1746		2037
1747	# # 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#
…		…
1754	my ($self) = @_;	2045	my ($self) = @_;
1755		2046
1756	return unless $self->{tls};	2047	return unless $self->{tls};
1757		2048
1758	$self->{tls_ctx}->_put_session (delete $self->{tls})	2049	$self->{tls_ctx}->_put_session (delete $self->{tls})
1759	if ref $self->{tls};	2050	if $self->{tls} > 0;
1760		2051
1761	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2052	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1762	}	2053	}
		2054
		2055	=item $handle->resettls
		2056
		2057	This rarely-used method simply resets and TLS state on the handle, usually
		2058	causing data loss.
		2059
		2060	One case where it may be useful is when you want to skip over the data in
		2061	the stream but you are not interested in interpreting it, so data loss is
		2062	no concern.
		2063
		2064	=cut
		2065
		2066	*resettls = \&_freetls;
1763		2067
1764	sub DESTROY {	2068	sub DESTROY {
1765	my ($self) = @_;	2069	my ($self) = @_;
1766		2070
1767	&_freetls;	2071	&_freetls;
…		…
1772	my $fh = delete $self->{fh};	2076	my $fh = delete $self->{fh};
1773	my $wbuf = delete $self->{wbuf};	2077	my $wbuf = delete $self->{wbuf};
1774		2078
1775	my @linger;	2079	my @linger;
1776		2080
1777	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2081	push @linger, AE::io $fh, 1, sub {
1778	my $len = syswrite $fh, $wbuf, length $wbuf;	2082	my $len = syswrite $fh, $wbuf, length $wbuf;
1779		2083
1780	if ($len > 0) {	2084	if ($len > 0) {
1781	substr $wbuf, 0, $len, "";	2085	substr $wbuf, 0, $len, "";
1782	} else {	2086	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1783	@linger = (); # end	2087	@linger = (); # end
1784	}	2088	}
1785	});	2089	};
1786	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2090	push @linger, AE::timer $linger, 0, sub {
1787	@linger = ();	2091	@linger = ();
1788	});	2092	};
1789	}	2093	}
1790	}	2094	}
1791		2095
1792	=item $handle->destroy	2096	=item $handle->destroy
1793		2097
1794	Shuts down the handle object as much as possible - this call ensures that	2098	Shuts down the handle object as much as possible - this call ensures that
1795	no further callbacks will be invoked and as many resources as possible	2099	no further callbacks will be invoked and as many resources as possible
1796	will be freed. You must not call any methods on the object afterwards.	2100	will be freed. Any method you will call on the handle object after
		2101	destroying it in this way will be silently ignored (and it will return the
		2102	empty list).
1797		2103
1798	Normally, you can just "forget" any references to an AnyEvent::Handle	2104	Normally, you can just "forget" any references to an AnyEvent::Handle
1799	object and it will simply shut down. This works in fatal error and EOF	2105	object and it will simply shut down. This works in fatal error and EOF
1800	callbacks, as well as code outside. It does I<NOT> work in a read or write	2106	callbacks, as well as code outside. It does I<NOT> work in a read or write
1801	callback, so when you want to destroy the AnyEvent::Handle object from	2107	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1815	sub destroy {	2121	sub destroy {
1816	my ($self) = @_;	2122	my ($self) = @_;
1817		2123
1818	$self->DESTROY;	2124	$self->DESTROY;
1819	%$self = ();	2125	%$self = ();
		2126	bless $self, "AnyEvent::Handle::destroyed";
1820	}	2127	}
		2128
		2129	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2130	#nop
		2131	}
		2132
		2133	=item $handle->destroyed
		2134
		2135	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2136	->destroy >>, true otherwise.
		2137
		2138	Can be useful to decide whether the handle is still valid after some
		2139	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2140	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2141	can destroy the handle, so work can be avoided by checking sometimes:
		2142
		2143	$hdl->starttls ("accept");
		2144	return if $hdl->destroyed;
		2145	$hdl->push_write (...
		2146
		2147	Note that the call to C<push_write> will silently be ignored if the handle
		2148	has been destroyed, so often you can just ignore the possibility of the
		2149	handle being destroyed.
		2150
		2151	=cut
		2152
		2153	sub destroyed { 0 }
		2154	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1821		2155
1822	=item AnyEvent::Handle::TLS_CTX	2156	=item AnyEvent::Handle::TLS_CTX
1823		2157
1824	This function creates and returns the AnyEvent::TLS object used by default	2158	This function creates and returns the AnyEvent::TLS object used by default
1825	for TLS mode.	2159	for TLS mode.
…		…
1853		2187
1854	It is only safe to "forget" the reference inside EOF or error callbacks,	2188	It is only safe to "forget" the reference inside EOF or error callbacks,
1855	from within all other callbacks, you need to explicitly call the C<<	2189	from within all other callbacks, you need to explicitly call the C<<
1856	->destroy >> method.	2190	->destroy >> method.
1857		2191
		2192	=item Why is my C<on_eof> callback never called?
		2193
		2194	Probably because your C<on_error> callback is being called instead: When
		2195	you have outstanding requests in your read queue, then an EOF is
		2196	considered an error as you clearly expected some data.
		2197
		2198	To avoid this, make sure you have an empty read queue whenever your handle
		2199	is supposed to be "idle" (i.e. connection closes are O.K.). You cna set
		2200	an C<on_read> handler that simply pushes the first read requests in the
		2201	queue.
		2202
		2203	See also the next question, which explains this in a bit more detail.
		2204
		2205	=item How can I serve requests in a loop?
		2206
		2207	Most protocols consist of some setup phase (authentication for example)
		2208	followed by a request handling phase, where the server waits for requests
		2209	and handles them, in a loop.
		2210
		2211	There are two important variants: The first (traditional, better) variant
		2212	handles requests until the server gets some QUIT command, causing it to
		2213	close the connection first (highly desirable for a busy TCP server). A
		2214	client dropping the connection is an error, which means this variant can
		2215	detect an unexpected detection close.
		2216
		2217	To handle this case, always make sure you have a on-empty read queue, by
		2218	pushing the "read request start" handler on it:
		2219
		2220	# we assume a request starts with a single line
		2221	my @start_request; @start_request = (line => sub {
		2222	my ($hdl, $line) = @_;
		2223
		2224	... handle request
		2225
		2226	# push next request read, possibly from a nested callback
		2227	$hdl->push_read (@start_request);
		2228	});
		2229
		2230	# auth done, now go into request handling loop
		2231	# now push the first @start_request
		2232	$hdl->push_read (@start_request);
		2233
		2234	By always having an outstanding C<push_read>, the handle always expects
		2235	some data and raises the C<EPIPE> error when the connction is dropped
		2236	unexpectedly.
		2237
		2238	The second variant is a protocol where the client can drop the connection
		2239	at any time. For TCP, this means that the server machine may run out of
		2240	sockets easier, and in general, it means you cnanot distinguish a protocl
		2241	failure/client crash from a normal connection close. Nevertheless, these
		2242	kinds of protocols are common (and sometimes even the best solution to the
		2243	problem).
		2244
		2245	Having an outstanding read request at all times is possible if you ignore
		2246	C<EPIPE> errors, but this doesn't help with when the client drops the
		2247	connection during a request, which would still be an error.
		2248
		2249	A better solution is to push the initial request read in an C<on_read>
		2250	callback. This avoids an error, as when the server doesn't expect data
		2251	(i.e. is idly waiting for the next request, an EOF will not raise an
		2252	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2253	and simpler:
		2254
		2255	# auth done, now go into request handling loop
		2256	$hdl->on_read (sub {
		2257	my ($hdl) = @_;
		2258
		2259	# called each time we receive data but the read queue is empty
		2260	# simply start read the request
		2261
		2262	$hdl->push_read (line => sub {
		2263	my ($hdl, $line) = @_;
		2264
		2265	... handle request
		2266
		2267	# do nothing special when the request has been handled, just
		2268	# let the request queue go empty.
		2269	});
		2270	});
		2271
1858	=item I get different callback invocations in TLS mode/Why can't I pause	2272	=item I get different callback invocations in TLS mode/Why can't I pause
1859	reading?	2273	reading?
1860		2274
1861	Unlike, say, TCP, TLS connections do not consist of two independent	2275	Unlike, say, TCP, TLS connections do not consist of two independent
1862	communication channels, one for each direction. Or put differently. The	2276	communication channels, one for each direction. Or put differently, the
1863	read and write directions are not independent of each other: you cannot	2277	read and write directions are not independent of each other: you cannot
1864	write data unless you are also prepared to read, and vice versa.	2278	write data unless you are also prepared to read, and vice versa.
1865		2279
1866	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2280	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1867	callback invocations when you are not expecting any read data - the reason	2281	callback invocations when you are not expecting any read data - the reason
1868	is that AnyEvent::Handle always reads in TLS mode.	2282	is that AnyEvent::Handle always reads in TLS mode.
1869		2283
1870	During the connection, you have to make sure that you always have a	2284	During the connection, you have to make sure that you always have a
1871	non-empty read-queue, or an C<on_read> watcher. At the end of the	2285	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1885	my $data = delete $_[0]{rbuf};	2299	my $data = delete $_[0]{rbuf};
1886	});	2300	});
1887		2301
1888	The reason to use C<on_error> is that TCP connections, due to latencies	2302	The reason to use C<on_error> is that TCP connections, due to latencies
1889	and packets loss, might get closed quite violently with an error, when in	2303	and packets loss, might get closed quite violently with an error, when in
1890	fact, all data has been received.	2304	fact all data has been received.
1891		2305
1892	It is usually better to use acknowledgements when transferring data,	2306	It is usually better to use acknowledgements when transferring data,
1893	to make sure the other side hasn't just died and you got the data	2307	to make sure the other side hasn't just died and you got the data
1894	intact. This is also one reason why so many internet protocols have an	2308	intact. This is also one reason why so many internet protocols have an
1895	explicit QUIT command.	2309	explicit QUIT command.
…		…
1912	consider using C<< ->push_shutdown >> instead.	2326	consider using C<< ->push_shutdown >> instead.
1913		2327
1914	=item I want to contact a TLS/SSL server, I don't care about security.	2328	=item I want to contact a TLS/SSL server, I don't care about security.
1915		2329
1916	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	2330	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1917	simply connect to it and then create the AnyEvent::Handle with the C<tls>	2331	connect to it and then create the AnyEvent::Handle with the C<tls>
1918	parameter:	2332	parameter:
1919		2333
1920	tcp_connect $host, $port, sub {	2334	tcp_connect $host, $port, sub {
1921	my ($fh) = @_;	2335	my ($fh) = @_;
1922		2336
…		…
2022		2436
2023	=item * all members not documented here and not prefixed with an underscore	2437	=item * all members not documented here and not prefixed with an underscore
2024	are free to use in subclasses.	2438	are free to use in subclasses.
2025		2439
2026	Of course, new versions of AnyEvent::Handle may introduce more "public"	2440	Of course, new versions of AnyEvent::Handle may introduce more "public"
2027	member variables, but thats just life, at least it is documented.	2441	member variables, but that's just life. At least it is documented.
2028		2442
2029	=back	2443	=back
2030		2444
2031	=head1 AUTHOR	2445	=head1 AUTHOR
2032		2446

Diff Legend

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