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.44 by root, Thu May 29 00:00:07 2008 UTC vs.
Revision 1.187 by root, Tue Sep 8 00:01:12 2009 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict;
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16
17	=cut
18
19	our $VERSION = '0.04';
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
32	$cv->broadcast;	15	my ($hdl, $fatal, $msg) = @_;
33	},	16	warn "got error $msg\n";
		17	$hdl->destroy;
		18	$cv->send;
34	);	19	);
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	warn "got line <$line>\n";
43	$cv->send;	28	$cv->send;
44	});	29	});
45		30
46	$cv->recv;	31	$cv->recv;
47		32
48	=head1 DESCRIPTION	33	=head1 DESCRIPTION
49		34
50	This module is a helper module to make it easier to do event-based I/O on	35	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	36	filehandles.
52	on sockets see L<AnyEvent::Util>.	37
		38	The L<AnyEvent::Intro> tutorial contains some well-documented
		39	AnyEvent::Handle examples.
53		40
54	In the following, when the documentation refers to of "bytes" then this	41	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	42	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
57		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
58	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
59	argument.	49	argument.
60		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
61	=head1 METHODS	80	=head1 METHODS
62		81
63	=over 4	82	=over 4
64		83
65	=item B<new (%args)>	84	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
66		85
67	The constructor supports these arguments (all as key => value pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
68		87
69	=over 4	88	=over 4
70		89
71	=item fh => $filehandle [MANDATORY]	90	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
72		91
73	The filehandle this L<AnyEvent::Handle> object will operate on.	92	The filehandle this L<AnyEvent::Handle> object will operate on.
74
75	NOTE: The filehandle will be set to non-blocking (using	93	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	94	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		95	that mode.
77		96
78	=item on_eof => $cb->($handle)	97	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
79		98
80	Set the callback to be called on EOF.	99	Try to connect to the specified host and service (port), using
		100	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		101	default C<peername>.
81		102
82	While not mandatory, it is highly recommended to set an eof callback,	103	You have to specify either this parameter, or C<fh>, above.
83	otherwise you might end up with a closed socket while you are still
84	waiting for data.
85		104
		105	It is possible to push requests on the read and write queues, and modify
		106	properties of the stream, even while AnyEvent::Handle is connecting.
		107
		108	When this parameter is specified, then the C<on_prepare>,
		109	C<on_connect_error> and C<on_connect> callbacks will be called under the
		110	appropriate circumstances:
		111
		112	=over 4
		113
86	=item on_error => $cb->($handle)	114	=item on_prepare => $cb->($handle)
87		115
		116	This (rarely used) callback is called before a new connection is
		117	attempted, but after the file handle has been created. It could be used to
		118	prepare the file handle with parameters required for the actual connect
		119	(as opposed to settings that can be changed when the connection is already
		120	established).
		121
		122	The return value of this callback should be the connect timeout value in
		123	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		124	timeout is to be used).
		125
		126	=item on_connect => $cb->($handle, $host, $port, $retry->())
		127
		128	This callback is called when a connection has been successfully established.
		129
		130	The actual numeric host and port (the socket peername) are passed as
		131	parameters, together with a retry callback.
		132
		133	When, for some reason, the handle is not acceptable, then calling
		134	C<$retry> will continue with the next connection target (in case of
		135	multi-homed hosts or SRV records there can be multiple connection
		136	endpoints). At the time it is called the read and write queues, eof
		137	status, tls status and similar properties of the handle will have been
		138	reset.
		139
		140	In most cases, ignoring the C<$retry> parameter is the way to go.
		141
		142	=item on_connect_error => $cb->($handle, $message)
		143
		144	This callback is called when the connection could not be
		145	established. C<$!> will contain the relevant error code, and C<$message> a
		146	message describing it (usually the same as C<"$!">).
		147
		148	If this callback isn't specified, then C<on_error> will be called with a
		149	fatal error instead.
		150
		151	=back
		152
		153	=item on_error => $cb->($handle, $fatal, $message)
		154
88	This is the fatal error callback, that is called when, well, a fatal error	155	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	156	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	157	connect or a read error.
91		158
92	The object will not be in a usable state when this callback has been	159	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	160	fatal errors the handle object will be destroyed (by a call to C<< ->
		161	destroy >>) after invoking the error callback (which means you are free to
		162	examine the handle object). Examples of fatal errors are an EOF condition
		163	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		164	cases where the other side can close the connection at their will it is
		165	often easiest to not report C<EPIPE> errors in this callback.
		166
		167	AnyEvent::Handle tries to find an appropriate error code for you to check
		168	against, but in some cases (TLS errors), this does not work well. It is
		169	recommended to always output the C<$message> argument in human-readable
		170	error messages (it's usually the same as C<"$!">).
		171
		172	Non-fatal errors can be retried by simply returning, but it is recommended
		173	to simply ignore this parameter and instead abondon the handle object
		174	when this callback is invoked. Examples of non-fatal errors are timeouts
		175	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
94		176
95	On callback entrance, the value of C<$!> contains the operating system	177	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	178	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
97		179	C<EPROTO>).
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100		180
101	While not mandatory, it is I<highly> recommended to set this callback, as	181	While not mandatory, it is I<highly> recommended to set this callback, as
102	you will not be notified of errors otherwise. The default simply calls	182	you will not be notified of errors otherwise. The default simply calls
103	die.	183	C<croak>.
104		184
105	=item on_read => $cb->($handle)	185	=item on_read => $cb->($handle)
106		186
107	This sets the default read callback, which is called when data arrives	187	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	188	and no read request is in the queue (unlike read queue callbacks, this
		189	callback will only be called when at least one octet of data is in the
		190	read buffer).
109		191
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	192	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$handle->{rbuf}> member directly.	193	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		194	must not enlarge or modify the read buffer, you can only remove data at
		195	the beginning from it.
112		196
113	When an EOF condition is detected then AnyEvent::Handle will first try to	197	When an EOF condition is detected then AnyEvent::Handle will first try to
114	feed all the remaining data to the queued callbacks and C<on_read> before	198	feed all the remaining data to the queued callbacks and C<on_read> before
115	calling the C<on_eof> callback. If no progress can be made, then a fatal	199	calling the C<on_eof> callback. If no progress can be made, then a fatal
116	error will be raised (with C<$!> set to C<EPIPE>).	200	error will be raised (with C<$!> set to C<EPIPE>).
117		201
		202	Note that, unlike requests in the read queue, an C<on_read> callback
		203	doesn't mean you I<require> some data: if there is an EOF and there
		204	are outstanding read requests then an error will be flagged. With an
		205	C<on_read> callback, the C<on_eof> callback will be invoked.
		206
		207	=item on_eof => $cb->($handle)
		208
		209	Set the callback to be called when an end-of-file condition is detected,
		210	i.e. in the case of a socket, when the other side has closed the
		211	connection cleanly, and there are no outstanding read requests in the
		212	queue (if there are read requests, then an EOF counts as an unexpected
		213	connection close and will be flagged as an error).
		214
		215	For sockets, this just means that the other side has stopped sending data,
		216	you can still try to write data, and, in fact, one can return from the EOF
		217	callback and continue writing data, as only the read part has been shut
		218	down.
		219
		220	If an EOF condition has been detected but no C<on_eof> callback has been
		221	set, then a fatal error will be raised with C<$!> set to <0>.
		222
118	=item on_drain => $cb->($handle)	223	=item on_drain => $cb->($handle)
119		224
120	This sets the callback that is called when the write buffer becomes empty	225	This sets the callback that is called when the write buffer becomes empty
121	(or when the callback is set and the buffer is empty already).	226	(or when the callback is set and the buffer is empty already).
122		227
123	To append to the write buffer, use the C<< ->push_write >> method.	228	To append to the write buffer, use the C<< ->push_write >> method.
124		229
		230	This callback is useful when you don't want to put all of your write data
		231	into the queue at once, for example, when you want to write the contents
		232	of some file to the socket you might not want to read the whole file into
		233	memory and push it into the queue, but instead only read more data from
		234	the file when the write queue becomes empty.
		235
125	=item timeout => $fractional_seconds	236	=item timeout => $fractional_seconds
126		237
		238	=item rtimeout => $fractional_seconds
		239
		240	=item wtimeout => $fractional_seconds
		241
127	If non-zero, then this enables an "inactivity" timeout: whenever this many	242	If non-zero, then these enables an "inactivity" timeout: whenever this
128	seconds pass without a successful read or write on the underlying file	243	many seconds pass without a successful read or write on the underlying
129	handle, the C<on_timeout> callback will be invoked (and if that one is	244	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
130	missing, an C<ETIMEDOUT> errror will be raised).	245	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		246	error will be raised).
		247
		248	There are three variants of the timeouts that work fully independent
		249	of each other, for both read and write, just read, and just write:
		250	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		251	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		252	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
