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.156 by root, Wed Jul 22 05:37:32 2009 UTC vs.
Revision 1.205 by root, Mon Nov 15 17:11:00 2010 UTC

1	package AnyEvent::Handle;
2
3	use Scalar::Util ();
4	use Carp ();
5	use Errno qw(EAGAIN EINTR);
6
7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
9
10	=head1 NAME	1	=head1 NAME
11		2
12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
13
14	=cut
15
16	our $VERSION = 4.86;
17		4
18	=head1 SYNOPSIS	5	=head1 SYNOPSIS
19		6
20	use AnyEvent;	7	use AnyEvent;
21	use AnyEvent::Handle;	8	use AnyEvent::Handle;
…		…
27	on_error => sub {	14	on_error => sub {
28	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
29	warn "got error $msg\n";	16	warn "got error $msg\n";
30	$hdl->destroy;	17	$hdl->destroy;
31	$cv->send;	18	$cv->send;
32	);	19	};
33		20
34	# send some request line	21	# send some request line
35	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
36		23
37	# read the response line	24	# read the response line
…		…
43		30
44	$cv->recv;	31	$cv->recv;
45		32
46	=head1 DESCRIPTION	33	=head1 DESCRIPTION
47		34
48	This module is a helper module to make it easier to do event-based I/O on	35	This is a helper module to make it easier to do event-based I/O on
49	filehandles. For utility functions for doing non-blocking connects and accepts	36	stream-based filehandles (sockets, pipes, and other stream things).
50	on sockets see L<AnyEvent::Util>.
51		37
52	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
53	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
54		40
55	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
56	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
57	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.
58		47
59	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
60	argument.	49	argument.
61		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
62	=head1 METHODS	82	=head1 METHODS
63		83
64	=over 4	84	=over 4
65		85
66	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
67		87
68	The constructor supports these arguments (all as C<< key => value >> pairs).	88	The constructor supports these arguments (all as C<< key => value >> pairs).
69		89
70	=over 4	90	=over 4
71		91
72	=item fh => $filehandle [MANDATORY]	92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
73		93
74	The filehandle this L<AnyEvent::Handle> object will operate on.	94	The filehandle this L<AnyEvent::Handle> object will operate on.
75
76	NOTE: The filehandle will be set to non-blocking mode (using	95	NOTE: The filehandle will be set to non-blocking mode (using
77	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
78	that mode.	97	that mode.
		98
		99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		100
		101	Try to connect to the specified host and service (port), using
		102	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		103	default C<peername>.
		104
		105	You have to specify either this parameter, or C<fh>, above.
		106
		107	It is possible to push requests on the read and write queues, and modify
		108	properties of the stream, even while AnyEvent::Handle is connecting.
		109
		110	When this parameter is specified, then the C<on_prepare>,
		111	C<on_connect_error> and C<on_connect> callbacks will be called under the
		112	appropriate circumstances:
		113
		114	=over 4
		115
		116	=item on_prepare => $cb->($handle)
		117
		118	This (rarely used) callback is called before a new connection is
		119	attempted, but after the file handle has been created. It could be used to
		120	prepare the file handle with parameters required for the actual connect
		121	(as opposed to settings that can be changed when the connection is already
		122	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.
79		210
80	=item on_eof => $cb->($handle)	211	=item on_eof => $cb->($handle)
81		212
82	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,
83	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
…		…
91	down.	222	down.
92		223
93	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
94	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>.
95		226
96	=item on_error => $cb->($handle, $fatal, $message)
97
98	This is the error callback, which is called when, well, some error
99	occured, such as not being able to resolve the hostname, failure to
100	connect or a read error.
101
102	Some errors are fatal (which is indicated by C<$fatal> being true). On
103	fatal errors the handle object will be destroyed (by a call to C<< ->
104	destroy >>) after invoking the error callback (which means you are free to
105	examine the handle object). Examples of fatal errors are an EOF condition
106	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
107
108	AnyEvent::Handle tries to find an appropriate error code for you to check
109	against, but in some cases (TLS errors), this does not work well. It is
110	recommended to always output the C<$message> argument in human-readable
111	error messages (it's usually the same as C<"$!">).
112
113	Non-fatal errors can be retried by simply returning, but it is recommended
114	to simply ignore this parameter and instead abondon the handle object
115	when this callback is invoked. Examples of non-fatal errors are timeouts
116	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
117
118	On callback entrance, the value of C<$!> contains the operating system
119	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
120	C<EPROTO>).
121
122	While not mandatory, it is I<highly> recommended to set this callback, as
123	you will not be notified of errors otherwise. The default simply calls
124	C<croak>.
125
126	=item on_read => $cb->($handle)
127
128	This sets the default read callback, which is called when data arrives
129	and no read request is in the queue (unlike read queue callbacks, this
130	callback will only be called when at least one octet of data is in the
131	read buffer).
132
133	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
134	method or access the C<< $handle->{rbuf} >> member directly. Note that you
135	must not enlarge or modify the read buffer, you can only remove data at
136	the beginning from it.
137
138	When an EOF condition is detected then AnyEvent::Handle will first try to
139	feed all the remaining data to the queued callbacks and C<on_read> before
140	calling the C<on_eof> callback. If no progress can be made, then a fatal
141	error will be raised (with C<$!> set to C<EPIPE>).
142
143	Note that, unlike requests in the read queue, an C<on_read> callback
144	doesn't mean you I<require> some data: if there is an EOF and there
145	are outstanding read requests then an error will be flagged. With an
146	C<on_read> callback, the C<on_eof> callback will be invoked.
147
148	=item on_drain => $cb->($handle)	227	=item on_drain => $cb->($handle)
149		228
150	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
151	(or when the callback is set and the buffer is empty already).	230	(or immediately if the buffer is empty already).
152		231
153	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.
154		233
155	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
156	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
…		…
158	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
159	the file when the write queue becomes empty.	238	the file when the write queue becomes empty.
160		239
161	=item timeout => $fractional_seconds	240	=item timeout => $fractional_seconds
162		241
		242	=item rtimeout => $fractional_seconds
		243
		244	=item wtimeout => $fractional_seconds
		245
163	If non-zero, then this enables an "inactivity" timeout: whenever this many	246	If non-zero, then these enables an "inactivity" timeout: whenever this
164	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
165	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
166	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).
167		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
168	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
169	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
170	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
171	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
172	restart the timeout.	262	restart the timeout.
173		263
174	Zero (the default) disables this timeout.	264	Zero (the default) disables this timeout.
175		265
…		…
191	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
192	isn't finished).	282	isn't finished).
193		283
194	=item autocork => <boolean>	284	=item autocork => <boolean>
195		285
196	When disabled (the default), then C<push_write> will try to immediately	286	When disabled (the default), C<push_write> will try to immediately
197	write the data to the handle, if possible. This avoids having to register	287	write the data to the handle if possible. This avoids having to register
198	a write watcher and wait for the next event loop iteration, but can	288	a write watcher and wait for the next event loop iteration, but can
199	be inefficient if you write multiple small chunks (on the wire, this	289	be inefficient if you write multiple small chunks (on the wire, this
200	disadvantage is usually avoided by your kernel's nagle algorithm, see	290	disadvantage is usually avoided by your kernel's nagle algorithm, see
201	C<no_delay>, but this option can save costly syscalls).	291	C<no_delay>, but this option can save costly syscalls).
202		292
203	When enabled, then writes will always be queued till the next event loop	293	When enabled, writes will always be queued till the next event loop
204	iteration. This is efficient when you do many small writes per iteration,	294	iteration. This is efficient when you do many small writes per iteration,
205	but less efficient when you do a single write only per iteration (or when	295	but less efficient when you do a single write only per iteration (or when
206	the write buffer often is full). It also increases write latency.	296	the write buffer often is full). It also increases write latency.
207		297
208	=item no_delay => <boolean>	298	=item no_delay => <boolean>
…		…
212	the Nagle algorithm, and usually it is beneficial.	302	the Nagle algorithm, and usually it is beneficial.
213		303
214	In some situations you want as low a delay as possible, which can be	304	In some situations you want as low a delay as possible, which can be
215	accomplishd by setting this option to a true value.	305	accomplishd by setting this option to a true value.
216		306
217	The default is your opertaing system's default behaviour (most likely	307	The default is your operating system's default behaviour (most likely
218	enabled), this option explicitly enables or disables it, if possible.	308	enabled). This option explicitly enables or disables it, if possible.
		309
		310	=item keepalive => <boolean>
		311
		312	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		313	normally, TCP connections have no time-out once established, so TCP
		314	connections, once established, can stay alive forever even when the other
		315	side has long gone. TCP keepalives are a cheap way to take down long-lived
		316	TCP connections when the other side becomes unreachable. While the default
		317	is OS-dependent, TCP keepalives usually kick in after around two hours,
		318	and, if the other side doesn't reply, take down the TCP connection some 10
		319	to 15 minutes later.
		320
		321	It is harmless to specify this option for file handles that do not support
		322	keepalives, and enabling it on connections that are potentially long-lived
		323	is usually a good idea.
		324
		325	=item oobinline => <boolean>
		326
		327	BSD majorly fucked up the implementation of TCP urgent data. The result
		328	is that almost no OS implements TCP according to the specs, and every OS
		329	implements it slightly differently.
		330
		331	If you want to handle TCP urgent data, then setting this flag (the default
		332	is enabled) gives you the most portable way of getting urgent data, by
		333	putting it into the stream.
		334
		335	Since BSD emulation of OOB data on top of TCP's urgent data can have
		336	security implications, AnyEvent::Handle sets this flag automatically
		337	unless explicitly specified. Note that setting this flag after
		338	establishing a connection I<may> be a bit too late (data loss could
		339	already have occured on BSD systems), but at least it will protect you
		340	from most attacks.
