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.158 by root, Fri Jul 24 08:40:35 2009 UTC vs.
Revision 1.204 by root, Mon Nov 15 03:29:17 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]
73
74	#=item fh => $filehandle [C<fh> or C<connect> MANDATORY]	92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		93
76	The filehandle this L<AnyEvent::Handle> object will operate on.	94	The filehandle this L<AnyEvent::Handle> object will operate on.
77	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.
80		98
81	#=item connect => [$host, $service]	99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
82	#	100
83	# You have to specify either this parameter, or C<connect>, below.
84	#Try to connect to the specified host and service (port), using	101	Try to connect to the specified host and service (port), using
85	#C<AnyEvent::Socket::tcp_connect>.	102	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
86	#	103	default C<peername>.
87	#When this	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.
88		210
89	=item on_eof => $cb->($handle)	211	=item on_eof => $cb->($handle)
90		212
91	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,
92	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
…		…
100	down.	222	down.
101		223
102	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
103	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>.
104		226
105	=item on_error => $cb->($handle, $fatal, $message)
106
107	This is the error callback, which is called when, well, some error
108	occured, such as not being able to resolve the hostname, failure to
109	connect or a read error.
110
111	Some errors are fatal (which is indicated by C<$fatal> being true). On
112	fatal errors the handle object will be destroyed (by a call to C<< ->
113	destroy >>) after invoking the error callback (which means you are free to
114	examine the handle object). Examples of fatal errors are an EOF condition
115	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
116
117	AnyEvent::Handle tries to find an appropriate error code for you to check
118	against, but in some cases (TLS errors), this does not work well. It is
119	recommended to always output the C<$message> argument in human-readable
120	error messages (it's usually the same as C<"$!">).
121
122	Non-fatal errors can be retried by simply returning, but it is recommended
123	to simply ignore this parameter and instead abondon the handle object
124	when this callback is invoked. Examples of non-fatal errors are timeouts
125	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
126
127	On callback entrance, the value of C<$!> contains the operating system
128	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
129	C<EPROTO>).
130
131	While not mandatory, it is I<highly> recommended to set this callback, as
132	you will not be notified of errors otherwise. The default simply calls
133	C<croak>.
134
135	=item on_read => $cb->($handle)
136
137	This sets the default read callback, which is called when data arrives
138	and no read request is in the queue (unlike read queue callbacks, this
139	callback will only be called when at least one octet of data is in the
140	read buffer).
141
142	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
143	method or access the C<< $handle->{rbuf} >> member directly. Note that you
144	must not enlarge or modify the read buffer, you can only remove data at
145	the beginning from it.
146
147	When an EOF condition is detected then AnyEvent::Handle will first try to
148	feed all the remaining data to the queued callbacks and C<on_read> before
149	calling the C<on_eof> callback. If no progress can be made, then a fatal
150	error will be raised (with C<$!> set to C<EPIPE>).
151
152	Note that, unlike requests in the read queue, an C<on_read> callback
153	doesn't mean you I<require> some data: if there is an EOF and there
154	are outstanding read requests then an error will be flagged. With an
155	C<on_read> callback, the C<on_eof> callback will be invoked.
156
157	=item on_drain => $cb->($handle)	227	=item on_drain => $cb->($handle)
158		228
159	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
160	(or when the callback is set and the buffer is empty already).	230	(or immediately if the buffer is empty already).
161		231
162	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.
163		233
164	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
165	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
…		…
167	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
168	the file when the write queue becomes empty.	238	the file when the write queue becomes empty.
169		239
170	=item timeout => $fractional_seconds	240	=item timeout => $fractional_seconds
171		241
		242	=item rtimeout => $fractional_seconds
		243
		244	=item wtimeout => $fractional_seconds
		245
