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.108 by root, Tue Jan 6 20:08:05 2009 UTC vs.
Revision 1.211 by root, Fri Dec 31 04:47:41 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.331;
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 B<new (%args)>	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69		87
70	The constructor supports these arguments (all as 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 (you can access that
		120	file handle via C<< $handle->{fh} >>). It could be used to prepare the
		121	file handle with parameters required for the actual connect (as opposed to
		122	settings that can be changed when the connection is already established).
		123
		124	The return value of this callback should be the connect timeout value in
		125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
		126	default timeout is to be used).
		127
		128	=item on_connect => $cb->($handle, $host, $port, $retry->())
		129
		130	This callback is called when a connection has been successfully established.
		131
		132	The peer's numeric host and port (the socket peername) are passed as
		133	parameters, together with a retry callback.
		134
		135	If, for some reason, the handle is not acceptable, calling C<$retry>
		136	will continue with the next connection target (in case of multi-homed
		137	hosts or SRV records there can be multiple connection endpoints). At the
		138	time it is called the read and write queues, eof status, tls status and
		139	similar properties of the handle will have been reset.
		140
		141	In most cases, you should ignore the C<$retry> parameter.
		142
		143	=item on_connect_error => $cb->($handle, $message)
		144
		145	This callback is called when the connection could not be
		146	established. C<$!> will contain the relevant error code, and C<$message> a
		147	message describing it (usually the same as C<"$!">).
		148
		149	If this callback isn't specified, then C<on_error> will be called with a
		150	fatal error instead.
		151
		152	=back
		153
		154	=item on_error => $cb->($handle, $fatal, $message)
		155
		156	This is the error callback, which is called when, well, some error
		157	occured, such as not being able to resolve the hostname, failure to
		158	connect, or a read error.
		159
		160	Some errors are fatal (which is indicated by C<$fatal> being true). On
		161	fatal errors the handle object will be destroyed (by a call to C<< ->
		162	destroy >>) after invoking the error callback (which means you are free to
		163	examine the handle object). Examples of fatal errors are an EOF condition
		164	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
		165	cases where the other side can close the connection at will, it is
		166	often easiest to not report C<EPIPE> errors in this callback.
		167
		168	AnyEvent::Handle tries to find an appropriate error code for you to check
		169	against, but in some cases (TLS errors), this does not work well. It is
		170	recommended to always output the C<$message> argument in human-readable
		171	error messages (it's usually the same as C<"$!">).
		172
		173	Non-fatal errors can be retried by returning, but it is recommended
		174	to simply ignore this parameter and instead abondon the handle object
		175	when this callback is invoked. Examples of non-fatal errors are timeouts
		176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		177
		178	On entry to the callback, the value of C<$!> contains the operating
		179	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		180	C<EPROTO>).
		181
		182	While not mandatory, it is I<highly> recommended to set this callback, as
		183	you will not be notified of errors otherwise. The default just calls
		184	C<croak>.
		185
		186	=item on_read => $cb->($handle)
		187
		188	This sets the default read callback, which is called when data arrives
		189	and no read request is in the queue (unlike read queue callbacks, this
		190	callback will only be called when at least one octet of data is in the
		191	read buffer).
		192
		193	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		194	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		195	must not enlarge or modify the read buffer, you can only remove data at
		196	the beginning from it.
		197
		198	You can also call C<< ->push_read (...) >> or any other function that
		199	modifies the read queue. Or do both. Or ...
		200
		201	When an EOF condition is detected, AnyEvent::Handle will first try to
		202	feed all the remaining data to the queued callbacks and C<on_read> before
		203	calling the C<on_eof> callback. If no progress can be made, then a fatal
		204	error will be raised (with C<$!> set to C<EPIPE>).
		205
		206	Note that, unlike requests in the read queue, an C<on_read> callback
		207	doesn't mean you I<require> some data: if there is an EOF and there
		208	are outstanding read requests then an error will be flagged. With an
		209	C<on_read> callback, the C<on_eof> callback will be invoked.
		210
82	=item on_eof => $cb->($handle)	211	=item on_eof => $cb->($handle)
83		212
84	Set the callback to be called when an end-of-file condition is detected,	213	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	214	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	215	connection cleanly, and there are no outstanding read requests in the
		216	queue (if there are read requests, then an EOF counts as an unexpected
		217	connection close and will be flagged as an error).
87		218
88	For sockets, this just means that the other side has stopped sending data,	219	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	220	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	221	callback and continue writing data, as only the read part has been shut
91	down.	222	down.
92		223
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	224	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	225	set, then a fatal error will be raised with C<$!> set to <0>.
99		226
100	=item on_error => $cb->($handle, $fatal)
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	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116
117	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
119
120	While not mandatory, it is I<highly> recommended to set this callback, as
121	you will not be notified of errors otherwise. The default simply calls
122	C<croak>.
123
124	=item on_read => $cb->($handle)
125
126	This sets the default read callback, which is called when data arrives
127	and no read request is in the queue (unlike read queue callbacks, this
128	callback will only be called when at least one octet of data is in the
129	read buffer).
130
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly.
133
134	When an EOF condition is detected then AnyEvent::Handle will first try to
135	feed all the remaining data to the queued callbacks and C<on_read> before
136	calling the C<on_eof> callback. If no progress can be made, then a fatal
137	error will be raised (with C<$!> set to C<EPIPE>).
138
139	=item on_drain => $cb->($handle)	227	=item on_drain => $cb->($handle)
140		228
141	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
142	(or when the callback is set and the buffer is empty already).	230	(or immediately if the buffer is empty already).
143		231
144	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.
145		233
146	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
147	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
…		…
149	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
150	the file when the write queue becomes empty.	238	the file when the write queue becomes empty.
151		239
152	=item timeout => $fractional_seconds	240	=item timeout => $fractional_seconds
153		241
		242	=item rtimeout => $fractional_seconds
		243
		244	=item wtimeout => $fractional_seconds
		245
154	If non-zero, then this enables an "inactivity" timeout: whenever this many	246	If non-zero, then these enables an "inactivity" timeout: whenever this
155	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
156	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
157	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).
158		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
159	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
160	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
161	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
162	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
163	restart the timeout.	262	restart the timeout.
164		263
165	Zero (the default) disables this timeout.	264	Zero (the default) disables this timeout.
166		265
…		…
180	be configured to accept only so-and-so much data that it cannot act on	279	be configured to accept only so-and-so much data that it cannot act on
181	(for example, when expecting a line, an attacker could send an unlimited	280	(for example, when expecting a line, an attacker could send an unlimited
182	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
183	isn't finished).	282	isn't finished).
184		283
		284	=item wbuf_max => <bytes>
		285
		286	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
		287	when the write buffer ever (strictly) exceeds this size. This is useful to
		288	avoid some forms of denial-of-service attacks.
		289
		290	Although the units of this parameter is bytes, this is the I<raw> number
		291	of bytes not yet accepted by the kernel. This can make a difference when
		292	you e.g. use TLS, as TLS typically makes your write data larger (but it
		293	can also make it smaller due to compression).
		294
		295	As an example of when this limit is useful, take a chat server that sends
		296	chat messages to a client. If the client does not read those in a timely
		297	manner then the send buffer in the server would grow unbounded.
		298
185	=item autocork => <boolean>	299	=item autocork => <boolean>
186		300
187	When disabled (the default), then C<push_write> will try to immediately	301	When disabled (the default), C<push_write> will try to immediately
188	write the data to the handle, if possible. This avoids having to register	302	write the data to the handle if possible. This avoids having to register
189	a write watcher and wait for the next event loop iteration, but can	303	a write watcher and wait for the next event loop iteration, but can
190	be inefficient if you write multiple small chunks (on the wire, this	304	be inefficient if you write multiple small chunks (on the wire, this
191	disadvantage is usually avoided by your kernel's nagle algorithm, see	305	disadvantage is usually avoided by your kernel's nagle algorithm, see
192	C<no_delay>, but this option can save costly syscalls).	306	C<no_delay>, but this option can save costly syscalls).
193		307
194	When enabled, then writes will always be queued till the next event loop	308	When enabled, writes will always be queued till the next event loop
195	iteration. This is efficient when you do many small writes per iteration,	309	iteration. This is efficient when you do many small writes per iteration,
196	but less efficient when you do a single write only per iteration (or when	310	but less efficient when you do a single write only per iteration (or when
197	the write buffer often is full). It also increases write latency.	311	the write buffer often is full). It also increases write latency.
198		312
199	=item no_delay => <boolean>	313	=item no_delay => <boolean>
…		…
203	the Nagle algorithm, and usually it is beneficial.	317	the Nagle algorithm, and usually it is beneficial.
204		318
205	In some situations you want as low a delay as possible, which can be	319	In some situations you want as low a delay as possible, which can be
206	accomplishd by setting this option to a true value.	320	accomplishd by setting this option to a true value.
207		321
208	The default is your opertaing system's default behaviour (most likely	322	The default is your operating system's default behaviour (most likely
209	enabled), this option explicitly enables or disables it, if possible.	323	enabled). This option explicitly enables or disables it, if possible.
		324
		325	=item keepalive => <boolean>
		326
		327	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		328	normally, TCP connections have no time-out once established, so TCP
		329	connections, once established, can stay alive forever even when the other
		330	side has long gone. TCP keepalives are a cheap way to take down long-lived
		331	TCP connections when the other side becomes unreachable. While the default
		332	is OS-dependent, TCP keepalives usually kick in after around two hours,
		333	and, if the other side doesn't reply, take down the TCP connection some 10
		334	to 15 minutes later.
		335
		336	It is harmless to specify this option for file handles that do not support
		337	keepalives, and enabling it on connections that are potentially long-lived
		338	is usually a good idea.
		339
		340	=item oobinline => <boolean>
		341
		342	BSD majorly fucked up the implementation of TCP urgent data. The result
		343	is that almost no OS implements TCP according to the specs, and every OS
		344	implements it slightly differently.
		345
		346	If you want to handle TCP urgent data, then setting this flag (the default
		347	is enabled) gives you the most portable way of getting urgent data, by
		348	putting it into the stream.
		349
		350	Since BSD emulation of OOB data on top of TCP's urgent data can have
		351	security implications, AnyEvent::Handle sets this flag automatically
		352	unless explicitly specified. Note that setting this flag after
		353	establishing a connection I<may> be a bit too late (data loss could
		354	already have occured on BSD systems), but at least it will protect you
		355	from most attacks.
