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.55 by root, Tue Jun 3 16:15:30 2008 UTC vs.
Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC

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

Diff Legend

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