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.149 by root, Thu Jul 16 03:48:33 2009 UTC vs.
Revision 1.206 by root, Mon Nov 15 19:49:31 2010 UTC

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

Diff Legend

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