210		356
211	=item read_size => <bytes>	357	=item read_size => <bytes>
212		358
213	The default read block size (the amount of bytes this module will	359	The initial read block size, the number of bytes this module will try to
214	try to read during each loop iteration, which affects memory	360	read during each loop iteration. Each handle object will consume at least
215	requirements). Default: C<8192>.	361	this amount of memory for the read buffer as well, so when handling many
		362	connections requirements). See also C<max_read_size>. Default: C<2048>.
		363
		364	=item max_read_size => <bytes>
		365
		366	The maximum read buffer size used by the dynamic adjustment
		367	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
		368	one go it will double C<read_size> up to the maximum given by this
		369	option. Default: C<131072> or C<read_size>, whichever is higher.
216		370
217	=item low_water_mark => <bytes>	371	=item low_water_mark => <bytes>
218		372
219	Sets the amount of bytes (default: C<0>) that make up an "empty" write	373	Sets the number of bytes (default: C<0>) that make up an "empty" write
220	buffer: If the write reaches this size or gets even samller it is	374	buffer: If the buffer reaches this size or gets even samller it is
221	considered empty.	375	considered empty.
222		376
223	Sometimes it can be beneficial (for performance reasons) to add data to	377	Sometimes it can be beneficial (for performance reasons) to add data to
224	the write buffer before it is fully drained, but this is a rare case, as	378	the write buffer before it is fully drained, but this is a rare case, as
225	the operating system kernel usually buffers data as well, so the default	379	the operating system kernel usually buffers data as well, so the default
226	is good in almost all cases.	380	is good in almost all cases.
227		381
228	=item linger => <seconds>	382	=item linger => <seconds>
229		383
230	If non-zero (default: C<3600>), then the destructor of the	384	If this is non-zero (default: C<3600>), the destructor of the
231	AnyEvent::Handle object will check whether there is still outstanding	385	AnyEvent::Handle object will check whether there is still outstanding
232	write data and will install a watcher that will write this data to the	386	write data and will install a watcher that will write this data to the
233	socket. No errors will be reported (this mostly matches how the operating	387	socket. No errors will be reported (this mostly matches how the operating
234	system treats outstanding data at socket close time).	388	system treats outstanding data at socket close time).
235		389
236	This will not work for partial TLS data that could not be encoded	390	This will not work for partial TLS data that could not be encoded
237	yet. This data will be lost. Calling the C<stoptls> method in time might	391	yet. This data will be lost. Calling the C<stoptls> method in time might
238	help.	392	help.
239		393
		394	=item peername => $string
		395
		396	A string used to identify the remote site - usually the DNS hostname
		397	(I<not> IDN!) used to create the connection, rarely the IP address.
		398
		399	Apart from being useful in error messages, this string is also used in TLS
		400	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		401	verification will be skipped when C<peername> is not specified or is
		402	C<undef>.
		403
240	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	404	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
241		405
242	When this parameter is given, it enables TLS (SSL) mode, that means	406	When this parameter is given, it enables TLS (SSL) mode, that means
243	AnyEvent will start a TLS handshake as soon as the conenction has been	407	AnyEvent will start a TLS handshake as soon as the connection has been
244	established and will transparently encrypt/decrypt data afterwards.	408	established and will transparently encrypt/decrypt data afterwards.
		409
		410	All TLS protocol errors will be signalled as C<EPROTO>, with an
		411	appropriate error message.
