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

Diff Legend

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