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.143 by root, Mon Jul 6 21:02:34 2009 UTC vs.
Revision 1.210 by root, Thu Dec 30 01:53:15 2010 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.452;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
		16	warn "got error $msg\n";
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	},
34	);	19	};
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	warn "got line <$line>\n";
43	$cv->send;	28	$cv->send;
44	});	29	});
45		30
46	$cv->recv;	31	$cv->recv;
47		32
48	=head1 DESCRIPTION	33	=head1 DESCRIPTION
49		34
50	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
51	filehandles. For utility functions for doing non-blocking connects and accepts	36	stream-based filehandles (sockets, pipes, and other stream things).
52	on sockets see L<AnyEvent::Util>.
53		37
54	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
56		40
57	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
58	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
59	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
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
74	=item fh => $filehandle [MANDATORY]	92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		93
76	The filehandle this L<AnyEvent::Handle> object will operate on.	94	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	95	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	96	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	97	that mode.
81		98
		99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		100
		101	Try to connect to the specified host and service (port), using
		102	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		103	default C<peername>.
		104
		105	You have to specify either this parameter, or C<fh>, above.
		106
		107	It is possible to push requests on the read and write queues, and modify
		108	properties of the stream, even while AnyEvent::Handle is connecting.
		109
		110	When this parameter is specified, then the C<on_prepare>,
		111	C<on_connect_error> and C<on_connect> callbacks will be called under the
		112	appropriate circumstances:
		113
		114	=over 4
		115
		116	=item on_prepare => $cb->($handle)
		117
		118	This (rarely used) callback is called before a new connection is
		119	attempted, but after the file handle has been created (you can access that
		120	file handle via C<< $handle->{fh} >>). It could be used to prepare the
		121	file handle with parameters required for the actual connect (as opposed to
		122	settings that can be changed when the connection is already established).
		123
		124	The return value of this callback should be the connect timeout value in
		125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
		126	default timeout is to be used).
		127
		128	=item on_connect => $cb->($handle, $host, $port, $retry->())
		129
		130	This callback is called when a connection has been successfully established.
		131
		132	The peer's numeric host and port (the socket peername) are passed as
		133	parameters, together with a retry callback.
		134
		135	If, for some reason, the handle is not acceptable, calling C<$retry>
		136	will continue with the next connection target (in case of multi-homed
		137	hosts or SRV records there can be multiple connection endpoints). At the
		138	time it is called the read and write queues, eof status, tls status and
		139	similar properties of the handle will have been reset.
		140
		141	In most cases, you should ignore the C<$retry> parameter.
		142
		143	=item on_connect_error => $cb->($handle, $message)
		144
		145	This callback is called when the connection could not be
		146	established. C<$!> will contain the relevant error code, and C<$message> a
		147	message describing it (usually the same as C<"$!">).
		148
		149	If this callback isn't specified, then C<on_error> will be called with a
		150	fatal error instead.
		151
		152	=back
		153
		154	=item on_error => $cb->($handle, $fatal, $message)
		155
		156	This is the error callback, which is called when, well, some error
		157	occured, such as not being able to resolve the hostname, failure to
		158	connect, or a read error.
		159
		160	Some errors are fatal (which is indicated by C<$fatal> being true). On
		161	fatal errors the handle object will be destroyed (by a call to C<< ->
		162	destroy >>) after invoking the error callback (which means you are free to
		163	examine the handle object). Examples of fatal errors are an EOF condition
		164	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
		165	cases where the other side can close the connection at will, it is
		166	often easiest to not report C<EPIPE> errors in this callback.
		167
		168	AnyEvent::Handle tries to find an appropriate error code for you to check
		169	against, but in some cases (TLS errors), this does not work well. It is
		170	recommended to always output the C<$message> argument in human-readable
		171	error messages (it's usually the same as C<"$!">).
		172
		173	Non-fatal errors can be retried by returning, but it is recommended
		174	to simply ignore this parameter and instead abondon the handle object
		175	when this callback is invoked. Examples of non-fatal errors are timeouts
		176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		177
		178	On entry to the callback, the value of C<$!> contains the operating
		179	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		180	C<EPROTO>).
		181
		182	While not mandatory, it is I<highly> recommended to set this callback, as
		183	you will not be notified of errors otherwise. The default just calls
		184	C<croak>.
		185
		186	=item on_read => $cb->($handle)
		187
		188	This sets the default read callback, which is called when data arrives
		189	and no read request is in the queue (unlike read queue callbacks, this
		190	callback will only be called when at least one octet of data is in the
		191	read buffer).
		192
		193	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		194	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		195	must not enlarge or modify the read buffer, you can only remove data at
		196	the beginning from it.
		197
		198	You can also call C<< ->push_read (...) >> or any other function that
		199	modifies the read queue. Or do both. Or ...
		200
		201	When an EOF condition is detected, AnyEvent::Handle will first try to
		202	feed all the remaining data to the queued callbacks and C<on_read> before
		203	calling the C<on_eof> callback. If no progress can be made, then a fatal
		204	error will be raised (with C<$!> set to C<EPIPE>).
		205
		206	Note that, unlike requests in the read queue, an C<on_read> callback
		207	doesn't mean you I<require> some data: if there is an EOF and there
		208	are outstanding read requests then an error will be flagged. With an
		209	C<on_read> callback, the C<on_eof> callback will be invoked.
		210
82	=item on_eof => $cb->($handle)	211	=item on_eof => $cb->($handle)
83		212
84	Set the callback to be called when an end-of-file condition is detected,	213	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	214	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	215	connection cleanly, and there are no outstanding read requests in the
		216	queue (if there are read requests, then an EOF counts as an unexpected
		217	connection close and will be flagged as an error).
87		218
88	For sockets, this just means that the other side has stopped sending data,	219	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	220	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	221	callback and continue writing data, as only the read part has been shut
91	down.	222	down.
92		223
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	224	If an EOF condition has been detected but no C<on_eof> callback has been
98	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>.
99		226
100	=item on_error => $cb->($handle, $fatal, $message)
101
102	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.
105
106	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.
111
112	AnyEvent::Handle tries to find an appropriate error code for you to check
113	against, but in some cases (TLS errors), this does not work well. It is
114	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).
116
117	Non-fatal errors can be retried by simply returning, but it is recommended
118	to simply ignore this parameter and instead abondon the handle object
119	when this callback is invoked. Examples of non-fatal errors are timeouts
120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
121
122	On callback entrance, the value of C<$!> contains the operating system
123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
124	C<EPROTO>).
125
126	While not mandatory, it is I<highly> recommended to set this callback, as
127	you will not be notified of errors otherwise. The default simply calls
128	C<croak>.
129
130	=item on_read => $cb->($handle)
131
132	This sets the default read callback, which is called when data arrives
133	and no read request is in the queue (unlike read queue callbacks, this
134	callback will only be called when at least one octet of data is in the
135	read buffer).
136
137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
138	method or access the C<< $handle->{rbuf} >> member directly. Note that you
139	must not enlarge or modify the read buffer, you can only remove data at
140	the beginning from it.
141
142	When an EOF condition is detected then AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before
144	calling the C<on_eof> callback. If no progress can be made, then a fatal
145	error will be raised (with C<$!> set to C<EPIPE>).
146
147	=item on_drain => $cb->($handle)	227	=item on_drain => $cb->($handle)
148		228
149	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
150	(or when the callback is set and the buffer is empty already).	230	(or immediately if the buffer is empty already).
151		231
152	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.
153		233
154	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
155	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
…		…
157	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
158	the file when the write queue becomes empty.	238	the file when the write queue becomes empty.
159		239
160	=item timeout => $fractional_seconds	240	=item timeout => $fractional_seconds
161		241
		242	=item rtimeout => $fractional_seconds
		243
		244	=item wtimeout => $fractional_seconds
		245