131		253
132	Note that timeout processing is also active when you currently do not have	254	Note that timeout processing is also active when you currently do not have
133	any outstanding read or write requests: If you plan to keep the connection	255	any outstanding read or write requests: If you plan to keep the connection
134	idle then you should disable the timout temporarily or ignore the timeout	256	idle then you should disable the timout temporarily or ignore the timeout
135	in the C<on_timeout> callback.	257	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		258	restart the timeout.
136		259
137	Zero (the default) disables this timeout.	260	Zero (the default) disables this timeout.
138		261
139	=item on_timeout => $cb->($handle)	262	=item on_timeout => $cb->($handle)
140		263
…		…
144		267
145	=item rbuf_max => <bytes>	268	=item rbuf_max => <bytes>
146		269
147	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	270	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
148	when the read buffer ever (strictly) exceeds this size. This is useful to	271	when the read buffer ever (strictly) exceeds this size. This is useful to
149	avoid denial-of-service attacks.	272	avoid some forms of denial-of-service attacks.
150		273
151	For example, a server accepting connections from untrusted sources should	274	For example, a server accepting connections from untrusted sources should
152	be configured to accept only so-and-so much data that it cannot act on	275	be configured to accept only so-and-so much data that it cannot act on
153	(for example, when expecting a line, an attacker could send an unlimited	276	(for example, when expecting a line, an attacker could send an unlimited
154	amount of data without a callback ever being called as long as the line	277	amount of data without a callback ever being called as long as the line
155	isn't finished).	278	isn't finished).
156		279
		280	=item autocork => <boolean>
		281
		282	When disabled (the default), then C<push_write> will try to immediately
		283	write the data to the handle, if possible. This avoids having to register
		284	a write watcher and wait for the next event loop iteration, but can
		285	be inefficient if you write multiple small chunks (on the wire, this
		286	disadvantage is usually avoided by your kernel's nagle algorithm, see
		287	C<no_delay>, but this option can save costly syscalls).
		288
		289	When enabled, then writes will always be queued till the next event loop
		290	iteration. This is efficient when you do many small writes per iteration,
		291	but less efficient when you do a single write only per iteration (or when
		292	the write buffer often is full). It also increases write latency.
		293
		294	=item no_delay => <boolean>
		295
		296	When doing small writes on sockets, your operating system kernel might
		297	wait a bit for more data before actually sending it out. This is called
		298	the Nagle algorithm, and usually it is beneficial.
		299
		300	In some situations you want as low a delay as possible, which can be
		301	accomplishd by setting this option to a true value.
		302
		303	The default is your opertaing system's default behaviour (most likely
		304	enabled), this option explicitly enables or disables it, if possible.
		305
		306	=item keepalive => <boolean>
		307
		308	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		309	normally, TCP connections have no time-out once established, so TCP
		310	connections, once established, can stay alive forever even when the other
		311	side has long gone. TCP keepalives are a cheap way to take down long-lived
		312	TCP connections whent he other side becomes unreachable. While the default
		313	is OS-dependent, TCP keepalives usually kick in after around two hours,
		314	and, if the other side doesn't reply, take down the TCP connection some 10
		315	to 15 minutes later.
		316
		317	It is harmless to specify this option for file handles that do not support
		318	keepalives, and enabling it on connections that are potentially long-lived
		319	is usually a good idea.
		320
		321	=item oobinline => <boolean>
		322
		323	BSD majorly fucked up the implementation of TCP urgent data. The result
		324	is that almost no OS implements TCP according to the specs, and every OS
		325	implements it slightly differently.
		326
		327	If you want to handle TCP urgent data, then setting this flag (the default
		328	is enabled) gives you the most portable way of getting urgent data, by
		329	putting it into the stream.
		330
		331	Since BSD emulation of OOB data on top of TCP's urgent data can have
		332	security implications, AnyEvent::Handle sets this flag automatically
		333	unless explicitly specified. Note that setting this flag after
		334	establishing a connection I<may> be a bit too late (data loss could
		335	already have occured on BSD systems), but at least it will protect you
		336	from most attacks.
		337
157	=item read_size => <bytes>	338	=item read_size => <bytes>
158		339
159	The default read block size (the amount of bytes this module will try to read	340	The default read block size (the amount of bytes this module will
160	on each [loop iteration). Default: C<4096>.	341	try to read during each loop iteration, which affects memory
		342	requirements). Default: C<8192>.
161		343
162	=item low_water_mark => <bytes>	344	=item low_water_mark => <bytes>
163		345
164	Sets the amount of bytes (default: C<0>) that make up an "empty" write	346	Sets the amount of bytes (default: C<0>) that make up an "empty" write
165	buffer: If the write reaches this size or gets even samller it is	347	buffer: If the write reaches this size or gets even samller it is
166	considered empty.	348	considered empty.
167		349
		350	Sometimes it can be beneficial (for performance reasons) to add data to
		351	the write buffer before it is fully drained, but this is a rare case, as
		352	the operating system kernel usually buffers data as well, so the default
		353	is good in almost all cases.
		354
		355	=item linger => <seconds>
		356
		357	If non-zero (default: C<3600>), then the destructor of the
		358	AnyEvent::Handle object will check whether there is still outstanding
		359	write data and will install a watcher that will write this data to the
		360	socket. No errors will be reported (this mostly matches how the operating
		361	system treats outstanding data at socket close time).
		362
		363	This will not work for partial TLS data that could not be encoded
		364	yet. This data will be lost. Calling the C<stoptls> method in time might
		365	help.
		366
		367	=item peername => $string
		368
		369	A string used to identify the remote site - usually the DNS hostname
		370	(I<not> IDN!) used to create the connection, rarely the IP address.
		371
		372	Apart from being useful in error messages, this string is also used in TLS
		373	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		374	verification will be skipped when C<peername> is not specified or
		375	C<undef>.
		376
168	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	377	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
169		378
170	When this parameter is given, it enables TLS (SSL) mode, that means it	379	When this parameter is given, it enables TLS (SSL) mode, that means
171	will start making tls handshake and will transparently encrypt/decrypt	380	AnyEvent will start a TLS handshake as soon as the connection has been
172	data.	381	established and will transparently encrypt/decrypt data afterwards.
		382
		383	All TLS protocol errors will be signalled as C<EPROTO>, with an
		384	appropriate error message.
173		385
174	TLS mode requires Net::SSLeay to be installed (it will be loaded	386	TLS mode requires Net::SSLeay to be installed (it will be loaded
175	automatically when you try to create a TLS handle).	387	automatically when you try to create a TLS handle): this module doesn't
		388	have a dependency on that module, so if your module requires it, you have
		389	to add the dependency yourself.
176		390
177	For the TLS server side, use C<accept>, and for the TLS client side of a	391	Unlike TCP, TLS has a server and client side: for the TLS server side, use
178	connection, use C<connect> mode.	392	C<accept>, and for the TLS client side of a connection, use C<connect>
		393	mode.
179		394
180	You can also provide your own TLS connection object, but you have	395	You can also provide your own TLS connection object, but you have
181	to make sure that you call either C<Net::SSLeay::set_connect_state>	396	to make sure that you call either C<Net::SSLeay::set_connect_state>
182	or C<Net::SSLeay::set_accept_state> on it before you pass it to	397	or C<Net::SSLeay::set_accept_state> on it before you pass it to
183	AnyEvent::Handle.	398	AnyEvent::Handle. Also, this module will take ownership of this connection
		399	object.
184		400
		401	At some future point, AnyEvent::Handle might switch to another TLS
		402	implementation, then the option to use your own session object will go
		403	away.
		404
		405	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		406	passing in the wrong integer will lead to certain crash. This most often
		407	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		408	segmentation fault.
		409
185	See the C<starttls> method if you need to start TLs negotiation later.	410	See the C<< ->starttls >> method for when need to start TLS negotiation later.
186		411
187	=item tls_ctx => $ssl_ctx	412	=item tls_ctx => $anyevent_tls
188		413
189	Use the given Net::SSLeay::CTX object to create the new TLS connection	414	Use the given C<AnyEvent::TLS> object to create the new TLS connection
190	(unless a connection object was specified directly). If this parameter is	415	(unless a connection object was specified directly). If this parameter is
191	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	416	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
192		417
		418	Instead of an object, you can also specify a hash reference with C<< key
		419	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		420	new TLS context object.
		421
		422	=item on_starttls => $cb->($handle, $success[, $error_message])
		423
		424	This callback will be invoked when the TLS/SSL handshake has finished. If
		425	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		426	(C<on_stoptls> will not be called in this case).
		427
		428	The session in C<< $handle->{tls} >> can still be examined in this
		429	callback, even when the handshake was not successful.
		430
		431	TLS handshake failures will not cause C<on_error> to be invoked when this
		432	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		433
		434	Without this callback, handshake failures lead to C<on_error> being
		435	called, as normal.
		436
		437	Note that you cannot call C<starttls> right again in this callback. If you
		438	need to do that, start an zero-second timer instead whose callback can
		439	then call C<< ->starttls >> again.
		440
		441	=item on_stoptls => $cb->($handle)
		442
		443	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		444	set, then it will be invoked after freeing the TLS session. If it is not,
		445	then a TLS shutdown condition will be treated like a normal EOF condition
		446	on the handle.
		447
		448	The session in C<< $handle->{tls} >> can still be examined in this
		449	callback.
		450
		451	This callback will only be called on TLS shutdowns, not when the
		452	underlying handle signals EOF.
		453
193	=item json => JSON or JSON::XS object	454	=item json => JSON or JSON::XS object
194		455
195	This is the json coder object used by the C<json> read and write types.	456	This is the json coder object used by the C<json> read and write types.
196		457
197	If you don't supply it, then AnyEvent::Handle will create and use a	458	If you don't supply it, then AnyEvent::Handle will create and use a
198	suitable one, which will write and expect UTF-8 encoded JSON texts.	459	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		460	texts.
199		461
200	Note that you are responsible to depend on the JSON module if you want to	462	Note that you are responsible to depend on the JSON module if you want to
201	use this functionality, as AnyEvent does not have a dependency itself.	463	use this functionality, as AnyEvent does not have a dependency itself.
202		464
203	=item filter_r => $cb
204
205	=item filter_w => $cb
206
207	These exist, but are undocumented at this time.
208
209	=back	465	=back
210		466
211	=cut	467	=cut
212		468
213	sub new {	469	sub new {
214	my $class = shift;	470	my $class = shift;
215
216	my $self = bless { @_ }, $class;	471	my $self = bless { @_ }, $class;
217		472
218	$self->{fh} or Carp::croak "mandatory argument fh is missing";	473	if ($self->{fh}) {
		474	$self->_start;
		475	return unless $self->{fh}; # could be gone by now
		476
		477	} elsif ($self->{connect}) {
		478	require AnyEvent::Socket;
		479
		480	$self->{peername} = $self->{connect}[0]
		481	unless exists $self->{peername};
		482
		483	$self->{_skip_drain_rbuf} = 1;
		484
		485	{
		486	Scalar::Util::weaken (my $self = $self);
		487
		488	$self->{_connect} =
		489	AnyEvent::Socket::tcp_connect (
		490	$self->{connect}[0],
		491	$self->{connect}[1],
		492	sub {
		493	my ($fh, $host, $port, $retry) = @_;
		494
		495	if ($fh) {
		496	$self->{fh} = $fh;
		497
		498	delete $self->{_skip_drain_rbuf};
		499	$self->_start;
		500
		501	$self->{on_connect}
		502	and $self->{on_connect}($self, $host, $port, sub {
		503	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		504	$self->{_skip_drain_rbuf} = 1;
		505	&$retry;
		506	});
		507
		508	} else {
		509	if ($self->{on_connect_error}) {
		510	$self->{on_connect_error}($self, "$!");
		511	$self->destroy;
		512	} else {
		513	$self->_error ($!, 1);
		514	}
		515	}
		516	},
		517	sub {
		518	local $self->{fh} = $_[0];
		519
		520	$self->{on_prepare}
		521	? $self->{on_prepare}->($self)
		522	: ()
		523	}
		524	);
		525	}
		526
		527	} else {
		528	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		529	}
		530
		531	$self
		532	}
		533
		534	sub _start {
		535	my ($self) = @_;
219		536
220	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	537	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
221		538
222	if ($self->{tls}) {	539	$self->{_activity} =
223	require Net::SSLeay;	540	$self->{_ractivity} =
		541	$self->{_wactivity} = AE::now;
		542
		543	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		544	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		545	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		546
		547	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		548	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
		549
		550	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		551
224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	552	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
225	}	553	if $self->{tls};
226		554
227	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
228	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
229	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
230	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	555	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
231		556
232	$self->{_activity} = AnyEvent->now;
233	$self->_timeout;
234
235	$self->start_read;	557	$self->start_read
		558	if $self->{on_read} || @{ $self->{_queue} };
236		559
237	$self	560	$self->_drain_wbuf;
238	}	561	}
239		562
240	sub _shutdown {
241	my ($self) = @_;
242
243	delete $self->{_rw};
244	delete $self->{_ww};
245	delete $self->{fh};
246	}
247
248	sub error {	563	sub _error {
249	my ($self) = @_;	564	my ($self, $errno, $fatal, $message) = @_;
250		565
251	{	566	$! = $errno;
252	local $!;	567	$message ||= "$!";
253	$self->_shutdown;
254	}
255		568
256	$self->{on_error}($self)
257	if $self->{on_error};	569	if ($self->{on_error}) {
258		570	$self->{on_error}($self, $fatal, $message);
		571	$self->destroy if $fatal;
		572	} elsif ($self->{fh} || $self->{connect}) {
		573	$self->destroy;
259	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	574	Carp::croak "AnyEvent::Handle uncaught error: $message";
		575	}
260	}	576	}
261		577
262	=item $fh = $handle->fh	578	=item $fh = $handle->fh
263		579
264	This method returns the file handle of the L<AnyEvent::Handle> object.	580	This method returns the file handle used to create the L<AnyEvent::Handle> object.
265		581
266	=cut	582	=cut
267		583
268	sub fh { $_[0]{fh} }	584	sub fh { $_[0]{fh} }
269		585
…		…
287	$_[0]{on_eof} = $_[1];	603	$_[0]{on_eof} = $_[1];
288	}	604	}
289		605
290	=item $handle->on_timeout ($cb)	606	=item $handle->on_timeout ($cb)
291		607
292	Replace the current C<on_timeout> callback, or disables the callback	608	=item $handle->on_rtimeout ($cb)
293	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
294	argument.
295		609
296	=cut	610	=item $handle->on_wtimeout ($cb)
297		611
298	sub on_timeout {	612	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
		613	callback, or disables the callback (but not the timeout) if C<$cb> =
		614	C<undef>. See the C<timeout> constructor argument and method.
		615
		616	=cut
		617
		618	# see below
		619
		620	=item $handle->autocork ($boolean)
		621
		622	Enables or disables the current autocork behaviour (see C<autocork>
		623	constructor argument). Changes will only take effect on the next write.
		624
		625	=cut
		626
		627	sub autocork {
		628	$_[0]{autocork} = $_[1];
		629	}
		630
		631	=item $handle->no_delay ($boolean)
		632
		633	Enables or disables the C<no_delay> setting (see constructor argument of
		634	the same name for details).
		635
		636	=cut
		637
		638	sub no_delay {
		639	$_[0]{no_delay} = $_[1];
		640
		641	eval {
		642	local $SIG{__DIE__};
		643	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		644	if $_[0]{fh};
		645	};
		646	}
		647
		648	=item $handle->keepalive ($boolean)
		649
		650	Enables or disables the C<keepalive> setting (see constructor argument of
		651	the same name for details).
		652
		653	=cut
		654
		655	sub keepalive {
		656	$_[0]{keepalive} = $_[1];
		657
		658	eval {
		659	local $SIG{__DIE__};
		660	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		661	if $_[0]{fh};
		662	};
		663	}
		664
		665	=item $handle->oobinline ($boolean)
		666
		667	Enables or disables the C<oobinline> setting (see constructor argument of
		668	the same name for details).
		669
		670	=cut
		671
		672	sub oobinline {
		673	$_[0]{oobinline} = $_[1];
		674
		675	eval {
		676	local $SIG{__DIE__};
		677	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		678	if $_[0]{fh};
		679	};
		680	}
		681
		682	=item $handle->keepalive ($boolean)
		683
		684	Enables or disables the C<keepalive> setting (see constructor argument of
		685	the same name for details).
		686
		687	=cut
		688
		689	sub keepalive {
		690	$_[0]{keepalive} = $_[1];
		691
		692	eval {
		693	local $SIG{__DIE__};
		694	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		695	if $_[0]{fh};
		696	};
		697	}
		698
		699	=item $handle->on_starttls ($cb)
		700
		701	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		702
		703	=cut
		704
		705	sub on_starttls {
		706	$_[0]{on_starttls} = $_[1];
		707	}
		708
		709	=item $handle->on_stoptls ($cb)
		710
		711	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		712
		713	=cut
		714
		715	sub on_starttls {
299	$_[0]{on_timeout} = $_[1];	716	$_[0]{on_stoptls} = $_[1];
		717	}
		718
		719	=item $handle->rbuf_max ($max_octets)
		720
		721	Configures the C<rbuf_max> setting (C<undef> disables it).
		722
		723	=cut
		724
		725	sub rbuf_max {
		726	$_[0]{rbuf_max} = $_[1];
300	}	727	}
301		728
302	#############################################################################	729	#############################################################################
303		730
304	=item $handle->timeout ($seconds)	731	=item $handle->timeout ($seconds)
305		732
		733	=item $handle->rtimeout ($seconds)
		734
		735	=item $handle->wtimeout ($seconds)
		736
