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.90 by root, Mon Sep 29 02:08:57 2008 UTC vs.
Revision 1.179 by root, Wed Aug 12 15:50:44 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.234;
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	$self->stoptls;
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>
…		…
634	Other languages could read single lines terminated by a newline and pass	878	Other languages could read single lines terminated by a newline and pass
635	this line into their JSON decoder of choice.	879	this line into their JSON decoder of choice.
636		880
637	=cut	881	=cut
638		882
		883	sub json_coder() {
		884	eval { require JSON::XS; JSON::XS->new->utf8 }
		885	|| do { require JSON; JSON->new->utf8 }
		886	}
		887
639	register_write_type json => sub {	888	register_write_type json => sub {
640	my ($self, $ref) = @_;	889	my ($self, $ref) = @_;
641		890
642	require JSON;	891	my $json = $self->{json} ||= json_coder;
643		892
644	$self->{json} ? $self->{json}->encode ($ref)	893	$json->encode ($ref)
645	: JSON::encode_json ($ref)
646	};	894	};
647		895
648	=item storable => $reference	896	=item storable => $reference
649		897
650	Freezes the given reference using L<Storable> and writes it to the	898	Freezes the given reference using L<Storable> and writes it to the
…		…
659		907
660	pack "w/a*", Storable::nfreeze ($ref)	908	pack "w/a*", Storable::nfreeze ($ref)
661	};	909	};
662		910
663	=back	911	=back
		912
		913	=item $handle->push_shutdown
		914
		915	Sometimes you know you want to close the socket after writing your data
		916	before it was actually written. One way to do that is to replace your
		917	C<on_drain> handler by a callback that shuts down the socket (and set
		918	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		919	replaces the C<on_drain> callback with:
		920
		921	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		922
		923	This simply shuts down the write side and signals an EOF condition to the
		924	the peer.
		925
		926	You can rely on the normal read queue and C<on_eof> handling
		927	afterwards. This is the cleanest way to close a connection.
		928
		929	=cut
		930
		931	sub push_shutdown {
		932	my ($self) = @_;
		933
		934	delete $self->{low_water_mark};
		935	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		936	}
664		937
665	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	938	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
666		939
667	This function (not method) lets you add your own types to C<push_write>.	940	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	941	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
762	=cut	1035	=cut
763		1036
764	sub _drain_rbuf {	1037	sub _drain_rbuf {
765	my ($self) = @_;	1038	my ($self) = @_;
766		1039
		1040	# avoid recursion
		1041	return if $self->{_skip_drain_rbuf};
767	local $self->{_in_drain} = 1;	1042	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		1043
776	while () {	1044	while () {
		1045	# we need to use a separate tls read buffer, as we must not receive data while
		1046	# we are draining the buffer, and this can only happen with TLS.
		1047	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1048	if exists $self->{_tls_rbuf};
		1049
777	my $len = length $self->{rbuf};	1050	my $len = length $self->{rbuf};
778		1051
779	if (my $cb = shift @{ $self->{_queue} }) {	1052	if (my $cb = shift @{ $self->{_queue} }) {
780	unless ($cb->($self)) {	1053	unless ($cb->($self)) {
781	if ($self->{_eof}) {	1054	# no progress can be made
782	# no progress can be made (not enough data and no data forthcoming)	1055	# (not enough data and no data forthcoming)
783	$self->_error (&Errno::EPIPE, 1), return;	1056	$self->_error (Errno::EPIPE, 1), return
784	}	1057	if $self->{_eof};
785		1058
786	unshift @{ $self->{_queue} }, $cb;	1059	unshift @{ $self->{_queue} }, $cb;
787	last;	1060	last;
788	}	1061	}
789	} elsif ($self->{on_read}) {	1062	} elsif ($self->{on_read}) {
…		…
796	&& !@{ $self->{_queue} } # and the queue is still empty	1069	&& !@{ $self->{_queue} } # and the queue is still empty
797	&& $self->{on_read} # but we still have on_read	1070	&& $self->{on_read} # but we still have on_read
798	) {	1071	) {
799	# no further data will arrive	1072	# no further data will arrive
800	# so no progress can be made	1073	# so no progress can be made
801	$self->_error (&Errno::EPIPE, 1), return	1074	$self->_error (Errno::EPIPE, 1), return
802	if $self->{_eof};	1075	if $self->{_eof};
803		1076
804	last; # more data might arrive	1077	last; # more data might arrive
805	}	1078	}
806	} else {	1079	} else {
807	# read side becomes idle	1080	# read side becomes idle
808	delete $self->{_rw};	1081	delete $self->{_rw} unless $self->{tls};
809	last;	1082	last;
810	}	1083	}
811	}	1084	}
812		1085
813	if ($self->{_eof}) {	1086	if ($self->{_eof}) {
814	if ($self->{on_eof}) {	1087	$self->{on_eof}
815	$self->{on_eof}($self)	1088	? $self->{on_eof}($self)
816	} else {	1089	: $self->_error (0, 1, "Unexpected end-of-file");
817	$self->_error (0, 1);	1090
818	}	1091	return;
		1092	}
		1093
		1094	if (
		1095	defined $self->{rbuf_max}
		1096	&& $self->{rbuf_max} < length $self->{rbuf}
		1097	) {
		1098	$self->_error (Errno::ENOSPC, 1), return;
819	}	1099	}
820		1100
821	# may need to restart read watcher	1101	# may need to restart read watcher
822	unless ($self->{_rw}) {	1102	unless ($self->{_rw}) {
823	$self->start_read	1103	$self->start_read
…		…
835		1115
836	sub on_read {	1116	sub on_read {
837	my ($self, $cb) = @_;	1117	my ($self, $cb) = @_;
838		1118
839	$self->{on_read} = $cb;	1119	$self->{on_read} = $cb;
840	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1120	$self->_drain_rbuf if $cb;
841	}	1121	}
842		1122
843	=item $handle->rbuf	1123	=item $handle->rbuf
844		1124
845	Returns the read buffer (as a modifiable lvalue).	1125	Returns the read buffer (as a modifiable lvalue).
846		1126
847	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1127	You can access the read buffer directly as the C<< ->{rbuf} >>
848	you want.	1128	member, if you want. However, the only operation allowed on the
		1129	read buffer (apart from looking at it) is removing data from its
		1130	beginning. Otherwise modifying or appending to it is not allowed and will
		1131	lead to hard-to-track-down bugs.
849		1132
850	NOTE: The read buffer should only be used or modified if the C<on_read>,	1133	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	1134	C<push_read> or C<unshift_read> methods are used. The other read methods
852	automatically manage the read buffer.	1135	automatically manage the read buffer.
853		1136
…		…
894	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1177	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
895	->($self, $cb, @_);	1178	->($self, $cb, @_);
896	}	1179	}
897		1180
898	push @{ $self->{_queue} }, $cb;	1181	push @{ $self->{_queue} }, $cb;
899	$self->_drain_rbuf unless $self->{_in_drain};	1182	$self->_drain_rbuf;
900	}	1183	}
901		1184
902	sub unshift_read {	1185	sub unshift_read {
903	my $self = shift;	1186	my $self = shift;
904	my $cb = pop;	1187	my $cb = pop;
…		…
910	->($self, $cb, @_);	1193	->($self, $cb, @_);
911	}	1194	}
912		1195
913		1196
914	unshift @{ $self->{_queue} }, $cb;	1197	unshift @{ $self->{_queue} }, $cb;
915	$self->_drain_rbuf unless $self->{_in_drain};	1198	$self->_drain_rbuf;
916	}	1199	}
917		1200
918	=item $handle->push_read (type => @args, $cb)	1201	=item $handle->push_read (type => @args, $cb)
919		1202
920	=item $handle->unshift_read (type => @args, $cb)	1203	=item $handle->unshift_read (type => @args, $cb)
…		…
1053	return 1;	1336	return 1;
1054	}	1337	}
1055		1338
1056	# reject	1339	# reject
1057	if ($reject && $$rbuf =~ $reject) {	1340	if ($reject && $$rbuf =~ $reject) {
1058	$self->_error (&Errno::EBADMSG);	1341	$self->_error (Errno::EBADMSG);
1059	}	1342	}
1060		1343
1061	# skip	1344	# skip
1062	if ($skip && $$rbuf =~ $skip) {	1345	if ($skip && $$rbuf =~ $skip) {
1063	$data .= substr $$rbuf, 0, $+[0], "";	1346	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1079	my ($self, $cb) = @_;	1362	my ($self, $cb) = @_;
1080		1363
1081	sub {	1364	sub {
1082	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1365	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1083	if ($_[0]{rbuf} =~ /[^0-9]/) {	1366	if ($_[0]{rbuf} =~ /[^0-9]/) {
1084	$self->_error (&Errno::EBADMSG);	1367	$self->_error (Errno::EBADMSG);
1085	}	1368	}
1086	return;	1369	return;
1087	}	1370	}
1088		1371
1089	my $len = $1;	1372	my $len = $1;
…		…
1092	my $string = $_[1];	1375	my $string = $_[1];
1093	$_[0]->unshift_read (chunk => 1, sub {	1376	$_[0]->unshift_read (chunk => 1, sub {
1094	if ($_[1] eq ",") {	1377	if ($_[1] eq ",") {
1095	$cb->($_[0], $string);	1378	$cb->($_[0], $string);
1096	} else {	1379	} else {
1097	$self->_error (&Errno::EBADMSG);	1380	$self->_error (Errno::EBADMSG);
1098	}	1381	}
1099	});	1382	});
1100	});	1383	});
1101		1384
1102	1	1385	1
…		…
1108	An octet string prefixed with an encoded length. The encoding C<$format>	1391	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	1392	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	1393	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1111	optional C<!>, C<< < >> or C<< > >> modifier).	1394	optional C<!>, C<< < >> or C<< > >> modifier).
1112		1395
1113	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1396	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1397	EPP uses a prefix of C<N> (4 octtes).
1114		1398
1115	Example: read a block of data prefixed by its length in BER-encoded	1399	Example: read a block of data prefixed by its length in BER-encoded
1116	format (very efficient).	1400	format (very efficient).
1117		1401
1118	$handle->push_read (packstring => "w", sub {	1402	$handle->push_read (packstring => "w", sub {
…		…
1148	}	1432	}
1149	};	1433	};
1150		1434
1151	=item json => $cb->($handle, $hash_or_arrayref)	1435	=item json => $cb->($handle, $hash_or_arrayref)
1152		1436
1153	Reads a JSON object or array, decodes it and passes it to the callback.	1437	Reads a JSON object or array, decodes it and passes it to the
		1438	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1154		1439
