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.82 by root, Thu Aug 21 18:45:16 2008 UTC vs.
Revision 1.182 by root, Thu Sep 3 12:35:01 2009 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 file handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.232;
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 {
32	$cv->broadcast;	15	my ($hdl, $fatal, $msg) = @_;
33	},	16	warn "got error $msg\n";
		17	$hdl->destroy;
		18	$cv->send;
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 module 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	filehandles.
52	on sockets see L<AnyEvent::Util>.	37
		38	The L<AnyEvent::Intro> tutorial contains some well-documented
		39	AnyEvent::Handle examples.
53		40
54	In the following, when the documentation refers to of "bytes" then this	41	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	42	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
57		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
58	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
59	argument.	49	argument.
60		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
61	=head1 METHODS	65	=head1 METHODS
62		66
63	=over 4	67	=over 4
64		68
65	=item B<new (%args)>	69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
66		70
67	The constructor supports these arguments (all as key => value pairs).	71	The constructor supports these arguments (all as C<< key => value >> pairs).
68		72
69	=over 4	73	=over 4
70		74
71	=item fh => $filehandle [MANDATORY]	75	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
72		76
73	The filehandle this L<AnyEvent::Handle> object will operate on.	77	The filehandle this L<AnyEvent::Handle> object will operate on.
74
75	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
77		81
		82	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		83
		84	Try to connect to the specified host and service (port), using
		85	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		86	default C<peername>.
		87
		88	You have to specify either this parameter, or C<fh>, above.
		89
		90	It is possible to push requests on the read and write queues, and modify
		91	properties of the stream, even while AnyEvent::Handle is connecting.
		92
		93	When this parameter is specified, then the C<on_prepare>,
		94	C<on_connect_error> and C<on_connect> callbacks will be called under the
		95	appropriate circumstances:
		96
		97	=over 4
		98
78	=item on_eof => $cb->($handle)	99	=item on_prepare => $cb->($handle)
79		100
80	Set the callback to be called when an end-of-file condition is detected,	101	This (rarely used) callback is called before a new connection is
81	i.e. in the case of a socket, when the other side has closed the	102	attempted, but after the file handle has been created. It could be used to
82	connection cleanly.	103	prepare the file handle with parameters required for the actual connect
		104	(as opposed to settings that can be changed when the connection is already
		105	established).
83		106
84	For sockets, this just means that the other side has stopped sending data,	107	The return value of this callback should be the connect timeout value in
85	you can still try to write data, and, in fact, one can return from the eof	108	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
86	callback and continue writing data, as only the read part has been shut	109	timeout is to be used).
87	down.
88		110
89	While not mandatory, it is I<highly> recommended to set an eof callback,	111	=item on_connect => $cb->($handle, $host, $port, $retry->())
90	otherwise you might end up with a closed socket while you are still
91	waiting for data.
92		112
93	If an EOF condition has been detected but no C<on_eof> callback has been	113	This callback is called when a connection has been successfully established.
94	set, then a fatal error will be raised with C<$!> set to <0>.
95		114
		115	The actual numeric host and port (the socket peername) are passed as
		116	parameters, together with a retry callback.
		117
		118	When, for some reason, the handle is not acceptable, then calling
		119	C<$retry> will continue with the next conenction target (in case of
		120	multi-homed hosts or SRV records there can be multiple connection
		121	endpoints). When it is called then the read and write queues, eof status,
		122	tls status and similar properties of the handle are being reset.
		123
		124	In most cases, ignoring the C<$retry> parameter is the way to go.
		125
		126	=item on_connect_error => $cb->($handle, $message)
		127
		128	This callback is called when the conenction could not be
		129	established. C<$!> will contain the relevant error code, and C<$message> a
		130	message describing it (usually the same as C<"$!">).
		131
		132	If this callback isn't specified, then C<on_error> will be called with a
		133	fatal error instead.
		134
		135	=back
		136
96	=item on_error => $cb->($handle, $fatal)	137	=item on_error => $cb->($handle, $fatal, $message)
97		138
98	This is the error callback, which is called when, well, some error	139	This is the error callback, which is called when, well, some error
99	occured, such as not being able to resolve the hostname, failure to	140	occured, such as not being able to resolve the hostname, failure to
100	connect or a read error.	141	connect or a read error.
101		142
102	Some errors are fatal (which is indicated by C<$fatal> being true). On	143	Some errors are fatal (which is indicated by C<$fatal> being true). On
103	fatal errors the handle object will be shut down and will not be usable	144	fatal errors the handle object will be destroyed (by a call to C<< ->
104	(but you are free to look at the current C< ->rbuf >). Examples of fatal	145	destroy >>) after invoking the error callback (which means you are free to
105	errors are an EOF condition with active (but unsatisifable) read watchers	146	examine the handle object). Examples of fatal errors are an EOF condition
106	(C<EPIPE>) or I/O errors.	147	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		148	cases where the other side can close the connection at their will it is
		149	often easiest to not report C<EPIPE> errors in this callback.
		150
		151	AnyEvent::Handle tries to find an appropriate error code for you to check
		152	against, but in some cases (TLS errors), this does not work well. It is
		153	recommended to always output the C<$message> argument in human-readable
		154	error messages (it's usually the same as C<"$!">).
107		155
108	Non-fatal errors can be retried by simply returning, but it is recommended	156	Non-fatal errors can be retried by simply returning, but it is recommended
109	to simply ignore this parameter and instead abondon the handle object	157	to simply ignore this parameter and instead abondon the handle object
110	when this callback is invoked. Examples of non-fatal errors are timeouts	158	when this callback is invoked. Examples of non-fatal errors are timeouts
111	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	159	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
112		160
113	On callback entrance, the value of C<$!> contains the operating system	161	On callback entrance, the value of C<$!> contains the operating system
114	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	162	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		163	C<EPROTO>).
115		164
116	While not mandatory, it is I<highly> recommended to set this callback, as	165	While not mandatory, it is I<highly> recommended to set this callback, as
117	you will not be notified of errors otherwise. The default simply calls	166	you will not be notified of errors otherwise. The default simply calls
118	C<croak>.	167	C<croak>.
119		168
…		…
123	and no read request is in the queue (unlike read queue callbacks, this	172	and no read request is in the queue (unlike read queue callbacks, this
124	callback will only be called when at least one octet of data is in the	173	callback will only be called when at least one octet of data is in the
125	read buffer).	174	read buffer).
126		175
127	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	176	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
128	method or access the C<$handle->{rbuf}> member directly.	177	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		178	must not enlarge or modify the read buffer, you can only remove data at
		179	the beginning from it.
129		180
130	When an EOF condition is detected then AnyEvent::Handle will first try to	181	When an EOF condition is detected then AnyEvent::Handle will first try to
131	feed all the remaining data to the queued callbacks and C<on_read> before	182	feed all the remaining data to the queued callbacks and C<on_read> before
132	calling the C<on_eof> callback. If no progress can be made, then a fatal	183	calling the C<on_eof> callback. If no progress can be made, then a fatal
133	error will be raised (with C<$!> set to C<EPIPE>).	184	error will be raised (with C<$!> set to C<EPIPE>).
		185
		186	Note that, unlike requests in the read queue, an C<on_read> callback
		187	doesn't mean you I<require> some data: if there is an EOF and there
		188	are outstanding read requests then an error will be flagged. With an
		189	C<on_read> callback, the C<on_eof> callback will be invoked.
		190
		191	=item on_eof => $cb->($handle)
		192
		193	Set the callback to be called when an end-of-file condition is detected,
		194	i.e. in the case of a socket, when the other side has closed the
		195	connection cleanly, and there are no outstanding read requests in the
		196	queue (if there are read requests, then an EOF counts as an unexpected
		197	connection close and will be flagged as an error).
		198
		199	For sockets, this just means that the other side has stopped sending data,
		200	you can still try to write data, and, in fact, one can return from the EOF
		201	callback and continue writing data, as only the read part has been shut
		202	down.
		203
		204	If an EOF condition has been detected but no C<on_eof> callback has been
		205	set, then a fatal error will be raised with C<$!> set to <0>.
134		206
135	=item on_drain => $cb->($handle)	207	=item on_drain => $cb->($handle)
136		208
137	This sets the callback that is called when the write buffer becomes empty	209	This sets the callback that is called when the write buffer becomes empty
138	(or when the callback is set and the buffer is empty already).	210	(or when the callback is set and the buffer is empty already).
…		…
145	memory and push it into the queue, but instead only read more data from	217	memory and push it into the queue, but instead only read more data from
146	the file when the write queue becomes empty.	218	the file when the write queue becomes empty.
147		219
148	=item timeout => $fractional_seconds	220	=item timeout => $fractional_seconds
149		221
		222	=item rtimeout => $fractional_seconds
		223
		224	=item wtimeout => $fractional_seconds
		225
