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.74 by root, Fri Jul 18 01:29:58 2008 UTC vs.
Revision 1.241 by root, Fri Sep 5 22:17:26 2014 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict;
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.22;
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	AE::log error => $msg;
		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	say "got line <$line>";
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
		38	The L<AnyEvent::Intro> tutorial contains some well-documented
		39	AnyEvent::Handle examples.
		40
54	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
55	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
56	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.
57		47
58	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
59	argument.	49	argument.
60		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
		80	sub MAX_READ_SIZE() { 131072 }
		81
61	=head1 METHODS	82	=head1 METHODS
62		83
63	=over 4	84	=over 4
64		85
65	=item B<new (%args)>	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
66		87
67	The constructor supports these arguments (all as key => value pairs).	88	The constructor supports these arguments (all as C<< key => value >> pairs).
68		89
69	=over 4	90	=over 4
70		91
71	=item fh => $filehandle [MANDATORY]	92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
72		93
73	The filehandle this L<AnyEvent::Handle> object will operate on.	94	The filehandle this L<AnyEvent::Handle> object will operate on.
74
75	NOTE: The filehandle will be set to non-blocking (using	95	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	96	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		97	that mode.
77		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
78	=item on_eof => $cb->($handle)	116	=item on_prepare => $cb->($handle)
79		117
80	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
81	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 (you can access that
82	connection cleanly.	120	file handle via C<< $handle->{fh} >>). It could be used to prepare the
		121	file handle with parameters required for the actual connect (as opposed to
		122	settings that can be changed when the connection is already established).
83		123
84	While not mandatory, it is highly recommended to set an eof callback,	124	The return value of this callback should be the connect timeout value in
85	otherwise you might end up with a closed socket while you are still	125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
86	waiting for data.	126	default timeout is to be used).
87		127
		128	=item on_connect => $cb->($handle, $host, $port, $retry->())
		129
		130	This callback is called when a connection has been successfully established.
		131
		132	The peer's numeric host and port (the socket peername) are passed as
		133	parameters, together with a retry callback. At the time it is called the
		134	read and write queues, EOF status, TLS status and similar properties of
		135	the handle will have been reset.
		136
		137	It is not allowed to use the read or write queues while the handle object
		138	is connecting.
		139
		140	If, for some reason, the handle is not acceptable, calling C<$retry> will
		141	continue with the next connection target (in case of multi-homed hosts or
		142	SRV records there can be multiple connection endpoints). The C<$retry>
		143	callback can be invoked after the connect callback returns, i.e. one can
		144	start a handshake and then decide to retry with the next host if the
		145	handshake fails.
		146
		147	In most cases, you should ignore the C<$retry> parameter.
		148
		149	=item on_connect_error => $cb->($handle, $message)
		150
		151	This callback is called when the connection could not be
		152	established. C<$!> will contain the relevant error code, and C<$message> a
		153	message describing it (usually the same as C<"$!">).
		154
		155	If this callback isn't specified, then C<on_error> will be called with a
		156	fatal error instead.
		157
		158	=back
		159
88	=item on_error => $cb->($handle, $fatal)	160	=item on_error => $cb->($handle, $fatal, $message)
89		161
90	This is the error callback, which is called when, well, some error	162	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	163	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	164	connect, or a read error.
93		165
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	166	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	167	fatal errors the handle object will be destroyed (by a call to C<< ->
		168	destroy >>) after invoking the error callback (which means you are free to
		169	examine the handle object). Examples of fatal errors are an EOF condition
		170	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
		171	cases where the other side can close the connection at will, it is
		172	often easiest to not report C<EPIPE> errors in this callback.
		173
		174	AnyEvent::Handle tries to find an appropriate error code for you to check
		175	against, but in some cases (TLS errors), this does not work well.
		176
		177	If you report the error to the user, it is recommended to always output
		178	the C<$message> argument in human-readable error messages (you don't need
		179	to report C<"$!"> if you report C<$message>).
		180
		181	If you want to react programmatically to the error, then looking at C<$!>
		182	and comparing it against some of the documented C<Errno> values is usually
		183	better than looking at the C<$message>.
		184
96	usable. Non-fatal errors can be retried by simply returning, but it is	185	Non-fatal errors can be retried by returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	186	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	187	when this callback is invoked. Examples of non-fatal errors are timeouts
		188	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		189
100	On callback entrance, the value of C<$!> contains the operating system	190	On entry to the callback, the value of C<$!> contains the operating
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	191	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		192	C<EPROTO>).
102		193
103	While not mandatory, it is I<highly> recommended to set this callback, as	194	While not mandatory, it is I<highly> recommended to set this callback, as
104	you will not be notified of errors otherwise. The default simply calls	195	you will not be notified of errors otherwise. The default just calls
105	C<croak>.	196	C<croak>.
106		197
107	=item on_read => $cb->($handle)	198	=item on_read => $cb->($handle)
108		199
109	This sets the default read callback, which is called when data arrives	200	This sets the default read callback, which is called when data arrives
110	and no read request is in the queue (unlike read queue callbacks, this	201	and no read request is in the queue (unlike read queue callbacks, this
111	callback will only be called when at least one octet of data is in the	202	callback will only be called when at least one octet of data is in the
112	read buffer).	203	read buffer).
113		204
114	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	205	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
115	method or access the C<$handle->{rbuf}> member directly.	206	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		207	must not enlarge or modify the read buffer, you can only remove data at
		208	the beginning from it.
116		209
		210	You can also call C<< ->push_read (...) >> or any other function that
		211	modifies the read queue. Or do both. Or ...
		212
117	When an EOF condition is detected then AnyEvent::Handle will first try to	213	When an EOF condition is detected, AnyEvent::Handle will first try to
118	feed all the remaining data to the queued callbacks and C<on_read> before	214	feed all the remaining data to the queued callbacks and C<on_read> before
119	calling the C<on_eof> callback. If no progress can be made, then a fatal	215	calling the C<on_eof> callback. If no progress can be made, then a fatal
120	error will be raised (with C<$!> set to C<EPIPE>).	216	error will be raised (with C<$!> set to C<EPIPE>).
121		217
		218	Note that, unlike requests in the read queue, an C<on_read> callback
		219	doesn't mean you I<require> some data: if there is an EOF and there
		220	are outstanding read requests then an error will be flagged. With an
		221	C<on_read> callback, the C<on_eof> callback will be invoked.
		222
		223	=item on_eof => $cb->($handle)
		224
		225	Set the callback to be called when an end-of-file condition is detected,
		226	i.e. in the case of a socket, when the other side has closed the
		227	connection cleanly, and there are no outstanding read requests in the
		228	queue (if there are read requests, then an EOF counts as an unexpected
		229	connection close and will be flagged as an error).
		230
		231	For sockets, this just means that the other side has stopped sending data,
		232	you can still try to write data, and, in fact, one can return from the EOF
		233	callback and continue writing data, as only the read part has been shut
		234	down.
		235
		236	If an EOF condition has been detected but no C<on_eof> callback has been
		237	set, then a fatal error will be raised with C<$!> set to <0>.
		238
122	=item on_drain => $cb->($handle)	239	=item on_drain => $cb->($handle)
123		240
124	This sets the callback that is called when the write buffer becomes empty	241	This sets the callback that is called once when the write buffer becomes
125	(or when the callback is set and the buffer is empty already).	242	empty (and immediately when the handle object is created).
126		243
127	To append to the write buffer, use the C<< ->push_write >> method.	244	To append to the write buffer, use the C<< ->push_write >> method.
128		245
129	This callback is useful when you don't want to put all of your write data	246	This callback is useful when you don't want to put all of your write data
130	into the queue at once, for example, when you want to write the contents	247	into the queue at once, for example, when you want to write the contents
…		…
132	memory and push it into the queue, but instead only read more data from	249	memory and push it into the queue, but instead only read more data from
133	the file when the write queue becomes empty.	250	the file when the write queue becomes empty.
134		251
135	=item timeout => $fractional_seconds	252	=item timeout => $fractional_seconds
136		253
		254	=item rtimeout => $fractional_seconds
		255
		256	=item wtimeout => $fractional_seconds
		257
137	If non-zero, then this enables an "inactivity" timeout: whenever this many	258	If non-zero, then these enables an "inactivity" timeout: whenever this
138	seconds pass without a successful read or write on the underlying file	259	many seconds pass without a successful read or write on the underlying
139	handle, the C<on_timeout> callback will be invoked (and if that one is	260	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
140	missing, an C<ETIMEDOUT> error will be raised).	261	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		262	error will be raised).
141		263
		264	There are three variants of the timeouts that work independently of each
		265	other, for both read and write (triggered when nothing was read I<OR>
		266	written), just read (triggered when nothing was read), and just write:
		267	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		268	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		269	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
		270
142	Note that timeout processing is also active when you currently do not have	271	Note that timeout processing is active even when you do not have any
143	any outstanding read or write requests: If you plan to keep the connection	272	outstanding read or write requests: If you plan to keep the connection
144	idle then you should disable the timout temporarily or ignore the timeout	273	idle then you should disable the timeout temporarily or ignore the
145	in the C<on_timeout> callback.	274	timeout in the corresponding C<on_timeout> callback, in which case
		275	AnyEvent::Handle will simply restart the timeout.
146		276
147	Zero (the default) disables this timeout.	277	Zero (the default) disables the corresponding timeout.
148		278
149	=item on_timeout => $cb->($handle)	279	=item on_timeout => $cb->($handle)
		280
		281	=item on_rtimeout => $cb->($handle)
		282
		283	=item on_wtimeout => $cb->($handle)
