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.92 by root, Wed Oct 1 08:52:06 2008 UTC vs.
Revision 1.178 by root, Tue Aug 11 01:15:17 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.3;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
32	$cv->broadcast;	15	my ($hdl, $fatal, $msg) = @_;
33	},	16	warn "got error $msg\n";
		17	$hdl->destroy;
		18	$cv->send;
34	);	19	);
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	warn "got line <$line>\n";
43	$cv->send;	28	$cv->send;
44	});	29	});
45		30
46	$cv->recv;	31	$cv->recv;
47		32
48	=head1 DESCRIPTION	33	=head1 DESCRIPTION
49		34
50	This module is a helper module to make it easier to do event-based I/O on	35	This 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
64	=head2 SIGPIPE is not handled by this module	51	=cut
65		52
66	SIGPIPE is not handled by this module, so one of the practical	53	package AnyEvent::Handle;
67	requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} =	54
68	'IGNORE'>). At least, this is highly recommend in a networked program: If	55	use Scalar::Util ();
69	you use AnyEvent::Handle in a filter program (like sort), exiting on	56	use List::Util ();
70	SIGPIPE is probably the right thing to do.	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;
71		64
72	=head1 METHODS	65	=head1 METHODS
73		66
74	=over 4	67	=over 4
75		68
76	=item B<new (%args)>	69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
77		70
78	The constructor supports these arguments (all as key => value pairs).	71	The constructor supports these arguments (all as C<< key => value >> pairs).
79		72
80	=over 4	73	=over 4
81		74
82	=item fh => $filehandle [MANDATORY]	75	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
83		76
84	The filehandle this L<AnyEvent::Handle> object will operate on.	77	The filehandle this L<AnyEvent::Handle> object will operate on.
85
86	NOTE: The filehandle will be set to non-blocking mode (using	78	NOTE: The filehandle will be set to non-blocking mode (using
87	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
88	that mode.	80	that mode.
89		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
90	=item on_eof => $cb->($handle)	99	=item on_prepare => $cb->($handle)
91		100
92	Set the callback to be called when an end-of-file condition is detected,	101	This (rarely used) callback is called before a new connection is
93	i.e. in the case of a socket, when the other side has closed the	102	attempted, but after the file handle has been created. It could be used to
94	connection cleanly.	103	prepare the file handle with parameters required for the actual connect
		104	(as opposed to settings that can be changed when the connection is already
		105	established).
95		106
96	For sockets, this just means that the other side has stopped sending data,	107	The return value of this callback should be the connect timeout value in
97	you can still try to write data, and, in fact, one can return from the eof	108	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
98	callback and continue writing data, as only the read part has been shut	109	timeout is to be used).
99	down.
100		110
101	While not mandatory, it is I<highly> recommended to set an eof callback,	111	=item on_connect => $cb->($handle, $host, $port, $retry->())
102	otherwise you might end up with a closed socket while you are still
103	waiting for data.
104		112
105	If an EOF condition has been detected but no C<on_eof> callback has been	113	This callback is called when a connection has been successfully established.
106	set, then a fatal error will be raised with C<$!> set to <0>.
107		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
108	=item on_error => $cb->($handle, $fatal)	137	=item on_error => $cb->($handle, $fatal, $message)
109		138
110	This is the error callback, which is called when, well, some error	139	This is the error callback, which is called when, well, some error
111	occured, such as not being able to resolve the hostname, failure to	140	occured, such as not being able to resolve the hostname, failure to
112	connect or a read error.	141	connect or a read error.
113		142
114	Some errors are fatal (which is indicated by C<$fatal> being true). On	143	Some errors are fatal (which is indicated by C<$fatal> being true). On
115	fatal errors the handle object will be shut down and will not be usable	144	fatal errors the handle object will be destroyed (by a call to C<< ->
116	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal	145	destroy >>) after invoking the error callback (which means you are free to
117	errors are an EOF condition with active (but unsatisifable) read watchers	146	examine the handle object). Examples of fatal errors are an EOF condition
118	(C<EPIPE>) or I/O errors.	147	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		148	cases where the other side can close the connection at their will it is
		149	often easiest to not report C<EPIPE> errors in this callback.
		150
		151	AnyEvent::Handle tries to find an appropriate error code for you to check
		152	against, but in some cases (TLS errors), this does not work well. It is
		153	recommended to always output the C<$message> argument in human-readable
		154	error messages (it's usually the same as C<"$!">).
119		155
120	Non-fatal errors can be retried by simply returning, but it is recommended	156	Non-fatal errors can be retried by simply returning, but it is recommended
121	to simply ignore this parameter and instead abondon the handle object	157	to simply ignore this parameter and instead abondon the handle object
122	when this callback is invoked. Examples of non-fatal errors are timeouts	158	when this callback is invoked. Examples of non-fatal errors are timeouts
123	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	159	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
124		160
125	On callback entrance, the value of C<$!> contains the operating system	161	On callback entrance, the value of C<$!> contains the operating system
126	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	162	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		163	C<EPROTO>).
127		164
128	While not mandatory, it is I<highly> recommended to set this callback, as	165	While not mandatory, it is I<highly> recommended to set this callback, as
129	you will not be notified of errors otherwise. The default simply calls	166	you will not be notified of errors otherwise. The default simply calls
130	C<croak>.	167	C<croak>.
131		168
…		…
135	and no read request is in the queue (unlike read queue callbacks, this	172	and no read request is in the queue (unlike read queue callbacks, this
136	callback will only be called when at least one octet of data is in the	173	callback will only be called when at least one octet of data is in the
137	read buffer).	174	read buffer).
138		175
139	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	176	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
140	method or access the C<$handle->{rbuf}> member directly.	177	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		178	must not enlarge or modify the read buffer, you can only remove data at
		179	the beginning from it.
141		180
142	When an EOF condition is detected then AnyEvent::Handle will first try to	181	When an EOF condition is detected then AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before	182	feed all the remaining data to the queued callbacks and C<on_read> before
144	calling the C<on_eof> callback. If no progress can be made, then a fatal	183	calling the C<on_eof> callback. If no progress can be made, then a fatal
145	error will be raised (with C<$!> set to C<EPIPE>).	184	error will be raised (with C<$!> set to C<EPIPE>).
		185
		186	Note that, unlike requests in the read queue, an C<on_read> callback
		187	doesn't mean you I<require> some data: if there is an EOF and there
		188	are outstanding read requests then an error will be flagged. With an
		189	C<on_read> callback, the C<on_eof> callback will be invoked.
		190
		191	=item on_eof => $cb->($handle)
		192
		193	Set the callback to be called when an end-of-file condition is detected,
		194	i.e. in the case of a socket, when the other side has closed the
		195	connection cleanly, and there are no outstanding read requests in the
		196	queue (if there are read requests, then an EOF counts as an unexpected
		197	connection close and will be flagged as an error).
		198
		199	For sockets, this just means that the other side has stopped sending data,
		200	you can still try to write data, and, in fact, one can return from the EOF
		201	callback and continue writing data, as only the read part has been shut
		202	down.
		203
		204	If an EOF condition has been detected but no C<on_eof> callback has been
		205	set, then a fatal error will be raised with C<$!> set to <0>.
146		206
147	=item on_drain => $cb->($handle)	207	=item on_drain => $cb->($handle)
148		208
149	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
150	(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).
…		…
157	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
158	the file when the write queue becomes empty.	218	the file when the write queue becomes empty.
159		219
160	=item timeout => $fractional_seconds	220	=item timeout => $fractional_seconds
161		221
		222	=item rtimeout => $fractional_seconds
		223
		224	=item wtimeout => $fractional_seconds
		225
162	If non-zero, then this enables an "inactivity" timeout: whenever this many	226	If non-zero, then these enables an "inactivity" timeout: whenever this
163	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
164	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
165	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>.
166		237
167	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
168	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
169	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
170	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
…		…
240	write data and will install a watcher that will write this data to the	311	write data and will install a watcher that will write this data to the
241	socket. No errors will be reported (this mostly matches how the operating	312	socket. No errors will be reported (this mostly matches how the operating
242	system treats outstanding data at socket close time).	313	system treats outstanding data at socket close time).
243		314
244	This will not work for partial TLS data that could not be encoded	315	This will not work for partial TLS data that could not be encoded
245	yet. This data will be lost.	316	yet. This data will be lost. Calling the C<stoptls> method in time might
		317	help.
		318
		319	=item peername => $string
		320
		321	A string used to identify the remote site - usually the DNS hostname
		322	(I<not> IDN!) used to create the connection, rarely the IP address.
		323
		324	Apart from being useful in error messages, this string is also used in TLS
		325	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		326	verification will be skipped when C<peername> is not specified or
		327	C<undef>.
246		328
247	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	329	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
248		330
249	When this parameter is given, it enables TLS (SSL) mode, that means	331	When this parameter is given, it enables TLS (SSL) mode, that means
250	AnyEvent will start a TLS handshake as soon as the conenction has been	332	AnyEvent will start a TLS handshake as soon as the conenction has been
251	established and will transparently encrypt/decrypt data afterwards.	333	established and will transparently encrypt/decrypt data afterwards.
		334
		335	All TLS protocol errors will be signalled as C<EPROTO>, with an
		336	appropriate error message.
252		337
253	TLS mode requires Net::SSLeay to be installed (it will be loaded	338	TLS mode requires Net::SSLeay to be installed (it will be loaded
254	automatically when you try to create a TLS handle): this module doesn't	339	automatically when you try to create a TLS handle): this module doesn't
255	have a dependency on that module, so if your module requires it, you have	340	have a dependency on that module, so if your module requires it, you have
256	to add the dependency yourself.	341	to add the dependency yourself.
…		…
260	mode.	345	mode.
261		346
262	You can also provide your own TLS connection object, but you have	347	You can also provide your own TLS connection object, but you have
263	to make sure that you call either C<Net::SSLeay::set_connect_state>	348	to make sure that you call either C<Net::SSLeay::set_connect_state>
264	or C<Net::SSLeay::set_accept_state> on it before you pass it to	349	or C<Net::SSLeay::set_accept_state> on it before you pass it to
265	AnyEvent::Handle.	350	AnyEvent::Handle. Also, this module will take ownership of this connection
		351	object.
		352
		353	At some future point, AnyEvent::Handle might switch to another TLS
		354	implementation, then the option to use your own session object will go
		355	away.
		356
		357	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		358	passing in the wrong integer will lead to certain crash. This most often
		359	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		360	segmentation fault.
266		361
267	See the C<< ->starttls >> method for when need to start TLS negotiation later.	362	See the C<< ->starttls >> method for when need to start TLS negotiation later.
268		363
269	=item tls_ctx => $ssl_ctx	364	=item tls_ctx => $anyevent_tls
270		365
271	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	366	Use the given C<AnyEvent::TLS> object to create the new TLS connection
272	(unless a connection object was specified directly). If this parameter is	367	(unless a connection object was specified directly). If this parameter is
273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	368	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		369
		370	Instead of an object, you can also specify a hash reference with C<< key
		371	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		372	new TLS context object.
		373
		374	=item on_starttls => $cb->($handle, $success[, $error_message])
		375
		376	This callback will be invoked when the TLS/SSL handshake has finished. If
		377	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		378	(C<on_stoptls> will not be called in this case).
		379
		380	The session in C<< $handle->{tls} >> can still be examined in this
		381	callback, even when the handshake was not successful.
		382
		383	TLS handshake failures will not cause C<on_error> to be invoked when this
		384	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		385
		386	Without this callback, handshake failures lead to C<on_error> being
		387	called, as normal.
		388
		389	Note that you cannot call C<starttls> right again in this callback. If you
		390	need to do that, start an zero-second timer instead whose callback can
		391	then call C<< ->starttls >> again.
		392
		393	=item on_stoptls => $cb->($handle)
		394
		395	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		396	set, then it will be invoked after freeing the TLS session. If it is not,
		397	then a TLS shutdown condition will be treated like a normal EOF condition
		398	on the handle.
		399
		400	The session in C<< $handle->{tls} >> can still be examined in this
		401	callback.
		402
		403	This callback will only be called on TLS shutdowns, not when the
		404	underlying handle signals EOF.
274		405
275	=item json => JSON or JSON::XS object	406	=item json => JSON or JSON::XS object
276		407
277	This is the json coder object used by the C<json> read and write types.	408	This is the json coder object used by the C<json> read and write types.
278		409
…		…
281	texts.	412	texts.
282		413
283	Note that you are responsible to depend on the JSON module if you want to	414	Note that you are responsible to depend on the JSON module if you want to
284	use this functionality, as AnyEvent does not have a dependency itself.	415	use this functionality, as AnyEvent does not have a dependency itself.
285		416
286	=item filter_r => $cb
287
288	=item filter_w => $cb
289
290	These exist, but are undocumented at this time. (They are used internally
291	by the TLS code).
292
293	=back	417	=back
294		418
295	=cut	419	=cut
296		420
297	sub new {	421	sub new {
298	my $class = shift;	422	my $class = shift;
299
300	my $self = bless { @_ }, $class;	423	my $self = bless { @_ }, $class;
301		424
302	$self->{fh} or Carp::croak "mandatory argument fh is missing";	425	if ($self->{fh}) {
		426	$self->_start;
		427	return unless $self->{fh}; # could be gone by now
		428
		429	} elsif ($self->{connect}) {
		430	require AnyEvent::Socket;
		431
		432	$self->{peername} = $self->{connect}[0]
		433	unless exists $self->{peername};
		434
		435	$self->{_skip_drain_rbuf} = 1;
		436
		437	{
		438	Scalar::Util::weaken (my $self = $self);
		439
		440	$self->{_connect} =
		441	AnyEvent::Socket::tcp_connect (
		442	$self->{connect}[0],
		443	$self->{connect}[1],
		444	sub {
		445	my ($fh, $host, $port, $retry) = @_;
		446
		447	if ($fh) {
		448	$self->{fh} = $fh;
		449
		450	delete $self->{_skip_drain_rbuf};
		451	$self->_start;
		452
		453	$self->{on_connect}
		454	and $self->{on_connect}($self, $host, $port, sub {
		455	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		456	$self->{_skip_drain_rbuf} = 1;
		457	&$retry;
		458	});
		459
		460	} else {
		461	if ($self->{on_connect_error}) {
		462	$self->{on_connect_error}($self, "$!");
		463	$self->destroy;
		464	} else {
		465	$self->_error ($!, 1);
		466	}
		467	}
		468	},
		469	sub {
		470	local $self->{fh} = $_[0];
		471
		472	$self->{on_prepare}
		473	? $self->{on_prepare}->($self)
		474	: ()
		475	}
		476	);
		477	}
		478
		479	} else {
		480	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		481	}
		482
		483	$self
		484	}
		485
		486	sub _start {
		487	my ($self) = @_;
303		488
304	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	489	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
305		490
306	if ($self->{tls}) {	491	$self->{_activity} =
307	require Net::SSLeay;	492	$self->{_ractivity} =
308	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
309	}
310
311	$self->{_activity} = AnyEvent->now;	493	$self->{_wactivity} = AE::now;
312	$self->_timeout;
313		494
314	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	495	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		496	$self->rtimeout (delete $self->{rtimeout}) if $self->{rtimeout};
		497	$self->wtimeout (delete $self->{wtimeout}) if $self->{wtimeout};
		498
315	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	499	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
316		500
		501	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		502	if $self->{tls};
		503
		504	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
		505
317	$self->start_read	506	$self->start_read
318	if $self->{on_read};	507	if $self->{on_read} || @{ $self->{_queue} };
319		508
320	$self	509	$self->_drain_wbuf;
321	}
322
323	sub _shutdown {
324	my ($self) = @_;
325
326	delete $self->{_tw};
327	delete $self->{_rw};
328	delete $self->{_ww};
329	delete $self->{fh};
330
331	&_freetls;
332
333	delete $self->{on_read};
334	delete $self->{_queue};
335	}	510	}
336		511
337	sub _error {	512	sub _error {
338	my ($self, $errno, $fatal) = @_;	513	my ($self, $errno, $fatal, $message) = @_;
339
340	$self->_shutdown
341	if $fatal;
342		514
343	$! = $errno;	515	$! = $errno;
		516	$message ||= "$!";
344		517
345	if ($self->{on_error}) {	518	if ($self->{on_error}) {
346	$self->{on_error}($self, $fatal);	519	$self->{on_error}($self, $fatal, $message);
347	} else {	520	$self->destroy if $fatal;
		521	} elsif ($self->{fh}) {
		522	$self->destroy;
348	Carp::croak "AnyEvent::Handle uncaught error: $!";	523	Carp::croak "AnyEvent::Handle uncaught error: $message";
349	}	524	}
350	}	525	}
351		526
352	=item $fh = $handle->fh	527	=item $fh = $handle->fh
353		528
…		…
377	$_[0]{on_eof} = $_[1];	552	$_[0]{on_eof} = $_[1];
378	}	553	}
379		554
380	=item $handle->on_timeout ($cb)	555	=item $handle->on_timeout ($cb)
381		556
382	Replace the current C<on_timeout> callback, or disables the callback (but	557	=item $handle->on_rtimeout ($cb)
383	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
384	argument and method.
385		558
386	=cut	559	=item $handle->on_wtimeout ($cb)
387		560
388	sub on_timeout {	561	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
389	$_[0]{on_timeout} = $_[1];	562	callback, or disables the callback (but not the timeout) if C<$cb> =
390	}	563	C<undef>. See the C<timeout> constructor argument and method.
		564
		565	=cut
		566
		567	# see below
391		568
392	=item $handle->autocork ($boolean)	569	=item $handle->autocork ($boolean)
393		570
394	Enables or disables the current autocork behaviour (see C<autocork>	571	Enables or disables the current autocork behaviour (see C<autocork>
395	constructor argument).	572	constructor argument). Changes will only take effect on the next write.
396		573
397	=cut	574	=cut
		575
		576	sub autocork {
		577	$_[0]{autocork} = $_[1];
		578	}
398		579
399	=item $handle->no_delay ($boolean)	580	=item $handle->no_delay ($boolean)
400		581
401	Enables or disables the C<no_delay> setting (see constructor argument of	582	Enables or disables the C<no_delay> setting (see constructor argument of
402	the same name for details).	583	the same name for details).
…		…
406	sub no_delay {	587	sub no_delay {
407	$_[0]{no_delay} = $_[1];	588	$_[0]{no_delay} = $_[1];
408		589
409	eval {	590	eval {
410	local $SIG{__DIE__};	591	local $SIG{__DIE__};
411	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	592	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		593	if $_[0]{fh};
412	};	594	};
413	}	595	}
414		596
		597	=item $handle->on_starttls ($cb)
		598
		599	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		600
		601	=cut
		602
		603	sub on_starttls {
		604	$_[0]{on_starttls} = $_[1];
		605	}
		606
		607	=item $handle->on_stoptls ($cb)
		608
		609	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		610
		611	=cut
		612
		613	sub on_starttls {
		614	$_[0]{on_stoptls} = $_[1];
		615	}
		616
		617	=item $handle->rbuf_max ($max_octets)
		618
		619	Configures the C<rbuf_max> setting (C<undef> disables it).
		620
		621	=cut
		622
		623	sub rbuf_max {
		624	$_[0]{rbuf_max} = $_[1];
		625	}
		626
415	#############################################################################	627	#############################################################################
416		628
417	=item $handle->timeout ($seconds)	629	=item $handle->timeout ($seconds)
418		630
		631	=item $handle->rtimeout ($seconds)
		632
		633	=item $handle->wtimeout ($seconds)
		634
419	Configures (or disables) the inactivity timeout.	635	Configures (or disables) the inactivity timeout.
420		636
421	=cut	637	=item $handle->timeout_reset
422		638
423	sub timeout {	639	=item $handle->rtimeout_reset
		640
		641	=item $handle->wtimeout_reset
		642
		643	Reset the activity timeout, as if data was received or sent.
		644
		645	These methods are cheap to call.
		646
		647	=cut
		648
		649	for my $dir ("", "r", "w") {
		650	my $timeout = "${dir}timeout";
		651	my $tw = "_${dir}tw";
		652	my $on_timeout = "on_${dir}timeout";
		653	my $activity = "_${dir}activity";
		654	my $cb;
		655
		656	*$on_timeout = sub {
		657	$_[0]{$on_timeout} = $_[1];
		658	};
		659
		660	*$timeout = sub {
424	my ($self, $timeout) = @_;	661	my ($self, $new_value) = @_;
425		662
426	$self->{timeout} = $timeout;	663	$self->{$timeout} = $new_value;
427	$self->_timeout;	664	delete $self->{$tw}; &$cb;
428	}	665	};
429		666
		667	*{"${dir}timeout_reset"} = sub {
		668	$_[0]{$activity} = AE::now;
		669	};
		670
		671	# main workhorse:
430	# reset the timeout watcher, as neccessary	672	# reset the timeout watcher, as neccessary
431	# also check for time-outs	673	# also check for time-outs
432	sub _timeout {	674	$cb = sub {
433	my ($self) = @_;	675	my ($self) = @_;
434		676
435	if ($self->{timeout}) {	677	if ($self->{$timeout} && $self->{fh}) {
436	my $NOW = AnyEvent->now;	678	my $NOW = AE::now;
437		679
438	# when would the timeout trigger?	680	# when would the timeout trigger?
439	my $after = $self->{_activity} + $self->{timeout} - $NOW;	681	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
440		682
441	# now or in the past already?	683	# now or in the past already?
442	if ($after <= 0) {	684	if ($after <= 0) {
443	$self->{_activity} = $NOW;	685	$self->{$activity} = $NOW;
444		686
445	if ($self->{on_timeout}) {	687	if ($self->{$on_timeout}) {
446	$self->{on_timeout}($self);	688	$self->{$on_timeout}($self);
447	} else {	689	} else {
448	$self->_error (&Errno::ETIMEDOUT);	690	$self->_error (Errno::ETIMEDOUT);
		691	}
		692
		693	# callback could have changed timeout value, optimise
		694	return unless $self->{$timeout};
		695
		696	# calculate new after
		697	$after = $self->{$timeout};
449	}	698	}
450		699
451	# callback could have changed timeout value, optimise	700	Scalar::Util::weaken $self;
452	return unless $self->{timeout};	701	return unless $self; # ->error could have destroyed $self
453		702
454	# calculate new after	703	$self->{$tw} ||= AE::timer $after, 0, sub {
455	$after = $self->{timeout};	704	delete $self->{$tw};
		705	$cb->($self);
		706	};
		707	} else {
		708	delete $self->{$tw};
456	}	709	}
457
458	Scalar::Util::weaken $self;
459	return unless $self; # ->error could have destroyed $self
460
461	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
462	delete $self->{_tw};
463	$self->_timeout;
464	});
465	} else {
466	delete $self->{_tw};
467	}	710	}
468	}	711	}
469		712
470	#############################################################################	713	#############################################################################
471		714
…		…
495	my ($self, $cb) = @_;	738	my ($self, $cb) = @_;
496		739
497	$self->{on_drain} = $cb;	740	$self->{on_drain} = $cb;
498		741
499	$cb->($self)	742	$cb->($self)
500	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	743	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
501	}	744	}
502		745
503	=item $handle->push_write ($data)	746	=item $handle->push_write ($data)
504		747
505	Queues the given scalar to be written. You can push as much data as you	748	Queues the given scalar to be written. You can push as much data as you
…		…
516	Scalar::Util::weaken $self;	759	Scalar::Util::weaken $self;
517		760
518	my $cb = sub {	761	my $cb = sub {
519	my $len = syswrite $self->{fh}, $self->{wbuf};	762	my $len = syswrite $self->{fh}, $self->{wbuf};
520		763
521	if ($len >= 0) {	764	if (defined $len) {
522	substr $self->{wbuf}, 0, $len, "";	765	substr $self->{wbuf}, 0, $len, "";
523		766
524	$self->{_activity} = AnyEvent->now;	767	$self->{_activity} = $self->{_wactivity} = AE::now;
525		768
526	$self->{on_drain}($self)	769	$self->{on_drain}($self)
527	if $self->{low_water_mark} >= length $self->{wbuf}	770	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
528	&& $self->{on_drain};	771	&& $self->{on_drain};
529		772
530	delete $self->{_ww} unless length $self->{wbuf};	773	delete $self->{_ww} unless length $self->{wbuf};
531	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	774	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
532	$self->_error ($!, 1);	775	$self->_error ($!, 1);
…		…
535		778
536	# try to write data immediately	779	# try to write data immediately
537	$cb->() unless $self->{autocork};	780	$cb->() unless $self->{autocork};
538		781
539	# if still data left in wbuf, we need to poll	782	# if still data left in wbuf, we need to poll
540	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	783	$self->{_ww} = AE::io $self->{fh}, 1, $cb
541	if length $self->{wbuf};	784	if length $self->{wbuf};
542	};	785	};
543	}	786	}
544		787
545	our %WH;	788	our %WH;
…		…
556		799
557	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	800	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
558	->($self, @_);	801	->($self, @_);
559	}	802	}
560		803
561	if ($self->{filter_w}) {	804	if ($self->{tls}) {
562	$self->{filter_w}($self, \$_[0]);	805	$self->{_tls_wbuf} .= $_[0];
		806	&_dotls ($self) if $self->{fh};
563	} else {	807	} else {
564	$self->{wbuf} .= $_[0];	808	$self->{wbuf} .= $_[0];
565	$self->_drain_wbuf;	809	$self->_drain_wbuf if $self->{fh};
566	}	810	}
567	}	811	}
568		812
569	=item $handle->push_write (type => @args)	813	=item $handle->push_write (type => @args)
570		814
…		…
584	=cut	828	=cut
585		829
586	register_write_type netstring => sub {	830	register_write_type netstring => sub {
587	my ($self, $string) = @_;	831	my ($self, $string) = @_;
588		832
589	sprintf "%d:%s,", (length $string), $string	833	(length $string) . ":$string,"
590	};	834	};
591		835
592	=item packstring => $format, $data	836	=item packstring => $format, $data
593		837
594	An octet string prefixed with an encoded length. The encoding C<$format>	838	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
659		903
660	pack "w/a*", Storable::nfreeze ($ref)	904	pack "w/a*", Storable::nfreeze ($ref)
661	};	905	};
662		906
663	=back	907	=back
		908
		909	=item $handle->push_shutdown
		910
		911	Sometimes you know you want to close the socket after writing your data
		912	before it was actually written. One way to do that is to replace your
		913	C<on_drain> handler by a callback that shuts down the socket (and set
		914	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		915	replaces the C<on_drain> callback with:
		916
		917	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		918
		919	This simply shuts down the write side and signals an EOF condition to the
		920	the peer.
		921
		922	You can rely on the normal read queue and C<on_eof> handling
		923	afterwards. This is the cleanest way to close a connection.
		924
		925	=cut
		926
		927	sub push_shutdown {
		928	my ($self) = @_;
		929
		930	delete $self->{low_water_mark};
		931	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		932	}
664		933
665	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	934	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
666		935
667	This function (not method) lets you add your own types to C<push_write>.	936	This function (not method) lets you add your own types to C<push_write>.
668	Whenever the given C<type> is used, C<push_write> will invoke the code	937	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
762	=cut	1031	=cut
763		1032
764	sub _drain_rbuf {	1033	sub _drain_rbuf {
765	my ($self) = @_;	1034	my ($self) = @_;
766		1035
		1036	# avoid recursion
		1037	return if $self->{_skip_drain_rbuf};
767	local $self->{_in_drain} = 1;	1038	local $self->{_skip_drain_rbuf} = 1;
768
769	if (
770	defined $self->{rbuf_max}
771	&& $self->{rbuf_max} < length $self->{rbuf}
772	) {
773	$self->_error (&Errno::ENOSPC, 1), return;
774	}
775		1039
776	while () {	1040	while () {
		1041	# we need to use a separate tls read buffer, as we must not receive data while
		1042	# we are draining the buffer, and this can only happen with TLS.
		1043	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1044	if exists $self->{_tls_rbuf};
		1045
777	my $len = length $self->{rbuf};	1046	my $len = length $self->{rbuf};
778		1047
779	if (my $cb = shift @{ $self->{_queue} }) {	1048	if (my $cb = shift @{ $self->{_queue} }) {
780	unless ($cb->($self)) {	1049	unless ($cb->($self)) {
781	if ($self->{_eof}) {	1050	# no progress can be made
782	# no progress can be made (not enough data and no data forthcoming)	1051	# (not enough data and no data forthcoming)
783	$self->_error (&Errno::EPIPE, 1), return;	1052	$self->_error (Errno::EPIPE, 1), return
784	}	1053	if $self->{_eof};
785		1054
786	unshift @{ $self->{_queue} }, $cb;	1055	unshift @{ $self->{_queue} }, $cb;
787	last;	1056	last;
788	}	1057	}
789	} elsif ($self->{on_read}) {	1058	} elsif ($self->{on_read}) {
…		…
796	&& !@{ $self->{_queue} } # and the queue is still empty	1065	&& !@{ $self->{_queue} } # and the queue is still empty
797	&& $self->{on_read} # but we still have on_read	1066	&& $self->{on_read} # but we still have on_read
798	) {	1067	) {
799	# no further data will arrive	1068	# no further data will arrive
800	# so no progress can be made	1069	# so no progress can be made
801	$self->_error (&Errno::EPIPE, 1), return	1070	$self->_error (Errno::EPIPE, 1), return
802	if $self->{_eof};	1071	if $self->{_eof};
803		1072
804	last; # more data might arrive	1073	last; # more data might arrive
805	}	1074	}
806	} else {	1075	} else {
807	# read side becomes idle	1076	# read side becomes idle
808	delete $self->{_rw};	1077	delete $self->{_rw} unless $self->{tls};
809	last;	1078	last;
810	}	1079	}
811	}	1080	}
812		1081
813	if ($self->{_eof}) {	1082	if ($self->{_eof}) {
814	if ($self->{on_eof}) {	1083	$self->{on_eof}
815	$self->{on_eof}($self)	1084	? $self->{on_eof}($self)
816	} else {	1085	: $self->_error (0, 1, "Unexpected end-of-file");
817	$self->_error (0, 1);	1086
818	}	1087	return;
		1088	}
		1089
		1090	if (
		1091	defined $self->{rbuf_max}
		1092	&& $self->{rbuf_max} < length $self->{rbuf}
		1093	) {
		1094	$self->_error (Errno::ENOSPC, 1), return;
819	}	1095	}
820		1096
821	# may need to restart read watcher	1097	# may need to restart read watcher
822	unless ($self->{_rw}) {	1098	unless ($self->{_rw}) {
823	$self->start_read	1099	$self->start_read
…		…
835		1111
836	sub on_read {	1112	sub on_read {
837	my ($self, $cb) = @_;	1113	my ($self, $cb) = @_;
838		1114
839	$self->{on_read} = $cb;	1115	$self->{on_read} = $cb;
840	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1116	$self->_drain_rbuf if $cb;
841	}	1117	}
842		1118
843	=item $handle->rbuf	1119	=item $handle->rbuf
844		1120
845	Returns the read buffer (as a modifiable lvalue).	1121	Returns the read buffer (as a modifiable lvalue).
846		1122
847	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1123	You can access the read buffer directly as the C<< ->{rbuf} >>
848	you want.	1124	member, if you want. However, the only operation allowed on the
		1125	read buffer (apart from looking at it) is removing data from its
		1126	beginning. Otherwise modifying or appending to it is not allowed and will
		1127	lead to hard-to-track-down bugs.
849		1128
850	NOTE: The read buffer should only be used or modified if the C<on_read>,	1129	NOTE: The read buffer should only be used or modified if the C<on_read>,
851	C<push_read> or C<unshift_read> methods are used. The other read methods	1130	C<push_read> or C<unshift_read> methods are used. The other read methods
852	automatically manage the read buffer.	1131	automatically manage the read buffer.
853		1132
…		…
894	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1173	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
895	->($self, $cb, @_);	1174	->($self, $cb, @_);
896	}	1175	}
897		1176
898	push @{ $self->{_queue} }, $cb;	1177	push @{ $self->{_queue} }, $cb;
899	$self->_drain_rbuf unless $self->{_in_drain};	1178	$self->_drain_rbuf;
900	}	1179	}
901		1180
902	sub unshift_read {	1181	sub unshift_read {
903	my $self = shift;	1182	my $self = shift;
904	my $cb = pop;	1183	my $cb = pop;
…		…
910	->($self, $cb, @_);	1189	->($self, $cb, @_);
911	}	1190	}
912		1191
913		1192
914	unshift @{ $self->{_queue} }, $cb;	1193	unshift @{ $self->{_queue} }, $cb;
915	$self->_drain_rbuf unless $self->{_in_drain};	1194	$self->_drain_rbuf;
916	}	1195	}
917		1196
918	=item $handle->push_read (type => @args, $cb)	1197	=item $handle->push_read (type => @args, $cb)
919		1198
920	=item $handle->unshift_read (type => @args, $cb)	1199	=item $handle->unshift_read (type => @args, $cb)
…		…
1053	return 1;	1332	return 1;
1054	}	1333	}
1055		1334
1056	# reject	1335	# reject
1057	if ($reject && $$rbuf =~ $reject) {	1336	if ($reject && $$rbuf =~ $reject) {
1058	$self->_error (&Errno::EBADMSG);	1337	$self->_error (Errno::EBADMSG);
1059	}	1338	}
1060		1339
1061	# skip	1340	# skip
1062	if ($skip && $$rbuf =~ $skip) {	1341	if ($skip && $$rbuf =~ $skip) {
1063	$data .= substr $$rbuf, 0, $+[0], "";	1342	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1079	my ($self, $cb) = @_;	1358	my ($self, $cb) = @_;
1080		1359
1081	sub {	1360	sub {
1082	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1361	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1083	if ($_[0]{rbuf} =~ /[^0-9]/) {	1362	if ($_[0]{rbuf} =~ /[^0-9]/) {
1084	$self->_error (&Errno::EBADMSG);	1363	$self->_error (Errno::EBADMSG);
1085	}	1364	}
1086	return;	1365	return;
1087	}	1366	}
1088		1367
1089	my $len = $1;	1368	my $len = $1;
…		…
1092	my $string = $_[1];	1371	my $string = $_[1];
1093	$_[0]->unshift_read (chunk => 1, sub {	1372	$_[0]->unshift_read (chunk => 1, sub {
1094	if ($_[1] eq ",") {	1373	if ($_[1] eq ",") {
1095	$cb->($_[0], $string);	1374	$cb->($_[0], $string);
1096	} else {	1375	} else {
1097	$self->_error (&Errno::EBADMSG);	1376	$self->_error (Errno::EBADMSG);
1098	}	1377	}
1099	});	1378	});
1100	});	1379	});
1101		1380
1102	1	1381	1
…		…
1108	An octet string prefixed with an encoded length. The encoding C<$format>	1387	An octet string prefixed with an encoded length. The encoding C<$format>
1109	uses the same format as a Perl C<pack> format, but must specify a single	1388	uses the same format as a Perl C<pack> format, but must specify a single
1110	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1389	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1111	optional C<!>, C<< < >> or C<< > >> modifier).	1390	optional C<!>, C<< < >> or C<< > >> modifier).
1112		1391
1113	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1392	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1393	EPP uses a prefix of C<N> (4 octtes).
1114		1394
1115	Example: read a block of data prefixed by its length in BER-encoded	1395	Example: read a block of data prefixed by its length in BER-encoded
1116	format (very efficient).	1396	format (very efficient).
1117		1397
1118	$handle->push_read (packstring => "w", sub {	1398	$handle->push_read (packstring => "w", sub {
…		…
1148	}	1428	}
1149	};	1429	};
1150		1430
1151	=item json => $cb->($handle, $hash_or_arrayref)	1431	=item json => $cb->($handle, $hash_or_arrayref)
1152		1432
1153	Reads a JSON object or array, decodes it and passes it to the callback.	1433	Reads a JSON object or array, decodes it and passes it to the
		1434	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1154		1435