245		412
246	TLS mode requires Net::SSLeay to be installed (it will be loaded	413	TLS mode requires Net::SSLeay to be installed (it will be loaded
247	automatically when you try to create a TLS handle): this module doesn't	414	automatically when you try to create a TLS handle): this module doesn't
248	have a dependency on that module, so if your module requires it, you have	415	have a dependency on that module, so if your module requires it, you have
249	to add the dependency yourself.	416	to add the dependency yourself.
…		…
253	mode.	420	mode.
254		421
255	You can also provide your own TLS connection object, but you have	422	You can also provide your own TLS connection object, but you have
256	to make sure that you call either C<Net::SSLeay::set_connect_state>	423	to make sure that you call either C<Net::SSLeay::set_connect_state>
257	or C<Net::SSLeay::set_accept_state> on it before you pass it to	424	or C<Net::SSLeay::set_accept_state> on it before you pass it to
258	AnyEvent::Handle.	425	AnyEvent::Handle. Also, this module will take ownership of this connection
		426	object.
259		427
		428	At some future point, AnyEvent::Handle might switch to another TLS
		429	implementation, then the option to use your own session object will go
		430	away.
		431
		432	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		433	passing in the wrong integer will lead to certain crash. This most often
		434	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		435	segmentation fault.
		436
260	See the C<< ->starttls >> method for when need to start TLS negotiation later.	437	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
261		438
262	=item tls_ctx => $ssl_ctx	439	=item tls_ctx => $anyevent_tls
263		440
264	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	441	Use the given C<AnyEvent::TLS> object to create the new TLS connection
265	(unless a connection object was specified directly). If this parameter is	442	(unless a connection object was specified directly). If this
266	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	443	parameter is missing (or C<undef>), then AnyEvent::Handle will use
		444	C<AnyEvent::Handle::TLS_CTX>.
		445
		446	Instead of an object, you can also specify a hash reference with C<< key
		447	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		448	new TLS context object.
		449
		450	=item on_starttls => $cb->($handle, $success[, $error_message])
		451
		452	This callback will be invoked when the TLS/SSL handshake has finished. If
		453	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		454	(C<on_stoptls> will not be called in this case).
		455
		456	The session in C<< $handle->{tls} >> can still be examined in this
		457	callback, even when the handshake was not successful.
		458
		459	TLS handshake failures will not cause C<on_error> to be invoked when this
		460	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		461
		462	Without this callback, handshake failures lead to C<on_error> being
		463	called as usual.
		464
		465	Note that you cannot just call C<starttls> again in this callback. If you
		466	need to do that, start an zero-second timer instead whose callback can
		467	then call C<< ->starttls >> again.
		468
		469	=item on_stoptls => $cb->($handle)
		470
		471	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		472	set, then it will be invoked after freeing the TLS session. If it is not,
		473	then a TLS shutdown condition will be treated like a normal EOF condition
		474	on the handle.
		475
		476	The session in C<< $handle->{tls} >> can still be examined in this
		477	callback.
		478
		479	This callback will only be called on TLS shutdowns, not when the
		480	underlying handle signals EOF.
267		481
268	=item json => JSON or JSON::XS object	482	=item json => JSON or JSON::XS object
269		483
270	This is the json coder object used by the C<json> read and write types.	484	This is the json coder object used by the C<json> read and write types.
271		485
…		…
280		494
281	=cut	495	=cut
282		496
283	sub new {	497	sub new {
284	my $class = shift;	498	my $class = shift;
285
286	my $self = bless { @_ }, $class;	499	my $self = bless { @_ }, $class;
287		500
288	$self->{fh} or Carp::croak "mandatory argument fh is missing";	501	if ($self->{fh}) {
		502	$self->_start;
		503	return unless $self->{fh}; # could be gone by now
		504
		505	} elsif ($self->{connect}) {
		506	require AnyEvent::Socket;
		507
		508	$self->{peername} = $self->{connect}[0]
		509	unless exists $self->{peername};
		510
		511	$self->{_skip_drain_rbuf} = 1;
		512
		513	{
		514	Scalar::Util::weaken (my $self = $self);
		515
		516	$self->{_connect} =
		517	AnyEvent::Socket::tcp_connect (
		518	$self->{connect}[0],
		519	$self->{connect}[1],
		520	sub {
		521	my ($fh, $host, $port, $retry) = @_;
		522
		523	delete $self->{_connect}; # no longer needed
		524
		525	if ($fh) {
		526	$self->{fh} = $fh;
		527
		528	delete $self->{_skip_drain_rbuf};
		529	$self->_start;
		530
		531	$self->{on_connect}
		532	and $self->{on_connect}($self, $host, $port, sub {
		533	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		534	$self->{_skip_drain_rbuf} = 1;
		535	&$retry;
		536	});
		537
		538	} else {
		539	if ($self->{on_connect_error}) {
		540	$self->{on_connect_error}($self, "$!");
		541	$self->destroy;
		542	} else {
		543	$self->_error ($!, 1);
		544	}
		545	}
		546	},
		547	sub {
		548	local $self->{fh} = $_[0];
		549
		550	$self->{on_prepare}
		551	? $self->{on_prepare}->($self)
		552	: ()
		553	}
		554	);
		555	}
		556
		557	} else {
		558	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		559	}
		560
		561	$self
		562	}
		563
		564	sub _start {
		565	my ($self) = @_;
		566
		567	# too many clueless people try to use udp and similar sockets
		568	# with AnyEvent::Handle, do them a favour.
		569	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		570	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		571	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
289		572
290	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	573	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
291		574
		575	$self->{_activity} =
		576	$self->{_ractivity} =
		577	$self->{_wactivity} = AE::now;
		578
		579	$self->{read_size} ||= 2048;
		580	$self->{max_read_size} = $self->{read_size}
		581	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		582
		583	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		584	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		585	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		586
		587	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		588	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
		589
		590	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		591
292	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	592	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
293	if $self->{tls};	593	if $self->{tls};
294		594
295	$self->{_activity} = AnyEvent->now;
296	$self->_timeout;
297
298	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	595	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
299	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
300		596
301	$self->start_read	597	$self->start_read
302	if $self->{on_read};	598	if $self->{on_read} || @{ $self->{_queue} };
303		599
304	$self	600	$self->_drain_wbuf;
305	}
306
307	sub _shutdown {
308	my ($self) = @_;
309
310	delete $self->{_tw};
311	delete $self->{_rw};
312	delete $self->{_ww};
313	delete $self->{fh};
314
315	&_freetls;
316
317	delete $self->{on_read};
318	delete $self->{_queue};
319	}	601	}
320		602
321	sub _error {	603	sub _error {
322	my ($self, $errno, $fatal) = @_;	604	my ($self, $errno, $fatal, $message) = @_;
323
324	$self->_shutdown
325	if $fatal;
326		605
327	$! = $errno;	606	$! = $errno;
		607	$message ||= "$!";
328		608
329	if ($self->{on_error}) {	609	if ($self->{on_error}) {
330	$self->{on_error}($self, $fatal);	610	$self->{on_error}($self, $fatal, $message);
331	} elsif ($self->{fh}) {	611	$self->destroy if $fatal;
		612	} elsif ($self->{fh} || $self->{connect}) {
		613	$self->destroy;
332	Carp::croak "AnyEvent::Handle uncaught error: $!";	614	Carp::croak "AnyEvent::Handle uncaught error: $message";
333	}	615	}
334	}	616	}
335		617
336	=item $fh = $handle->fh	618	=item $fh = $handle->fh
337		619
…		…
361	$_[0]{on_eof} = $_[1];	643	$_[0]{on_eof} = $_[1];
362	}	644	}
363		645
364	=item $handle->on_timeout ($cb)	646	=item $handle->on_timeout ($cb)
365		647
366	Replace the current C<on_timeout> callback, or disables the callback (but	648	=item $handle->on_rtimeout ($cb)
367	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
368	argument and method.
369		649
370	=cut	650	=item $handle->on_wtimeout ($cb)
371		651
372	sub on_timeout {	652	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
373	$_[0]{on_timeout} = $_[1];	653	callback, or disables the callback (but not the timeout) if C<$cb> =
374	}	654	C<undef>. See the C<timeout> constructor argument and method.
		655
		656	=cut
		657
		658	# see below
375		659
376	=item $handle->autocork ($boolean)	660	=item $handle->autocork ($boolean)
377		661
378	Enables or disables the current autocork behaviour (see C<autocork>	662	Enables or disables the current autocork behaviour (see C<autocork>
379	constructor argument). Changes will only take effect on the next write.	663	constructor argument). Changes will only take effect on the next write.
…		…
392	=cut	676	=cut
393		677
394	sub no_delay {	678	sub no_delay {
395	$_[0]{no_delay} = $_[1];	679	$_[0]{no_delay} = $_[1];
396		680
		681	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		682	if $_[0]{fh};
		683	}
		684
		685	=item $handle->keepalive ($boolean)
		686
		687	Enables or disables the C<keepalive> setting (see constructor argument of
		688	the same name for details).
		689
		690	=cut
		691
		692	sub keepalive {
		693	$_[0]{keepalive} = $_[1];
		694
397	eval {	695	eval {
398	local $SIG{__DIE__};	696	local $SIG{__DIE__};
399	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	697	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		698	if $_[0]{fh};
400	};	699	};
401	}	700	}
402		701
		702	=item $handle->oobinline ($boolean)
		703
		704	Enables or disables the C<oobinline> setting (see constructor argument of
		705	the same name for details).
		706
		707	=cut
		708
		709	sub oobinline {
		710	$_[0]{oobinline} = $_[1];
		711
		712	eval {
		713	local $SIG{__DIE__};
		714	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		715	if $_[0]{fh};
		716	};
		717	}
		718
		719	=item $handle->keepalive ($boolean)
		720
		721	Enables or disables the C<keepalive> setting (see constructor argument of
		722	the same name for details).
		723
		724	=cut
		725
		726	sub keepalive {
		727	$_[0]{keepalive} = $_[1];
		728
		729	eval {
		730	local $SIG{__DIE__};
		731	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		732	if $_[0]{fh};
		733	};
		734	}
		735
		736	=item $handle->on_starttls ($cb)
		737
		738	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		739
		740	=cut
		741
		742	sub on_starttls {
		743	$_[0]{on_starttls} = $_[1];
		744	}
		745
		746	=item $handle->on_stoptls ($cb)
		747
		748	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		749
		750	=cut
		751
		752	sub on_stoptls {
		753	$_[0]{on_stoptls} = $_[1];
		754	}
		755
		756	=item $handle->rbuf_max ($max_octets)
		757
		758	Configures the C<rbuf_max> setting (C<undef> disables it).
		759
		760	=item $handle->wbuf_max ($max_octets)
		761
		762	Configures the C<wbuf_max> setting (C<undef> disables it).
		763
		764	=cut
		765
		766	sub rbuf_max {
		767	$_[0]{rbuf_max} = $_[1];
		768	}
		769
		770	sub rbuf_max {
		771	$_[0]{wbuf_max} = $_[1];
		772	}
		773
403	#############################################################################	774	#############################################################################
404		775
405	=item $handle->timeout ($seconds)	776	=item $handle->timeout ($seconds)
406		777
		778	=item $handle->rtimeout ($seconds)
		779
		780	=item $handle->wtimeout ($seconds)
		781
407	Configures (or disables) the inactivity timeout.	782	Configures (or disables) the inactivity timeout.
408		783
409	=cut	784	=item $handle->timeout_reset
410		785
411	sub timeout {	786	=item $handle->rtimeout_reset
		787
		788	=item $handle->wtimeout_reset
		789
		790	Reset the activity timeout, as if data was received or sent.
		791
		792	These methods are cheap to call.
		793
		794	=cut
		795
		796	for my $dir ("", "r", "w") {
		797	my $timeout = "${dir}timeout";
		798	my $tw = "_${dir}tw";
		799	my $on_timeout = "on_${dir}timeout";
		800	my $activity = "_${dir}activity";
		801	my $cb;
		802
		803	*$on_timeout = sub {
		804	$_[0]{$on_timeout} = $_[1];
		805	};
		806
		807	*$timeout = sub {
412	my ($self, $timeout) = @_;	808	my ($self, $new_value) = @_;
413		809
		810	$new_value >= 0
		811	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		812
414	$self->{timeout} = $timeout;	813	$self->{$timeout} = $new_value;
415	$self->_timeout;	814	delete $self->{$tw}; &$cb;
416	}	815	};
417		816
		817	*{"${dir}timeout_reset"} = sub {
		818	$_[0]{$activity} = AE::now;
		819	};
		820
		821	# main workhorse:
418	# reset the timeout watcher, as neccessary	822	# reset the timeout watcher, as neccessary
419	# also check for time-outs	823	# also check for time-outs
420	sub _timeout {	824	$cb = sub {
421	my ($self) = @_;	825	my ($self) = @_;
422		826
423	if ($self->{timeout}) {	827	if ($self->{$timeout} && $self->{fh}) {
424	my $NOW = AnyEvent->now;	828	my $NOW = AE::now;
425		829
426	# when would the timeout trigger?	830	# when would the timeout trigger?
427	my $after = $self->{_activity} + $self->{timeout} - $NOW;	831	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
428		832
429	# now or in the past already?	833	# now or in the past already?
430	if ($after <= 0) {	834	if ($after <= 0) {
431	$self->{_activity} = $NOW;	835	$self->{$activity} = $NOW;
432		836
433	if ($self->{on_timeout}) {	837	if ($self->{$on_timeout}) {
434	$self->{on_timeout}($self);	838	$self->{$on_timeout}($self);
435	} else {	839	} else {
436	$self->_error (&Errno::ETIMEDOUT);	840	$self->_error (Errno::ETIMEDOUT);
		841	}
		842
		843	# callback could have changed timeout value, optimise
		844	return unless $self->{$timeout};
		845
		846	# calculate new after
		847	$after = $self->{$timeout};
437	}	848	}
438		849
439	# callback could have changed timeout value, optimise	850	Scalar::Util::weaken $self;
440	return unless $self->{timeout};	851	return unless $self; # ->error could have destroyed $self
441		852
442	# calculate new after	853	$self->{$tw} ||= AE::timer $after, 0, sub {
443	$after = $self->{timeout};	854	delete $self->{$tw};
		855	$cb->($self);
		856	};
		857	} else {
		858	delete $self->{$tw};
444	}	859	}
445
446	Scalar::Util::weaken $self;
447	return unless $self; # ->error could have destroyed $self
448
449	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
450	delete $self->{_tw};
451	$self->_timeout;
452	});
453	} else {
454	delete $self->{_tw};
455	}	860	}
456	}	861	}
457		862
458	#############################################################################	863	#############################################################################
459		864
…		…
475	=item $handle->on_drain ($cb)	880	=item $handle->on_drain ($cb)
476		881
477	Sets the C<on_drain> callback or clears it (see the description of	882	Sets the C<on_drain> callback or clears it (see the description of
478	C<on_drain> in the constructor).	883	C<on_drain> in the constructor).
479		884
		885	This method may invoke callbacks (and therefore the handle might be
		886	destroyed after it returns).
		887
480	=cut	888	=cut
481		889
482	sub on_drain {	890	sub on_drain {
483	my ($self, $cb) = @_;	891	my ($self, $cb) = @_;
484		892
…		…
488	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});	896	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
489	}	897	}
490		898
491	=item $handle->push_write ($data)	899	=item $handle->push_write ($data)
492		900
493	Queues the given scalar to be written. You can push as much data as you	901	Queues the given scalar to be written. You can push as much data as
494	want (only limited by the available memory), as C<AnyEvent::Handle>	902	you want (only limited by the available memory and C<wbuf_max>), as
495	buffers it independently of the kernel.	903	C<AnyEvent::Handle> buffers it independently of the kernel.
		904
		905	This method may invoke callbacks (and therefore the handle might be
		906	destroyed after it returns).