150		284
151	Called whenever the inactivity timeout passes. If you return from this	285	Called whenever the inactivity timeout passes. If you return from this
152	callback, then the timeout will be reset as if some activity had happened,	286	callback, then the timeout will be reset as if some activity had happened,
153	so this condition is not fatal in any way.	287	so this condition is not fatal in any way.
154		288
155	=item rbuf_max => <bytes>	289	=item rbuf_max => <bytes>
156		290
157	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	291	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
158	when the read buffer ever (strictly) exceeds this size. This is useful to	292	when the read buffer ever (strictly) exceeds this size. This is useful to
159	avoid denial-of-service attacks.	293	avoid some forms of denial-of-service attacks.
160		294
161	For example, a server accepting connections from untrusted sources should	295	For example, a server accepting connections from untrusted sources should
162	be configured to accept only so-and-so much data that it cannot act on	296	be configured to accept only so-and-so much data that it cannot act on
163	(for example, when expecting a line, an attacker could send an unlimited	297	(for example, when expecting a line, an attacker could send an unlimited
164	amount of data without a callback ever being called as long as the line	298	amount of data without a callback ever being called as long as the line
165	isn't finished).	299	isn't finished).
166		300
		301	=item wbuf_max => <bytes>
		302
		303	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
		304	when the write buffer ever (strictly) exceeds this size. This is useful to
		305	avoid some forms of denial-of-service attacks.
		306
		307	Although the units of this parameter is bytes, this is the I<raw> number
		308	of bytes not yet accepted by the kernel. This can make a difference when
		309	you e.g. use TLS, as TLS typically makes your write data larger (but it
		310	can also make it smaller due to compression).
		311
		312	As an example of when this limit is useful, take a chat server that sends
		313	chat messages to a client. If the client does not read those in a timely
		314	manner then the send buffer in the server would grow unbounded.
		315
167	=item autocork => <boolean>	316	=item autocork => <boolean>
168		317
169	When disabled (the default), then C<push_write> will try to immediately	318	When disabled (the default), C<push_write> will try to immediately
170	write the data to the handle if possible. This avoids having to register	319	write the data to the handle if possible. This avoids having to register
171	a write watcher and wait for the next event loop iteration, but can be	320	a write watcher and wait for the next event loop iteration, but can
172	inefficient if you write multiple small chunks (this disadvantage is	321	be inefficient if you write multiple small chunks (on the wire, this
173	usually avoided by your kernel's nagle algorithm, see C<low_delay>).	322	disadvantage is usually avoided by your kernel's nagle algorithm, see
		323	C<no_delay>, but this option can save costly syscalls).
174		324
175	When enabled, then writes will always be queued till the next event loop	325	When enabled, writes will always be queued till the next event loop
176	iteration. This is efficient when you do many small writes per iteration,	326	iteration. This is efficient when you do many small writes per iteration,
177	but less efficient when you do a single write only.	327	but less efficient when you do a single write only per iteration (or when
		328	the write buffer often is full). It also increases write latency.
178		329
179	=item no_delay => <boolean>	330	=item no_delay => <boolean>
180		331
181	When doing small writes on sockets, your operating system kernel might	332	When doing small writes on sockets, your operating system kernel might
182	wait a bit for more data before actually sending it out. This is called	333	wait a bit for more data before actually sending it out. This is called
183	the Nagle algorithm, and usually it is beneficial.	334	the Nagle algorithm, and usually it is beneficial.
184		335
185	In some situations you want as low a delay as possible, which cna be	336	In some situations you want as low a delay as possible, which can be
186	accomplishd by setting this option to true.	337	accomplishd by setting this option to a true value.
187		338
188	The default is your opertaing system's default behaviour, this option	339	The default is your operating system's default behaviour (most likely
189	explicitly enables or disables it, if possible.	340	enabled). This option explicitly enables or disables it, if possible.
		341
		342	=item keepalive => <boolean>
		343
		344	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		345	normally, TCP connections have no time-out once established, so TCP
		346	connections, once established, can stay alive forever even when the other
		347	side has long gone. TCP keepalives are a cheap way to take down long-lived
		348	TCP connections when the other side becomes unreachable. While the default
		349	is OS-dependent, TCP keepalives usually kick in after around two hours,
		350	and, if the other side doesn't reply, take down the TCP connection some 10
		351	to 15 minutes later.
		352
		353	It is harmless to specify this option for file handles that do not support
		354	keepalives, and enabling it on connections that are potentially long-lived
		355	is usually a good idea.
		356
		357	=item oobinline => <boolean>
		358
		359	BSD majorly fucked up the implementation of TCP urgent data. The result
		360	is that almost no OS implements TCP according to the specs, and every OS
		361	implements it slightly differently.
		362
		363	If you want to handle TCP urgent data, then setting this flag (the default
		364	is enabled) gives you the most portable way of getting urgent data, by
		365	putting it into the stream.
		366
		367	Since BSD emulation of OOB data on top of TCP's urgent data can have
		368	security implications, AnyEvent::Handle sets this flag automatically
		369	unless explicitly specified. Note that setting this flag after
		370	establishing a connection I<may> be a bit too late (data loss could
		371	already have occured on BSD systems), but at least it will protect you
		372	from most attacks.
190		373
191	=item read_size => <bytes>	374	=item read_size => <bytes>
192		375
193	The default read block size (the amount of bytes this module will try to read	376	The initial read block size, the number of bytes this module will try
194	during each (loop iteration). Default: C<8192>.	377	to read during each loop iteration. Each handle object will consume
		378	at least this amount of memory for the read buffer as well, so when
		379	handling many connections watch out for memory requirements). See also
		380	C<max_read_size>. Default: C<2048>.
		381
		382	=item max_read_size => <bytes>
		383
		384	The maximum read buffer size used by the dynamic adjustment
		385	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
		386	one go it will double C<read_size> up to the maximum given by this
		387	option. Default: C<131072> or C<read_size>, whichever is higher.
195		388
196	=item low_water_mark => <bytes>	389	=item low_water_mark => <bytes>
197		390
198	Sets the amount of bytes (default: C<0>) that make up an "empty" write	391	Sets the number of bytes (default: C<0>) that make up an "empty" write
199	buffer: If the write reaches this size or gets even samller it is	392	buffer: If the buffer reaches this size or gets even samller it is
200	considered empty.	393	considered empty.
201		394
		395	Sometimes it can be beneficial (for performance reasons) to add data to
		396	the write buffer before it is fully drained, but this is a rare case, as
		397	the operating system kernel usually buffers data as well, so the default
		398	is good in almost all cases.
		399
202	=item linger => <seconds>	400	=item linger => <seconds>
203		401
204	If non-zero (default: C<3600>), then the destructor of the	402	If this is non-zero (default: C<3600>), the destructor of the
205	AnyEvent::Handle object will check wether there is still outstanding write	403	AnyEvent::Handle object will check whether there is still outstanding
206	data and will install a watcher that will write out this data. No errors	404	write data and will install a watcher that will write this data to the
207	will be reported (this mostly matches how the operating system treats	405	socket. No errors will be reported (this mostly matches how the operating
208	outstanding data at socket close time).	406	system treats outstanding data at socket close time).
209		407
210	This will not work for partial TLS data that could not yet been	408	This will not work for partial TLS data that could not be encoded
211	encoded. This data will be lost.	409	yet. This data will be lost. Calling the C<stoptls> method in time might
		410	help.
		411
		412	=item peername => $string
		413
		414	A string used to identify the remote site - usually the DNS hostname
		415	(I<not> IDN!) used to create the connection, rarely the IP address.
		416
		417	Apart from being useful in error messages, this string is also used in TLS
		418	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		419	verification will be skipped when C<peername> is not specified or is
		420	C<undef>.
212		421
213	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	422	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
214		423
215	When this parameter is given, it enables TLS (SSL) mode, that means it	424	When this parameter is given, it enables TLS (SSL) mode, that means
216	will start making tls handshake and will transparently encrypt/decrypt	425	AnyEvent will start a TLS handshake as soon as the connection has been
217	data.	426	established and will transparently encrypt/decrypt data afterwards.
		427
		428	All TLS protocol errors will be signalled as C<EPROTO>, with an
		429	appropriate error message.
218		430
219	TLS mode requires Net::SSLeay to be installed (it will be loaded	431	TLS mode requires Net::SSLeay to be installed (it will be loaded
220	automatically when you try to create a TLS handle).	432	automatically when you try to create a TLS handle): this module doesn't
		433	have a dependency on that module, so if your module requires it, you have
		434	to add the dependency yourself. If Net::SSLeay cannot be loaded or is too
		435	old, you get an C<EPROTO> error.
221		436
222	For the TLS server side, use C<accept>, and for the TLS client side of a	437	Unlike TCP, TLS has a server and client side: for the TLS server side, use
223	connection, use C<connect> mode.	438	C<accept>, and for the TLS client side of a connection, use C<connect>
		439	mode.
224		440
225	You can also provide your own TLS connection object, but you have	441	You can also provide your own TLS connection object, but you have
226	to make sure that you call either C<Net::SSLeay::set_connect_state>	442	to make sure that you call either C<Net::SSLeay::set_connect_state>
227	or C<Net::SSLeay::set_accept_state> on it before you pass it to	443	or C<Net::SSLeay::set_accept_state> on it before you pass it to
228	AnyEvent::Handle.	444	AnyEvent::Handle. Also, this module will take ownership of this connection
		445	object.
229		446
		447	At some future point, AnyEvent::Handle might switch to another TLS
		448	implementation, then the option to use your own session object will go
		449	away.
		450
		451	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		452	passing in the wrong integer will lead to certain crash. This most often
		453	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		454	segmentation fault.
		455
230	See the C<starttls> method if you need to start TLs negotiation later.	456	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
231		457
232	=item tls_ctx => $ssl_ctx	458	=item tls_ctx => $anyevent_tls
233		459
234	Use the given Net::SSLeay::CTX object to create the new TLS connection	460	Use the given C<AnyEvent::TLS> object to create the new TLS connection
235	(unless a connection object was specified directly). If this parameter is	461	(unless a connection object was specified directly). If this
236	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	462	parameter is missing (or C<undef>), then AnyEvent::Handle will use
		463	C<AnyEvent::Handle::TLS_CTX>.
237		464
		465	Instead of an object, you can also specify a hash reference with C<< key
		466	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		467	new TLS context object.
		468
		469	=item on_starttls => $cb->($handle, $success[, $error_message])
		470
		471	This callback will be invoked when the TLS/SSL handshake has finished. If
		472	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		473	(C<on_stoptls> will not be called in this case).
		474
		475	The session in C<< $handle->{tls} >> can still be examined in this
		476	callback, even when the handshake was not successful.
		477
		478	TLS handshake failures will not cause C<on_error> to be invoked when this
		479	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		480
		481	Without this callback, handshake failures lead to C<on_error> being
		482	called as usual.
		483
		484	Note that you cannot just call C<starttls> again in this callback. If you
		485	need to do that, start an zero-second timer instead whose callback can
		486	then call C<< ->starttls >> again.
		487
		488	=item on_stoptls => $cb->($handle)
		489
		490	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		491	set, then it will be invoked after freeing the TLS session. If it is not,
		492	then a TLS shutdown condition will be treated like a normal EOF condition
		493	on the handle.
		494
		495	The session in C<< $handle->{tls} >> can still be examined in this
		496	callback.
		497
		498	This callback will only be called on TLS shutdowns, not when the
		499	underlying handle signals EOF.
		500
238	=item json => JSON or JSON::XS object	501	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
239		502
240	This is the json coder object used by the C<json> read and write types.	503	This is the json coder object used by the C<json> read and write types.
241		504
242	If you don't supply it, then AnyEvent::Handle will create and use a	505	If you don't supply it, then AnyEvent::Handle will create and use a
243	suitable one, which will write and expect UTF-8 encoded JSON texts.	506	suitable one (on demand), which will write and expect UTF-8 encoded
		507	JSON texts (either using L<JSON::XS> or L<JSON>). The written texts are
		508	guaranteed not to contain any newline character.
244		509
		510	For security reasons, this encoder will likely I<not> handle numbers and
		511	strings, only arrays and objects/hashes. The reason is that originally
		512	JSON was self-delimited, but Dougles Crockford thought it was a splendid
		513	idea to redefine JSON incompatibly, so this is no longer true.
		514
		515	For protocols that used back-to-back JSON texts, this might lead to
		516	run-ins, where two or more JSON texts will be interpreted as one JSON
		517	text.
		518
		519	For this reason, if the default encoder uses L<JSON::XS>, it will default
		520	to not allowing anything but arrays and objects/hashes, at least for the
		521	forseeable future (it will change at some point). This might or might not
		522	be true for the L<JSON> module, so this might cause a security issue.
		523
		524	If you depend on either behaviour, you should create your own json object
		525	and pass it in explicitly.
		526
		527	=item cbor => L<CBOR::XS> object
		528
		529	This is the cbor coder object used by the C<cbor> read and write types.
		530
		531	If you don't supply it, then AnyEvent::Handle will create and use a
		532	suitable one (on demand), which will write CBOR without using extensions,
		533	if possible.
		534
245	Note that you are responsible to depend on the JSON module if you want to	535	Note that you are responsible to depend on the L<CBOR::XS> module if you
246	use this functionality, as AnyEvent does not have a dependency itself.	536	want to use this functionality, as AnyEvent does not have a dependency on
247		537	it itself.
248	=item filter_r => $cb
249
250	=item filter_w => $cb
251
252	These exist, but are undocumented at this time.
253		538
254	=back	539	=back
255		540
256	=cut	541	=cut
257		542
258	sub new {	543	sub new {
259	my $class = shift;	544	my $class = shift;
260
261	my $self = bless { @_ }, $class;	545	my $self = bless { @_ }, $class;
262		546
263	$self->{fh} or Carp::croak "mandatory argument fh is missing";	547	if ($self->{fh}) {
		548	$self->_start;
		549	return unless $self->{fh}; # could be gone by now
		550
		551	} elsif ($self->{connect}) {
		552	require AnyEvent::Socket;
		553
		554	$self->{peername} = $self->{connect}[0]
		555	unless exists $self->{peername};
		556
		557	$self->{_skip_drain_rbuf} = 1;
		558
		559	{
		560	Scalar::Util::weaken (my $self = $self);
		561
		562	$self->{_connect} =
		563	AnyEvent::Socket::tcp_connect (
		564	$self->{connect}[0],
		565	$self->{connect}[1],
		566	sub {
		567	my ($fh, $host, $port, $retry) = @_;
		568
		569	delete $self->{_connect}; # no longer needed
		570
		571	if ($fh) {
		572	$self->{fh} = $fh;
		573
		574	delete $self->{_skip_drain_rbuf};
		575	$self->_start;
		576
		577	$self->{on_connect}
		578	and $self->{on_connect}($self, $host, $port, sub {
		579	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		580	$self->{_skip_drain_rbuf} = 1;
		581	&$retry;
		582	});
		583
		584	} else {
		585	if ($self->{on_connect_error}) {
		586	$self->{on_connect_error}($self, "$!");
		587	$self->destroy if $self;
		588	} else {
		589	$self->_error ($!, 1);
		590	}
		591	}
		592	},
		593	sub {
		594	local $self->{fh} = $_[0];
		595
		596	$self->{on_prepare}
		597	? $self->{on_prepare}->($self)
		598	: ()
		599	}
		600	);
		601	}
		602
		603	} else {
		604	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		605	}
		606
		607	$self
		608	}
		609
		610	sub _start {
		611	my ($self) = @_;
		612
		613	# too many clueless people try to use udp and similar sockets
		614	# with AnyEvent::Handle, do them a favour.
		615	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		616	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		617	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
264		618
265	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	619	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
266		620
267	if ($self->{tls}) {	621	$self->{_activity} =
268	require Net::SSLeay;	622	$self->{_ractivity} =
		623	$self->{_wactivity} = AE::now;
		624
		625	$self->{read_size} ||= 2048;
		626	$self->{max_read_size} = $self->{read_size}
		627	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		628
		629	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		630	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		631	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		632
		633	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		634	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
		635
		636	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		637
269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	638	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
270	}	639	if $self->{tls};
271		640
272	$self->{_activity} = AnyEvent->now;
273	$self->_timeout;
274
275	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	641	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
276	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
277		642
278	$self->start_read	643	$self->start_read
279	if $self->{on_read};	644	if $self->{on_read} || @{ $self->{_queue} };
280		645
281	$self	646	$self->_drain_wbuf;
282	}
283
284	sub _shutdown {
285	my ($self) = @_;
286
287	delete $self->{_tw};
288	delete $self->{_rw};
289	delete $self->{_ww};
290	delete $self->{fh};
291
292	$self->stoptls;
293	}	647	}
294		648
295	sub _error {	649	sub _error {
296	my ($self, $errno, $fatal) = @_;	650	my ($self, $errno, $fatal, $message) = @_;
297
298	$self->_shutdown
299	if $fatal;
300		651
301	$! = $errno;	652	$! = $errno;
		653	$message ||= "$!";
302		654
303	if ($self->{on_error}) {	655	if ($self->{on_error}) {
304	$self->{on_error}($self, $fatal);	656	$self->{on_error}($self, $fatal, $message);
305	} else {	657	$self->destroy if $fatal;
		658	} elsif ($self->{fh} || $self->{connect}) {
		659	$self->destroy;
306	Carp::croak "AnyEvent::Handle uncaught error: $!";	660	Carp::croak "AnyEvent::Handle uncaught error: $message";
307	}	661	}
308	}	662	}
309		663
310	=item $fh = $handle->fh	664	=item $fh = $handle->fh
311		665
312	This method returns the file handle of the L<AnyEvent::Handle> object.	666	This method returns the file handle used to create the L<AnyEvent::Handle> object.
313		667
314	=cut	668	=cut
315		669
316	sub fh { $_[0]{fh} }	670	sub fh { $_[0]{fh} }
317		671
…		…
335	$_[0]{on_eof} = $_[1];	689	$_[0]{on_eof} = $_[1];
336	}	690	}
337		691
338	=item $handle->on_timeout ($cb)	692	=item $handle->on_timeout ($cb)
339		693
340	Replace the current C<on_timeout> callback, or disables the callback	694	=item $handle->on_rtimeout ($cb)
341	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
342	argument.
343		695
344	=cut	696	=item $handle->on_wtimeout ($cb)
345		697
346	sub on_timeout {	698	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
347	$_[0]{on_timeout} = $_[1];	699	callback, or disables the callback (but not the timeout) if C<$cb> =
348	}	700	C<undef>. See the C<timeout> constructor argument and method.
		701
		702	=cut
		703
		704	# see below
