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.91 by root, Wed Oct 1 07:40:39 2008 UTC vs.
Revision 1.203 by root, Sat Oct 16 03:22:10 2010 UTC

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

Diff Legend

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