219		341
220	=item read_size => <bytes>	342	=item read_size => <bytes>
221		343
222	The default read block size (the amount of bytes this module will	344	The initial read block size, the number of bytes this module will try to
223	try to read during each loop iteration, which affects memory	345	read during each loop iteration. Each handle object will consume at least
224	requirements). Default: C<8192>.	346	this amount of memory for the read buffer as well, so when handling many
		347	connections requirements). See also C<max_read_size>. Default: C<2048>.
		348
		349	=item max_read_size => <bytes>
		350
		351	The maximum read buffer size used by the dynamic adjustment
		352	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
		353	one go it will double C<read_size> up to the maximum given by this
		354	option. Default: C<131072> or C<read_size>, whichever is higher.
225		355
226	=item low_water_mark => <bytes>	356	=item low_water_mark => <bytes>
227		357
228	Sets the amount of bytes (default: C<0>) that make up an "empty" write	358	Sets the number of bytes (default: C<0>) that make up an "empty" write
229	buffer: If the write reaches this size or gets even samller it is	359	buffer: If the buffer reaches this size or gets even samller it is
230	considered empty.	360	considered empty.
231		361
232	Sometimes it can be beneficial (for performance reasons) to add data to	362	Sometimes it can be beneficial (for performance reasons) to add data to
233	the write buffer before it is fully drained, but this is a rare case, as	363	the write buffer before it is fully drained, but this is a rare case, as
234	the operating system kernel usually buffers data as well, so the default	364	the operating system kernel usually buffers data as well, so the default
235	is good in almost all cases.	365	is good in almost all cases.
236		366
237	=item linger => <seconds>	367	=item linger => <seconds>
238		368
239	If non-zero (default: C<3600>), then the destructor of the	369	If this is non-zero (default: C<3600>), the destructor of the
240	AnyEvent::Handle object will check whether there is still outstanding	370	AnyEvent::Handle object will check whether there is still outstanding
241	write data and will install a watcher that will write this data to the	371	write data and will install a watcher that will write this data to the
242	socket. No errors will be reported (this mostly matches how the operating	372	socket. No errors will be reported (this mostly matches how the operating
243	system treats outstanding data at socket close time).	373	system treats outstanding data at socket close time).
244		374
…		…
251	A string used to identify the remote site - usually the DNS hostname	381	A string used to identify the remote site - usually the DNS hostname
252	(I<not> IDN!) used to create the connection, rarely the IP address.	382	(I<not> IDN!) used to create the connection, rarely the IP address.
253		383
254	Apart from being useful in error messages, this string is also used in TLS	384	Apart from being useful in error messages, this string is also used in TLS
255	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	385	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
256	verification will be skipped when C<peername> is not specified or	386	verification will be skipped when C<peername> is not specified or is
257	C<undef>.	387	C<undef>.
258		388
259	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	389	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
260		390
261	When this parameter is given, it enables TLS (SSL) mode, that means	391	When this parameter is given, it enables TLS (SSL) mode, that means
262	AnyEvent will start a TLS handshake as soon as the conenction has been	392	AnyEvent will start a TLS handshake as soon as the connection has been
263	established and will transparently encrypt/decrypt data afterwards.	393	established and will transparently encrypt/decrypt data afterwards.
264		394
265	All TLS protocol errors will be signalled as C<EPROTO>, with an	395	All TLS protocol errors will be signalled as C<EPROTO>, with an
266	appropriate error message.	396	appropriate error message.
267		397
…		…
287	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	417	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
288	passing in the wrong integer will lead to certain crash. This most often	418	passing in the wrong integer will lead to certain crash. This most often
289	happens when one uses a stylish C<< tls => 1 >> and is surprised about the	419	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
290	segmentation fault.	420	segmentation fault.
291		421
292	See the C<< ->starttls >> method for when need to start TLS negotiation later.	422	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
293		423
294	=item tls_ctx => $anyevent_tls	424	=item tls_ctx => $anyevent_tls
295		425
296	Use the given C<AnyEvent::TLS> object to create the new TLS connection	426	Use the given C<AnyEvent::TLS> object to create the new TLS connection
297	(unless a connection object was specified directly). If this parameter is	427	(unless a connection object was specified directly). If this parameter is
…		…
312		442
313	TLS handshake failures will not cause C<on_error> to be invoked when this	443	TLS handshake failures will not cause C<on_error> to be invoked when this
314	callback is in effect, instead, the error message will be passed to C<on_starttls>.	444	callback is in effect, instead, the error message will be passed to C<on_starttls>.
315		445
316	Without this callback, handshake failures lead to C<on_error> being	446	Without this callback, handshake failures lead to C<on_error> being
317	called, as normal.	447	called as usual.
318		448
319	Note that you cannot call C<starttls> right again in this callback. If you	449	Note that you cannot just call C<starttls> again in this callback. If you
320	need to do that, start an zero-second timer instead whose callback can	450	need to do that, start an zero-second timer instead whose callback can
321	then call C<< ->starttls >> again.	451	then call C<< ->starttls >> again.
322		452
323	=item on_stoptls => $cb->($handle)	453	=item on_stoptls => $cb->($handle)
324		454
…		…
350		480
351	sub new {	481	sub new {
352	my $class = shift;	482	my $class = shift;
353	my $self = bless { @_ }, $class;	483	my $self = bless { @_ }, $class;
354		484
355	$self->{fh} or Carp::croak "mandatory argument fh is missing";	485	if ($self->{fh}) {
		486	$self->_start;
		487	return unless $self->{fh}; # could be gone by now
		488
		489	} elsif ($self->{connect}) {
		490	require AnyEvent::Socket;
		491
		492	$self->{peername} = $self->{connect}[0]
		493	unless exists $self->{peername};
		494
		495	$self->{_skip_drain_rbuf} = 1;
		496
		497	{
		498	Scalar::Util::weaken (my $self = $self);
		499
		500	$self->{_connect} =
		501	AnyEvent::Socket::tcp_connect (
		502	$self->{connect}[0],
		503	$self->{connect}[1],
		504	sub {
		505	my ($fh, $host, $port, $retry) = @_;
		506
		507	delete $self->{_connect};
		508
		509	if ($fh) {
		510	$self->{fh} = $fh;
		511
		512	delete $self->{_skip_drain_rbuf};
		513	$self->_start;
		514
		515	$self->{on_connect}
		516	and $self->{on_connect}($self, $host, $port, sub {
		517	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		518	$self->{_skip_drain_rbuf} = 1;
		519	&$retry;
		520	});
		521
		522	} else {
		523	if ($self->{on_connect_error}) {
		524	$self->{on_connect_error}($self, "$!");
		525	$self->destroy;
		526	} else {
		527	$self->_error ($!, 1);
		528	}
		529	}
		530	},
		531	sub {
		532	local $self->{fh} = $_[0];
		533
		534	$self->{on_prepare}
		535	? $self->{on_prepare}->($self)
		536	: ()
		537	}
		538	);
		539	}
		540
		541	} else {
		542	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		543	}
		544
		545	$self
		546	}
		547
		548	sub _start {
		549	my ($self) = @_;
		550
		551	# too many clueless people try to use udp and similar sockets
		552	# with AnyEvent::Handle, do them a favour.
		553	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		554	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		555	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
356		556
357	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	557	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
358		558
		559	$self->{_activity} =
		560	$self->{_ractivity} =
359	$self->{_activity} = AnyEvent->now;	561	$self->{_wactivity} = AE::now;
360	$self->_timeout;
361		562
		563	$self->{read_size} ||= 2048;
		564	$self->{max_read_size} = $self->{read_size}
		565	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		566
		567	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		568	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		569	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		570
362	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	571	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		572	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
363		573
		574	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		575
364	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	576	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
365	if $self->{tls};	577	if $self->{tls};
366		578
367	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	579	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
368		580
369	$self->start_read	581	$self->start_read
370	if $self->{on_read};	582	if $self->{on_read} || @{ $self->{_queue} };
371		583
372	$self->{fh} && $self	584	$self->_drain_wbuf;
373	}	585	}
374
375	#sub _shutdown {
376	# my ($self) = @_;
377	#
378	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
379	# $self->{_eof} = 1; # tell starttls et. al to stop trying
380	#
381	# &_freetls;
382	#}
383		586
384	sub _error {	587	sub _error {
385	my ($self, $errno, $fatal, $message) = @_;	588	my ($self, $errno, $fatal, $message) = @_;
386		589
387	$! = $errno;	590	$! = $errno;
388	$message ||= "$!";	591	$message ||= "$!";
389		592
390	if ($self->{on_error}) {	593	if ($self->{on_error}) {
391	$self->{on_error}($self, $fatal, $message);	594	$self->{on_error}($self, $fatal, $message);
392	$self->destroy if $fatal;	595	$self->destroy if $fatal;
393	} elsif ($self->{fh}) {	596	} elsif ($self->{fh} || $self->{connect}) {
394	$self->destroy;	597	$self->destroy;
395	Carp::croak "AnyEvent::Handle uncaught error: $message";	598	Carp::croak "AnyEvent::Handle uncaught error: $message";
396	}	599	}
397	}	600	}
398		601
…		…
424	$_[0]{on_eof} = $_[1];	627	$_[0]{on_eof} = $_[1];
425	}	628	}
426		629
427	=item $handle->on_timeout ($cb)	630	=item $handle->on_timeout ($cb)
428		631
429	Replace the current C<on_timeout> callback, or disables the callback (but	632	=item $handle->on_rtimeout ($cb)
430	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
431	argument and method.
432		633
433	=cut	634	=item $handle->on_wtimeout ($cb)
434		635
435	sub on_timeout {	636	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
436	$_[0]{on_timeout} = $_[1];	637	callback, or disables the callback (but not the timeout) if C<$cb> =
437	}	638	C<undef>. See the C<timeout> constructor argument and method.
		639
		640	=cut
		641
		642	# see below
438		643
439	=item $handle->autocork ($boolean)	644	=item $handle->autocork ($boolean)
440		645
441	Enables or disables the current autocork behaviour (see C<autocork>	646	Enables or disables the current autocork behaviour (see C<autocork>
442	constructor argument). Changes will only take effect on the next write.	647	constructor argument). Changes will only take effect on the next write.
…		…
455	=cut	660	=cut
456		661
457	sub no_delay {	662	sub no_delay {
458	$_[0]{no_delay} = $_[1];	663	$_[0]{no_delay} = $_[1];
459		664
		665	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		666	if $_[0]{fh};
		667	}
		668
		669	=item $handle->keepalive ($boolean)
		670
		671	Enables or disables the C<keepalive> setting (see constructor argument of
		672	the same name for details).
		673
		674	=cut
		675
		676	sub keepalive {
		677	$_[0]{keepalive} = $_[1];
		678
460	eval {	679	eval {
461	local $SIG{__DIE__};	680	local $SIG{__DIE__};
462	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	681	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		682	if $_[0]{fh};
		683	};
		684	}
		685
		686	=item $handle->oobinline ($boolean)
		687
		688	Enables or disables the C<oobinline> setting (see constructor argument of
		689	the same name for details).
		690
		691	=cut
		692
		693	sub oobinline {
		694	$_[0]{oobinline} = $_[1];
		695
		696	eval {
		697	local $SIG{__DIE__};
		698	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		699	if $_[0]{fh};
		700	};
		701	}
		702
		703	=item $handle->keepalive ($boolean)
		704
		705	Enables or disables the C<keepalive> setting (see constructor argument of
		706	the same name for details).
		707
		708	=cut
		709
		710	sub keepalive {
		711	$_[0]{keepalive} = $_[1];
		712
		713	eval {
		714	local $SIG{__DIE__};
		715	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		716	if $_[0]{fh};
463	};	717	};
464	}	718	}
465		719
466	=item $handle->on_starttls ($cb)	720	=item $handle->on_starttls ($cb)
467		721
…		…
477		731
478	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	732	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
479		733
480	=cut	734	=cut
481		735
482	sub on_starttls {	736	sub on_stoptls {
483	$_[0]{on_stoptls} = $_[1];	737	$_[0]{on_stoptls} = $_[1];
484	}	738	}
485		739
		740	=item $handle->rbuf_max ($max_octets)
		741
		742	Configures the C<rbuf_max> setting (C<undef> disables it).
		743
		744	=cut
		745
		746	sub rbuf_max {
		747	$_[0]{rbuf_max} = $_[1];
		748	}
		749
486	#############################################################################	750	#############################################################################
487		751
488	=item $handle->timeout ($seconds)	752	=item $handle->timeout ($seconds)
489		753
		754	=item $handle->rtimeout ($seconds)
		755
		756	=item $handle->wtimeout ($seconds)
		757
490	Configures (or disables) the inactivity timeout.	758	Configures (or disables) the inactivity timeout.
491		759
492	=cut	760	=item $handle->timeout_reset
493		761
494	sub timeout {	762	=item $handle->rtimeout_reset
		763
		764	=item $handle->wtimeout_reset
		765
		766	Reset the activity timeout, as if data was received or sent.
		767
		768	These methods are cheap to call.
		769
		770	=cut
		771
		772	for my $dir ("", "r", "w") {
		773	my $timeout = "${dir}timeout";
		774	my $tw = "_${dir}tw";
		775	my $on_timeout = "on_${dir}timeout";
		776	my $activity = "_${dir}activity";
		777	my $cb;
		778
		779	*$on_timeout = sub {
		780	$_[0]{$on_timeout} = $_[1];
		781	};
		782
		783	*$timeout = sub {
495	my ($self, $timeout) = @_;	784	my ($self, $new_value) = @_;
496		785
		786	$new_value >= 0
		787	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		788
497	$self->{timeout} = $timeout;	789	$self->{$timeout} = $new_value;
498	$self->_timeout;	790	delete $self->{$tw}; &$cb;
499	}	791	};
500		792
		793	*{"${dir}timeout_reset"} = sub {
		794	$_[0]{$activity} = AE::now;
		795	};
		796
		797	# main workhorse:
501	# reset the timeout watcher, as neccessary	798	# reset the timeout watcher, as neccessary
502	# also check for time-outs	799	# also check for time-outs
503	sub _timeout {	800	$cb = sub {
504	my ($self) = @_;	801	my ($self) = @_;
505		802
506	if ($self->{timeout}) {	803	if ($self->{$timeout} && $self->{fh}) {
507	my $NOW = AnyEvent->now;	804	my $NOW = AE::now;
508		805
509	# when would the timeout trigger?	806	# when would the timeout trigger?
510	my $after = $self->{_activity} + $self->{timeout} - $NOW;	807	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
511		808
512	# now or in the past already?	809	# now or in the past already?
513	if ($after <= 0) {	810	if ($after <= 0) {
514	$self->{_activity} = $NOW;	811	$self->{$activity} = $NOW;
515		812
516	if ($self->{on_timeout}) {	813	if ($self->{$on_timeout}) {
517	$self->{on_timeout}($self);	814	$self->{$on_timeout}($self);
518	} else {	815	} else {
519	$self->_error (Errno::ETIMEDOUT);	816	$self->_error (Errno::ETIMEDOUT);
		817	}
		818
		819	# callback could have changed timeout value, optimise
		820	return unless $self->{$timeout};
		821
		822	# calculate new after
		823	$after = $self->{$timeout};
520	}	824	}
521		825
522	# callback could have changed timeout value, optimise	826	Scalar::Util::weaken $self;
523	return unless $self->{timeout};	827	return unless $self; # ->error could have destroyed $self
524		828
525	# calculate new after	829	$self->{$tw} ||= AE::timer $after, 0, sub {
526	$after = $self->{timeout};	830	delete $self->{$tw};
		831	$cb->($self);
		832	};
		833	} else {
		834	delete $self->{$tw};
527	}	835	}
528
529	Scalar::Util::weaken $self;
530	return unless $self; # ->error could have destroyed $self
531
532	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
533	delete $self->{_tw};
534	$self->_timeout;
535	});
536	} else {
537	delete $self->{_tw};
538	}	836	}
539	}	837	}
540		838
541	#############################################################################	839	#############################################################################
542		840
…		…
557		855
558	=item $handle->on_drain ($cb)	856	=item $handle->on_drain ($cb)
559		857
560	Sets the C<on_drain> callback or clears it (see the description of	858	Sets the C<on_drain> callback or clears it (see the description of
561	C<on_drain> in the constructor).	859	C<on_drain> in the constructor).
		860
		861	This method may invoke callbacks (and therefore the handle might be
		862	destroyed after it returns).