150	If non-zero, then this enables an "inactivity" timeout: whenever this many	226	If non-zero, then these enables an "inactivity" timeout: whenever this
151	seconds pass without a successful read or write on the underlying file	227	many seconds pass without a successful read or write on the underlying
152	handle, the C<on_timeout> callback will be invoked (and if that one is	228	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
153	missing, an C<ETIMEDOUT> error will be raised).	229	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		230	error will be raised).
		231
		232	There are three variants of the timeouts that work fully independent
		233	of each other, for both read and write, just read, and just write:
		234	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		235	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		236	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
154		237
155	Note that timeout processing is also active when you currently do not have	238	Note that timeout processing is also active when you currently do not have
156	any outstanding read or write requests: If you plan to keep the connection	239	any outstanding read or write requests: If you plan to keep the connection
157	idle then you should disable the timout temporarily or ignore the timeout	240	idle then you should disable the timout temporarily or ignore the timeout
158	in the C<on_timeout> callback.	241	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		242	restart the timeout.
159		243
160	Zero (the default) disables this timeout.	244	Zero (the default) disables this timeout.
161		245
162	=item on_timeout => $cb->($handle)	246	=item on_timeout => $cb->($handle)
163		247
…		…
167		251
168	=item rbuf_max => <bytes>	252	=item rbuf_max => <bytes>
169		253
170	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	254	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
171	when the read buffer ever (strictly) exceeds this size. This is useful to	255	when the read buffer ever (strictly) exceeds this size. This is useful to
172	avoid denial-of-service attacks.	256	avoid some forms of denial-of-service attacks.
173		257
174	For example, a server accepting connections from untrusted sources should	258	For example, a server accepting connections from untrusted sources should
175	be configured to accept only so-and-so much data that it cannot act on	259	be configured to accept only so-and-so much data that it cannot act on
176	(for example, when expecting a line, an attacker could send an unlimited	260	(for example, when expecting a line, an attacker could send an unlimited
177	amount of data without a callback ever being called as long as the line	261	amount of data without a callback ever being called as long as the line
178	isn't finished).	262	isn't finished).
179		263
180	=item autocork => <boolean>	264	=item autocork => <boolean>
181		265
182	When disabled (the default), then C<push_write> will try to immediately	266	When disabled (the default), then C<push_write> will try to immediately
183	write the data to the handle if possible. This avoids having to register	267	write the data to the handle, if possible. This avoids having to register
184	a write watcher and wait for the next event loop iteration, but can be	268	a write watcher and wait for the next event loop iteration, but can
185	inefficient if you write multiple small chunks (this disadvantage is	269	be inefficient if you write multiple small chunks (on the wire, this
186	usually avoided by your kernel's nagle algorithm, see C<low_delay>).	270	disadvantage is usually avoided by your kernel's nagle algorithm, see
		271	C<no_delay>, but this option can save costly syscalls).
187		272
188	When enabled, then writes will always be queued till the next event loop	273	When enabled, then writes will always be queued till the next event loop
189	iteration. This is efficient when you do many small writes per iteration,	274	iteration. This is efficient when you do many small writes per iteration,
190	but less efficient when you do a single write only.	275	but less efficient when you do a single write only per iteration (or when
		276	the write buffer often is full). It also increases write latency.
191		277
192	=item no_delay => <boolean>	278	=item no_delay => <boolean>
193		279
194	When doing small writes on sockets, your operating system kernel might	280	When doing small writes on sockets, your operating system kernel might
195	wait a bit for more data before actually sending it out. This is called	281	wait a bit for more data before actually sending it out. This is called
196	the Nagle algorithm, and usually it is beneficial.	282	the Nagle algorithm, and usually it is beneficial.
197		283
198	In some situations you want as low a delay as possible, which cna be	284	In some situations you want as low a delay as possible, which can be
199	accomplishd by setting this option to true.	285	accomplishd by setting this option to a true value.
200		286
201	The default is your opertaing system's default behaviour, this option	287	The default is your opertaing system's default behaviour (most likely
202	explicitly enables or disables it, if possible.	288	enabled), this option explicitly enables or disables it, if possible.
		289
		290	=item keepalive => <boolean>
		291
		292	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		293	normally, TCP connections have no time-out once established, so TCP
		294	conenctions, once established, can stay alive forever even when the other
		295	side has long gone. TCP keepalives are a cheap way to take down long-lived
		296	TCP connections whent he other side becomes unreachable. While the default
		297	is OS-dependent, TCP keepalives usually kick in after around two hours,
		298	and, if the other side doesn't reply, take down the TCP connection some 10
		299	to 15 minutes later.
		300
		301	It is harmless to specify this option for file handles that do not support
		302	keepalives, and enabling it on connections that are potentially long-lived
		303	is usually a good idea.
		304
		305	=item oobinline => <boolean>
		306
		307	BSD majorly fucked up the implementation of TCP urgent data. The result
		308	is that almost no OS implements TCP according to the specs, and every OS
		309	implements it slightly differently.
		310
		311	If you want to handle TCP urgent data, then setting this flag gives you
		312	the most portable way of getting urgent data, by putting it into the
		313	stream.
203		314
204	=item read_size => <bytes>	315	=item read_size => <bytes>
205		316
206	The default read block size (the amount of bytes this module will try to read	317	The default read block size (the amount of bytes this module will
207	during each (loop iteration). Default: C<8192>.	318	try to read during each loop iteration, which affects memory
		319	requirements). Default: C<8192>.
208		320
209	=item low_water_mark => <bytes>	321	=item low_water_mark => <bytes>
210		322
211	Sets the amount of bytes (default: C<0>) that make up an "empty" write	323	Sets the amount of bytes (default: C<0>) that make up an "empty" write
212	buffer: If the write reaches this size or gets even samller it is	324	buffer: If the write reaches this size or gets even samller it is
213	considered empty.	325	considered empty.
214		326
		327	Sometimes it can be beneficial (for performance reasons) to add data to
		328	the write buffer before it is fully drained, but this is a rare case, as
		329	the operating system kernel usually buffers data as well, so the default
		330	is good in almost all cases.
		331
215	=item linger => <seconds>	332	=item linger => <seconds>
216		333
217	If non-zero (default: C<3600>), then the destructor of the	334	If non-zero (default: C<3600>), then the destructor of the
218	AnyEvent::Handle object will check wether there is still outstanding write	335	AnyEvent::Handle object will check whether there is still outstanding
219	data and will install a watcher that will write out this data. No errors	336	write data and will install a watcher that will write this data to the
220	will be reported (this mostly matches how the operating system treats	337	socket. No errors will be reported (this mostly matches how the operating
221	outstanding data at socket close time).	338	system treats outstanding data at socket close time).
222		339
223	This will not work for partial TLS data that could not yet been	340	This will not work for partial TLS data that could not be encoded
224	encoded. This data will be lost.	341	yet. This data will be lost. Calling the C<stoptls> method in time might
		342	help.
		343
		344	=item peername => $string
		345
		346	A string used to identify the remote site - usually the DNS hostname
		347	(I<not> IDN!) used to create the connection, rarely the IP address.
		348
		349	Apart from being useful in error messages, this string is also used in TLS
		350	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		351	verification will be skipped when C<peername> is not specified or
		352	C<undef>.
225		353
226	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	354	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
227		355
228	When this parameter is given, it enables TLS (SSL) mode, that means it	356	When this parameter is given, it enables TLS (SSL) mode, that means
229	will start making tls handshake and will transparently encrypt/decrypt	357	AnyEvent will start a TLS handshake as soon as the conenction has been
230	data.	358	established and will transparently encrypt/decrypt data afterwards.
		359
		360	All TLS protocol errors will be signalled as C<EPROTO>, with an
		361	appropriate error message.
231		362
232	TLS mode requires Net::SSLeay to be installed (it will be loaded	363	TLS mode requires Net::SSLeay to be installed (it will be loaded
233	automatically when you try to create a TLS handle).	364	automatically when you try to create a TLS handle): this module doesn't
		365	have a dependency on that module, so if your module requires it, you have
		366	to add the dependency yourself.
234		367
235	For the TLS server side, use C<accept>, and for the TLS client side of a	368	Unlike TCP, TLS has a server and client side: for the TLS server side, use
236	connection, use C<connect> mode.	369	C<accept>, and for the TLS client side of a connection, use C<connect>
		370	mode.
237		371
238	You can also provide your own TLS connection object, but you have	372	You can also provide your own TLS connection object, but you have
239	to make sure that you call either C<Net::SSLeay::set_connect_state>	373	to make sure that you call either C<Net::SSLeay::set_connect_state>
240	or C<Net::SSLeay::set_accept_state> on it before you pass it to	374	or C<Net::SSLeay::set_accept_state> on it before you pass it to
241	AnyEvent::Handle.	375	AnyEvent::Handle. Also, this module will take ownership of this connection
		376	object.
242		377
		378	At some future point, AnyEvent::Handle might switch to another TLS
		379	implementation, then the option to use your own session object will go
		380	away.
		381
		382	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		383	passing in the wrong integer will lead to certain crash. This most often
		384	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		385	segmentation fault.
		386
243	See the C<starttls> method if you need to start TLS negotiation later.	387	See the C<< ->starttls >> method for when need to start TLS negotiation later.
244		388
245	=item tls_ctx => $ssl_ctx	389	=item tls_ctx => $anyevent_tls
246		390
247	Use the given Net::SSLeay::CTX object to create the new TLS connection	391	Use the given C<AnyEvent::TLS> object to create the new TLS connection
248	(unless a connection object was specified directly). If this parameter is	392	(unless a connection object was specified directly). If this parameter is
249	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	393	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
250		394
		395	Instead of an object, you can also specify a hash reference with C<< key
		396	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		397	new TLS context object.
		398
		399	=item on_starttls => $cb->($handle, $success[, $error_message])
		400
		401	This callback will be invoked when the TLS/SSL handshake has finished. If
		402	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		403	(C<on_stoptls> will not be called in this case).
		404
		405	The session in C<< $handle->{tls} >> can still be examined in this
		406	callback, even when the handshake was not successful.
		407
		408	TLS handshake failures will not cause C<on_error> to be invoked when this
		409	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		410
		411	Without this callback, handshake failures lead to C<on_error> being
		412	called, as normal.
		413
		414	Note that you cannot call C<starttls> right again in this callback. If you
		415	need to do that, start an zero-second timer instead whose callback can
		416	then call C<< ->starttls >> again.
		417
		418	=item on_stoptls => $cb->($handle)
		419
		420	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		421	set, then it will be invoked after freeing the TLS session. If it is not,
		422	then a TLS shutdown condition will be treated like a normal EOF condition
		423	on the handle.
		424
		425	The session in C<< $handle->{tls} >> can still be examined in this
		426	callback.
		427
		428	This callback will only be called on TLS shutdowns, not when the
		429	underlying handle signals EOF.
		430
251	=item json => JSON or JSON::XS object	431	=item json => JSON or JSON::XS object
252		432
253	This is the json coder object used by the C<json> read and write types.	433	This is the json coder object used by the C<json> read and write types.
254		434
255	If you don't supply it, then AnyEvent::Handle will create and use a	435	If you don't supply it, then AnyEvent::Handle will create and use a
256	suitable one, which will write and expect UTF-8 encoded JSON texts.	436	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		437	texts.
257		438
258	Note that you are responsible to depend on the JSON module if you want to	439	Note that you are responsible to depend on the JSON module if you want to
259	use this functionality, as AnyEvent does not have a dependency itself.	440	use this functionality, as AnyEvent does not have a dependency itself.
260		441
261	=item filter_r => $cb
262
263	=item filter_w => $cb
264
265	These exist, but are undocumented at this time.
266
267	=back	442	=back
268		443
269	=cut	444	=cut
270		445
271	sub new {	446	sub new {
272	my $class = shift;	447	my $class = shift;
273
274	my $self = bless { @_ }, $class;	448	my $self = bless { @_ }, $class;
275		449
276	$self->{fh} or Carp::croak "mandatory argument fh is missing";	450	if ($self->{fh}) {
		451	$self->_start;
		452	return unless $self->{fh}; # could be gone by now
		453
		454	} elsif ($self->{connect}) {
		455	require AnyEvent::Socket;
		456
		457	$self->{peername} = $self->{connect}[0]
		458	unless exists $self->{peername};
		459
		460	$self->{_skip_drain_rbuf} = 1;
		461
		462	{
		463	Scalar::Util::weaken (my $self = $self);
		464
		465	$self->{_connect} =
		466	AnyEvent::Socket::tcp_connect (
		467	$self->{connect}[0],
		468	$self->{connect}[1],
		469	sub {
		470	my ($fh, $host, $port, $retry) = @_;
		471
		472	if ($fh) {
		473	$self->{fh} = $fh;
		474
		475	delete $self->{_skip_drain_rbuf};
		476	$self->_start;
		477
		478	$self->{on_connect}
		479	and $self->{on_connect}($self, $host, $port, sub {
		480	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		481	$self->{_skip_drain_rbuf} = 1;
		482	&$retry;
		483	});
		484
		485	} else {
		486	if ($self->{on_connect_error}) {
		487	$self->{on_connect_error}($self, "$!");
		488	$self->destroy;
		489	} else {
		490	$self->_error ($!, 1);
		491	}
		492	}
		493	},
		494	sub {
		495	local $self->{fh} = $_[0];
		496
		497	$self->{on_prepare}
		498	? $self->{on_prepare}->($self)
		499	: ()
		500	}
		501	);
		502	}
		503
		504	} else {
		505	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		506	}
		507
		508	$self
		509	}
		510
		511	sub _start {
		512	my ($self) = @_;
277		513
278	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	514	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
279		515
280	if ($self->{tls}) {	516	$self->{_activity} =
281	require Net::SSLeay;	517	$self->{_ractivity} =
282	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
283	}
284
285	$self->{_activity} = AnyEvent->now;	518	$self->{_wactivity} = AE::now;
286	$self->_timeout;
287		519
288	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	520	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		521	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		522	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		523
289	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	524	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay};
		525	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive};
		526	$self->oobinline (delete $self->{oobinline}) if exists $self->{oobinline};
		527
		528	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		529	if $self->{tls};
		530
		531	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
290		532
291	$self->start_read	533	$self->start_read
292	if $self->{on_read};	534	if $self->{on_read} || @{ $self->{_queue} };
293		535
294	$self	536	$self->_drain_wbuf;
295	}
296
297	sub _shutdown {
298	my ($self) = @_;
299
300	delete $self->{_tw};
301	delete $self->{_rw};
302	delete $self->{_ww};
303	delete $self->{fh};
304
305	$self->stoptls;
306
307	delete $self->{on_read};
308	delete $self->{_queue};
309	}	537	}
310		538
311	sub _error {	539	sub _error {
312	my ($self, $errno, $fatal) = @_;	540	my ($self, $errno, $fatal, $message) = @_;
313
314	$self->_shutdown
315	if $fatal;
316		541
317	$! = $errno;	542	$! = $errno;
		543	$message ||= "$!";
318		544
319	if ($self->{on_error}) {	545	if ($self->{on_error}) {
320	$self->{on_error}($self, $fatal);	546	$self->{on_error}($self, $fatal, $message);
321	} else {	547	$self->destroy if $fatal;
		548	} elsif ($self->{fh}) {
		549	$self->destroy;
322	Carp::croak "AnyEvent::Handle uncaught error: $!";	550	Carp::croak "AnyEvent::Handle uncaught error: $message";
323	}	551	}
324	}	552	}
325		553
326	=item $fh = $handle->fh	554	=item $fh = $handle->fh
327		555
328	This method returns the file handle of the L<AnyEvent::Handle> object.	556	This method returns the file handle used to create the L<AnyEvent::Handle> object.
329		557
330	=cut	558	=cut
331		559
332	sub fh { $_[0]{fh} }	560	sub fh { $_[0]{fh} }
333		561
…		…
351	$_[0]{on_eof} = $_[1];	579	$_[0]{on_eof} = $_[1];
352	}	580	}
353		581
354	=item $handle->on_timeout ($cb)	582	=item $handle->on_timeout ($cb)
355		583
356	Replace the current C<on_timeout> callback, or disables the callback	584	=item $handle->on_rtimeout ($cb)
357	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
358	argument.
359		585
360	=cut	586	=item $handle->on_wtimeout ($cb)
361		587
362	sub on_timeout {	588	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
363	$_[0]{on_timeout} = $_[1];	589	callback, or disables the callback (but not the timeout) if C<$cb> =
364	}	590	C<undef>. See the C<timeout> constructor argument and method.
		591
		592	=cut
		593
		594	# see below