306	Configures (or disables) the inactivity timeout.	737	Configures (or disables) the inactivity timeout.
307		738
308	=cut	739	=item $handle->timeout_reset
309		740
310	sub timeout {	741	=item $handle->rtimeout_reset
		742
		743	=item $handle->wtimeout_reset
		744
		745	Reset the activity timeout, as if data was received or sent.
		746
		747	These methods are cheap to call.
		748
		749	=cut
		750
		751	for my $dir ("", "r", "w") {
		752	my $timeout = "${dir}timeout";
		753	my $tw = "_${dir}tw";
		754	my $on_timeout = "on_${dir}timeout";
		755	my $activity = "_${dir}activity";
		756	my $cb;
		757
		758	*$on_timeout = sub {
		759	$_[0]{$on_timeout} = $_[1];
		760	};
		761
		762	*$timeout = sub {
311	my ($self, $timeout) = @_;	763	my ($self, $new_value) = @_;
312		764
313	$self->{timeout} = $timeout;	765	$self->{$timeout} = $new_value;
314	$self->_timeout;	766	delete $self->{$tw}; &$cb;
315	}	767	};
316		768
		769	*{"${dir}timeout_reset"} = sub {
		770	$_[0]{$activity} = AE::now;
		771	};
		772
		773	# main workhorse:
317	# reset the timeout watcher, as neccessary	774	# reset the timeout watcher, as neccessary
318	# also check for time-outs	775	# also check for time-outs
319	sub _timeout {	776	$cb = sub {
320	my ($self) = @_;	777	my ($self) = @_;
321		778
322	if ($self->{timeout}) {	779	if ($self->{$timeout} && $self->{fh}) {
323	my $NOW = AnyEvent->now;	780	my $NOW = AE::now;
324		781
325	# when would the timeout trigger?	782	# when would the timeout trigger?
326	my $after = $self->{_activity} + $self->{timeout} - $NOW;	783	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
327		784
328	# now or in the past already?	785	# now or in the past already?
329	if ($after <= 0) {	786	if ($after <= 0) {
330	$self->{_activity} = $NOW;	787	$self->{$activity} = $NOW;
331		788
332	if ($self->{on_timeout}) {	789	if ($self->{$on_timeout}) {
333	$self->{on_timeout}->($self);	790	$self->{$on_timeout}($self);
334	} else {	791	} else {
335	$! = Errno::ETIMEDOUT;	792	$self->_error (Errno::ETIMEDOUT);
336	$self->error;	793	}
		794
		795	# callback could have changed timeout value, optimise
		796	return unless $self->{$timeout};
		797
		798	# calculate new after
		799	$after = $self->{$timeout};
337	}	800	}
338		801
339	# callbakx could have changed timeout value, optimise	802	Scalar::Util::weaken $self;
340	return unless $self->{timeout};	803	return unless $self; # ->error could have destroyed $self
341		804
342	# calculate new after	805	$self->{$tw} ||= AE::timer $after, 0, sub {
343	$after = $self->{timeout};	806	delete $self->{$tw};
		807	$cb->($self);
		808	};
		809	} else {
		810	delete $self->{$tw};
344	}	811	}
345
346	Scalar::Util::weaken $self;
347
348	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
349	delete $self->{_tw};
350	$self->_timeout;
351	});
352	} else {
353	delete $self->{_tw};
354	}	812	}
355	}	813	}
356		814
357	#############################################################################	815	#############################################################################
358		816
…		…
382	my ($self, $cb) = @_;	840	my ($self, $cb) = @_;
383		841
384	$self->{on_drain} = $cb;	842	$self->{on_drain} = $cb;
385		843
386	$cb->($self)	844	$cb->($self)
387	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	845	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
388	}	846	}
389		847
390	=item $handle->push_write ($data)	848	=item $handle->push_write ($data)
391		849
392	Queues the given scalar to be written. You can push as much data as you	850	Queues the given scalar to be written. You can push as much data as you
…		…
403	Scalar::Util::weaken $self;	861	Scalar::Util::weaken $self;
404		862
405	my $cb = sub {	863	my $cb = sub {
406	my $len = syswrite $self->{fh}, $self->{wbuf};	864	my $len = syswrite $self->{fh}, $self->{wbuf};
407		865
408	if ($len >= 0) {	866	if (defined $len) {
409	substr $self->{wbuf}, 0, $len, "";	867	substr $self->{wbuf}, 0, $len, "";
410		868
411	$self->{_activity} = AnyEvent->now;	869	$self->{_activity} = $self->{_wactivity} = AE::now;
412		870
413	$self->{on_drain}($self)	871	$self->{on_drain}($self)
414	if $self->{low_water_mark} >= length $self->{wbuf}	872	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
415	&& $self->{on_drain};	873	&& $self->{on_drain};
416		874
417	delete $self->{_ww} unless length $self->{wbuf};	875	delete $self->{_ww} unless length $self->{wbuf};
418	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	876	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
419	$self->error;	877	$self->_error ($!, 1);
420	}	878	}
421	};	879	};
422		880
423	# try to write data immediately	881	# try to write data immediately
424	$cb->();	882	$cb->() unless $self->{autocork};
425		883
426	# if still data left in wbuf, we need to poll	884	# if still data left in wbuf, we need to poll
427	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	885	$self->{_ww} = AE::io $self->{fh}, 1, $cb
428	if length $self->{wbuf};	886	if length $self->{wbuf};
429	};	887	};
430	}	888	}
431		889
432	our %WH;	890	our %WH;
433		891
		892	# deprecated