1155	If a C<json> object was passed to the constructor, then that will be used	1436	If a C<json> object was passed to the constructor, then that will be used
1156	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1437	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1157		1438
1158	This read type uses the incremental parser available with JSON version	1439	This read type uses the incremental parser available with JSON version
…		…
1167	=cut	1448	=cut
1168		1449
1169	register_read_type json => sub {	1450	register_read_type json => sub {
1170	my ($self, $cb) = @_;	1451	my ($self, $cb) = @_;
1171		1452
1172	require JSON;	1453	my $json = $self->{json} ||=
		1454	eval { require JSON::XS; JSON::XS->new->utf8 }
		1455	|| do { require JSON; JSON->new->utf8 };
1173		1456
1174	my $data;	1457	my $data;
1175	my $rbuf = \$self->{rbuf};	1458	my $rbuf = \$self->{rbuf};
1176		1459
1177	my $json = $self->{json} ||= JSON->new->utf8;
1178
1179	sub {	1460	sub {
1180	my $ref = $json->incr_parse ($self->{rbuf});	1461	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1181		1462
1182	if ($ref) {	1463	if ($ref) {
1183	$self->{rbuf} = $json->incr_text;	1464	$self->{rbuf} = $json->incr_text;
1184	$json->incr_text = "";	1465	$json->incr_text = "";
1185	$cb->($self, $ref);	1466	$cb->($self, $ref);
1186		1467
1187	1	1468	1
		1469	} elsif ($@) {
		1470	# error case
		1471	$json->incr_skip;
		1472
		1473	$self->{rbuf} = $json->incr_text;
		1474	$json->incr_text = "";
		1475
		1476	$self->_error (Errno::EBADMSG);
		1477
		1478	()
1188	} else {	1479	} else {
1189	$self->{rbuf} = "";	1480	$self->{rbuf} = "";
		1481
1190	()	1482	()
1191	}	1483	}
1192	}	1484	}
1193	};	1485	};
1194		1486
…		…
1226	# read remaining chunk	1518	# read remaining chunk
1227	$_[0]->unshift_read (chunk => $len, sub {	1519	$_[0]->unshift_read (chunk => $len, sub {
1228	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1520	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1229	$cb->($_[0], $ref);	1521	$cb->($_[0], $ref);
1230	} else {	1522	} else {
1231	$self->_error (&Errno::EBADMSG);	1523	$self->_error (Errno::EBADMSG);
1232	}	1524	}
1233	});	1525	});
1234	}	1526	}
1235		1527
1236	1	1528	1
…		…
1271	Note that AnyEvent::Handle will automatically C<start_read> for you when	1563	Note that AnyEvent::Handle will automatically C<start_read> for you when
1272	you change the C<on_read> callback or push/unshift a read callback, and it	1564	you change the C<on_read> callback or push/unshift a read callback, and it
1273	will automatically C<stop_read> for you when neither C<on_read> is set nor	1565	will automatically C<stop_read> for you when neither C<on_read> is set nor
1274	there are any read requests in the queue.	1566	there are any read requests in the queue.
1275		1567
		1568	These methods will have no effect when in TLS mode (as TLS doesn't support
		1569	half-duplex connections).
		1570