365		595
366	=item $handle->autocork ($boolean)	596	=item $handle->autocork ($boolean)
367		597
368	Enables or disables the current autocork behaviour (see C<autocork>	598	Enables or disables the current autocork behaviour (see C<autocork>
369	constructor argument).	599	constructor argument). Changes will only take effect on the next write.
370		600
371	=cut	601	=cut
		602
		603	sub autocork {
		604	$_[0]{autocork} = $_[1];
		605	}
372		606
373	=item $handle->no_delay ($boolean)	607	=item $handle->no_delay ($boolean)
374		608
375	Enables or disables the C<no_delay> setting (see constructor argument of	609	Enables or disables the C<no_delay> setting (see constructor argument of
376	the same name for details).	610	the same name for details).
…		…
380	sub no_delay {	614	sub no_delay {
381	$_[0]{no_delay} = $_[1];	615	$_[0]{no_delay} = $_[1];
382		616
383	eval {	617	eval {
384	local $SIG{__DIE__};	618	local $SIG{__DIE__};
385	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	619	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		620	if $_[0]{fh};
386	};	621	};
387	}	622	}
388		623
		624	=item $handle->keepalive ($boolean)
		625
		626	Enables or disables the C<keepalive> setting (see constructor argument of
		627	the same name for details).
		628
		629	=cut
		630
		631	sub keepalive {
		632	$_[0]{keepalive} = $_[1];
		633
		634	eval {
		635	local $SIG{__DIE__};
		636	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		637	if $_[0]{fh};
		638	};
		639	}
		640
		641	=item $handle->oobinline ($boolean)
		642
		643	Enables or disables the C<oobinline> setting (see constructor argument of
		644	the same name for details).
		645
		646	=cut
		647
		648	sub oobinline {
		649	$_[0]{oobinline} = $_[1];
		650
		651	eval {
		652	local $SIG{__DIE__};
		653	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		654	if $_[0]{fh};
		655	};
		656	}
		657
		658	=item $handle->keepalive ($boolean)
		659
		660	Enables or disables the C<keepalive> setting (see constructor argument of
		661	the same name for details).
		662
		663	=cut
		664
		665	sub keepalive {
		666	$_[0]{keepalive} = $_[1];
		667
		668	eval {
		669	local $SIG{__DIE__};
		670	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		671	if $_[0]{fh};
		672	};
		673	}
		674
		675	=item $handle->on_starttls ($cb)
		676
		677	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		678
		679	=cut
		680
		681	sub on_starttls {
		682	$_[0]{on_starttls} = $_[1];
		683	}
		684
		685	=item $handle->on_stoptls ($cb)
		686
		687	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		688
		689	=cut
		690
		691	sub on_starttls {
		692	$_[0]{on_stoptls} = $_[1];
		693	}
		694
		695	=item $handle->rbuf_max ($max_octets)
		696
		697	Configures the C<rbuf_max> setting (C<undef> disables it).
		698
		699	=cut
		700
		701	sub rbuf_max {
		702	$_[0]{rbuf_max} = $_[1];
		703	}
		704