434	sub register_write_type($$) {	893	sub register_write_type($$) {
435	$WH{$_[0]} = $_[1];	894	$WH{$_[0]} = $_[1];
436	}	895	}
437		896
438	sub push_write {	897	sub push_write {
439	my $self = shift;	898	my $self = shift;
440		899
441	if (@_ > 1) {	900	if (@_ > 1) {
442	my $type = shift;	901	my $type = shift;
443		902
		903	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
444	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	904	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
445	->($self, @_);	905	->($self, @_);
446	}	906	}
447		907
448	if ($self->{filter_w}) {	908	if ($self->{tls}) {
449	$self->{filter_w}->($self, \$_[0]);	909	$self->{_tls_wbuf} .= $_[0];
		910	&_dotls ($self) if $self->{fh};
450	} else {	911	} else {
451	$self->{wbuf} .= $_[0];	912	$self->{wbuf} .= $_[0];
452	$self->_drain_wbuf;	913	$self->_drain_wbuf if $self->{fh};
453	}	914	}
454	}	915	}
455		916
456	=item $handle->push_write (type => @args)	917	=item $handle->push_write (type => @args)
457		918
458	=item $handle->unshift_write (type => @args)
459
460	Instead of formatting your data yourself, you can also let this module do	919	Instead of formatting your data yourself, you can also let this module
461	the job by specifying a type and type-specific arguments.	920	do the job by specifying a type and type-specific arguments. You
		921	can also specify the (fully qualified) name of a package, in which
		922	case AnyEvent tries to load the package and then expects to find the
		923	C<anyevent_read_type> function inside (see "custom write types", below).
462		924
463	Predefined types are (if you have ideas for additional types, feel free to	925	Predefined types are (if you have ideas for additional types, feel free to
464	drop by and tell us):	926	drop by and tell us):
465		927
466	=over 4	928	=over 4
…		…
468	=item netstring => $string	930	=item netstring => $string
469		931
470	Formats the given value as netstring	932	Formats the given value as netstring
471	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	933	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
472		934
473	=back
474
475	=cut	935	=cut
476		936
477	register_write_type netstring => sub {	937	register_write_type netstring => sub {
478	my ($self, $string) = @_;	938	my ($self, $string) = @_;
479		939
480	sprintf "%d:%s,", (length $string), $string	940	(length $string) . ":$string,"
		941	};
		942
		943	=item packstring => $format, $data
		944
		945	An octet string prefixed with an encoded length. The encoding C<$format>
		946	uses the same format as a Perl C<pack> format, but must specify a single
		947	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		948	optional C<!>, C<< < >> or C<< > >> modifier).
		949
		950	=cut
		951
		952	register_write_type packstring => sub {
		953	my ($self, $format, $string) = @_;
		954
		955	pack "$format/a*", $string
481	};	956	};
482		957
483	=item json => $array_or_hashref	958	=item json => $array_or_hashref
484		959
485	Encodes the given hash or array reference into a JSON object. Unless you	960	Encodes the given hash or array reference into a JSON object. Unless you
…		…
510	Other languages could read single lines terminated by a newline and pass	985	Other languages could read single lines terminated by a newline and pass
511	this line into their JSON decoder of choice.	986	this line into their JSON decoder of choice.
512		987
513	=cut	988	=cut
514		989
		990	sub json_coder() {
		991	eval { require JSON::XS; JSON::XS->new->utf8 }
		992	|| do { require JSON; JSON->new->utf8 }
		993	}
		994
