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

Diff Legend

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