562		863
563	=cut	864	=cut
564		865
565	sub on_drain {	866	sub on_drain {
566	my ($self, $cb) = @_;	867	my ($self, $cb) = @_;
…		…
575		876
576	Queues the given scalar to be written. You can push as much data as you	877	Queues the given scalar to be written. You can push as much data as you
577	want (only limited by the available memory), as C<AnyEvent::Handle>	878	want (only limited by the available memory), as C<AnyEvent::Handle>
578	buffers it independently of the kernel.	879	buffers it independently of the kernel.
579		880
		881	This method may invoke callbacks (and therefore the handle might be
		882	destroyed after it returns).
		883
580	=cut	884	=cut
581		885
582	sub _drain_wbuf {	886	sub _drain_wbuf {
583	my ($self) = @_;	887	my ($self) = @_;
584		888
…		…
590	my $len = syswrite $self->{fh}, $self->{wbuf};	894	my $len = syswrite $self->{fh}, $self->{wbuf};
591		895
592	if (defined $len) {	896	if (defined $len) {
593	substr $self->{wbuf}, 0, $len, "";	897	substr $self->{wbuf}, 0, $len, "";
594		898
595	$self->{_activity} = AnyEvent->now;	899	$self->{_activity} = $self->{_wactivity} = AE::now;
596		900
597	$self->{on_drain}($self)	901	$self->{on_drain}($self)
598	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	902	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
599	&& $self->{on_drain};	903	&& $self->{on_drain};
600		904
…		…
606		910
607	# try to write data immediately	911	# try to write data immediately
608	$cb->() unless $self->{autocork};	912	$cb->() unless $self->{autocork};
609		913
610	# if still data left in wbuf, we need to poll	914	# if still data left in wbuf, we need to poll
611	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	915	$self->{_ww} = AE::io $self->{fh}, 1, $cb
612	if length $self->{wbuf};	916	if length $self->{wbuf};
613	};	917	};
614	}	918	}
615		919
616	our %WH;	920	our %WH;
617		921
		922	# deprecated
618	sub register_write_type($$) {	923	sub register_write_type($$) {
619	$WH{$_[0]} = $_[1];	924	$WH{$_[0]} = $_[1];
620	}	925	}
621		926
622	sub push_write {	927	sub push_write {
623	my $self = shift;	928	my $self = shift;
624		929
625	if (@_ > 1) {	930	if (@_ > 1) {
626	my $type = shift;	931	my $type = shift;
627		932
		933	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
628	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	934	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
629	->($self, @_);	935	->($self, @_);
630	}	936	}
631		937
		938	# we downgrade here to avoid hard-to-track-down bugs,
		939	# and diagnose the problem earlier and better.
		940
632	if ($self->{tls}) {	941	if ($self->{tls}) {
633	$self->{_tls_wbuf} .= $_[0];	942	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
634		943	&_dotls ($self) if $self->{fh};
635	&_dotls ($self);
636	} else {	944	} else {
637	$self->{wbuf} .= $_[0];	945	utf8::downgrade $self->{wbuf} .= $_[0];
638	$self->_drain_wbuf;	946	$self->_drain_wbuf if $self->{fh};
639	}	947	}
640	}	948	}
641		949
642	=item $handle->push_write (type => @args)	950	=item $handle->push_write (type => @args)
643		951
644	Instead of formatting your data yourself, you can also let this module do	952	Instead of formatting your data yourself, you can also let this module
645	the job by specifying a type and type-specific arguments.	953	do the job by specifying a type and type-specific arguments. You
		954	can also specify the (fully qualified) name of a package, in which
		955	case AnyEvent tries to load the package and then expects to find the
		956	C<anyevent_write_type> function inside (see "custom write types", below).
646		957
647	Predefined types are (if you have ideas for additional types, feel free to	958	Predefined types are (if you have ideas for additional types, feel free to
648	drop by and tell us):	959	drop by and tell us):
649		960
650	=over 4	961	=over 4
…		…
707	Other languages could read single lines terminated by a newline and pass	1018	Other languages could read single lines terminated by a newline and pass
708	this line into their JSON decoder of choice.	1019	this line into their JSON decoder of choice.
709		1020
710	=cut	1021	=cut
711		1022
		1023	sub json_coder() {
		1024	eval { require JSON::XS; JSON::XS->new->utf8 }
		1025	|| do { require JSON; JSON->new->utf8 }
		1026	}
		1027
712	register_write_type json => sub {	1028	register_write_type json => sub {
713	my ($self, $ref) = @_;	1029	my ($self, $ref) = @_;
714		1030
715	require JSON;	1031	my $json = $self->{json} ||= json_coder;
716		1032
717	$self->{json} ? $self->{json}->encode ($ref)	1033	$json->encode ($ref)
718	: JSON::encode_json ($ref)
719	};	1034	};
720		1035
721	=item storable => $reference	1036	=item storable => $reference
722		1037
723	Freezes the given reference using L<Storable> and writes it to the	1038	Freezes the given reference using L<Storable> and writes it to the
…		…
749	the peer.	1064	the peer.
750		1065
751	You can rely on the normal read queue and C<on_eof> handling	1066	You can rely on the normal read queue and C<on_eof> handling
752	afterwards. This is the cleanest way to close a connection.	1067	afterwards. This is the cleanest way to close a connection.
753		1068
		1069	This method may invoke callbacks (and therefore the handle might be
		1070	destroyed after it returns).
		1071
754	=cut	1072	=cut
755		1073
756	sub push_shutdown {	1074	sub push_shutdown {
757	my ($self) = @_;	1075	my ($self) = @_;
758		1076
759	delete $self->{low_water_mark};	1077	delete $self->{low_water_mark};
760	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1078	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
761	}	1079	}
762		1080
763	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1081	=item custom write types - Package::anyevent_write_type $handle, @args
764		1082
765	This function (not method) lets you add your own types to C<push_write>.	1083	Instead of one of the predefined types, you can also specify the name of
		1084	a package. AnyEvent will try to load the package and then expects to find
		1085	a function named C<anyevent_write_type> inside. If it isn't found, it
		1086	progressively tries to load the parent package until it either finds the
		1087	function (good) or runs out of packages (bad).
		1088
766	Whenever the given C<type> is used, C<push_write> will invoke the code	1089	Whenever the given C<type> is used, C<push_write> will the function with
767	reference with the handle object and the remaining arguments.	1090	the handle object and the remaining arguments.
768		1091
769	The code reference is supposed to return a single octet string that will	1092	The function is supposed to return a single octet string that will be
770	be appended to the write buffer.	1093	appended to the write buffer, so you cna mentally treat this function as a
		1094	"arguments to on-the-wire-format" converter.
771		1095
772	Note that this is a function, and all types registered this way will be	1096	Example: implement a custom write type C<join> that joins the remaining
773	global, so try to use unique names.	1097	arguments using the first one.
		1098
		1099	$handle->push_write (My::Type => " ", 1,2,3);
		1100
		1101	# uses the following package, which can be defined in the "My::Type" or in
		1102	# the "My" modules to be auto-loaded, or just about anywhere when the
		1103	# My::Type::anyevent_write_type is defined before invoking it.
		1104
		1105	package My::Type;
		1106
		1107	sub anyevent_write_type {
		1108	my ($handle, $delim, @args) = @_;
		1109
		1110	join $delim, @args
		1111	}
774		1112
775	=cut	1113	=cut
776		1114
777	#############################################################################	1115	#############################################################################
778		1116
…		…
787	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1125	ways, the "simple" way, using only C<on_read> and the "complex" way, using
788	a queue.	1126	a queue.
789		1127
790	In the simple case, you just install an C<on_read> callback and whenever	1128	In the simple case, you just install an C<on_read> callback and whenever
791	new data arrives, it will be called. You can then remove some data (if	1129	new data arrives, it will be called. You can then remove some data (if
792	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1130	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
793	leave the data there if you want to accumulate more (e.g. when only a	1131	leave the data there if you want to accumulate more (e.g. when only a
794	partial message has been received so far).	1132	partial message has been received so far), or change the read queue with
		1133	e.g. C<push_read>.
795		1134
796	In the more complex case, you want to queue multiple callbacks. In this	1135	In the more complex case, you want to queue multiple callbacks. In this
797	case, AnyEvent::Handle will call the first queued callback each time new	1136	case, AnyEvent::Handle will call the first queued callback each time new
798	data arrives (also the first time it is queued) and removes it when it has	1137	data arrives (also the first time it is queued) and remove it when it has
799	done its job (see C<push_read>, below).	1138	done its job (see C<push_read>, below).
800		1139
801	This way you can, for example, push three line-reads, followed by reading	1140	This way you can, for example, push three line-reads, followed by reading
802	a chunk of data, and AnyEvent::Handle will execute them in order.	1141	a chunk of data, and AnyEvent::Handle will execute them in order.
803		1142
…		…
860	=cut	1199	=cut
861		1200
862	sub _drain_rbuf {	1201	sub _drain_rbuf {
863	my ($self) = @_;	1202	my ($self) = @_;
864		1203
		1204	# avoid recursion
		1205	return if $self->{_skip_drain_rbuf};
865	local $self->{_in_drain} = 1;	1206	local $self->{_skip_drain_rbuf} = 1;
866
867	if (
868	defined $self->{rbuf_max}
869	&& $self->{rbuf_max} < length $self->{rbuf}
870	) {
871	$self->_error (Errno::ENOSPC, 1), return;
872	}
873		1207
874	while () {	1208	while () {
875	# we need to use a separate tls read buffer, as we must not receive data while	1209	# we need to use a separate tls read buffer, as we must not receive data while
876	# we are draining the buffer, and this can only happen with TLS.	1210	# we are draining the buffer, and this can only happen with TLS.
877	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1211	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1212	if exists $self->{_tls_rbuf};
878		1213
879	my $len = length $self->{rbuf};	1214	my $len = length $self->{rbuf};
880		1215
881	if (my $cb = shift @{ $self->{_queue} }) {	1216	if (my $cb = shift @{ $self->{_queue} }) {
882	unless ($cb->($self)) {	1217	unless ($cb->($self)) {
883	if ($self->{_eof}) {	1218	# no progress can be made
884	# no progress can be made (not enough data and no data forthcoming)	1219	# (not enough data and no data forthcoming)
885	$self->_error (Errno::EPIPE, 1), return;	1220	$self->_error (Errno::EPIPE, 1), return
886	}	1221	if $self->{_eof};
887		1222
888	unshift @{ $self->{_queue} }, $cb;	1223	unshift @{ $self->{_queue} }, $cb;
889	last;	1224	last;
890	}	1225	}
891	} elsif ($self->{on_read}) {	1226	} elsif ($self->{on_read}) {
…		…
911	last;	1246	last;
912	}	1247	}
913	}	1248	}
914		1249
915	if ($self->{_eof}) {	1250	if ($self->{_eof}) {
916	if ($self->{on_eof}) {	1251	$self->{on_eof}
917	$self->{on_eof}($self)	1252	? $self->{on_eof}($self)
918	} else {
919	$self->_error (0, 1, "Unexpected end-of-file");	1253	: $self->_error (0, 1, "Unexpected end-of-file");
920	}	1254
		1255	return;
		1256	}
		1257
		1258	if (
		1259	defined $self->{rbuf_max}
		1260	&& $self->{rbuf_max} < length $self->{rbuf}
		1261	) {
		1262	$self->_error (Errno::ENOSPC, 1), return;
921	}	1263	}
922		1264
923	# may need to restart read watcher	1265	# may need to restart read watcher
924	unless ($self->{_rw}) {	1266	unless ($self->{_rw}) {
925	$self->start_read	1267	$self->start_read
…		…
931		1273
932	This replaces the currently set C<on_read> callback, or clears it (when	1274	This replaces the currently set C<on_read> callback, or clears it (when
933	the new callback is C<undef>). See the description of C<on_read> in the	1275	the new callback is C<undef>). See the description of C<on_read> in the
934	constructor.	1276	constructor.
935		1277
		1278	This method may invoke callbacks (and therefore the handle might be
		1279	destroyed after it returns).
		1280
936	=cut	1281	=cut
937		1282
938	sub on_read {	1283	sub on_read {
939	my ($self, $cb) = @_;	1284	my ($self, $cb) = @_;
940		1285
941	$self->{on_read} = $cb;	1286	$self->{on_read} = $cb;
942	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1287	$self->_drain_rbuf if $cb;
943	}	1288	}
944		1289
945	=item $handle->rbuf	1290	=item $handle->rbuf
946		1291
947	Returns the read buffer (as a modifiable lvalue).	1292	Returns the read buffer (as a modifiable lvalue). You can also access the
		1293	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1294	much faster, and no less clean).
948		1295
949	You can access the read buffer directly as the C<< ->{rbuf} >>	1296	The only operation allowed on the read buffer (apart from looking at it)
950	member, if you want. However, the only operation allowed on the	1297	is removing data from its beginning. Otherwise modifying or appending to
951	read buffer (apart from looking at it) is removing data from its	1298	it is not allowed and will lead to hard-to-track-down bugs.
952	beginning. Otherwise modifying or appending to it is not allowed and will
953	lead to hard-to-track-down bugs.
954		1299
955	NOTE: The read buffer should only be used or modified if the C<on_read>,	1300	NOTE: The read buffer should only be used or modified in the C<on_read>
956	C<push_read> or C<unshift_read> methods are used. The other read methods	1301	callback or when C<push_read> or C<unshift_read> are used with a single
957	automatically manage the read buffer.	1302	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1303	will manage the read buffer on their own.
958		1304
959	=cut	1305	=cut
960		1306
961	sub rbuf : lvalue {	1307	sub rbuf : lvalue {
962	$_[0]{rbuf}	1308	$_[0]{rbuf}
…		…
979		1325
980	If enough data was available, then the callback must remove all data it is	1326	If enough data was available, then the callback must remove all data it is
981	interested in (which can be none at all) and return a true value. After returning	1327	interested in (which can be none at all) and return a true value. After returning
982	true, it will be removed from the queue.	1328	true, it will be removed from the queue.
983		1329
		1330	These methods may invoke callbacks (and therefore the handle might be
		1331	destroyed after it returns).
		1332
984	=cut	1333	=cut
985		1334
986	our %RH;	1335	our %RH;
987		1336
988	sub register_read_type($$) {	1337	sub register_read_type($$) {
…		…
994	my $cb = pop;	1343	my $cb = pop;
995		1344
996	if (@_) {	1345	if (@_) {
997	my $type = shift;	1346	my $type = shift;
998		1347
		1348	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
999	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1349	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1000	->($self, $cb, @_);	1350	->($self, $cb, @_);
1001	}	1351	}
1002		1352
1003	push @{ $self->{_queue} }, $cb;	1353	push @{ $self->{_queue} }, $cb;
1004	$self->_drain_rbuf unless $self->{_in_drain};	1354	$self->_drain_rbuf;
1005	}	1355	}
1006		1356
1007	sub unshift_read {	1357	sub unshift_read {
1008	my $self = shift;	1358	my $self = shift;
1009	my $cb = pop;	1359	my $cb = pop;
1010		1360
1011	if (@_) {	1361	if (@_) {
1012	my $type = shift;	1362	my $type = shift;
1013		1363
		1364	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1014	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1365	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1015	->($self, $cb, @_);	1366	->($self, $cb, @_);
1016	}	1367	}
1017		1368
1018
1019	unshift @{ $self->{_queue} }, $cb;	1369	unshift @{ $self->{_queue} }, $cb;
1020	$self->_drain_rbuf unless $self->{_in_drain};	1370	$self->_drain_rbuf;
1021	}	1371	}
1022		1372
1023	=item $handle->push_read (type => @args, $cb)	1373	=item $handle->push_read (type => @args, $cb)
1024		1374
1025	=item $handle->unshift_read (type => @args, $cb)	1375	=item $handle->unshift_read (type => @args, $cb)
1026		1376
1027	Instead of providing a callback that parses the data itself you can chose	1377	Instead of providing a callback that parses the data itself you can chose
1028	between a number of predefined parsing formats, for chunks of data, lines	1378	between a number of predefined parsing formats, for chunks of data, lines
1029	etc.	1379	etc. You can also specify the (fully qualified) name of a package, in
		1380	which case AnyEvent tries to load the package and then expects to find the
		1381	C<anyevent_read_type> function inside (see "custom read types", below).
1030		1382
1031	Predefined types are (if you have ideas for additional types, feel free to	1383	Predefined types are (if you have ideas for additional types, feel free to
1032	drop by and tell us):	1384	drop by and tell us):
1033		1385
1034	=over 4	1386	=over 4
…		…
1126	the receive buffer when neither C<$accept> nor C<$reject> match,	1478	the receive buffer when neither C<$accept> nor C<$reject> match,
1127	and everything preceding and including the match will be accepted	1479	and everything preceding and including the match will be accepted
1128	unconditionally. This is useful to skip large amounts of data that you	1480	unconditionally. This is useful to skip large amounts of data that you
1129	know cannot be matched, so that the C<$accept> or C<$reject> regex do not	1481	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1130	have to start matching from the beginning. This is purely an optimisation	1482	have to start matching from the beginning. This is purely an optimisation
1131	and is usually worth only when you expect more than a few kilobytes.	1483	and is usually worth it only when you expect more than a few kilobytes.
1132		1484
1133	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1485	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1134	expect the header to be very large (it isn't in practise, but...), we use	1486	expect the header to be very large (it isn't in practice, but...), we use
1135	a skip regex to skip initial portions. The skip regex is tricky in that	1487	a skip regex to skip initial portions. The skip regex is tricky in that
1136	it only accepts something not ending in either \015 or \012, as these are	1488	it only accepts something not ending in either \015 or \012, as these are
1137	required for the accept regex.	1489	required for the accept regex.
1138		1490
1139	$handle->push_read (regex =>	1491	$handle->push_read (regex =>
…		…
1274	=cut	1626	=cut
1275		1627
1276	register_read_type json => sub {	1628	register_read_type json => sub {
1277	my ($self, $cb) = @_;	1629	my ($self, $cb) = @_;
1278		1630
1279	my $json = $self->{json} ||=	1631	my $json = $self->{json} ||= json_coder;
1280	eval { require JSON::XS; JSON::XS->new->utf8 }
1281	|| do { require JSON; JSON->new->utf8 };
1282		1632
1283	my $data;	1633	my $data;
1284	my $rbuf = \$self->{rbuf};	1634	my $rbuf = \$self->{rbuf};
1285		1635
1286	sub {	1636	sub {
…		…
1355	}	1705	}
1356	};	1706	};
1357		1707
1358	=back	1708	=back
1359		1709
1360	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1710	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1361		1711
1362	This function (not method) lets you add your own types to C<push_read>.	1712	Instead of one of the predefined types, you can also specify the name
		1713	of a package. AnyEvent will try to load the package and then expects to
		1714	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1715	progressively tries to load the parent package until it either finds the
		1716	function (good) or runs out of packages (bad).
1363		1717
1364	Whenever the given C<type> is used, C<push_read> will invoke the code	1718	Whenever this type is used, C<push_read> will invoke the function with the
1365	reference with the handle object, the callback and the remaining	1719	handle object, the original callback and the remaining arguments.
1366	arguments.
1367		1720
1368	The code reference is supposed to return a callback (usually a closure)	1721	The function is supposed to return a callback (usually a closure) that
1369	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1722	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1723	mentally treat the function as a "configurable read type to read callback"
		1724	converter.
1370		1725
1371	It should invoke the passed callback when it is done reading (remember to	1726	It should invoke the original callback when it is done reading (remember
1372	pass C<$handle> as first argument as all other callbacks do that).	1727	to pass C<$handle> as first argument as all other callbacks do that,
		1728	although there is no strict requirement on this).
1373		1729
1374	Note that this is a function, and all types registered this way will be
1375	global, so try to use unique names.
1376
1377	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1730	For examples, see the source of this module (F<perldoc -m
1378	search for C<register_read_type>)).	1731	AnyEvent::Handle>, search for C<register_read_type>)).
1379		1732
1380	=item $handle->stop_read	1733	=item $handle->stop_read
1381		1734
1382	=item $handle->start_read	1735	=item $handle->start_read
1383		1736
…		…
1403	}	1756	}
1404		1757
1405	sub start_read {	1758	sub start_read {
1406	my ($self) = @_;	1759	my ($self) = @_;
1407		1760
1408	unless ($self->{_rw} || $self->{_eof}) {	1761	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1409	Scalar::Util::weaken $self;	1762	Scalar::Util::weaken $self;
1410		1763
1411	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1764	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1412	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1765	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1413	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1766	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1414		1767
1415	if ($len > 0) {	1768	if ($len > 0) {
1416	$self->{_activity} = AnyEvent->now;	1769	$self->{_activity} = $self->{_ractivity} = AE::now;
1417		1770
1418	if ($self->{tls}) {	1771	if ($self->{tls}) {
1419	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1772	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1420		1773
1421	&_dotls ($self);	1774	&_dotls ($self);
1422	} else {	1775	} else {
1423	$self->_drain_rbuf unless $self->{_in_drain};	1776	$self->_drain_rbuf;
		1777	}
		1778
		1779	if ($len == $self->{read_size}) {
		1780	$self->{read_size} *= 2;
		1781	$self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
		1782	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1424	}	1783	}
1425		1784
1426	} elsif (defined $len) {	1785	} elsif (defined $len) {
1427	delete $self->{_rw};	1786	delete $self->{_rw};
1428	$self->{_eof} = 1;	1787	$self->{_eof} = 1;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1788	$self->_drain_rbuf;
1430		1789
1431	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1790	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1432	return $self->_error ($!, 1);	1791	return $self->_error ($!, 1);
1433	}	1792	}
1434	});	1793	};
1435	}	1794	}
1436	}	1795	}
1437		1796
1438	our $ERROR_SYSCALL;	1797	our $ERROR_SYSCALL;
1439	our $ERROR_WANT_READ;	1798	our $ERROR_WANT_READ;
…		…
1494	$self->{_eof} = 1;	1853	$self->{_eof} = 1;
1495	}	1854	}
1496	}	1855	}
1497		1856
1498	$self->{_tls_rbuf} .= $tmp;	1857	$self->{_tls_rbuf} .= $tmp;
1499	$self->_drain_rbuf unless $self->{_in_drain};	1858	$self->_drain_rbuf;
1500	$self->{tls} or return; # tls session might have gone away in callback	1859	$self->{tls} or return; # tls session might have gone away in callback
1501	}	1860	}
1502		1861
1503	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1862	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1504	return $self->_tls_error ($tmp)	1863	return $self->_tls_error ($tmp)
…		…
1506	&& ($tmp != $ERROR_SYSCALL || $!);	1865	&& ($tmp != $ERROR_SYSCALL || $!);
1507		1866
1508	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1867	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1509	$self->{wbuf} .= $tmp;	1868	$self->{wbuf} .= $tmp;
1510	$self->_drain_wbuf;	1869	$self->_drain_wbuf;
		1870	$self->{tls} or return; # tls session might have gone away in callback