162	If non-zero, then this enables an "inactivity" timeout: whenever this many	246	If non-zero, then these enables an "inactivity" timeout: whenever this
163	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
164	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
165	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).
166		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
167	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
168	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
169	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
170	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
171	restart the timeout.	262	restart the timeout.
172		263
173	Zero (the default) disables this timeout.	264	Zero (the default) disables this timeout.
174		265
…		…
188	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
189	(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
190	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
191	isn't finished).	282	isn't finished).
192		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
193	=item autocork => <boolean>	299	=item autocork => <boolean>
194		300
195	When disabled (the default), then C<push_write> will try to immediately	301	When disabled (the default), C<push_write> will try to immediately
196	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
197	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
198	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
199	disadvantage is usually avoided by your kernel's nagle algorithm, see	305	disadvantage is usually avoided by your kernel's nagle algorithm, see
200	C<no_delay>, but this option can save costly syscalls).	306	C<no_delay>, but this option can save costly syscalls).
201		307
202	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
203	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,
204	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
205	the write buffer often is full). It also increases write latency.	311	the write buffer often is full). It also increases write latency.
206		312
207	=item no_delay => <boolean>	313	=item no_delay => <boolean>
…		…
211	the Nagle algorithm, and usually it is beneficial.	317	the Nagle algorithm, and usually it is beneficial.
212		318
213	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
214	accomplishd by setting this option to a true value.	320	accomplishd by setting this option to a true value.
215		321
216	The default is your opertaing system's default behaviour (most likely	322	The default is your operating system's default behaviour (most likely
217	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.
218		356
219	=item read_size => <bytes>	357	=item read_size => <bytes>
220		358
221	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
222	try to read during each loop iteration, which affects memory	360	read during each loop iteration. Each handle object will consume at least
223	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.
224		370
225	=item low_water_mark => <bytes>	371	=item low_water_mark => <bytes>
226		372
227	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
228	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
229	considered empty.	375	considered empty.
230		376
231	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
232	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
233	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
234	is good in almost all cases.	380	is good in almost all cases.
235		381
236	=item linger => <seconds>	382	=item linger => <seconds>
237		383
238	If non-zero (default: C<3600>), then the destructor of the	384	If this is non-zero (default: C<3600>), the destructor of the
239	AnyEvent::Handle object will check whether there is still outstanding	385	AnyEvent::Handle object will check whether there is still outstanding
240	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
241	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
242	system treats outstanding data at socket close time).	388	system treats outstanding data at socket close time).
243		389
…		…
249		395
250	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
251	(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.
252		398
253	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
254	peername verification (see C<verify_peername> in L<AnyEvent::TLS>).	400	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		401	verification will be skipped when C<peername> is not specified or is
		402	C<undef>.
255		403
256	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	404	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
257		405
258	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
259	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
260	established and will transparently encrypt/decrypt data afterwards.	408	established and will transparently encrypt/decrypt data afterwards.
261		409
262	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
263	appropriate error message.	411	appropriate error message.
264		412
…		…
284	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	432	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
285	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
286	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
287	segmentation fault.	435	segmentation fault.
288		436
289	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.
290		438
291	=item tls_ctx => $anyevent_tls	439	=item tls_ctx => $anyevent_tls
292		440
293	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
294	(unless a connection object was specified directly). If this parameter is	442	(unless a connection object was specified directly). If this
295	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>.
296		445
297	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
298	=> 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
299	new TLS context object.	448	new TLS context object.
300		449
…		…
309		458
310	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
311	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>.
312		461
313	Without this callback, handshake failures lead to C<on_error> being	462	Without this callback, handshake failures lead to C<on_error> being
314	called, as normal.	463	called as usual.
315		464
316	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
317	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
318	then call C<< ->starttls >> again.	467	then call C<< ->starttls >> again.
319		468
320	=item on_stoptls => $cb->($handle)	469	=item on_stoptls => $cb->($handle)
321		470
…		…
347		496
348	sub new {	497	sub new {
349	my $class = shift;	498	my $class = shift;
350	my $self = bless { @_ }, $class;	499	my $self = bless { @_ }, $class;
351		500
352	$self->{fh} or Carp::croak "mandatory argument fh is missing";	501	if ($self->{fh}) {
		502	$self->_start;
		503	return unless $self->{fh}; # could be gone by now
		504
		505	} elsif ($self->{connect}) {
		506	require AnyEvent::Socket;
		507
		508	$self->{peername} = $self->{connect}[0]
		509	unless exists $self->{peername};
		510
		511	$self->{_skip_drain_rbuf} = 1;
		512
		513	{
		514	Scalar::Util::weaken (my $self = $self);
		515
		516	$self->{_connect} =
		517	AnyEvent::Socket::tcp_connect (
		518	$self->{connect}[0],
		519	$self->{connect}[1],
		520	sub {
		521	my ($fh, $host, $port, $retry) = @_;
		522
		523	delete $self->{_connect}; # no longer needed
		524
		525	if ($fh) {
		526	$self->{fh} = $fh;
		527
		528	delete $self->{_skip_drain_rbuf};
		529	$self->_start;
		530
		531	$self->{on_connect}
		532	and $self->{on_connect}($self, $host, $port, sub {
		533	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		534	$self->{_skip_drain_rbuf} = 1;
		535	&$retry;
		536	});
		537
		538	} else {
		539	if ($self->{on_connect_error}) {
		540	$self->{on_connect_error}($self, "$!");
		541	$self->destroy;
		542	} else {
		543	$self->_error ($!, 1);
		544	}
		545	}
		546	},
		547	sub {
		548	local $self->{fh} = $_[0];
		549
		550	$self->{on_prepare}
		551	? $self->{on_prepare}->($self)
		552	: ()
		553	}
		554	);
		555	}
		556
		557	} else {
		558	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		559	}
		560
		561	$self
		562	}
		563
		564	sub _start {
		565	my ($self) = @_;
		566
		567	# too many clueless people try to use udp and similar sockets
		568	# with AnyEvent::Handle, do them a favour.
		569	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		570	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		571	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
353		572
354	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	573	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
355		574
		575	$self->{_activity} =
		576	$self->{_ractivity} =
356	$self->{_activity} = AnyEvent->now;	577	$self->{_wactivity} = AE::now;
357	$self->_timeout;
358		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
359	$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};
360		589
		590	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		591
361	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	592	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
362	if $self->{tls};	593	if $self->{tls};
363		594
364	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	595	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
365		596
366	$self->start_read	597	$self->start_read
367	if $self->{on_read};	598	if $self->{on_read} || @{ $self->{_queue} };
368		599
369	$self->{fh} && $self	600	$self->_drain_wbuf;
370	}
371
372	sub _shutdown {
373	my ($self) = @_;
374
375	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
376	$self->{_eof} = 1; # tell starttls et. al to stop trying
377
378	&_freetls;
379	}	601	}
380		602
381	sub _error {	603	sub _error {
382	my ($self, $errno, $fatal, $message) = @_;	604	my ($self, $errno, $fatal, $message) = @_;
383		605
384	$self->_shutdown
385	if $fatal;
386
387	$! = $errno;	606	$! = $errno;
388	$message ||= "$!";	607	$message ||= "$!";
389		608
390	if ($self->{on_error}) {	609	if ($self->{on_error}) {
391	$self->{on_error}($self, $fatal, $message);	610	$self->{on_error}($self, $fatal, $message);
392	} elsif ($self->{fh}) {	611	$self->destroy if $fatal;
		612	} elsif ($self->{fh} || $self->{connect}) {
		613	$self->destroy;
393	Carp::croak "AnyEvent::Handle uncaught error: $message";	614	Carp::croak "AnyEvent::Handle uncaught error: $message";
394	}	615	}
395	}	616	}
396		617
397	=item $fh = $handle->fh	618	=item $fh = $handle->fh
…		…
422	$_[0]{on_eof} = $_[1];	643	$_[0]{on_eof} = $_[1];
423	}	644	}
424		645
425	=item $handle->on_timeout ($cb)	646	=item $handle->on_timeout ($cb)
426		647
427	Replace the current C<on_timeout> callback, or disables the callback (but	648	=item $handle->on_rtimeout ($cb)
428	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
429	argument and method.
430		649
431	=cut	650	=item $handle->on_wtimeout ($cb)
432		651
433	sub on_timeout {	652	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
434	$_[0]{on_timeout} = $_[1];	653	callback, or disables the callback (but not the timeout) if C<$cb> =
435	}	654	C<undef>. See the C<timeout> constructor argument and method.
		655
		656	=cut
		657
		658	# see below
436		659
437	=item $handle->autocork ($boolean)	660	=item $handle->autocork ($boolean)
438		661
439	Enables or disables the current autocork behaviour (see C<autocork>	662	Enables or disables the current autocork behaviour (see C<autocork>
440	constructor argument). Changes will only take effect on the next write.	663	constructor argument). Changes will only take effect on the next write.
…		…
453	=cut	676	=cut
454		677
455	sub no_delay {	678	sub no_delay {
456	$_[0]{no_delay} = $_[1];	679	$_[0]{no_delay} = $_[1];
457		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
458	eval {	695	eval {
459	local $SIG{__DIE__};	696	local $SIG{__DIE__};
460	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	697	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		698	if $_[0]{fh};
		699	};
		700	}
		701
		702	=item $handle->oobinline ($boolean)
		703
		704	Enables or disables the C<oobinline> setting (see constructor argument of
		705	the same name for details).
		706
		707	=cut
		708
		709	sub oobinline {
		710	$_[0]{oobinline} = $_[1];
		711
		712	eval {
		713	local $SIG{__DIE__};
		714	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		715	if $_[0]{fh};
		716	};
		717	}
		718
		719	=item $handle->keepalive ($boolean)
		720
		721	Enables or disables the C<keepalive> setting (see constructor argument of
		722	the same name for details).
		723
		724	=cut
		725
		726	sub keepalive {
		727	$_[0]{keepalive} = $_[1];
		728
		729	eval {
		730	local $SIG{__DIE__};
		731	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		732	if $_[0]{fh};
461	};	733	};
462	}	734	}
463		735
464	=item $handle->on_starttls ($cb)	736	=item $handle->on_starttls ($cb)
465		737
…		…
475		747
476	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).
477		749
478	=cut	750	=cut
479		751
480	sub on_starttls {	752	sub on_stoptls {
481	$_[0]{on_stoptls} = $_[1];	753	$_[0]{on_stoptls} = $_[1];
482	}	754	}
483		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
484	#############################################################################	774	#############################################################################
485		775
486	=item $handle->timeout ($seconds)	776	=item $handle->timeout ($seconds)
487		777
		778	=item $handle->rtimeout ($seconds)
		779
		780	=item $handle->wtimeout ($seconds)
		781