349		705
350	=item $handle->autocork ($boolean)	706	=item $handle->autocork ($boolean)
351		707
352	Enables or disables the current autocork behaviour (see C<autocork>	708	Enables or disables the current autocork behaviour (see C<autocork>
353	constructor argument).	709	constructor argument). Changes will only take effect on the next write.
354		710
355	=cut	711	=cut
		712
		713	sub autocork {
		714	$_[0]{autocork} = $_[1];
		715	}
356		716
357	=item $handle->no_delay ($boolean)	717	=item $handle->no_delay ($boolean)
358		718
359	Enables or disables the C<no_delay> setting (see constructor argument of	719	Enables or disables the C<no_delay> setting (see constructor argument of
360	the same name for details).	720	the same name for details).
…		…
362	=cut	722	=cut
363		723
364	sub no_delay {	724	sub no_delay {
365	$_[0]{no_delay} = $_[1];	725	$_[0]{no_delay} = $_[1];
366		726
		727	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		728	if $_[0]{fh};
		729	}
		730
		731	=item $handle->keepalive ($boolean)
		732
		733	Enables or disables the C<keepalive> setting (see constructor argument of
		734	the same name for details).
		735
		736	=cut
		737
		738	sub keepalive {
		739	$_[0]{keepalive} = $_[1];
		740
367	eval {	741	eval {
368	local $SIG{__DIE__};	742	local $SIG{__DIE__};
369	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	743	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		744	if $_[0]{fh};
370	};	745	};
371	}	746	}
372		747
		748	=item $handle->oobinline ($boolean)
		749
		750	Enables or disables the C<oobinline> setting (see constructor argument of
		751	the same name for details).
		752
		753	=cut
		754
		755	sub oobinline {
		756	$_[0]{oobinline} = $_[1];
		757
		758	eval {
		759	local $SIG{__DIE__};
		760	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		761	if $_[0]{fh};
		762	};
		763	}
		764
		765	=item $handle->keepalive ($boolean)
		766
		767	Enables or disables the C<keepalive> setting (see constructor argument of
		768	the same name for details).
		769
		770	=cut
		771
		772	sub keepalive {
		773	$_[0]{keepalive} = $_[1];
		774
		775	eval {
		776	local $SIG{__DIE__};
		777	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		778	if $_[0]{fh};
		779	};
		780	}
		781
		782	=item $handle->on_starttls ($cb)
		783
		784	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		785
		786	=cut
		787
		788	sub on_starttls {
		789	$_[0]{on_starttls} = $_[1];
		790	}
		791
		792	=item $handle->on_stoptls ($cb)
		793
		794	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		795
		796	=cut
		797
		798	sub on_stoptls {
		799	$_[0]{on_stoptls} = $_[1];
		800	}
		801
		802	=item $handle->rbuf_max ($max_octets)
		803
		804	Configures the C<rbuf_max> setting (C<undef> disables it).
		805
		806	=item $handle->wbuf_max ($max_octets)
		807
		808	Configures the C<wbuf_max> setting (C<undef> disables it).
		809
		810	=cut
		811
		812	sub rbuf_max {
		813	$_[0]{rbuf_max} = $_[1];
		814	}
		815
		816	sub wbuf_max {
		817	$_[0]{wbuf_max} = $_[1];
		818	}
		819
373	#############################################################################	820	#############################################################################
374		821
375	=item $handle->timeout ($seconds)	822	=item $handle->timeout ($seconds)
376		823
		824	=item $handle->rtimeout ($seconds)
		825
		826	=item $handle->wtimeout ($seconds)
		827
377	Configures (or disables) the inactivity timeout.	828	Configures (or disables) the inactivity timeout.
378		829
379	=cut	830	The timeout will be checked instantly, so this method might destroy the
		831	handle before it returns.
380		832
381	sub timeout {	833	=item $handle->timeout_reset
		834
		835	=item $handle->rtimeout_reset
		836
		837	=item $handle->wtimeout_reset
		838
		839	Reset the activity timeout, as if data was received or sent.
		840
		841	These methods are cheap to call.
		842
		843	=cut
		844
		845	for my $dir ("", "r", "w") {
		846	my $timeout = "${dir}timeout";
		847	my $tw = "_${dir}tw";
		848	my $on_timeout = "on_${dir}timeout";
		849	my $activity = "_${dir}activity";
		850	my $cb;
		851
		852	*$on_timeout = sub {
		853	$_[0]{$on_timeout} = $_[1];
		854	};
		855
		856	*$timeout = sub {
382	my ($self, $timeout) = @_;	857	my ($self, $new_value) = @_;
383		858
		859	$new_value >= 0
		860	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		861
384	$self->{timeout} = $timeout;	862	$self->{$timeout} = $new_value;
385	$self->_timeout;	863	delete $self->{$tw}; &$cb;
386	}	864	};
387		865
		866	*{"${dir}timeout_reset"} = sub {
		867	$_[0]{$activity} = AE::now;
		868	};
		869
		870	# main workhorse:
388	# reset the timeout watcher, as neccessary	871	# reset the timeout watcher, as neccessary
389	# also check for time-outs	872	# also check for time-outs
390	sub _timeout {	873	$cb = sub {
391	my ($self) = @_;	874	my ($self) = @_;
392		875
393	if ($self->{timeout}) {	876	if ($self->{$timeout} && $self->{fh}) {
394	my $NOW = AnyEvent->now;	877	my $NOW = AE::now;
395		878
396	# when would the timeout trigger?	879	# when would the timeout trigger?
397	my $after = $self->{_activity} + $self->{timeout} - $NOW;	880	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
398		881
399	# now or in the past already?	882	# now or in the past already?
400	if ($after <= 0) {	883	if ($after <= 0) {
401	$self->{_activity} = $NOW;	884	$self->{$activity} = $NOW;
402		885
403	if ($self->{on_timeout}) {	886	if ($self->{$on_timeout}) {
404	$self->{on_timeout}($self);	887	$self->{$on_timeout}($self);
405	} else {	888	} else {
406	$self->_error (&Errno::ETIMEDOUT);	889	$self->_error (Errno::ETIMEDOUT);
		890	}
		891
		892	# callback could have changed timeout value, optimise
		893	return unless $self->{$timeout};
		894
		895	# calculate new after
		896	$after = $self->{$timeout};
407	}	897	}
408		898
409	# callback could have changed timeout value, optimise	899	Scalar::Util::weaken $self;
410	return unless $self->{timeout};	900	return unless $self; # ->error could have destroyed $self
411		901
412	# calculate new after	902	$self->{$tw} ||= AE::timer $after, 0, sub {
413	$after = $self->{timeout};	903	delete $self->{$tw};
		904	$cb->($self);
		905	};
		906	} else {
		907	delete $self->{$tw};
414	}	908	}
415
416	Scalar::Util::weaken $self;
417	return unless $self; # ->error could have destroyed $self
418
419	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
420	delete $self->{_tw};
421	$self->_timeout;
422	});
423	} else {
424	delete $self->{_tw};
425	}	909	}
426	}	910	}
427		911
428	#############################################################################	912	#############################################################################
429		913
…		…
436		920
437	The write queue is very simple: you can add data to its end, and	921	The write queue is very simple: you can add data to its end, and
438	AnyEvent::Handle will automatically try to get rid of it for you.	922	AnyEvent::Handle will automatically try to get rid of it for you.
439		923
440	When data could be written and the write buffer is shorter then the low	924	When data could be written and the write buffer is shorter then the low
441	water mark, the C<on_drain> callback will be invoked.	925	water mark, the C<on_drain> callback will be invoked once.
442		926
443	=over 4	927	=over 4
444		928
445	=item $handle->on_drain ($cb)	929	=item $handle->on_drain ($cb)
446		930
447	Sets the C<on_drain> callback or clears it (see the description of	931	Sets the C<on_drain> callback or clears it (see the description of
448	C<on_drain> in the constructor).	932	C<on_drain> in the constructor).
449		933
		934	This method may invoke callbacks (and therefore the handle might be
		935	destroyed after it returns).
		936
450	=cut	937	=cut
451		938
452	sub on_drain {	939	sub on_drain {
453	my ($self, $cb) = @_;	940	my ($self, $cb) = @_;
454		941
455	$self->{on_drain} = $cb;	942	$self->{on_drain} = $cb;
456		943
457	$cb->($self)	944	$cb->($self)
458	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	945	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
459	}	946	}
460		947
461	=item $handle->push_write ($data)	948	=item $handle->push_write ($data)
462		949
463	Queues the given scalar to be written. You can push as much data as you	950	Queues the given scalar to be written. You can push as much data as
464	want (only limited by the available memory), as C<AnyEvent::Handle>	951	you want (only limited by the available memory and C<wbuf_max>), as
465	buffers it independently of the kernel.	952	C<AnyEvent::Handle> buffers it independently of the kernel.
		953
		954	This method may invoke callbacks (and therefore the handle might be
		955	destroyed after it returns).
