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

Diff Legend

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