488	Configures (or disables) the inactivity timeout.	782	Configures (or disables) the inactivity timeout.
489		783
490	=cut	784	=item $handle->timeout_reset
491		785
492	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 {
493	my ($self, $timeout) = @_;	808	my ($self, $new_value) = @_;
494		809
		810	$new_value >= 0
		811	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		812
495	$self->{timeout} = $timeout;	813	$self->{$timeout} = $new_value;
496	$self->_timeout;	814	delete $self->{$tw}; &$cb;
497	}	815	};
498		816
		817	*{"${dir}timeout_reset"} = sub {
		818	$_[0]{$activity} = AE::now;
		819	};
		820
		821	# main workhorse:
499	# reset the timeout watcher, as neccessary	822	# reset the timeout watcher, as neccessary
500	# also check for time-outs	823	# also check for time-outs
501	sub _timeout {	824	$cb = sub {
502	my ($self) = @_;	825	my ($self) = @_;
503		826
504	if ($self->{timeout}) {	827	if ($self->{$timeout} && $self->{fh}) {
505	my $NOW = AnyEvent->now;	828	my $NOW = AE::now;
506		829
507	# when would the timeout trigger?	830	# when would the timeout trigger?
508	my $after = $self->{_activity} + $self->{timeout} - $NOW;	831	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
509		832
510	# now or in the past already?	833	# now or in the past already?
511	if ($after <= 0) {	834	if ($after <= 0) {
512	$self->{_activity} = $NOW;	835	$self->{$activity} = $NOW;
513		836
514	if ($self->{on_timeout}) {	837	if ($self->{$on_timeout}) {
515	$self->{on_timeout}($self);	838	$self->{$on_timeout}($self);
516	} else {	839	} else {
517	$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};
518	}	848	}
519		849
520	# callback could have changed timeout value, optimise	850	Scalar::Util::weaken $self;
521	return unless $self->{timeout};	851	return unless $self; # ->error could have destroyed $self
522		852
523	# calculate new after	853	$self->{$tw} ||= AE::timer $after, 0, sub {
524	$after = $self->{timeout};	854	delete $self->{$tw};
		855	$cb->($self);
		856	};
		857	} else {
		858	delete $self->{$tw};
525	}	859	}
526
527	Scalar::Util::weaken $self;
528	return unless $self; # ->error could have destroyed $self
529
530	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
531	delete $self->{_tw};
532	$self->_timeout;
533	});
534	} else {
535	delete $self->{_tw};
536	}	860	}
537	}	861	}
538		862
539	#############################################################################	863	#############################################################################
540		864
…		…
556	=item $handle->on_drain ($cb)	880	=item $handle->on_drain ($cb)
557		881
558	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
559	C<on_drain> in the constructor).	883	C<on_drain> in the constructor).
560		884
		885	This method may invoke callbacks (and therefore the handle might be
		886	destroyed after it returns).
		887
561	=cut	888	=cut
562		889
563	sub on_drain {	890	sub on_drain {
564	my ($self, $cb) = @_;	891	my ($self, $cb) = @_;
565		892
…		…
569	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});
570	}	897	}
571		898
572	=item $handle->push_write ($data)	899	=item $handle->push_write ($data)
573		900
574	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
575	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
576	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).
577		907
578	=cut	908	=cut
579		909
580	sub _drain_wbuf {	910	sub _drain_wbuf {
581	my ($self) = @_;	911	my ($self) = @_;
…		…
585	Scalar::Util::weaken $self;	915	Scalar::Util::weaken $self;
586		916
587	my $cb = sub {	917	my $cb = sub {
588	my $len = syswrite $self->{fh}, $self->{wbuf};	918	my $len = syswrite $self->{fh}, $self->{wbuf};
589		919
590	if ($len >= 0) {	920	if (defined $len) {
591	substr $self->{wbuf}, 0, $len, "";	921	substr $self->{wbuf}, 0, $len, "";
592		922
593	$self->{_activity} = AnyEvent->now;	923	$self->{_activity} = $self->{_wactivity} = AE::now;
594		924
595	$self->{on_drain}($self)	925	$self->{on_drain}($self)
596	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})
597	&& $self->{on_drain};	927	&& $self->{on_drain};
598		928
…		…
604		934
605	# try to write data immediately	935	# try to write data immediately
606	$cb->() unless $self->{autocork};	936	$cb->() unless $self->{autocork};
607		937
608	# if still data left in wbuf, we need to poll	938	# if still data left in wbuf, we need to poll
609	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	939	$self->{_ww} = AE::io $self->{fh}, 1, $cb
610	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	}
611	};	948	};
612	}	949	}
613		950
614	our %WH;	951	our %WH;
615		952
		953	# deprecated