466		956
467	=cut	957	=cut
468		958
469	sub _drain_wbuf {	959	sub _drain_wbuf {
470	my ($self) = @_;	960	my ($self) = @_;
…		…
474	Scalar::Util::weaken $self;	964	Scalar::Util::weaken $self;
475		965
476	my $cb = sub {	966	my $cb = sub {
477	my $len = syswrite $self->{fh}, $self->{wbuf};	967	my $len = syswrite $self->{fh}, $self->{wbuf};
478		968
479	if ($len >= 0) {	969	if (defined $len) {
480	substr $self->{wbuf}, 0, $len, "";	970	substr $self->{wbuf}, 0, $len, "";
481		971
482	$self->{_activity} = AnyEvent->now;	972	$self->{_activity} = $self->{_wactivity} = AE::now;
483		973
484	$self->{on_drain}($self)	974	$self->{on_drain}($self)
485	if $self->{low_water_mark} >= length $self->{wbuf}	975	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
486	&& $self->{on_drain};	976	&& $self->{on_drain};
487		977
488	delete $self->{_ww} unless length $self->{wbuf};	978	delete $self->{_ww} unless length $self->{wbuf};
489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	979	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
490	$self->_error ($!, 1);	980	$self->_error ($!, 1);
…		…
493		983
494	# try to write data immediately	984	# try to write data immediately
495	$cb->() unless $self->{autocork};	985	$cb->() unless $self->{autocork};
496		986
497	# if still data left in wbuf, we need to poll	987	# if still data left in wbuf, we need to poll
498	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	988	$self->{_ww} = AE::io $self->{fh}, 1, $cb
499	if length $self->{wbuf};	989	if length $self->{wbuf};
		990
		991	if (
		992	defined $self->{wbuf_max}
		993	&& $self->{wbuf_max} < length $self->{wbuf}
		994	) {
		995	$self->_error (Errno::ENOSPC, 1), return;
		996	}
500	};	997	};
501	}	998	}
502		999
503	our %WH;	1000	our %WH;
504		1001
		1002	# deprecated
505	sub register_write_type($$) {	1003	sub register_write_type($$) {
506	$WH{$_[0]} = $_[1];	1004	$WH{$_[0]} = $_[1];
507	}	1005	}
508		1006
509	sub push_write {	1007	sub push_write {
510	my $self = shift;	1008	my $self = shift;
511		1009
512	if (@_ > 1) {	1010	if (@_ > 1) {
513	my $type = shift;	1011	my $type = shift;
514		1012
		1013	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
515	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	1014	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
516	->($self, @_);	1015	->($self, @_);
517	}	1016	}
518		1017
		1018	# we downgrade here to avoid hard-to-track-down bugs,
		1019	# and diagnose the problem earlier and better.
		1020
519	if ($self->{filter_w}) {	1021	if ($self->{tls}) {
520	$self->{filter_w}($self, \$_[0]);	1022	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
		1023	&_dotls ($self) if $self->{fh};
521	} else {	1024	} else {
522	$self->{wbuf} .= $_[0];	1025	utf8::downgrade $self->{wbuf} .= $_[0];
523	$self->_drain_wbuf;	1026	$self->_drain_wbuf if $self->{fh};
524	}	1027	}
525	}	1028	}
526		1029
527	=item $handle->push_write (type => @args)	1030	=item $handle->push_write (type => @args)
528		1031
529	Instead of formatting your data yourself, you can also let this module do	1032	Instead of formatting your data yourself, you can also let this module
530	the job by specifying a type and type-specific arguments.	1033	do the job by specifying a type and type-specific arguments. You
		1034	can also specify the (fully qualified) name of a package, in which
		1035	case AnyEvent tries to load the package and then expects to find the
		1036	C<anyevent_write_type> function inside (see "custom write types", below).
531		1037
532	Predefined types are (if you have ideas for additional types, feel free to	1038	Predefined types are (if you have ideas for additional types, feel free to
533	drop by and tell us):	1039	drop by and tell us):
534		1040
535	=over 4	1041	=over 4
…		…
542	=cut	1048	=cut
543		1049
544	register_write_type netstring => sub {	1050	register_write_type netstring => sub {
545	my ($self, $string) = @_;	1051	my ($self, $string) = @_;
546		1052
547	sprintf "%d:%s,", (length $string), $string	1053	(length $string) . ":$string,"
548	};	1054	};
549		1055
550	=item packstring => $format, $data	1056	=item packstring => $format, $data
551		1057
552	An octet string prefixed with an encoded length. The encoding C<$format>	1058	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
566		1072
567	Encodes the given hash or array reference into a JSON object. Unless you	1073	Encodes the given hash or array reference into a JSON object. Unless you
568	provide your own JSON object, this means it will be encoded to JSON text	1074	provide your own JSON object, this means it will be encoded to JSON text
569	in UTF-8.	1075	in UTF-8.
570		1076
		1077	The default encoder might or might not handle every type of JSON value -
		1078	it might be limited to arrays and objects for security reasons. See the
		1079	C<json> constructor attribute for more details.
		1080
571	JSON objects (and arrays) are self-delimiting, so you can write JSON at	1081	JSON objects (and arrays) are self-delimiting, so if you only use arrays
572	one end of a handle and read them at the other end without using any	1082	and hashes, you can write JSON at one end of a handle and read them at the
573	additional framing.	1083	other end without using any additional framing.
574		1084
575	The generated JSON text is guaranteed not to contain any newlines: While	1085	The JSON text generated by the default encoder is guaranteed not to
576	this module doesn't need delimiters after or between JSON texts to be	1086	contain any newlines: While this module doesn't need delimiters after or
577	able to read them, many other languages depend on that.	1087	between JSON texts to be able to read them, many other languages depend on
		1088	them.
578		1089
579	A simple RPC protocol that interoperates easily with others is to send	1090	A simple RPC protocol that interoperates easily with other languages is
580	JSON arrays (or objects, although arrays are usually the better choice as	1091	to send JSON arrays (or objects, although arrays are usually the better
581	they mimic how function argument passing works) and a newline after each	1092	choice as they mimic how function argument passing works) and a newline
582	JSON text:	1093	after each JSON text:
583		1094
584	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1095	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
585	$handle->push_write ("\012");	1096	$handle->push_write ("\012");
586		1097
587	An AnyEvent::Handle receiver would simply use the C<json> read type and	1098	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
590	$handle->push_read (json => sub { my $array = $_[1]; ... });	1101	$handle->push_read (json => sub { my $array = $_[1]; ... });
591		1102
592	Other languages could read single lines terminated by a newline and pass	1103	Other languages could read single lines terminated by a newline and pass
593	this line into their JSON decoder of choice.	1104	this line into their JSON decoder of choice.
594		1105
		1106	=item cbor => $perl_scalar
		1107
		1108	Encodes the given scalar into a CBOR value. Unless you provide your own
		1109	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1110	using any extensions, if possible.
		1111
		1112	CBOR values are self-delimiting, so you can write CBOR at one end of
		1113	a handle and read them at the other end without using any additional
		1114	framing.
		1115
		1116	A simple nd very very fast RPC protocol that interoperates with
		1117	other languages is to send CBOR and receive CBOR values (arrays are
		1118	recommended):
		1119
		1120	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1121
		1122	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1123
		1124	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1125
595	=cut	1126	=cut
		1127
		1128	sub json_coder() {
		1129	eval { require JSON::XS; JSON::XS->new->utf8 }
		1130	|| do { require JSON::PP; JSON::PP->new->utf8 }
		1131	}
596		1132
597	register_write_type json => sub {	1133	register_write_type json => sub {
598	my ($self, $ref) = @_;	1134	my ($self, $ref) = @_;
599		1135
600	require JSON;	1136	($self->{json} ||= json_coder)
		1137	->encode ($ref)
		1138	};
601		1139
602	$self->{json} ? $self->{json}->encode ($ref)	1140	sub cbor_coder() {
603	: JSON::encode_json ($ref)	1141	require CBOR::XS;
		1142	CBOR::XS->new
		1143	}
		1144
		1145	register_write_type cbor => sub {
		1146	my ($self, $scalar) = @_;
		1147
		1148	($self->{cbor} ||= cbor_coder)
		1149	->encode ($scalar)
604	};	1150	};
605		1151
606	=item storable => $reference	1152	=item storable => $reference
607		1153
608	Freezes the given reference using L<Storable> and writes it to the	1154	Freezes the given reference using L<Storable> and writes it to the
…		…
611	=cut	1157	=cut
612		1158
613	register_write_type storable => sub {	1159	register_write_type storable => sub {
614	my ($self, $ref) = @_;	1160	my ($self, $ref) = @_;
615		1161
616	require Storable;	1162	require Storable unless $Storable::VERSION;
617		1163
618	pack "w/a*", Storable::nfreeze ($ref)	1164	pack "w/a*", Storable::nfreeze ($ref)
619	};	1165	};
620		1166
621	=back	1167	=back
622		1168
623	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1169	=item $handle->push_shutdown
624		1170
625	This function (not method) lets you add your own types to C<push_write>.	1171	Sometimes you know you want to close the socket after writing your data
		1172	before it was actually written. One way to do that is to replace your
		1173	C<on_drain> handler by a callback that shuts down the socket (and set
		1174	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1175	replaces the C<on_drain> callback with:
		1176
		1177	sub { shutdown $_[0]{fh}, 1 }
		1178
		1179	This simply shuts down the write side and signals an EOF condition to the
		1180	the peer.
		1181
		1182	You can rely on the normal read queue and C<on_eof> handling
		1183	afterwards. This is the cleanest way to close a connection.
		1184
		1185	This method may invoke callbacks (and therefore the handle might be
		1186	destroyed after it returns).
		1187
		1188	=cut
		1189
		1190	sub push_shutdown {
		1191	my ($self) = @_;
		1192
		1193	delete $self->{low_water_mark};
		1194	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1195	}
		1196
		1197	=item custom write types - Package::anyevent_write_type $handle, @args
		1198
		1199	Instead of one of the predefined types, you can also specify the name of
		1200	a package. AnyEvent will try to load the package and then expects to find
		1201	a function named C<anyevent_write_type> inside. If it isn't found, it
		1202	progressively tries to load the parent package until it either finds the
		1203	function (good) or runs out of packages (bad).
		1204
626	Whenever the given C<type> is used, C<push_write> will invoke the code	1205	Whenever the given C<type> is used, C<push_write> will the function with
627	reference with the handle object and the remaining arguments.	1206	the handle object and the remaining arguments.
628		1207
629	The code reference is supposed to return a single octet string that will	1208	The function is supposed to return a single octet string that will be
630	be appended to the write buffer.	1209	appended to the write buffer, so you can mentally treat this function as a
		1210	"arguments to on-the-wire-format" converter.
631		1211
632	Note that this is a function, and all types registered this way will be	1212	Example: implement a custom write type C<join> that joins the remaining
633	global, so try to use unique names.	1213	arguments using the first one.
		1214
		1215	$handle->push_write (My::Type => " ", 1,2,3);
		1216
		1217	# uses the following package, which can be defined in the "My::Type" or in
		1218	# the "My" modules to be auto-loaded, or just about anywhere when the
		1219	# My::Type::anyevent_write_type is defined before invoking it.
		1220
		1221	package My::Type;
		1222
		1223	sub anyevent_write_type {
		1224	my ($handle, $delim, @args) = @_;
		1225
		1226	join $delim, @args
		1227	}
634		1228
635	=cut	1229	=cut
636		1230
637	#############################################################################	1231	#############################################################################
638		1232
…		…
647	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1241	ways, the "simple" way, using only C<on_read> and the "complex" way, using
648	a queue.	1242	a queue.
649		1243
650	In the simple case, you just install an C<on_read> callback and whenever	1244	In the simple case, you just install an C<on_read> callback and whenever
651	new data arrives, it will be called. You can then remove some data (if	1245	new data arrives, it will be called. You can then remove some data (if
652	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1246	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
653	leave the data there if you want to accumulate more (e.g. when only a	1247	leave the data there if you want to accumulate more (e.g. when only a
654	partial message has been received so far).	1248	partial message has been received so far), or change the read queue with
		1249	e.g. C<push_read>.
655		1250
656	In the more complex case, you want to queue multiple callbacks. In this	1251	In the more complex case, you want to queue multiple callbacks. In this
657	case, AnyEvent::Handle will call the first queued callback each time new	1252	case, AnyEvent::Handle will call the first queued callback each time new
658	data arrives (also the first time it is queued) and removes it when it has	1253	data arrives (also the first time it is queued) and remove it when it has
659	done its job (see C<push_read>, below).	1254	done its job (see C<push_read>, below).
660		1255
661	This way you can, for example, push three line-reads, followed by reading	1256	This way you can, for example, push three line-reads, followed by reading
662	a chunk of data, and AnyEvent::Handle will execute them in order.	1257	a chunk of data, and AnyEvent::Handle will execute them in order.
663		1258
…		…
720	=cut	1315	=cut
721		1316
722	sub _drain_rbuf {	1317	sub _drain_rbuf {
723	my ($self) = @_;	1318	my ($self) = @_;
724		1319
		1320	# avoid recursion
		1321	return if $self->{_skip_drain_rbuf};
725	local $self->{_in_drain} = 1;	1322	local $self->{_skip_drain_rbuf} = 1;
726
727	if (
728	defined $self->{rbuf_max}
729	&& $self->{rbuf_max} < length $self->{rbuf}
730	) {
731	return $self->_error (&Errno::ENOSPC, 1);
732	}
733		1323
734	while () {	1324	while () {
735	no strict 'refs';	1325	# we need to use a separate tls read buffer, as we must not receive data while
		1326	# we are draining the buffer, and this can only happen with TLS.
		1327	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1328	if exists $self->{_tls_rbuf};
736		1329
737	my $len = length $self->{rbuf};	1330	my $len = length $self->{rbuf};
738		1331
739	if (my $cb = shift @{ $self->{_queue} }) {	1332	if (my $cb = shift @{ $self->{_queue} }) {
740	unless ($cb->($self)) {	1333	unless ($cb->($self)) {
741	if ($self->{_eof}) {	1334	# no progress can be made
742	# no progress can be made (not enough data and no data forthcoming)	1335	# (not enough data and no data forthcoming)
743	$self->_error (&Errno::EPIPE, 1), last;	1336	$self->_error (Errno::EPIPE, 1), return
744	}	1337	if $self->{_eof};
745		1338
746	unshift @{ $self->{_queue} }, $cb;	1339	unshift @{ $self->{_queue} }, $cb;
747	last;	1340	last;
748	}	1341	}
749	} elsif ($self->{on_read}) {	1342	} elsif ($self->{on_read}) {
…		…
756	&& !@{ $self->{_queue} } # and the queue is still empty	1349	&& !@{ $self->{_queue} } # and the queue is still empty
757	&& $self->{on_read} # but we still have on_read	1350	&& $self->{on_read} # but we still have on_read
758	) {	1351	) {
759	# no further data will arrive	1352	# no further data will arrive
760	# so no progress can be made	1353	# so no progress can be made
761	$self->_error (&Errno::EPIPE, 1), last	1354	$self->_error (Errno::EPIPE, 1), return
762	if $self->{_eof};	1355	if $self->{_eof};
763		1356
764	last; # more data might arrive	1357	last; # more data might arrive
765	}	1358	}
766	} else {	1359	} else {
767	# read side becomes idle	1360	# read side becomes idle
768	delete $self->{_rw};	1361	delete $self->{_rw} unless $self->{tls};
769	last;	1362	last;
770	}	1363	}
771	}	1364	}
772		1365
		1366	if ($self->{_eof}) {
		1367	$self->{on_eof}
773	$self->{on_eof}($self)	1368	? $self->{on_eof}($self)
774	if $self->{_eof} && $self->{on_eof};	1369	: $self->_error (0, 1, "Unexpected end-of-file");
		1370
		1371	return;
		1372	}
		1373
		1374	if (
		1375	defined $self->{rbuf_max}
		1376	&& $self->{rbuf_max} < length $self->{rbuf}
		1377	) {
		1378	$self->_error (Errno::ENOSPC, 1), return;
		1379	}
775		1380
776	# may need to restart read watcher	1381	# may need to restart read watcher
777	unless ($self->{_rw}) {	1382	unless ($self->{_rw}) {
778	$self->start_read	1383	$self->start_read
779	if $self->{on_read} || @{ $self->{_queue} };	1384	if $self->{on_read} || @{ $self->{_queue} };
…		…
784		1389
785	This replaces the currently set C<on_read> callback, or clears it (when	1390	This replaces the currently set C<on_read> callback, or clears it (when
786	the new callback is C<undef>). See the description of C<on_read> in the	1391	the new callback is C<undef>). See the description of C<on_read> in the
787	constructor.	1392	constructor.
788		1393
		1394	This method may invoke callbacks (and therefore the handle might be
		1395	destroyed after it returns).
		1396
789	=cut	1397	=cut
790		1398
791	sub on_read {	1399	sub on_read {
792	my ($self, $cb) = @_;	1400	my ($self, $cb) = @_;
793		1401
794	$self->{on_read} = $cb;	1402	$self->{on_read} = $cb;
795	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1403	$self->_drain_rbuf if $cb;
796	}	1404	}
797		1405
798	=item $handle->rbuf	1406	=item $handle->rbuf
799		1407
800	Returns the read buffer (as a modifiable lvalue).	1408	Returns the read buffer (as a modifiable lvalue). You can also access the
		1409	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1410	much faster, and no less clean).
801		1411
802	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1412	The only operation allowed on the read buffer (apart from looking at it)
803	you want.	1413	is removing data from its beginning. Otherwise modifying or appending to
		1414	it is not allowed and will lead to hard-to-track-down bugs.
804		1415
805	NOTE: The read buffer should only be used or modified if the C<on_read>,	1416	NOTE: The read buffer should only be used or modified in the C<on_read>
806	C<push_read> or C<unshift_read> methods are used. The other read methods	1417	callback or when C<push_read> or C<unshift_read> are used with a single
807	automatically manage the read buffer.	1418	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1419	will manage the read buffer on their own.
808		1420
809	=cut	1421	=cut
810		1422
811	sub rbuf : lvalue {	1423	sub rbuf : lvalue {
812	$_[0]{rbuf}	1424	$_[0]{rbuf}
…		…
829		1441
830	If enough data was available, then the callback must remove all data it is	1442	If enough data was available, then the callback must remove all data it is
831	interested in (which can be none at all) and return a true value. After returning	1443	interested in (which can be none at all) and return a true value. After returning
832	true, it will be removed from the queue.	1444	true, it will be removed from the queue.
833		1445
		1446	These methods may invoke callbacks (and therefore the handle might be
		1447	destroyed after it returns).
		1448
834	=cut	1449	=cut
835		1450
836	our %RH;	1451	our %RH;
837		1452
838	sub register_read_type($$) {	1453	sub register_read_type($$) {
…		…
844	my $cb = pop;	1459	my $cb = pop;
845		1460
846	if (@_) {	1461	if (@_) {
847	my $type = shift;	1462	my $type = shift;
848		1463
		1464	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
849	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1465	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
850	->($self, $cb, @_);	1466	->($self, $cb, @_);
851	}	1467	}
852		1468
853	push @{ $self->{_queue} }, $cb;	1469	push @{ $self->{_queue} }, $cb;
854	$self->_drain_rbuf unless $self->{_in_drain};	1470	$self->_drain_rbuf;
855	}	1471	}
856		1472
857	sub unshift_read {	1473	sub unshift_read {
858	my $self = shift;	1474	my $self = shift;
859	my $cb = pop;	1475	my $cb = pop;
860		1476
861	if (@_) {	1477	if (@_) {
862	my $type = shift;	1478	my $type = shift;
863		1479
		1480	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
864	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1481	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
865	->($self, $cb, @_);	1482	->($self, $cb, @_);
866	}	1483	}
867		1484
868
869	unshift @{ $self->{_queue} }, $cb;	1485	unshift @{ $self->{_queue} }, $cb;
870	$self->_drain_rbuf unless $self->{_in_drain};	1486	$self->_drain_rbuf;
871	}	1487	}
872		1488
873	=item $handle->push_read (type => @args, $cb)	1489	=item $handle->push_read (type => @args, $cb)
874		1490
875	=item $handle->unshift_read (type => @args, $cb)	1491	=item $handle->unshift_read (type => @args, $cb)
876		1492
877	Instead of providing a callback that parses the data itself you can chose	1493	Instead of providing a callback that parses the data itself you can chose
878	between a number of predefined parsing formats, for chunks of data, lines	1494	between a number of predefined parsing formats, for chunks of data, lines
879	etc.	1495	etc. You can also specify the (fully qualified) name of a package, in
		1496	which case AnyEvent tries to load the package and then expects to find the
		1497	C<anyevent_read_type> function inside (see "custom read types", below).
880		1498
881	Predefined types are (if you have ideas for additional types, feel free to	1499	Predefined types are (if you have ideas for additional types, feel free to
882	drop by and tell us):	1500	drop by and tell us):
883		1501
884	=over 4	1502	=over 4
…		…
890	data.	1508	data.
891		1509
892	Example: read 2 bytes.	1510	Example: read 2 bytes.
893		1511
894	$handle->push_read (chunk => 2, sub {	1512	$handle->push_read (chunk => 2, sub {
895	warn "yay ", unpack "H*", $_[1];	1513	say "yay " . unpack "H*", $_[1];
896	});	1514	});
897		1515
898	=cut	1516	=cut
899		1517
900	register_read_type chunk => sub {	1518	register_read_type chunk => sub {
…		…
905	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1523	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
906	1	1524	1
907	}	1525	}
908	};	1526	};
909		1527
910	# compatibility with older API
911	sub push_read_chunk {
912	$_[0]->push_read (chunk => $_[1], $_[2]);
913	}
914
915	sub unshift_read_chunk {
916	$_[0]->unshift_read (chunk => $_[1], $_[2]);
917	}
918
919	=item line => [$eol, ]$cb->($handle, $line, $eol)	1528	=item line => [$eol, ]$cb->($handle, $line, $eol)
920		1529
921	The callback will be called only once a full line (including the end of	1530	The callback will be called only once a full line (including the end of
922	line marker, C<$eol>) has been read. This line (excluding the end of line	1531	line marker, C<$eol>) has been read. This line (excluding the end of line
923	marker) will be passed to the callback as second argument (C<$line>), and	1532	marker) will be passed to the callback as second argument (C<$line>), and
…		…
938	=cut	1547	=cut
939		1548
940	register_read_type line => sub {	1549	register_read_type line => sub {
941	my ($self, $cb, $eol) = @_;	1550	my ($self, $cb, $eol) = @_;
942		1551
943	$eol = qr|(\015?\012)| if @_ < 3;	1552	if (@_ < 3) {
		1553	# this is faster then the generic code below
		1554	sub {
		1555	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1556	or return;
		1557
		1558	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
		1559	$cb->($_[0], $str, "$1");
		1560	1
		1561	}
		1562	} else {
944	$eol = quotemeta $eol unless ref $eol;	1563	$eol = quotemeta $eol unless ref $eol;
945	$eol = qr|^(.*?)($eol)|s;	1564	$eol = qr|^(.*?)($eol)|s;
946		1565
947	sub {	1566	sub {
948	$_[0]{rbuf} =~ s/$eol// or return;	1567	$_[0]{rbuf} =~ s/$eol// or return;
949		1568
950	$cb->($_[0], $1, $2);	1569	$cb->($_[0], "$1", "$2");
		1570	1
951	1	1571	}
952	}	1572	}
953	};	1573	};
954
955	# compatibility with older API
956	sub push_read_line {
957	my $self = shift;
958	$self->push_read (line => @_);
959	}
960
961	sub unshift_read_line {
962	my $self = shift;
963	$self->unshift_read (line => @_);
964	}
965		1574
966	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1575	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
967		1576
968	Makes a regex match against the regex object C<$accept> and returns	1577	Makes a regex match against the regex object C<$accept> and returns
969	everything up to and including the match.	1578	everything up to and including the match.
…		…
987	the receive buffer when neither C<$accept> nor C<$reject> match,	1596	the receive buffer when neither C<$accept> nor C<$reject> match,
988	and everything preceding and including the match will be accepted	1597	and everything preceding and including the match will be accepted
989	unconditionally. This is useful to skip large amounts of data that you	1598	unconditionally. This is useful to skip large amounts of data that you
990	know cannot be matched, so that the C<$accept> or C<$reject> regex do not	1599	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
991	have to start matching from the beginning. This is purely an optimisation	1600	have to start matching from the beginning. This is purely an optimisation
992	and is usually worth only when you expect more than a few kilobytes.	1601	and is usually worth it only when you expect more than a few kilobytes.
993		1602
994	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1603	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
995	expect the header to be very large (it isn't in practise, but...), we use	1604	expect the header to be very large (it isn't in practice, but...), we use
996	a skip regex to skip initial portions. The skip regex is tricky in that	1605	a skip regex to skip initial portions. The skip regex is tricky in that
997	it only accepts something not ending in either \015 or \012, as these are	1606	it only accepts something not ending in either \015 or \012, as these are
998	required for the accept regex.	1607	required for the accept regex.
999		1608
1000	$handle->push_read (regex =>	1609	$handle->push_read (regex =>
…		…
1013		1622
1014	sub {	1623	sub {
1015	# accept	1624	# accept
1016	if ($$rbuf =~ $accept) {	1625	if ($$rbuf =~ $accept) {
1017	$data .= substr $$rbuf, 0, $+[0], "";	1626	$data .= substr $$rbuf, 0, $+[0], "";
1018	$cb->($self, $data);	1627	$cb->($_[0], $data);
1019	return 1;	1628	return 1;
1020	}	1629	}
1021		1630
1022	# reject	1631	# reject
1023	if ($reject && $$rbuf =~ $reject) {	1632	if ($reject && $$rbuf =~ $reject) {
1024	$self->_error (&Errno::EBADMSG);	1633	$_[0]->_error (Errno::EBADMSG);
1025	}	1634	}
1026		1635
1027	# skip	1636	# skip
1028	if ($skip && $$rbuf =~ $skip) {	1637	if ($skip && $$rbuf =~ $skip) {
1029	$data .= substr $$rbuf, 0, $+[0], "";	1638	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1045	my ($self, $cb) = @_;	1654	my ($self, $cb) = @_;
1046		1655
1047	sub {	1656	sub {
1048	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1657	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1049	if ($_[0]{rbuf} =~ /[^0-9]/) {	1658	if ($_[0]{rbuf} =~ /[^0-9]/) {
1050	$self->_error (&Errno::EBADMSG);	1659	$_[0]->_error (Errno::EBADMSG);
1051	}	1660	}
1052	return;	1661	return;
1053	}	1662	}
1054		1663
1055	my $len = $1;	1664	my $len = $1;
1056		1665
1057	$self->unshift_read (chunk => $len, sub {	1666	$_[0]->unshift_read (chunk => $len, sub {
1058	my $string = $_[1];	1667	my $string = $_[1];
1059	$_[0]->unshift_read (chunk => 1, sub {	1668	$_[0]->unshift_read (chunk => 1, sub {
1060	if ($_[1] eq ",") {	1669	if ($_[1] eq ",") {
1061	$cb->($_[0], $string);	1670	$cb->($_[0], $string);
1062	} else {	1671	} else {
1063	$self->_error (&Errno::EBADMSG);	1672	$_[0]->_error (Errno::EBADMSG);
1064	}	1673	}
1065	});	1674	});
1066	});	1675	});
1067		1676
1068	1	1677	1
…		…
1074	An octet string prefixed with an encoded length. The encoding C<$format>	1683	An octet string prefixed with an encoded length. The encoding C<$format>
1075	uses the same format as a Perl C<pack> format, but must specify a single	1684	uses the same format as a Perl C<pack> format, but must specify a single
1076	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1685	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1077	optional C<!>, C<< < >> or C<< > >> modifier).	1686	optional C<!>, C<< < >> or C<< > >> modifier).
1078		1687
1079	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1688	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1689	EPP uses a prefix of C<N> (4 octtes).
1080		1690
1081	Example: read a block of data prefixed by its length in BER-encoded	1691	Example: read a block of data prefixed by its length in BER-encoded
1082	format (very efficient).	1692	format (very efficient).
1083		1693
1084	$handle->push_read (packstring => "w", sub {	1694	$handle->push_read (packstring => "w", sub {
…		…
1090	register_read_type packstring => sub {	1700	register_read_type packstring => sub {
1091	my ($self, $cb, $format) = @_;	1701	my ($self, $cb, $format) = @_;
1092		1702
1093	sub {	1703	sub {
1094	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1704	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1095	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1705	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1096	or return;	1706	or return;
1097		1707
		1708	$format = length pack $format, $len;
		1709
		1710	# bypass unshift if we already have the remaining chunk
		1711	if ($format + $len <= length $_[0]{rbuf}) {
		1712	my $data = substr $_[0]{rbuf}, $format, $len;
		1713	substr $_[0]{rbuf}, 0, $format + $len, "";
		1714	$cb->($_[0], $data);
		1715	} else {
1098	# remove prefix	1716	# remove prefix
1099	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1717	substr $_[0]{rbuf}, 0, $format, "";
1100		1718
1101	# read rest	1719	# read remaining chunk
1102	$_[0]->unshift_read (chunk => $len, $cb);	1720	$_[0]->unshift_read (chunk => $len, $cb);
		1721	}
1103		1722
1104	1	1723	1
1105	}	1724	}
1106	};	1725	};
1107		1726
1108	=item json => $cb->($handle, $hash_or_arrayref)	1727	=item json => $cb->($handle, $hash_or_arrayref)
1109		1728
1110	Reads a JSON object or array, decodes it and passes it to the callback.	1729	Reads a JSON object or array, decodes it and passes it to the
		1730	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1111		1731
1112	If a C<json> object was passed to the constructor, then that will be used	1732	If a C<json> object was passed to the constructor, then that will be
1113	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1733	used for the final decode, otherwise it will create a L<JSON::XS> or
		1734	L<JSON::PP> coder object expecting UTF-8.
1114		1735
1115	This read type uses the incremental parser available with JSON version	1736	This read type uses the incremental parser available with JSON version
1116	2.09 (and JSON::XS version 2.2) and above. You have to provide a	1737	2.09 (and JSON::XS version 2.2) and above.
1117	dependency on your own: this module will load the JSON module, but
1118	AnyEvent does not depend on it itself.
1119		1738
1120	Since JSON texts are fully self-delimiting, the C<json> read and write	1739	Since JSON texts are fully self-delimiting, the C<json> read and write
1121	types are an ideal simple RPC protocol: just exchange JSON datagrams. See	1740	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1122	the C<json> write type description, above, for an actual example.	1741	the C<json> write type description, above, for an actual example.
1123		1742
1124	=cut	1743	=cut
1125		1744
1126	register_read_type json => sub {	1745	register_read_type json => sub {
1127	my ($self, $cb) = @_;	1746	my ($self, $cb) = @_;
1128		1747
1129	require JSON;	1748	my $json = $self->{json} ||= json_coder;
1130		1749
1131	my $data;	1750	my $data;
1132	my $rbuf = \$self->{rbuf};
1133
1134	my $json = $self->{json} ||= JSON->new->utf8;
1135		1751
1136	sub {	1752	sub {
1137	my $ref = $json->incr_parse ($self->{rbuf});	1753	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1138		1754
1139	if ($ref) {	1755	if ($ref) {
1140	$self->{rbuf} = $json->incr_text;	1756	$_[0]{rbuf} = $json->incr_text;
1141	$json->incr_text = "";	1757	$json->incr_text = "";
1142	$cb->($self, $ref);	1758	$cb->($_[0], $ref);
1143		1759
1144	1	1760	1
		1761	} elsif ($@) {
		1762	# error case
		1763	$json->incr_skip;
		1764
		1765	$_[0]{rbuf} = $json->incr_text;
		1766	$json->incr_text = "";
		1767
		1768	$_[0]->_error (Errno::EBADMSG);
		1769
		1770	()
1145	} else {	1771	} else {
1146	$self->{rbuf} = "";	1772	$_[0]{rbuf} = "";
		1773
		1774	()
		1775	}
		1776	}
		1777	};
		1778
		1779	=item cbor => $cb->($handle, $scalar)
		1780
		1781	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1782	error occurs, an C<EBADMSG> error will be raised.
		1783
		1784	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1785	used for the final decode, otherwise it will create a CBOR coder without
		1786	enabling any options.
		1787
		1788	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1789	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1790	itself.
		1791
		1792	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1793	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1794	the C<cbor> write type description, above, for an actual example.
		1795
		1796	=cut
		1797
		1798	register_read_type cbor => sub {
		1799	my ($self, $cb) = @_;
		1800
		1801	my $cbor = $self->{cbor} ||= cbor_coder;
		1802
		1803	my $data;
		1804
		1805	sub {
		1806	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1807
		1808	if (@value) {
		1809	$cb->($_[0], @value);
		1810
		1811	1
		1812	} elsif ($@) {
		1813	# error case
		1814	$cbor->incr_reset;
		1815
		1816	$_[0]->_error (Errno::EBADMSG);
		1817
		1818	()
		1819	} else {
1147	()	1820	()
1148	}	1821	}
1149	}	1822	}
1150	};	1823	};
1151		1824
…		…
1160	=cut	1833	=cut
1161		1834
1162	register_read_type storable => sub {	1835	register_read_type storable => sub {
1163	my ($self, $cb) = @_;	1836	my ($self, $cb) = @_;
1164		1837
1165	require Storable;	1838	require Storable unless $Storable::VERSION;
1166		1839
1167	sub {	1840	sub {
1168	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1841	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1169	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })	1842	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1170	or return;	1843	or return;
1171		1844
		1845	my $format = length pack "w", $len;
		1846
		1847	# bypass unshift if we already have the remaining chunk
		1848	if ($format + $len <= length $_[0]{rbuf}) {
		1849	my $data = substr $_[0]{rbuf}, $format, $len;
		1850	substr $_[0]{rbuf}, 0, $format + $len, "";
		1851
		1852	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1853	or return $_[0]->_error (Errno::EBADMSG);
		1854	} else {
1172	# remove prefix	1855	# remove prefix
1173	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";	1856	substr $_[0]{rbuf}, 0, $format, "";
1174		1857
1175	# read rest	1858	# read remaining chunk
1176	$_[0]->unshift_read (chunk => $len, sub {	1859	$_[0]->unshift_read (chunk => $len, sub {
1177	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1860	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1178	$cb->($_[0], $ref);
1179	} else {
1180	$self->_error (&Errno::EBADMSG);	1861	or $_[0]->_error (Errno::EBADMSG);
1181	}	1862	});
1182	});	1863	}
		1864
		1865	1
1183	}	1866	}
1184	};	1867	};
1185		1868
		1869	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1870
		1871	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1872	record without consuming anything. Only SSL version 3 or higher
		1873	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1874	SSL2-compatible framing is supported).
		1875
		1876	If it detects that the input data is likely TLS, it calls the callback
		1877	with a true value for C<$detect> and the (on-wire) TLS version as second
		1878	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1879	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1880	be definitely not TLS, it calls the callback with a false value for
		1881	C<$detect>.
		1882
		1883	The callback could use this information to decide whether or not to start
		1884	TLS negotiation.
		1885
		1886	In all cases the data read so far is passed to the following read
		1887	handlers.
		1888
		1889	Usually you want to use the C<tls_autostart> read type instead.
		1890
		1891	If you want to design a protocol that works in the presence of TLS
		1892	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1893	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1894	read type does are a bit more strict, but might losen in the future to
		1895	accomodate protocol changes.
		1896
		1897	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1898	L<Net::SSLeay>).
		1899
		1900	=item tls_autostart => $tls[, $tls_ctx]
		1901
		1902	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1903	to start tls by calling C<starttls> with the given arguments.
		1904
		1905	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1906	been configured to accept, as servers do not normally send a handshake on
		1907	their own and ths cannot be detected in this way.
		1908
		1909	See C<tls_detect> above for more details.
		1910
		1911	Example: give the client a chance to start TLS before accepting a text
		1912	line.
		1913
		1914	$hdl->push_read (tls_detect => "accept");
		1915	$hdl->push_read (line => sub {
		1916	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1917	});
		1918
		1919	=cut
		1920
		1921	register_read_type tls_detect => sub {
		1922	my ($self, $cb) = @_;
		1923
		1924	sub {
		1925	# this regex matches a full or partial tls record
		1926	if (
		1927	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1928	$self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs
		1929	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1930	or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs
		1931	) {
		1932	return if 3 != length $1; # partial match, can't decide yet
		1933
		1934	# full match, valid TLS record
		1935	my ($major, $minor) = unpack "CC", $1;
		1936	$cb->($self, "accept", $major + $minor * 0.1);
		1937	} else {
		1938	# mismatch == guaranteed not TLS
		1939	$cb->($self, undef);
		1940	}
		1941
		1942	1
		1943	}
		1944	};
		1945
		1946	register_read_type tls_autostart => sub {
		1947	my ($self, @tls) = @_;
		1948
		1949	$RH{tls_detect}($self, sub {
		1950	return unless $_[1];
		1951	$_[0]->starttls (@tls);
		1952	})
		1953	};
		1954
1186	=back	1955	=back
1187		1956
1188	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1957	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1189		1958
1190	This function (not method) lets you add your own types to C<push_read>.	1959	Instead of one of the predefined types, you can also specify the name
		1960	of a package. AnyEvent will try to load the package and then expects to
		1961	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1962	progressively tries to load the parent package until it either finds the
		1963	function (good) or runs out of packages (bad).
1191		1964
1192	Whenever the given C<type> is used, C<push_read> will invoke the code	1965	Whenever this type is used, C<push_read> will invoke the function with the
1193	reference with the handle object, the callback and the remaining	1966	handle object, the original callback and the remaining arguments.
1194	arguments.
1195		1967
1196	The code reference is supposed to return a callback (usually a closure)	1968	The function is supposed to return a callback (usually a closure) that
1197	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1969	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1970	mentally treat the function as a "configurable read type to read callback"
		1971	converter.
1198		1972
1199	It should invoke the passed callback when it is done reading (remember to	1973	It should invoke the original callback when it is done reading (remember
1200	pass C<$handle> as first argument as all other callbacks do that).	1974	to pass C<$handle> as first argument as all other callbacks do that,
		1975	although there is no strict requirement on this).
1201		1976
1202	Note that this is a function, and all types registered this way will be
1203	global, so try to use unique names.
1204
1205	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1977	For examples, see the source of this module (F<perldoc -m
1206	search for C<register_read_type>)).	1978	AnyEvent::Handle>, search for C<register_read_type>)).
1207		1979
1208	=item $handle->stop_read	1980	=item $handle->stop_read
1209		1981
1210	=item $handle->start_read	1982	=item $handle->start_read
1211		1983
…		…
1217	Note that AnyEvent::Handle will automatically C<start_read> for you when	1989	Note that AnyEvent::Handle will automatically C<start_read> for you when
1218	you change the C<on_read> callback or push/unshift a read callback, and it	1990	you change the C<on_read> callback or push/unshift a read callback, and it
1219	will automatically C<stop_read> for you when neither C<on_read> is set nor	1991	will automatically C<stop_read> for you when neither C<on_read> is set nor
1220	there are any read requests in the queue.	1992	there are any read requests in the queue.
1221		1993
		1994	In older versions of this module (<= 5.3), these methods had no effect,
		1995	as TLS does not support half-duplex connections. In current versions they
		1996	work as expected, as this behaviour is required to avoid certain resource
		1997	attacks, where the program would be forced to read (and buffer) arbitrary
		1998	amounts of data before being able to send some data. The drawback is that
		1999	some readings of the the SSL/TLS specifications basically require this
		2000	attack to be working, as SSL/TLS implementations might stall sending data
		2001	during a rehandshake.
		2002
		2003	As a guideline, during the initial handshake, you should not stop reading,
		2004	and as a client, it might cause problems, depending on your application.
		2005
1222	=cut	2006	=cut
1223		2007
1224	sub stop_read {	2008	sub stop_read {
1225	my ($self) = @_;	2009	my ($self) = @_;
1226		2010
…		…
1228	}	2012	}
1229		2013
1230	sub start_read {	2014	sub start_read {
1231	my ($self) = @_;	2015	my ($self) = @_;
1232		2016
1233	unless ($self->{_rw} || $self->{_eof}) {	2017	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1234	Scalar::Util::weaken $self;	2018	Scalar::Util::weaken $self;
1235		2019
1236	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	2020	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1237	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	2021	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1238	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	2022	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1239		2023
1240	if ($len > 0) {	2024	if ($len > 0) {
1241	$self->{_activity} = AnyEvent->now;	2025	$self->{_activity} = $self->{_ractivity} = AE::now;
1242		2026
1243	$self->{filter_r}	2027	if ($self->{tls}) {
1244	? $self->{filter_r}($self, $rbuf)	2028	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1245	: $self->{_in_drain} || $self->_drain_rbuf;	2029
		2030	&_dotls ($self);
		2031	} else {
		2032	$self->_drain_rbuf;
		2033	}
		2034
		2035	if ($len == $self->{read_size}) {
		2036	$self->{read_size} *= 2;
		2037	$self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
		2038	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		2039	}
1246		2040
1247	} elsif (defined $len) {	2041	} elsif (defined $len) {
1248	delete $self->{_rw};	2042	delete $self->{_rw};
1249	$self->{_eof} = 1;	2043	$self->{_eof} = 1;
1250	$self->_drain_rbuf unless $self->{_in_drain};	2044	$self->_drain_rbuf;
1251		2045
1252	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2046	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1253	return $self->_error ($!, 1);	2047	return $self->_error ($!, 1);
1254	}	2048	}
1255	});	2049	};
1256	}	2050	}
1257	}	2051	}
1258		2052
		2053	our $ERROR_SYSCALL;
		2054	our $ERROR_WANT_READ;
		2055
		2056	sub _tls_error {
		2057	my ($self, $err) = @_;
		2058
		2059	return $self->_error ($!, 1)
		2060	if $err == Net::SSLeay::ERROR_SYSCALL ();
		2061
		2062	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		2063
		2064	# reduce error string to look less scary
		2065	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		2066
		2067	if ($self->{_on_starttls}) {
		2068	(delete $self->{_on_starttls})->($self, undef, $err);
		2069	&_freetls;
		2070	} else {
		2071	&_freetls;
		2072	$self->_error (Errno::EPROTO, 1, $err);
		2073	}
		2074	}
		2075
		2076	# poll the write BIO and send the data if applicable
		2077	# also decode read data if possible
		2078	# this is basiclaly our TLS state machine
		2079	# more efficient implementations are possible with openssl,
		2080	# but not with the buggy and incomplete Net::SSLeay.
1259	sub _dotls {	2081	sub _dotls {
1260	my ($self) = @_;	2082	my ($self) = @_;
1261		2083
1262	my $buf;	2084	my $tmp;
1263		2085
1264	if (length $self->{_tls_wbuf}) {	2086	while (length $self->{_tls_wbuf}) {
1265	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2087	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1266	substr $self->{_tls_wbuf}, 0, $len, "";	2088	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2089
		2090	return $self->_tls_error ($tmp)
		2091	if $tmp != $ERROR_WANT_READ
		2092	&& ($tmp != $ERROR_SYSCALL || $!);
		2093
		2094	last;
1267	}	2095	}
1268	}
1269		2096
		2097	substr $self->{_tls_wbuf}, 0, $tmp, "";
		2098	}
		2099
		2100	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		2101	unless (length $tmp) {
		2102	$self->{_on_starttls}
		2103	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		2104	&_freetls;
		2105
		2106	if ($self->{on_stoptls}) {
		2107	$self->{on_stoptls}($self);
		2108	return;
		2109	} else {
		2110	# let's treat SSL-eof as we treat normal EOF
		2111	delete $self->{_rw};
		2112	$self->{_eof} = 1;
		2113	}
		2114	}
		2115
		2116	$self->{_tls_rbuf} .= $tmp;
		2117	$self->_drain_rbuf;
		2118	$self->{tls} or return; # tls session might have gone away in callback
		2119	}
		2120
		2121	$tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us
		2122	return $self->_tls_error ($tmp)
		2123	if $tmp != $ERROR_WANT_READ
		2124	&& ($tmp != $ERROR_SYSCALL || $!);
		2125
1270	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2126	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1271	$self->{wbuf} .= $buf;	2127	$self->{wbuf} .= $tmp;
1272	$self->_drain_wbuf;	2128	$self->_drain_wbuf;
		2129	$self->{tls} or return; # tls session might have gone away in callback
1273	}	2130	}
1274		2131
1275	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	2132	$self->{_on_starttls}
1276	if (length $buf) {	2133	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1277	$self->{rbuf} .= $buf;	2134	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1278	$self->_drain_rbuf unless $self->{_in_drain};
1279	} else {
1280	# let's treat SSL-eof as we treat normal EOF
1281	$self->{_eof} = 1;
1282	$self->_shutdown;
1283	return;
1284	}
1285	}
1286
1287	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1288
1289	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1290	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1291	return $self->_error ($!, 1);
1292	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1293	return $self->_error (&Errno::EIO, 1);
1294	}
1295
1296	# all others are fine for our purposes
1297	}
1298	}	2135	}
1299		2136
1300	=item $handle->starttls ($tls[, $tls_ctx])	2137	=item $handle->starttls ($tls[, $tls_ctx])
1301		2138
1302	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2139	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1303	object is created, you can also do that at a later time by calling	2140	object is created, you can also do that at a later time by calling
1304	C<starttls>.	2141	C<starttls>. See the C<tls> constructor argument for general info.
		2142
		2143	Starting TLS is currently an asynchronous operation - when you push some
		2144	write data and then call C<< ->starttls >> then TLS negotiation will start
		2145	immediately, after which the queued write data is then sent. This might
		2146	change in future versions, so best make sure you have no outstanding write
		2147	data when calling this method.