1276	=cut	1571	=cut
1277		1572
1278	sub stop_read {	1573	sub stop_read {
1279	my ($self) = @_;	1574	my ($self) = @_;
1280		1575
1281	delete $self->{_rw};	1576	delete $self->{_rw} unless $self->{tls};
1282	}	1577	}
1283		1578
1284	sub start_read {	1579	sub start_read {
1285	my ($self) = @_;	1580	my ($self) = @_;
1286		1581
1287	unless ($self->{_rw} || $self->{_eof}) {	1582	unless ($self->{_rw} || $self->{_eof}) {
1288	Scalar::Util::weaken $self;	1583	Scalar::Util::weaken $self;
1289		1584
1290	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1585	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1291	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1586	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1292	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1587	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1293		1588
1294	if ($len > 0) {	1589	if ($len > 0) {
1295	$self->{_activity} = AnyEvent->now;	1590	$self->{_activity} = $self->{_ractivity} = AE::now;
1296		1591
1297	$self->{filter_r}	1592	if ($self->{tls}) {
1298	? $self->{filter_r}($self, $rbuf)	1593	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1299	: $self->{_in_drain} || $self->_drain_rbuf;	1594
		1595	&_dotls ($self);
		1596	} else {
		1597	$self->_drain_rbuf;
		1598	}
1300		1599
1301	} elsif (defined $len) {	1600	} elsif (defined $len) {
1302	delete $self->{_rw};	1601	delete $self->{_rw};
1303	$self->{_eof} = 1;	1602	$self->{_eof} = 1;
1304	$self->_drain_rbuf unless $self->{_in_drain};	1603	$self->_drain_rbuf;
1305		1604
1306	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1605	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1307	return $self->_error ($!, 1);	1606	return $self->_error ($!, 1);
1308	}	1607	}
1309	});	1608	};
1310	}	1609	}
1311	}	1610	}
1312		1611
		1612	our $ERROR_SYSCALL;
		1613	our $ERROR_WANT_READ;
		1614
		1615	sub _tls_error {
		1616	my ($self, $err) = @_;
		1617
		1618	return $self->_error ($!, 1)
		1619	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1620
		1621	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1622
		1623	# reduce error string to look less scary
		1624	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1625
		1626	if ($self->{_on_starttls}) {
		1627	(delete $self->{_on_starttls})->($self, undef, $err);
		1628	&_freetls;
		1629	} else {
		1630	&_freetls;
		1631	$self->_error (Errno::EPROTO, 1, $err);
		1632	}
		1633	}
		1634
		1635	# poll the write BIO and send the data if applicable
		1636	# also decode read data if possible
		1637	# this is basiclaly our TLS state machine
		1638	# more efficient implementations are possible with openssl,
		1639	# but not with the buggy and incomplete Net::SSLeay.