515	register_write_type json => sub {	995	register_write_type json => sub {
516	my ($self, $ref) = @_;	996	my ($self, $ref) = @_;
517		997
518	require JSON;	998	my $json = $self->{json} ||= json_coder;
519		999
520	$self->{json} ? $self->{json}->encode ($ref)	1000	$json->encode ($ref)
521	: JSON::encode_json ($ref)
522	};	1001	};
523		1002
524	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1003	=item storable => $reference
525		1004
526	This function (not method) lets you add your own types to C<push_write>.	1005	Freezes the given reference using L<Storable> and writes it to the
		1006	handle. Uses the C<nfreeze> format.
		1007
		1008	=cut
		1009
		1010	register_write_type storable => sub {
		1011	my ($self, $ref) = @_;
		1012
		1013	require Storable;
		1014
		1015	pack "w/a*", Storable::nfreeze ($ref)
		1016	};
		1017
		1018	=back
		1019
		1020	=item $handle->push_shutdown
		1021
		1022	Sometimes you know you want to close the socket after writing your data
		1023	before it was actually written. One way to do that is to replace your
		1024	C<on_drain> handler by a callback that shuts down the socket (and set
		1025	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1026	replaces the C<on_drain> callback with:
		1027
		1028	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		1029
		1030	This simply shuts down the write side and signals an EOF condition to the
		1031	the peer.
		1032
		1033	You can rely on the normal read queue and C<on_eof> handling
		1034	afterwards. This is the cleanest way to close a connection.
		1035
		1036	=cut
		1037
		1038	sub push_shutdown {
		1039	my ($self) = @_;
		1040
		1041	delete $self->{low_water_mark};
		1042	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1043	}
		1044
		1045	=item custom write types - Package::anyevent_write_type $handle, @args
		1046
		1047	Instead of one of the predefined types, you can also specify the name of
		1048	a package. AnyEvent will try to load the package and then expects to find
		1049	a function named C<anyevent_write_type> inside. If it isn't found, it
		1050	progressively tries to load the parent package until it either finds the
		1051	function (good) or runs out of packages (bad).
		1052
527	Whenever the given C<type> is used, C<push_write> will invoke the code	1053	Whenever the given C<type> is used, C<push_write> will the function with
528	reference with the handle object and the remaining arguments.	1054	the handle object and the remaining arguments.
529		1055
530	The code reference is supposed to return a single octet string that will	1056	The function is supposed to return a single octet string that will be
531	be appended to the write buffer.	1057	appended to the write buffer, so you cna mentally treat this function as a
		1058	"arguments to on-the-wire-format" converter.
532		1059
533	Note that this is a function, and all types registered this way will be	1060	Example: implement a custom write type C<join> that joins the remaining
534	global, so try to use unique names.	1061	arguments using the first one.
		1062
		1063	$handle->push_write (My::Type => " ", 1,2,3);
		1064
		1065	# uses the following package, which can be defined in the "My::Type" or in
		1066	# the "My" modules to be auto-loaded, or just about anywhere when the
		1067	# My::Type::anyevent_write_type is defined before invoking it.
		1068
		1069	package My::Type;
		1070
		1071	sub anyevent_write_type {
		1072	my ($handle, $delim, @args) = @_;
		1073
		1074	join $delim, @args
		1075	}
535		1076
536	=cut	1077	=cut
537		1078
538	#############################################################################	1079	#############################################################################
539		1080
…		…
548	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1089	ways, the "simple" way, using only C<on_read> and the "complex" way, using
549	a queue.	1090	a queue.
550		1091
551	In the simple case, you just install an C<on_read> callback and whenever	1092	In the simple case, you just install an C<on_read> callback and whenever
552	new data arrives, it will be called. You can then remove some data (if	1093	new data arrives, it will be called. You can then remove some data (if
553	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	1094	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
554	or not.	1095	leave the data there if you want to accumulate more (e.g. when only a
		1096	partial message has been received so far).
555		1097
556	In the more complex case, you want to queue multiple callbacks. In this	1098	In the more complex case, you want to queue multiple callbacks. In this
557	case, AnyEvent::Handle will call the first queued callback each time new	1099	case, AnyEvent::Handle will call the first queued callback each time new
558	data arrives and removes it when it has done its job (see C<push_read>,	1100	data arrives (also the first time it is queued) and removes it when it has
559	below).	1101	done its job (see C<push_read>, below).
560		1102
561	This way you can, for example, push three line-reads, followed by reading	1103	This way you can, for example, push three line-reads, followed by reading
562	a chunk of data, and AnyEvent::Handle will execute them in order.	1104	a chunk of data, and AnyEvent::Handle will execute them in order.
563		1105
564	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	1106	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
565	the specified number of bytes which give an XML datagram.	1107	the specified number of bytes which give an XML datagram.
566		1108
567	# in the default state, expect some header bytes	1109	# in the default state, expect some header bytes
568	$handle->on_read (sub {	1110	$handle->on_read (sub {
569	# some data is here, now queue the length-header-read (4 octets)	1111	# some data is here, now queue the length-header-read (4 octets)
570	shift->unshift_read_chunk (4, sub {	1112	shift->unshift_read (chunk => 4, sub {
571	# header arrived, decode	1113	# header arrived, decode
572	my $len = unpack "N", $_[1];	1114	my $len = unpack "N", $_[1];
573		1115
574	# now read the payload	1116	# now read the payload
575	shift->unshift_read_chunk ($len, sub {	1117	shift->unshift_read (chunk => $len, sub {
576	my $xml = $_[1];	1118	my $xml = $_[1];
577	# handle xml	1119	# handle xml
578	});	1120	});
579	});	1121	});
580	});	1122	});
581		1123
582	Example 2: Implement a client for a protocol that replies either with	1124	Example 2: Implement a client for a protocol that replies either with "OK"
583	"OK" and another line or "ERROR" for one request, and 64 bytes for the	1125	and another line or "ERROR" for the first request that is sent, and 64
584	second request. Due tot he availability of a full queue, we can just	1126	bytes for the second request. Due to the availability of a queue, we can
585	pipeline sending both requests and manipulate the queue as necessary in	1127	just pipeline sending both requests and manipulate the queue as necessary
586	the callbacks:	1128	in the callbacks.
587		1129
588	# request one	1130	When the first callback is called and sees an "OK" response, it will
		1131	C<unshift> another line-read. This line-read will be queued I<before> the
		1132	64-byte chunk callback.
		1133
		1134	# request one, returns either "OK + extra line" or "ERROR"
589	$handle->push_write ("request 1\015\012");	1135	$handle->push_write ("request 1\015\012");
590		1136
591	# we expect "ERROR" or "OK" as response, so push a line read	1137	# we expect "ERROR" or "OK" as response, so push a line read
592	$handle->push_read_line (sub {	1138	$handle->push_read (line => sub {
593	# if we got an "OK", we have to _prepend_ another line,	1139	# if we got an "OK", we have to _prepend_ another line,
594	# so it will be read before the second request reads its 64 bytes	1140	# so it will be read before the second request reads its 64 bytes
595	# which are already in the queue when this callback is called	1141	# which are already in the queue when this callback is called
596	# we don't do this in case we got an error	1142	# we don't do this in case we got an error
597	if ($_[1] eq "OK") {	1143	if ($_[1] eq "OK") {
598	$_[0]->unshift_read_line (sub {	1144	$_[0]->unshift_read (line => sub {
599	my $response = $_[1];	1145	my $response = $_[1];
600	...	1146	...
601	});	1147	});
602	}	1148	}
603	});	1149	});
604		1150
605	# request two	1151	# request two, simply returns 64 octets
606	$handle->push_write ("request 2\015\012");	1152	$handle->push_write ("request 2\015\012");
607		1153
608	# simply read 64 bytes, always	1154	# simply read 64 bytes, always
609	$handle->push_read_chunk (64, sub {	1155	$handle->push_read (chunk => 64, sub {
610	my $response = $_[1];	1156	my $response = $_[1];
611	...	1157	...
612	});	1158	});
613		1159
614	=over 4	1160	=over 4
615		1161
616	=cut	1162	=cut
617		1163
618	sub _drain_rbuf {	1164	sub _drain_rbuf {
619	my ($self) = @_;	1165	my ($self) = @_;
		1166
		1167	# avoid recursion
		1168	return if $self->{_skip_drain_rbuf};
		1169	local $self->{_skip_drain_rbuf} = 1;
		1170
		1171	while () {
		1172	# we need to use a separate tls read buffer, as we must not receive data while
		1173	# we are draining the buffer, and this can only happen with TLS.
		1174	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1175	if exists $self->{_tls_rbuf};
		1176
		1177	my $len = length $self->{rbuf};
		1178
		1179	if (my $cb = shift @{ $self->{_queue} }) {
		1180	unless ($cb->($self)) {
		1181	# no progress can be made
		1182	# (not enough data and no data forthcoming)
		1183	$self->_error (Errno::EPIPE, 1), return
		1184	if $self->{_eof};
		1185
		1186	unshift @{ $self->{_queue} }, $cb;
		1187	last;
		1188	}
		1189	} elsif ($self->{on_read}) {
		1190	last unless $len;
		1191
		1192	$self->{on_read}($self);
		1193
		1194	if (
		1195	$len == length $self->{rbuf} # if no data has been consumed
		1196	&& !@{ $self->{_queue} } # and the queue is still empty
		1197	&& $self->{on_read} # but we still have on_read
		1198	) {
		1199	# no further data will arrive
		1200	# so no progress can be made
		1201	$self->_error (Errno::EPIPE, 1), return
		1202	if $self->{_eof};
		1203
		1204	last; # more data might arrive
		1205	}
		1206	} else {
		1207	# read side becomes idle
		1208	delete $self->{_rw} unless $self->{tls};
		1209	last;
		1210	}
		1211	}
		1212
		1213	if ($self->{_eof}) {
		1214	$self->{on_eof}
		1215	? $self->{on_eof}($self)
		1216	: $self->_error (0, 1, "Unexpected end-of-file");
		1217
		1218	return;
		1219	}
620		1220
621	if (	1221	if (
622	defined $self->{rbuf_max}	1222	defined $self->{rbuf_max}
623	&& $self->{rbuf_max} < length $self->{rbuf}	1223	&& $self->{rbuf_max} < length $self->{rbuf}
624	) {	1224	) {
625	$! = &Errno::ENOSPC;	1225	$self->_error (Errno::ENOSPC, 1), return;
626	$self->error;
627	}	1226	}
628		1227
629	return if $self->{in_drain};	1228	# may need to restart read watcher
630	local $self->{in_drain} = 1;	1229	unless ($self->{_rw}) {
631		1230	$self->start_read
632	while (my $len = length $self->{rbuf}) {	1231	if $self->{on_read} || @{ $self->{_queue} };
633	no strict 'refs';
634	if (my $cb = shift @{ $self->{_queue} }) {
635	unless ($cb->($self)) {
636	if ($self->{_eof}) {
637	# no progress can be made (not enough data and no data forthcoming)
638	$! = &Errno::EPIPE;
639	$self->error;
640	}
641
642	unshift @{ $self->{_queue} }, $cb;
643	return;
644	}
645	} elsif ($self->{on_read}) {
646	$self->{on_read}($self);
647
648	if (
649	$self->{_eof} # if no further data will arrive
650	&& $len == length $self->{rbuf} # and no data has been consumed
651	&& !@{ $self->{_queue} } # and the queue is still empty
652	&& $self->{on_read} # and we still want to read data
653	) {
654	# then no progress can be made
655	$! = &Errno::EPIPE;
656	$self->error;
657	}
658	} else {
659	# read side becomes idle
660	delete $self->{_rw};
661	return;
662	}
663	}
664
665	if ($self->{_eof}) {
666	$self->_shutdown;
667	$self->{on_eof}($self)
668	if $self->{on_eof};
669	}	1232	}
670	}	1233	}
671		1234
672	=item $handle->on_read ($cb)	1235	=item $handle->on_read ($cb)
673		1236
…		…
679		1242
680	sub on_read {	1243	sub on_read {
681	my ($self, $cb) = @_;	1244	my ($self, $cb) = @_;
682		1245
683	$self->{on_read} = $cb;	1246	$self->{on_read} = $cb;
		1247	$self->_drain_rbuf if $cb;
684	}	1248	}
685		1249
686	=item $handle->rbuf	1250	=item $handle->rbuf
687		1251
688	Returns the read buffer (as a modifiable lvalue).	1252	Returns the read buffer (as a modifiable lvalue).
689		1253
690	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1254	You can access the read buffer directly as the C<< ->{rbuf} >>
691	you want.	1255	member, if you want. However, the only operation allowed on the
		1256	read buffer (apart from looking at it) is removing data from its
		1257	beginning. Otherwise modifying or appending to it is not allowed and will
		1258	lead to hard-to-track-down bugs.
692		1259
693	NOTE: The read buffer should only be used or modified if the C<on_read>,	1260	NOTE: The read buffer should only be used or modified if the C<on_read>,
694	C<push_read> or C<unshift_read> methods are used. The other read methods	1261	C<push_read> or C<unshift_read> methods are used. The other read methods
695	automatically manage the read buffer.	1262	automatically manage the read buffer.
696		1263
…		…
732	my $cb = pop;	1299	my $cb = pop;
733		1300
734	if (@_) {	1301	if (@_) {
735	my $type = shift;	1302	my $type = shift;
736		1303
		1304	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
737	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1305	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
738	->($self, $cb, @_);	1306	->($self, $cb, @_);
739	}	1307	}
740		1308
741	push @{ $self->{_queue} }, $cb;	1309	push @{ $self->{_queue} }, $cb;
742	$self->_drain_rbuf;	1310	$self->_drain_rbuf;
…		…
751		1319
752	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1320	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
753	->($self, $cb, @_);	1321	->($self, $cb, @_);
754	}	1322	}
755		1323
756
757	unshift @{ $self->{_queue} }, $cb;	1324	unshift @{ $self->{_queue} }, $cb;
758	$self->_drain_rbuf;	1325	$self->_drain_rbuf;
759	}	1326	}
760		1327
761	=item $handle->push_read (type => @args, $cb)	1328	=item $handle->push_read (type => @args, $cb)
762		1329
763	=item $handle->unshift_read (type => @args, $cb)	1330	=item $handle->unshift_read (type => @args, $cb)
764		1331
765	Instead of providing a callback that parses the data itself you can chose	1332	Instead of providing a callback that parses the data itself you can chose
766	between a number of predefined parsing formats, for chunks of data, lines	1333	between a number of predefined parsing formats, for chunks of data, lines
767	etc.	1334	etc. You can also specify the (fully qualified) name of a package, in
		1335	which case AnyEvent tries to load the package and then expects to find the
		1336	C<anyevent_read_type> function inside (see "custom read types", below).
