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.147 by root, Thu Jul 9 08:31:16 2009 UTC vs.
Revision 1.203 by root, Sat Oct 16 03:22:10 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.81;
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 unsatisifable) 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 parameter is
…		…
311		442
312	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
313	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>.
314		445
315	Without this callback, handshake failures lead to C<on_error> being	446	Without this callback, handshake failures lead to C<on_error> being
316	called, as normal.	447	called as usual.
317		448
318	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
319	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
320	then call C<< ->starttls >> again.	451	then call C<< ->starttls >> again.
321		452
322	=item on_stoptls => $cb->($handle)	453	=item on_stoptls => $cb->($handle)
323		454
…		…
349		480
350	sub new {	481	sub new {
351	my $class = shift;	482	my $class = shift;
352	my $self = bless { @_ }, $class;	483	my $self = bless { @_ }, $class;
353		484
354	$self->{fh} or Carp::croak "mandatory argument fh is missing";	485	if ($self->{fh}) {
		486	$self->_start;
		487	return unless $self->{fh}; # could be gone by now
		488
		489	} elsif ($self->{connect}) {
		490	require AnyEvent::Socket;
		491
		492	$self->{peername} = $self->{connect}[0]
		493	unless exists $self->{peername};
		494
		495	$self->{_skip_drain_rbuf} = 1;
		496
		497	{
		498	Scalar::Util::weaken (my $self = $self);
		499
		500	$self->{_connect} =
		501	AnyEvent::Socket::tcp_connect (
		502	$self->{connect}[0],
		503	$self->{connect}[1],
		504	sub {
		505	my ($fh, $host, $port, $retry) = @_;
		506
		507	if ($fh) {
		508	$self->{fh} = $fh;
		509
		510	delete $self->{_skip_drain_rbuf};
		511	$self->_start;
		512
		513	$self->{on_connect}
		514	and $self->{on_connect}($self, $host, $port, sub {
		515	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		516	$self->{_skip_drain_rbuf} = 1;
		517	&$retry;
		518	});
		519
		520	} else {
		521	if ($self->{on_connect_error}) {
		522	$self->{on_connect_error}($self, "$!");
		523	$self->destroy;
		524	} else {
		525	$self->_error ($!, 1);
		526	}
		527	}
		528	},
		529	sub {
		530	local $self->{fh} = $_[0];
		531
		532	$self->{on_prepare}
		533	? $self->{on_prepare}->($self)
		534	: ()
		535	}
		536	);
		537	}
		538
		539	} else {
		540	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		541	}
		542
		543	$self
		544	}
		545
		546	sub _start {
		547	my ($self) = @_;
		548
		549	# too many clueless people try to use udp and similar sockets
		550	# with AnyEvent::Handle, do them a favour.
		551	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		552	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		553	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
355		554
356	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	555	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
357		556
		557	$self->{_activity} =
		558	$self->{_ractivity} =
358	$self->{_activity} = AnyEvent->now;	559	$self->{_wactivity} = AE::now;
359	$self->_timeout;
360		560
		561	$self->{read_size} ||= 2048;
		562	$self->{max_read_size} = $self->{read_size}
		563	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		564
		565	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		566	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		567	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		568
361	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	569	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		570	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
362		571
		572	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		573
363	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	574	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
364	if $self->{tls};	575	if $self->{tls};
365		576
366	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	577	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
367		578
368	$self->start_read	579	$self->start_read
369	if $self->{on_read};	580	if $self->{on_read} || @{ $self->{_queue} };
370		581
371	$self->{fh} && $self	582	$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	}	583	}
382		584
383	sub _error {	585	sub _error {
384	my ($self, $errno, $fatal, $message) = @_;	586	my ($self, $errno, $fatal, $message) = @_;
385		587
386	$self->_shutdown
387	if $fatal;
388
389	$! = $errno;	588	$! = $errno;
390	$message ||= "$!";	589	$message ||= "$!";
391		590
392	if ($self->{on_error}) {	591	if ($self->{on_error}) {
393	$self->{on_error}($self, $fatal, $message);	592	$self->{on_error}($self, $fatal, $message);
394	} elsif ($self->{fh}) {	593	$self->destroy if $fatal;
		594	} elsif ($self->{fh} || $self->{connect}) {
		595	$self->destroy;
395	Carp::croak "AnyEvent::Handle uncaught error: $message";	596	Carp::croak "AnyEvent::Handle uncaught error: $message";
396	}	597	}
397	}	598	}
398		599
399	=item $fh = $handle->fh	600	=item $fh = $handle->fh
…		…
424	$_[0]{on_eof} = $_[1];	625	$_[0]{on_eof} = $_[1];
425	}	626	}
426		627
427	=item $handle->on_timeout ($cb)	628	=item $handle->on_timeout ($cb)
428		629
429	Replace the current C<on_timeout> callback, or disables the callback (but	630	=item $handle->on_rtimeout ($cb)
430	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
431	argument and method.
432		631
433	=cut	632	=item $handle->on_wtimeout ($cb)
434		633
435	sub on_timeout {	634	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
436	$_[0]{on_timeout} = $_[1];	635	callback, or disables the callback (but not the timeout) if C<$cb> =
437	}	636	C<undef>. See the C<timeout> constructor argument and method.
		637
		638	=cut
		639
		640	# see below
438		641
439	=item $handle->autocork ($boolean)	642	=item $handle->autocork ($boolean)
440		643
441	Enables or disables the current autocork behaviour (see C<autocork>	644	Enables or disables the current autocork behaviour (see C<autocork>
442	constructor argument). Changes will only take effect on the next write.	645	constructor argument). Changes will only take effect on the next write.
…		…
455	=cut	658	=cut
456		659
457	sub no_delay {	660	sub no_delay {
458	$_[0]{no_delay} = $_[1];	661	$_[0]{no_delay} = $_[1];
459		662
		663	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		664	if $_[0]{fh};
		665	}
		666
		667	=item $handle->keepalive ($boolean)
		668
		669	Enables or disables the C<keepalive> setting (see constructor argument of
		670	the same name for details).
		671
		672	=cut
		673
		674	sub keepalive {
		675	$_[0]{keepalive} = $_[1];
		676
460	eval {	677	eval {
461	local $SIG{__DIE__};	678	local $SIG{__DIE__};
462	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	679	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		680	if $_[0]{fh};
		681	};
		682	}
		683
		684	=item $handle->oobinline ($boolean)
		685
		686	Enables or disables the C<oobinline> setting (see constructor argument of
		687	the same name for details).
		688
		689	=cut
		690
		691	sub oobinline {
		692	$_[0]{oobinline} = $_[1];
		693
		694	eval {
		695	local $SIG{__DIE__};
		696	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		697	if $_[0]{fh};
		698	};
		699	}
		700
		701	=item $handle->keepalive ($boolean)
		702
		703	Enables or disables the C<keepalive> setting (see constructor argument of
		704	the same name for details).
		705
		706	=cut
		707
		708	sub keepalive {
		709	$_[0]{keepalive} = $_[1];
		710
		711	eval {
		712	local $SIG{__DIE__};
		713	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		714	if $_[0]{fh};
463	};	715	};
464	}	716	}
465		717
466	=item $handle->on_starttls ($cb)	718	=item $handle->on_starttls ($cb)
467		719
…		…
477		729
478	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	730	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
479		731
480	=cut	732	=cut
481		733
482	sub on_starttls {	734	sub on_stoptls {
483	$_[0]{on_stoptls} = $_[1];	735	$_[0]{on_stoptls} = $_[1];
484	}	736	}
485		737
		738	=item $handle->rbuf_max ($max_octets)
		739
		740	Configures the C<rbuf_max> setting (C<undef> disables it).
		741
		742	=cut
		743
		744	sub rbuf_max {
		745	$_[0]{rbuf_max} = $_[1];
		746	}
		747
486	#############################################################################	748	#############################################################################
487		749
488	=item $handle->timeout ($seconds)	750	=item $handle->timeout ($seconds)
489		751
		752	=item $handle->rtimeout ($seconds)
		753
		754	=item $handle->wtimeout ($seconds)
		755
490	Configures (or disables) the inactivity timeout.	756	Configures (or disables) the inactivity timeout.
491		757
492	=cut	758	=item $handle->timeout_reset
493		759
494	sub timeout {	760	=item $handle->rtimeout_reset
		761
		762	=item $handle->wtimeout_reset
		763
		764	Reset the activity timeout, as if data was received or sent.
		765
		766	These methods are cheap to call.
		767
		768	=cut
		769
		770	for my $dir ("", "r", "w") {
		771	my $timeout = "${dir}timeout";
		772	my $tw = "_${dir}tw";
		773	my $on_timeout = "on_${dir}timeout";
		774	my $activity = "_${dir}activity";
		775	my $cb;
		776
		777	*$on_timeout = sub {
		778	$_[0]{$on_timeout} = $_[1];
		779	};
		780
		781	*$timeout = sub {
495	my ($self, $timeout) = @_;	782	my ($self, $new_value) = @_;
496		783
		784	$new_value >= 0
		785	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		786
497	$self->{timeout} = $timeout;	787	$self->{$timeout} = $new_value;
498	$self->_timeout;	788	delete $self->{$tw}; &$cb;
499	}	789	};
500		790
		791	*{"${dir}timeout_reset"} = sub {
		792	$_[0]{$activity} = AE::now;
		793	};
		794
		795	# main workhorse:
501	# reset the timeout watcher, as neccessary	796	# reset the timeout watcher, as neccessary
502	# also check for time-outs	797	# also check for time-outs
503	sub _timeout {	798	$cb = sub {
504	my ($self) = @_;	799	my ($self) = @_;
505		800
506	if ($self->{timeout}) {	801	if ($self->{$timeout} && $self->{fh}) {
507	my $NOW = AnyEvent->now;	802	my $NOW = AE::now;
508		803
509	# when would the timeout trigger?	804	# when would the timeout trigger?
510	my $after = $self->{_activity} + $self->{timeout} - $NOW;	805	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
511		806
512	# now or in the past already?	807	# now or in the past already?
513	if ($after <= 0) {	808	if ($after <= 0) {
514	$self->{_activity} = $NOW;	809	$self->{$activity} = $NOW;
515		810
516	if ($self->{on_timeout}) {	811	if ($self->{$on_timeout}) {
517	$self->{on_timeout}($self);	812	$self->{$on_timeout}($self);
518	} else {	813	} else {
519	$self->_error (&Errno::ETIMEDOUT);	814	$self->_error (Errno::ETIMEDOUT);
		815	}
		816
		817	# callback could have changed timeout value, optimise
		818	return unless $self->{$timeout};
		819
		820	# calculate new after
		821	$after = $self->{$timeout};
520	}	822	}
521		823
522	# callback could have changed timeout value, optimise	824	Scalar::Util::weaken $self;
523	return unless $self->{timeout};	825	return unless $self; # ->error could have destroyed $self
524		826
525	# calculate new after	827	$self->{$tw} ||= AE::timer $after, 0, sub {
526	$after = $self->{timeout};	828	delete $self->{$tw};
		829	$cb->($self);
		830	};
		831	} else {
		832	delete $self->{$tw};
527	}	833	}
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	}	834	}
539	}	835	}
540		836
541	#############################################################################	837	#############################################################################
542		838
…		…
557		853
558	=item $handle->on_drain ($cb)	854	=item $handle->on_drain ($cb)
559		855
560	Sets the C<on_drain> callback or clears it (see the description of	856	Sets the C<on_drain> callback or clears it (see the description of
561	C<on_drain> in the constructor).	857	C<on_drain> in the constructor).
		858
		859	This method may invoke callbacks (and therefore the handle might be
		860	destroyed after it returns).