496		907
497	=cut	908	=cut
498		909
499	sub _drain_wbuf {	910	sub _drain_wbuf {
500	my ($self) = @_;	911	my ($self) = @_;
…		…
504	Scalar::Util::weaken $self;	915	Scalar::Util::weaken $self;
505		916
506	my $cb = sub {	917	my $cb = sub {
507	my $len = syswrite $self->{fh}, $self->{wbuf};	918	my $len = syswrite $self->{fh}, $self->{wbuf};
508		919
509	if ($len >= 0) {	920	if (defined $len) {
510	substr $self->{wbuf}, 0, $len, "";	921	substr $self->{wbuf}, 0, $len, "";
511		922
512	$self->{_activity} = AnyEvent->now;	923	$self->{_activity} = $self->{_wactivity} = AE::now;
513		924
514	$self->{on_drain}($self)	925	$self->{on_drain}($self)
515	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	926	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
516	&& $self->{on_drain};	927	&& $self->{on_drain};
517		928
…		…
523		934
524	# try to write data immediately	935	# try to write data immediately
525	$cb->() unless $self->{autocork};	936	$cb->() unless $self->{autocork};
526		937
527	# if still data left in wbuf, we need to poll	938	# if still data left in wbuf, we need to poll
528	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	939	$self->{_ww} = AE::io $self->{fh}, 1, $cb
529	if length $self->{wbuf};	940	if length $self->{wbuf};
		941
		942	if (
		943	defined $self->{wbuf_max}
		944	&& $self->{wbuf_max} < length $self->{wbuf}
		945	) {
		946	$self->_error (Errno::ENOSPC, 1), return;
		947	}
530	};	948	};
531	}	949	}
532		950
533	our %WH;	951	our %WH;
534		952
		953	# deprecated
535	sub register_write_type($$) {	954	sub register_write_type($$) {
536	$WH{$_[0]} = $_[1];	955	$WH{$_[0]} = $_[1];
537	}	956	}
538		957
539	sub push_write {	958	sub push_write {
540	my $self = shift;	959	my $self = shift;
541		960
542	if (@_ > 1) {	961	if (@_ > 1) {
543	my $type = shift;	962	my $type = shift;
544		963
		964	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
545	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	965	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
546	->($self, @_);	966	->($self, @_);
547	}	967	}
548		968
		969	# we downgrade here to avoid hard-to-track-down bugs,
		970	# and diagnose the problem earlier and better.
		971
549	if ($self->{tls}) {	972	if ($self->{tls}) {
550	$self->{_tls_wbuf} .= $_[0];	973	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
551		974	&_dotls ($self) if $self->{fh};
552	&_dotls ($self);
553	} else {	975	} else {
554	$self->{wbuf} .= $_[0];	976	utf8::downgrade $self->{wbuf} .= $_[0];
555	$self->_drain_wbuf;	977	$self->_drain_wbuf if $self->{fh};
556	}	978	}
557	}	979	}
558		980
559	=item $handle->push_write (type => @args)	981	=item $handle->push_write (type => @args)
560		982
561	Instead of formatting your data yourself, you can also let this module do	983	Instead of formatting your data yourself, you can also let this module
562	the job by specifying a type and type-specific arguments.	984	do the job by specifying a type and type-specific arguments. You
		985	can also specify the (fully qualified) name of a package, in which
		986	case AnyEvent tries to load the package and then expects to find the
		987	C<anyevent_write_type> function inside (see "custom write types", below).
563		988
564	Predefined types are (if you have ideas for additional types, feel free to	989	Predefined types are (if you have ideas for additional types, feel free to
565	drop by and tell us):	990	drop by and tell us):
566		991
567	=over 4	992	=over 4
…		…
624	Other languages could read single lines terminated by a newline and pass	1049	Other languages could read single lines terminated by a newline and pass
625	this line into their JSON decoder of choice.	1050	this line into their JSON decoder of choice.
626		1051
627	=cut	1052	=cut
628		1053
		1054	sub json_coder() {
		1055	eval { require JSON::XS; JSON::XS->new->utf8 }
		1056	|| do { require JSON; JSON->new->utf8 }
		1057	}
		1058
629	register_write_type json => sub {	1059	register_write_type json => sub {
630	my ($self, $ref) = @_;	1060	my ($self, $ref) = @_;
631		1061
632	require JSON;	1062	my $json = $self->{json} ||= json_coder;
633		1063
634	$self->{json} ? $self->{json}->encode ($ref)	1064	$json->encode ($ref)
635	: JSON::encode_json ($ref)
636	};	1065	};
637		1066
638	=item storable => $reference	1067	=item storable => $reference
639		1068
640	Freezes the given reference using L<Storable> and writes it to the	1069	Freezes the given reference using L<Storable> and writes it to the
…		…
650	pack "w/a*", Storable::nfreeze ($ref)	1079	pack "w/a*", Storable::nfreeze ($ref)
651	};	1080	};
652		1081
653	=back	1082	=back
654		1083
655	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1084	=item $handle->push_shutdown
656		1085
657	This function (not method) lets you add your own types to C<push_write>.	1086	Sometimes you know you want to close the socket after writing your data
		1087	before it was actually written. One way to do that is to replace your
		1088	C<on_drain> handler by a callback that shuts down the socket (and set
		1089	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1090	replaces the C<on_drain> callback with:
		1091
		1092	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		1093
		1094	This simply shuts down the write side and signals an EOF condition to the
		1095	the peer.
		1096
		1097	You can rely on the normal read queue and C<on_eof> handling
		1098	afterwards. This is the cleanest way to close a connection.
		1099
		1100	This method may invoke callbacks (and therefore the handle might be
		1101	destroyed after it returns).
		1102
		1103	=cut
		1104
		1105	sub push_shutdown {
		1106	my ($self) = @_;
		1107
		1108	delete $self->{low_water_mark};
		1109	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1110	}
		1111
		1112	=item custom write types - Package::anyevent_write_type $handle, @args
		1113
		1114	Instead of one of the predefined types, you can also specify the name of
		1115	a package. AnyEvent will try to load the package and then expects to find
		1116	a function named C<anyevent_write_type> inside. If it isn't found, it
		1117	progressively tries to load the parent package until it either finds the
		1118	function (good) or runs out of packages (bad).
		1119
658	Whenever the given C<type> is used, C<push_write> will invoke the code	1120	Whenever the given C<type> is used, C<push_write> will the function with
659	reference with the handle object and the remaining arguments.	1121	the handle object and the remaining arguments.
660		1122
661	The code reference is supposed to return a single octet string that will	1123	The function is supposed to return a single octet string that will be
662	be appended to the write buffer.	1124	appended to the write buffer, so you cna mentally treat this function as a
		1125	"arguments to on-the-wire-format" converter.
663		1126
664	Note that this is a function, and all types registered this way will be	1127	Example: implement a custom write type C<join> that joins the remaining
665	global, so try to use unique names.	1128	arguments using the first one.
		1129
		1130	$handle->push_write (My::Type => " ", 1,2,3);
		1131
		1132	# uses the following package, which can be defined in the "My::Type" or in
		1133	# the "My" modules to be auto-loaded, or just about anywhere when the
		1134	# My::Type::anyevent_write_type is defined before invoking it.
		1135
		1136	package My::Type;
		1137
		1138	sub anyevent_write_type {
		1139	my ($handle, $delim, @args) = @_;
		1140
		1141	join $delim, @args
		1142	}
666		1143
667	=cut	1144	=cut
668		1145
669	#############################################################################	1146	#############################################################################
670		1147
…		…
679	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1156	ways, the "simple" way, using only C<on_read> and the "complex" way, using
680	a queue.	1157	a queue.
681		1158
682	In the simple case, you just install an C<on_read> callback and whenever	1159	In the simple case, you just install an C<on_read> callback and whenever
683	new data arrives, it will be called. You can then remove some data (if	1160	new data arrives, it will be called. You can then remove some data (if
684	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1161	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
685	leave the data there if you want to accumulate more (e.g. when only a	1162	leave the data there if you want to accumulate more (e.g. when only a
686	partial message has been received so far).	1163	partial message has been received so far), or change the read queue with
		1164	e.g. C<push_read>.
687		1165
688	In the more complex case, you want to queue multiple callbacks. In this	1166	In the more complex case, you want to queue multiple callbacks. In this
689	case, AnyEvent::Handle will call the first queued callback each time new	1167	case, AnyEvent::Handle will call the first queued callback each time new
690	data arrives (also the first time it is queued) and removes it when it has	1168	data arrives (also the first time it is queued) and remove it when it has
691	done its job (see C<push_read>, below).	1169	done its job (see C<push_read>, below).
692		1170
693	This way you can, for example, push three line-reads, followed by reading	1171	This way you can, for example, push three line-reads, followed by reading
694	a chunk of data, and AnyEvent::Handle will execute them in order.	1172	a chunk of data, and AnyEvent::Handle will execute them in order.
695		1173
…		…
752	=cut	1230	=cut
753		1231
754	sub _drain_rbuf {	1232	sub _drain_rbuf {
755	my ($self) = @_;	1233	my ($self) = @_;
756		1234
		1235	# avoid recursion
		1236	return if $self->{_skip_drain_rbuf};
757	local $self->{_in_drain} = 1;	1237	local $self->{_skip_drain_rbuf} = 1;
758
759	if (
760	defined $self->{rbuf_max}
761	&& $self->{rbuf_max} < length $self->{rbuf}
762	) {
763	$self->_error (&Errno::ENOSPC, 1), return;
764	}
765		1238
766	while () {	1239	while () {
		1240	# we need to use a separate tls read buffer, as we must not receive data while
		1241	# we are draining the buffer, and this can only happen with TLS.
		1242	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1243	if exists $self->{_tls_rbuf};
		1244
767	my $len = length $self->{rbuf};	1245	my $len = length $self->{rbuf};
768		1246
769	if (my $cb = shift @{ $self->{_queue} }) {	1247	if (my $cb = shift @{ $self->{_queue} }) {
770	unless ($cb->($self)) {	1248	unless ($cb->($self)) {
771	if ($self->{_eof}) {	1249	# no progress can be made
772	# no progress can be made (not enough data and no data forthcoming)	1250	# (not enough data and no data forthcoming)
773	$self->_error (&Errno::EPIPE, 1), return;	1251	$self->_error (Errno::EPIPE, 1), return
774	}	1252	if $self->{_eof};
775		1253
776	unshift @{ $self->{_queue} }, $cb;	1254	unshift @{ $self->{_queue} }, $cb;
777	last;	1255	last;
778	}	1256	}
779	} elsif ($self->{on_read}) {	1257	} elsif ($self->{on_read}) {
…		…
786	&& !@{ $self->{_queue} } # and the queue is still empty	1264	&& !@{ $self->{_queue} } # and the queue is still empty
787	&& $self->{on_read} # but we still have on_read	1265	&& $self->{on_read} # but we still have on_read
788	) {	1266	) {
789	# no further data will arrive	1267	# no further data will arrive
790	# so no progress can be made	1268	# so no progress can be made
791	$self->_error (&Errno::EPIPE, 1), return	1269	$self->_error (Errno::EPIPE, 1), return
792	if $self->{_eof};	1270	if $self->{_eof};
793		1271
794	last; # more data might arrive	1272	last; # more data might arrive
795	}	1273	}
796	} else {	1274	} else {
…		…
799	last;	1277	last;
800	}	1278	}
801	}	1279	}
802		1280
803	if ($self->{_eof}) {	1281	if ($self->{_eof}) {
804	if ($self->{on_eof}) {	1282	$self->{on_eof}
805	$self->{on_eof}($self)	1283	? $self->{on_eof}($self)
806	} else {	1284	: $self->_error (0, 1, "Unexpected end-of-file");
807	$self->_error (0, 1);	1285
808	}	1286	return;
		1287	}
		1288
		1289	if (
		1290	defined $self->{rbuf_max}
		1291	&& $self->{rbuf_max} < length $self->{rbuf}
		1292	) {
		1293	$self->_error (Errno::ENOSPC, 1), return;
809	}	1294	}
810		1295
811	# may need to restart read watcher	1296	# may need to restart read watcher
812	unless ($self->{_rw}) {	1297	unless ($self->{_rw}) {
813	$self->start_read	1298	$self->start_read
…		…
819		1304
820	This replaces the currently set C<on_read> callback, or clears it (when	1305	This replaces the currently set C<on_read> callback, or clears it (when
821	the new callback is C<undef>). See the description of C<on_read> in the	1306	the new callback is C<undef>). See the description of C<on_read> in the
822	constructor.	1307	constructor.
823		1308
		1309	This method may invoke callbacks (and therefore the handle might be
		1310	destroyed after it returns).
		1311
824	=cut	1312	=cut
825		1313
826	sub on_read {	1314	sub on_read {
827	my ($self, $cb) = @_;	1315	my ($self, $cb) = @_;
828		1316
829	$self->{on_read} = $cb;	1317	$self->{on_read} = $cb;
830	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1318	$self->_drain_rbuf if $cb;
831	}	1319	}
832		1320
833	=item $handle->rbuf	1321	=item $handle->rbuf
834		1322
835	Returns the read buffer (as a modifiable lvalue).	1323	Returns the read buffer (as a modifiable lvalue). You can also access the
		1324	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1325	much faster, and no less clean).
836		1326
837	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1327	The only operation allowed on the read buffer (apart from looking at it)
838	you want.	1328	is removing data from its beginning. Otherwise modifying or appending to
		1329	it is not allowed and will lead to hard-to-track-down bugs.
839		1330
840	NOTE: The read buffer should only be used or modified if the C<on_read>,	1331	NOTE: The read buffer should only be used or modified in the C<on_read>
841	C<push_read> or C<unshift_read> methods are used. The other read methods	1332	callback or when C<push_read> or C<unshift_read> are used with a single
842	automatically manage the read buffer.	1333	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1334	will manage the read buffer on their own.
843		1335
844	=cut	1336	=cut
845		1337
846	sub rbuf : lvalue {	1338	sub rbuf : lvalue {
847	$_[0]{rbuf}	1339	$_[0]{rbuf}
…		…
864		1356
865	If enough data was available, then the callback must remove all data it is	1357	If enough data was available, then the callback must remove all data it is
866	interested in (which can be none at all) and return a true value. After returning	1358	interested in (which can be none at all) and return a true value. After returning
867	true, it will be removed from the queue.	1359	true, it will be removed from the queue.
868		1360
		1361	These methods may invoke callbacks (and therefore the handle might be
		1362	destroyed after it returns).
		1363
869	=cut	1364	=cut
870		1365
871	our %RH;	1366	our %RH;
872		1367
873	sub register_read_type($$) {	1368	sub register_read_type($$) {
…		…
879	my $cb = pop;	1374	my $cb = pop;
880		1375
881	if (@_) {	1376	if (@_) {
882	my $type = shift;	1377	my $type = shift;
883		1378
		1379	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
884	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1380	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
885	->($self, $cb, @_);	1381	->($self, $cb, @_);
886	}	1382	}
887		1383
888	push @{ $self->{_queue} }, $cb;	1384	push @{ $self->{_queue} }, $cb;
889	$self->_drain_rbuf unless $self->{_in_drain};	1385	$self->_drain_rbuf;
890	}	1386	}
891		1387
892	sub unshift_read {	1388	sub unshift_read {
893	my $self = shift;	1389	my $self = shift;
894	my $cb = pop;	1390	my $cb = pop;
895		1391
896	if (@_) {	1392	if (@_) {
897	my $type = shift;	1393	my $type = shift;
898		1394
		1395	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
899	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1396	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
900	->($self, $cb, @_);	1397	->($self, $cb, @_);
901	}	1398	}
902		1399
903
904	unshift @{ $self->{_queue} }, $cb;	1400	unshift @{ $self->{_queue} }, $cb;
905	$self->_drain_rbuf unless $self->{_in_drain};	1401	$self->_drain_rbuf;
906	}	1402	}
907		1403
908	=item $handle->push_read (type => @args, $cb)	1404	=item $handle->push_read (type => @args, $cb)
909		1405
910	=item $handle->unshift_read (type => @args, $cb)	1406	=item $handle->unshift_read (type => @args, $cb)
911		1407
912	Instead of providing a callback that parses the data itself you can chose	1408	Instead of providing a callback that parses the data itself you can chose
913	between a number of predefined parsing formats, for chunks of data, lines	1409	between a number of predefined parsing formats, for chunks of data, lines
914	etc.	1410	etc. You can also specify the (fully qualified) name of a package, in
		1411	which case AnyEvent tries to load the package and then expects to find the
		1412	C<anyevent_read_type> function inside (see "custom read types", below).
915		1413
916	Predefined types are (if you have ideas for additional types, feel free to	1414	Predefined types are (if you have ideas for additional types, feel free to
917	drop by and tell us):	1415	drop by and tell us):
918		1416
919	=over 4	1417	=over 4
…		…
1011	the receive buffer when neither C<$accept> nor C<$reject> match,	1509	the receive buffer when neither C<$accept> nor C<$reject> match,
1012	and everything preceding and including the match will be accepted	1510	and everything preceding and including the match will be accepted
1013	unconditionally. This is useful to skip large amounts of data that you	1511	unconditionally. This is useful to skip large amounts of data that you
1014	know cannot be matched, so that the C<$accept> or C<$reject> regex do not	1512	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1015	have to start matching from the beginning. This is purely an optimisation	1513	have to start matching from the beginning. This is purely an optimisation
1016	and is usually worth only when you expect more than a few kilobytes.	1514	and is usually worth it only when you expect more than a few kilobytes.
1017		1515
1018	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1516	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1019	expect the header to be very large (it isn't in practise, but...), we use	1517	expect the header to be very large (it isn't in practice, but...), we use
1020	a skip regex to skip initial portions. The skip regex is tricky in that	1518	a skip regex to skip initial portions. The skip regex is tricky in that
1021	it only accepts something not ending in either \015 or \012, as these are	1519	it only accepts something not ending in either \015 or \012, as these are
1022	required for the accept regex.	1520	required for the accept regex.
1023		1521
1024	$handle->push_read (regex =>	1522	$handle->push_read (regex =>
…		…
1043	return 1;	1541	return 1;
1044	}	1542	}
1045		1543
1046	# reject	1544	# reject
1047	if ($reject && $$rbuf =~ $reject) {	1545	if ($reject && $$rbuf =~ $reject) {
1048	$self->_error (&Errno::EBADMSG);	1546	$self->_error (Errno::EBADMSG);
1049	}	1547	}
1050		1548
1051	# skip	1549	# skip
1052	if ($skip && $$rbuf =~ $skip) {	1550	if ($skip && $$rbuf =~ $skip) {
1053	$data .= substr $$rbuf, 0, $+[0], "";	1551	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1069	my ($self, $cb) = @_;	1567	my ($self, $cb) = @_;
1070		1568
1071	sub {	1569	sub {
1072	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1570	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1073	if ($_[0]{rbuf} =~ /[^0-9]/) {	1571	if ($_[0]{rbuf} =~ /[^0-9]/) {
1074	$self->_error (&Errno::EBADMSG);	1572	$self->_error (Errno::EBADMSG);
1075	}	1573	}
1076	return;	1574	return;
1077	}	1575	}
1078		1576
1079	my $len = $1;	1577	my $len = $1;
…		…
1082	my $string = $_[1];	1580	my $string = $_[1];
1083	$_[0]->unshift_read (chunk => 1, sub {	1581	$_[0]->unshift_read (chunk => 1, sub {
1084	if ($_[1] eq ",") {	1582	if ($_[1] eq ",") {
1085	$cb->($_[0], $string);	1583	$cb->($_[0], $string);
1086	} else {	1584	} else {
1087	$self->_error (&Errno::EBADMSG);	1585	$self->_error (Errno::EBADMSG);
1088	}	1586	}
1089	});	1587	});
1090	});	1588	});
1091		1589
1092	1	1590	1
…		…
1118	sub {	1616	sub {
1119	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1617	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1120	defined (my $len = eval { unpack $format, $_[0]{rbuf} })	1618	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1121	or return;	1619	or return;
1122		1620
		1621	warn "len $len\n";#d#
1123	$format = length pack $format, $len;	1622	$format = length pack $format, $len;
		1623	warn "len2 $format\n";#d#
1124		1624
1125	# bypass unshift if we already have the remaining chunk	1625	# bypass unshift if we already have the remaining chunk
1126	if ($format + $len <= length $_[0]{rbuf}) {	1626	if ($format + $len <= length $_[0]{rbuf}) {
1127	my $data = substr $_[0]{rbuf}, $format, $len;	1627	my $data = substr $_[0]{rbuf}, $format, $len;
1128	substr $_[0]{rbuf}, 0, $format + $len, "";	1628	substr $_[0]{rbuf}, 0, $format + $len, "";
…		…
1139	}	1639	}
1140	};	1640	};
1141		1641
1142	=item json => $cb->($handle, $hash_or_arrayref)	1642	=item json => $cb->($handle, $hash_or_arrayref)
1143		1643
1144	Reads a JSON object or array, decodes it and passes it to the callback.	1644	Reads a JSON object or array, decodes it and passes it to the
		1645	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1145		1646
1146	If a C<json> object was passed to the constructor, then that will be used	1647	If a C<json> object was passed to the constructor, then that will be used
1147	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1648	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1148		1649
1149	This read type uses the incremental parser available with JSON version	1650	This read type uses the incremental parser available with JSON version
…		…
1158	=cut	1659	=cut
1159		1660
1160	register_read_type json => sub {	1661	register_read_type json => sub {
1161	my ($self, $cb) = @_;	1662	my ($self, $cb) = @_;
1162		1663
1163	require JSON;	1664	my $json = $self->{json} ||= json_coder;
1164		1665
1165	my $data;	1666	my $data;
1166	my $rbuf = \$self->{rbuf};	1667	my $rbuf = \$self->{rbuf};
1167		1668
1168	my $json = $self->{json} ||= JSON->new->utf8;
1169
1170	sub {	1669	sub {
1171	my $ref = $json->incr_parse ($self->{rbuf});	1670	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1172		1671
1173	if ($ref) {	1672	if ($ref) {
1174	$self->{rbuf} = $json->incr_text;	1673	$self->{rbuf} = $json->incr_text;
1175	$json->incr_text = "";	1674	$json->incr_text = "";
1176	$cb->($self, $ref);	1675	$cb->($self, $ref);
1177		1676
1178	1	1677	1
		1678	} elsif ($@) {
		1679	# error case
		1680	$json->incr_skip;
		1681
		1682	$self->{rbuf} = $json->incr_text;
		1683	$json->incr_text = "";
		1684
		1685	$self->_error (Errno::EBADMSG);
		1686
		1687	()
1179	} else {	1688	} else {
1180	$self->{rbuf} = "";	1689	$self->{rbuf} = "";
		1690
1181	()	1691	()
1182	}	1692	}
1183	}	1693	}
1184	};	1694	};
1185		1695
…		…
1217	# read remaining chunk	1727	# read remaining chunk
1218	$_[0]->unshift_read (chunk => $len, sub {	1728	$_[0]->unshift_read (chunk => $len, sub {
1219	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1729	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1220	$cb->($_[0], $ref);	1730	$cb->($_[0], $ref);
1221	} else {	1731	} else {
1222	$self->_error (&Errno::EBADMSG);	1732	$self->_error (Errno::EBADMSG);
1223	}	1733	}
1224	});	1734	});
1225	}	1735	}
1226		1736
1227	1	1737	1
1228	}	1738	}
1229	};	1739	};
1230		1740
1231	=back	1741	=back
1232		1742
1233	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1743	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1234		1744
1235	This function (not method) lets you add your own types to C<push_read>.	1745	Instead of one of the predefined types, you can also specify the name
		1746	of a package. AnyEvent will try to load the package and then expects to
		1747	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1748	progressively tries to load the parent package until it either finds the
		1749	function (good) or runs out of packages (bad).
