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

Diff Legend

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