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.99 by root, Thu Oct 23 02:41:00 2008 UTC vs.
Revision 1.207 by root, Mon Nov 15 22:29:36 2010 UTC

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

Diff Legend

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