1155	If a C<json> object was passed to the constructor, then that will be used	1440	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.	1441	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1157		1442
1158	This read type uses the incremental parser available with JSON version	1443	This read type uses the incremental parser available with JSON version
…		…
1167	=cut	1452	=cut
1168		1453
1169	register_read_type json => sub {	1454	register_read_type json => sub {
1170	my ($self, $cb) = @_;	1455	my ($self, $cb) = @_;
1171		1456
1172	require JSON;	1457	my $json = $self->{json} ||= json_coder;
1173		1458
1174	my $data;	1459	my $data;
1175	my $rbuf = \$self->{rbuf};	1460	my $rbuf = \$self->{rbuf};
1176		1461
1177	my $json = $self->{json} ||= JSON->new->utf8;
1178
1179	sub {	1462	sub {
1180	my $ref = $json->incr_parse ($self->{rbuf});	1463	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1181		1464
1182	if ($ref) {	1465	if ($ref) {
1183	$self->{rbuf} = $json->incr_text;	1466	$self->{rbuf} = $json->incr_text;
1184	$json->incr_text = "";	1467	$json->incr_text = "";
1185	$cb->($self, $ref);	1468	$cb->($self, $ref);
1186		1469
1187	1	1470	1
		1471	} elsif ($@) {
		1472	# error case
		1473	$json->incr_skip;
		1474
		1475	$self->{rbuf} = $json->incr_text;
		1476	$json->incr_text = "";
		1477
		1478	$self->_error (Errno::EBADMSG);
		1479
		1480	()
1188	} else {	1481	} else {
1189	$self->{rbuf} = "";	1482	$self->{rbuf} = "";
		1483
1190	()	1484	()
1191	}	1485	}
1192	}	1486	}
1193	};	1487	};
1194		1488
…		…
1226	# read remaining chunk	1520	# read remaining chunk
1227	$_[0]->unshift_read (chunk => $len, sub {	1521	$_[0]->unshift_read (chunk => $len, sub {
1228	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1522	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1229	$cb->($_[0], $ref);	1523	$cb->($_[0], $ref);
1230	} else {	1524	} else {
1231	$self->_error (&Errno::EBADMSG);	1525	$self->_error (Errno::EBADMSG);
1232	}	1526	}
1233	});	1527	});
1234	}	1528	}
1235		1529
1236	1	1530	1
…		…
1271	Note that AnyEvent::Handle will automatically C<start_read> for you when	1565	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	1566	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	1567	will automatically C<stop_read> for you when neither C<on_read> is set nor
1274	there are any read requests in the queue.	1568	there are any read requests in the queue.
1275		1569
		1570	These methods will have no effect when in TLS mode (as TLS doesn't support
		1571	half-duplex connections).
		1572