389	#############################################################################	705	#############################################################################
390		706
391	=item $handle->timeout ($seconds)	707	=item $handle->timeout ($seconds)
392		708
		709	=item $handle->rtimeout ($seconds)
		710
		711	=item $handle->wtimeout ($seconds)
		712
393	Configures (or disables) the inactivity timeout.	713	Configures (or disables) the inactivity timeout.
394		714
395	=cut	715	=item $handle->timeout_reset
396		716
397	sub timeout {	717	=item $handle->rtimeout_reset
		718
		719	=item $handle->wtimeout_reset
		720
		721	Reset the activity timeout, as if data was received or sent.
		722
		723	These methods are cheap to call.
		724
		725	=cut
		726
		727	for my $dir ("", "r", "w") {
		728	my $timeout = "${dir}timeout";
		729	my $tw = "_${dir}tw";
		730	my $on_timeout = "on_${dir}timeout";
		731	my $activity = "_${dir}activity";
		732	my $cb;
		733
		734	*$on_timeout = sub {
		735	$_[0]{$on_timeout} = $_[1];
		736	};
		737
		738	*$timeout = sub {
398	my ($self, $timeout) = @_;	739	my ($self, $new_value) = @_;
399		740
400	$self->{timeout} = $timeout;	741	$self->{$timeout} = $new_value;
401	$self->_timeout;	742	delete $self->{$tw}; &$cb;
402	}	743	};
403		744
		745	*{"${dir}timeout_reset"} = sub {
		746	$_[0]{$activity} = AE::now;
		747	};
		748
		749	# main workhorse:
404	# reset the timeout watcher, as neccessary	750	# reset the timeout watcher, as neccessary
405	# also check for time-outs	751	# also check for time-outs
406	sub _timeout {	752	$cb = sub {
407	my ($self) = @_;	753	my ($self) = @_;
408		754
409	if ($self->{timeout}) {	755	if ($self->{$timeout} && $self->{fh}) {
410	my $NOW = AnyEvent->now;	756	my $NOW = AE::now;
411		757
412	# when would the timeout trigger?	758	# when would the timeout trigger?
413	my $after = $self->{_activity} + $self->{timeout} - $NOW;	759	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
414		760
415	# now or in the past already?	761	# now or in the past already?
416	if ($after <= 0) {	762	if ($after <= 0) {
417	$self->{_activity} = $NOW;	763	$self->{$activity} = $NOW;
418		764
419	if ($self->{on_timeout}) {	765	if ($self->{$on_timeout}) {
420	$self->{on_timeout}($self);	766	$self->{$on_timeout}($self);
421	} else {	767	} else {
422	$self->_error (&Errno::ETIMEDOUT);	768	$self->_error (Errno::ETIMEDOUT);
		769	}
		770
		771	# callback could have changed timeout value, optimise
		772	return unless $self->{$timeout};
		773
		774	# calculate new after
		775	$after = $self->{$timeout};
423	}	776	}
424		777
425	# callback could have changed timeout value, optimise	778	Scalar::Util::weaken $self;
426	return unless $self->{timeout};	779	return unless $self; # ->error could have destroyed $self
427		780
428	# calculate new after	781	$self->{$tw} ||= AE::timer $after, 0, sub {
429	$after = $self->{timeout};	782	delete $self->{$tw};
		783	$cb->($self);
		784	};
		785	} else {
		786	delete $self->{$tw};
430	}	787	}
431
432	Scalar::Util::weaken $self;
433	return unless $self; # ->error could have destroyed $self
434
435	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
436	delete $self->{_tw};
437	$self->_timeout;
438	});
439	} else {
440	delete $self->{_tw};
441	}	788	}
442	}	789	}
443		790
444	#############################################################################	791	#############################################################################
445		792
…		…
469	my ($self, $cb) = @_;	816	my ($self, $cb) = @_;
470		817
471	$self->{on_drain} = $cb;	818	$self->{on_drain} = $cb;
472		819
473	$cb->($self)	820	$cb->($self)
474	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	821	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
475	}	822	}
476		823
477	=item $handle->push_write ($data)	824	=item $handle->push_write ($data)
478		825
479	Queues the given scalar to be written. You can push as much data as you	826	Queues the given scalar to be written. You can push as much data as you
…		…
490	Scalar::Util::weaken $self;	837	Scalar::Util::weaken $self;
491		838
492	my $cb = sub {	839	my $cb = sub {
493	my $len = syswrite $self->{fh}, $self->{wbuf};	840	my $len = syswrite $self->{fh}, $self->{wbuf};
494		841
495	if ($len >= 0) {	842	if (defined $len) {
496	substr $self->{wbuf}, 0, $len, "";	843	substr $self->{wbuf}, 0, $len, "";
497		844
498	$self->{_activity} = AnyEvent->now;	845	$self->{_activity} = $self->{_wactivity} = AE::now;
499		846
500	$self->{on_drain}($self)	847	$self->{on_drain}($self)
501	if $self->{low_water_mark} >= length $self->{wbuf}	848	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
502	&& $self->{on_drain};	849	&& $self->{on_drain};
503		850
504	delete $self->{_ww} unless length $self->{wbuf};	851	delete $self->{_ww} unless length $self->{wbuf};
505	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	852	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
506	$self->_error ($!, 1);	853	$self->_error ($!, 1);
…		…
509		856
510	# try to write data immediately	857	# try to write data immediately
511	$cb->() unless $self->{autocork};	858	$cb->() unless $self->{autocork};
512		859
513	# if still data left in wbuf, we need to poll	860	# if still data left in wbuf, we need to poll
514	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	861	$self->{_ww} = AE::io $self->{fh}, 1, $cb
515	if length $self->{wbuf};	862	if length $self->{wbuf};
516	};	863	};
517	}	864	}
518		865
519	our %WH;	866	our %WH;
…		…
530		877
531	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	878	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
532	->($self, @_);	879	->($self, @_);
533	}	880	}
534		881
535	if ($self->{filter_w}) {	882	if ($self->{tls}) {
536	$self->{filter_w}($self, \$_[0]);	883	$self->{_tls_wbuf} .= $_[0];
		884	&_dotls ($self) if $self->{fh};
537	} else {	885	} else {
538	$self->{wbuf} .= $_[0];	886	$self->{wbuf} .= $_[0];
539	$self->_drain_wbuf;	887	$self->_drain_wbuf if $self->{fh};
540	}	888	}
541	}	889	}
542		890
543	=item $handle->push_write (type => @args)	891	=item $handle->push_write (type => @args)
544		892
…		…
558	=cut	906	=cut
559		907
560	register_write_type netstring => sub {	908	register_write_type netstring => sub {
561	my ($self, $string) = @_;	909	my ($self, $string) = @_;
562		910
563	sprintf "%d:%s,", (length $string), $string	911	(length $string) . ":$string,"
564	};	912	};
565		913
566	=item packstring => $format, $data	914	=item packstring => $format, $data
567		915
568	An octet string prefixed with an encoded length. The encoding C<$format>	916	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
608	Other languages could read single lines terminated by a newline and pass	956	Other languages could read single lines terminated by a newline and pass
609	this line into their JSON decoder of choice.	957	this line into their JSON decoder of choice.
610		958
611	=cut	959	=cut
612		960
		961	sub json_coder() {
		962	eval { require JSON::XS; JSON::XS->new->utf8 }
		963	|| do { require JSON; JSON->new->utf8 }
		964	}
		965