562		861
563	=cut	862	=cut
564		863
565	sub on_drain {	864	sub on_drain {
566	my ($self, $cb) = @_;	865	my ($self, $cb) = @_;
…		…
575		874
576	Queues the given scalar to be written. You can push as much data as you	875	Queues the given scalar to be written. You can push as much data as you
577	want (only limited by the available memory), as C<AnyEvent::Handle>	876	want (only limited by the available memory), as C<AnyEvent::Handle>
578	buffers it independently of the kernel.	877	buffers it independently of the kernel.
579		878
		879	This method may invoke callbacks (and therefore the handle might be
		880	destroyed after it returns).
		881
580	=cut	882	=cut
581		883
582	sub _drain_wbuf {	884	sub _drain_wbuf {
583	my ($self) = @_;	885	my ($self) = @_;
584		886
…		…
590	my $len = syswrite $self->{fh}, $self->{wbuf};	892	my $len = syswrite $self->{fh}, $self->{wbuf};
591		893
592	if (defined $len) {	894	if (defined $len) {
593	substr $self->{wbuf}, 0, $len, "";	895	substr $self->{wbuf}, 0, $len, "";
594		896
595	$self->{_activity} = AnyEvent->now;	897	$self->{_activity} = $self->{_wactivity} = AE::now;
596		898
597	$self->{on_drain}($self)	899	$self->{on_drain}($self)
598	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	900	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
599	&& $self->{on_drain};	901	&& $self->{on_drain};
600		902
…		…
606		908
607	# try to write data immediately	909	# try to write data immediately
608	$cb->() unless $self->{autocork};	910	$cb->() unless $self->{autocork};
609		911
610	# if still data left in wbuf, we need to poll	912	# if still data left in wbuf, we need to poll
611	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	913	$self->{_ww} = AE::io $self->{fh}, 1, $cb
612	if length $self->{wbuf};	914	if length $self->{wbuf};
613	};	915	};
614	}	916	}
615		917
616	our %WH;	918	our %WH;
617		919
		920	# deprecated
618	sub register_write_type($$) {	921	sub register_write_type($$) {
619	$WH{$_[0]} = $_[1];	922	$WH{$_[0]} = $_[1];
620	}	923	}
621		924
622	sub push_write {	925	sub push_write {
623	my $self = shift;	926	my $self = shift;
624		927
625	if (@_ > 1) {	928	if (@_ > 1) {
626	my $type = shift;	929	my $type = shift;
627		930
		931	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
628	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	932	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
629	->($self, @_);	933	->($self, @_);
630	}	934	}
631		935
		936	# we downgrade here to avoid hard-to-track-down bugs,
		937	# and diagnose the problem earlier and better.
		938
632	if ($self->{tls}) {	939	if ($self->{tls}) {
633	$self->{_tls_wbuf} .= $_[0];	940	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
634		941	&_dotls ($self) if $self->{fh};
635	&_dotls ($self);
636	} else {	942	} else {
637	$self->{wbuf} .= $_[0];	943	utf8::downgrade $self->{wbuf} .= $_[0];
638	$self->_drain_wbuf;	944	$self->_drain_wbuf if $self->{fh};
639	}	945	}
640	}	946	}
641		947
642	=item $handle->push_write (type => @args)	948	=item $handle->push_write (type => @args)
643		949
644	Instead of formatting your data yourself, you can also let this module do	950	Instead of formatting your data yourself, you can also let this module
645	the job by specifying a type and type-specific arguments.	951	do the job by specifying a type and type-specific arguments. You
		952	can also specify the (fully qualified) name of a package, in which
		953	case AnyEvent tries to load the package and then expects to find the
		954	C<anyevent_write_type> function inside (see "custom write types", below).
646		955
647	Predefined types are (if you have ideas for additional types, feel free to	956	Predefined types are (if you have ideas for additional types, feel free to
648	drop by and tell us):	957	drop by and tell us):
649		958
650	=over 4	959	=over 4
…		…
707	Other languages could read single lines terminated by a newline and pass	1016	Other languages could read single lines terminated by a newline and pass
708	this line into their JSON decoder of choice.	1017	this line into their JSON decoder of choice.
709		1018
710	=cut	1019	=cut
711		1020
		1021	sub json_coder() {
		1022	eval { require JSON::XS; JSON::XS->new->utf8 }
		1023	|| do { require JSON; JSON->new->utf8 }
		1024	}
		1025
712	register_write_type json => sub {	1026	register_write_type json => sub {
713	my ($self, $ref) = @_;	1027	my ($self, $ref) = @_;
714		1028
715	require JSON;	1029	my $json = $self->{json} ||= json_coder;
716		1030
717	$self->{json} ? $self->{json}->encode ($ref)	1031	$json->encode ($ref)
718	: JSON::encode_json ($ref)
719	};	1032	};
720		1033
721	=item storable => $reference	1034	=item storable => $reference
722		1035
723	Freezes the given reference using L<Storable> and writes it to the	1036	Freezes the given reference using L<Storable> and writes it to the
…		…
749	the peer.	1062	the peer.
750		1063
751	You can rely on the normal read queue and C<on_eof> handling	1064	You can rely on the normal read queue and C<on_eof> handling
752	afterwards. This is the cleanest way to close a connection.	1065	afterwards. This is the cleanest way to close a connection.
753		1066
		1067	This method may invoke callbacks (and therefore the handle might be
		1068	destroyed after it returns).
		1069
754	=cut	1070	=cut
755		1071
756	sub push_shutdown {	1072	sub push_shutdown {
757	my ($self) = @_;	1073	my ($self) = @_;
758		1074
759	delete $self->{low_water_mark};	1075	delete $self->{low_water_mark};
760	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1076	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
761	}	1077	}
762		1078
763	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1079	=item custom write types - Package::anyevent_write_type $handle, @args
764		1080
765	This function (not method) lets you add your own types to C<push_write>.	1081	Instead of one of the predefined types, you can also specify the name of
		1082	a package. AnyEvent will try to load the package and then expects to find
		1083	a function named C<anyevent_write_type> inside. If it isn't found, it
		1084	progressively tries to load the parent package until it either finds the
		1085	function (good) or runs out of packages (bad).
		1086
766	Whenever the given C<type> is used, C<push_write> will invoke the code	1087	Whenever the given C<type> is used, C<push_write> will the function with
767	reference with the handle object and the remaining arguments.	1088	the handle object and the remaining arguments.
768		1089
769	The code reference is supposed to return a single octet string that will	1090	The function is supposed to return a single octet string that will be
770	be appended to the write buffer.	1091	appended to the write buffer, so you cna mentally treat this function as a
		1092	"arguments to on-the-wire-format" converter.
771		1093
772	Note that this is a function, and all types registered this way will be	1094	Example: implement a custom write type C<join> that joins the remaining
773	global, so try to use unique names.	1095	arguments using the first one.
		1096
		1097	$handle->push_write (My::Type => " ", 1,2,3);
		1098
		1099	# uses the following package, which can be defined in the "My::Type" or in
		1100	# the "My" modules to be auto-loaded, or just about anywhere when the
		1101	# My::Type::anyevent_write_type is defined before invoking it.
		1102
		1103	package My::Type;
		1104
		1105	sub anyevent_write_type {
		1106	my ($handle, $delim, @args) = @_;
		1107
		1108	join $delim, @args
		1109	}
774		1110
775	=cut	1111	=cut
776		1112
777	#############################################################################	1113	#############################################################################
778		1114
…		…
787	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1123	ways, the "simple" way, using only C<on_read> and the "complex" way, using
788	a queue.	1124	a queue.
789		1125
790	In the simple case, you just install an C<on_read> callback and whenever	1126	In the simple case, you just install an C<on_read> callback and whenever
791	new data arrives, it will be called. You can then remove some data (if	1127	new data arrives, it will be called. You can then remove some data (if
792	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1128	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
793	leave the data there if you want to accumulate more (e.g. when only a	1129	leave the data there if you want to accumulate more (e.g. when only a
794	partial message has been received so far).	1130	partial message has been received so far), or change the read queue with
		1131	e.g. C<push_read>.
795		1132
796	In the more complex case, you want to queue multiple callbacks. In this	1133	In the more complex case, you want to queue multiple callbacks. In this
797	case, AnyEvent::Handle will call the first queued callback each time new	1134	case, AnyEvent::Handle will call the first queued callback each time new
798	data arrives (also the first time it is queued) and removes it when it has	1135	data arrives (also the first time it is queued) and remove it when it has
799	done its job (see C<push_read>, below).	1136	done its job (see C<push_read>, below).
800		1137
801	This way you can, for example, push three line-reads, followed by reading	1138	This way you can, for example, push three line-reads, followed by reading
802	a chunk of data, and AnyEvent::Handle will execute them in order.	1139	a chunk of data, and AnyEvent::Handle will execute them in order.
803		1140
…		…
860	=cut	1197	=cut
861		1198
862	sub _drain_rbuf {	1199	sub _drain_rbuf {
863	my ($self) = @_;	1200	my ($self) = @_;
864		1201
		1202	# avoid recursion
		1203	return if $self->{_skip_drain_rbuf};
865	local $self->{_in_drain} = 1;	1204	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		1205
874	while () {	1206	while () {
875	# we need to use a separate tls read buffer, as we must not receive data while	1207	# we need to use a separate tls read buffer, as we must not receive data while
876	# we are draining the buffer, and this can only happen with TLS.	1208	# we are draining the buffer, and this can only happen with TLS.
877	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1209	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1210	if exists $self->{_tls_rbuf};
878		1211
879	my $len = length $self->{rbuf};	1212	my $len = length $self->{rbuf};
880		1213
881	if (my $cb = shift @{ $self->{_queue} }) {	1214	if (my $cb = shift @{ $self->{_queue} }) {
882	unless ($cb->($self)) {	1215	unless ($cb->($self)) {
883	if ($self->{_eof}) {	1216	# no progress can be made
884	# no progress can be made (not enough data and no data forthcoming)	1217	# (not enough data and no data forthcoming)
885	$self->_error (&Errno::EPIPE, 1), return;	1218	$self->_error (Errno::EPIPE, 1), return
886	}	1219	if $self->{_eof};
887		1220
888	unshift @{ $self->{_queue} }, $cb;	1221	unshift @{ $self->{_queue} }, $cb;
889	last;	1222	last;
890	}	1223	}
891	} elsif ($self->{on_read}) {	1224	} elsif ($self->{on_read}) {
…		…
898	&& !@{ $self->{_queue} } # and the queue is still empty	1231	&& !@{ $self->{_queue} } # and the queue is still empty
899	&& $self->{on_read} # but we still have on_read	1232	&& $self->{on_read} # but we still have on_read
900	) {	1233	) {
901	# no further data will arrive	1234	# no further data will arrive
902	# so no progress can be made	1235	# so no progress can be made
903	$self->_error (&Errno::EPIPE, 1), return	1236	$self->_error (Errno::EPIPE, 1), return
904	if $self->{_eof};	1237	if $self->{_eof};
905		1238
906	last; # more data might arrive	1239	last; # more data might arrive
907	}	1240	}
908	} else {	1241	} else {
…		…
911	last;	1244	last;
912	}	1245	}
913	}	1246	}
914		1247
915	if ($self->{_eof}) {	1248	if ($self->{_eof}) {
916	if ($self->{on_eof}) {	1249	$self->{on_eof}
917	$self->{on_eof}($self)	1250	? $self->{on_eof}($self)
918	} else {
919	$self->_error (0, 1, "Unexpected end-of-file");	1251	: $self->_error (0, 1, "Unexpected end-of-file");
920	}	1252
		1253	return;
		1254	}
		1255
		1256	if (
		1257	defined $self->{rbuf_max}
		1258	&& $self->{rbuf_max} < length $self->{rbuf}
		1259	) {
		1260	$self->_error (Errno::ENOSPC, 1), return;
921	}	1261	}
922		1262
923	# may need to restart read watcher	1263	# may need to restart read watcher
924	unless ($self->{_rw}) {	1264	unless ($self->{_rw}) {
925	$self->start_read	1265	$self->start_read
…		…
931		1271
932	This replaces the currently set C<on_read> callback, or clears it (when	1272	This replaces the currently set C<on_read> callback, or clears it (when
933	the new callback is C<undef>). See the description of C<on_read> in the	1273	the new callback is C<undef>). See the description of C<on_read> in the
934	constructor.	1274	constructor.
935		1275
		1276	This method may invoke callbacks (and therefore the handle might be
		1277	destroyed after it returns).
		1278
936	=cut	1279	=cut
937		1280
938	sub on_read {	1281	sub on_read {
939	my ($self, $cb) = @_;	1282	my ($self, $cb) = @_;
940		1283
941	$self->{on_read} = $cb;	1284	$self->{on_read} = $cb;
942	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1285	$self->_drain_rbuf if $cb;
943	}	1286	}
944		1287
945	=item $handle->rbuf	1288	=item $handle->rbuf
946		1289
947	Returns the read buffer (as a modifiable lvalue).	1290	Returns the read buffer (as a modifiable lvalue). You can also access the
		1291	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1292	much faster, and no less clean).
948		1293
949	You can access the read buffer directly as the C<< ->{rbuf} >>	1294	The only operation allowed on the read buffer (apart from looking at it)
950	member, if you want. However, the only operation allowed on the	1295	is removing data from its beginning. Otherwise modifying or appending to
951	read buffer (apart from looking at it) is removing data from its	1296	it is not allowed and will lead to hard-to-track-down bugs.
952	beginning. Otherwise modifying or appending to it is not allowed and will
953	lead to hard-to-track-down bugs.
954		1297
955	NOTE: The read buffer should only be used or modified if the C<on_read>,	1298	NOTE: The read buffer should only be used or modified in the C<on_read>
956	C<push_read> or C<unshift_read> methods are used. The other read methods	1299	callback or when C<push_read> or C<unshift_read> are used with a single
957	automatically manage the read buffer.	1300	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1301	will manage the read buffer on their own.
958		1302
959	=cut	1303	=cut
960		1304
961	sub rbuf : lvalue {	1305	sub rbuf : lvalue {
962	$_[0]{rbuf}	1306	$_[0]{rbuf}
…		…
979		1323
980	If enough data was available, then the callback must remove all data it is	1324	If enough data was available, then the callback must remove all data it is
981	interested in (which can be none at all) and return a true value. After returning	1325	interested in (which can be none at all) and return a true value. After returning
982	true, it will be removed from the queue.	1326	true, it will be removed from the queue.
983		1327
		1328	These methods may invoke callbacks (and therefore the handle might be
		1329	destroyed after it returns).
		1330
984	=cut	1331	=cut
985		1332
986	our %RH;	1333	our %RH;
987		1334
988	sub register_read_type($$) {	1335	sub register_read_type($$) {
…		…
994	my $cb = pop;	1341	my $cb = pop;
995		1342
996	if (@_) {	1343	if (@_) {
997	my $type = shift;	1344	my $type = shift;
998		1345
		1346	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
999	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1347	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1000	->($self, $cb, @_);	1348	->($self, $cb, @_);
1001	}	1349	}
1002		1350
1003	push @{ $self->{_queue} }, $cb;	1351	push @{ $self->{_queue} }, $cb;
1004	$self->_drain_rbuf unless $self->{_in_drain};	1352	$self->_drain_rbuf;
1005	}	1353	}
1006		1354
1007	sub unshift_read {	1355	sub unshift_read {
1008	my $self = shift;	1356	my $self = shift;
1009	my $cb = pop;	1357	my $cb = pop;
1010		1358
1011	if (@_) {	1359	if (@_) {
1012	my $type = shift;	1360	my $type = shift;
1013		1361
		1362	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1014	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1363	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1015	->($self, $cb, @_);	1364	->($self, $cb, @_);
1016	}	1365	}
1017		1366
1018
1019	unshift @{ $self->{_queue} }, $cb;	1367	unshift @{ $self->{_queue} }, $cb;
1020	$self->_drain_rbuf unless $self->{_in_drain};	1368	$self->_drain_rbuf;
1021	}	1369	}
1022		1370
1023	=item $handle->push_read (type => @args, $cb)	1371	=item $handle->push_read (type => @args, $cb)
1024		1372
1025	=item $handle->unshift_read (type => @args, $cb)	1373	=item $handle->unshift_read (type => @args, $cb)
1026		1374
1027	Instead of providing a callback that parses the data itself you can chose	1375	Instead of providing a callback that parses the data itself you can chose
1028	between a number of predefined parsing formats, for chunks of data, lines	1376	between a number of predefined parsing formats, for chunks of data, lines
1029	etc.	1377	etc. You can also specify the (fully qualified) name of a package, in
		1378	which case AnyEvent tries to load the package and then expects to find the
		1379	C<anyevent_read_type> function inside (see "custom read types", below).
1030		1380
1031	Predefined types are (if you have ideas for additional types, feel free to	1381	Predefined types are (if you have ideas for additional types, feel free to
1032	drop by and tell us):	1382	drop by and tell us):
1033		1383
1034	=over 4	1384	=over 4
…		…
1126	the receive buffer when neither C<$accept> nor C<$reject> match,	1476	the receive buffer when neither C<$accept> nor C<$reject> match,
1127	and everything preceding and including the match will be accepted	1477	and everything preceding and including the match will be accepted
1128	unconditionally. This is useful to skip large amounts of data that you	1478	unconditionally. This is useful to skip large amounts of data that you
1129	know cannot be matched, so that the C<$accept> or C<$reject> regex do not	1479	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1130	have to start matching from the beginning. This is purely an optimisation	1480	have to start matching from the beginning. This is purely an optimisation
1131	and is usually worth only when you expect more than a few kilobytes.	1481	and is usually worth it only when you expect more than a few kilobytes.
1132		1482
1133	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1483	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1134	expect the header to be very large (it isn't in practise, but...), we use	1484	expect the header to be very large (it isn't in practice, but...), we use
1135	a skip regex to skip initial portions. The skip regex is tricky in that	1485	a skip regex to skip initial portions. The skip regex is tricky in that
1136	it only accepts something not ending in either \015 or \012, as these are	1486	it only accepts something not ending in either \015 or \012, as these are
1137	required for the accept regex.	1487	required for the accept regex.
1138		1488
1139	$handle->push_read (regex =>	1489	$handle->push_read (regex =>
…		…
1158	return 1;	1508	return 1;
1159	}	1509	}
1160		1510
1161	# reject	1511	# reject
1162	if ($reject && $$rbuf =~ $reject) {	1512	if ($reject && $$rbuf =~ $reject) {
1163	$self->_error (&Errno::EBADMSG);	1513	$self->_error (Errno::EBADMSG);
1164	}	1514	}
1165		1515
1166	# skip	1516	# skip
1167	if ($skip && $$rbuf =~ $skip) {	1517	if ($skip && $$rbuf =~ $skip) {
1168	$data .= substr $$rbuf, 0, $+[0], "";	1518	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1184	my ($self, $cb) = @_;	1534	my ($self, $cb) = @_;
1185		1535
1186	sub {	1536	sub {
1187	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1537	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1188	if ($_[0]{rbuf} =~ /[^0-9]/) {	1538	if ($_[0]{rbuf} =~ /[^0-9]/) {
1189	$self->_error (&Errno::EBADMSG);	1539	$self->_error (Errno::EBADMSG);
1190	}	1540	}
1191	return;	1541	return;
1192	}	1542	}
1193		1543
1194	my $len = $1;	1544	my $len = $1;
…		…
1197	my $string = $_[1];	1547	my $string = $_[1];
1198	$_[0]->unshift_read (chunk => 1, sub {	1548	$_[0]->unshift_read (chunk => 1, sub {
1199	if ($_[1] eq ",") {	1549	if ($_[1] eq ",") {
1200	$cb->($_[0], $string);	1550	$cb->($_[0], $string);
1201	} else {	1551	} else {
1202	$self->_error (&Errno::EBADMSG);	1552	$self->_error (Errno::EBADMSG);
1203	}	1553	}
1204	});	1554	});
1205	});	1555	});
1206		1556
1207	1	1557	1
…		…
1274	=cut	1624	=cut
1275		1625
1276	register_read_type json => sub {	1626	register_read_type json => sub {
1277	my ($self, $cb) = @_;	1627	my ($self, $cb) = @_;
1278		1628
1279	my $json = $self->{json} ||=	1629	my $json = $self->{json} ||= json_coder;
1280	eval { require JSON::XS; JSON::XS->new->utf8 }
1281	|| do { require JSON; JSON->new->utf8 };
1282		1630
1283	my $data;	1631	my $data;
1284	my $rbuf = \$self->{rbuf};	1632	my $rbuf = \$self->{rbuf};
1285		1633
1286	sub {	1634	sub {
…		…
1297	$json->incr_skip;	1645	$json->incr_skip;
1298		1646
1299	$self->{rbuf} = $json->incr_text;	1647	$self->{rbuf} = $json->incr_text;
1300	$json->incr_text = "";	1648	$json->incr_text = "";
1301		1649
1302	$self->_error (&Errno::EBADMSG);	1650	$self->_error (Errno::EBADMSG);
1303		1651
1304	()	1652	()
1305	} else {	1653	} else {
1306	$self->{rbuf} = "";	1654	$self->{rbuf} = "";
1307		1655
…		…
1344	# read remaining chunk	1692	# read remaining chunk
1345	$_[0]->unshift_read (chunk => $len, sub {	1693	$_[0]->unshift_read (chunk => $len, sub {
1346	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1694	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1347	$cb->($_[0], $ref);	1695	$cb->($_[0], $ref);
1348	} else {	1696	} else {
1349	$self->_error (&Errno::EBADMSG);	1697	$self->_error (Errno::EBADMSG);
1350	}	1698	}
1351	});	1699	});
1352	}	1700	}
1353		1701
1354	1	1702	1
1355	}	1703	}
1356	};	1704	};
1357		1705
1358	=back	1706	=back
1359		1707
1360	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1708	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1361		1709
1362	This function (not method) lets you add your own types to C<push_read>.	1710	Instead of one of the predefined types, you can also specify the name
		1711	of a package. AnyEvent will try to load the package and then expects to
		1712	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1713	progressively tries to load the parent package until it either finds the
		1714	function (good) or runs out of packages (bad).
1363		1715
1364	Whenever the given C<type> is used, C<push_read> will invoke the code	1716	Whenever this type is used, C<push_read> will invoke the function with the
1365	reference with the handle object, the callback and the remaining	1717	handle object, the original callback and the remaining arguments.
1366	arguments.
1367		1718
1368	The code reference is supposed to return a callback (usually a closure)	1719	The function is supposed to return a callback (usually a closure) that
1369	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1720	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1721	mentally treat the function as a "configurable read type to read callback"
		1722	converter.
1370		1723
1371	It should invoke the passed callback when it is done reading (remember to	1724	It should invoke the original callback when it is done reading (remember
1372	pass C<$handle> as first argument as all other callbacks do that).	1725	to pass C<$handle> as first argument as all other callbacks do that,
		1726	although there is no strict requirement on this).
1373		1727
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>,	1728	For examples, see the source of this module (F<perldoc -m
1378	search for C<register_read_type>)).	1729	AnyEvent::Handle>, search for C<register_read_type>)).
1379		1730
1380	=item $handle->stop_read	1731	=item $handle->stop_read
1381		1732
1382	=item $handle->start_read	1733	=item $handle->start_read
1383		1734
…		…
1403	}	1754	}
1404		1755
1405	sub start_read {	1756	sub start_read {
1406	my ($self) = @_;	1757	my ($self) = @_;
1407		1758
1408	unless ($self->{_rw} || $self->{_eof}) {	1759	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1409	Scalar::Util::weaken $self;	1760	Scalar::Util::weaken $self;
1410		1761
1411	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1762	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1412	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1763	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1413	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1764	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1414		1765
1415	if ($len > 0) {	1766	if ($len > 0) {
1416	$self->{_activity} = AnyEvent->now;	1767	$self->{_activity} = $self->{_ractivity} = AE::now;
1417		1768
1418	if ($self->{tls}) {	1769	if ($self->{tls}) {
1419	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1770	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1420		1771
1421	&_dotls ($self);	1772	&_dotls ($self);
1422	} else {	1773	} else {
1423	$self->_drain_rbuf unless $self->{_in_drain};	1774	$self->_drain_rbuf;
		1775	}
		1776
		1777	if ($len == $self->{read_size}) {
		1778	$self->{read_size} *= 2;
		1779	$self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
		1780	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1424	}	1781	}
1425		1782
1426	} elsif (defined $len) {	1783	} elsif (defined $len) {
1427	delete $self->{_rw};	1784	delete $self->{_rw};
1428	$self->{_eof} = 1;	1785	$self->{_eof} = 1;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1786	$self->_drain_rbuf;
1430		1787
1431	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1788	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1432	return $self->_error ($!, 1);	1789	return $self->_error ($!, 1);
1433	}	1790	}
1434	});	1791	};
1435	}	1792	}
1436	}	1793	}
1437		1794
1438	our $ERROR_SYSCALL;	1795	our $ERROR_SYSCALL;
1439	our $ERROR_WANT_READ;	1796	our $ERROR_WANT_READ;
…		…
1452	if ($self->{_on_starttls}) {	1809	if ($self->{_on_starttls}) {
1453	(delete $self->{_on_starttls})->($self, undef, $err);	1810	(delete $self->{_on_starttls})->($self, undef, $err);
1454	&_freetls;	1811	&_freetls;
1455	} else {	1812	} else {
1456	&_freetls;	1813	&_freetls;
1457	$self->_error (&Errno::EPROTO, 1, $err);	1814	$self->_error (Errno::EPROTO, 1, $err);
1458	}	1815	}
1459	}	1816	}
1460		1817
1461	# poll the write BIO and send the data if applicable	1818	# poll the write BIO and send the data if applicable
1462	# also decode read data if possible	1819	# also decode read data if possible
…		…
1494	$self->{_eof} = 1;	1851	$self->{_eof} = 1;
1495	}	1852	}
1496	}	1853	}
1497		1854
1498	$self->{_tls_rbuf} .= $tmp;	1855	$self->{_tls_rbuf} .= $tmp;
1499	$self->_drain_rbuf unless $self->{_in_drain};	1856	$self->_drain_rbuf;
1500	$self->{tls} or return; # tls session might have gone away in callback	1857	$self->{tls} or return; # tls session might have gone away in callback
1501	}	1858	}
1502		1859
1503	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1860	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1504	return $self->_tls_error ($tmp)	1861	return $self->_tls_error ($tmp)
…		…
1506	&& ($tmp != $ERROR_SYSCALL || $!);	1863	&& ($tmp != $ERROR_SYSCALL || $!);
1507		1864
1508	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1865	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1509	$self->{wbuf} .= $tmp;	1866	$self->{wbuf} .= $tmp;
1510	$self->_drain_wbuf;	1867	$self->_drain_wbuf;
		1868	$self->{tls} or return; # tls session might have gone away in callback