1276	=cut	1573	=cut
1277		1574
1278	sub stop_read {	1575	sub stop_read {
1279	my ($self) = @_;	1576	my ($self) = @_;
1280		1577
1281	delete $self->{_rw};	1578	delete $self->{_rw} unless $self->{tls};
1282	}	1579	}
1283		1580
1284	sub start_read {	1581	sub start_read {
1285	my ($self) = @_;	1582	my ($self) = @_;
1286		1583
1287	unless ($self->{_rw} || $self->{_eof}) {	1584	unless ($self->{_rw} || $self->{_eof}) {
1288	Scalar::Util::weaken $self;	1585	Scalar::Util::weaken $self;
1289		1586
1290	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1587	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1291	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1588	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1292	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1589	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1293		1590
1294	if ($len > 0) {	1591	if ($len > 0) {
1295	$self->{_activity} = AnyEvent->now;	1592	$self->{_activity} = $self->{_ractivity} = AE::now;
1296		1593
1297	$self->{filter_r}	1594	if ($self->{tls}) {
1298	? $self->{filter_r}($self, $rbuf)	1595	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1299	: $self->{_in_drain} || $self->_drain_rbuf;	1596
		1597	&_dotls ($self);
		1598	} else {
		1599	$self->_drain_rbuf;
		1600	}
1300		1601
1301	} elsif (defined $len) {	1602	} elsif (defined $len) {
1302	delete $self->{_rw};	1603	delete $self->{_rw};
1303	$self->{_eof} = 1;	1604	$self->{_eof} = 1;
1304	$self->_drain_rbuf unless $self->{_in_drain};	1605	$self->_drain_rbuf;
1305		1606
1306	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1607	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1307	return $self->_error ($!, 1);	1608	return $self->_error ($!, 1);
1308	}	1609	}
1309	});	1610	};
1310	}	1611	}
1311	}	1612	}
1312		1613
		1614	our $ERROR_SYSCALL;
		1615	our $ERROR_WANT_READ;
		1616
		1617	sub _tls_error {
		1618	my ($self, $err) = @_;
		1619
		1620	return $self->_error ($!, 1)
		1621	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1622
		1623	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1624
		1625	# reduce error string to look less scary
		1626	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1627
		1628	if ($self->{_on_starttls}) {
		1629	(delete $self->{_on_starttls})->($self, undef, $err);
		1630	&_freetls;
		1631	} else {
		1632	&_freetls;
		1633	$self->_error (Errno::EPROTO, 1, $err);
		1634	}
		1635	}
		1636
		1637	# poll the write BIO and send the data if applicable
		1638	# also decode read data if possible
		1639	# this is basiclaly our TLS state machine
		1640	# more efficient implementations are possible with openssl,
		1641	# but not with the buggy and incomplete Net::SSLeay.