616	sub register_write_type($$) {	954	sub register_write_type($$) {
617	$WH{$_[0]} = $_[1];	955	$WH{$_[0]} = $_[1];
618	}	956	}
619		957
620	sub push_write {	958	sub push_write {
621	my $self = shift;	959	my $self = shift;
622		960
623	if (@_ > 1) {	961	if (@_ > 1) {
624	my $type = shift;	962	my $type = shift;
625		963
		964	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
626	@_ = ($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")
627	->($self, @_);	966	->($self, @_);
628	}	967	}
629		968
		969	# we downgrade here to avoid hard-to-track-down bugs,
		970	# and diagnose the problem earlier and better.
		971
630	if ($self->{tls}) {	972	if ($self->{tls}) {
631	$self->{_tls_wbuf} .= $_[0];	973	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
632		974	&_dotls ($self) if $self->{fh};
633	&_dotls ($self);
634	} else {	975	} else {
635	$self->{wbuf} .= $_[0];	976	utf8::downgrade $self->{wbuf} .= $_[0];
636	$self->_drain_wbuf;	977	$self->_drain_wbuf if $self->{fh};
637	}	978	}
638	}	979	}
639		980
640	=item $handle->push_write (type => @args)	981	=item $handle->push_write (type => @args)
641		982
642	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
643	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).
644		988
645	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
646	drop by and tell us):	990	drop by and tell us):
647		991
648	=over 4	992	=over 4
…		…
705	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
706	this line into their JSON decoder of choice.	1050	this line into their JSON decoder of choice.
707		1051
708	=cut	1052	=cut
709		1053
		1054	sub json_coder() {
		1055	eval { require JSON::XS; JSON::XS->new->utf8 }
		1056	|| do { require JSON; JSON->new->utf8 }
		1057	}
		1058
710	register_write_type json => sub {	1059	register_write_type json => sub {
711	my ($self, $ref) = @_;	1060	my ($self, $ref) = @_;
712		1061
713	require JSON;	1062	my $json = $self->{json} ||= json_coder;
714		1063
715	$self->{json} ? $self->{json}->encode ($ref)	1064	$json->encode ($ref)
716	: JSON::encode_json ($ref)
717	};	1065	};
718		1066
719	=item storable => $reference	1067	=item storable => $reference
720		1068
721	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
…		…
747	the peer.	1095	the peer.
748		1096
749	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
750	afterwards. This is the cleanest way to close a connection.	1098	afterwards. This is the cleanest way to close a connection.
751		1099
		1100	This method may invoke callbacks (and therefore the handle might be
		1101	destroyed after it returns).
		1102