768		1337
769	Predefined types are (if you have ideas for additional types, feel free to	1338	Predefined types are (if you have ideas for additional types, feel free to
770	drop by and tell us):	1339	drop by and tell us):
771		1340
772	=over 4	1341	=over 4
…		…
793	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1362	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
794	1	1363	1
795	}	1364	}
796	};	1365	};
797		1366
798	# compatibility with older API
799	sub push_read_chunk {
800	$_[0]->push_read (chunk => $_[1], $_[2]);
801	}
802
803	sub unshift_read_chunk {
804	$_[0]->unshift_read (chunk => $_[1], $_[2]);
805	}
806
807	=item line => [$eol, ]$cb->($handle, $line, $eol)	1367	=item line => [$eol, ]$cb->($handle, $line, $eol)
808		1368
809	The callback will be called only once a full line (including the end of	1369	The callback will be called only once a full line (including the end of
810	line marker, C<$eol>) has been read. This line (excluding the end of line	1370	line marker, C<$eol>) has been read. This line (excluding the end of line
811	marker) will be passed to the callback as second argument (C<$line>), and	1371	marker) will be passed to the callback as second argument (C<$line>), and
…		…
826	=cut	1386	=cut
827		1387
828	register_read_type line => sub {	1388	register_read_type line => sub {
829	my ($self, $cb, $eol) = @_;	1389	my ($self, $cb, $eol) = @_;
830		1390
831	$eol = qr|(\015?\012)| if @_ < 3;	1391	if (@_ < 3) {
832	$eol = quotemeta $eol unless ref $eol;	1392	# this is more than twice as fast as the generic code below
833	$eol = qr|^(.*?)($eol)|s;
834
835	sub {	1393	sub {
836	$_[0]{rbuf} =~ s/$eol// or return;	1394	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
837		1395
838	$cb->($_[0], $1, $2);	1396	$cb->($_[0], $1, $2);
839	1
840	}
841	};
842
843	# compatibility with older API
844	sub push_read_line {
845	my $self = shift;
846	$self->push_read (line => @_);
847	}
848
849	sub unshift_read_line {
850	my $self = shift;
851	$self->unshift_read (line => @_);
852	}
853
854	=item netstring => $cb->($handle, $string)
855
856	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
857
858	Throws an error with C<$!> set to EBADMSG on format violations.
859
860	=cut
861
862	register_read_type netstring => sub {
863	my ($self, $cb) = @_;
864
865	sub {
866	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
867	if ($_[0]{rbuf} =~ /[^0-9]/) {
868	$! = &Errno::EBADMSG;
869	$self->error;
870	}	1397	1
871	return;
872	}	1398	}
		1399	} else {
		1400	$eol = quotemeta $eol unless ref $eol;
		1401	$eol = qr|^(.*?)($eol)|s;
873		1402
874	my $len = $1;	1403	sub {
		1404	$_[0]{rbuf} =~ s/$eol// or return;
875		1405
876	$self->unshift_read (chunk => $len, sub {	1406	$cb->($_[0], $1, $2);
877	my $string = $_[1];
878	$_[0]->unshift_read (chunk => 1, sub {
879	if ($_[1] eq ",") {
880	$cb->($_[0], $string);
881	} else {
882	$! = &Errno::EBADMSG;
883	$self->error;
884	}
885	});	1407	1
886	});	1408	}
887
888	1
889	}	1409	}
890	};	1410	};
891		1411
892	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1412	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
893		1413
…		…
945	return 1;	1465	return 1;
946	}	1466	}
947		1467
948	# reject	1468	# reject
949	if ($reject && $$rbuf =~ $reject) {	1469	if ($reject && $$rbuf =~ $reject) {
950	$! = &Errno::EBADMSG;	1470	$self->_error (Errno::EBADMSG);
951	$self->error;
952	}	1471	}
953		1472
954	# skip	1473	# skip
955	if ($skip && $$rbuf =~ $skip) {	1474	if ($skip && $$rbuf =~ $skip) {
956	$data .= substr $$rbuf, 0, $+[0], "";	1475	$data .= substr $$rbuf, 0, $+[0], "";
…		…
958		1477
959	()	1478	()
960	}	1479	}
961	};	1480	};
962		1481
		1482	=item netstring => $cb->($handle, $string)
		1483
		1484	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1485
		1486	Throws an error with C<$!> set to EBADMSG on format violations.
		1487
		1488	=cut
		1489
		1490	register_read_type netstring => sub {
		1491	my ($self, $cb) = @_;
		1492
		1493	sub {
		1494	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
		1495	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1496	$self->_error (Errno::EBADMSG);
		1497	}
		1498	return;
		1499	}
		1500
		1501	my $len = $1;
		1502
		1503	$self->unshift_read (chunk => $len, sub {
		1504	my $string = $_[1];
		1505	$_[0]->unshift_read (chunk => 1, sub {
		1506	if ($_[1] eq ",") {
		1507	$cb->($_[0], $string);
		1508	} else {
		1509	$self->_error (Errno::EBADMSG);
		1510	}
		1511	});
		1512	});
		1513
		1514	1
		1515	}
		1516	};
		1517
		1518	=item packstring => $format, $cb->($handle, $string)
		1519
		1520	An octet string prefixed with an encoded length. The encoding C<$format>
		1521	uses the same format as a Perl C<pack> format, but must specify a single
		1522	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1523	optional C<!>, C<< < >> or C<< > >> modifier).
		1524
		1525	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1526	EPP uses a prefix of C<N> (4 octtes).
		1527
		1528	Example: read a block of data prefixed by its length in BER-encoded
		1529	format (very efficient).
		1530
		1531	$handle->push_read (packstring => "w", sub {
		1532	my ($handle, $data) = @_;
		1533	});
		1534
		1535	=cut
		1536
		1537	register_read_type packstring => sub {
		1538	my ($self, $cb, $format) = @_;
		1539
		1540	sub {
		1541	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1542	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1543	or return;
		1544
		1545	$format = length pack $format, $len;
		1546
		1547	# bypass unshift if we already have the remaining chunk
		1548	if ($format + $len <= length $_[0]{rbuf}) {
		1549	my $data = substr $_[0]{rbuf}, $format, $len;
		1550	substr $_[0]{rbuf}, 0, $format + $len, "";
		1551	$cb->($_[0], $data);
		1552	} else {
		1553	# remove prefix
		1554	substr $_[0]{rbuf}, 0, $format, "";
		1555
		1556	# read remaining chunk
		1557	$_[0]->unshift_read (chunk => $len, $cb);
		1558	}
		1559
		1560	1
		1561	}
		1562	};
		1563
963	=item json => $cb->($handle, $hash_or_arrayref)	1564	=item json => $cb->($handle, $hash_or_arrayref)
964		1565
965	Reads a JSON object or array, decodes it and passes it to the callback.	1566	Reads a JSON object or array, decodes it and passes it to the
		1567	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
966		1568
967	If a C<json> object was passed to the constructor, then that will be used	1569	If a C<json> object was passed to the constructor, then that will be used
968	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1570	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
969		1571
970	This read type uses the incremental parser available with JSON version	1572	This read type uses the incremental parser available with JSON version
…		…
977	the C<json> write type description, above, for an actual example.	1579	the C<json> write type description, above, for an actual example.
978		1580
979	=cut	1581	=cut
980		1582
981	register_read_type json => sub {	1583	register_read_type json => sub {
982	my ($self, $cb, $accept, $reject, $skip) = @_;	1584	my ($self, $cb) = @_;
983		1585
984	require JSON;	1586	my $json = $self->{json} ||= json_coder;
985		1587
986	my $data;	1588	my $data;
987	my $rbuf = \$self->{rbuf};	1589	my $rbuf = \$self->{rbuf};
988		1590
989	my $json = $self->{json} ||= JSON->new->utf8;
990
991	sub {	1591	sub {
992	my $ref = $json->incr_parse ($self->{rbuf});	1592	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
993		1593
994	if ($ref) {	1594	if ($ref) {
995	$self->{rbuf} = $json->incr_text;	1595	$self->{rbuf} = $json->incr_text;
996	$json->incr_text = "";	1596	$json->incr_text = "";
997	$cb->($self, $ref);	1597	$cb->($self, $ref);
998		1598
999	1	1599	1
		1600	} elsif ($@) {
		1601	# error case
		1602	$json->incr_skip;
		1603
		1604	$self->{rbuf} = $json->incr_text;
		1605	$json->incr_text = "";
		1606
		1607	$self->_error (Errno::EBADMSG);
		1608
		1609	()
1000	} else {	1610	} else {
1001	$self->{rbuf} = "";	1611	$self->{rbuf} = "";
		1612
1002	()	1613	()
1003	}	1614	}
1004	}	1615	}
1005	};	1616	};
1006		1617
		1618	=item storable => $cb->($handle, $ref)
		1619
		1620	Deserialises a L<Storable> frozen representation as written by the
		1621	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1622	data).
		1623
		1624	Raises C<EBADMSG> error if the data could not be decoded.
		1625
		1626	=cut
		1627
		1628	register_read_type storable => sub {
		1629	my ($self, $cb) = @_;
		1630
		1631	require Storable;
		1632
		1633	sub {
		1634	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1635	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1636	or return;
		1637
		1638	my $format = length pack "w", $len;
		1639
		1640	# bypass unshift if we already have the remaining chunk
		1641	if ($format + $len <= length $_[0]{rbuf}) {
		1642	my $data = substr $_[0]{rbuf}, $format, $len;
		1643	substr $_[0]{rbuf}, 0, $format + $len, "";
		1644	$cb->($_[0], Storable::thaw ($data));
		1645	} else {
		1646	# remove prefix
		1647	substr $_[0]{rbuf}, 0, $format, "";
		1648
		1649	# read remaining chunk
		1650	$_[0]->unshift_read (chunk => $len, sub {
		1651	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1652	$cb->($_[0], $ref);
		1653	} else {
		1654	$self->_error (Errno::EBADMSG);
		1655	}
		1656	});
		1657	}
		1658
		1659	1
		1660	}
		1661	};
		1662
1007	=back	1663	=back
1008		1664
1009	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1665	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1010		1666
1011	This function (not method) lets you add your own types to C<push_read>.	1667	Instead of one of the predefined types, you can also specify the name
		1668	of a package. AnyEvent will try to load the package and then expects to
		1669	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1670	progressively tries to load the parent package until it either finds the
		1671	function (good) or runs out of packages (bad).
1012		1672
1013	Whenever the given C<type> is used, C<push_read> will invoke the code	1673	Whenever this type is used, C<push_read> will invoke the function with the
1014	reference with the handle object, the callback and the remaining	1674	handle object, the original callback and the remaining arguments.
1015	arguments.
1016		1675
1017	The code reference is supposed to return a callback (usually a closure)	1676	The function is supposed to return a callback (usually a closure) that
1018	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1677	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1678	mentally treat the function as a "configurable read type to read callback"
		1679	converter.
1019		1680
1020	It should invoke the passed callback when it is done reading (remember to	1681	It should invoke the original callback when it is done reading (remember
1021	pass C<$handle> as first argument as all other callbacks do that).	1682	to pass C<$handle> as first argument as all other callbacks do that,
		1683	although there is no strict requirement on this).
1022		1684
1023	Note that this is a function, and all types registered this way will be
1024	global, so try to use unique names.
1025
1026	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1685	For examples, see the source of this module (F<perldoc -m
1027	search for C<register_read_type>)).	1686	AnyEvent::Handle>, search for C<register_read_type>)).
1028		1687
1029	=item $handle->stop_read	1688	=item $handle->stop_read
1030		1689
1031	=item $handle->start_read	1690	=item $handle->start_read
1032		1691
1033	In rare cases you actually do not want to read anything from the	1692	In rare cases you actually do not want to read anything from the
1034	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1693	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1035	any queued callbacks will be executed then. To start reading again, call	1694	any queued callbacks will be executed then. To start reading again, call
1036	C<start_read>.	1695	C<start_read>.
1037		1696
		1697	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1698	you change the C<on_read> callback or push/unshift a read callback, and it
		1699	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1700	there are any read requests in the queue.
		1701
		1702	These methods will have no effect when in TLS mode (as TLS doesn't support
		1703	half-duplex connections).
		1704