1313	sub _dotls {	1642	sub _dotls {
1314	my ($self) = @_;	1643	my ($self) = @_;
1315		1644
1316	my $buf;	1645	my $tmp;
1317		1646
1318	if (length $self->{_tls_wbuf}) {	1647	if (length $self->{_tls_wbuf}) {
1319	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1648	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1320	substr $self->{_tls_wbuf}, 0, $len, "";	1649	substr $self->{_tls_wbuf}, 0, $tmp, "";
1321	}	1650	}
1322	}
1323		1651
		1652	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1653	return $self->_tls_error ($tmp)
		1654	if $tmp != $ERROR_WANT_READ
		1655	&& ($tmp != $ERROR_SYSCALL || $!);
		1656	}
		1657
		1658	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1659	unless (length $tmp) {
		1660	$self->{_on_starttls}
		1661	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1662	&_freetls;
		1663
		1664	if ($self->{on_stoptls}) {
		1665	$self->{on_stoptls}($self);
		1666	return;
		1667	} else {
		1668	# let's treat SSL-eof as we treat normal EOF
		1669	delete $self->{_rw};
		1670	$self->{_eof} = 1;
		1671	}
		1672	}
		1673
		1674	$self->{_tls_rbuf} .= $tmp;
		1675	$self->_drain_rbuf;
		1676	$self->{tls} or return; # tls session might have gone away in callback
		1677	}
		1678
		1679	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1680	return $self->_tls_error ($tmp)
		1681	if $tmp != $ERROR_WANT_READ
		1682	&& ($tmp != $ERROR_SYSCALL || $!);
		1683