1511	}	1871	}
1512		1872
1513	$self->{_on_starttls}	1873	$self->{_on_starttls}
1514	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1874	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1515	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1875	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1518	=item $handle->starttls ($tls[, $tls_ctx])	1878	=item $handle->starttls ($tls[, $tls_ctx])
1519		1879
1520	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1880	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1521	object is created, you can also do that at a later time by calling	1881	object is created, you can also do that at a later time by calling
1522	C<starttls>.	1882	C<starttls>.
		1883
		1884	Starting TLS is currently an asynchronous operation - when you push some
		1885	write data and then call C<< ->starttls >> then TLS negotiation will start
		1886	immediately, after which the queued write data is then sent.
1523		1887
1524	The first argument is the same as the C<tls> constructor argument (either	1888	The first argument is the same as the C<tls> constructor argument (either
1525	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1889	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1526		1890
1527	The second argument is the optional C<AnyEvent::TLS> object that is used	1891	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1532	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1896	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1533	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1897	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1534	changed to your liking. Note that the handshake might have already started	1898	changed to your liking. Note that the handshake might have already started
1535	when this function returns.	1899	when this function returns.
1536		1900
1537	If it an error to start a TLS handshake more than once per	1901	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1538	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1902	handshakes on the same stream. It is best to not attempt to use the
		1903	stream after stopping TLS.
		1904
		1905	This method may invoke callbacks (and therefore the handle might be
		1906	destroyed after it returns).
1539		1907
1540	=cut	1908	=cut
1541		1909
1542	our %TLS_CACHE; #TODO not yet documented, should we?	1910	our %TLS_CACHE; #TODO not yet documented, should we?
1543		1911
1544	sub starttls {	1912	sub starttls {
1545	my ($self, $ssl, $ctx) = @_;	1913	my ($self, $tls, $ctx) = @_;
		1914
		1915	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1916	if $self->{tls};
		1917
		1918	$self->{tls} = $tls;
		1919	$self->{tls_ctx} = $ctx if @_ > 2;
		1920
		1921	return unless $self->{fh};
1546		1922
1547	require Net::SSLeay;	1923	require Net::SSLeay;
1548
1549	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1550	if $self->{tls};
1551		1924
1552	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1925	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1553	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1926	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1554		1927
		1928	$tls = delete $self->{tls};
1555	$ctx ||= $self->{tls_ctx};	1929	$ctx = $self->{tls_ctx};
		1930
		1931	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1556		1932
1557	if ("HASH" eq ref $ctx) {	1933	if ("HASH" eq ref $ctx) {
1558	require AnyEvent::TLS;	1934	require AnyEvent::TLS;
1559
1560	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1561		1935
1562	if ($ctx->{cache}) {	1936	if ($ctx->{cache}) {
1563	my $key = $ctx+0;	1937	my $key = $ctx+0;
1564	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;	1938	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1565	} else {	1939	} else {
1566	$ctx = new AnyEvent::TLS %$ctx;	1940	$ctx = new AnyEvent::TLS %$ctx;
1567	}	1941	}
1568	}	1942	}
1569		1943
1570	$self->{tls_ctx} = $ctx || TLS_CTX ();	1944	$self->{tls_ctx} = $ctx || TLS_CTX ();
1571	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1945	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1572		1946
1573	# basically, this is deep magic (because SSL_read should have the same issues)	1947	# basically, this is deep magic (because SSL_read should have the same issues)
1574	# but the openssl maintainers basically said: "trust us, it just works".	1948	# but the openssl maintainers basically said: "trust us, it just works".
1575	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1949	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1576	# and mismaintained ssleay-module doesn't even offer them).	1950	# and mismaintained ssleay-module doesn't even offer them).
…		…
1583	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1957	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1584	# have identity issues in that area.	1958	# have identity issues in that area.
1585	# Net::SSLeay::CTX_set_mode ($ssl,	1959	# Net::SSLeay::CTX_set_mode ($ssl,
1586	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1960	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1587	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1961	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1588	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	1962	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1589		1963
1590	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1964	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1591	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1965	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592		1966
		1967	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1968
1593	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1969	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1594		1970
1595	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1971	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1596	if $self->{on_starttls};	1972	if $self->{on_starttls};
1597		1973
1598	&_dotls; # need to trigger the initial handshake	1974	&_dotls; # need to trigger the initial handshake
…		…
1601		1977
1602	=item $handle->stoptls	1978	=item $handle->stoptls
1603		1979
1604	Shuts down the SSL connection - this makes a proper EOF handshake by	1980	Shuts down the SSL connection - this makes a proper EOF handshake by
1605	sending a close notify to the other side, but since OpenSSL doesn't	1981	sending a close notify to the other side, but since OpenSSL doesn't
1606	support non-blocking shut downs, it is not possible to re-use the stream	1982	support non-blocking shut downs, it is not guaranteed that you can re-use
1607	afterwards.	1983	the stream afterwards.
		1984
		1985	This method may invoke callbacks (and therefore the handle might be
		1986	destroyed after it returns).
1608		1987
1609	=cut	1988	=cut
1610		1989
1611	sub stoptls {	1990	sub stoptls {
1612	my ($self) = @_;	1991	my ($self) = @_;
1613		1992
1614	if ($self->{tls}) {	1993	if ($self->{tls} && $self->{fh}) {
1615	Net::SSLeay::shutdown ($self->{tls});	1994	Net::SSLeay::shutdown ($self->{tls});
1616		1995
1617	&_dotls;	1996	&_dotls;
1618		1997
1619	# # we don't give a shit. no, we do, but we can't. no...#d#	1998	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1625	sub _freetls {	2004	sub _freetls {
1626	my ($self) = @_;	2005	my ($self) = @_;
1627		2006
1628	return unless $self->{tls};	2007	return unless $self->{tls};
1629		2008
1630	$self->{tls_ctx}->_put_session (delete $self->{tls});	2009	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2010	if $self->{tls} > 0;
1631		2011
1632	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2012	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1633	}	2013	}
1634		2014
1635	sub DESTROY {	2015	sub DESTROY {
…		…
1643	my $fh = delete $self->{fh};	2023	my $fh = delete $self->{fh};
1644	my $wbuf = delete $self->{wbuf};	2024	my $wbuf = delete $self->{wbuf};
1645		2025
1646	my @linger;	2026	my @linger;
1647		2027
1648	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2028	push @linger, AE::io $fh, 1, sub {
1649	my $len = syswrite $fh, $wbuf, length $wbuf;	2029	my $len = syswrite $fh, $wbuf, length $wbuf;
1650		2030
1651	if ($len > 0) {	2031	if ($len > 0) {
1652	substr $wbuf, 0, $len, "";	2032	substr $wbuf, 0, $len, "";
1653	} else {	2033	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1654	@linger = (); # end	2034	@linger = (); # end
1655	}	2035	}
1656	});	2036	};
1657	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2037	push @linger, AE::timer $linger, 0, sub {
1658	@linger = ();	2038	@linger = ();
1659	});	2039	};
1660	}	2040	}
1661	}	2041	}
1662		2042
1663	=item $handle->destroy	2043	=item $handle->destroy
1664		2044
1665	Shuts down the handle object as much as possible - this call ensures that	2045	Shuts down the handle object as much as possible - this call ensures that
1666	no further callbacks will be invoked and as many resources as possible	2046	no further callbacks will be invoked and as many resources as possible
1667	will be freed. You must not call any methods on the object afterwards.	2047	will be freed. Any method you will call on the handle object after
		2048	destroying it in this way will be silently ignored (and it will return the
		2049	empty list).
