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.74 by root, Fri Jul 18 01:29:58 2008 UTC vs.
Revision 1.171 by root, Tue Aug 4 12:38:55 2009 UTC

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

Diff Legend

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