1324	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1684	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1325	$self->{wbuf} .= $buf;	1685	$self->{wbuf} .= $tmp;
1326	$self->_drain_wbuf;	1686	$self->_drain_wbuf;
1327	}	1687	}
1328		1688
1329	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1689	$self->{_on_starttls}
1330	if (length $buf) {	1690	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1331	$self->{rbuf} .= $buf;	1691	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1332	$self->_drain_rbuf unless $self->{_in_drain};
1333	} else {
1334	# let's treat SSL-eof as we treat normal EOF
1335	$self->{_eof} = 1;
1336	$self->_shutdown;
1337	return;
1338	}
1339	}
1340
1341	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1342
1343	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1344	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1345	return $self->_error ($!, 1);
1346	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1347	return $self->_error (&Errno::EIO, 1);
1348	}
1349
1350	# all others are fine for our purposes
1351	}
1352	}	1692	}
1353		1693
1354	=item $handle->starttls ($tls[, $tls_ctx])	1694	=item $handle->starttls ($tls[, $tls_ctx])
1355		1695
1356	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1696	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1357	object is created, you can also do that at a later time by calling	1697	object is created, you can also do that at a later time by calling
1358	C<starttls>.	1698	C<starttls>.
1359		1699
		1700	Starting TLS is currently an asynchronous operation - when you push some
		1701	write data and then call C<< ->starttls >> then TLS negotiation will start
		1702	immediately, after which the queued write data is then sent.
		1703