172	If non-zero, then this enables an "inactivity" timeout: whenever this many	246	If non-zero, then these enables an "inactivity" timeout: whenever this
173	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
174	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
175	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).
176		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
177	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
178	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
179	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
180	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
181	restart the timeout.	262	restart the timeout.
182		263
183	Zero (the default) disables this timeout.	264	Zero (the default) disables this timeout.
184		265
…		…
200	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
201	isn't finished).	282	isn't finished).
202		283
203	=item autocork => <boolean>	284	=item autocork => <boolean>
204		285
205	When disabled (the default), then C<push_write> will try to immediately	286	When disabled (the default), C<push_write> will try to immediately
206	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
207	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
208	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
209	disadvantage is usually avoided by your kernel's nagle algorithm, see	290	disadvantage is usually avoided by your kernel's nagle algorithm, see
210	C<no_delay>, but this option can save costly syscalls).	291	C<no_delay>, but this option can save costly syscalls).
211		292
212	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
213	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,
214	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
215	the write buffer often is full). It also increases write latency.	296	the write buffer often is full). It also increases write latency.
216		297
217	=item no_delay => <boolean>	298	=item no_delay => <boolean>
…		…
221	the Nagle algorithm, and usually it is beneficial.	302	the Nagle algorithm, and usually it is beneficial.
222		303
223	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
224	accomplishd by setting this option to a true value.	305	accomplishd by setting this option to a true value.
225		306
226	The default is your opertaing system's default behaviour (most likely	307	The default is your operating system's default behaviour (most likely
227	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.
228		341
229	=item read_size => <bytes>	342	=item read_size => <bytes>
230		343
231	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
232	try to read during each loop iteration, which affects memory	345	read during each loop iteration. Each handle object will consume at least
233	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.
234		355
235	=item low_water_mark => <bytes>	356	=item low_water_mark => <bytes>
236		357
237	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
238	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
239	considered empty.	360	considered empty.
240		361
241	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
242	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
243	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
244	is good in almost all cases.	365	is good in almost all cases.
245		366
246	=item linger => <seconds>	367	=item linger => <seconds>
247		368
248	If non-zero (default: C<3600>), then the destructor of the	369	If this is non-zero (default: C<3600>), the destructor of the
249	AnyEvent::Handle object will check whether there is still outstanding	370	AnyEvent::Handle object will check whether there is still outstanding
250	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
251	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
252	system treats outstanding data at socket close time).	373	system treats outstanding data at socket close time).
253		374
…		…
260	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
261	(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.
262		383
263	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
264	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	385	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
265	verification will be skipped when C<peername> is not specified or	386	verification will be skipped when C<peername> is not specified or is
266	C<undef>.	387	C<undef>.
267		388
268	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	389	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
269		390
270	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
271	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
272	established and will transparently encrypt/decrypt data afterwards.	393	established and will transparently encrypt/decrypt data afterwards.
273		394
274	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
275	appropriate error message.	396	appropriate error message.
276		397
…		…
296	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	417	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
297	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
298	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
299	segmentation fault.	420	segmentation fault.
300		421
301	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.
302		423
303	=item tls_ctx => $anyevent_tls	424	=item tls_ctx => $anyevent_tls
304		425
305	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
306	(unless a connection object was specified directly). If this parameter is	427	(unless a connection object was specified directly). If this parameter is
…		…
321		442
322	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
323	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>.
324		445
325	Without this callback, handshake failures lead to C<on_error> being	446	Without this callback, handshake failures lead to C<on_error> being
326	called, as normal.	447	called as usual.
327		448
328	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
329	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
330	then call C<< ->starttls >> again.	451	then call C<< ->starttls >> again.
331		452
332	=item on_stoptls => $cb->($handle)	453	=item on_stoptls => $cb->($handle)
333		454
…		…
359		480
360	sub new {	481	sub new {
361	my $class = shift;	482	my $class = shift;
362	my $self = bless { @_ }, $class;	483	my $self = bless { @_ }, $class;
363		484
364	$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;
365		554
366	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	555	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
367		556
		557	$self->{_activity} =
		558	$self->{_ractivity} =
368	$self->{_activity} = AnyEvent->now;	559	$self->{_wactivity} = AE::now;
369	$self->_timeout;
370		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
371	$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};
372		571
		572	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		573
373	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	574	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
374	if $self->{tls};	575	if $self->{tls};
375		576
376	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	577	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
377		578
378	$self->start_read	579	$self->start_read
379	if $self->{on_read};	580	if $self->{on_read} || @{ $self->{_queue} };
380		581
381	$self->{fh} && $self	582	$self->_drain_wbuf;
382	}	583	}
383
384	#sub _shutdown {
385	# my ($self) = @_;
386	#
387	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
388	# $self->{_eof} = 1; # tell starttls et. al to stop trying
389	#
390	# &_freetls;
391	#}
392		584
393	sub _error {	585	sub _error {
394	my ($self, $errno, $fatal, $message) = @_;	586	my ($self, $errno, $fatal, $message) = @_;
395		587
396	$! = $errno;	588	$! = $errno;
397	$message ||= "$!";	589	$message ||= "$!";
398		590
399	if ($self->{on_error}) {	591	if ($self->{on_error}) {
400	$self->{on_error}($self, $fatal, $message);	592	$self->{on_error}($self, $fatal, $message);
401	$self->destroy if $fatal;	593	$self->destroy if $fatal;
402	} elsif ($self->{fh}) {	594	} elsif ($self->{fh} || $self->{connect}) {
403	$self->destroy;	595	$self->destroy;
404	Carp::croak "AnyEvent::Handle uncaught error: $message";	596	Carp::croak "AnyEvent::Handle uncaught error: $message";
405	}	597	}
406	}	598	}
407		599
…		…
433	$_[0]{on_eof} = $_[1];	625	$_[0]{on_eof} = $_[1];
434	}	626	}
435		627
436	=item $handle->on_timeout ($cb)	628	=item $handle->on_timeout ($cb)
437		629
438	Replace the current C<on_timeout> callback, or disables the callback (but	630	=item $handle->on_rtimeout ($cb)
439	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
440	argument and method.
441		631
442	=cut	632	=item $handle->on_wtimeout ($cb)
443		633
444	sub on_timeout {	634	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
445	$_[0]{on_timeout} = $_[1];	635	callback, or disables the callback (but not the timeout) if C<$cb> =
446	}	636	C<undef>. See the C<timeout> constructor argument and method.
		637
		638	=cut
		639
		640	# see below
447		641
448	=item $handle->autocork ($boolean)	642	=item $handle->autocork ($boolean)
449		643
450	Enables or disables the current autocork behaviour (see C<autocork>	644	Enables or disables the current autocork behaviour (see C<autocork>
451	constructor argument). Changes will only take effect on the next write.	645	constructor argument). Changes will only take effect on the next write.
…		…
464	=cut	658	=cut
465		659
466	sub no_delay {	660	sub no_delay {
467	$_[0]{no_delay} = $_[1];	661	$_[0]{no_delay} = $_[1];
468		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
469	eval {	677	eval {
470	local $SIG{__DIE__};	678	local $SIG{__DIE__};
471	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};
472	};	715	};
473	}	716	}
474		717
475	=item $handle->on_starttls ($cb)	718	=item $handle->on_starttls ($cb)
476		719
…		…
486		729
487	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).
488		731
489	=cut	732	=cut
490		733
491	sub on_starttls {	734	sub on_stoptls {
492	$_[0]{on_stoptls} = $_[1];	735	$_[0]{on_stoptls} = $_[1];
493	}	736	}
494		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
495	#############################################################################	748	#############################################################################
496		749
497	=item $handle->timeout ($seconds)	750	=item $handle->timeout ($seconds)
498		751
		752	=item $handle->rtimeout ($seconds)
		753
		754	=item $handle->wtimeout ($seconds)
		755
