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.112 by root, Wed Jan 21 06:01:35 2009 UTC vs.
Revision 1.183 by root, Thu Sep 3 12:45:35 2009 UTC

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

Diff Legend

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