1360	The first argument is the same as the C<tls> constructor argument (either	1704	The first argument is the same as the C<tls> constructor argument (either
1361	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1705	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1362		1706
1363	The second argument is the optional C<Net::SSLeay::CTX> object that is	1707	The second argument is the optional C<AnyEvent::TLS> object that is used
1364	used when AnyEvent::Handle has to create its own TLS connection object.	1708	when AnyEvent::Handle has to create its own TLS connection object, or
		1709	a hash reference with C<< key => value >> pairs that will be used to
		1710	construct a new context.
1365		1711
1366	The TLS connection object will end up in C<< $handle->{tls} >> after this	1712	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1367	call and can be used or changed to your liking. Note that the handshake	1713	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1368	might have already started when this function returns.	1714	changed to your liking. Note that the handshake might have already started
		1715	when this function returns.
1369		1716
		1717	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		1718	handshakes on the same stream. Best do not attempt to use the stream after
		1719	stopping TLS.
		1720
1370	=cut	1721	=cut
		1722
		1723	our %TLS_CACHE; #TODO not yet documented, should we?
1371		1724
1372	sub starttls {	1725	sub starttls {
1373	my ($self, $ssl, $ctx) = @_;	1726	my ($self, $tls, $ctx) = @_;
1374		1727
1375	$self->stoptls;	1728	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1729	if $self->{tls};
1376		1730
1377	if ($ssl eq "accept") {	1731	$self->{tls} = $tls;
1378	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1732	$self->{tls_ctx} = $ctx if @_ > 2;
1379	Net::SSLeay::set_accept_state ($ssl);	1733
1380	} elsif ($ssl eq "connect") {	1734	return unless $self->{fh};
1381	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1735
1382	Net::SSLeay::set_connect_state ($ssl);	1736	require Net::SSLeay;
		1737
		1738	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1739	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1740
		1741	$tls = $self->{tls};
		1742	$ctx = $self->{tls_ctx};
		1743
		1744	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1745
		1746	if ("HASH" eq ref $ctx) {
		1747	require AnyEvent::TLS;
		1748
		1749	if ($ctx->{cache}) {
		1750	my $key = $ctx+0;
		1751	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1752	} else {
		1753	$ctx = new AnyEvent::TLS %$ctx;
		1754	}
		1755	}
1383	}	1756
1384		1757	$self->{tls_ctx} = $ctx || TLS_CTX ();
1385	$self->{tls} = $ssl;	1758	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1386		1759
1387	# basically, this is deep magic (because SSL_read should have the same issues)	1760	# basically, this is deep magic (because SSL_read should have the same issues)
1388	# but the openssl maintainers basically said: "trust us, it just works".	1761	# but the openssl maintainers basically said: "trust us, it just works".
1389	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1762	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1390	# and mismaintained ssleay-module doesn't even offer them).	1763	# and mismaintained ssleay-module doesn't even offer them).
1391	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1764	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1392	#	1765	#
1393	# in short: this is a mess.	1766	# in short: this is a mess.
1394	#	1767	#
1395	# note that we do not try to kepe the length constant between writes as we are required to do.	1768	# note that we do not try to keep the length constant between writes as we are required to do.
1396	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1769	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1397	# and we drive openssl fully in blocking mode here.	1770	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1771	# have identity issues in that area.
1398	Net::SSLeay::CTX_set_mode ($self->{tls},	1772	# Net::SSLeay::CTX_set_mode ($ssl,
1399	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1773	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1400	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1774	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1775	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1401		1776
1402	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1777	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1403	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1778	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1404		1779
		1780	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1781
1405	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1782	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1406		1783
1407	$self->{filter_w} = sub {	1784	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1408	$_[0]{_tls_wbuf} .= ${$_[1]};	1785	if $self->{on_starttls};
1409	&_dotls;	1786
1410	};	1787	&_dotls; # need to trigger the initial handshake
1411	$self->{filter_r} = sub {	1788	$self->start_read; # make sure we actually do read
1412	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1413	&_dotls;
1414	};
1415	}	1789	}
1416		1790
1417	=item $handle->stoptls	1791	=item $handle->stoptls
1418		1792
1419	Destroys the SSL connection, if any. Partial read or write data will be	1793	Shuts down the SSL connection - this makes a proper EOF handshake by
1420	lost.	1794	sending a close notify to the other side, but since OpenSSL doesn't
		1795	support non-blocking shut downs, it is not guarenteed that you can re-use
		1796	the stream afterwards.
1421		1797
1422	=cut	1798	=cut
1423		1799
1424	sub stoptls {	1800	sub stoptls {
1425	my ($self) = @_;	1801	my ($self) = @_;
1426		1802
1427	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1803	if ($self->{tls}) {
		1804	Net::SSLeay::shutdown ($self->{tls});
1428		1805
1429	delete $self->{_rbio};	1806	&_dotls;
1430	delete $self->{_wbio};	1807
1431	delete $self->{_tls_wbuf};	1808	# # we don't give a shit. no, we do, but we can't. no...#d#
1432	delete $self->{filter_r};	1809	# # we, we... have to use openssl :/#d#
1433	delete $self->{filter_w};	1810	# &_freetls;#d#
		1811	}
		1812	}
		1813
		1814	sub _freetls {
		1815	my ($self) = @_;
		1816
		1817	return unless $self->{tls};
		1818
		1819	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1820	if $self->{tls} > 0;
		1821
		1822	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1434	}	1823	}
1435		1824
1436	sub DESTROY {	1825	sub DESTROY {
1437	my $self = shift;	1826	my ($self) = @_;
1438		1827
1439	$self->stoptls;	1828	&_freetls;
1440		1829
1441	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1830	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1442		1831
1443	if ($linger && length $self->{wbuf}) {	1832	if ($linger && length $self->{wbuf} && $self->{fh}) {
1444	my $fh = delete $self->{fh};	1833	my $fh = delete $self->{fh};
1445	my $wbuf = delete $self->{wbuf};	1834	my $wbuf = delete $self->{wbuf};
1446		1835
1447	my @linger;	1836	my @linger;
1448		1837
1449	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1838	push @linger, AE::io $fh, 1, sub {
1450	my $len = syswrite $fh, $wbuf, length $wbuf;	1839	my $len = syswrite $fh, $wbuf, length $wbuf;
1451		1840
1452	if ($len > 0) {	1841	if ($len > 0) {
1453	substr $wbuf, 0, $len, "";	1842	substr $wbuf, 0, $len, "";
1454	} else {	1843	} else {
1455	@linger = (); # end	1844	@linger = (); # end
1456	}	1845	}
1457	});	1846	};
1458	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1847	push @linger, AE::timer $linger, 0, sub {
1459	@linger = ();	1848	@linger = ();
1460	});	1849	};
1461	}	1850	}
		1851	}
		1852
		1853	=item $handle->destroy
		1854
		1855	Shuts down the handle object as much as possible - this call ensures that
		1856	no further callbacks will be invoked and as many resources as possible
		1857	will be freed. Any method you will call on the handle object after
		1858	destroying it in this way will be silently ignored (and it will return the
		1859	empty list).
		1860
		1861	Normally, you can just "forget" any references to an AnyEvent::Handle
		1862	object and it will simply shut down. This works in fatal error and EOF
		1863	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1864	callback, so when you want to destroy the AnyEvent::Handle object from
		1865	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1866	that case.
		1867
		1868	Destroying the handle object in this way has the advantage that callbacks
		1869	will be removed as well, so if those are the only reference holders (as
		1870	is common), then one doesn't need to do anything special to break any
		1871	reference cycles.
		1872
		1873	The handle might still linger in the background and write out remaining
		1874	data, as specified by the C<linger> option, however.
		1875
		1876	=cut
		1877
		1878	sub destroy {
		1879	my ($self) = @_;
		1880
		1881	$self->DESTROY;
		1882	%$self = ();
		1883	bless $self, "AnyEvent::Handle::destroyed";
		1884	}
		1885
		1886	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1887	#nop