499	Configures (or disables) the inactivity timeout.	756	Configures (or disables) the inactivity timeout.
500		757
501	=cut	758	=item $handle->timeout_reset
502		759
503	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 {
504	my ($self, $timeout) = @_;	782	my ($self, $new_value) = @_;
505		783
		784	$new_value >= 0
		785	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		786
506	$self->{timeout} = $timeout;	787	$self->{$timeout} = $new_value;
507	$self->_timeout;	788	delete $self->{$tw}; &$cb;
508	}	789	};
509		790
		791	*{"${dir}timeout_reset"} = sub {
		792	$_[0]{$activity} = AE::now;
		793	};
		794
		795	# main workhorse:
510	# reset the timeout watcher, as neccessary	796	# reset the timeout watcher, as neccessary
511	# also check for time-outs	797	# also check for time-outs
512	sub _timeout {	798	$cb = sub {
513	my ($self) = @_;	799	my ($self) = @_;
514		800
515	if ($self->{timeout}) {	801	if ($self->{$timeout} && $self->{fh}) {
516	my $NOW = AnyEvent->now;	802	my $NOW = AE::now;
517		803
518	# when would the timeout trigger?	804	# when would the timeout trigger?
519	my $after = $self->{_activity} + $self->{timeout} - $NOW;	805	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
520		806
521	# now or in the past already?	807	# now or in the past already?
522	if ($after <= 0) {	808	if ($after <= 0) {
523	$self->{_activity} = $NOW;	809	$self->{$activity} = $NOW;
524		810
525	if ($self->{on_timeout}) {	811	if ($self->{$on_timeout}) {
526	$self->{on_timeout}($self);	812	$self->{$on_timeout}($self);
527	} else {	813	} else {
528	$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};
529	}	822	}
530		823
531	# callback could have changed timeout value, optimise	824	Scalar::Util::weaken $self;
532	return unless $self->{timeout};	825	return unless $self; # ->error could have destroyed $self
533		826
534	# calculate new after	827	$self->{$tw} ||= AE::timer $after, 0, sub {
535	$after = $self->{timeout};	828	delete $self->{$tw};
		829	$cb->($self);
		830	};
		831	} else {
		832	delete $self->{$tw};
536	}	833	}
537
538	Scalar::Util::weaken $self;
539	return unless $self; # ->error could have destroyed $self
540
541	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
542	delete $self->{_tw};
543	$self->_timeout;
544	});
545	} else {
546	delete $self->{_tw};
547	}	834	}
548	}	835	}
549		836
550	#############################################################################	837	#############################################################################
551		838
…		…
566		853
567	=item $handle->on_drain ($cb)	854	=item $handle->on_drain ($cb)
568		855
569	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
570	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).
571		861
572	=cut	862	=cut
573		863
574	sub on_drain {	864	sub on_drain {
575	my ($self, $cb) = @_;	865	my ($self, $cb) = @_;
…		…
584		874
585	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
586	want (only limited by the available memory), as C<AnyEvent::Handle>	876	want (only limited by the available memory), as C<AnyEvent::Handle>
587	buffers it independently of the kernel.	877	buffers it independently of the kernel.
588		878
		879	This method may invoke callbacks (and therefore the handle might be
		880	destroyed after it returns).
		881
589	=cut	882	=cut
590		883
591	sub _drain_wbuf {	884	sub _drain_wbuf {
592	my ($self) = @_;	885	my ($self) = @_;
593		886
…		…
599	my $len = syswrite $self->{fh}, $self->{wbuf};	892	my $len = syswrite $self->{fh}, $self->{wbuf};
600		893
601	if (defined $len) {	894	if (defined $len) {
602	substr $self->{wbuf}, 0, $len, "";	895	substr $self->{wbuf}, 0, $len, "";
603		896
604	$self->{_activity} = AnyEvent->now;	897	$self->{_activity} = $self->{_wactivity} = AE::now;
605		898
606	$self->{on_drain}($self)	899	$self->{on_drain}($self)
607	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})
608	&& $self->{on_drain};	901	&& $self->{on_drain};
609		902
…		…
615		908
616	# try to write data immediately	909	# try to write data immediately
617	$cb->() unless $self->{autocork};	910	$cb->() unless $self->{autocork};
618		911
619	# if still data left in wbuf, we need to poll	912	# if still data left in wbuf, we need to poll
620	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	913	$self->{_ww} = AE::io $self->{fh}, 1, $cb
621	if length $self->{wbuf};	914	if length $self->{wbuf};
622	};	915	};
623	}	916	}
624		917
625	our %WH;	918	our %WH;
626		919
		920	# deprecated