752	=cut	1103	=cut
753		1104
754	sub push_shutdown {	1105	sub push_shutdown {
755	my ($self) = @_;	1106	my ($self) = @_;
756		1107
757	delete $self->{low_water_mark};	1108	delete $self->{low_water_mark};
758	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1109	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
759	}	1110	}
760		1111
761	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1112	=item custom write types - Package::anyevent_write_type $handle, @args
762		1113
763	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
764	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
765	reference with the handle object and the remaining arguments.	1121	the handle object and the remaining arguments.
766		1122
767	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
768	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.
769		1126
770	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
771	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	}
772		1143
773	=cut	1144	=cut
774		1145
775	#############################################################################	1146	#############################################################################
776		1147
…		…
785	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
786	a queue.	1157	a queue.
787		1158
788	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
789	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
790	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
791	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
792	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>.
793		1165
794	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
795	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
796	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
797	done its job (see C<push_read>, below).	1169	done its job (see C<push_read>, below).
798		1170
799	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
800	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.
801		1173
…		…
858	=cut	1230	=cut
859		1231
860	sub _drain_rbuf {	1232	sub _drain_rbuf {
861	my ($self) = @_;	1233	my ($self) = @_;
862		1234
		1235	# avoid recursion
		1236	return if $self->{_skip_drain_rbuf};
863	local $self->{_in_drain} = 1;	1237	local $self->{_skip_drain_rbuf} = 1;
864
865	if (
866	defined $self->{rbuf_max}
867	&& $self->{rbuf_max} < length $self->{rbuf}
868	) {
869	$self->_error (&Errno::ENOSPC, 1), return;
870	}
871		1238
872	while () {	1239	while () {
873	# 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
874	# 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.
875	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1242	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1243	if exists $self->{_tls_rbuf};
876		1244
877	my $len = length $self->{rbuf};	1245	my $len = length $self->{rbuf};
878		1246
879	if (my $cb = shift @{ $self->{_queue} }) {	1247	if (my $cb = shift @{ $self->{_queue} }) {
880	unless ($cb->($self)) {	1248	unless ($cb->($self)) {
881	if ($self->{_eof}) {	1249	# no progress can be made
882	# no progress can be made (not enough data and no data forthcoming)	1250	# (not enough data and no data forthcoming)
883	$self->_error (&Errno::EPIPE, 1), return;	1251	$self->_error (Errno::EPIPE, 1), return
884	}	1252	if $self->{_eof};
885		1253
886	unshift @{ $self->{_queue} }, $cb;	1254	unshift @{ $self->{_queue} }, $cb;
887	last;	1255	last;
888	}	1256	}
889	} elsif ($self->{on_read}) {	1257	} elsif ($self->{on_read}) {
…		…
896	&& !@{ $self->{_queue} } # and the queue is still empty	1264	&& !@{ $self->{_queue} } # and the queue is still empty
897	&& $self->{on_read} # but we still have on_read	1265	&& $self->{on_read} # but we still have on_read
898	) {	1266	) {
899	# no further data will arrive	1267	# no further data will arrive
900	# so no progress can be made	1268	# so no progress can be made
901	$self->_error (&Errno::EPIPE, 1), return	1269	$self->_error (Errno::EPIPE, 1), return
902	if $self->{_eof};	1270	if $self->{_eof};
903		1271
904	last; # more data might arrive	1272	last; # more data might arrive
905	}	1273	}
906	} else {	1274	} else {
…		…
909	last;	1277	last;
910	}	1278	}
911	}	1279	}
912		1280
913	if ($self->{_eof}) {	1281	if ($self->{_eof}) {
914	if ($self->{on_eof}) {	1282	$self->{on_eof}
915	$self->{on_eof}($self)	1283	? $self->{on_eof}($self)
916	} else {
917	$self->_error (0, 1, "Unexpected end-of-file");	1284	: $self->_error (0, 1, "Unexpected end-of-file");
918	}	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;
919	}	1294	}
920		1295
921	# may need to restart read watcher	1296	# may need to restart read watcher
922	unless ($self->{_rw}) {	1297	unless ($self->{_rw}) {
923	$self->start_read	1298	$self->start_read
…		…
929		1304
930	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
931	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
932	constructor.	1307	constructor.
933		1308
		1309	This method may invoke callbacks (and therefore the handle might be
		1310	destroyed after it returns).
		1311
934	=cut	1312	=cut
935		1313
936	sub on_read {	1314	sub on_read {
937	my ($self, $cb) = @_;	1315	my ($self, $cb) = @_;
938		1316
939	$self->{on_read} = $cb;	1317	$self->{on_read} = $cb;
940	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1318	$self->_drain_rbuf if $cb;
941	}	1319	}
942		1320
943	=item $handle->rbuf	1321	=item $handle->rbuf
944		1322
945	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).
946		1326
947	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)
948	member, if you want. However, the only operation allowed on the	1328	is removing data from its beginning. Otherwise modifying or appending to
949	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.
950	beginning. Otherwise modifying or appending to it is not allowed and will
951	lead to hard-to-track-down bugs.
952		1330
953	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>
954	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
955	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.
956		1335
957	=cut	1336	=cut
958		1337
959	sub rbuf : lvalue {	1338	sub rbuf : lvalue {
960	$_[0]{rbuf}	1339	$_[0]{rbuf}
…		…
977		1356
978	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
979	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
980	true, it will be removed from the queue.	1359	true, it will be removed from the queue.
981		1360
		1361	These methods may invoke callbacks (and therefore the handle might be
		1362	destroyed after it returns).
		1363
982	=cut	1364	=cut
983		1365
984	our %RH;	1366	our %RH;
985		1367
986	sub register_read_type($$) {	1368	sub register_read_type($$) {
…		…
992	my $cb = pop;	1374	my $cb = pop;
993		1375
994	if (@_) {	1376	if (@_) {
995	my $type = shift;	1377	my $type = shift;
996		1378
		1379	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
997	$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")
998	->($self, $cb, @_);	1381	->($self, $cb, @_);
999	}	1382	}
1000		1383
1001	push @{ $self->{_queue} }, $cb;	1384	push @{ $self->{_queue} }, $cb;
1002	$self->_drain_rbuf unless $self->{_in_drain};	1385	$self->_drain_rbuf;
1003	}	1386	}
1004		1387
1005	sub unshift_read {	1388	sub unshift_read {
1006	my $self = shift;	1389	my $self = shift;
1007	my $cb = pop;	1390	my $cb = pop;
1008		1391
1009	if (@_) {	1392	if (@_) {
1010	my $type = shift;	1393	my $type = shift;
1011		1394
		1395	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1012	$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")
1013	->($self, $cb, @_);	1397	->($self, $cb, @_);
1014	}	1398	}
1015		1399
1016
1017	unshift @{ $self->{_queue} }, $cb;	1400	unshift @{ $self->{_queue} }, $cb;
1018	$self->_drain_rbuf unless $self->{_in_drain};	1401	$self->_drain_rbuf;
1019	}	1402	}
1020		1403
1021	=item $handle->push_read (type => @args, $cb)	1404	=item $handle->push_read (type => @args, $cb)
1022		1405
1023	=item $handle->unshift_read (type => @args, $cb)	1406	=item $handle->unshift_read (type => @args, $cb)
1024		1407
1025	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
1026	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
1027	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).
1028		1413
1029	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
1030	drop by and tell us):	1415	drop by and tell us):
1031		1416
1032	=over 4	1417	=over 4
…		…
1124	the receive buffer when neither C<$accept> nor C<$reject> match,	1509	the receive buffer when neither C<$accept> nor C<$reject> match,
1125	and everything preceding and including the match will be accepted	1510	and everything preceding and including the match will be accepted
1126	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
1127	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
1128	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
1129	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.
1130		1515
1131	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
1132	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
1133	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
1134	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
1135	required for the accept regex.	1520	required for the accept regex.
1136		1521
1137	$handle->push_read (regex =>	1522	$handle->push_read (regex =>
…		…
1156	return 1;	1541	return 1;
1157	}	1542	}
1158		1543
1159	# reject	1544	# reject
1160	if ($reject && $$rbuf =~ $reject) {	1545	if ($reject && $$rbuf =~ $reject) {
1161	$self->_error (&Errno::EBADMSG);	1546	$self->_error (Errno::EBADMSG);
1162	}	1547	}
1163		1548
1164	# skip	1549	# skip
1165	if ($skip && $$rbuf =~ $skip) {	1550	if ($skip && $$rbuf =~ $skip) {
1166	$data .= substr $$rbuf, 0, $+[0], "";	1551	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1182	my ($self, $cb) = @_;	1567	my ($self, $cb) = @_;
1183		1568
1184	sub {	1569	sub {
1185	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1570	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1186	if ($_[0]{rbuf} =~ /[^0-9]/) {	1571	if ($_[0]{rbuf} =~ /[^0-9]/) {
1187	$self->_error (&Errno::EBADMSG);	1572	$self->_error (Errno::EBADMSG);
1188	}	1573	}
1189	return;	1574	return;
1190	}	1575	}
1191		1576
1192	my $len = $1;	1577	my $len = $1;
…		…
1195	my $string = $_[1];	1580	my $string = $_[1];
1196	$_[0]->unshift_read (chunk => 1, sub {	1581	$_[0]->unshift_read (chunk => 1, sub {
1197	if ($_[1] eq ",") {	1582	if ($_[1] eq ",") {
1198	$cb->($_[0], $string);	1583	$cb->($_[0], $string);
1199	} else {	1584	} else {
1200	$self->_error (&Errno::EBADMSG);	1585	$self->_error (Errno::EBADMSG);
1201	}	1586	}
1202	});	1587	});
1203	});	1588	});
1204		1589
1205	1	1590	1
…		…
1272	=cut	1657	=cut
1273		1658
1274	register_read_type json => sub {	1659	register_read_type json => sub {
1275	my ($self, $cb) = @_;	1660	my ($self, $cb) = @_;
1276		1661
1277	my $json = $self->{json} ||=	1662	my $json = $self->{json} ||= json_coder;
1278	eval { require JSON::XS; JSON::XS->new->utf8 }
1279	|| do { require JSON; JSON->new->utf8 };
1280		1663
1281	my $data;	1664	my $data;
1282	my $rbuf = \$self->{rbuf};	1665	my $rbuf = \$self->{rbuf};
1283		1666
1284	sub {	1667	sub {
…		…
1295	$json->incr_skip;	1678	$json->incr_skip;
1296		1679
1297	$self->{rbuf} = $json->incr_text;	1680	$self->{rbuf} = $json->incr_text;
1298	$json->incr_text = "";	1681	$json->incr_text = "";
1299		1682
1300	$self->_error (&Errno::EBADMSG);	1683	$self->_error (Errno::EBADMSG);
1301		1684
1302	()	1685	()
1303	} else {	1686	} else {
1304	$self->{rbuf} = "";	1687	$self->{rbuf} = "";
1305		1688
…		…
1342	# read remaining chunk	1725	# read remaining chunk
1343	$_[0]->unshift_read (chunk => $len, sub {	1726	$_[0]->unshift_read (chunk => $len, sub {
1344	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1727	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1345	$cb->($_[0], $ref);	1728	$cb->($_[0], $ref);
1346	} else {	1729	} else {
1347	$self->_error (&Errno::EBADMSG);	1730	$self->_error (Errno::EBADMSG);
1348	}	1731	}
1349	});	1732	});
1350	}	1733	}
1351		1734
1352	1	1735	1
1353	}	1736	}
1354	};	1737	};
1355		1738
1356	=back	1739	=back
1357		1740
1358	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1741	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1359		1742
1360	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).
1361		1748
1362	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
1363	reference with the handle object, the callback and the remaining	1750	handle object, the original callback and the remaining arguments.
1364	arguments.
1365		1751
1366	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
1367	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.
1368		1756
1369	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
1370	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).
1371		1760
1372	Note that this is a function, and all types registered this way will be
1373	global, so try to use unique names.
1374
1375	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
1376	search for C<register_read_type>)).	1762	AnyEvent::Handle>, search for C<register_read_type>)).
1377		1763
1378	=item $handle->stop_read	1764	=item $handle->stop_read
1379		1765
1380	=item $handle->start_read	1766	=item $handle->start_read
1381		1767
…		…
1401	}	1787	}
1402		1788
1403	sub start_read {	1789	sub start_read {
1404	my ($self) = @_;	1790	my ($self) = @_;
1405		1791
1406	unless ($self->{_rw} || $self->{_eof}) {	1792	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1407	Scalar::Util::weaken $self;	1793	Scalar::Util::weaken $self;
1408		1794
1409	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1795	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1410	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1796	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1411	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1797	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1412		1798
1413	if ($len > 0) {	1799	if ($len > 0) {
1414	$self->{_activity} = AnyEvent->now;	1800	$self->{_activity} = $self->{_ractivity} = AE::now;
1415		1801
1416	if ($self->{tls}) {	1802	if ($self->{tls}) {
1417	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1803	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1418		1804
1419	&_dotls ($self);	1805	&_dotls ($self);
1420	} else {	1806	} else {
1421	$self->_drain_rbuf unless $self->{_in_drain};	1807	$self->_drain_rbuf;
		1808	}
		1809
		1810	if ($len == $self->{read_size}) {
		1811	$self->{read_size} *= 2;
		1812	$self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
		1813	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1422	}	1814	}
1423		1815
1424	} elsif (defined $len) {	1816	} elsif (defined $len) {
1425	delete $self->{_rw};	1817	delete $self->{_rw};
1426	$self->{_eof} = 1;	1818	$self->{_eof} = 1;
1427	$self->_drain_rbuf unless $self->{_in_drain};	1819	$self->_drain_rbuf;
1428		1820
1429	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1821	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1430	return $self->_error ($!, 1);	1822	return $self->_error ($!, 1);
1431	}	1823	}
1432	});	1824	};
1433	}	1825	}
1434	}	1826	}
1435		1827
1436	our $ERROR_SYSCALL;	1828	our $ERROR_SYSCALL;
1437	our $ERROR_WANT_READ;	1829	our $ERROR_WANT_READ;
…		…
1450	if ($self->{_on_starttls}) {	1842	if ($self->{_on_starttls}) {
1451	(delete $self->{_on_starttls})->($self, undef, $err);	1843	(delete $self->{_on_starttls})->($self, undef, $err);
1452	&_freetls;	1844	&_freetls;
1453	} else {	1845	} else {
1454	&_freetls;	1846	&_freetls;
1455	$self->_error (&Errno::EPROTO, 1, $err);	1847	$self->_error (Errno::EPROTO, 1, $err);
1456	}	1848	}
1457	}	1849	}
1458		1850
1459	# poll the write BIO and send the data if applicable	1851	# poll the write BIO and send the data if applicable
1460	# also decode read data if possible	1852	# also decode read data if possible
…		…
1492	$self->{_eof} = 1;	1884	$self->{_eof} = 1;
1493	}	1885	}
1494	}	1886	}
1495		1887
1496	$self->{_tls_rbuf} .= $tmp;	1888	$self->{_tls_rbuf} .= $tmp;
1497	$self->_drain_rbuf unless $self->{_in_drain};	1889	$self->_drain_rbuf;
1498	$self->{tls} or return; # tls session might have gone away in callback	1890	$self->{tls} or return; # tls session might have gone away in callback
1499	}	1891	}
1500		1892
1501	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1893	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1502	return $self->_tls_error ($tmp)	1894	return $self->_tls_error ($tmp)
…		…
1504	&& ($tmp != $ERROR_SYSCALL || $!);	1896	&& ($tmp != $ERROR_SYSCALL || $!);
1505		1897
1506	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1898	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1507	$self->{wbuf} .= $tmp;	1899	$self->{wbuf} .= $tmp;
1508	$self->_drain_wbuf;	1900	$self->_drain_wbuf;
		1901	$self->{tls} or return; # tls session might have gone away in callback