1305		2148
1306	The first argument is the same as the C<tls> constructor argument (either	2149	The first argument is the same as the C<tls> constructor argument (either
1307	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2150	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1308		2151
1309	The second argument is the optional C<Net::SSLeay::CTX> object that is	2152	The second argument is the optional C<AnyEvent::TLS> object that is used
1310	used when AnyEvent::Handle has to create its own TLS connection object.	2153	when AnyEvent::Handle has to create its own TLS connection object, or
		2154	a hash reference with C<< key => value >> pairs that will be used to
		2155	construct a new context.
1311		2156
1312	The TLS connection object will end up in C<< $handle->{tls} >> after this	2157	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1313	call and can be used or changed to your liking. Note that the handshake	2158	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1314	might have already started when this function returns.	2159	changed to your liking. Note that the handshake might have already started
		2160	when this function returns.
1315		2161
		2162	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		2163	handshakes on the same stream. It is best to not attempt to use the
		2164	stream after stopping TLS.
		2165
		2166	This method may invoke callbacks (and therefore the handle might be
		2167	destroyed after it returns).
		2168
1316	=cut	2169	=cut
		2170
		2171	our %TLS_CACHE; #TODO not yet documented, should we?
1317		2172
1318	sub starttls {	2173	sub starttls {
1319	my ($self, $ssl, $ctx) = @_;	2174	my ($self, $tls, $ctx) = @_;
1320		2175
1321	$self->stoptls;	2176	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		2177	if $self->{tls};
1322		2178
1323	if ($ssl eq "accept") {	2179	unless (defined $AnyEvent::TLS::VERSION) {
1324	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	2180	eval {
1325	Net::SSLeay::set_accept_state ($ssl);	2181	require Net::SSLeay;
1326	} elsif ($ssl eq "connect") {	2182	require AnyEvent::TLS;
1327	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	2183	1
1328	Net::SSLeay::set_connect_state ($ssl);	2184	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2185	}
		2186
		2187	$self->{tls} = $tls;
		2188	$self->{tls_ctx} = $ctx if @_ > 2;
		2189
		2190	return unless $self->{fh};
		2191
		2192	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		2193	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		2194
		2195	$tls = delete $self->{tls};
		2196	$ctx = $self->{tls_ctx};
		2197
		2198	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		2199
		2200	if ("HASH" eq ref $ctx) {
		2201	if ($ctx->{cache}) {
		2202	my $key = $ctx+0;
		2203	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		2204	} else {
		2205	$ctx = new AnyEvent::TLS %$ctx;
		2206	}
		2207	}
1329	}	2208
1330		2209	$self->{tls_ctx} = $ctx || TLS_CTX ();
1331	$self->{tls} = $ssl;	2210	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1332		2211
1333	# basically, this is deep magic (because SSL_read should have the same issues)	2212	# basically, this is deep magic (because SSL_read should have the same issues)
1334	# but the openssl maintainers basically said: "trust us, it just works".	2213	# but the openssl maintainers basically said: "trust us, it just works".
1335	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	2214	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1336	# and mismaintained ssleay-module doesn't even offer them).	2215	# and mismaintained ssleay-module doesn't even offer them).
1337	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	2216	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		2217	#
		2218	# in short: this is a mess.
		2219	#
		2220	# note that we do not try to keep the length constant between writes as we are required to do.
		2221	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		2222	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		2223	# have identity issues in that area.
1338	Net::SSLeay::CTX_set_mode ($self->{tls},	2224	# Net::SSLeay::CTX_set_mode ($ssl,
1339	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	2225	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1340	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	2226	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		2227	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1341		2228
1342	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2229	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1343	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2230	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1344		2231
		2232	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2233	$self->{rbuf} = "";
		2234
1345	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	2235	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1346		2236
1347	$self->{filter_w} = sub {	2237	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1348	$_[0]{_tls_wbuf} .= ${$_[1]};	2238	if $self->{on_starttls};
1349	&_dotls;	2239
1350	};	2240	&_dotls; # need to trigger the initial handshake
1351	$self->{filter_r} = sub {	2241	$self->start_read; # make sure we actually do read
1352	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1353	&_dotls;
1354	};
1355	}	2242	}
1356		2243
1357	=item $handle->stoptls	2244	=item $handle->stoptls
1358		2245
1359	Destroys the SSL connection, if any. Partial read or write data will be	2246	Shuts down the SSL connection - this makes a proper EOF handshake by
1360	lost.	2247	sending a close notify to the other side, but since OpenSSL doesn't
		2248	support non-blocking shut downs, it is not guaranteed that you can re-use
		2249	the stream afterwards.
		2250
		2251	This method may invoke callbacks (and therefore the handle might be
		2252	destroyed after it returns).
1361		2253
1362	=cut	2254	=cut
1363		2255
1364	sub stoptls {	2256	sub stoptls {
1365	my ($self) = @_;	2257	my ($self) = @_;
1366		2258
1367	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	2259	if ($self->{tls} && $self->{fh}) {
		2260	Net::SSLeay::shutdown ($self->{tls});
1368		2261
1369	delete $self->{_rbio};	2262	&_dotls;
1370	delete $self->{_wbio};	2263
1371	delete $self->{_tls_wbuf};	2264	# # we don't give a shit. no, we do, but we can't. no...#d#
1372	delete $self->{filter_r};	2265	# # we, we... have to use openssl :/#d#
1373	delete $self->{filter_w};	2266	# &_freetls;#d#
		2267	}
1374	}	2268	}
		2269
		2270	sub _freetls {
		2271	my ($self) = @_;
		2272
		2273	return unless $self->{tls};
		2274
		2275	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2276	if $self->{tls} > 0;
		2277
		2278	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
		2279	}
		2280
		2281	=item $handle->resettls
		2282
		2283	This rarely-used method simply resets and TLS state on the handle, usually
		2284	causing data loss.
		2285
		2286	One case where it may be useful is when you want to skip over the data in
		2287	the stream but you are not interested in interpreting it, so data loss is
		2288	no concern.
		2289
		2290	=cut
		2291
		2292	*resettls = \&_freetls;
1375		2293
1376	sub DESTROY {	2294	sub DESTROY {
1377	my $self = shift;	2295	my ($self) = @_;
1378		2296
1379	$self->stoptls;	2297	&_freetls;
1380		2298
1381	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	2299	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1382		2300
1383	if ($linger && length $self->{wbuf}) {	2301	if ($linger && length $self->{wbuf} && $self->{fh}) {
1384	my $fh = delete $self->{fh};	2302	my $fh = delete $self->{fh};
1385	my $wbuf = delete $self->{wbuf};	2303	my $wbuf = delete $self->{wbuf};
1386		2304
1387	my @linger;	2305	my @linger;
1388		2306
1389	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2307	push @linger, AE::io $fh, 1, sub {
1390	my $len = syswrite $fh, $wbuf, length $wbuf;	2308	my $len = syswrite $fh, $wbuf, length $wbuf;
1391		2309
1392	if ($len > 0) {	2310	if ($len > 0) {
1393	substr $wbuf, 0, $len, "";	2311	substr $wbuf, 0, $len, "";
1394	} else {	2312	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1395	@linger = (); # end	2313	@linger = (); # end
1396	}	2314	}
		2315	};
		2316	push @linger, AE::timer $linger, 0, sub {
		2317	@linger = ();
		2318	};
		2319	}
		2320	}
		2321
		2322	=item $handle->destroy
		2323
		2324	Shuts down the handle object as much as possible - this call ensures that
		2325	no further callbacks will be invoked and as many resources as possible
		2326	will be freed. Any method you will call on the handle object after
		2327	destroying it in this way will be silently ignored (and it will return the
		2328	empty list).
		2329
		2330	Normally, you can just "forget" any references to an AnyEvent::Handle
		2331	object and it will simply shut down. This works in fatal error and EOF
		2332	callbacks, as well as code outside. It does I<NOT> work in a read or write
		2333	callback, so when you want to destroy the AnyEvent::Handle object from
		2334	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		2335	that case.
		2336
		2337	Destroying the handle object in this way has the advantage that callbacks
		2338	will be removed as well, so if those are the only reference holders (as
		2339	is common), then one doesn't need to do anything special to break any
		2340	reference cycles.
		2341
		2342	The handle might still linger in the background and write out remaining
		2343	data, as specified by the C<linger> option, however.
		2344
		2345	=cut
		2346
		2347	sub destroy {
		2348	my ($self) = @_;
		2349
		2350	$self->DESTROY;
		2351	%$self = ();
		2352	bless $self, "AnyEvent::Handle::destroyed";
		2353	}
		2354
		2355	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2356	#nop
		2357	}
		2358
		2359	=item $handle->destroyed
		2360
		2361	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2362	->destroy >>, true otherwise.
		2363
		2364	Can be useful to decide whether the handle is still valid after some
		2365	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2366	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2367	can destroy the handle, so work can be avoided by checking sometimes:
		2368
		2369	$hdl->starttls ("accept");
		2370	return if $hdl->destroyed;
		2371	$hdl->push_write (...
		2372
		2373	Note that the call to C<push_write> will silently be ignored if the handle
		2374	has been destroyed, so often you can just ignore the possibility of the
		2375	handle being destroyed.
		2376
		2377	=cut
		2378
		2379	sub destroyed { 0 }
		2380	sub AnyEvent::Handle::destroyed::destroyed { 1 }
		2381
		2382	=item AnyEvent::Handle::TLS_CTX
		2383
		2384	This function creates and returns the AnyEvent::TLS object used by default
		2385	for TLS mode.
		2386
		2387	The context is created by calling L<AnyEvent::TLS> without any arguments.
		2388
		2389	=cut
		2390
		2391	our $TLS_CTX;
		2392
		2393	sub TLS_CTX() {
		2394	$TLS_CTX ||= do {
		2395	require AnyEvent::TLS;
		2396
		2397	new AnyEvent::TLS
		2398	}
		2399	}
		2400
		2401	=back
		2402
		2403
		2404	=head1 NONFREQUENTLY ASKED QUESTIONS
		2405
		2406	=over 4
		2407
		2408	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		2409	still get further invocations!
		2410
		2411	That's because AnyEvent::Handle keeps a reference to itself when handling
		2412	read or write callbacks.
		2413
		2414	It is only safe to "forget" the reference inside EOF or error callbacks,
		2415	from within all other callbacks, you need to explicitly call the C<<
		2416	->destroy >> method.
		2417
		2418	=item Why is my C<on_eof> callback never called?
		2419
		2420	Probably because your C<on_error> callback is being called instead: When
		2421	you have outstanding requests in your read queue, then an EOF is
		2422	considered an error as you clearly expected some data.
		2423
		2424	To avoid this, make sure you have an empty read queue whenever your handle
		2425	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2426	an C<on_read> handler that simply pushes the first read requests in the
		2427	queue.
		2428
		2429	See also the next question, which explains this in a bit more detail.
		2430
		2431	=item How can I serve requests in a loop?
		2432
		2433	Most protocols consist of some setup phase (authentication for example)
		2434	followed by a request handling phase, where the server waits for requests
		2435	and handles them, in a loop.
		2436
		2437	There are two important variants: The first (traditional, better) variant
		2438	handles requests until the server gets some QUIT command, causing it to
		2439	close the connection first (highly desirable for a busy TCP server). A
		2440	client dropping the connection is an error, which means this variant can
		2441	detect an unexpected detection close.
		2442
		2443	To handle this case, always make sure you have a non-empty read queue, by
		2444	pushing the "read request start" handler on it:
		2445
		2446	# we assume a request starts with a single line
		2447	my @start_request; @start_request = (line => sub {
		2448	my ($hdl, $line) = @_;
		2449
		2450	... handle request
		2451
		2452	# push next request read, possibly from a nested callback
		2453	$hdl->push_read (@start_request);
		2454	});
		2455
		2456	# auth done, now go into request handling loop
		2457	# now push the first @start_request
		2458	$hdl->push_read (@start_request);
		2459
		2460	By always having an outstanding C<push_read>, the handle always expects
		2461	some data and raises the C<EPIPE> error when the connction is dropped
		2462	unexpectedly.
		2463
		2464	The second variant is a protocol where the client can drop the connection
		2465	at any time. For TCP, this means that the server machine may run out of
		2466	sockets easier, and in general, it means you cannot distinguish a protocl
		2467	failure/client crash from a normal connection close. Nevertheless, these
		2468	kinds of protocols are common (and sometimes even the best solution to the
		2469	problem).
		2470
		2471	Having an outstanding read request at all times is possible if you ignore
		2472	C<EPIPE> errors, but this doesn't help with when the client drops the
		2473	connection during a request, which would still be an error.
		2474
		2475	A better solution is to push the initial request read in an C<on_read>
		2476	callback. This avoids an error, as when the server doesn't expect data
		2477	(i.e. is idly waiting for the next request, an EOF will not raise an
		2478	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2479	and simpler:
		2480
		2481	# auth done, now go into request handling loop
		2482	$hdl->on_read (sub {
		2483	my ($hdl) = @_;
		2484
		2485	# called each time we receive data but the read queue is empty
		2486	# simply start read the request
		2487
		2488	$hdl->push_read (line => sub {
		2489	my ($hdl, $line) = @_;
		2490
		2491	... handle request
		2492
		2493	# do nothing special when the request has been handled, just
		2494	# let the request queue go empty.
1397	});	2495	});
1398	push @linger, AnyEvent->timer (after => $linger, cb => sub {
1399	@linger = ();
1400	});	2496	});
		2497
		2498	=item I get different callback invocations in TLS mode/Why can't I pause
		2499	reading?
		2500
		2501	Unlike, say, TCP, TLS connections do not consist of two independent
		2502	communication channels, one for each direction. Or put differently, the
		2503	read and write directions are not independent of each other: you cannot
		2504	write data unless you are also prepared to read, and vice versa.
		2505
		2506	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
		2507	callback invocations when you are not expecting any read data - the reason
		2508	is that AnyEvent::Handle always reads in TLS mode.
		2509
		2510	During the connection, you have to make sure that you always have a
		2511	non-empty read-queue, or an C<on_read> watcher. At the end of the
		2512	connection (or when you no longer want to use it) you can call the
		2513	C<destroy> method.
		2514
		2515	=item How do I read data until the other side closes the connection?
		2516
		2517	If you just want to read your data into a perl scalar, the easiest way
		2518	to achieve this is by setting an C<on_read> callback that does nothing,
		2519	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		2520	will be in C<$_[0]{rbuf}>:
		2521
		2522	$handle->on_read (sub { });
		2523	$handle->on_eof (undef);
		2524	$handle->on_error (sub {
		2525	my $data = delete $_[0]{rbuf};
		2526	});
		2527
		2528	Note that this example removes the C<rbuf> member from the handle object,
		2529	which is not normally allowed by the API. It is expressly permitted in
		2530	this case only, as the handle object needs to be destroyed afterwards.
		2531
		2532	The reason to use C<on_error> is that TCP connections, due to latencies
		2533	and packets loss, might get closed quite violently with an error, when in
		2534	fact all data has been received.
		2535
		2536	It is usually better to use acknowledgements when transferring data,
		2537	to make sure the other side hasn't just died and you got the data
		2538	intact. This is also one reason why so many internet protocols have an
		2539	explicit QUIT command.
		2540
		2541	=item I don't want to destroy the handle too early - how do I wait until
		2542	all data has been written?
		2543
		2544	After writing your last bits of data, set the C<on_drain> callback
		2545	and destroy the handle in there - with the default setting of
		2546	C<low_water_mark> this will be called precisely when all data has been
		2547	written to the socket:
		2548
		2549	$handle->push_write (...);
		2550	$handle->on_drain (sub {
		2551	AE::log debug => "All data submitted to the kernel.";
		2552	undef $handle;
		2553	});
		2554
		2555	If you just want to queue some data and then signal EOF to the other side,
		2556	consider using C<< ->push_shutdown >> instead.
		2557
		2558	=item I want to contact a TLS/SSL server, I don't care about security.
		2559
		2560	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2561	connect to it and then create the AnyEvent::Handle with the C<tls>
		2562	parameter:
		2563
		2564	tcp_connect $host, $port, sub {
		2565	my ($fh) = @_;
		2566
		2567	my $handle = new AnyEvent::Handle
		2568	fh => $fh,
		2569	tls => "connect",
		2570	on_error => sub { ... };
		2571
		2572	$handle->push_write (...);
1401	}	2573	};
1402	}
1403		2574
1404	=item AnyEvent::Handle::TLS_CTX	2575	=item I want to contact a TLS/SSL server, I do care about security.
1405		2576
1406	This function creates and returns the Net::SSLeay::CTX object used by	2577	Then you should additionally enable certificate verification, including
1407	default for TLS mode.	2578	peername verification, if the protocol you use supports it (see
		2579	L<AnyEvent::TLS>, C<verify_peername>).
1408		2580
1409	The context is created like this:	2581	E.g. for HTTPS:
1410		2582
1411	Net::SSLeay::load_error_strings;	2583	tcp_connect $host, $port, sub {
1412	Net::SSLeay::SSLeay_add_ssl_algorithms;	2584	my ($fh) = @_;
1413	Net::SSLeay::randomize;
1414		2585
1415	my $CTX = Net::SSLeay::CTX_new;	2586	my $handle = new AnyEvent::Handle
		2587	fh => $fh,
		2588	peername => $host,
		2589	tls => "connect",
		2590	tls_ctx => { verify => 1, verify_peername => "https" },
		2591	...
1416		2592
1417	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL	2593	Note that you must specify the hostname you connected to (or whatever
		2594	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2595	peername verification will be done.
1418		2596
1419	=cut	2597	The above will use the system-dependent default set of trusted CA
		2598	certificates. If you want to check against a specific CA, add the
		2599	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
1420		2600
1421	our $TLS_CTX;	2601	tls_ctx => {
		2602	verify => 1,
		2603	verify_peername => "https",
		2604	ca_file => "my-ca-cert.pem",
		2605	},
1422		2606
1423	sub TLS_CTX() {	2607	=item I want to create a TLS/SSL server, how do I do that?
1424	$TLS_CTX || do {
1425	require Net::SSLeay;
1426		2608
1427	Net::SSLeay::load_error_strings ();	2609	Well, you first need to get a server certificate and key. You have
1428	Net::SSLeay::SSLeay_add_ssl_algorithms ();	2610	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
1429	Net::SSLeay::randomize ();	2611	self-signed certificate (cheap. check the search engine of your choice,
		2612	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2613	nice program for that purpose).
1430		2614
1431	$TLS_CTX = Net::SSLeay::CTX_new ();	2615	Then create a file with your private key (in PEM format, see
		2616	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2617	file should then look like this:
1432		2618
1433	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());	2619	-----BEGIN RSA PRIVATE KEY-----
		2620	...header data
		2621	... lots of base64'y-stuff
		2622	-----END RSA PRIVATE KEY-----
1434		2623
1435	$TLS_CTX	2624	-----BEGIN CERTIFICATE-----
1436	}	2625	... lots of base64'y-stuff
1437	}	2626	-----END CERTIFICATE-----
		2627
		2628	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2629	specify this file as C<cert_file>:
		2630
		2631	tcp_server undef, $port, sub {
		2632	my ($fh) = @_;
		2633
		2634	my $handle = new AnyEvent::Handle
		2635	fh => $fh,
		2636	tls => "accept",
		2637	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2638	...
		2639
		2640	When you have intermediate CA certificates that your clients might not
		2641	know about, just append them to the C<cert_file>.
1438		2642
1439	=back	2643	=back
1440		2644
1441	=head1 SUBCLASSING AnyEvent::Handle	2645	=head1 SUBCLASSING AnyEvent::Handle
1442		2646
…		…
1448	=over 4	2652	=over 4
1449		2653
1450	=item * all constructor arguments become object members.	2654	=item * all constructor arguments become object members.
1451		2655
1452	At least initially, when you pass a C<tls>-argument to the constructor it	2656	At least initially, when you pass a C<tls>-argument to the constructor it
1453	will end up in C<< $handle->{tls} >>. Those members might be changes or	2657	will end up in C<< $handle->{tls} >>. Those members might be changed or
1454	mutated later on (for example C<tls> will hold the TLS connection object).	2658	mutated later on (for example C<tls> will hold the TLS connection object).
1455		2659
1456	=item * other object member names are prefixed with an C<_>.	2660	=item * other object member names are prefixed with an C<_>.
1457		2661
1458	All object members not explicitly documented (internal use) are prefixed	2662	All object members not explicitly documented (internal use) are prefixed
…		…
1461		2665
1462	=item * all members not documented here and not prefixed with an underscore	2666	=item * all members not documented here and not prefixed with an underscore
1463	are free to use in subclasses.	2667	are free to use in subclasses.
1464		2668
1465	Of course, new versions of AnyEvent::Handle may introduce more "public"	2669	Of course, new versions of AnyEvent::Handle may introduce more "public"
1466	member variables, but thats just life, at least it is documented.	2670	member variables, but that's just life. At least it is documented.
1467		2671
1468	=back	2672	=back
1469		2673
1470	=head1 AUTHOR	2674	=head1 AUTHOR
1471		2675
1472	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2676	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
1473		2677
1474	=cut	2678	=cut
1475		2679
1476	1; # End of AnyEvent::Handle	2680	1
		2681

Diff Legend

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