1236		1750
1237	Whenever the given C<type> is used, C<push_read> will invoke the code	1751	Whenever this type is used, C<push_read> will invoke the function with the
1238	reference with the handle object, the callback and the remaining	1752	handle object, the original callback and the remaining arguments.
1239	arguments.
1240		1753
1241	The code reference is supposed to return a callback (usually a closure)	1754	The function is supposed to return a callback (usually a closure) that
1242	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1755	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1756	mentally treat the function as a "configurable read type to read callback"
		1757	converter.
1243		1758
1244	It should invoke the passed callback when it is done reading (remember to	1759	It should invoke the original callback when it is done reading (remember
1245	pass C<$handle> as first argument as all other callbacks do that).	1760	to pass C<$handle> as first argument as all other callbacks do that,
		1761	although there is no strict requirement on this).
1246		1762
1247	Note that this is a function, and all types registered this way will be
1248	global, so try to use unique names.
1249
1250	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1763	For examples, see the source of this module (F<perldoc -m
1251	search for C<register_read_type>)).	1764	AnyEvent::Handle>, search for C<register_read_type>)).
1252		1765
1253	=item $handle->stop_read	1766	=item $handle->stop_read
1254		1767
1255	=item $handle->start_read	1768	=item $handle->start_read
1256		1769
…		…
1276	}	1789	}
1277		1790
1278	sub start_read {	1791	sub start_read {
1279	my ($self) = @_;	1792	my ($self) = @_;
1280		1793
1281	unless ($self->{_rw} || $self->{_eof}) {	1794	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1282	Scalar::Util::weaken $self;	1795	Scalar::Util::weaken $self;
1283		1796
1284	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1797	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1285	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1798	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1286	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1799	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1287		1800
1288	if ($len > 0) {	1801	if ($len > 0) {
1289	$self->{_activity} = AnyEvent->now;	1802	$self->{_activity} = $self->{_ractivity} = AE::now;
1290		1803
1291	if ($self->{tls}) {	1804	if ($self->{tls}) {
1292	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1805	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1293		1806
1294	&_dotls ($self);	1807	&_dotls ($self);
1295	} else {	1808	} else {
1296	$self->_drain_rbuf unless $self->{_in_drain};	1809	$self->_drain_rbuf;
		1810	}
		1811
		1812	if ($len == $self->{read_size}) {
		1813	$self->{read_size} *= 2;
		1814	$self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
		1815	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1297	}	1816	}
1298		1817
1299	} elsif (defined $len) {	1818	} elsif (defined $len) {
1300	delete $self->{_rw};	1819	delete $self->{_rw};
1301	$self->{_eof} = 1;	1820	$self->{_eof} = 1;
1302	$self->_drain_rbuf unless $self->{_in_drain};	1821	$self->_drain_rbuf;
1303		1822
1304	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1823	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1305	return $self->_error ($!, 1);	1824	return $self->_error ($!, 1);
1306	}	1825	}
1307	});	1826	};
		1827	}
		1828	}
		1829
		1830	our $ERROR_SYSCALL;
		1831	our $ERROR_WANT_READ;
		1832
		1833	sub _tls_error {
		1834	my ($self, $err) = @_;
		1835
		1836	return $self->_error ($!, 1)
		1837	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1838
		1839	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1840
		1841	# reduce error string to look less scary
		1842	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1843
		1844	if ($self->{_on_starttls}) {
		1845	(delete $self->{_on_starttls})->($self, undef, $err);
		1846	&_freetls;
		1847	} else {
		1848	&_freetls;
		1849	$self->_error (Errno::EPROTO, 1, $err);
1308	}	1850	}
1309	}	1851	}
1310		1852
1311	# poll the write BIO and send the data if applicable	1853	# poll the write BIO and send the data if applicable
		1854	# also decode read data if possible
		1855	# this is basiclaly our TLS state machine
		1856	# more efficient implementations are possible with openssl,
		1857	# but not with the buggy and incomplete Net::SSLeay.