1462	}	1888	}
1463		1889
1464	=item AnyEvent::Handle::TLS_CTX	1890	=item AnyEvent::Handle::TLS_CTX
1465		1891
1466	This function creates and returns the Net::SSLeay::CTX object used by	1892	This function creates and returns the AnyEvent::TLS object used by default
1467	default for TLS mode.	1893	for TLS mode.
1468		1894
1469	The context is created like this:	1895	The context is created by calling L<AnyEvent::TLS> without any arguments.
1470
1471	Net::SSLeay::load_error_strings;
1472	Net::SSLeay::SSLeay_add_ssl_algorithms;
1473	Net::SSLeay::randomize;
1474
1475	my $CTX = Net::SSLeay::CTX_new;
1476
1477	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1478		1896
1479	=cut	1897	=cut
1480		1898
1481	our $TLS_CTX;	1899	our $TLS_CTX;
1482		1900
1483	sub TLS_CTX() {	1901	sub TLS_CTX() {
1484	$TLS_CTX || do {	1902	$TLS_CTX ||= do {
1485	require Net::SSLeay;	1903	require AnyEvent::TLS;
1486		1904
1487	Net::SSLeay::load_error_strings ();	1905	new AnyEvent::TLS
1488	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1489	Net::SSLeay::randomize ();
1490
1491	$TLS_CTX = Net::SSLeay::CTX_new ();
1492
1493	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1494
1495	$TLS_CTX
1496	}	1906	}
1497	}	1907	}
1498		1908
1499	=back	1909	=back
		1910
		1911
		1912	=head1 NONFREQUENTLY ASKED QUESTIONS
		1913
		1914	=over 4
		1915
		1916	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1917	still get further invocations!
		1918
		1919	That's because AnyEvent::Handle keeps a reference to itself when handling
		1920	read or write callbacks.
		1921
		1922	It is only safe to "forget" the reference inside EOF or error callbacks,
		1923	from within all other callbacks, you need to explicitly call the C<<
		1924	->destroy >> method.
		1925
		1926	=item I get different callback invocations in TLS mode/Why can't I pause
		1927	reading?
		1928
		1929	Unlike, say, TCP, TLS connections do not consist of two independent
		1930	communication channels, one for each direction. Or put differently. The
		1931	read and write directions are not independent of each other: you cannot
		1932	write data unless you are also prepared to read, and vice versa.
		1933
		1934	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1935	callback invocations when you are not expecting any read data - the reason
		1936	is that AnyEvent::Handle always reads in TLS mode.
		1937
		1938	During the connection, you have to make sure that you always have a
		1939	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1940	connection (or when you no longer want to use it) you can call the
		1941	C<destroy> method.
		1942
		1943	=item How do I read data until the other side closes the connection?
		1944
		1945	If you just want to read your data into a perl scalar, the easiest way
		1946	to achieve this is by setting an C<on_read> callback that does nothing,
		1947	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1948	will be in C<$_[0]{rbuf}>:
		1949
		1950	$handle->on_read (sub { });
		1951	$handle->on_eof (undef);
		1952	$handle->on_error (sub {
		1953	my $data = delete $_[0]{rbuf};
		1954	});
		1955
		1956	The reason to use C<on_error> is that TCP connections, due to latencies
		1957	and packets loss, might get closed quite violently with an error, when in
		1958	fact, all data has been received.
		1959
		1960	It is usually better to use acknowledgements when transferring data,
		1961	to make sure the other side hasn't just died and you got the data
		1962	intact. This is also one reason why so many internet protocols have an
		1963	explicit QUIT command.
		1964
		1965	=item I don't want to destroy the handle too early - how do I wait until
		1966	all data has been written?
		1967
		1968	After writing your last bits of data, set the C<on_drain> callback
		1969	and destroy the handle in there - with the default setting of
		1970	C<low_water_mark> this will be called precisely when all data has been
		1971	written to the socket:
		1972
		1973	$handle->push_write (...);
		1974	$handle->on_drain (sub {
		1975	warn "all data submitted to the kernel\n";
		1976	undef $handle;
		1977	});
		1978
		1979	If you just want to queue some data and then signal EOF to the other side,
		1980	consider using C<< ->push_shutdown >> instead.
		1981
		1982	=item I want to contact a TLS/SSL server, I don't care about security.
		1983
		1984	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1985	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1986	parameter:
		1987
		1988	tcp_connect $host, $port, sub {
		1989	my ($fh) = @_;
		1990
		1991	my $handle = new AnyEvent::Handle
		1992	fh => $fh,
		1993	tls => "connect",
		1994	on_error => sub { ... };
		1995
		1996	$handle->push_write (...);
		1997	};
		1998
		1999	=item I want to contact a TLS/SSL server, I do care about security.
		2000
		2001	Then you should additionally enable certificate verification, including
		2002	peername verification, if the protocol you use supports it (see
		2003	L<AnyEvent::TLS>, C<verify_peername>).
		2004
		2005	E.g. for HTTPS:
		2006
		2007	tcp_connect $host, $port, sub {
		2008	my ($fh) = @_;
		2009
		2010	my $handle = new AnyEvent::Handle
		2011	fh => $fh,
		2012	peername => $host,
		2013	tls => "connect",
		2014	tls_ctx => { verify => 1, verify_peername => "https" },
		2015	...
		2016
		2017	Note that you must specify the hostname you connected to (or whatever
		2018	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2019	peername verification will be done.
		2020
		2021	The above will use the system-dependent default set of trusted CA
		2022	certificates. If you want to check against a specific CA, add the
		2023	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2024
		2025	tls_ctx => {
		2026	verify => 1,
		2027	verify_peername => "https",
		2028	ca_file => "my-ca-cert.pem",
		2029	},
		2030
		2031	=item I want to create a TLS/SSL server, how do I do that?
		2032
		2033	Well, you first need to get a server certificate and key. You have
		2034	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2035	self-signed certificate (cheap. check the search engine of your choice,
		2036	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2037	nice program for that purpose).
		2038
		2039	Then create a file with your private key (in PEM format, see
		2040	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2041	file should then look like this:
		2042
		2043	-----BEGIN RSA PRIVATE KEY-----
		2044	...header data
		2045	... lots of base64'y-stuff
		2046	-----END RSA PRIVATE KEY-----
		2047
		2048	-----BEGIN CERTIFICATE-----
		2049	... lots of base64'y-stuff
		2050	-----END CERTIFICATE-----
		2051
		2052	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2053	specify this file as C<cert_file>:
		2054
		2055	tcp_server undef, $port, sub {
		2056	my ($fh) = @_;
		2057
		2058	my $handle = new AnyEvent::Handle
		2059	fh => $fh,
		2060	tls => "accept",
		2061	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2062	...
		2063
		2064	When you have intermediate CA certificates that your clients might not
		2065	know about, just append them to the C<cert_file>.
		2066
		2067	=back
		2068
1500		2069
1501	=head1 SUBCLASSING AnyEvent::Handle	2070	=head1 SUBCLASSING AnyEvent::Handle
1502		2071
1503	In many cases, you might want to subclass AnyEvent::Handle.	2072	In many cases, you might want to subclass AnyEvent::Handle.
1504		2073

Diff Legend

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