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

Diff Legend

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