1312	sub _dotls {	1858	sub _dotls {
1313	my ($self) = @_;	1859	my ($self) = @_;
1314		1860
1315	my $tmp;	1861	my $tmp;
1316		1862
1317	if (length $self->{_tls_wbuf}) {	1863	if (length $self->{_tls_wbuf}) {
1318	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1864	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1319	substr $self->{_tls_wbuf}, 0, $tmp, "";	1865	substr $self->{_tls_wbuf}, 0, $tmp, "";
1320	}	1866	}
		1867
		1868	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1869	return $self->_tls_error ($tmp)
		1870	if $tmp != $ERROR_WANT_READ
		1871	&& ($tmp != $ERROR_SYSCALL || $!);
1321	}	1872	}
1322		1873
1323	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1874	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1324	unless (length $tmp) {	1875	unless (length $tmp) {
1325	# let's treat SSL-eof as we treat normal EOF	1876	$self->{_on_starttls}
1326	delete $self->{_rw};	1877	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1327	$self->{_eof} = 1;
1328	&_freetls;	1878	&_freetls;
		1879
		1880	if ($self->{on_stoptls}) {
		1881	$self->{on_stoptls}($self);
		1882	return;
		1883	} else {
		1884	# let's treat SSL-eof as we treat normal EOF
		1885	delete $self->{_rw};
		1886	$self->{_eof} = 1;
		1887	}
1329	}	1888	}
1330		1889
1331	$self->{rbuf} .= $tmp;	1890	$self->{_tls_rbuf} .= $tmp;
1332	$self->_drain_rbuf unless $self->{_in_drain};	1891	$self->_drain_rbuf;
1333	$self->{tls} or return; # tls session might have gone away in callback	1892	$self->{tls} or return; # tls session might have gone away in callback
1334	}	1893	}
1335		1894
1336	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1895	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1337
1338	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1339	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1340	return $self->_error ($!, 1);	1896	return $self->_tls_error ($tmp)
1341	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1897	if $tmp != $ERROR_WANT_READ
1342	return $self->_error (&Errno::EIO, 1);	1898	&& ($tmp != $ERROR_SYSCALL || $!);
1343	}
1344
1345	# all other errors are fine for our purposes
1346	}
1347		1899
1348	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1900	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1349	$self->{wbuf} .= $tmp;	1901	$self->{wbuf} .= $tmp;
1350	$self->_drain_wbuf;	1902	$self->_drain_wbuf;
		1903	$self->{tls} or return; # tls session might have gone away in callback
1351	}	1904	}
		1905
		1906	$self->{_on_starttls}
		1907	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1908	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1352	}	1909	}
1353		1910
1354	=item $handle->starttls ($tls[, $tls_ctx])	1911	=item $handle->starttls ($tls[, $tls_ctx])
1355		1912
1356	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1913	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1357	object is created, you can also do that at a later time by calling	1914	object is created, you can also do that at a later time by calling
1358	C<starttls>.	1915	C<starttls>.
1359		1916
		1917	Starting TLS is currently an asynchronous operation - when you push some
		1918	write data and then call C<< ->starttls >> then TLS negotiation will start
		1919	immediately, after which the queued write data is then sent.
		1920