627	sub register_write_type($$) {	921	sub register_write_type($$) {
628	$WH{$_[0]} = $_[1];	922	$WH{$_[0]} = $_[1];
629	}	923	}
630		924
631	sub push_write {	925	sub push_write {
632	my $self = shift;	926	my $self = shift;
633		927
634	if (@_ > 1) {	928	if (@_ > 1) {
635	my $type = shift;	929	my $type = shift;
636		930
		931	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
637	@_ = ($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")
638	->($self, @_);	933	->($self, @_);
639	}	934	}
640		935
		936	# we downgrade here to avoid hard-to-track-down bugs,
		937	# and diagnose the problem earlier and better.
		938
641	if ($self->{tls}) {	939	if ($self->{tls}) {
642	$self->{_tls_wbuf} .= $_[0];	940	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
643		941	&_dotls ($self) if $self->{fh};
644	&_dotls ($self);
645	} else {	942	} else {
646	$self->{wbuf} .= $_[0];	943	utf8::downgrade $self->{wbuf} .= $_[0];
647	$self->_drain_wbuf;	944	$self->_drain_wbuf if $self->{fh};
648	}	945	}
649	}	946	}
650		947
651	=item $handle->push_write (type => @args)	948	=item $handle->push_write (type => @args)
652		949
653	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
654	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).
655		955
656	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
657	drop by and tell us):	957	drop by and tell us):
658		958
659	=over 4	959	=over 4
…		…
716	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
717	this line into their JSON decoder of choice.	1017	this line into their JSON decoder of choice.
718		1018
719	=cut	1019	=cut
720		1020
		1021	sub json_coder() {
		1022	eval { require JSON::XS; JSON::XS->new->utf8 }
		1023	|| do { require JSON; JSON->new->utf8 }
		1024	}
		1025
721	register_write_type json => sub {	1026	register_write_type json => sub {
722	my ($self, $ref) = @_;	1027	my ($self, $ref) = @_;
723		1028
724	require JSON;	1029	my $json = $self->{json} ||= json_coder;
725		1030
726	$self->{json} ? $self->{json}->encode ($ref)	1031	$json->encode ($ref)
727	: JSON::encode_json ($ref)
728	};	1032	};
729		1033
730	=item storable => $reference	1034	=item storable => $reference
731		1035
732	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
…		…
758	the peer.	1062	the peer.
759		1063
760	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
761	afterwards. This is the cleanest way to close a connection.	1065	afterwards. This is the cleanest way to close a connection.
762		1066
		1067	This method may invoke callbacks (and therefore the handle might be
		1068	destroyed after it returns).
		1069
