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.85 by root, Thu Aug 21 19:53:19 2008 UTC vs.
Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC

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

Diff Legend

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