1360	The first argument is the same as the C<tls> constructor argument (either	1921	The first argument is the same as the C<tls> constructor argument (either
1361	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1922	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1362		1923
1363	The second argument is the optional C<Net::SSLeay::CTX> object that is	1924	The second argument is the optional C<AnyEvent::TLS> object that is used
1364	used when AnyEvent::Handle has to create its own TLS connection object.	1925	when AnyEvent::Handle has to create its own TLS connection object, or
		1926	a hash reference with C<< key => value >> pairs that will be used to
		1927	construct a new context.
1365		1928
1366	The TLS connection object will end up in C<< $handle->{tls} >> after this	1929	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1367	call and can be used or changed to your liking. Note that the handshake	1930	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1368	might have already started when this function returns.	1931	changed to your liking. Note that the handshake might have already started
		1932	when this function returns.
1369		1933
1370	If it an error to start a TLS handshake more than once per	1934	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1371	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1935	handshakes on the same stream. It is best to not attempt to use the
		1936	stream after stopping TLS.
1372		1937
		1938	This method may invoke callbacks (and therefore the handle might be
		1939	destroyed after it returns).
		1940
1373	=cut	1941	=cut
		1942
		1943	our %TLS_CACHE; #TODO not yet documented, should we?
1374		1944
1375	sub starttls {	1945	sub starttls {
1376	my ($self, $ssl, $ctx) = @_;	1946	my ($self, $tls, $ctx) = @_;
		1947
		1948	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1949	if $self->{tls};
		1950
		1951	$self->{tls} = $tls;
		1952	$self->{tls_ctx} = $ctx if @_ > 2;
		1953
		1954	return unless $self->{fh};
1377		1955
1378	require Net::SSLeay;	1956	require Net::SSLeay;
1379		1957
1380	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1958	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1381	if $self->{tls};	1959	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1960
		1961	$tls = delete $self->{tls};
		1962	$ctx = $self->{tls_ctx};
		1963
		1964	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1965
		1966	if ("HASH" eq ref $ctx) {
		1967	require AnyEvent::TLS;
		1968
		1969	if ($ctx->{cache}) {
		1970	my $key = $ctx+0;
		1971	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1972	} else {
		1973	$ctx = new AnyEvent::TLS %$ctx;
		1974	}
		1975	}
1382		1976
1383	if ($ssl eq "accept") {	1977	$self->{tls_ctx} = $ctx || TLS_CTX ();
1384	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1978	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1385	Net::SSLeay::set_accept_state ($ssl);
1386	} elsif ($ssl eq "connect") {
1387	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1388	Net::SSLeay::set_connect_state ($ssl);
1389	}
1390
1391	$self->{tls} = $ssl;
1392		1979
1393	# basically, this is deep magic (because SSL_read should have the same issues)	1980	# basically, this is deep magic (because SSL_read should have the same issues)
1394	# but the openssl maintainers basically said: "trust us, it just works".	1981	# but the openssl maintainers basically said: "trust us, it just works".
1395	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1982	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1396	# and mismaintained ssleay-module doesn't even offer them).	1983	# and mismaintained ssleay-module doesn't even offer them).
…		…
1400	#	1987	#
1401	# note that we do not try to keep the length constant between writes as we are required to do.	1988	# note that we do not try to keep the length constant between writes as we are required to do.
1402	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1989	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1403	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1990	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1404	# have identity issues in that area.	1991	# have identity issues in that area.
1405	Net::SSLeay::CTX_set_mode ($self->{tls},	1992	# Net::SSLeay::CTX_set_mode ($ssl,
1406	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1993	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1407	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1994	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1995	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1408		1996
1409	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1997	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1410	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1998	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1411		1999
		2000	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		2001
1412	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	2002	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		2003
		2004	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		2005	if $self->{on_starttls};
1413		2006
1414	&_dotls; # need to trigger the initial handshake	2007	&_dotls; # need to trigger the initial handshake
1415	$self->start_read; # make sure we actually do read	2008	$self->start_read; # make sure we actually do read
1416	}	2009	}
1417		2010
1418	=item $handle->stoptls	2011	=item $handle->stoptls
1419		2012
1420	Shuts down the SSL connection - this makes a proper EOF handshake by	2013	Shuts down the SSL connection - this makes a proper EOF handshake by
1421	sending a close notify to the other side, but since OpenSSL doesn't	2014	sending a close notify to the other side, but since OpenSSL doesn't
1422	support non-blocking shut downs, it is not possible to re-use the stream	2015	support non-blocking shut downs, it is not guaranteed that you can re-use
1423	afterwards.	2016	the stream afterwards.
		2017
		2018	This method may invoke callbacks (and therefore the handle might be
		2019	destroyed after it returns).
1424		2020
1425	=cut	2021	=cut
1426		2022
1427	sub stoptls {	2023	sub stoptls {
1428	my ($self) = @_;	2024	my ($self) = @_;
1429		2025
1430	if ($self->{tls}) {	2026	if ($self->{tls} && $self->{fh}) {
1431	Net::SSLeay::shutdown ($self->{tls});	2027	Net::SSLeay::shutdown ($self->{tls});
1432		2028
1433	&_dotls;	2029	&_dotls;
1434		2030
1435	# we don't give a shit. no, we do, but we can't. no...	2031	# # we don't give a shit. no, we do, but we can't. no...#d#
1436	# we, we... have to use openssl :/	2032	# # we, we... have to use openssl :/#d#
1437	&_freetls;	2033	# &_freetls;#d#
1438	}	2034	}
1439	}	2035	}
1440		2036
1441	sub _freetls {	2037	sub _freetls {
1442	my ($self) = @_;	2038	my ($self) = @_;
1443		2039
1444	return unless $self->{tls};	2040	return unless $self->{tls};
1445		2041
1446	Net::SSLeay::free (delete $self->{tls});	2042	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2043	if $self->{tls} > 0;
1447		2044
1448	delete @$self{qw(_rbio _wbio _tls_wbuf)};	2045	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1449	}	2046	}
1450		2047
1451	sub DESTROY {	2048	sub DESTROY {
1452	my $self = shift;	2049	my ($self) = @_;
1453		2050
1454	&_freetls;	2051	&_freetls;
1455		2052
1456	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	2053	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1457		2054
1458	if ($linger && length $self->{wbuf}) {	2055	if ($linger && length $self->{wbuf} && $self->{fh}) {
1459	my $fh = delete $self->{fh};	2056	my $fh = delete $self->{fh};
1460	my $wbuf = delete $self->{wbuf};	2057	my $wbuf = delete $self->{wbuf};
1461		2058
1462	my @linger;	2059	my @linger;
1463		2060
1464	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2061	push @linger, AE::io $fh, 1, sub {
1465	my $len = syswrite $fh, $wbuf, length $wbuf;	2062	my $len = syswrite $fh, $wbuf, length $wbuf;
1466		2063
1467	if ($len > 0) {	2064	if ($len > 0) {
1468	substr $wbuf, 0, $len, "";	2065	substr $wbuf, 0, $len, "";
1469	} else {	2066	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1470	@linger = (); # end	2067	@linger = (); # end
1471	}	2068	}
1472	});	2069	};
1473	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2070	push @linger, AE::timer $linger, 0, sub {
1474	@linger = ();	2071	@linger = ();
1475	});	2072	};
1476	}	2073	}
1477	}	2074	}
1478		2075
1479	=item $handle->destroy	2076	=item $handle->destroy
1480		2077
1481	Shuts down the handle object as much as possible - this call ensures that	2078	Shuts down the handle object as much as possible - this call ensures that
1482	no further callbacks will be invoked and resources will be freed as much	2079	no further callbacks will be invoked and as many resources as possible
1483	as possible. You must not call any methods on the object afterwards.	2080	will be freed. Any method you will call on the handle object after
		2081	destroying it in this way will be silently ignored (and it will return the
		2082	empty list).
1484		2083
1485	Normally, you can just "forget" any references to an AnyEvent::Handle	2084	Normally, you can just "forget" any references to an AnyEvent::Handle
1486	object and it will simply shut down. This works in fatal error and EOF	2085	object and it will simply shut down. This works in fatal error and EOF
1487	callbacks, as well as code outside. It does I<NOT> work in a read or write	2086	callbacks, as well as code outside. It does I<NOT> work in a read or write
1488	callback, so when you want to destroy the AnyEvent::Handle object from	2087	callback, so when you want to destroy the AnyEvent::Handle object from
1489	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	2088	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1490	that case.	2089	that case.
1491		2090
		2091	Destroying the handle object in this way has the advantage that callbacks
		2092	will be removed as well, so if those are the only reference holders (as
		2093	is common), then one doesn't need to do anything special to break any
		2094	reference cycles.
		2095