613	register_write_type json => sub {	966	register_write_type json => sub {
614	my ($self, $ref) = @_;	967	my ($self, $ref) = @_;
615		968
616	require JSON;	969	my $json = $self->{json} ||= json_coder;
617		970
618	$self->{json} ? $self->{json}->encode ($ref)	971	$json->encode ($ref)
619	: JSON::encode_json ($ref)
620	};	972	};
621		973
622	=item storable => $reference	974	=item storable => $reference
623		975
624	Freezes the given reference using L<Storable> and writes it to the	976	Freezes the given reference using L<Storable> and writes it to the
…		…
633		985
634	pack "w/a*", Storable::nfreeze ($ref)	986	pack "w/a*", Storable::nfreeze ($ref)
635	};	987	};
636		988
637	=back	989	=back
		990
		991	=item $handle->push_shutdown
		992
		993	Sometimes you know you want to close the socket after writing your data
		994	before it was actually written. One way to do that is to replace your
		995	C<on_drain> handler by a callback that shuts down the socket (and set
		996	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		997	replaces the C<on_drain> callback with:
		998
		999	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		1000
		1001	This simply shuts down the write side and signals an EOF condition to the
		1002	the peer.
		1003
		1004	You can rely on the normal read queue and C<on_eof> handling
		1005	afterwards. This is the cleanest way to close a connection.
		1006
		1007	=cut
		1008
		1009	sub push_shutdown {
		1010	my ($self) = @_;
		1011
		1012	delete $self->{low_water_mark};
		1013	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1014	}
638		1015
639	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1016	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
640		1017
641	This function (not method) lets you add your own types to C<push_write>.	1018	This function (not method) lets you add your own types to C<push_write>.
642	Whenever the given C<type> is used, C<push_write> will invoke the code	1019	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
736	=cut	1113	=cut
737		1114
738	sub _drain_rbuf {	1115	sub _drain_rbuf {
739	my ($self) = @_;	1116	my ($self) = @_;
740		1117
		1118	# avoid recursion
		1119	return if $self->{_skip_drain_rbuf};
741	local $self->{_in_drain} = 1;	1120	local $self->{_skip_drain_rbuf} = 1;
742
743	if (
744	defined $self->{rbuf_max}
745	&& $self->{rbuf_max} < length $self->{rbuf}
746	) {
747	$self->_error (&Errno::ENOSPC, 1), return;
748	}
749		1121
750	while () {	1122	while () {
		1123	# we need to use a separate tls read buffer, as we must not receive data while
		1124	# we are draining the buffer, and this can only happen with TLS.
		1125	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1126	if exists $self->{_tls_rbuf};
		1127
751	my $len = length $self->{rbuf};	1128	my $len = length $self->{rbuf};
752		1129
753	if (my $cb = shift @{ $self->{_queue} }) {	1130	if (my $cb = shift @{ $self->{_queue} }) {
754	unless ($cb->($self)) {	1131	unless ($cb->($self)) {
755	if ($self->{_eof}) {	1132	# no progress can be made
756	# no progress can be made (not enough data and no data forthcoming)	1133	# (not enough data and no data forthcoming)
757	$self->_error (&Errno::EPIPE, 1), return;	1134	$self->_error (Errno::EPIPE, 1), return
758	}	1135	if $self->{_eof};
759		1136
760	unshift @{ $self->{_queue} }, $cb;	1137	unshift @{ $self->{_queue} }, $cb;
761	last;	1138	last;
762	}	1139	}
763	} elsif ($self->{on_read}) {	1140	} elsif ($self->{on_read}) {
…		…
770	&& !@{ $self->{_queue} } # and the queue is still empty	1147	&& !@{ $self->{_queue} } # and the queue is still empty
771	&& $self->{on_read} # but we still have on_read	1148	&& $self->{on_read} # but we still have on_read
772	) {	1149	) {
773	# no further data will arrive	1150	# no further data will arrive
774	# so no progress can be made	1151	# so no progress can be made
775	$self->_error (&Errno::EPIPE, 1), return	1152	$self->_error (Errno::EPIPE, 1), return
776	if $self->{_eof};	1153	if $self->{_eof};
777		1154
778	last; # more data might arrive	1155	last; # more data might arrive
779	}	1156	}
780	} else {	1157	} else {
781	# read side becomes idle	1158	# read side becomes idle
782	delete $self->{_rw};	1159	delete $self->{_rw} unless $self->{tls};
783	last;	1160	last;
784	}	1161	}
785	}	1162	}
786		1163
787	if ($self->{_eof}) {	1164	if ($self->{_eof}) {
788	if ($self->{on_eof}) {	1165	$self->{on_eof}
789	$self->{on_eof}($self)	1166	? $self->{on_eof}($self)
790	} else {	1167	: $self->_error (0, 1, "Unexpected end-of-file");
791	$self->_error (0, 1);	1168
792	}	1169	return;
		1170	}
		1171
		1172	if (
		1173	defined $self->{rbuf_max}
		1174	&& $self->{rbuf_max} < length $self->{rbuf}
		1175	) {
		1176	$self->_error (Errno::ENOSPC, 1), return;
793	}	1177	}
794		1178
795	# may need to restart read watcher	1179	# may need to restart read watcher
796	unless ($self->{_rw}) {	1180	unless ($self->{_rw}) {
797	$self->start_read	1181	$self->start_read
…		…
809		1193
810	sub on_read {	1194	sub on_read {
811	my ($self, $cb) = @_;	1195	my ($self, $cb) = @_;
812		1196
813	$self->{on_read} = $cb;	1197	$self->{on_read} = $cb;
814	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1198	$self->_drain_rbuf if $cb;
815	}	1199	}
816		1200
817	=item $handle->rbuf	1201	=item $handle->rbuf
818		1202
819	Returns the read buffer (as a modifiable lvalue).	1203	Returns the read buffer (as a modifiable lvalue).
820		1204
821	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1205	You can access the read buffer directly as the C<< ->{rbuf} >>
822	you want.	1206	member, if you want. However, the only operation allowed on the
		1207	read buffer (apart from looking at it) is removing data from its
		1208	beginning. Otherwise modifying or appending to it is not allowed and will
		1209	lead to hard-to-track-down bugs.
823		1210
824	NOTE: The read buffer should only be used or modified if the C<on_read>,	1211	NOTE: The read buffer should only be used or modified if the C<on_read>,
825	C<push_read> or C<unshift_read> methods are used. The other read methods	1212	C<push_read> or C<unshift_read> methods are used. The other read methods
826	automatically manage the read buffer.	1213	automatically manage the read buffer.
827		1214
…		…
868	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1255	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
869	->($self, $cb, @_);	1256	->($self, $cb, @_);
870	}	1257	}
871		1258
872	push @{ $self->{_queue} }, $cb;	1259	push @{ $self->{_queue} }, $cb;
873	$self->_drain_rbuf unless $self->{_in_drain};	1260	$self->_drain_rbuf;
874	}	1261	}
875		1262
876	sub unshift_read {	1263	sub unshift_read {
877	my $self = shift;	1264	my $self = shift;
878	my $cb = pop;	1265	my $cb = pop;
…		…
882		1269
883	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1270	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
884	->($self, $cb, @_);	1271	->($self, $cb, @_);
885	}	1272	}
886		1273
887
888	unshift @{ $self->{_queue} }, $cb;	1274	unshift @{ $self->{_queue} }, $cb;
889	$self->_drain_rbuf unless $self->{_in_drain};	1275	$self->_drain_rbuf;
890	}	1276	}
891		1277
892	=item $handle->push_read (type => @args, $cb)	1278	=item $handle->push_read (type => @args, $cb)
893		1279
894	=item $handle->unshift_read (type => @args, $cb)	1280	=item $handle->unshift_read (type => @args, $cb)
…		…
1027	return 1;	1413	return 1;
1028	}	1414	}
1029		1415
1030	# reject	1416	# reject
1031	if ($reject && $$rbuf =~ $reject) {	1417	if ($reject && $$rbuf =~ $reject) {
1032	$self->_error (&Errno::EBADMSG);	1418	$self->_error (Errno::EBADMSG);
1033	}	1419	}
1034		1420
1035	# skip	1421	# skip
1036	if ($skip && $$rbuf =~ $skip) {	1422	if ($skip && $$rbuf =~ $skip) {
1037	$data .= substr $$rbuf, 0, $+[0], "";	1423	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1053	my ($self, $cb) = @_;	1439	my ($self, $cb) = @_;
1054		1440
1055	sub {	1441	sub {
1056	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1442	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1057	if ($_[0]{rbuf} =~ /[^0-9]/) {	1443	if ($_[0]{rbuf} =~ /[^0-9]/) {
1058	$self->_error (&Errno::EBADMSG);	1444	$self->_error (Errno::EBADMSG);
1059	}	1445	}
1060	return;	1446	return;
1061	}	1447	}
1062		1448
1063	my $len = $1;	1449	my $len = $1;
…		…
1066	my $string = $_[1];	1452	my $string = $_[1];
1067	$_[0]->unshift_read (chunk => 1, sub {	1453	$_[0]->unshift_read (chunk => 1, sub {
1068	if ($_[1] eq ",") {	1454	if ($_[1] eq ",") {
1069	$cb->($_[0], $string);	1455	$cb->($_[0], $string);
1070	} else {	1456	} else {
1071	$self->_error (&Errno::EBADMSG);	1457	$self->_error (Errno::EBADMSG);
1072	}	1458	}
1073	});	1459	});
1074	});	1460	});
1075		1461
1076	1	1462	1
…		…
1082	An octet string prefixed with an encoded length. The encoding C<$format>	1468	An octet string prefixed with an encoded length. The encoding C<$format>
1083	uses the same format as a Perl C<pack> format, but must specify a single	1469	uses the same format as a Perl C<pack> format, but must specify a single
1084	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1470	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1085	optional C<!>, C<< < >> or C<< > >> modifier).	1471	optional C<!>, C<< < >> or C<< > >> modifier).
1086		1472
1087	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1473	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1474	EPP uses a prefix of C<N> (4 octtes).
1088		1475
1089	Example: read a block of data prefixed by its length in BER-encoded	1476	Example: read a block of data prefixed by its length in BER-encoded
1090	format (very efficient).	1477	format (very efficient).
1091		1478
1092	$handle->push_read (packstring => "w", sub {	1479	$handle->push_read (packstring => "w", sub {
…		…
1122	}	1509	}
1123	};	1510	};
1124		1511
1125	=item json => $cb->($handle, $hash_or_arrayref)	1512	=item json => $cb->($handle, $hash_or_arrayref)
1126		1513
1127	Reads a JSON object or array, decodes it and passes it to the callback.	1514	Reads a JSON object or array, decodes it and passes it to the
		1515	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1128		1516