763	=cut	1070	=cut
764		1071
765	sub push_shutdown {	1072	sub push_shutdown {
766	my ($self) = @_;	1073	my ($self) = @_;
767		1074
768	delete $self->{low_water_mark};	1075	delete $self->{low_water_mark};
769	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1076	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
770	}	1077	}
771		1078
772	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1079	=item custom write types - Package::anyevent_write_type $handle, @args
773		1080
774	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
775	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
776	reference with the handle object and the remaining arguments.	1088	the handle object and the remaining arguments.
777		1089
778	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
779	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.
780		1093
781	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
782	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	}
783		1110
784	=cut	1111	=cut
785		1112
786	#############################################################################	1113	#############################################################################
787		1114
…		…
796	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
797	a queue.	1124	a queue.
798		1125
799	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
800	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
801	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
802	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
803	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>.
804		1132
805	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
806	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
807	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
808	done its job (see C<push_read>, below).	1136	done its job (see C<push_read>, below).
809		1137
810	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
811	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.
812		1140
…		…
869	=cut	1197	=cut
870		1198
871	sub _drain_rbuf {	1199	sub _drain_rbuf {
872	my ($self) = @_;	1200	my ($self) = @_;
873		1201
		1202	# avoid recursion
		1203	return if $self->{_skip_drain_rbuf};
874	local $self->{_in_drain} = 1;	1204	local $self->{_skip_drain_rbuf} = 1;
875
876	if (
877	defined $self->{rbuf_max}
878	&& $self->{rbuf_max} < length $self->{rbuf}
879	) {
880	$self->_error (Errno::ENOSPC, 1), return;
881	}
882		1205
883	while () {	1206	while () {
884	# 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
885	# 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.
886	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1209	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1210	if exists $self->{_tls_rbuf};
887		1211
888	my $len = length $self->{rbuf};	1212	my $len = length $self->{rbuf};
889		1213
890	if (my $cb = shift @{ $self->{_queue} }) {	1214	if (my $cb = shift @{ $self->{_queue} }) {
891	unless ($cb->($self)) {	1215	unless ($cb->($self)) {
892	if ($self->{_eof}) {	1216	# no progress can be made
893	# no progress can be made (not enough data and no data forthcoming)	1217	# (not enough data and no data forthcoming)
894	$self->_error (Errno::EPIPE, 1), return;	1218	$self->_error (Errno::EPIPE, 1), return
895	}	1219	if $self->{_eof};
896		1220
897	unshift @{ $self->{_queue} }, $cb;	1221	unshift @{ $self->{_queue} }, $cb;
898	last;	1222	last;
899	}	1223	}
900	} elsif ($self->{on_read}) {	1224	} elsif ($self->{on_read}) {
…		…
920	last;	1244	last;
921	}	1245	}
922	}	1246	}
923		1247
924	if ($self->{_eof}) {	1248	if ($self->{_eof}) {
925	if ($self->{on_eof}) {	1249	$self->{on_eof}
926	$self->{on_eof}($self)	1250	? $self->{on_eof}($self)
927	} else {
928	$self->_error (0, 1, "Unexpected end-of-file");	1251	: $self->_error (0, 1, "Unexpected end-of-file");
929	}	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;
930	}	1261	}
931		1262
932	# may need to restart read watcher	1263	# may need to restart read watcher
933	unless ($self->{_rw}) {	1264	unless ($self->{_rw}) {
934	$self->start_read	1265	$self->start_read
…		…
940		1271
941	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
942	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
943	constructor.	1274	constructor.
944		1275
		1276	This method may invoke callbacks (and therefore the handle might be
		1277	destroyed after it returns).
		1278
945	=cut	1279	=cut
946		1280
947	sub on_read {	1281	sub on_read {
948	my ($self, $cb) = @_;	1282	my ($self, $cb) = @_;
949		1283
950	$self->{on_read} = $cb;	1284	$self->{on_read} = $cb;
951	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1285	$self->_drain_rbuf if $cb;
952	}	1286	}
953		1287
954	=item $handle->rbuf	1288	=item $handle->rbuf
955		1289
956	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).
957		1293
958	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)
959	member, if you want. However, the only operation allowed on the	1295	is removing data from its beginning. Otherwise modifying or appending to
960	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.
961	beginning. Otherwise modifying or appending to it is not allowed and will
962	lead to hard-to-track-down bugs.
963		1297
964	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>
965	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
966	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.
967		1302
968	=cut	1303	=cut
969		1304
970	sub rbuf : lvalue {	1305	sub rbuf : lvalue {
971	$_[0]{rbuf}	1306	$_[0]{rbuf}
…		…
988		1323
989	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
990	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
991	true, it will be removed from the queue.	1326	true, it will be removed from the queue.
992		1327
		1328	These methods may invoke callbacks (and therefore the handle might be
		1329	destroyed after it returns).
		1330
993	=cut	1331	=cut
994		1332
995	our %RH;	1333	our %RH;
996		1334
997	sub register_read_type($$) {	1335	sub register_read_type($$) {
…		…
1003	my $cb = pop;	1341	my $cb = pop;
1004		1342
1005	if (@_) {	1343	if (@_) {
1006	my $type = shift;	1344	my $type = shift;
1007		1345
		1346	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1008	$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")
1009	->($self, $cb, @_);	1348	->($self, $cb, @_);
1010	}	1349	}
1011		1350
1012	push @{ $self->{_queue} }, $cb;	1351	push @{ $self->{_queue} }, $cb;
1013	$self->_drain_rbuf unless $self->{_in_drain};	1352	$self->_drain_rbuf;
1014	}	1353	}
1015		1354
1016	sub unshift_read {	1355	sub unshift_read {
1017	my $self = shift;	1356	my $self = shift;
1018	my $cb = pop;	1357	my $cb = pop;
1019		1358
1020	if (@_) {	1359	if (@_) {
1021	my $type = shift;	1360	my $type = shift;
1022		1361
		1362	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1023	$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")
1024	->($self, $cb, @_);	1364	->($self, $cb, @_);
1025	}	1365	}
1026		1366
1027
1028	unshift @{ $self->{_queue} }, $cb;	1367	unshift @{ $self->{_queue} }, $cb;
1029	$self->_drain_rbuf unless $self->{_in_drain};	1368	$self->_drain_rbuf;
1030	}	1369	}
1031		1370
1032	=item $handle->push_read (type => @args, $cb)	1371	=item $handle->push_read (type => @args, $cb)
1033		1372
1034	=item $handle->unshift_read (type => @args, $cb)	1373	=item $handle->unshift_read (type => @args, $cb)
1035		1374
1036	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
1037	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
1038	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).
1039		1380
1040	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
1041	drop by and tell us):	1382	drop by and tell us):
1042		1383
1043	=over 4	1384	=over 4
…		…
1135	the receive buffer when neither C<$accept> nor C<$reject> match,	1476	the receive buffer when neither C<$accept> nor C<$reject> match,
1136	and everything preceding and including the match will be accepted	1477	and everything preceding and including the match will be accepted
1137	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
1138	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
1139	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
1140	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.
1141		1482
1142	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
1143	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
1144	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
1145	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
1146	required for the accept regex.	1487	required for the accept regex.
1147		1488
1148	$handle->push_read (regex =>	1489	$handle->push_read (regex =>
…		…
1283	=cut	1624	=cut
1284		1625
1285	register_read_type json => sub {	1626	register_read_type json => sub {
1286	my ($self, $cb) = @_;	1627	my ($self, $cb) = @_;
1287		1628
1288	my $json = $self->{json} ||=	1629	my $json = $self->{json} ||= json_coder;
1289	eval { require JSON::XS; JSON::XS->new->utf8 }
1290	|| do { require JSON; JSON->new->utf8 };
1291		1630
1292	my $data;	1631	my $data;
1293	my $rbuf = \$self->{rbuf};	1632	my $rbuf = \$self->{rbuf};
1294		1633
1295	sub {	1634	sub {
…		…
1364	}	1703	}
1365	};	1704	};
1366		1705
1367	=back	1706	=back
1368		1707
1369	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1708	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1370		1709
1371	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).
1372		1715
1373	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
1374	reference with the handle object, the callback and the remaining	1717	handle object, the original callback and the remaining arguments.
1375	arguments.
1376		1718
1377	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
1378	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.
1379		1723
1380	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
1381	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).
1382		1727
1383	Note that this is a function, and all types registered this way will be
1384	global, so try to use unique names.
1385
1386	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
1387	search for C<register_read_type>)).	1729	AnyEvent::Handle>, search for C<register_read_type>)).
1388		1730
1389	=item $handle->stop_read	1731	=item $handle->stop_read
1390		1732
1391	=item $handle->start_read	1733	=item $handle->start_read
1392		1734
…		…
1412	}	1754	}
1413		1755
1414	sub start_read {	1756	sub start_read {
1415	my ($self) = @_;	1757	my ($self) = @_;
1416		1758
1417	unless ($self->{_rw} || $self->{_eof}) {	1759	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1418	Scalar::Util::weaken $self;	1760	Scalar::Util::weaken $self;
1419		1761
1420	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1762	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1421	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1763	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1422	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1764	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1423		1765
1424	if ($len > 0) {	1766	if ($len > 0) {
1425	$self->{_activity} = AnyEvent->now;	1767	$self->{_activity} = $self->{_ractivity} = AE::now;
1426		1768
1427	if ($self->{tls}) {	1769	if ($self->{tls}) {
1428	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1770	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1429		1771
1430	&_dotls ($self);	1772	&_dotls ($self);
1431	} else {	1773	} else {
1432	$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);
1433	}	1781	}
1434		1782
1435	} elsif (defined $len) {	1783	} elsif (defined $len) {
1436	delete $self->{_rw};	1784	delete $self->{_rw};
1437	$self->{_eof} = 1;	1785	$self->{_eof} = 1;
1438	$self->_drain_rbuf unless $self->{_in_drain};	1786	$self->_drain_rbuf;
1439		1787
1440	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1788	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1441	return $self->_error ($!, 1);	1789	return $self->_error ($!, 1);
1442	}	1790	}
1443	});	1791	};
1444	}	1792	}
1445	}	1793	}
1446		1794
1447	our $ERROR_SYSCALL;	1795	our $ERROR_SYSCALL;
1448	our $ERROR_WANT_READ;	1796	our $ERROR_WANT_READ;
…		…
1503	$self->{_eof} = 1;	1851	$self->{_eof} = 1;
1504	}	1852	}
1505	}	1853	}
1506		1854
1507	$self->{_tls_rbuf} .= $tmp;	1855	$self->{_tls_rbuf} .= $tmp;
1508	$self->_drain_rbuf unless $self->{_in_drain};	1856	$self->_drain_rbuf;
1509	$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
1510	}	1858	}
1511		1859
1512	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1860	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1513	return $self->_tls_error ($tmp)	1861	return $self->_tls_error ($tmp)
…		…
1515	&& ($tmp != $ERROR_SYSCALL || $!);	1863	&& ($tmp != $ERROR_SYSCALL || $!);
1516		1864
1517	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1865	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1518	$self->{wbuf} .= $tmp;	1866	$self->{wbuf} .= $tmp;
1519	$self->_drain_wbuf;	1867	$self->_drain_wbuf;
		1868	$self->{tls} or return; # tls session might have gone away in callback