1511	}	1869	}
1512		1870
1513	$self->{_on_starttls}	1871	$self->{_on_starttls}
1514	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1872	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1515	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1873	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1518	=item $handle->starttls ($tls[, $tls_ctx])	1876	=item $handle->starttls ($tls[, $tls_ctx])
1519		1877
1520	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1878	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	1879	object is created, you can also do that at a later time by calling
1522	C<starttls>.	1880	C<starttls>.
		1881
		1882	Starting TLS is currently an asynchronous operation - when you push some
		1883	write data and then call C<< ->starttls >> then TLS negotiation will start
		1884	immediately, after which the queued write data is then sent.
1523		1885
1524	The first argument is the same as the C<tls> constructor argument (either	1886	The first argument is the same as the C<tls> constructor argument (either
1525	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1887	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1526		1888
1527	The second argument is the optional C<AnyEvent::TLS> object that is used	1889	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1532	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1894	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1533	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1895	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1534	changed to your liking. Note that the handshake might have already started	1896	changed to your liking. Note that the handshake might have already started
1535	when this function returns.	1897	when this function returns.
1536		1898
1537	If it an error to start a TLS handshake more than once per	1899	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1538	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1900	handshakes on the same stream. It is best to not attempt to use the
		1901	stream after stopping TLS.
		1902
		1903	This method may invoke callbacks (and therefore the handle might be
		1904	destroyed after it returns).
1539		1905
1540	=cut	1906	=cut
1541		1907
1542	our %TLS_CACHE; #TODO not yet documented, should we?	1908	our %TLS_CACHE; #TODO not yet documented, should we?
1543		1909
1544	sub starttls {	1910	sub starttls {
1545	my ($self, $ssl, $ctx) = @_;	1911	my ($self, $tls, $ctx) = @_;
		1912
		1913	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1914	if $self->{tls};
		1915
		1916	$self->{tls} = $tls;
		1917	$self->{tls_ctx} = $ctx if @_ > 2;
		1918
		1919	return unless $self->{fh};
1546		1920
1547	require Net::SSLeay;	1921	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		1922
1552	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1923	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1553	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1924	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1554		1925
		1926	$tls = delete $self->{tls};
1555	$ctx ||= $self->{tls_ctx};	1927	$ctx = $self->{tls_ctx};
		1928
		1929	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1556		1930
1557	if ("HASH" eq ref $ctx) {	1931	if ("HASH" eq ref $ctx) {
1558	require AnyEvent::TLS;	1932	require AnyEvent::TLS;
1559
1560	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1561		1933
1562	if ($ctx->{cache}) {	1934	if ($ctx->{cache}) {
1563	my $key = $ctx+0;	1935	my $key = $ctx+0;
1564	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;	1936	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1565	} else {	1937	} else {
1566	$ctx = new AnyEvent::TLS %$ctx;	1938	$ctx = new AnyEvent::TLS %$ctx;
1567	}	1939	}
1568	}	1940	}
1569		1941
1570	$self->{tls_ctx} = $ctx || TLS_CTX ();	1942	$self->{tls_ctx} = $ctx || TLS_CTX ();
1571	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1943	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1572		1944
1573	# basically, this is deep magic (because SSL_read should have the same issues)	1945	# basically, this is deep magic (because SSL_read should have the same issues)
1574	# but the openssl maintainers basically said: "trust us, it just works".	1946	# but the openssl maintainers basically said: "trust us, it just works".
1575	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1947	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1576	# and mismaintained ssleay-module doesn't even offer them).	1948	# 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	1955	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1584	# have identity issues in that area.	1956	# have identity issues in that area.
1585	# Net::SSLeay::CTX_set_mode ($ssl,	1957	# Net::SSLeay::CTX_set_mode ($ssl,
1586	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1958	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1587	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1959	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1588	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	1960	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1589		1961
1590	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1962	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1591	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1963	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592		1964
		1965	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1966
1593	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1967	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1594		1968
1595	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1969	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1596	if $self->{on_starttls};	1970	if $self->{on_starttls};
1597		1971
1598	&_dotls; # need to trigger the initial handshake	1972	&_dotls; # need to trigger the initial handshake
…		…
1601		1975
1602	=item $handle->stoptls	1976	=item $handle->stoptls
1603		1977
1604	Shuts down the SSL connection - this makes a proper EOF handshake by	1978	Shuts down the SSL connection - this makes a proper EOF handshake by
1605	sending a close notify to the other side, but since OpenSSL doesn't	1979	sending a close notify to the other side, but since OpenSSL doesn't
1606	support non-blocking shut downs, it is not possible to re-use the stream	1980	support non-blocking shut downs, it is not guaranteed that you can re-use
1607	afterwards.	1981	the stream afterwards.
		1982
		1983	This method may invoke callbacks (and therefore the handle might be
		1984	destroyed after it returns).
1608		1985
1609	=cut	1986	=cut
1610		1987
1611	sub stoptls {	1988	sub stoptls {
1612	my ($self) = @_;	1989	my ($self) = @_;
1613		1990
1614	if ($self->{tls}) {	1991	if ($self->{tls} && $self->{fh}) {
1615	Net::SSLeay::shutdown ($self->{tls});	1992	Net::SSLeay::shutdown ($self->{tls});
1616		1993
1617	&_dotls;	1994	&_dotls;
1618		1995
1619	# # we don't give a shit. no, we do, but we can't. no...#d#	1996	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1625	sub _freetls {	2002	sub _freetls {
1626	my ($self) = @_;	2003	my ($self) = @_;
1627		2004
1628	return unless $self->{tls};	2005	return unless $self->{tls};
1629		2006
1630	$self->{tls_ctx}->_put_session (delete $self->{tls});	2007	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2008	if $self->{tls} > 0;
1631		2009
1632	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2010	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1633	}	2011	}
1634		2012
1635	sub DESTROY {	2013	sub DESTROY {
…		…
1637		2015
1638	&_freetls;	2016	&_freetls;
1639		2017
1640	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	2018	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1641		2019
1642	if ($linger && length $self->{wbuf}) {	2020	if ($linger && length $self->{wbuf} && $self->{fh}) {
1643	my $fh = delete $self->{fh};	2021	my $fh = delete $self->{fh};
1644	my $wbuf = delete $self->{wbuf};	2022	my $wbuf = delete $self->{wbuf};
1645		2023
1646	my @linger;	2024	my @linger;
1647		2025
1648	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2026	push @linger, AE::io $fh, 1, sub {
1649	my $len = syswrite $fh, $wbuf, length $wbuf;	2027	my $len = syswrite $fh, $wbuf, length $wbuf;
1650		2028
1651	if ($len > 0) {	2029	if ($len > 0) {
1652	substr $wbuf, 0, $len, "";	2030	substr $wbuf, 0, $len, "";
1653	} else {	2031	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1654	@linger = (); # end	2032	@linger = (); # end
1655	}	2033	}
1656	});	2034	};
1657	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2035	push @linger, AE::timer $linger, 0, sub {
1658	@linger = ();	2036	@linger = ();
1659	});	2037	};
1660	}	2038	}
1661	}	2039	}
1662		2040
1663	=item $handle->destroy	2041	=item $handle->destroy
1664		2042
1665	Shuts down the handle object as much as possible - this call ensures that	2043	Shuts down the handle object as much as possible - this call ensures that
1666	no further callbacks will be invoked and as many resources as possible	2044	no further callbacks will be invoked and as many resources as possible
1667	will be freed. You must not call any methods on the object afterwards.	2045	will be freed. Any method you will call on the handle object after
		2046	destroying it in this way will be silently ignored (and it will return the
		2047	empty list).
1668		2048
1669	Normally, you can just "forget" any references to an AnyEvent::Handle	2049	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	2050	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	2051	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	2052	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	2053	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1674	that case.	2054	that case.
1675		2055
		2056	Destroying the handle object in this way has the advantage that callbacks
		2057	will be removed as well, so if those are the only reference holders (as
		2058	is common), then one doesn't need to do anything special to break any
		2059	reference cycles.
		2060
1676	The handle might still linger in the background and write out remaining	2061	The handle might still linger in the background and write out remaining
1677	data, as specified by the C<linger> option, however.	2062	data, as specified by the C<linger> option, however.
1678		2063
1679	=cut	2064	=cut
1680		2065
1681	sub destroy {	2066	sub destroy {
1682	my ($self) = @_;	2067	my ($self) = @_;
1683		2068
1684	$self->DESTROY;	2069	$self->DESTROY;
1685	%$self = ();	2070	%$self = ();
		2071	bless $self, "AnyEvent::Handle::destroyed";
1686	}	2072	}
		2073
		2074	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2075	#nop
		2076	}
		2077
		2078	=item $handle->destroyed
		2079
		2080	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2081	->destroy >>, true otherwise.
		2082
		2083	Can be useful to decide whether the handle is still valid after some
		2084	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2085	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2086	can destroy the handle, so work can be avoided by checking sometimes:
		2087
		2088	$hdl->starttls ("accept");
		2089	return if $hdl->destroyed;
		2090	$hdl->push_write (...
		2091
		2092	Note that the call to C<push_write> will silently be ignored if the handle
		2093	has been destroyed, so often you can just ignore the possibility of the
		2094	handle being destroyed.
		2095
		2096	=cut
		2097
		2098	sub destroyed { 0 }
		2099	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1687		2100
1688	=item AnyEvent::Handle::TLS_CTX	2101	=item AnyEvent::Handle::TLS_CTX
1689		2102
1690	This function creates and returns the AnyEvent::TLS object used by default	2103	This function creates and returns the AnyEvent::TLS object used by default
1691	for TLS mode.	2104	for TLS mode.
…		…
1723		2136
1724	=item I get different callback invocations in TLS mode/Why can't I pause	2137	=item I get different callback invocations in TLS mode/Why can't I pause
1725	reading?	2138	reading?
1726		2139
1727	Unlike, say, TCP, TLS connections do not consist of two independent	2140	Unlike, say, TCP, TLS connections do not consist of two independent
1728	communication channels, one for each direction. Or put differently. The	2141	communication channels, one for each direction. Or put differently, the
1729	read and write directions are not independent of each other: you cannot	2142	read and write directions are not independent of each other: you cannot
1730	write data unless you are also prepared to read, and vice versa.	2143	write data unless you are also prepared to read, and vice versa.
1731		2144
1732	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2145	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1733	callback invocations when you are not expecting any read data - the reason	2146	callback invocations when you are not expecting any read data - the reason
1734	is that AnyEvent::Handle always reads in TLS mode.	2147	is that AnyEvent::Handle always reads in TLS mode.
1735		2148
1736	During the connection, you have to make sure that you always have a	2149	During the connection, you have to make sure that you always have a
1737	non-empty read-queue, or an C<on_read> watcher. At the end of the	2150	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1747		2160
1748	$handle->on_read (sub { });	2161	$handle->on_read (sub { });
1749	$handle->on_eof (undef);	2162	$handle->on_eof (undef);
1750	$handle->on_error (sub {	2163	$handle->on_error (sub {
1751	my $data = delete $_[0]{rbuf};	2164	my $data = delete $_[0]{rbuf};
1752	undef $handle;
1753	});	2165	});
1754		2166
1755	The reason to use C<on_error> is that TCP connections, due to latencies	2167	The reason to use C<on_error> is that TCP connections, due to latencies
1756	and packets loss, might get closed quite violently with an error, when in	2168	and packets loss, might get closed quite violently with an error, when in
1757	fact, all data has been received.	2169	fact all data has been received.
1758		2170
1759	It is usually better to use acknowledgements when transferring data,	2171	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	2172	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	2173	intact. This is also one reason why so many internet protocols have an
1762	explicit QUIT command.	2174	explicit QUIT command.
…		…
1779	consider using C<< ->push_shutdown >> instead.	2191	consider using C<< ->push_shutdown >> instead.
1780		2192
1781	=item I want to contact a TLS/SSL server, I don't care about security.	2193	=item I want to contact a TLS/SSL server, I don't care about security.
1782		2194
1783	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	2195	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1784	simply connect to it and then create the AnyEvent::Handle with the C<tls>	2196	connect to it and then create the AnyEvent::Handle with the C<tls>
1785	parameter:	2197	parameter:
1786		2198
1787	tcp_connect $host, $port, sub {	2199	tcp_connect $host, $port, sub {
1788	my ($fh) = @_;	2200	my ($fh) = @_;
1789		2201
…		…
1889		2301
1890	=item * all members not documented here and not prefixed with an underscore	2302	=item * all members not documented here and not prefixed with an underscore
1891	are free to use in subclasses.	2303	are free to use in subclasses.
1892		2304
1893	Of course, new versions of AnyEvent::Handle may introduce more "public"	2305	Of course, new versions of AnyEvent::Handle may introduce more "public"
1894	member variables, but thats just life, at least it is documented.	2306	member variables, but that's just life. At least it is documented.
1895		2307
1896	=back	2308	=back
1897		2309
1898	=head1 AUTHOR	2310	=head1 AUTHOR
1899		2311

Diff Legend

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