1129	If a C<json> object was passed to the constructor, then that will be used	1517	If a C<json> object was passed to the constructor, then that will be used
1130	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1518	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1131		1519
1132	This read type uses the incremental parser available with JSON version	1520	This read type uses the incremental parser available with JSON version
…		…
1141	=cut	1529	=cut
1142		1530
1143	register_read_type json => sub {	1531	register_read_type json => sub {
1144	my ($self, $cb) = @_;	1532	my ($self, $cb) = @_;
1145		1533
1146	require JSON;	1534	my $json = $self->{json} ||= json_coder;
1147		1535
1148	my $data;	1536	my $data;
1149	my $rbuf = \$self->{rbuf};	1537	my $rbuf = \$self->{rbuf};
1150		1538
1151	my $json = $self->{json} ||= JSON->new->utf8;
1152
1153	sub {	1539	sub {
1154	my $ref = $json->incr_parse ($self->{rbuf});	1540	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1155		1541
1156	if ($ref) {	1542	if ($ref) {
1157	$self->{rbuf} = $json->incr_text;	1543	$self->{rbuf} = $json->incr_text;
1158	$json->incr_text = "";	1544	$json->incr_text = "";
1159	$cb->($self, $ref);	1545	$cb->($self, $ref);
1160		1546
1161	1	1547	1
		1548	} elsif ($@) {
		1549	# error case
		1550	$json->incr_skip;
		1551
		1552	$self->{rbuf} = $json->incr_text;
		1553	$json->incr_text = "";
		1554
		1555	$self->_error (Errno::EBADMSG);
		1556
		1557	()
1162	} else {	1558	} else {
1163	$self->{rbuf} = "";	1559	$self->{rbuf} = "";
		1560
1164	()	1561	()
1165	}	1562	}
1166	}	1563	}
1167	};	1564	};
1168		1565
…		…
1200	# read remaining chunk	1597	# read remaining chunk
1201	$_[0]->unshift_read (chunk => $len, sub {	1598	$_[0]->unshift_read (chunk => $len, sub {
1202	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1599	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1203	$cb->($_[0], $ref);	1600	$cb->($_[0], $ref);
1204	} else {	1601	} else {
1205	$self->_error (&Errno::EBADMSG);	1602	$self->_error (Errno::EBADMSG);
1206	}	1603	}
1207	});	1604	});
1208	}	1605	}
1209		1606
1210	1	1607	1
…		…
1245	Note that AnyEvent::Handle will automatically C<start_read> for you when	1642	Note that AnyEvent::Handle will automatically C<start_read> for you when
1246	you change the C<on_read> callback or push/unshift a read callback, and it	1643	you change the C<on_read> callback or push/unshift a read callback, and it
1247	will automatically C<stop_read> for you when neither C<on_read> is set nor	1644	will automatically C<stop_read> for you when neither C<on_read> is set nor
1248	there are any read requests in the queue.	1645	there are any read requests in the queue.
1249		1646
		1647	These methods will have no effect when in TLS mode (as TLS doesn't support
		1648	half-duplex connections).
		1649
1250	=cut	1650	=cut
1251		1651
1252	sub stop_read {	1652	sub stop_read {
1253	my ($self) = @_;	1653	my ($self) = @_;
1254		1654
1255	delete $self->{_rw};	1655	delete $self->{_rw} unless $self->{tls};
1256	}	1656	}
1257		1657
1258	sub start_read {	1658	sub start_read {
1259	my ($self) = @_;	1659	my ($self) = @_;
1260		1660
1261	unless ($self->{_rw} || $self->{_eof}) {	1661	unless ($self->{_rw} || $self->{_eof}) {
1262	Scalar::Util::weaken $self;	1662	Scalar::Util::weaken $self;
1263		1663
1264	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1664	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1265	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1665	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1266	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1666	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1267		1667
1268	if ($len > 0) {	1668	if ($len > 0) {
1269	$self->{_activity} = AnyEvent->now;	1669	$self->{_activity} = $self->{_ractivity} = AE::now;
1270		1670
1271	$self->{filter_r}	1671	if ($self->{tls}) {
1272	? $self->{filter_r}($self, $rbuf)	1672	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1273	: $self->{_in_drain} || $self->_drain_rbuf;	1673
		1674	&_dotls ($self);
		1675	} else {
		1676	$self->_drain_rbuf;
		1677	}
1274		1678
1275	} elsif (defined $len) {	1679	} elsif (defined $len) {
1276	delete $self->{_rw};	1680	delete $self->{_rw};
1277	$self->{_eof} = 1;	1681	$self->{_eof} = 1;
1278	$self->_drain_rbuf unless $self->{_in_drain};	1682	$self->_drain_rbuf;
1279		1683
1280	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1684	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1281	return $self->_error ($!, 1);	1685	return $self->_error ($!, 1);
1282	}	1686	}
1283	});	1687	};
1284	}	1688	}
1285	}	1689	}
1286		1690
		1691	our $ERROR_SYSCALL;
		1692	our $ERROR_WANT_READ;
		1693
		1694	sub _tls_error {
		1695	my ($self, $err) = @_;
		1696
		1697	return $self->_error ($!, 1)
		1698	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1699
		1700	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1701
		1702	# reduce error string to look less scary
		1703	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1704
		1705	if ($self->{_on_starttls}) {
		1706	(delete $self->{_on_starttls})->($self, undef, $err);
		1707	&_freetls;
		1708	} else {
		1709	&_freetls;
		1710	$self->_error (Errno::EPROTO, 1, $err);
		1711	}
		1712	}
		1713
		1714	# poll the write BIO and send the data if applicable
		1715	# also decode read data if possible
		1716	# this is basiclaly our TLS state machine
		1717	# more efficient implementations are possible with openssl,
		1718	# but not with the buggy and incomplete Net::SSLeay.