1313	sub _dotls {	1640	sub _dotls {
1314	my ($self) = @_;	1641	my ($self) = @_;
1315		1642
1316	my $buf;	1643	my $tmp;
1317		1644
1318	if (length $self->{_tls_wbuf}) {	1645	if (length $self->{_tls_wbuf}) {
1319	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1646	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1320	substr $self->{_tls_wbuf}, 0, $len, "";	1647	substr $self->{_tls_wbuf}, 0, $tmp, "";
1321	}	1648	}
1322	}
1323		1649
		1650	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1651	return $self->_tls_error ($tmp)
		1652	if $tmp != $ERROR_WANT_READ
		1653	&& ($tmp != $ERROR_SYSCALL || $!);
		1654	}
		1655
1324	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1656	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1325	unless (length $buf) {	1657	unless (length $tmp) {
1326	# let's treat SSL-eof as we treat normal EOF	1658	$self->{_on_starttls}
1327	delete $self->{_rw};	1659	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1328	$self->{_eof} = 1;
1329	&_freetls;	1660	&_freetls;
		1661
		1662	if ($self->{on_stoptls}) {
		1663	$self->{on_stoptls}($self);
		1664	return;
		1665	} else {
		1666	# let's treat SSL-eof as we treat normal EOF
		1667	delete $self->{_rw};
		1668	$self->{_eof} = 1;
		1669	}
1330	}	1670	}
1331		1671
1332	$self->{rbuf} .= $buf;	1672	$self->{_tls_rbuf} .= $tmp;
1333	$self->_drain_rbuf unless $self->{_in_drain};	1673	$self->_drain_rbuf;
1334	$self->{tls} or return; # tls session might have gone away in callback	1674	$self->{tls} or return; # tls session might have gone away in callback
1335	}	1675	}
1336		1676
1337	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1677	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1338
1339	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1340	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1341	return $self->_error ($!, 1);	1678	return $self->_tls_error ($tmp)
1342	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1679	if $tmp != $ERROR_WANT_READ
1343	return $self->_error (&Errno::EIO, 1);	1680	&& ($tmp != $ERROR_SYSCALL || $!);
1344	}
1345		1681
1346	# all others are fine for our purposes
1347	}
1348
1349	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1682	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1350	$self->{wbuf} .= $buf;	1683	$self->{wbuf} .= $tmp;
1351	$self->_drain_wbuf;	1684	$self->_drain_wbuf;
1352	}	1685	}
		1686
		1687	$self->{_on_starttls}
		1688	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1689	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1353	}	1690	}
