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.112 by root, Wed Jan 21 06:01:35 2009 UTC vs.
Revision 1.239 by root, Tue Dec 10 20:39:12 2013 UTC

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

Diff Legend

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