1520	}	1869	}
1521		1870
1522	$self->{_on_starttls}	1871	$self->{_on_starttls}
1523	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1872	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1524	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1873	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1545	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
1546	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
1547	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
1548	when this function returns.	1897	when this function returns.
1549		1898
1550	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
1551	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).
1552		1905
1553	=cut	1906	=cut
1554		1907
1555	our %TLS_CACHE; #TODO not yet documented, should we?	1908	our %TLS_CACHE; #TODO not yet documented, should we?
1556		1909
1557	sub starttls {	1910	sub starttls {
1558	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};
1559		1920
1560	require Net::SSLeay;	1921	require Net::SSLeay;
1561
1562	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1563	if $self->{tls};
1564		1922
1565	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1923	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1566	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1924	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1567		1925
		1926	$tls = delete $self->{tls};
1568	$ctx ||= $self->{tls_ctx};	1927	$ctx = $self->{tls_ctx};
1569		1928
1570	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1929	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1571		1930
1572	if ("HASH" eq ref $ctx) {	1931	if ("HASH" eq ref $ctx) {
1573	require AnyEvent::TLS;	1932	require AnyEvent::TLS;
…		…
1579	$ctx = new AnyEvent::TLS %$ctx;	1938	$ctx = new AnyEvent::TLS %$ctx;
1580	}	1939	}
1581	}	1940	}
1582		1941
1583	$self->{tls_ctx} = $ctx || TLS_CTX ();	1942	$self->{tls_ctx} = $ctx || TLS_CTX ();
1584	$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});
1585		1944
1586	# 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)
1587	# but the openssl maintainers basically said: "trust us, it just works".	1946	# but the openssl maintainers basically said: "trust us, it just works".
1588	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1947	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1589	# and mismaintained ssleay-module doesn't even offer them).	1948	# and mismaintained ssleay-module doesn't even offer them).
…		…
1596	# 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
1597	# have identity issues in that area.	1956	# have identity issues in that area.
1598	# Net::SSLeay::CTX_set_mode ($ssl,	1957	# Net::SSLeay::CTX_set_mode ($ssl,
1599	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1958	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1600	# | (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));
1601	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	1960	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1602		1961
1603	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1962	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1604	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1963	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1605		1964
		1965	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1966