1354		1691
1355	=item $handle->starttls ($tls[, $tls_ctx])	1692	=item $handle->starttls ($tls[, $tls_ctx])
1356		1693
1357	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1694	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1358	object is created, you can also do that at a later time by calling	1695	object is created, you can also do that at a later time by calling
1359	C<starttls>.	1696	C<starttls>.
1360		1697
		1698	Starting TLS is currently an asynchronous operation - when you push some
		1699	write data and then call C<< ->starttls >> then TLS negotiation will start
		1700	immediately, after which the queued write data is then sent.
		1701
1361	The first argument is the same as the C<tls> constructor argument (either	1702	The first argument is the same as the C<tls> constructor argument (either
1362	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1703	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1363		1704
1364	The second argument is the optional C<Net::SSLeay::CTX> object that is	1705	The second argument is the optional C<AnyEvent::TLS> object that is used
1365	used when AnyEvent::Handle has to create its own TLS connection object.	1706	when AnyEvent::Handle has to create its own TLS connection object, or
		1707	a hash reference with C<< key => value >> pairs that will be used to
		1708	construct a new context.
1366		1709
1367	The TLS connection object will end up in C<< $handle->{tls} >> after this	1710	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1368	call and can be used or changed to your liking. Note that the handshake	1711	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1369	might have already started when this function returns.	1712	changed to your liking. Note that the handshake might have already started
		1713	when this function returns.
1370		1714
1371	If it an error to start a TLS handshake more than once per	1715	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1372	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1716	handshakes on the same stream. Best do not attempt to use the stream after
		1717	stopping TLS.
1373		1718
1374	=cut	1719	=cut
		1720
		1721	our %TLS_CACHE; #TODO not yet documented, should we?
1375		1722
1376	sub starttls {	1723	sub starttls {
1377	my ($self, $ssl, $ctx) = @_;	1724	my ($self, $tls, $ctx) = @_;
1378		1725
1379	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"	1726	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1380	if $self->{tls};	1727	if $self->{tls};
		1728
		1729	$self->{tls} = $tls;
		1730	$self->{tls_ctx} = $ctx if @_ > 2;
		1731
		1732	return unless $self->{fh};
		1733
		1734	require Net::SSLeay;
		1735
		1736	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1737	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1738
		1739	$tls = $self->{tls};
		1740	$ctx = $self->{tls_ctx};
		1741
		1742	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1743
		1744	if ("HASH" eq ref $ctx) {
		1745	require AnyEvent::TLS;
		1746
		1747	if ($ctx->{cache}) {
		1748	my $key = $ctx+0;
		1749	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1750	} else {
		1751	$ctx = new AnyEvent::TLS %$ctx;
		1752	}
		1753	}
1381		1754
1382	if ($ssl eq "accept") {	1755	$self->{tls_ctx} = $ctx || TLS_CTX ();
1383	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1756	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1384	Net::SSLeay::set_accept_state ($ssl);
1385	} elsif ($ssl eq "connect") {
1386	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1387	Net::SSLeay::set_connect_state ($ssl);
1388	}
1389
1390	$self->{tls} = $ssl;
1391		1757
1392	# basically, this is deep magic (because SSL_read should have the same issues)	1758	# basically, this is deep magic (because SSL_read should have the same issues)
1393	# but the openssl maintainers basically said: "trust us, it just works".	1759	# but the openssl maintainers basically said: "trust us, it just works".
1394	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1760	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1395	# and mismaintained ssleay-module doesn't even offer them).	1761	# and mismaintained ssleay-module doesn't even offer them).
1396	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1762	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1397	#	1763	#
1398	# in short: this is a mess.	1764	# in short: this is a mess.
1399	#	1765	#
1400	# note that we do not try to kepe the length constant between writes as we are required to do.	1766	# note that we do not try to keep the length constant between writes as we are required to do.
1401	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1767	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1402	# and we drive openssl fully in blocking mode here.	1768	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1769	# have identity issues in that area.
1403	Net::SSLeay::CTX_set_mode ($self->{tls},	1770	# Net::SSLeay::CTX_set_mode ($ssl,
1404	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1771	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1405	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1772	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1773	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1406		1774
1407	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1775	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1408	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1776	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1409		1777
		1778	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1779
1410	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1780	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1411		1781
1412	$self->{filter_w} = sub {	1782	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1413	$_[0]{_tls_wbuf} .= ${$_[1]};	1783	if $self->{on_starttls};
1414	&_dotls;
1415	};
1416	$self->{filter_r} = sub {
1417	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1418	&_dotls;
1419	};
1420		1784
1421	&_dotls; # need to trigger the initial negotiation exchange	1785	&_dotls; # need to trigger the initial handshake
		1786	$self->start_read; # make sure we actually do read
1422	}	1787	}
1423		1788
1424	=item $handle->stoptls	1789	=item $handle->stoptls
1425		1790
1426	Shuts down the SSL connection - this makes a proper EOF handshake by	1791	Shuts down the SSL connection - this makes a proper EOF handshake by
1427	sending a close notify to the other side, but since OpenSSL doesn't	1792	sending a close notify to the other side, but since OpenSSL doesn't
1428	support non-blocking shut downs, it is not possible to re-use the stream	1793	support non-blocking shut downs, it is not guarenteed that you can re-use
1429	afterwards.	1794	the stream afterwards.
1430		1795
1431	=cut	1796	=cut
1432		1797
1433	sub stoptls {	1798	sub stoptls {
1434	my ($self) = @_;	1799	my ($self) = @_;
1435		1800
1436	if ($self->{tls}) {	1801	if ($self->{tls}) {
1437	Net::SSLeay::shutdown $self->{tls};	1802	Net::SSLeay::shutdown ($self->{tls});
1438		1803
1439	&_dotls;	1804	&_dotls;
1440		1805
1441	# we don't give a shit. no, we do, but we can't. no...	1806	# # we don't give a shit. no, we do, but we can't. no...#d#
1442	# we, we... have to use openssl :/	1807	# # we, we... have to use openssl :/#d#
1443	&_freetls;	1808	# &_freetls;#d#
1444	}	1809	}
1445	}	1810	}
1446		1811
1447	sub _freetls {	1812	sub _freetls {
1448	my ($self) = @_;	1813	my ($self) = @_;
1449		1814
1450	return unless $self->{tls};	1815	return unless $self->{tls};
1451		1816
1452	Net::SSLeay::free (delete $self->{tls});	1817	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1818	if $self->{tls} > 0;
1453		1819
1454	delete @$self{qw(_rbio filter_w _wbio filter_r)};	1820	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1455	}	1821	}
1456		1822
1457	sub DESTROY {	1823	sub DESTROY {
1458	my $self = shift;	1824	my ($self) = @_;
1459		1825
1460	&_freetls;	1826	&_freetls;
1461		1827
1462	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1828	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1463		1829
1464	if ($linger && length $self->{wbuf}) {	1830	if ($linger && length $self->{wbuf} && $self->{fh}) {
1465	my $fh = delete $self->{fh};	1831	my $fh = delete $self->{fh};
1466	my $wbuf = delete $self->{wbuf};	1832	my $wbuf = delete $self->{wbuf};
1467		1833
1468	my @linger;	1834	my @linger;
1469		1835
1470	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1836	push @linger, AE::io $fh, 1, sub {
1471	my $len = syswrite $fh, $wbuf, length $wbuf;	1837	my $len = syswrite $fh, $wbuf, length $wbuf;
1472		1838
1473	if ($len > 0) {	1839	if ($len > 0) {
1474	substr $wbuf, 0, $len, "";	1840	substr $wbuf, 0, $len, "";
1475	} else {	1841	} else {
1476	@linger = (); # end	1842	@linger = (); # end
1477	}	1843	}
1478	});	1844	};
1479	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1845	push @linger, AE::timer $linger, 0, sub {
1480	@linger = ();	1846	@linger = ();
1481	});	1847	};
1482	}	1848	}
		1849	}
		1850
		1851	=item $handle->destroy
		1852
		1853	Shuts down the handle object as much as possible - this call ensures that
		1854	no further callbacks will be invoked and as many resources as possible
		1855	will be freed. Any method you will call on the handle object after
		1856	destroying it in this way will be silently ignored (and it will return the
		1857	empty list).
		1858
		1859	Normally, you can just "forget" any references to an AnyEvent::Handle
		1860	object and it will simply shut down. This works in fatal error and EOF
		1861	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1862	callback, so when you want to destroy the AnyEvent::Handle object from
		1863	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1864	that case.
		1865
		1866	Destroying the handle object in this way has the advantage that callbacks
		1867	will be removed as well, so if those are the only reference holders (as
		1868	is common), then one doesn't need to do anything special to break any
		1869	reference cycles.
		1870
		1871	The handle might still linger in the background and write out remaining
		1872	data, as specified by the C<linger> option, however.
		1873
		1874	=cut
		1875
		1876	sub destroy {
		1877	my ($self) = @_;
		1878
		1879	$self->DESTROY;
		1880	%$self = ();
		1881	bless $self, "AnyEvent::Handle::destroyed";
		1882	}
		1883
		1884	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1885	#nop