1509	}	1902	}
1510		1903
1511	$self->{_on_starttls}	1904	$self->{_on_starttls}
1512	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1905	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1513	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1906	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1516	=item $handle->starttls ($tls[, $tls_ctx])	1909	=item $handle->starttls ($tls[, $tls_ctx])
1517		1910
1518	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1911	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1519	object is created, you can also do that at a later time by calling	1912	object is created, you can also do that at a later time by calling
1520	C<starttls>.	1913	C<starttls>.
		1914
		1915	Starting TLS is currently an asynchronous operation - when you push some
		1916	write data and then call C<< ->starttls >> then TLS negotiation will start
		1917	immediately, after which the queued write data is then sent.
1521		1918
1522	The first argument is the same as the C<tls> constructor argument (either	1919	The first argument is the same as the C<tls> constructor argument (either
1523	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1920	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1524		1921
1525	The second argument is the optional C<AnyEvent::TLS> object that is used	1922	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1530	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1927	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1531	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1928	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1532	changed to your liking. Note that the handshake might have already started	1929	changed to your liking. Note that the handshake might have already started
1533	when this function returns.	1930	when this function returns.
1534		1931
1535	If it an error to start a TLS handshake more than once per	1932	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1536	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1933	handshakes on the same stream. It is best to not attempt to use the
		1934	stream after stopping TLS.
		1935
		1936	This method may invoke callbacks (and therefore the handle might be
		1937	destroyed after it returns).
1537		1938
1538	=cut	1939	=cut
1539		1940
1540	our %TLS_CACHE; #TODO not yet documented, should we?	1941	our %TLS_CACHE; #TODO not yet documented, should we?
1541		1942
1542	sub starttls {	1943	sub starttls {
1543	my ($self, $ssl, $ctx) = @_;	1944	my ($self, $tls, $ctx) = @_;
		1945
		1946	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1947	if $self->{tls};
		1948
		1949	$self->{tls} = $tls;
		1950	$self->{tls_ctx} = $ctx if @_ > 2;
		1951
		1952	return unless $self->{fh};
1544		1953
1545	require Net::SSLeay;	1954	require Net::SSLeay;
1546
1547	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1548	if $self->{tls};
1549		1955
1550	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1956	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1551	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1957	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1552		1958
		1959	$tls = delete $self->{tls};
1553	$ctx ||= $self->{tls_ctx};	1960	$ctx = $self->{tls_ctx};
		1961
		1962	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1554		1963
1555	if ("HASH" eq ref $ctx) {	1964	if ("HASH" eq ref $ctx) {
1556	require AnyEvent::TLS;	1965	require AnyEvent::TLS;
1557
1558	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1559		1966
1560	if ($ctx->{cache}) {	1967	if ($ctx->{cache}) {
1561	my $key = $ctx+0;	1968	my $key = $ctx+0;
1562	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;	1969	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1563	} else {	1970	} else {
1564	$ctx = new AnyEvent::TLS %$ctx;	1971	$ctx = new AnyEvent::TLS %$ctx;
1565	}	1972	}
1566	}	1973	}
1567		1974
1568	$self->{tls_ctx} = $ctx || TLS_CTX ();	1975	$self->{tls_ctx} = $ctx || TLS_CTX ();
1569	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1976	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1570		1977
1571	# basically, this is deep magic (because SSL_read should have the same issues)	1978	# basically, this is deep magic (because SSL_read should have the same issues)
1572	# but the openssl maintainers basically said: "trust us, it just works".	1979	# but the openssl maintainers basically said: "trust us, it just works".
1573	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1980	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1574	# and mismaintained ssleay-module doesn't even offer them).	1981	# and mismaintained ssleay-module doesn't even offer them).
…		…
1581	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1988	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1582	# have identity issues in that area.	1989	# have identity issues in that area.
1583	# Net::SSLeay::CTX_set_mode ($ssl,	1990	# Net::SSLeay::CTX_set_mode ($ssl,
1584	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1991	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1585	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1992	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1586	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	1993	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1587		1994
1588	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1995	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1589	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1996	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1590		1997
		1998	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1999
1591	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	2000	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1592		2001
1593	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2002	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1594	if $self->{on_starttls};	2003	if $self->{on_starttls};
1595		2004
1596	&_dotls; # need to trigger the initial handshake	2005	&_dotls; # need to trigger the initial handshake
…		…
1599		2008
1600	=item $handle->stoptls	2009	=item $handle->stoptls
1601		2010
1602	Shuts down the SSL connection - this makes a proper EOF handshake by	2011	Shuts down the SSL connection - this makes a proper EOF handshake by
1603	sending a close notify to the other side, but since OpenSSL doesn't	2012	sending a close notify to the other side, but since OpenSSL doesn't
1604	support non-blocking shut downs, it is not possible to re-use the stream	2013	support non-blocking shut downs, it is not guaranteed that you can re-use
1605	afterwards.	2014	the stream afterwards.
		2015
		2016	This method may invoke callbacks (and therefore the handle might be
		2017	destroyed after it returns).
1606		2018
1607	=cut	2019	=cut
1608		2020
1609	sub stoptls {	2021	sub stoptls {
1610	my ($self) = @_;	2022	my ($self) = @_;
1611		2023
1612	if ($self->{tls}) {	2024	if ($self->{tls} && $self->{fh}) {
1613	Net::SSLeay::shutdown ($self->{tls});	2025	Net::SSLeay::shutdown ($self->{tls});
1614		2026
1615	&_dotls;	2027	&_dotls;
1616		2028
1617	# # we don't give a shit. no, we do, but we can't. no...#d#	2029	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1623	sub _freetls {	2035	sub _freetls {
1624	my ($self) = @_;	2036	my ($self) = @_;
1625		2037
1626	return unless $self->{tls};	2038	return unless $self->{tls};
1627		2039
1628	$self->{tls_ctx}->_put_session (delete $self->{tls});	2040	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2041	if $self->{tls} > 0;
1629		2042
1630	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2043	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1631	}	2044	}
1632		2045
1633	sub DESTROY {	2046	sub DESTROY {
…		…
1635		2048
1636	&_freetls;	2049	&_freetls;
1637		2050
1638	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	2051	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1639		2052
1640	if ($linger && length $self->{wbuf}) {	2053	if ($linger && length $self->{wbuf} && $self->{fh}) {
1641	my $fh = delete $self->{fh};	2054	my $fh = delete $self->{fh};
1642	my $wbuf = delete $self->{wbuf};	2055	my $wbuf = delete $self->{wbuf};
1643		2056
1644	my @linger;	2057	my @linger;
1645		2058
1646	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2059	push @linger, AE::io $fh, 1, sub {
1647	my $len = syswrite $fh, $wbuf, length $wbuf;	2060	my $len = syswrite $fh, $wbuf, length $wbuf;
1648		2061
1649	if ($len > 0) {	2062	if ($len > 0) {
1650	substr $wbuf, 0, $len, "";	2063	substr $wbuf, 0, $len, "";
1651	} else {	2064	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1652	@linger = (); # end	2065	@linger = (); # end
1653	}	2066	}
1654	});	2067	};
1655	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2068	push @linger, AE::timer $linger, 0, sub {
1656	@linger = ();	2069	@linger = ();
1657	});	2070	};
1658	}	2071	}
1659	}	2072	}
1660		2073
1661	=item $handle->destroy	2074	=item $handle->destroy
1662		2075
1663	Shuts down the handle object as much as possible - this call ensures that	2076	Shuts down the handle object as much as possible - this call ensures that
1664	no further callbacks will be invoked and as many resources as possible	2077	no further callbacks will be invoked and as many resources as possible
1665	will be freed. You must not call any methods on the object afterwards.	2078	will be freed. Any method you will call on the handle object after
		2079	destroying it in this way will be silently ignored (and it will return the
		2080	empty list).
1666		2081
1667	Normally, you can just "forget" any references to an AnyEvent::Handle	2082	Normally, you can just "forget" any references to an AnyEvent::Handle
1668	object and it will simply shut down. This works in fatal error and EOF	2083	object and it will simply shut down. This works in fatal error and EOF
1669	callbacks, as well as code outside. It does I<NOT> work in a read or write	2084	callbacks, as well as code outside. It does I<NOT> work in a read or write
1670	callback, so when you want to destroy the AnyEvent::Handle object from	2085	callback, so when you want to destroy the AnyEvent::Handle object from
1671	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	2086	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1672	that case.	2087	that case.
1673		2088
		2089	Destroying the handle object in this way has the advantage that callbacks
		2090	will be removed as well, so if those are the only reference holders (as
		2091	is common), then one doesn't need to do anything special to break any
		2092	reference cycles.
		2093
1674	The handle might still linger in the background and write out remaining	2094	The handle might still linger in the background and write out remaining
1675	data, as specified by the C<linger> option, however.	2095	data, as specified by the C<linger> option, however.
1676		2096
1677	=cut	2097	=cut
1678		2098
1679	sub destroy {	2099	sub destroy {
1680	my ($self) = @_;	2100	my ($self) = @_;
1681		2101
1682	$self->DESTROY;	2102	$self->DESTROY;
1683	%$self = ();	2103	%$self = ();
		2104	bless $self, "AnyEvent::Handle::destroyed";
1684	}	2105	}
		2106
		2107	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2108	#nop
		2109	}
		2110
		2111	=item $handle->destroyed
		2112
		2113	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2114	->destroy >>, true otherwise.
		2115
		2116	Can be useful to decide whether the handle is still valid after some
		2117	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2118	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2119	can destroy the handle, so work can be avoided by checking sometimes:
		2120
		2121	$hdl->starttls ("accept");
		2122	return if $hdl->destroyed;
		2123	$hdl->push_write (...
		2124
		2125	Note that the call to C<push_write> will silently be ignored if the handle
		2126	has been destroyed, so often you can just ignore the possibility of the
		2127	handle being destroyed.
		2128
		2129	=cut
		2130
		2131	sub destroyed { 0 }
		2132	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1685		2133
1686	=item AnyEvent::Handle::TLS_CTX	2134	=item AnyEvent::Handle::TLS_CTX
1687		2135
1688	This function creates and returns the AnyEvent::TLS object used by default	2136	This function creates and returns the AnyEvent::TLS object used by default
1689	for TLS mode.	2137	for TLS mode.
…		…
1717		2165
1718	It is only safe to "forget" the reference inside EOF or error callbacks,	2166	It is only safe to "forget" the reference inside EOF or error callbacks,
1719	from within all other callbacks, you need to explicitly call the C<<	2167	from within all other callbacks, you need to explicitly call the C<<
1720	->destroy >> method.	2168	->destroy >> method.
1721		2169
		2170	=item Why is my C<on_eof> callback never called?
		2171
		2172	Probably because your C<on_error> callback is being called instead: When
		2173	you have outstanding requests in your read queue, then an EOF is
		2174	considered an error as you clearly expected some data.
		2175
		2176	To avoid this, make sure you have an empty read queue whenever your handle
		2177	is supposed to be "idle" (i.e. connection closes are O.K.). You cna set
		2178	an C<on_read> handler that simply pushes the first read requests in the
		2179	queue.
		2180
		2181	See also the next question, which explains this in a bit more detail.
		2182
		2183	=item How can I serve requests in a loop?
		2184
		2185	Most protocols consist of some setup phase (authentication for example)
		2186	followed by a request handling phase, where the server waits for requests
		2187	and handles them, in a loop.
		2188
		2189	There are two important variants: The first (traditional, better) variant
		2190	handles requests until the server gets some QUIT command, causing it to
		2191	close the connection first (highly desirable for a busy TCP server). A
		2192	client dropping the connection is an error, which means this variant can
		2193	detect an unexpected detection close.
		2194
		2195	To handle this case, always make sure you have a on-empty read queue, by
		2196	pushing the "read request start" handler on it:
		2197
		2198	# we assume a request starts with a single line
		2199	my @start_request; @start_request = (line => sub {
		2200	my ($hdl, $line) = @_;
		2201
		2202	... handle request
		2203
		2204	# push next request read, possibly from a nested callback
		2205	$hdl->push_read (@start_request);
		2206	});
		2207
		2208	# auth done, now go into request handling loop
		2209	# now push the first @start_request
		2210	$hdl->push_read (@start_request);
		2211
		2212	By always having an outstanding C<push_read>, the handle always expects
		2213	some data and raises the C<EPIPE> error when the connction is dropped
		2214	unexpectedly.
		2215
		2216	The second variant is a protocol where the client can drop the connection
		2217	at any time. For TCP, this means that the server machine may run out of
		2218	sockets easier, and in general, it means you cnanot distinguish a protocl
		2219	failure/client crash from a normal connection close. Nevertheless, these
		2220	kinds of protocols are common (and sometimes even the best solution to the
		2221	problem).
		2222
		2223	Having an outstanding read request at all times is possible if you ignore
		2224	C<EPIPE> errors, but this doesn't help with when the client drops the
		2225	connection during a request, which would still be an error.
		2226
		2227	A better solution is to push the initial request read in an C<on_read>
		2228	callback. This avoids an error, as when the server doesn't expect data
		2229	(i.e. is idly waiting for the next request, an EOF will not raise an
		2230	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2231	and simpler:
		2232
		2233	# auth done, now go into request handling loop
		2234	$hdl->on_read (sub {
		2235	my ($hdl) = @_;
		2236
		2237	# called each time we receive data but the read queue is empty
		2238	# simply start read the request
		2239
		2240	$hdl->push_read (line => sub {
		2241	my ($hdl, $line) = @_;
		2242
		2243	... handle request
		2244
		2245	# do nothing special when the request has been handled, just
		2246	# let the request queue go empty.
		2247	});
		2248	});
		2249
1722	=item I get different callback invocations in TLS mode/Why can't I pause	2250	=item I get different callback invocations in TLS mode/Why can't I pause
1723	reading?	2251	reading?
1724		2252
1725	Unlike, say, TCP, TLS connections do not consist of two independent	2253	Unlike, say, TCP, TLS connections do not consist of two independent
1726	communication channels, one for each direction. Or put differently. The	2254	communication channels, one for each direction. Or put differently, the
1727	read and write directions are not independent of each other: you cannot	2255	read and write directions are not independent of each other: you cannot
1728	write data unless you are also prepared to read, and vice versa.	2256	write data unless you are also prepared to read, and vice versa.
1729		2257
1730	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2258	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1731	callback invocations when you are not expecting any read data - the reason	2259	callback invocations when you are not expecting any read data - the reason
1732	is that AnyEvent::Handle always reads in TLS mode.	2260	is that AnyEvent::Handle always reads in TLS mode.
1733		2261
1734	During the connection, you have to make sure that you always have a	2262	During the connection, you have to make sure that you always have a
1735	non-empty read-queue, or an C<on_read> watcher. At the end of the	2263	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1745		2273
1746	$handle->on_read (sub { });	2274	$handle->on_read (sub { });
1747	$handle->on_eof (undef);	2275	$handle->on_eof (undef);
1748	$handle->on_error (sub {	2276	$handle->on_error (sub {
1749	my $data = delete $_[0]{rbuf};	2277	my $data = delete $_[0]{rbuf};
1750	undef $handle;
1751	});	2278	});
1752		2279
1753	The reason to use C<on_error> is that TCP connections, due to latencies	2280	The reason to use C<on_error> is that TCP connections, due to latencies
1754	and packets loss, might get closed quite violently with an error, when in	2281	and packets loss, might get closed quite violently with an error, when in
1755	fact, all data has been received.	2282	fact all data has been received.
1756		2283
1757	It is usually better to use acknowledgements when transferring data,	2284	It is usually better to use acknowledgements when transferring data,
1758	to make sure the other side hasn't just died and you got the data	2285	to make sure the other side hasn't just died and you got the data
1759	intact. This is also one reason why so many internet protocols have an	2286	intact. This is also one reason why so many internet protocols have an
1760	explicit QUIT command.	2287	explicit QUIT command.
…		…
1777	consider using C<< ->push_shutdown >> instead.	2304	consider using C<< ->push_shutdown >> instead.
1778		2305
1779	=item I want to contact a TLS/SSL server, I don't care about security.	2306	=item I want to contact a TLS/SSL server, I don't care about security.
1780		2307
1781	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	2308	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1782	simply connect to it and then create the AnyEvent::Handle with the C<tls>	2309	connect to it and then create the AnyEvent::Handle with the C<tls>
1783	parameter:	2310	parameter:
1784		2311
		2312	tcp_connect $host, $port, sub {
		2313	my ($fh) = @_;
		2314
1785	my $handle = new AnyEvent::Handle	2315	my $handle = new AnyEvent::Handle
1786	fh => $fh,	2316	fh => $fh,
1787	tls => "connect",	2317	tls => "connect",
1788	on_error => sub { ... };	2318	on_error => sub { ... };
1789		2319
1790	$handle->push_write (...);	2320	$handle->push_write (...);
		2321	};
1791		2322
1792	=item I want to contact a TLS/SSL server, I do care about security.	2323	=item I want to contact a TLS/SSL server, I do care about security.
1793		2324
1794	Then you #x##TODO#	2325	Then you should additionally enable certificate verification, including
		2326	peername verification, if the protocol you use supports it (see
		2327	L<AnyEvent::TLS>, C<verify_peername>).
1795		2328
1796		2329	E.g. for HTTPS:
		2330
		2331	tcp_connect $host, $port, sub {
		2332	my ($fh) = @_;
		2333
		2334	my $handle = new AnyEvent::Handle
		2335	fh => $fh,
		2336	peername => $host,
		2337	tls => "connect",
		2338	tls_ctx => { verify => 1, verify_peername => "https" },
		2339	...
		2340
		2341	Note that you must specify the hostname you connected to (or whatever
		2342	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2343	peername verification will be done.
		2344
		2345	The above will use the system-dependent default set of trusted CA
		2346	certificates. If you want to check against a specific CA, add the
		2347	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2348
		2349	tls_ctx => {
		2350	verify => 1,
		2351	verify_peername => "https",
		2352	ca_file => "my-ca-cert.pem",
		2353	},
		2354
		2355	=item I want to create a TLS/SSL server, how do I do that?
		2356
		2357	Well, you first need to get a server certificate and key. You have
		2358	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2359	self-signed certificate (cheap. check the search engine of your choice,
		2360	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2361	nice program for that purpose).
		2362
		2363	Then create a file with your private key (in PEM format, see
		2364	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2365	file should then look like this:
		2366
		2367	-----BEGIN RSA PRIVATE KEY-----
		2368	...header data
		2369	... lots of base64'y-stuff
		2370	-----END RSA PRIVATE KEY-----
		2371
		2372	-----BEGIN CERTIFICATE-----
		2373	... lots of base64'y-stuff
		2374	-----END CERTIFICATE-----
		2375
		2376	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2377	specify this file as C<cert_file>:
		2378
		2379	tcp_server undef, $port, sub {
		2380	my ($fh) = @_;
		2381
		2382	my $handle = new AnyEvent::Handle
		2383	fh => $fh,
		2384	tls => "accept",
		2385	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2386	...
		2387
		2388	When you have intermediate CA certificates that your clients might not
		2389	know about, just append them to the C<cert_file>.
1797		2390
1798	=back	2391	=back
1799		2392
1800		2393
1801	=head1 SUBCLASSING AnyEvent::Handle	2394	=head1 SUBCLASSING AnyEvent::Handle
…		…
1821		2414
1822	=item * all members not documented here and not prefixed with an underscore	2415	=item * all members not documented here and not prefixed with an underscore
1823	are free to use in subclasses.	2416	are free to use in subclasses.
1824		2417
1825	Of course, new versions of AnyEvent::Handle may introduce more "public"	2418	Of course, new versions of AnyEvent::Handle may introduce more "public"
1826	member variables, but thats just life, at least it is documented.	2419	member variables, but that's just life. At least it is documented.
1827		2420
1828	=back	2421	=back
1829		2422
1830	=head1 AUTHOR	2423	=head1 AUTHOR
1831		2424

Diff Legend

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