1606	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1967	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1607		1968
1608	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1969	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1609	if $self->{on_starttls};	1970	if $self->{on_starttls};
1610		1971
1611	&_dotls; # need to trigger the initial handshake	1972	&_dotls; # need to trigger the initial handshake
…		…
1614		1975
1615	=item $handle->stoptls	1976	=item $handle->stoptls
1616		1977
1617	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
1618	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
1619	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
1620	afterwards.	1981	the stream afterwards.
		1982
		1983	This method may invoke callbacks (and therefore the handle might be
		1984	destroyed after it returns).
1621		1985
1622	=cut	1986	=cut
1623		1987
1624	sub stoptls {	1988	sub stoptls {
1625	my ($self) = @_;	1989	my ($self) = @_;
1626		1990
1627	if ($self->{tls}) {	1991	if ($self->{tls} && $self->{fh}) {
1628	Net::SSLeay::shutdown ($self->{tls});	1992	Net::SSLeay::shutdown ($self->{tls});
1629		1993
1630	&_dotls;	1994	&_dotls;
1631		1995
1632	# # 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#
…		…
1638	sub _freetls {	2002	sub _freetls {
1639	my ($self) = @_;	2003	my ($self) = @_;
1640		2004
1641	return unless $self->{tls};	2005	return unless $self->{tls};
1642		2006
1643	$self->{tls_ctx}->_put_session (delete $self->{tls});	2007	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2008	if $self->{tls} > 0;
1644		2009
1645	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2010	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1646	}	2011	}
1647		2012
1648	sub DESTROY {	2013	sub DESTROY {
…		…
1656	my $fh = delete $self->{fh};	2021	my $fh = delete $self->{fh};
1657	my $wbuf = delete $self->{wbuf};	2022	my $wbuf = delete $self->{wbuf};
1658		2023
1659	my @linger;	2024	my @linger;
1660		2025
1661	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2026	push @linger, AE::io $fh, 1, sub {
1662	my $len = syswrite $fh, $wbuf, length $wbuf;	2027	my $len = syswrite $fh, $wbuf, length $wbuf;
1663		2028
1664	if ($len > 0) {	2029	if ($len > 0) {
1665	substr $wbuf, 0, $len, "";	2030	substr $wbuf, 0, $len, "";
1666	} else {	2031	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1667	@linger = (); # end	2032	@linger = (); # end
1668	}	2033	}
1669	});	2034	};
1670	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2035	push @linger, AE::timer $linger, 0, sub {
1671	@linger = ();	2036	@linger = ();
1672	});	2037	};
1673	}	2038	}
1674	}	2039	}
1675		2040
1676	=item $handle->destroy	2041	=item $handle->destroy
1677		2042
1678	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
1679	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
1680	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).
1681		2048
1682	Normally, you can just "forget" any references to an AnyEvent::Handle	2049	Normally, you can just "forget" any references to an AnyEvent::Handle
1683	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
1684	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
1685	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
…		…
1699	sub destroy {	2066	sub destroy {
1700	my ($self) = @_;	2067	my ($self) = @_;
1701		2068
1702	$self->DESTROY;	2069	$self->DESTROY;
1703	%$self = ();	2070	%$self = ();
		2071	bless $self, "AnyEvent::Handle::destroyed";
1704	}	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 }
1705		2100
1706	=item AnyEvent::Handle::TLS_CTX	2101	=item AnyEvent::Handle::TLS_CTX
1707		2102
1708	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
1709	for TLS mode.	2104	for TLS mode.
…		…
1741		2136
1742	=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
1743	reading?	2138	reading?
1744		2139
1745	Unlike, say, TCP, TLS connections do not consist of two independent	2140	Unlike, say, TCP, TLS connections do not consist of two independent
1746	communication channels, one for each direction. Or put differently. The	2141	communication channels, one for each direction. Or put differently, the
1747	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
1748	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.
1749		2144
1750	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>
1751	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
1752	is that AnyEvent::Handle always reads in TLS mode.	2147	is that AnyEvent::Handle always reads in TLS mode.
1753		2148
1754	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
1755	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
…		…
1769	my $data = delete $_[0]{rbuf};	2164	my $data = delete $_[0]{rbuf};
1770	});	2165	});
1771		2166
1772	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
1773	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
1774	fact, all data has been received.	2169	fact all data has been received.
1775		2170
1776	It is usually better to use acknowledgements when transferring data,	2171	It is usually better to use acknowledgements when transferring data,
1777	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
1778	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
1779	explicit QUIT command.	2174	explicit QUIT command.
…		…
1796	consider using C<< ->push_shutdown >> instead.	2191	consider using C<< ->push_shutdown >> instead.
1797		2192
1798	=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.
1799		2194
1800	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,
1801	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>
1802	parameter:	2197	parameter:
1803		2198
1804	tcp_connect $host, $port, sub {	2199	tcp_connect $host, $port, sub {
1805	my ($fh) = @_;	2200	my ($fh) = @_;
1806		2201
…		…
1906		2301
1907	=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
1908	are free to use in subclasses.	2303	are free to use in subclasses.
1909		2304
1910	Of course, new versions of AnyEvent::Handle may introduce more "public"	2305	Of course, new versions of AnyEvent::Handle may introduce more "public"
1911	member variables, but thats just life, at least it is documented.	2306	member variables, but that's just life. At least it is documented.
1912		2307
1913	=back	2308	=back
1914		2309
1915	=head1 AUTHOR	2310	=head1 AUTHOR
1916		2311

Diff Legend

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