1483	}	1886	}
1484		1887
1485	=item AnyEvent::Handle::TLS_CTX	1888	=item AnyEvent::Handle::TLS_CTX
1486		1889
1487	This function creates and returns the Net::SSLeay::CTX object used by	1890	This function creates and returns the AnyEvent::TLS object used by default
1488	default for TLS mode.	1891	for TLS mode.
1489		1892
1490	The context is created like this:	1893	The context is created by calling L<AnyEvent::TLS> without any arguments.
1491
1492	Net::SSLeay::load_error_strings;
1493	Net::SSLeay::SSLeay_add_ssl_algorithms;
1494	Net::SSLeay::randomize;
1495
1496	my $CTX = Net::SSLeay::CTX_new;
1497
1498	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1499		1894
1500	=cut	1895	=cut
1501		1896
1502	our $TLS_CTX;	1897	our $TLS_CTX;
1503		1898
1504	sub TLS_CTX() {	1899	sub TLS_CTX() {
1505	$TLS_CTX || do {	1900	$TLS_CTX ||= do {
1506	require Net::SSLeay;	1901	require AnyEvent::TLS;
1507		1902
1508	Net::SSLeay::load_error_strings ();	1903	new AnyEvent::TLS
1509	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1510	Net::SSLeay::randomize ();
1511
1512	$TLS_CTX = Net::SSLeay::CTX_new ();
1513
1514	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1515
1516	$TLS_CTX
1517	}	1904	}
1518	}	1905	}
1519		1906
1520	=back	1907	=back
		1908
		1909
		1910	=head1 NONFREQUENTLY ASKED QUESTIONS
		1911
		1912	=over 4
		1913
		1914	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1915	still get further invocations!
		1916
		1917	That's because AnyEvent::Handle keeps a reference to itself when handling
		1918	read or write callbacks.
		1919
		1920	It is only safe to "forget" the reference inside EOF or error callbacks,
		1921	from within all other callbacks, you need to explicitly call the C<<
		1922	->destroy >> method.
		1923
		1924	=item I get different callback invocations in TLS mode/Why can't I pause
		1925	reading?
		1926
		1927	Unlike, say, TCP, TLS connections do not consist of two independent
		1928	communication channels, one for each direction. Or put differently. The
		1929	read and write directions are not independent of each other: you cannot
		1930	write data unless you are also prepared to read, and vice versa.
		1931
		1932	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1933	callback invocations when you are not expecting any read data - the reason
		1934	is that AnyEvent::Handle always reads in TLS mode.
		1935
		1936	During the connection, you have to make sure that you always have a
		1937	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1938	connection (or when you no longer want to use it) you can call the
		1939	C<destroy> method.
		1940
		1941	=item How do I read data until the other side closes the connection?
		1942
		1943	If you just want to read your data into a perl scalar, the easiest way
		1944	to achieve this is by setting an C<on_read> callback that does nothing,
		1945	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1946	will be in C<$_[0]{rbuf}>:
		1947
		1948	$handle->on_read (sub { });
		1949	$handle->on_eof (undef);
		1950	$handle->on_error (sub {
		1951	my $data = delete $_[0]{rbuf};
		1952	});
		1953
		1954	The reason to use C<on_error> is that TCP connections, due to latencies
		1955	and packets loss, might get closed quite violently with an error, when in
		1956	fact, all data has been received.
		1957
		1958	It is usually better to use acknowledgements when transferring data,
		1959	to make sure the other side hasn't just died and you got the data
		1960	intact. This is also one reason why so many internet protocols have an
		1961	explicit QUIT command.
		1962
		1963	=item I don't want to destroy the handle too early - how do I wait until
		1964	all data has been written?
		1965
		1966	After writing your last bits of data, set the C<on_drain> callback
		1967	and destroy the handle in there - with the default setting of
		1968	C<low_water_mark> this will be called precisely when all data has been
		1969	written to the socket:
		1970
		1971	$handle->push_write (...);
		1972	$handle->on_drain (sub {
		1973	warn "all data submitted to the kernel\n";
		1974	undef $handle;
		1975	});
		1976
		1977	If you just want to queue some data and then signal EOF to the other side,
		1978	consider using C<< ->push_shutdown >> instead.
		1979
		1980	=item I want to contact a TLS/SSL server, I don't care about security.
		1981
		1982	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1983	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1984	parameter:
		1985
		1986	tcp_connect $host, $port, sub {
		1987	my ($fh) = @_;
		1988
		1989	my $handle = new AnyEvent::Handle
		1990	fh => $fh,
		1991	tls => "connect",
		1992	on_error => sub { ... };
		1993
		1994	$handle->push_write (...);
		1995	};
		1996
		1997	=item I want to contact a TLS/SSL server, I do care about security.
		1998
		1999	Then you should additionally enable certificate verification, including
		2000	peername verification, if the protocol you use supports it (see
		2001	L<AnyEvent::TLS>, C<verify_peername>).
		2002
		2003	E.g. for HTTPS:
		2004
		2005	tcp_connect $host, $port, sub {
		2006	my ($fh) = @_;
		2007
		2008	my $handle = new AnyEvent::Handle
		2009	fh => $fh,
		2010	peername => $host,
		2011	tls => "connect",
		2012	tls_ctx => { verify => 1, verify_peername => "https" },
		2013	...
		2014
		2015	Note that you must specify the hostname you connected to (or whatever
		2016	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2017	peername verification will be done.
		2018
		2019	The above will use the system-dependent default set of trusted CA
		2020	certificates. If you want to check against a specific CA, add the
		2021	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2022
		2023	tls_ctx => {
		2024	verify => 1,
		2025	verify_peername => "https",
		2026	ca_file => "my-ca-cert.pem",
		2027	},
		2028
		2029	=item I want to create a TLS/SSL server, how do I do that?
		2030
		2031	Well, you first need to get a server certificate and key. You have
		2032	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2033	self-signed certificate (cheap. check the search engine of your choice,
		2034	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2035	nice program for that purpose).
		2036
		2037	Then create a file with your private key (in PEM format, see
		2038	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2039	file should then look like this:
		2040
		2041	-----BEGIN RSA PRIVATE KEY-----
		2042	...header data
		2043	... lots of base64'y-stuff
		2044	-----END RSA PRIVATE KEY-----
		2045
		2046	-----BEGIN CERTIFICATE-----
		2047	... lots of base64'y-stuff
		2048	-----END CERTIFICATE-----
		2049
		2050	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2051	specify this file as C<cert_file>:
		2052
		2053	tcp_server undef, $port, sub {
		2054	my ($fh) = @_;
		2055
		2056	my $handle = new AnyEvent::Handle
		2057	fh => $fh,
		2058	tls => "accept",
		2059	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2060	...
		2061
		2062	When you have intermediate CA certificates that your clients might not
		2063	know about, just append them to the C<cert_file>.
		2064
		2065	=back
		2066
1521		2067
1522	=head1 SUBCLASSING AnyEvent::Handle	2068	=head1 SUBCLASSING AnyEvent::Handle
1523		2069
1524	In many cases, you might want to subclass AnyEvent::Handle.	2070	In many cases, you might want to subclass AnyEvent::Handle.
1525		2071

Diff Legend

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