1038	=cut	1705	=cut
1039		1706
1040	sub stop_read {	1707	sub stop_read {
1041	my ($self) = @_;	1708	my ($self) = @_;
1042		1709
1043	delete $self->{_rw};	1710	delete $self->{_rw} unless $self->{tls};
1044	}	1711	}
1045		1712
1046	sub start_read {	1713	sub start_read {
1047	my ($self) = @_;	1714	my ($self) = @_;
1048		1715
1049	unless ($self->{_rw} || $self->{_eof}) {	1716	unless ($self->{_rw} || $self->{_eof}) {
1050	Scalar::Util::weaken $self;	1717	Scalar::Util::weaken $self;
1051		1718
1052	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1719	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1053	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1720	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1054	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1721	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1055		1722
1056	if ($len > 0) {	1723	if ($len > 0) {
1057	$self->{_activity} = AnyEvent->now;	1724	$self->{_activity} = $self->{_ractivity} = AE::now;
1058		1725
1059	$self->{filter_r}	1726	if ($self->{tls}) {
1060	? $self->{filter_r}->($self, $rbuf)	1727	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
		1728
		1729	&_dotls ($self);
		1730	} else {
1061	: $self->_drain_rbuf;	1731	$self->_drain_rbuf;
		1732	}
1062		1733
1063	} elsif (defined $len) {	1734	} elsif (defined $len) {
1064	delete $self->{_rw};	1735	delete $self->{_rw};
1065	delete $self->{_ww};
1066	delete $self->{_tw};
1067	$self->{_eof} = 1;	1736	$self->{_eof} = 1;
1068	$self->_drain_rbuf;	1737	$self->_drain_rbuf;
1069		1738
1070	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1739	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1071	return $self->error;	1740	return $self->_error ($!, 1);
1072	}	1741	}
1073	});	1742	};
1074	}	1743	}
1075	}	1744	}
1076		1745
		1746	our $ERROR_SYSCALL;
		1747	our $ERROR_WANT_READ;
		1748
		1749	sub _tls_error {
		1750	my ($self, $err) = @_;
		1751
		1752	return $self->_error ($!, 1)
		1753	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1754
		1755	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1756
		1757	# reduce error string to look less scary
		1758	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1759
		1760	if ($self->{_on_starttls}) {
		1761	(delete $self->{_on_starttls})->($self, undef, $err);
		1762	&_freetls;
		1763	} else {
		1764	&_freetls;
		1765	$self->_error (Errno::EPROTO, 1, $err);
		1766	}
		1767	}
		1768
		1769	# poll the write BIO and send the data if applicable
		1770	# also decode read data if possible
		1771	# this is basiclaly our TLS state machine
		1772	# more efficient implementations are possible with openssl,
		1773	# but not with the buggy and incomplete Net::SSLeay.
1077	sub _dotls {	1774	sub _dotls {
1078	my ($self) = @_;	1775	my ($self) = @_;
1079		1776
		1777	my $tmp;
		1778
1080	if (length $self->{_tls_wbuf}) {	1779	if (length $self->{_tls_wbuf}) {
1081	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1780	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1082	substr $self->{_tls_wbuf}, 0, $len, "";	1781	substr $self->{_tls_wbuf}, 0, $tmp, "";
1083	}	1782	}
1084	}
1085		1783
		1784	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1785	return $self->_tls_error ($tmp)
		1786	if $tmp != $ERROR_WANT_READ
		1787	&& ($tmp != $ERROR_SYSCALL || $!);
		1788	}
		1789
		1790	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1791	unless (length $tmp) {
		1792	$self->{_on_starttls}
		1793	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1794	&_freetls;
		1795
		1796	if ($self->{on_stoptls}) {
		1797	$self->{on_stoptls}($self);
		1798	return;
		1799	} else {
		1800	# let's treat SSL-eof as we treat normal EOF
		1801	delete $self->{_rw};
		1802	$self->{_eof} = 1;
		1803	}
		1804	}
		1805
		1806	$self->{_tls_rbuf} .= $tmp;
		1807	$self->_drain_rbuf;
		1808	$self->{tls} or return; # tls session might have gone away in callback
		1809	}
		1810
		1811	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1812	return $self->_tls_error ($tmp)
		1813	if $tmp != $ERROR_WANT_READ
		1814	&& ($tmp != $ERROR_SYSCALL || $!);
		1815
1086	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1816	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1087	$self->{wbuf} .= $buf;	1817	$self->{wbuf} .= $tmp;
1088	$self->_drain_wbuf;	1818	$self->_drain_wbuf;
1089	}	1819	}
1090		1820
1091	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1821	$self->{_on_starttls}
1092	$self->{rbuf} .= $buf;	1822	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1093	$self->_drain_rbuf;	1823	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1094	}
1095
1096	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1097
1098	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1099	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1100	$self->error;
1101	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1102	$! = &Errno::EIO;
1103	$self->error;
1104	}
1105
1106	# all others are fine for our purposes
1107	}
1108	}	1824	}
1109		1825
1110	=item $handle->starttls ($tls[, $tls_ctx])	1826	=item $handle->starttls ($tls[, $tls_ctx])
1111		1827
1112	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1828	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1113	object is created, you can also do that at a later time by calling	1829	object is created, you can also do that at a later time by calling
1114	C<starttls>.	1830	C<starttls>.
1115		1831
		1832	Starting TLS is currently an asynchronous operation - when you push some
		1833	write data and then call C<< ->starttls >> then TLS negotiation will start
		1834	immediately, after which the queued write data is then sent.
		1835