1492	The handle might still linger in the background and write out remaining	2096	The handle might still linger in the background and write out remaining
1493	data, as specified by the C<linger> option, however.	2097	data, as specified by the C<linger> option, however.
1494		2098
1495	=cut	2099	=cut
1496		2100
1497	sub destroy {	2101	sub destroy {
1498	my ($self) = @_;	2102	my ($self) = @_;
1499		2103
1500	$self->DESTROY;	2104	$self->DESTROY;
1501	%$self = ();	2105	%$self = ();
		2106	bless $self, "AnyEvent::Handle::destroyed";
1502	}	2107	}
		2108
		2109	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2110	#nop
		2111	}
		2112
		2113	=item $handle->destroyed
		2114
		2115	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2116	->destroy >>, true otherwise.
		2117
		2118	Can be useful to decide whether the handle is still valid after some
		2119	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2120	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2121	can destroy the handle, so work can be avoided by checking sometimes:
		2122
		2123	$hdl->starttls ("accept");
		2124	return if $hdl->destroyed;
		2125	$hdl->push_write (...
		2126
		2127	Note that the call to C<push_write> will silently be ignored if the handle
		2128	has been destroyed, so often you can just ignore the possibility of the
		2129	handle being destroyed.
		2130
		2131	=cut
		2132
		2133	sub destroyed { 0 }
		2134	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1503		2135
1504	=item AnyEvent::Handle::TLS_CTX	2136	=item AnyEvent::Handle::TLS_CTX
1505		2137
1506	This function creates and returns the Net::SSLeay::CTX object used by	2138	This function creates and returns the AnyEvent::TLS object used by default
1507	default for TLS mode.	2139	for TLS mode.
1508		2140
1509	The context is created like this:	2141	The context is created by calling L<AnyEvent::TLS> without any arguments.
1510
1511	Net::SSLeay::load_error_strings;
1512	Net::SSLeay::SSLeay_add_ssl_algorithms;
1513	Net::SSLeay::randomize;
1514
1515	my $CTX = Net::SSLeay::CTX_new;
1516
1517	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1518		2142
1519	=cut	2143	=cut
1520		2144
1521	our $TLS_CTX;	2145	our $TLS_CTX;
1522		2146
1523	sub TLS_CTX() {	2147	sub TLS_CTX() {
1524	$TLS_CTX || do {	2148	$TLS_CTX ||= do {
1525	require Net::SSLeay;	2149	require AnyEvent::TLS;
1526		2150
1527	Net::SSLeay::load_error_strings ();	2151	new AnyEvent::TLS
1528	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1529	Net::SSLeay::randomize ();
1530
1531	$TLS_CTX = Net::SSLeay::CTX_new ();
1532
1533	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1534
1535	$TLS_CTX
1536	}	2152	}
1537	}	2153	}
1538		2154
1539	=back	2155	=back
1540		2156
…		…
1551		2167
1552	It is only safe to "forget" the reference inside EOF or error callbacks,	2168	It is only safe to "forget" the reference inside EOF or error callbacks,
1553	from within all other callbacks, you need to explicitly call the C<<	2169	from within all other callbacks, you need to explicitly call the C<<
1554	->destroy >> method.	2170	->destroy >> method.
1555		2171
		2172	=item Why is my C<on_eof> callback never called?
		2173
		2174	Probably because your C<on_error> callback is being called instead: When
		2175	you have outstanding requests in your read queue, then an EOF is
		2176	considered an error as you clearly expected some data.
		2177
		2178	To avoid this, make sure you have an empty read queue whenever your handle
		2179	is supposed to be "idle" (i.e. connection closes are O.K.). You cna set
		2180	an C<on_read> handler that simply pushes the first read requests in the
		2181	queue.
		2182
		2183	See also the next question, which explains this in a bit more detail.
		2184
		2185	=item How can I serve requests in a loop?
		2186
		2187	Most protocols consist of some setup phase (authentication for example)
		2188	followed by a request handling phase, where the server waits for requests
		2189	and handles them, in a loop.
		2190
		2191	There are two important variants: The first (traditional, better) variant
		2192	handles requests until the server gets some QUIT command, causing it to
		2193	close the connection first (highly desirable for a busy TCP server). A
		2194	client dropping the connection is an error, which means this variant can
		2195	detect an unexpected detection close.
		2196
		2197	To handle this case, always make sure you have a on-empty read queue, by
		2198	pushing the "read request start" handler on it:
		2199
		2200	# we assume a request starts with a single line
		2201	my @start_request; @start_request = (line => sub {
		2202	my ($hdl, $line) = @_;
		2203
		2204	... handle request
		2205
		2206	# push next request read, possibly from a nested callback
		2207	$hdl->push_read (@start_request);
		2208	});
		2209
		2210	# auth done, now go into request handling loop
		2211	# now push the first @start_request
		2212	$hdl->push_read (@start_request);
		2213
		2214	By always having an outstanding C<push_read>, the handle always expects
		2215	some data and raises the C<EPIPE> error when the connction is dropped
		2216	unexpectedly.
		2217
		2218	The second variant is a protocol where the client can drop the connection
		2219	at any time. For TCP, this means that the server machine may run out of
		2220	sockets easier, and in general, it means you cnanot distinguish a protocl
		2221	failure/client crash from a normal connection close. Nevertheless, these
		2222	kinds of protocols are common (and sometimes even the best solution to the
		2223	problem).
		2224
		2225	Having an outstanding read request at all times is possible if you ignore
		2226	C<EPIPE> errors, but this doesn't help with when the client drops the
		2227	connection during a request, which would still be an error.
		2228
		2229	A better solution is to push the initial request read in an C<on_read>
		2230	callback. This avoids an error, as when the server doesn't expect data
		2231	(i.e. is idly waiting for the next request, an EOF will not raise an
		2232	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2233	and simpler:
		2234
		2235	# auth done, now go into request handling loop
		2236	$hdl->on_read (sub {
		2237	my ($hdl) = @_;
		2238
		2239	# called each time we receive data but the read queue is empty
		2240	# simply start read the request
		2241
		2242	$hdl->push_read (line => sub {
		2243	my ($hdl, $line) = @_;
		2244
		2245	... handle request
		2246
		2247	# do nothing special when the request has been handled, just
		2248	# let the request queue go empty.
		2249	});
		2250	});
		2251
1556	=item I get different callback invocations in TLS mode/Why can't I pause	2252	=item I get different callback invocations in TLS mode/Why can't I pause
1557	reading?	2253	reading?
1558		2254
1559	Unlike, say, TCP, TLS connections do not consist of two independent	2255	Unlike, say, TCP, TLS connections do not consist of two independent
1560	communication channels, one for each direction. Or put differently. The	2256	communication channels, one for each direction. Or put differently, the
1561	read and write directions are not independent of each other: you cannot	2257	read and write directions are not independent of each other: you cannot
1562	write data unless you are also prepared to read, and vice versa.	2258	write data unless you are also prepared to read, and vice versa.
1563		2259
1564	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2260	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1565	callback invocations when you are not expecting any read data - the reason	2261	callback invocations when you are not expecting any read data - the reason
1566	is that AnyEvent::Handle always reads in TLS mode.	2262	is that AnyEvent::Handle always reads in TLS mode.
1567		2263
1568	During the connection, you have to make sure that you always have a	2264	During the connection, you have to make sure that you always have a
1569	non-empty read-queue, or an C<on_read> watcher. At the end of the	2265	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1579		2275
1580	$handle->on_read (sub { });	2276	$handle->on_read (sub { });
1581	$handle->on_eof (undef);	2277	$handle->on_eof (undef);
1582	$handle->on_error (sub {	2278	$handle->on_error (sub {
1583	my $data = delete $_[0]{rbuf};	2279	my $data = delete $_[0]{rbuf};
1584	undef $handle;
1585	});	2280	});
1586		2281
1587	The reason to use C<on_error> is that TCP connections, due to latencies	2282	The reason to use C<on_error> is that TCP connections, due to latencies
1588	and packets loss, might get closed quite violently with an error, when in	2283	and packets loss, might get closed quite violently with an error, when in
1589	fact, all data has been received.	2284	fact all data has been received.
1590		2285
1591	It is usually better to use acknowledgements when transferring data,	2286	It is usually better to use acknowledgements when transferring data,
1592	to make sure the other side hasn't just died and you got the data	2287	to make sure the other side hasn't just died and you got the data
1593	intact. This is also one reason why so many internet protocols have an	2288	intact. This is also one reason why so many internet protocols have an
1594	explicit QUIT command.	2289	explicit QUIT command.
…		…
1605	$handle->on_drain (sub {	2300	$handle->on_drain (sub {
1606	warn "all data submitted to the kernel\n";	2301	warn "all data submitted to the kernel\n";
1607	undef $handle;	2302	undef $handle;
1608	});	2303	});
1609		2304
		2305	If you just want to queue some data and then signal EOF to the other side,
		2306	consider using C<< ->push_shutdown >> instead.
		2307
		2308	=item I want to contact a TLS/SSL server, I don't care about security.
		2309
		2310	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2311	connect to it and then create the AnyEvent::Handle with the C<tls>
		2312	parameter:
		2313
		2314	tcp_connect $host, $port, sub {
		2315	my ($fh) = @_;
		2316
		2317	my $handle = new AnyEvent::Handle
		2318	fh => $fh,
		2319	tls => "connect",
		2320	on_error => sub { ... };
		2321
		2322	$handle->push_write (...);
		2323	};
		2324
		2325	=item I want to contact a TLS/SSL server, I do care about security.
		2326
		2327	Then you should additionally enable certificate verification, including
		2328	peername verification, if the protocol you use supports it (see
		2329	L<AnyEvent::TLS>, C<verify_peername>).
		2330
		2331	E.g. for HTTPS:
		2332
		2333	tcp_connect $host, $port, sub {
		2334	my ($fh) = @_;
		2335
		2336	my $handle = new AnyEvent::Handle
		2337	fh => $fh,
		2338	peername => $host,
		2339	tls => "connect",
		2340	tls_ctx => { verify => 1, verify_peername => "https" },
		2341	...
		2342
		2343	Note that you must specify the hostname you connected to (or whatever
		2344	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2345	peername verification will be done.
		2346
		2347	The above will use the system-dependent default set of trusted CA
		2348	certificates. If you want to check against a specific CA, add the
		2349	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2350
		2351	tls_ctx => {
		2352	verify => 1,
		2353	verify_peername => "https",
		2354	ca_file => "my-ca-cert.pem",
		2355	},
		2356
		2357	=item I want to create a TLS/SSL server, how do I do that?
		2358
		2359	Well, you first need to get a server certificate and key. You have
		2360	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2361	self-signed certificate (cheap. check the search engine of your choice,
		2362	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2363	nice program for that purpose).
		2364
		2365	Then create a file with your private key (in PEM format, see
		2366	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2367	file should then look like this:
		2368
		2369	-----BEGIN RSA PRIVATE KEY-----
		2370	...header data
		2371	... lots of base64'y-stuff
		2372	-----END RSA PRIVATE KEY-----
		2373
		2374	-----BEGIN CERTIFICATE-----
		2375	... lots of base64'y-stuff
		2376	-----END CERTIFICATE-----
		2377
		2378	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2379	specify this file as C<cert_file>:
		2380
		2381	tcp_server undef, $port, sub {
		2382	my ($fh) = @_;
		2383
		2384	my $handle = new AnyEvent::Handle
		2385	fh => $fh,
		2386	tls => "accept",
		2387	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2388	...
		2389
		2390	When you have intermediate CA certificates that your clients might not
		2391	know about, just append them to the C<cert_file>.
		2392
1610	=back	2393	=back
1611		2394
1612		2395
1613	=head1 SUBCLASSING AnyEvent::Handle	2396	=head1 SUBCLASSING AnyEvent::Handle
1614		2397
…		…
1633		2416
1634	=item * all members not documented here and not prefixed with an underscore	2417	=item * all members not documented here and not prefixed with an underscore
1635	are free to use in subclasses.	2418	are free to use in subclasses.
1636		2419
1637	Of course, new versions of AnyEvent::Handle may introduce more "public"	2420	Of course, new versions of AnyEvent::Handle may introduce more "public"
1638	member variables, but thats just life, at least it is documented.	2421	member variables, but that's just life. At least it is documented.
1639		2422
1640	=back	2423	=back
1641		2424
1642	=head1 AUTHOR	2425	=head1 AUTHOR
1643		2426

Diff Legend

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