1668		2050
1669	Normally, you can just "forget" any references to an AnyEvent::Handle	2051	Normally, you can just "forget" any references to an AnyEvent::Handle
1670	object and it will simply shut down. This works in fatal error and EOF	2052	object and it will simply shut down. This works in fatal error and EOF
1671	callbacks, as well as code outside. It does I<NOT> work in a read or write	2053	callbacks, as well as code outside. It does I<NOT> work in a read or write
1672	callback, so when you want to destroy the AnyEvent::Handle object from	2054	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1686	sub destroy {	2068	sub destroy {
1687	my ($self) = @_;	2069	my ($self) = @_;
1688		2070
1689	$self->DESTROY;	2071	$self->DESTROY;
1690	%$self = ();	2072	%$self = ();
		2073	bless $self, "AnyEvent::Handle::destroyed";
1691	}	2074	}
		2075
		2076	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2077	#nop
		2078	}
		2079
		2080	=item $handle->destroyed
		2081
		2082	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2083	->destroy >>, true otherwise.
		2084
		2085	Can be useful to decide whether the handle is still valid after some
		2086	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2087	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2088	can destroy the handle, so work can be avoided by checking sometimes:
		2089
		2090	$hdl->starttls ("accept");
		2091	return if $hdl->destroyed;
		2092	$hdl->push_write (...
		2093
		2094	Note that the call to C<push_write> will silently be ignored if the handle
		2095	has been destroyed, so often you can just ignore the possibility of the
		2096	handle being destroyed.
		2097
		2098	=cut
		2099
		2100	sub destroyed { 0 }
		2101	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1692		2102
1693	=item AnyEvent::Handle::TLS_CTX	2103	=item AnyEvent::Handle::TLS_CTX
1694		2104
1695	This function creates and returns the AnyEvent::TLS object used by default	2105	This function creates and returns the AnyEvent::TLS object used by default
1696	for TLS mode.	2106	for TLS mode.
…		…
1728		2138
1729	=item I get different callback invocations in TLS mode/Why can't I pause	2139	=item I get different callback invocations in TLS mode/Why can't I pause
1730	reading?	2140	reading?
1731		2141
1732	Unlike, say, TCP, TLS connections do not consist of two independent	2142	Unlike, say, TCP, TLS connections do not consist of two independent
1733	communication channels, one for each direction. Or put differently. The	2143	communication channels, one for each direction. Or put differently, the
1734	read and write directions are not independent of each other: you cannot	2144	read and write directions are not independent of each other: you cannot
1735	write data unless you are also prepared to read, and vice versa.	2145	write data unless you are also prepared to read, and vice versa.
1736		2146
1737	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2147	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1738	callback invocations when you are not expecting any read data - the reason	2148	callback invocations when you are not expecting any read data - the reason
1739	is that AnyEvent::Handle always reads in TLS mode.	2149	is that AnyEvent::Handle always reads in TLS mode.
1740		2150
1741	During the connection, you have to make sure that you always have a	2151	During the connection, you have to make sure that you always have a
1742	non-empty read-queue, or an C<on_read> watcher. At the end of the	2152	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1756	my $data = delete $_[0]{rbuf};	2166	my $data = delete $_[0]{rbuf};
1757	});	2167	});
1758		2168
1759	The reason to use C<on_error> is that TCP connections, due to latencies	2169	The reason to use C<on_error> is that TCP connections, due to latencies
1760	and packets loss, might get closed quite violently with an error, when in	2170	and packets loss, might get closed quite violently with an error, when in
1761	fact, all data has been received.	2171	fact all data has been received.
1762		2172
1763	It is usually better to use acknowledgements when transferring data,	2173	It is usually better to use acknowledgements when transferring data,
1764	to make sure the other side hasn't just died and you got the data	2174	to make sure the other side hasn't just died and you got the data
1765	intact. This is also one reason why so many internet protocols have an	2175	intact. This is also one reason why so many internet protocols have an
1766	explicit QUIT command.	2176	explicit QUIT command.
…		…
1783	consider using C<< ->push_shutdown >> instead.	2193	consider using C<< ->push_shutdown >> instead.
1784		2194
1785	=item I want to contact a TLS/SSL server, I don't care about security.	2195	=item I want to contact a TLS/SSL server, I don't care about security.
1786		2196
1787	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	2197	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1788	simply connect to it and then create the AnyEvent::Handle with the C<tls>	2198	connect to it and then create the AnyEvent::Handle with the C<tls>
1789	parameter:	2199	parameter:
1790		2200
1791	tcp_connect $host, $port, sub {	2201	tcp_connect $host, $port, sub {
1792	my ($fh) = @_;	2202	my ($fh) = @_;
1793		2203
…		…
1893		2303
1894	=item * all members not documented here and not prefixed with an underscore	2304	=item * all members not documented here and not prefixed with an underscore
1895	are free to use in subclasses.	2305	are free to use in subclasses.
1896		2306
1897	Of course, new versions of AnyEvent::Handle may introduce more "public"	2307	Of course, new versions of AnyEvent::Handle may introduce more "public"
1898	member variables, but thats just life, at least it is documented.	2308	member variables, but that's just life. At least it is documented.
1899		2309
1900	=back	2310	=back
1901		2311
1902	=head1 AUTHOR	2312	=head1 AUTHOR
1903		2313

Diff Legend

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