1287	sub _dotls {	1719	sub _dotls {
1288	my ($self) = @_;	1720	my ($self) = @_;
1289		1721
1290	my $buf;	1722	my $tmp;
1291		1723
1292	if (length $self->{_tls_wbuf}) {	1724	if (length $self->{_tls_wbuf}) {
1293	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1725	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1294	substr $self->{_tls_wbuf}, 0, $len, "";	1726	substr $self->{_tls_wbuf}, 0, $tmp, "";
1295	}	1727	}
1296	}
1297		1728
		1729	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1730	return $self->_tls_error ($tmp)
		1731	if $tmp != $ERROR_WANT_READ
		1732	&& ($tmp != $ERROR_SYSCALL || $!);
		1733	}
		1734
		1735	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1736	unless (length $tmp) {
		1737	$self->{_on_starttls}
		1738	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1739	&_freetls;
		1740
		1741	if ($self->{on_stoptls}) {
		1742	$self->{on_stoptls}($self);
		1743	return;
		1744	} else {
		1745	# let's treat SSL-eof as we treat normal EOF
		1746	delete $self->{_rw};
		1747	$self->{_eof} = 1;
		1748	}
		1749	}
		1750
		1751	$self->{_tls_rbuf} .= $tmp;
		1752	$self->_drain_rbuf;
		1753	$self->{tls} or return; # tls session might have gone away in callback
		1754	}
		1755
		1756	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1757	return $self->_tls_error ($tmp)
		1758	if $tmp != $ERROR_WANT_READ
		1759	&& ($tmp != $ERROR_SYSCALL || $!);
		1760
1298	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1761	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1299	$self->{wbuf} .= $buf;	1762	$self->{wbuf} .= $tmp;
1300	$self->_drain_wbuf;	1763	$self->_drain_wbuf;
1301	}	1764	}
1302		1765
1303	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1766	$self->{_on_starttls}
1304	if (length $buf) {	1767	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1305	$self->{rbuf} .= $buf;	1768	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1306	$self->_drain_rbuf unless $self->{_in_drain};
1307	} else {
1308	# let's treat SSL-eof as we treat normal EOF
1309	$self->{_eof} = 1;
1310	$self->_shutdown;
1311	return;
1312	}
1313	}
1314
1315	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1316
1317	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1318	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1319	return $self->_error ($!, 1);
1320	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1321	return $self->_error (&Errno::EIO, 1);
1322	}
1323
1324	# all others are fine for our purposes
1325	}
1326	}	1769	}
1327		1770
1328	=item $handle->starttls ($tls[, $tls_ctx])	1771	=item $handle->starttls ($tls[, $tls_ctx])
1329		1772
1330	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1773	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1331	object is created, you can also do that at a later time by calling	1774	object is created, you can also do that at a later time by calling
1332	C<starttls>.	1775	C<starttls>.
1333		1776
		1777	Starting TLS is currently an asynchronous operation - when you push some
		1778	write data and then call C<< ->starttls >> then TLS negotiation will start
		1779	immediately, after which the queued write data is then sent.
		1780
1334	The first argument is the same as the C<tls> constructor argument (either	1781	The first argument is the same as the C<tls> constructor argument (either
1335	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1782	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1336		1783
1337	The second argument is the optional C<Net::SSLeay::CTX> object that is	1784	The second argument is the optional C<AnyEvent::TLS> object that is used
1338	used when AnyEvent::Handle has to create its own TLS connection object.	1785	when AnyEvent::Handle has to create its own TLS connection object, or
		1786	a hash reference with C<< key => value >> pairs that will be used to
		1787	construct a new context.
1339		1788
1340	The TLS connection object will end up in C<< $handle->{tls} >> after this	1789	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1341	call and can be used or changed to your liking. Note that the handshake	1790	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1342	might have already started when this function returns.	1791	changed to your liking. Note that the handshake might have already started
		1792	when this function returns.
1343		1793
		1794	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		1795	handshakes on the same stream. Best do not attempt to use the stream after
		1796	stopping TLS.
		1797
1344	=cut	1798	=cut
		1799
		1800	our %TLS_CACHE; #TODO not yet documented, should we?
1345		1801
1346	sub starttls {	1802	sub starttls {
1347	my ($self, $ssl, $ctx) = @_;	1803	my ($self, $tls, $ctx) = @_;
1348		1804
1349	$self->stoptls;	1805	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1806	if $self->{tls};
1350		1807
1351	if ($ssl eq "accept") {	1808	$self->{tls} = $tls;
1352	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1809	$self->{tls_ctx} = $ctx if @_ > 2;
1353	Net::SSLeay::set_accept_state ($ssl);	1810
1354	} elsif ($ssl eq "connect") {	1811	return unless $self->{fh};
1355	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1812
1356	Net::SSLeay::set_connect_state ($ssl);	1813	require Net::SSLeay;
		1814
		1815	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1816	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1817
		1818	$tls = delete $self->{tls};
		1819	$ctx = $self->{tls_ctx};
		1820
		1821	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1822
		1823	if ("HASH" eq ref $ctx) {
		1824	require AnyEvent::TLS;
		1825
		1826	if ($ctx->{cache}) {
		1827	my $key = $ctx+0;
		1828	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1829	} else {
		1830	$ctx = new AnyEvent::TLS %$ctx;
		1831	}
		1832	}
1357	}	1833
1358		1834	$self->{tls_ctx} = $ctx || TLS_CTX ();
1359	$self->{tls} = $ssl;	1835	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1360		1836
1361	# basically, this is deep magic (because SSL_read should have the same issues)	1837	# basically, this is deep magic (because SSL_read should have the same issues)
1362	# but the openssl maintainers basically said: "trust us, it just works".	1838	# but the openssl maintainers basically said: "trust us, it just works".
1363	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1839	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1364	# and mismaintained ssleay-module doesn't even offer them).	1840	# and mismaintained ssleay-module doesn't even offer them).
1365	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1841	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1842	#
		1843	# in short: this is a mess.
		1844	#
		1845	# note that we do not try to keep the length constant between writes as we are required to do.
		1846	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1847	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1848	# have identity issues in that area.
1366	Net::SSLeay::CTX_set_mode ($self->{tls},	1849	# Net::SSLeay::CTX_set_mode ($ssl,
1367	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1850	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1368	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1851	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1852	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1369		1853
1370	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1854	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1371	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1855	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1372		1856
		1857	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1858
1373	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1859	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1374		1860
1375	$self->{filter_w} = sub {	1861	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1376	$_[0]{_tls_wbuf} .= ${$_[1]};	1862	if $self->{on_starttls};
1377	&_dotls;	1863
1378	};	1864	&_dotls; # need to trigger the initial handshake
1379	$self->{filter_r} = sub {	1865	$self->start_read; # make sure we actually do read
1380	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1381	&_dotls;
1382	};
1383	}	1866	}
1384		1867
1385	=item $handle->stoptls	1868	=item $handle->stoptls
1386		1869
1387	Destroys the SSL connection, if any. Partial read or write data will be	1870	Shuts down the SSL connection - this makes a proper EOF handshake by
1388	lost.	1871	sending a close notify to the other side, but since OpenSSL doesn't
		1872	support non-blocking shut downs, it is not guarenteed that you can re-use
		1873	the stream afterwards.
1389		1874
1390	=cut	1875	=cut
1391		1876
1392	sub stoptls {	1877	sub stoptls {
1393	my ($self) = @_;	1878	my ($self) = @_;
1394		1879
1395	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1880	if ($self->{tls}) {
		1881	Net::SSLeay::shutdown ($self->{tls});
1396		1882
1397	delete $self->{_rbio};	1883	&_dotls;
1398	delete $self->{_wbio};	1884
1399	delete $self->{_tls_wbuf};	1885	# # we don't give a shit. no, we do, but we can't. no...#d#
1400	delete $self->{filter_r};	1886	# # we, we... have to use openssl :/#d#
1401	delete $self->{filter_w};	1887	# &_freetls;#d#
		1888	}
		1889	}
		1890
		1891	sub _freetls {
		1892	my ($self) = @_;
		1893
		1894	return unless $self->{tls};
		1895
		1896	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1897	if $self->{tls} > 0;
		1898
		1899	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1402	}	1900	}
1403		1901
1404	sub DESTROY {	1902	sub DESTROY {
1405	my $self = shift;	1903	my ($self) = @_;
1406		1904
1407	$self->stoptls;	1905	&_freetls;
1408		1906
1409	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1907	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1410		1908
1411	if ($linger && length $self->{wbuf}) {	1909	if ($linger && length $self->{wbuf} && $self->{fh}) {
1412	my $fh = delete $self->{fh};	1910	my $fh = delete $self->{fh};
1413	my $wbuf = delete $self->{wbuf};	1911	my $wbuf = delete $self->{wbuf};
1414		1912
1415	my @linger;	1913	my @linger;
1416		1914
1417	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1915	push @linger, AE::io $fh, 1, sub {
1418	my $len = syswrite $fh, $wbuf, length $wbuf;	1916	my $len = syswrite $fh, $wbuf, length $wbuf;
1419		1917
1420	if ($len > 0) {	1918	if ($len > 0) {
1421	substr $wbuf, 0, $len, "";	1919	substr $wbuf, 0, $len, "";
1422	} else {	1920	} else {
1423	@linger = (); # end	1921	@linger = (); # end
1424	}	1922	}
1425	});	1923	};
1426	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1924	push @linger, AE::timer $linger, 0, sub {
1427	@linger = ();	1925	@linger = ();
1428	});	1926	};
1429	}	1927	}
		1928	}
		1929
		1930	=item $handle->destroy
		1931
		1932	Shuts down the handle object as much as possible - this call ensures that
		1933	no further callbacks will be invoked and as many resources as possible
		1934	will be freed. Any method you will call on the handle object after
		1935	destroying it in this way will be silently ignored (and it will return the
		1936	empty list).
		1937
		1938	Normally, you can just "forget" any references to an AnyEvent::Handle
		1939	object and it will simply shut down. This works in fatal error and EOF
		1940	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1941	callback, so when you want to destroy the AnyEvent::Handle object from
		1942	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1943	that case.
		1944
		1945	Destroying the handle object in this way has the advantage that callbacks
		1946	will be removed as well, so if those are the only reference holders (as
		1947	is common), then one doesn't need to do anything special to break any
		1948	reference cycles.
		1949
		1950	The handle might still linger in the background and write out remaining
		1951	data, as specified by the C<linger> option, however.
		1952
		1953	=cut
		1954
		1955	sub destroy {
		1956	my ($self) = @_;
		1957
		1958	$self->DESTROY;
		1959	%$self = ();
		1960	bless $self, "AnyEvent::Handle::destroyed";
		1961	}
		1962
		1963	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1964	#nop