1116	The first argument is the same as the C<tls> constructor argument (either	1836	The first argument is the same as the C<tls> constructor argument (either
1117	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1837	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1118		1838
1119	The second argument is the optional C<Net::SSLeay::CTX> object that is	1839	The second argument is the optional C<AnyEvent::TLS> object that is used
1120	used when AnyEvent::Handle has to create its own TLS connection object.	1840	when AnyEvent::Handle has to create its own TLS connection object, or
		1841	a hash reference with C<< key => value >> pairs that will be used to
		1842	construct a new context.
1121		1843
1122	The TLS connection object will end up in C<< $handle->{tls} >> after this	1844	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1123	call and can be used or changed to your liking. Note that the handshake	1845	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1124	might have already started when this function returns.	1846	changed to your liking. Note that the handshake might have already started
		1847	when this function returns.
1125		1848
1126	=cut	1849	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		1850	handshakes on the same stream. Best do not attempt to use the stream after
		1851	stopping TLS.
1127		1852
1128	# TODO: maybe document...	1853	=cut
		1854
		1855	our %TLS_CACHE; #TODO not yet documented, should we?
		1856
1129	sub starttls {	1857	sub starttls {
1130	my ($self, $ssl, $ctx) = @_;	1858	my ($self, $tls, $ctx) = @_;
1131		1859
1132	$self->stoptls;	1860	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1861	if $self->{tls};
1133		1862
1134	if ($ssl eq "accept") {	1863	$self->{tls} = $tls;
1135	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1864	$self->{tls_ctx} = $ctx if @_ > 2;
1136	Net::SSLeay::set_accept_state ($ssl);	1865
1137	} elsif ($ssl eq "connect") {	1866	return unless $self->{fh};
1138	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1867
1139	Net::SSLeay::set_connect_state ($ssl);	1868	require Net::SSLeay;
		1869
		1870	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1871	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1872
		1873	$tls = delete $self->{tls};
		1874	$ctx = $self->{tls_ctx};
		1875
		1876	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1877
		1878	if ("HASH" eq ref $ctx) {
		1879	require AnyEvent::TLS;
		1880
		1881	if ($ctx->{cache}) {
		1882	my $key = $ctx+0;
		1883	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1884	} else {
		1885	$ctx = new AnyEvent::TLS %$ctx;
		1886	}
		1887	}
1140	}	1888
1141		1889	$self->{tls_ctx} = $ctx || TLS_CTX ();
1142	$self->{tls} = $ssl;	1890	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1143		1891
1144	# basically, this is deep magic (because SSL_read should have the same issues)	1892	# basically, this is deep magic (because SSL_read should have the same issues)
1145	# but the openssl maintainers basically said: "trust us, it just works".	1893	# but the openssl maintainers basically said: "trust us, it just works".
1146	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1894	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1147	# and mismaintained ssleay-module doesn't even offer them).	1895	# and mismaintained ssleay-module doesn't even offer them).
1148	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1896	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1897	#
		1898	# in short: this is a mess.
		1899	#
		1900	# note that we do not try to keep the length constant between writes as we are required to do.
		1901	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1902	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1903	# have identity issues in that area.
1149	Net::SSLeay::CTX_set_mode ($self->{tls},	1904	# Net::SSLeay::CTX_set_mode ($ssl,
1150	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1905	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1151	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1906	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1907	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1152		1908
1153	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1909	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1154	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1910	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1155		1911
		1912	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1913
1156	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1914	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1157		1915
1158	$self->{filter_w} = sub {	1916	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1159	$_[0]{_tls_wbuf} .= ${$_[1]};	1917	if $self->{on_starttls};
1160	&_dotls;	1918
1161	};	1919	&_dotls; # need to trigger the initial handshake
1162	$self->{filter_r} = sub {	1920	$self->start_read; # make sure we actually do read
1163	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1164	&_dotls;
1165	};
1166	}	1921	}
1167		1922
1168	=item $handle->stoptls	1923	=item $handle->stoptls
1169		1924
1170	Destroys the SSL connection, if any. Partial read or write data will be	1925	Shuts down the SSL connection - this makes a proper EOF handshake by
1171	lost.	1926	sending a close notify to the other side, but since OpenSSL doesn't
		1927	support non-blocking shut downs, it is not guarenteed that you can re-use
		1928	the stream afterwards.
1172		1929
1173	=cut	1930	=cut
1174		1931
1175	sub stoptls {	1932	sub stoptls {
1176	my ($self) = @_;	1933	my ($self) = @_;
1177		1934
1178	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1935	if ($self->{tls}) {
		1936	Net::SSLeay::shutdown ($self->{tls});
1179		1937
1180	delete $self->{_rbio};	1938	&_dotls;
1181	delete $self->{_wbio};	1939
1182	delete $self->{_tls_wbuf};	1940	# # we don't give a shit. no, we do, but we can't. no...#d#
1183	delete $self->{filter_r};	1941	# # we, we... have to use openssl :/#d#
1184	delete $self->{filter_w};	1942	# &_freetls;#d#
		1943	}
		1944	}
		1945
		1946	sub _freetls {
		1947	my ($self) = @_;
		1948
		1949	return unless $self->{tls};
		1950
		1951	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1952	if $self->{tls} > 0;
		1953
		1954	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1185	}	1955	}
1186		1956
1187	sub DESTROY {	1957	sub DESTROY {
1188	my $self = shift;	1958	my ($self) = @_;
1189		1959
1190	$self->stoptls;	1960	&_freetls;
		1961
		1962	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1963
		1964	if ($linger && length $self->{wbuf} && $self->{fh}) {
		1965	my $fh = delete $self->{fh};
		1966	my $wbuf = delete $self->{wbuf};
		1967
		1968	my @linger;
		1969
		1970	push @linger, AE::io $fh, 1, sub {
		1971	my $len = syswrite $fh, $wbuf, length $wbuf;
		1972
		1973	if ($len > 0) {
		1974	substr $wbuf, 0, $len, "";
		1975	} else {
		1976	@linger = (); # end
		1977	}
		1978	};
		1979	push @linger, AE::timer $linger, 0, sub {
		1980	@linger = ();
		1981	};
		1982	}
		1983	}
		1984
		1985	=item $handle->destroy
		1986
		1987	Shuts down the handle object as much as possible - this call ensures that
		1988	no further callbacks will be invoked and as many resources as possible
		1989	will be freed. Any method you will call on the handle object after
		1990	destroying it in this way will be silently ignored (and it will return the
		1991	empty list).
		1992
		1993	Normally, you can just "forget" any references to an AnyEvent::Handle
		1994	object and it will simply shut down. This works in fatal error and EOF
		1995	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1996	callback, so when you want to destroy the AnyEvent::Handle object from
		1997	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1998	that case.
		1999
		2000	Destroying the handle object in this way has the advantage that callbacks
		2001	will be removed as well, so if those are the only reference holders (as
		2002	is common), then one doesn't need to do anything special to break any
		2003	reference cycles.
		2004
		2005	The handle might still linger in the background and write out remaining
		2006	data, as specified by the C<linger> option, however.
		2007
		2008	=cut
		2009
		2010	sub destroy {
		2011	my ($self) = @_;
		2012
		2013	$self->DESTROY;
		2014	%$self = ();
		2015	bless $self, "AnyEvent::Handle::destroyed";
		2016	}
		2017
		2018	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2019	#nop
1191	}	2020	}
1192		2021
1193	=item AnyEvent::Handle::TLS_CTX	2022	=item AnyEvent::Handle::TLS_CTX
1194		2023
1195	This function creates and returns the Net::SSLeay::CTX object used by	2024	This function creates and returns the AnyEvent::TLS object used by default
1196	default for TLS mode.	2025	for TLS mode.
1197		2026
1198	The context is created like this:	2027	The context is created by calling L<AnyEvent::TLS> without any arguments.
1199
1200	Net::SSLeay::load_error_strings;
1201	Net::SSLeay::SSLeay_add_ssl_algorithms;
1202	Net::SSLeay::randomize;
1203
1204	my $CTX = Net::SSLeay::CTX_new;
1205
1206	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1207		2028
1208	=cut	2029	=cut
1209		2030
1210	our $TLS_CTX;	2031	our $TLS_CTX;
1211		2032
1212	sub TLS_CTX() {	2033	sub TLS_CTX() {
1213	$TLS_CTX || do {	2034	$TLS_CTX ||= do {
1214	require Net::SSLeay;	2035	require AnyEvent::TLS;
1215		2036
1216	Net::SSLeay::load_error_strings ();	2037	new AnyEvent::TLS
1217	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1218	Net::SSLeay::randomize ();
1219
1220	$TLS_CTX = Net::SSLeay::CTX_new ();
1221
1222	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1223
1224	$TLS_CTX
1225	}	2038	}
1226	}	2039	}
1227		2040
1228	=back	2041	=back
		2042
		2043
		2044	=head1 NONFREQUENTLY ASKED QUESTIONS
		2045
		2046	=over 4
		2047
		2048	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		2049	still get further invocations!
		2050
		2051	That's because AnyEvent::Handle keeps a reference to itself when handling
		2052	read or write callbacks.
		2053
		2054	It is only safe to "forget" the reference inside EOF or error callbacks,
		2055	from within all other callbacks, you need to explicitly call the C<<
		2056	->destroy >> method.
		2057
		2058	=item I get different callback invocations in TLS mode/Why can't I pause
		2059	reading?
		2060
		2061	Unlike, say, TCP, TLS connections do not consist of two independent
		2062	communication channels, one for each direction. Or put differently. The
		2063	read and write directions are not independent of each other: you cannot
		2064	write data unless you are also prepared to read, and vice versa.
		2065
		2066	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		2067	callback invocations when you are not expecting any read data - the reason
		2068	is that AnyEvent::Handle always reads in TLS mode.
		2069
		2070	During the connection, you have to make sure that you always have a
		2071	non-empty read-queue, or an C<on_read> watcher. At the end of the
		2072	connection (or when you no longer want to use it) you can call the
		2073	C<destroy> method.
		2074
		2075	=item How do I read data until the other side closes the connection?
		2076
		2077	If you just want to read your data into a perl scalar, the easiest way
		2078	to achieve this is by setting an C<on_read> callback that does nothing,
		2079	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		2080	will be in C<$_[0]{rbuf}>:
		2081
		2082	$handle->on_read (sub { });
		2083	$handle->on_eof (undef);
		2084	$handle->on_error (sub {
		2085	my $data = delete $_[0]{rbuf};
		2086	});
		2087
		2088	The reason to use C<on_error> is that TCP connections, due to latencies
		2089	and packets loss, might get closed quite violently with an error, when in
		2090	fact, all data has been received.
		2091
		2092	It is usually better to use acknowledgements when transferring data,
		2093	to make sure the other side hasn't just died and you got the data
		2094	intact. This is also one reason why so many internet protocols have an
		2095	explicit QUIT command.
		2096
		2097	=item I don't want to destroy the handle too early - how do I wait until
		2098	all data has been written?
		2099
		2100	After writing your last bits of data, set the C<on_drain> callback
		2101	and destroy the handle in there - with the default setting of
		2102	C<low_water_mark> this will be called precisely when all data has been
		2103	written to the socket:
		2104
		2105	$handle->push_write (...);
		2106	$handle->on_drain (sub {
		2107	warn "all data submitted to the kernel\n";
		2108	undef $handle;
		2109	});
		2110
		2111	If you just want to queue some data and then signal EOF to the other side,
		2112	consider using C<< ->push_shutdown >> instead.
		2113
		2114	=item I want to contact a TLS/SSL server, I don't care about security.
		2115
		2116	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2117	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		2118	parameter:
		2119
		2120	tcp_connect $host, $port, sub {
		2121	my ($fh) = @_;
		2122
		2123	my $handle = new AnyEvent::Handle
		2124	fh => $fh,
		2125	tls => "connect",
		2126	on_error => sub { ... };
		2127
		2128	$handle->push_write (...);
		2129	};
		2130
		2131	=item I want to contact a TLS/SSL server, I do care about security.
		2132
		2133	Then you should additionally enable certificate verification, including
		2134	peername verification, if the protocol you use supports it (see
		2135	L<AnyEvent::TLS>, C<verify_peername>).
		2136
		2137	E.g. for HTTPS:
		2138
		2139	tcp_connect $host, $port, sub {
		2140	my ($fh) = @_;
		2141
		2142	my $handle = new AnyEvent::Handle
		2143	fh => $fh,
		2144	peername => $host,
		2145	tls => "connect",
		2146	tls_ctx => { verify => 1, verify_peername => "https" },
		2147	...
		2148
		2149	Note that you must specify the hostname you connected to (or whatever
		2150	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2151	peername verification will be done.
		2152
		2153	The above will use the system-dependent default set of trusted CA
		2154	certificates. If you want to check against a specific CA, add the
		2155	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2156
		2157	tls_ctx => {
		2158	verify => 1,
		2159	verify_peername => "https",
		2160	ca_file => "my-ca-cert.pem",
		2161	},
		2162
		2163	=item I want to create a TLS/SSL server, how do I do that?
		2164
		2165	Well, you first need to get a server certificate and key. You have
		2166	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2167	self-signed certificate (cheap. check the search engine of your choice,
		2168	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2169	nice program for that purpose).
		2170
		2171	Then create a file with your private key (in PEM format, see
		2172	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2173	file should then look like this:
		2174
		2175	-----BEGIN RSA PRIVATE KEY-----
		2176	...header data
		2177	... lots of base64'y-stuff
		2178	-----END RSA PRIVATE KEY-----
		2179
		2180	-----BEGIN CERTIFICATE-----
		2181	... lots of base64'y-stuff
		2182	-----END CERTIFICATE-----
		2183
		2184	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2185	specify this file as C<cert_file>:
		2186
		2187	tcp_server undef, $port, sub {
		2188	my ($fh) = @_;
		2189
		2190	my $handle = new AnyEvent::Handle
		2191	fh => $fh,
		2192	tls => "accept",
		2193	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2194	...
		2195
		2196	When you have intermediate CA certificates that your clients might not
		2197	know about, just append them to the C<cert_file>.
		2198
		2199	=back
		2200
1229		2201
1230	=head1 SUBCLASSING AnyEvent::Handle	2202	=head1 SUBCLASSING AnyEvent::Handle
1231		2203
1232	In many cases, you might want to subclass AnyEvent::Handle.	2204	In many cases, you might want to subclass AnyEvent::Handle.
1233		2205
…		…
1237	=over 4	2209	=over 4
1238		2210
1239	=item * all constructor arguments become object members.	2211	=item * all constructor arguments become object members.
1240		2212
1241	At least initially, when you pass a C<tls>-argument to the constructor it	2213	At least initially, when you pass a C<tls>-argument to the constructor it
1242	will end up in C<< $handle->{tls} >>. Those members might be changes or	2214	will end up in C<< $handle->{tls} >>. Those members might be changed or
1243	mutated later on (for example C<tls> will hold the TLS connection object).	2215	mutated later on (for example C<tls> will hold the TLS connection object).
1244		2216
1245	=item * other object member names are prefixed with an C<_>.	2217	=item * other object member names are prefixed with an C<_>.
1246		2218
1247	All object members not explicitly documented (internal use) are prefixed	2219	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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