1430	}	1965	}
1431		1966
1432	=item AnyEvent::Handle::TLS_CTX	1967	=item AnyEvent::Handle::TLS_CTX
1433		1968
1434	This function creates and returns the Net::SSLeay::CTX object used by	1969	This function creates and returns the AnyEvent::TLS object used by default
1435	default for TLS mode.	1970	for TLS mode.
1436		1971
1437	The context is created like this:	1972	The context is created by calling L<AnyEvent::TLS> without any arguments.
1438
1439	Net::SSLeay::load_error_strings;
1440	Net::SSLeay::SSLeay_add_ssl_algorithms;
1441	Net::SSLeay::randomize;
1442
1443	my $CTX = Net::SSLeay::CTX_new;
1444
1445	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1446		1973
1447	=cut	1974	=cut
1448		1975
1449	our $TLS_CTX;	1976	our $TLS_CTX;
1450		1977
1451	sub TLS_CTX() {	1978	sub TLS_CTX() {
1452	$TLS_CTX || do {	1979	$TLS_CTX ||= do {
1453	require Net::SSLeay;	1980	require AnyEvent::TLS;
1454		1981
1455	Net::SSLeay::load_error_strings ();	1982	new AnyEvent::TLS
1456	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1457	Net::SSLeay::randomize ();
1458
1459	$TLS_CTX = Net::SSLeay::CTX_new ();
1460
1461	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1462
1463	$TLS_CTX
1464	}	1983	}
1465	}	1984	}
1466		1985
1467	=back	1986	=back
		1987
		1988
		1989	=head1 NONFREQUENTLY ASKED QUESTIONS
		1990
		1991	=over 4
		1992
		1993	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1994	still get further invocations!
		1995
		1996	That's because AnyEvent::Handle keeps a reference to itself when handling
		1997	read or write callbacks.
		1998
		1999	It is only safe to "forget" the reference inside EOF or error callbacks,
		2000	from within all other callbacks, you need to explicitly call the C<<
		2001	->destroy >> method.
		2002
		2003	=item I get different callback invocations in TLS mode/Why can't I pause
		2004	reading?
		2005
		2006	Unlike, say, TCP, TLS connections do not consist of two independent
		2007	communication channels, one for each direction. Or put differently. The
		2008	read and write directions are not independent of each other: you cannot
		2009	write data unless you are also prepared to read, and vice versa.
		2010
		2011	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		2012	callback invocations when you are not expecting any read data - the reason
		2013	is that AnyEvent::Handle always reads in TLS mode.
		2014
		2015	During the connection, you have to make sure that you always have a
		2016	non-empty read-queue, or an C<on_read> watcher. At the end of the
		2017	connection (or when you no longer want to use it) you can call the
		2018	C<destroy> method.
		2019
		2020	=item How do I read data until the other side closes the connection?
		2021
		2022	If you just want to read your data into a perl scalar, the easiest way
		2023	to achieve this is by setting an C<on_read> callback that does nothing,
		2024	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		2025	will be in C<$_[0]{rbuf}>:
		2026
		2027	$handle->on_read (sub { });
		2028	$handle->on_eof (undef);
		2029	$handle->on_error (sub {
		2030	my $data = delete $_[0]{rbuf};
		2031	});
		2032
		2033	The reason to use C<on_error> is that TCP connections, due to latencies
		2034	and packets loss, might get closed quite violently with an error, when in
		2035	fact, all data has been received.
		2036
		2037	It is usually better to use acknowledgements when transferring data,
		2038	to make sure the other side hasn't just died and you got the data
		2039	intact. This is also one reason why so many internet protocols have an
		2040	explicit QUIT command.
		2041
		2042	=item I don't want to destroy the handle too early - how do I wait until
		2043	all data has been written?
		2044
		2045	After writing your last bits of data, set the C<on_drain> callback
		2046	and destroy the handle in there - with the default setting of
		2047	C<low_water_mark> this will be called precisely when all data has been
		2048	written to the socket:
		2049
		2050	$handle->push_write (...);
		2051	$handle->on_drain (sub {
		2052	warn "all data submitted to the kernel\n";
		2053	undef $handle;
		2054	});
		2055
		2056	If you just want to queue some data and then signal EOF to the other side,
		2057	consider using C<< ->push_shutdown >> instead.
		2058
		2059	=item I want to contact a TLS/SSL server, I don't care about security.
		2060
		2061	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2062	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		2063	parameter:
		2064
		2065	tcp_connect $host, $port, sub {
		2066	my ($fh) = @_;
		2067
		2068	my $handle = new AnyEvent::Handle
		2069	fh => $fh,
		2070	tls => "connect",
		2071	on_error => sub { ... };
		2072
		2073	$handle->push_write (...);
		2074	};
		2075
		2076	=item I want to contact a TLS/SSL server, I do care about security.
		2077
		2078	Then you should additionally enable certificate verification, including
		2079	peername verification, if the protocol you use supports it (see
		2080	L<AnyEvent::TLS>, C<verify_peername>).
		2081
		2082	E.g. for HTTPS:
		2083
		2084	tcp_connect $host, $port, sub {
		2085	my ($fh) = @_;
		2086
		2087	my $handle = new AnyEvent::Handle
		2088	fh => $fh,
		2089	peername => $host,
		2090	tls => "connect",
		2091	tls_ctx => { verify => 1, verify_peername => "https" },
		2092	...
		2093
		2094	Note that you must specify the hostname you connected to (or whatever
		2095	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2096	peername verification will be done.
		2097
		2098	The above will use the system-dependent default set of trusted CA
		2099	certificates. If you want to check against a specific CA, add the
		2100	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2101
		2102	tls_ctx => {
		2103	verify => 1,
		2104	verify_peername => "https",
		2105	ca_file => "my-ca-cert.pem",
		2106	},
		2107
		2108	=item I want to create a TLS/SSL server, how do I do that?
		2109
		2110	Well, you first need to get a server certificate and key. You have
		2111	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2112	self-signed certificate (cheap. check the search engine of your choice,
		2113	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2114	nice program for that purpose).
		2115
		2116	Then create a file with your private key (in PEM format, see
		2117	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2118	file should then look like this:
		2119
		2120	-----BEGIN RSA PRIVATE KEY-----
		2121	...header data
		2122	... lots of base64'y-stuff
		2123	-----END RSA PRIVATE KEY-----
		2124
		2125	-----BEGIN CERTIFICATE-----
		2126	... lots of base64'y-stuff
		2127	-----END CERTIFICATE-----
		2128
		2129	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2130	specify this file as C<cert_file>:
		2131
		2132	tcp_server undef, $port, sub {
		2133	my ($fh) = @_;
		2134
		2135	my $handle = new AnyEvent::Handle
		2136	fh => $fh,
		2137	tls => "accept",
		2138	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2139	...
		2140
		2141	When you have intermediate CA certificates that your clients might not
		2142	know about, just append them to the C<cert_file>.
		2143
		2144	=back
		2145
1468		2146
1469	=head1 SUBCLASSING AnyEvent::Handle	2147	=head1 SUBCLASSING AnyEvent::Handle
1470		2148
1471	In many cases, you might want to subclass AnyEvent::Handle.	2149	In many cases, you might want to subclass AnyEvent::Handle.
1472		2150

Diff Legend

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