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.79 by root, Sun Jul 27 08:37:56 2008 UTC vs.
Revision 1.238 by root, Tue Dec 10 15:54:51 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.22;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
32	$cv->broadcast;	15	my ($hdl, $fatal, $msg) = @_;
33	},	16	AE::log error => $msg;
		17	$hdl->destroy;
		18	$cv->send;
34	);	19	};
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	say "got line <$line>";
43	$cv->send;	28	$cv->send;
44	});	29	});
45		30
46	$cv->recv;	31	$cv->recv;
47		32
48	=head1 DESCRIPTION	33	=head1 DESCRIPTION
49		34
50	This module is a helper module to make it easier to do event-based I/O on	35	This is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	36	stream-based filehandles (sockets, pipes, and other stream things).
52	on sockets see L<AnyEvent::Util>.
53		37
		38	The L<AnyEvent::Intro> tutorial contains some well-documented
		39	AnyEvent::Handle examples.
		40
54	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
55	means characters. As sysread and syswrite are used for all I/O, their	42	characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
57		47
58	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
59	argument.	49	argument.
60		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
		80	sub MAX_READ_SIZE() { 131072 }
		81
61	=head1 METHODS	82	=head1 METHODS
62		83
63	=over 4	84	=over 4
64		85
65	=item B<new (%args)>	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
66		87
67	The constructor supports these arguments (all as key => value pairs).	88	The constructor supports these arguments (all as C<< key => value >> pairs).
68		89
69	=over 4	90	=over 4
70		91
71	=item fh => $filehandle [MANDATORY]	92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
72		93
73	The filehandle this L<AnyEvent::Handle> object will operate on.	94	The filehandle this L<AnyEvent::Handle> object will operate on.
74
75	NOTE: The filehandle will be set to non-blocking (using	95	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	96	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		97	that mode.
77		98
		99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		100
		101	Try to connect to the specified host and service (port), using
		102	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		103	default C<peername>.
		104
		105	You have to specify either this parameter, or C<fh>, above.
		106
		107	It is possible to push requests on the read and write queues, and modify
		108	properties of the stream, even while AnyEvent::Handle is connecting.
		109
		110	When this parameter is specified, then the C<on_prepare>,
		111	C<on_connect_error> and C<on_connect> callbacks will be called under the
		112	appropriate circumstances:
		113
		114	=over 4
		115
78	=item on_eof => $cb->($handle)	116	=item on_prepare => $cb->($handle)
79		117
80	Set the callback to be called when an end-of-file condition is detected,	118	This (rarely used) callback is called before a new connection is
81	i.e. in the case of a socket, when the other side has closed the	119	attempted, but after the file handle has been created (you can access that
82	connection cleanly.	120	file handle via C<< $handle->{fh} >>). It could be used to prepare the
		121	file handle with parameters required for the actual connect (as opposed to
		122	settings that can be changed when the connection is already established).
83		123
84	While not mandatory, it is highly recommended to set an eof callback,	124	The return value of this callback should be the connect timeout value in
85	otherwise you might end up with a closed socket while you are still	125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
86	waiting for data.	126	default timeout is to be used).
87		127
		128	=item on_connect => $cb->($handle, $host, $port, $retry->())
		129
		130	This callback is called when a connection has been successfully established.
		131
		132	The peer's numeric host and port (the socket peername) are passed as
		133	parameters, together with a retry callback. At the time it is called the
		134	read and write queues, EOF status, TLS status and similar properties of
		135	the handle will have been reset.
		136
		137	It is not allowed to use the read or write queues while the handle object
		138	is connecting.
		139
		140	If, for some reason, the handle is not acceptable, calling C<$retry> will
		141	continue with the next connection target (in case of multi-homed hosts or
		142	SRV records there can be multiple connection endpoints). The C<$retry>
		143	callback can be invoked after the connect callback returns, i.e. one can
		144	start a handshake and then decide to retry with the next host if the
		145	handshake fails.
		146
		147	In most cases, you should ignore the C<$retry> parameter.
		148
		149	=item on_connect_error => $cb->($handle, $message)
		150
		151	This callback is called when the connection could not be
		152	established. C<$!> will contain the relevant error code, and C<$message> a
		153	message describing it (usually the same as C<"$!">).
		154
		155	If this callback isn't specified, then C<on_error> will be called with a
		156	fatal error instead.
		157
		158	=back
		159
88	=item on_error => $cb->($handle, $fatal)	160	=item on_error => $cb->($handle, $fatal, $message)
89		161
90	This is the error callback, which is called when, well, some error	162	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	163	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	164	connect, or a read error.
93		165
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	166	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	167	fatal errors the handle object will be destroyed (by a call to C<< ->
		168	destroy >>) after invoking the error callback (which means you are free to
		169	examine the handle object). Examples of fatal errors are an EOF condition
		170	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
		171	cases where the other side can close the connection at will, it is
		172	often easiest to not report C<EPIPE> errors in this callback.
		173
		174	AnyEvent::Handle tries to find an appropriate error code for you to check
		175	against, but in some cases (TLS errors), this does not work well.
		176
		177	If you report the error to the user, it is recommended to always output
		178	the C<$message> argument in human-readable error messages (you don't need
		179	to report C<"$!"> if you report C<$message>).
		180
		181	If you want to react programmatically to the error, then looking at C<$!>
		182	and comparing it against some of the documented C<Errno> values is usually
		183	better than looking at the C<$message>.
		184
96	usable. Non-fatal errors can be retried by simply returning, but it is	185	Non-fatal errors can be retried by returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	186	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	187	when this callback is invoked. Examples of non-fatal errors are timeouts
		188	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		189
100	On callback entrance, the value of C<$!> contains the operating system	190	On entry to the callback, the value of C<$!> contains the operating
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	191	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		192	C<EPROTO>).
102		193
103	While not mandatory, it is I<highly> recommended to set this callback, as	194	While not mandatory, it is I<highly> recommended to set this callback, as
104	you will not be notified of errors otherwise. The default simply calls	195	you will not be notified of errors otherwise. The default just calls
105	C<croak>.	196	C<croak>.
106		197
107	=item on_read => $cb->($handle)	198	=item on_read => $cb->($handle)
108		199
109	This sets the default read callback, which is called when data arrives	200	This sets the default read callback, which is called when data arrives
110	and no read request is in the queue (unlike read queue callbacks, this	201	and no read request is in the queue (unlike read queue callbacks, this
111	callback will only be called when at least one octet of data is in the	202	callback will only be called when at least one octet of data is in the
112	read buffer).	203	read buffer).
113		204
114	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	205	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
115	method or access the C<$handle->{rbuf}> member directly.	206	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		207	must not enlarge or modify the read buffer, you can only remove data at
		208	the beginning from it.
116		209
		210	You can also call C<< ->push_read (...) >> or any other function that
		211	modifies the read queue. Or do both. Or ...
		212
117	When an EOF condition is detected then AnyEvent::Handle will first try to	213	When an EOF condition is detected, AnyEvent::Handle will first try to
118	feed all the remaining data to the queued callbacks and C<on_read> before	214	feed all the remaining data to the queued callbacks and C<on_read> before
119	calling the C<on_eof> callback. If no progress can be made, then a fatal	215	calling the C<on_eof> callback. If no progress can be made, then a fatal
120	error will be raised (with C<$!> set to C<EPIPE>).	216	error will be raised (with C<$!> set to C<EPIPE>).
121		217
		218	Note that, unlike requests in the read queue, an C<on_read> callback
		219	doesn't mean you I<require> some data: if there is an EOF and there
		220	are outstanding read requests then an error will be flagged. With an
		221	C<on_read> callback, the C<on_eof> callback will be invoked.
		222
		223	=item on_eof => $cb->($handle)
		224
		225	Set the callback to be called when an end-of-file condition is detected,
		226	i.e. in the case of a socket, when the other side has closed the
		227	connection cleanly, and there are no outstanding read requests in the
		228	queue (if there are read requests, then an EOF counts as an unexpected
		229	connection close and will be flagged as an error).
		230
		231	For sockets, this just means that the other side has stopped sending data,
		232	you can still try to write data, and, in fact, one can return from the EOF
		233	callback and continue writing data, as only the read part has been shut
		234	down.
		235
		236	If an EOF condition has been detected but no C<on_eof> callback has been
		237	set, then a fatal error will be raised with C<$!> set to <0>.
		238
122	=item on_drain => $cb->($handle)	239	=item on_drain => $cb->($handle)
123		240
124	This sets the callback that is called when the write buffer becomes empty	241	This sets the callback that is called once when the write buffer becomes
125	(or when the callback is set and the buffer is empty already).	242	empty (and immediately when the handle object is created).
126		243
127	To append to the write buffer, use the C<< ->push_write >> method.	244	To append to the write buffer, use the C<< ->push_write >> method.
128		245
129	This callback is useful when you don't want to put all of your write data	246	This callback is useful when you don't want to put all of your write data
130	into the queue at once, for example, when you want to write the contents	247	into the queue at once, for example, when you want to write the contents
…		…
132	memory and push it into the queue, but instead only read more data from	249	memory and push it into the queue, but instead only read more data from
133	the file when the write queue becomes empty.	250	the file when the write queue becomes empty.
134		251
135	=item timeout => $fractional_seconds	252	=item timeout => $fractional_seconds
136		253
		254	=item rtimeout => $fractional_seconds
		255
		256	=item wtimeout => $fractional_seconds
		257
137	If non-zero, then this enables an "inactivity" timeout: whenever this many	258	If non-zero, then these enables an "inactivity" timeout: whenever this
138	seconds pass without a successful read or write on the underlying file	259	many seconds pass without a successful read or write on the underlying
139	handle, the C<on_timeout> callback will be invoked (and if that one is	260	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
140	missing, an C<ETIMEDOUT> error will be raised).	261	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		262	error will be raised).
141		263
		264	There are three variants of the timeouts that work independently of each
		265	other, for both read and write (triggered when nothing was read I<OR>
		266	written), just read (triggered when nothing was read), and just write:
		267	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		268	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		269	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
		270
142	Note that timeout processing is also active when you currently do not have	271	Note that timeout processing is active even when you do not have any
143	any outstanding read or write requests: If you plan to keep the connection	272	outstanding read or write requests: If you plan to keep the connection
144	idle then you should disable the timout temporarily or ignore the timeout	273	idle then you should disable the timeout temporarily or ignore the
145	in the C<on_timeout> callback.	274	timeout in the corresponding C<on_timeout> callback, in which case
		275	AnyEvent::Handle will simply restart the timeout.
146		276
147	Zero (the default) disables this timeout.	277	Zero (the default) disables the corresponding timeout.
148		278
149	=item on_timeout => $cb->($handle)	279	=item on_timeout => $cb->($handle)
		280
		281	=item on_rtimeout => $cb->($handle)
		282
		283	=item on_wtimeout => $cb->($handle)
150		284
151	Called whenever the inactivity timeout passes. If you return from this	285	Called whenever the inactivity timeout passes. If you return from this
152	callback, then the timeout will be reset as if some activity had happened,	286	callback, then the timeout will be reset as if some activity had happened,
153	so this condition is not fatal in any way.	287	so this condition is not fatal in any way.
154		288
155	=item rbuf_max => <bytes>	289	=item rbuf_max => <bytes>
156		290
157	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	291	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
158	when the read buffer ever (strictly) exceeds this size. This is useful to	292	when the read buffer ever (strictly) exceeds this size. This is useful to
159	avoid denial-of-service attacks.	293	avoid some forms of denial-of-service attacks.
160		294
161	For example, a server accepting connections from untrusted sources should	295	For example, a server accepting connections from untrusted sources should
162	be configured to accept only so-and-so much data that it cannot act on	296	be configured to accept only so-and-so much data that it cannot act on
163	(for example, when expecting a line, an attacker could send an unlimited	297	(for example, when expecting a line, an attacker could send an unlimited
164	amount of data without a callback ever being called as long as the line	298	amount of data without a callback ever being called as long as the line
165	isn't finished).	299	isn't finished).
166		300
		301	=item wbuf_max => <bytes>
		302
		303	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
		304	when the write buffer ever (strictly) exceeds this size. This is useful to
		305	avoid some forms of denial-of-service attacks.
		306
		307	Although the units of this parameter is bytes, this is the I<raw> number
		308	of bytes not yet accepted by the kernel. This can make a difference when
		309	you e.g. use TLS, as TLS typically makes your write data larger (but it
		310	can also make it smaller due to compression).
		311
		312	As an example of when this limit is useful, take a chat server that sends
		313	chat messages to a client. If the client does not read those in a timely
		314	manner then the send buffer in the server would grow unbounded.
		315
167	=item autocork => <boolean>	316	=item autocork => <boolean>
168		317
169	When disabled (the default), then C<push_write> will try to immediately	318	When disabled (the default), C<push_write> will try to immediately
170	write the data to the handle if possible. This avoids having to register	319	write the data to the handle if possible. This avoids having to register
171	a write watcher and wait for the next event loop iteration, but can be	320	a write watcher and wait for the next event loop iteration, but can
172	inefficient if you write multiple small chunks (this disadvantage is	321	be inefficient if you write multiple small chunks (on the wire, this
173	usually avoided by your kernel's nagle algorithm, see C<low_delay>).	322	disadvantage is usually avoided by your kernel's nagle algorithm, see
		323	C<no_delay>, but this option can save costly syscalls).
174		324
175	When enabled, then writes will always be queued till the next event loop	325	When enabled, writes will always be queued till the next event loop
176	iteration. This is efficient when you do many small writes per iteration,	326	iteration. This is efficient when you do many small writes per iteration,
177	but less efficient when you do a single write only.	327	but less efficient when you do a single write only per iteration (or when
		328	the write buffer often is full). It also increases write latency.
178		329
179	=item no_delay => <boolean>	330	=item no_delay => <boolean>
180		331
181	When doing small writes on sockets, your operating system kernel might	332	When doing small writes on sockets, your operating system kernel might
182	wait a bit for more data before actually sending it out. This is called	333	wait a bit for more data before actually sending it out. This is called
183	the Nagle algorithm, and usually it is beneficial.	334	the Nagle algorithm, and usually it is beneficial.
184		335
185	In some situations you want as low a delay as possible, which cna be	336	In some situations you want as low a delay as possible, which can be
186	accomplishd by setting this option to true.	337	accomplishd by setting this option to a true value.
187		338
188	The default is your opertaing system's default behaviour, this option	339	The default is your operating system's default behaviour (most likely
189	explicitly enables or disables it, if possible.	340	enabled). This option explicitly enables or disables it, if possible.
		341
		342	=item keepalive => <boolean>
		343
		344	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		345	normally, TCP connections have no time-out once established, so TCP
		346	connections, once established, can stay alive forever even when the other
		347	side has long gone. TCP keepalives are a cheap way to take down long-lived
		348	TCP connections when the other side becomes unreachable. While the default
		349	is OS-dependent, TCP keepalives usually kick in after around two hours,
		350	and, if the other side doesn't reply, take down the TCP connection some 10
		351	to 15 minutes later.
		352
		353	It is harmless to specify this option for file handles that do not support
		354	keepalives, and enabling it on connections that are potentially long-lived
		355	is usually a good idea.
		356
		357	=item oobinline => <boolean>
		358
		359	BSD majorly fucked up the implementation of TCP urgent data. The result
		360	is that almost no OS implements TCP according to the specs, and every OS
		361	implements it slightly differently.
		362
		363	If you want to handle TCP urgent data, then setting this flag (the default
		364	is enabled) gives you the most portable way of getting urgent data, by
		365	putting it into the stream.
		366
		367	Since BSD emulation of OOB data on top of TCP's urgent data can have
		368	security implications, AnyEvent::Handle sets this flag automatically
		369	unless explicitly specified. Note that setting this flag after
		370	establishing a connection I<may> be a bit too late (data loss could
		371	already have occured on BSD systems), but at least it will protect you
		372	from most attacks.
190		373
191	=item read_size => <bytes>	374	=item read_size => <bytes>
192		375
193	The default read block size (the amount of bytes this module will try to read	376	The initial read block size, the number of bytes this module will try
194	during each (loop iteration). Default: C<8192>.	377	to read during each loop iteration. Each handle object will consume
		378	at least this amount of memory for the read buffer as well, so when
		379	handling many connections watch out for memory requirements). See also
		380	C<max_read_size>. Default: C<2048>.
		381
		382	=item max_read_size => <bytes>
		383
		384	The maximum read buffer size used by the dynamic adjustment
		385	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
		386	one go it will double C<read_size> up to the maximum given by this
		387	option. Default: C<131072> or C<read_size>, whichever is higher.
195		388
196	=item low_water_mark => <bytes>	389	=item low_water_mark => <bytes>
197		390
198	Sets the amount of bytes (default: C<0>) that make up an "empty" write	391	Sets the number of bytes (default: C<0>) that make up an "empty" write
199	buffer: If the write reaches this size or gets even samller it is	392	buffer: If the buffer reaches this size or gets even samller it is
200	considered empty.	393	considered empty.
201		394
		395	Sometimes it can be beneficial (for performance reasons) to add data to
		396	the write buffer before it is fully drained, but this is a rare case, as
		397	the operating system kernel usually buffers data as well, so the default
		398	is good in almost all cases.
		399
202	=item linger => <seconds>	400	=item linger => <seconds>
203		401
204	If non-zero (default: C<3600>), then the destructor of the	402	If this is non-zero (default: C<3600>), the destructor of the
205	AnyEvent::Handle object will check wether there is still outstanding write	403	AnyEvent::Handle object will check whether there is still outstanding
206	data and will install a watcher that will write out this data. No errors	404	write data and will install a watcher that will write this data to the
207	will be reported (this mostly matches how the operating system treats	405	socket. No errors will be reported (this mostly matches how the operating
208	outstanding data at socket close time).	406	system treats outstanding data at socket close time).
209		407
210	This will not work for partial TLS data that could not yet been	408	This will not work for partial TLS data that could not be encoded
211	encoded. This data will be lost.	409	yet. This data will be lost. Calling the C<stoptls> method in time might
		410	help.
		411
		412	=item peername => $string
		413
		414	A string used to identify the remote site - usually the DNS hostname
		415	(I<not> IDN!) used to create the connection, rarely the IP address.
		416
		417	Apart from being useful in error messages, this string is also used in TLS
		418	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		419	verification will be skipped when C<peername> is not specified or is
		420	C<undef>.
212		421
213	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	422	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
214		423
215	When this parameter is given, it enables TLS (SSL) mode, that means it	424	When this parameter is given, it enables TLS (SSL) mode, that means
216	will start making tls handshake and will transparently encrypt/decrypt	425	AnyEvent will start a TLS handshake as soon as the connection has been
217	data.	426	established and will transparently encrypt/decrypt data afterwards.
		427
		428	All TLS protocol errors will be signalled as C<EPROTO>, with an
		429	appropriate error message.
218		430
219	TLS mode requires Net::SSLeay to be installed (it will be loaded	431	TLS mode requires Net::SSLeay to be installed (it will be loaded
220	automatically when you try to create a TLS handle).	432	automatically when you try to create a TLS handle): this module doesn't
		433	have a dependency on that module, so if your module requires it, you have
		434	to add the dependency yourself. If Net::SSLeay cannot be loaded or is too
		435	old, you get an C<EPROTO> error.
221		436
222	For the TLS server side, use C<accept>, and for the TLS client side of a	437	Unlike TCP, TLS has a server and client side: for the TLS server side, use
223	connection, use C<connect> mode.	438	C<accept>, and for the TLS client side of a connection, use C<connect>
		439	mode.
224		440
225	You can also provide your own TLS connection object, but you have	441	You can also provide your own TLS connection object, but you have
226	to make sure that you call either C<Net::SSLeay::set_connect_state>	442	to make sure that you call either C<Net::SSLeay::set_connect_state>
227	or C<Net::SSLeay::set_accept_state> on it before you pass it to	443	or C<Net::SSLeay::set_accept_state> on it before you pass it to
228	AnyEvent::Handle.	444	AnyEvent::Handle. Also, this module will take ownership of this connection
		445	object.
229		446
		447	At some future point, AnyEvent::Handle might switch to another TLS
		448	implementation, then the option to use your own session object will go
		449	away.
		450
		451	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		452	passing in the wrong integer will lead to certain crash. This most often
		453	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		454	segmentation fault.
		455
230	See the C<starttls> method if you need to start TLS negotiation later.	456	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
231		457
232	=item tls_ctx => $ssl_ctx	458	=item tls_ctx => $anyevent_tls
233		459
234	Use the given Net::SSLeay::CTX object to create the new TLS connection	460	Use the given C<AnyEvent::TLS> object to create the new TLS connection
235	(unless a connection object was specified directly). If this parameter is	461	(unless a connection object was specified directly). If this
236	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	462	parameter is missing (or C<undef>), then AnyEvent::Handle will use
		463	C<AnyEvent::Handle::TLS_CTX>.
237		464
		465	Instead of an object, you can also specify a hash reference with C<< key
		466	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		467	new TLS context object.
		468
		469	=item on_starttls => $cb->($handle, $success[, $error_message])
		470
		471	This callback will be invoked when the TLS/SSL handshake has finished. If
		472	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		473	(C<on_stoptls> will not be called in this case).
		474
		475	The session in C<< $handle->{tls} >> can still be examined in this
		476	callback, even when the handshake was not successful.
		477
		478	TLS handshake failures will not cause C<on_error> to be invoked when this
		479	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		480
		481	Without this callback, handshake failures lead to C<on_error> being
		482	called as usual.
		483
		484	Note that you cannot just call C<starttls> again in this callback. If you
		485	need to do that, start an zero-second timer instead whose callback can
		486	then call C<< ->starttls >> again.
		487
		488	=item on_stoptls => $cb->($handle)
		489
		490	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		491	set, then it will be invoked after freeing the TLS session. If it is not,
		492	then a TLS shutdown condition will be treated like a normal EOF condition
		493	on the handle.
		494
		495	The session in C<< $handle->{tls} >> can still be examined in this
		496	callback.
		497
		498	This callback will only be called on TLS shutdowns, not when the
		499	underlying handle signals EOF.
		500
238	=item json => JSON or JSON::XS object	501	=item json => L<JSON> or L<JSON::XS> object
239		502
240	This is the json coder object used by the C<json> read and write types.	503	This is the json coder object used by the C<json> read and write types.
241		504
242	If you don't supply it, then AnyEvent::Handle will create and use a	505	If you don't supply it, then AnyEvent::Handle will create and use a
243	suitable one, which will write and expect UTF-8 encoded JSON texts.	506	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		507	texts.
244		508
245	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
246	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.
247		512
248	=item filter_r => $cb	513	=item cbor => L<CBOR::XS> object
249		514
250	=item filter_w => $cb	515	This is the cbor coder object used by the C<cbor> read and write types.
251		516
252	These exist, but are undocumented at this time.	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.
253		524
254	=back	525	=back
255		526
256	=cut	527	=cut
257		528
258	sub new {	529	sub new {
259	my $class = shift;	530	my $class = shift;
260
261	my $self = bless { @_ }, $class;	531	my $self = bless { @_ }, $class;
262		532
263	$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;
264		604
265	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	605	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
266		606
267	if ($self->{tls}) {	607	$self->{_activity} =
268	require Net::SSLeay;	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
269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	624	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
270	}	625	if $self->{tls};
271		626
272	$self->{_activity} = AnyEvent->now;
273	$self->_timeout;
274
275	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	627	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
276	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
277		628
278	$self->start_read	629	$self->start_read
279	if $self->{on_read};	630	if $self->{on_read} || @{ $self->{_queue} };
280		631
281	$self	632	$self->_drain_wbuf;
282	}
283
284	sub _shutdown {
285	my ($self) = @_;
286
287	delete $self->{_tw};
288	delete $self->{_rw};
289	delete $self->{_ww};
290	delete $self->{fh};
291
292	$self->stoptls;
293	}	633	}
294		634
295	sub _error {	635	sub _error {
296	my ($self, $errno, $fatal) = @_;	636	my ($self, $errno, $fatal, $message) = @_;
297
298	$self->_shutdown
299	if $fatal;
300		637
301	$! = $errno;	638	$! = $errno;
		639	$message ||= "$!";
302		640
303	if ($self->{on_error}) {	641	if ($self->{on_error}) {
304	$self->{on_error}($self, $fatal);	642	$self->{on_error}($self, $fatal, $message);
305	} else {	643	$self->destroy if $fatal;
		644	} elsif ($self->{fh} || $self->{connect}) {
		645	$self->destroy;
306	Carp::croak "AnyEvent::Handle uncaught error: $!";	646	Carp::croak "AnyEvent::Handle uncaught error: $message";
307	}	647	}
308	}	648	}
309		649
310	=item $fh = $handle->fh	650	=item $fh = $handle->fh
311		651
312	This method returns the file handle of the L<AnyEvent::Handle> object.	652	This method returns the file handle used to create the L<AnyEvent::Handle> object.
313		653
314	=cut	654	=cut
315		655
316	sub fh { $_[0]{fh} }	656	sub fh { $_[0]{fh} }
317		657
…		…
335	$_[0]{on_eof} = $_[1];	675	$_[0]{on_eof} = $_[1];
336	}	676	}
337		677
338	=item $handle->on_timeout ($cb)	678	=item $handle->on_timeout ($cb)
339		679
340	Replace the current C<on_timeout> callback, or disables the callback	680	=item $handle->on_rtimeout ($cb)
341	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
342	argument.
343		681
344	=cut	682	=item $handle->on_wtimeout ($cb)
345		683
346	sub on_timeout {	684	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
347	$_[0]{on_timeout} = $_[1];	685	callback, or disables the callback (but not the timeout) if C<$cb> =
348	}	686	C<undef>. See the C<timeout> constructor argument and method.
		687
		688	=cut
		689
		690	# see below
349		691
350	=item $handle->autocork ($boolean)	692	=item $handle->autocork ($boolean)
351		693
352	Enables or disables the current autocork behaviour (see C<autocork>	694	Enables or disables the current autocork behaviour (see C<autocork>
353	constructor argument).	695	constructor argument). Changes will only take effect on the next write.
354		696
355	=cut	697	=cut
		698
		699	sub autocork {
		700	$_[0]{autocork} = $_[1];
		701	}
356		702
357	=item $handle->no_delay ($boolean)	703	=item $handle->no_delay ($boolean)
358		704
359	Enables or disables the C<no_delay> setting (see constructor argument of	705	Enables or disables the C<no_delay> setting (see constructor argument of
360	the same name for details).	706	the same name for details).
…		…
362	=cut	708	=cut
363		709
364	sub no_delay {	710	sub no_delay {
365	$_[0]{no_delay} = $_[1];	711	$_[0]{no_delay} = $_[1];
366		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
367	eval {	727	eval {
368	local $SIG{__DIE__};	728	local $SIG{__DIE__};
369	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};
370	};	731	};
371	}	732	}
372		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
373	#############################################################################	806	#############################################################################
374		807
375	=item $handle->timeout ($seconds)	808	=item $handle->timeout ($seconds)
376		809
		810	=item $handle->rtimeout ($seconds)
		811
		812	=item $handle->wtimeout ($seconds)
		813
377	Configures (or disables) the inactivity timeout.	814	Configures (or disables) the inactivity timeout.
378		815
379	=cut	816	The timeout will be checked instantly, so this method might destroy the
		817	handle before it returns.
380		818
381	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 {
382	my ($self, $timeout) = @_;	843	my ($self, $new_value) = @_;
383		844
		845	$new_value >= 0
		846	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		847
384	$self->{timeout} = $timeout;	848	$self->{$timeout} = $new_value;
385	$self->_timeout;	849	delete $self->{$tw}; &$cb;
386	}	850	};
387		851
		852	*{"${dir}timeout_reset"} = sub {
		853	$_[0]{$activity} = AE::now;
		854	};
		855
		856	# main workhorse:
388	# reset the timeout watcher, as neccessary	857	# reset the timeout watcher, as neccessary
389	# also check for time-outs	858	# also check for time-outs
390	sub _timeout {	859	$cb = sub {
391	my ($self) = @_;	860	my ($self) = @_;
392		861
393	if ($self->{timeout}) {	862	if ($self->{$timeout} && $self->{fh}) {
394	my $NOW = AnyEvent->now;	863	my $NOW = AE::now;
395		864
396	# when would the timeout trigger?	865	# when would the timeout trigger?
397	my $after = $self->{_activity} + $self->{timeout} - $NOW;	866	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
398		867
399	# now or in the past already?	868	# now or in the past already?
400	if ($after <= 0) {	869	if ($after <= 0) {
401	$self->{_activity} = $NOW;	870	$self->{$activity} = $NOW;
402		871
403	if ($self->{on_timeout}) {	872	if ($self->{$on_timeout}) {
404	$self->{on_timeout}($self);	873	$self->{$on_timeout}($self);
405	} else {	874	} else {
406	$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};
407	}	883	}
408		884
409	# callback could have changed timeout value, optimise	885	Scalar::Util::weaken $self;
410	return unless $self->{timeout};	886	return unless $self; # ->error could have destroyed $self
411		887
412	# calculate new after	888	$self->{$tw} ||= AE::timer $after, 0, sub {
413	$after = $self->{timeout};	889	delete $self->{$tw};
		890	$cb->($self);
		891	};
		892	} else {
		893	delete $self->{$tw};
414	}	894	}
415
416	Scalar::Util::weaken $self;
417	return unless $self; # ->error could have destroyed $self
418
419	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
420	delete $self->{_tw};
421	$self->_timeout;
422	});
423	} else {
424	delete $self->{_tw};
425	}	895	}
426	}	896	}
427		897
428	#############################################################################	898	#############################################################################
429		899
…		…
436		906
437	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
438	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.
439		909
440	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
441	water mark, the C<on_drain> callback will be invoked.	911	water mark, the C<on_drain> callback will be invoked once.
442		912
443	=over 4	913	=over 4
444		914
445	=item $handle->on_drain ($cb)	915	=item $handle->on_drain ($cb)
446		916
447	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
448	C<on_drain> in the constructor).	918	C<on_drain> in the constructor).
449		919
		920	This method may invoke callbacks (and therefore the handle might be
		921	destroyed after it returns).
		922
450	=cut	923	=cut
451		924
452	sub on_drain {	925	sub on_drain {
453	my ($self, $cb) = @_;	926	my ($self, $cb) = @_;
454		927
455	$self->{on_drain} = $cb;	928	$self->{on_drain} = $cb;
456		929
457	$cb->($self)	930	$cb->($self)
458	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	931	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
459	}	932	}
460		933
461	=item $handle->push_write ($data)	934	=item $handle->push_write ($data)
462		935
463	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
464	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
465	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).
466		942
467	=cut	943	=cut
468		944
469	sub _drain_wbuf {	945	sub _drain_wbuf {
470	my ($self) = @_;	946	my ($self) = @_;
…		…
474	Scalar::Util::weaken $self;	950	Scalar::Util::weaken $self;
475		951
476	my $cb = sub {	952	my $cb = sub {
477	my $len = syswrite $self->{fh}, $self->{wbuf};	953	my $len = syswrite $self->{fh}, $self->{wbuf};
478		954
479	if ($len >= 0) {	955	if (defined $len) {
480	substr $self->{wbuf}, 0, $len, "";	956	substr $self->{wbuf}, 0, $len, "";
481		957
482	$self->{_activity} = AnyEvent->now;	958	$self->{_activity} = $self->{_wactivity} = AE::now;
483		959
484	$self->{on_drain}($self)	960	$self->{on_drain}($self)
485	if $self->{low_water_mark} >= length $self->{wbuf}	961	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
486	&& $self->{on_drain};	962	&& $self->{on_drain};
487		963
488	delete $self->{_ww} unless length $self->{wbuf};	964	delete $self->{_ww} unless length $self->{wbuf};
489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	965	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
490	$self->_error ($!, 1);	966	$self->_error ($!, 1);
…		…
493		969
494	# try to write data immediately	970	# try to write data immediately
495	$cb->() unless $self->{autocork};	971	$cb->() unless $self->{autocork};
496		972
497	# if still data left in wbuf, we need to poll	973	# if still data left in wbuf, we need to poll
498	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	974	$self->{_ww} = AE::io $self->{fh}, 1, $cb
499	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	}
500	};	983	};
501	}	984	}
502		985
503	our %WH;	986	our %WH;
504		987
		988	# deprecated
505	sub register_write_type($$) {	989	sub register_write_type($$) {
506	$WH{$_[0]} = $_[1];	990	$WH{$_[0]} = $_[1];
507	}	991	}
508		992
509	sub push_write {	993	sub push_write {
510	my $self = shift;	994	my $self = shift;
511		995
512	if (@_ > 1) {	996	if (@_ > 1) {
513	my $type = shift;	997	my $type = shift;
514		998
		999	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
515	@_ = ($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")
516	->($self, @_);	1001	->($self, @_);
517	}	1002	}
518		1003
		1004	# we downgrade here to avoid hard-to-track-down bugs,
		1005	# and diagnose the problem earlier and better.
		1006
519	if ($self->{filter_w}) {	1007	if ($self->{tls}) {
520	$self->{filter_w}($self, \$_[0]);	1008	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
		1009	&_dotls ($self) if $self->{fh};
521	} else {	1010	} else {
522	$self->{wbuf} .= $_[0];	1011	utf8::downgrade $self->{wbuf} .= $_[0];
523	$self->_drain_wbuf;	1012	$self->_drain_wbuf if $self->{fh};
524	}	1013	}
525	}	1014	}
526		1015
527	=item $handle->push_write (type => @args)	1016	=item $handle->push_write (type => @args)
528		1017
529	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
530	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).
531		1023
532	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
533	drop by and tell us):	1025	drop by and tell us):
534		1026
535	=over 4	1027	=over 4
…		…
542	=cut	1034	=cut
543		1035
544	register_write_type netstring => sub {	1036	register_write_type netstring => sub {
545	my ($self, $string) = @_;	1037	my ($self, $string) = @_;
546		1038
547	sprintf "%d:%s,", (length $string), $string	1039	(length $string) . ":$string,"
548	};	1040	};
549		1041
550	=item packstring => $format, $data	1042	=item packstring => $format, $data
551		1043
552	An octet string prefixed with an encoded length. The encoding C<$format>	1044	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
574		1066
575	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
576	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
577	able to read them, many other languages depend on that.	1069	able to read them, many other languages depend on that.
578		1070
579	A simple RPC protocol that interoperates easily with others is to send	1071	A simple RPC protocol that interoperates easily with other languages is
580	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
581	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
582	JSON text:	1074	after each JSON text:
583		1075
584	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1076	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
585	$handle->push_write ("\012");	1077	$handle->push_write ("\012");
586		1078
587	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
…		…
590	$handle->push_read (json => sub { my $array = $_[1]; ... });	1082	$handle->push_read (json => sub { my $array = $_[1]; ... });
591		1083
592	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
593	this line into their JSON decoder of choice.	1085	this line into their JSON decoder of choice.
594		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
595	=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	}
596		1113
597	register_write_type json => sub {	1114	register_write_type json => sub {
598	my ($self, $ref) = @_;	1115	my ($self, $ref) = @_;
599		1116
600	require JSON;	1117	($self->{json} ||= json_coder)
		1118	->encode ($ref)
		1119	};
601		1120
602	$self->{json} ? $self->{json}->encode ($ref)	1121	sub cbor_coder() {
603	: 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)
604	};	1131	};
605		1132
606	=item storable => $reference	1133	=item storable => $reference
607		1134
608	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
…		…
611	=cut	1138	=cut
612		1139
613	register_write_type storable => sub {	1140	register_write_type storable => sub {
614	my ($self, $ref) = @_;	1141	my ($self, $ref) = @_;
615		1142
616	require Storable;	1143	require Storable unless $Storable::VERSION;
617		1144
618	pack "w/a*", Storable::nfreeze ($ref)	1145	pack "w/a*", Storable::nfreeze ($ref)
619	};	1146	};
620		1147
621	=back	1148	=back
622		1149
623	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1150	=item $handle->push_shutdown
624		1151
625	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
626	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
627	reference with the handle object and the remaining arguments.	1187	the handle object and the remaining arguments.
628		1188
629	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
630	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.
631		1192
632	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
633	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	}
634		1209
635	=cut	1210	=cut
636		1211
637	#############################################################################	1212	#############################################################################
638		1213
…		…
647	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
648	a queue.	1223	a queue.
649		1224
650	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
651	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
652	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
653	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
654	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>.
655		1231
656	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
657	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
658	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
659	done its job (see C<push_read>, below).	1235	done its job (see C<push_read>, below).
660		1236
661	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
662	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.
663		1239
…		…
720	=cut	1296	=cut
721		1297
722	sub _drain_rbuf {	1298	sub _drain_rbuf {
723	my ($self) = @_;	1299	my ($self) = @_;
724		1300
		1301	# avoid recursion
		1302	return if $self->{_skip_drain_rbuf};
725	local $self->{_in_drain} = 1;	1303	local $self->{_skip_drain_rbuf} = 1;
726
727	if (
728	defined $self->{rbuf_max}
729	&& $self->{rbuf_max} < length $self->{rbuf}
730	) {
731	return $self->_error (&Errno::ENOSPC, 1);
732	}
733		1304
734	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
735	my $len = length $self->{rbuf};	1311	my $len = length $self->{rbuf};
736		1312
737	if (my $cb = shift @{ $self->{_queue} }) {	1313	if (my $cb = shift @{ $self->{_queue} }) {
738	unless ($cb->($self)) {	1314	unless ($cb->($self)) {
739	if ($self->{_eof}) {	1315	# no progress can be made
740	# no progress can be made (not enough data and no data forthcoming)	1316	# (not enough data and no data forthcoming)
741	$self->_error (&Errno::EPIPE, 1), last;	1317	$self->_error (Errno::EPIPE, 1), return
742	}	1318	if $self->{_eof};
743		1319
744	unshift @{ $self->{_queue} }, $cb;	1320	unshift @{ $self->{_queue} }, $cb;
745	last;	1321	last;
746	}	1322	}
747	} elsif ($self->{on_read}) {	1323	} elsif ($self->{on_read}) {
…		…
754	&& !@{ $self->{_queue} } # and the queue is still empty	1330	&& !@{ $self->{_queue} } # and the queue is still empty
755	&& $self->{on_read} # but we still have on_read	1331	&& $self->{on_read} # but we still have on_read
756	) {	1332	) {
757	# no further data will arrive	1333	# no further data will arrive
758	# so no progress can be made	1334	# so no progress can be made
759	$self->_error (&Errno::EPIPE, 1), last	1335	$self->_error (Errno::EPIPE, 1), return
760	if $self->{_eof};	1336	if $self->{_eof};
761		1337
762	last; # more data might arrive	1338	last; # more data might arrive
763	}	1339	}
764	} else {	1340	} else {
765	# read side becomes idle	1341	# read side becomes idle
766	delete $self->{_rw};	1342	delete $self->{_rw} unless $self->{tls};
767	last;	1343	last;
768	}	1344	}
769	}	1345	}
770		1346
		1347	if ($self->{_eof}) {
		1348	$self->{on_eof}
771	$self->{on_eof}($self)	1349	? $self->{on_eof}($self)
772	if $self->{_eof} && $self->{on_eof};	1350	: $self->_error (0, 1, "Unexpected end-of-file");
		1351
		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;
		1360	}
773		1361
774	# may need to restart read watcher	1362	# may need to restart read watcher
775	unless ($self->{_rw}) {	1363	unless ($self->{_rw}) {
776	$self->start_read	1364	$self->start_read
777	if $self->{on_read} || @{ $self->{_queue} };	1365	if $self->{on_read} || @{ $self->{_queue} };
…		…
782		1370
783	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
784	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
785	constructor.	1373	constructor.
786		1374
		1375	This method may invoke callbacks (and therefore the handle might be
		1376	destroyed after it returns).
		1377
787	=cut	1378	=cut
788		1379
789	sub on_read {	1380	sub on_read {
790	my ($self, $cb) = @_;	1381	my ($self, $cb) = @_;
791		1382
792	$self->{on_read} = $cb;	1383	$self->{on_read} = $cb;
793	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1384	$self->_drain_rbuf if $cb;
794	}	1385	}
795		1386
796	=item $handle->rbuf	1387	=item $handle->rbuf
797		1388
798	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).
799		1392
800	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)
801	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.
802		1396
803	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>
804	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
805	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.
806		1401
807	=cut	1402	=cut
808		1403
809	sub rbuf : lvalue {	1404	sub rbuf : lvalue {
810	$_[0]{rbuf}	1405	$_[0]{rbuf}
…		…
827		1422
828	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
829	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
830	true, it will be removed from the queue.	1425	true, it will be removed from the queue.
831		1426
		1427	These methods may invoke callbacks (and therefore the handle might be
		1428	destroyed after it returns).
		1429
832	=cut	1430	=cut
833		1431
834	our %RH;	1432	our %RH;
835		1433
836	sub register_read_type($$) {	1434	sub register_read_type($$) {
…		…
842	my $cb = pop;	1440	my $cb = pop;
843		1441
844	if (@_) {	1442	if (@_) {
845	my $type = shift;	1443	my $type = shift;
846		1444
		1445	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
847	$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")
848	->($self, $cb, @_);	1447	->($self, $cb, @_);
849	}	1448	}
850		1449
851	push @{ $self->{_queue} }, $cb;	1450	push @{ $self->{_queue} }, $cb;
852	$self->_drain_rbuf unless $self->{_in_drain};	1451	$self->_drain_rbuf;
853	}	1452	}
854		1453
855	sub unshift_read {	1454	sub unshift_read {
856	my $self = shift;	1455	my $self = shift;
857	my $cb = pop;	1456	my $cb = pop;
858		1457
859	if (@_) {	1458	if (@_) {
860	my $type = shift;	1459	my $type = shift;
861		1460
		1461	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
862	$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")
863	->($self, $cb, @_);	1463	->($self, $cb, @_);
864	}	1464	}
865		1465
866
867	unshift @{ $self->{_queue} }, $cb;	1466	unshift @{ $self->{_queue} }, $cb;
868	$self->_drain_rbuf unless $self->{_in_drain};	1467	$self->_drain_rbuf;
869	}	1468	}
870		1469
871	=item $handle->push_read (type => @args, $cb)	1470	=item $handle->push_read (type => @args, $cb)
872		1471
873	=item $handle->unshift_read (type => @args, $cb)	1472	=item $handle->unshift_read (type => @args, $cb)
874		1473
875	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
876	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
877	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).
878		1479
879	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
880	drop by and tell us):	1481	drop by and tell us):
881		1482
882	=over 4	1483	=over 4
…		…
888	data.	1489	data.
889		1490
890	Example: read 2 bytes.	1491	Example: read 2 bytes.
891		1492
892	$handle->push_read (chunk => 2, sub {	1493	$handle->push_read (chunk => 2, sub {
893	warn "yay ", unpack "H*", $_[1];	1494	say "yay " . unpack "H*", $_[1];
894	});	1495	});
895		1496
896	=cut	1497	=cut
897		1498
898	register_read_type chunk => sub {	1499	register_read_type chunk => sub {
…		…
928		1529
929	register_read_type line => sub {	1530	register_read_type line => sub {
930	my ($self, $cb, $eol) = @_;	1531	my ($self, $cb, $eol) = @_;
931		1532
932	if (@_ < 3) {	1533	if (@_ < 3) {
933	# this is more than twice as fast as the generic code below	1534	# this is faster then the generic code below
934	sub {	1535	sub {
935	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1536	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1537	or return;
936		1538
		1539	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
937	$cb->($_[0], $1, $2);	1540	$cb->($_[0], $str, "$1");
938	1	1541	1
939	}	1542	}
940	} else {	1543	} else {
941	$eol = quotemeta $eol unless ref $eol;	1544	$eol = quotemeta $eol unless ref $eol;
942	$eol = qr|^(.*?)($eol)|s;	1545	$eol = qr|^(.*?)($eol)|s;
943		1546
944	sub {	1547	sub {
945	$_[0]{rbuf} =~ s/$eol// or return;	1548	$_[0]{rbuf} =~ s/$eol// or return;
946		1549
947	$cb->($_[0], $1, $2);	1550	$cb->($_[0], "$1", "$2");
948	1	1551	1
949	}	1552	}
950	}	1553	}
951	};	1554	};
952		1555
…		…
974	the receive buffer when neither C<$accept> nor C<$reject> match,	1577	the receive buffer when neither C<$accept> nor C<$reject> match,
975	and everything preceding and including the match will be accepted	1578	and everything preceding and including the match will be accepted
976	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
977	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
978	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
979	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.
980		1583
981	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
982	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
983	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
984	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
985	required for the accept regex.	1588	required for the accept regex.
986		1589
987	$handle->push_read (regex =>	1590	$handle->push_read (regex =>
…		…
1000		1603
1001	sub {	1604	sub {
1002	# accept	1605	# accept
1003	if ($$rbuf =~ $accept) {	1606	if ($$rbuf =~ $accept) {
1004	$data .= substr $$rbuf, 0, $+[0], "";	1607	$data .= substr $$rbuf, 0, $+[0], "";
1005	$cb->($self, $data);	1608	$cb->($_[0], $data);
1006	return 1;	1609	return 1;
1007	}	1610	}
1008		1611
1009	# reject	1612	# reject
1010	if ($reject && $$rbuf =~ $reject) {	1613	if ($reject && $$rbuf =~ $reject) {
1011	$self->_error (&Errno::EBADMSG);	1614	$_[0]->_error (Errno::EBADMSG);
1012	}	1615	}
1013		1616
1014	# skip	1617	# skip
1015	if ($skip && $$rbuf =~ $skip) {	1618	if ($skip && $$rbuf =~ $skip) {
1016	$data .= substr $$rbuf, 0, $+[0], "";	1619	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1032	my ($self, $cb) = @_;	1635	my ($self, $cb) = @_;
1033		1636
1034	sub {	1637	sub {
1035	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1638	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1036	if ($_[0]{rbuf} =~ /[^0-9]/) {	1639	if ($_[0]{rbuf} =~ /[^0-9]/) {
1037	$self->_error (&Errno::EBADMSG);	1640	$_[0]->_error (Errno::EBADMSG);
1038	}	1641	}
1039	return;	1642	return;
1040	}	1643	}
1041		1644
1042	my $len = $1;	1645	my $len = $1;
1043		1646
1044	$self->unshift_read (chunk => $len, sub {	1647	$_[0]->unshift_read (chunk => $len, sub {
1045	my $string = $_[1];	1648	my $string = $_[1];
1046	$_[0]->unshift_read (chunk => 1, sub {	1649	$_[0]->unshift_read (chunk => 1, sub {
1047	if ($_[1] eq ",") {	1650	if ($_[1] eq ",") {
1048	$cb->($_[0], $string);	1651	$cb->($_[0], $string);
1049	} else {	1652	} else {
1050	$self->_error (&Errno::EBADMSG);	1653	$_[0]->_error (Errno::EBADMSG);
1051	}	1654	}
1052	});	1655	});
1053	});	1656	});
1054		1657
1055	1	1658	1
…		…
1061	An octet string prefixed with an encoded length. The encoding C<$format>	1664	An octet string prefixed with an encoded length. The encoding C<$format>
1062	uses the same format as a Perl C<pack> format, but must specify a single	1665	uses the same format as a Perl C<pack> format, but must specify a single
1063	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1666	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1064	optional C<!>, C<< < >> or C<< > >> modifier).	1667	optional C<!>, C<< < >> or C<< > >> modifier).
1065		1668
1066	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1669	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1670	EPP uses a prefix of C<N> (4 octtes).
1067		1671
1068	Example: read a block of data prefixed by its length in BER-encoded	1672	Example: read a block of data prefixed by its length in BER-encoded
1069	format (very efficient).	1673	format (very efficient).
1070		1674
1071	$handle->push_read (packstring => "w", sub {	1675	$handle->push_read (packstring => "w", sub {
…		…
1101	}	1705	}
1102	};	1706	};
1103		1707
1104	=item json => $cb->($handle, $hash_or_arrayref)	1708	=item json => $cb->($handle, $hash_or_arrayref)
1105		1709
1106	Reads a JSON object or array, decodes it and passes it to the callback.	1710	Reads a JSON object or array, decodes it and passes it to the
		1711	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1107		1712
1108	If a C<json> object was passed to the constructor, then that will be used	1713	If a C<json> object was passed to the constructor, then that will be used
1109	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1714	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1110		1715
1111	This read type uses the incremental parser available with JSON version	1716	This read type uses the incremental parser available with JSON version
…		…
1120	=cut	1725	=cut
1121		1726
1122	register_read_type json => sub {	1727	register_read_type json => sub {
1123	my ($self, $cb) = @_;	1728	my ($self, $cb) = @_;
1124		1729
1125	require JSON;	1730	my $json = $self->{json} ||= json_coder;
1126		1731
1127	my $data;	1732	my $data;
1128	my $rbuf = \$self->{rbuf};
1129
1130	my $json = $self->{json} ||= JSON->new->utf8;
1131		1733
1132	sub {	1734	sub {
1133	my $ref = $json->incr_parse ($self->{rbuf});	1735	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1134		1736
1135	if ($ref) {	1737	if ($ref) {
1136	$self->{rbuf} = $json->incr_text;	1738	$_[0]{rbuf} = $json->incr_text;
1137	$json->incr_text = "";	1739	$json->incr_text = "";
1138	$cb->($self, $ref);	1740	$cb->($_[0], $ref);
1139		1741
1140	1	1742	1
		1743	} elsif ($@) {
		1744	# error case
		1745	$json->incr_skip;
		1746
		1747	$_[0]{rbuf} = $json->incr_text;
		1748	$json->incr_text = "";
		1749
		1750	$_[0]->_error (Errno::EBADMSG);
		1751
		1752	()
1141	} else {	1753	} else {
1142	$self->{rbuf} = "";	1754	$_[0]{rbuf} = "";
		1755
		1756	()
		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 {
1143	()	1802	()
1144	}	1803	}
1145	}	1804	}
1146	};	1805	};
1147		1806
…		…
1156	=cut	1815	=cut
1157		1816
1158	register_read_type storable => sub {	1817	register_read_type storable => sub {
1159	my ($self, $cb) = @_;	1818	my ($self, $cb) = @_;
1160		1819
1161	require Storable;	1820	require Storable unless $Storable::VERSION;
1162		1821
1163	sub {	1822	sub {
1164	# 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
1165	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1824	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1166	or return;	1825	or return;
…		…
1169		1828
1170	# bypass unshift if we already have the remaining chunk	1829	# bypass unshift if we already have the remaining chunk
1171	if ($format + $len <= length $_[0]{rbuf}) {	1830	if ($format + $len <= length $_[0]{rbuf}) {
1172	my $data = substr $_[0]{rbuf}, $format, $len;	1831	my $data = substr $_[0]{rbuf}, $format, $len;
1173	substr $_[0]{rbuf}, 0, $format + $len, "";	1832	substr $_[0]{rbuf}, 0, $format + $len, "";
		1833
1174	$cb->($_[0], Storable::thaw ($data));	1834	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1835	or return $_[0]->_error (Errno::EBADMSG);
1175	} else {	1836	} else {
1176	# remove prefix	1837	# remove prefix
1177	substr $_[0]{rbuf}, 0, $format, "";	1838	substr $_[0]{rbuf}, 0, $format, "";
1178		1839
1179	# read remaining chunk	1840	# read remaining chunk
1180	$_[0]->unshift_read (chunk => $len, sub {	1841	$_[0]->unshift_read (chunk => $len, sub {
1181	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1842	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1182	$cb->($_[0], $ref);
1183	} else {
1184	$self->_error (&Errno::EBADMSG);	1843	or $_[0]->_error (Errno::EBADMSG);
1185	}
1186	});	1844	});
1187	}	1845	}
1188		1846
1189	1	1847	1
1190	}	1848	}
1191	};	1849	};
1192		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
1193	=back	1937	=back
1194		1938
1195	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1939	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1196		1940
1197	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).
1198		1946
1199	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
1200	reference with the handle object, the callback and the remaining	1948	handle object, the original callback and the remaining arguments.
1201	arguments.
1202		1949
1203	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
1204	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.
1205		1954
1206	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
1207	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).
1208		1958
1209	Note that this is a function, and all types registered this way will be
1210	global, so try to use unique names.
1211
1212	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
1213	search for C<register_read_type>)).	1960	AnyEvent::Handle>, search for C<register_read_type>)).
1214		1961
1215	=item $handle->stop_read	1962	=item $handle->stop_read
1216		1963
1217	=item $handle->start_read	1964	=item $handle->start_read
1218		1965
…		…
1224	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
1225	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
1226	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
1227	there are any read requests in the queue.	1974	there are any read requests in the queue.
1228		1975
		1976	In older versions of this module (<= 5.3), these methods had no effect,
		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.
		1987
1229	=cut	1988	=cut
1230		1989
1231	sub stop_read {	1990	sub stop_read {
1232	my ($self) = @_;	1991	my ($self) = @_;
1233		1992
…		…
1235	}	1994	}
1236		1995
1237	sub start_read {	1996	sub start_read {
1238	my ($self) = @_;	1997	my ($self) = @_;
1239		1998
1240	unless ($self->{_rw} || $self->{_eof}) {	1999	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1241	Scalar::Util::weaken $self;	2000	Scalar::Util::weaken $self;
1242		2001
1243	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	2002	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1244	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	2003	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1245	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	2004	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1246		2005
1247	if ($len > 0) {	2006	if ($len > 0) {
1248	$self->{_activity} = AnyEvent->now;	2007	$self->{_activity} = $self->{_ractivity} = AE::now;
1249		2008
1250	$self->{filter_r}	2009	if ($self->{tls}) {
1251	? $self->{filter_r}($self, $rbuf)	2010	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1252	: $self->{_in_drain} || $self->_drain_rbuf;	2011
		2012	&_dotls ($self);
		2013	} else {
		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);
		2021	}
1253		2022
1254	} elsif (defined $len) {	2023	} elsif (defined $len) {
1255	delete $self->{_rw};	2024	delete $self->{_rw};
1256	$self->{_eof} = 1;	2025	$self->{_eof} = 1;
1257	$self->_drain_rbuf unless $self->{_in_drain};	2026	$self->_drain_rbuf;
1258		2027
1259	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2028	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1260	return $self->_error ($!, 1);	2029	return $self->_error ($!, 1);
1261	}	2030	}
1262	});	2031	};
1263	}	2032	}
1264	}	2033	}
1265		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);
		2055	}
		2056	}
		2057
		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.
1266	sub _dotls {	2063	sub _dotls {
1267	my ($self) = @_;	2064	my ($self) = @_;
1268		2065
1269	my $buf;	2066	my $tmp;
1270		2067
1271	if (length $self->{_tls_wbuf}) {	2068	if (length $self->{_tls_wbuf}) {
1272	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2069	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1273	substr $self->{_tls_wbuf}, 0, $len, "";	2070	substr $self->{_tls_wbuf}, 0, $tmp, "";
1274	}	2071	}
1275	}
1276		2072
		2073	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2074	return $self->_tls_error ($tmp)
		2075	if $tmp != $ERROR_WANT_READ
		2076	&& ($tmp != $ERROR_SYSCALL || $!);
		2077	}
		2078
		2079	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		2080	unless (length $tmp) {
		2081	$self->{_on_starttls}
		2082	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		2083	&_freetls;
		2084
		2085	if ($self->{on_stoptls}) {
		2086	$self->{on_stoptls}($self);
		2087	return;
		2088	} else {
		2089	# let's treat SSL-eof as we treat normal EOF
		2090	delete $self->{_rw};
		2091	$self->{_eof} = 1;
		2092	}
		2093	}
		2094
		2095	$self->{_tls_rbuf} .= $tmp;
		2096	$self->_drain_rbuf;
		2097	$self->{tls} or return; # tls session might have gone away in callback
		2098	}
		2099
		2100	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		2101	return $self->_tls_error ($tmp)
		2102	if $tmp != $ERROR_WANT_READ
		2103	&& ($tmp != $ERROR_SYSCALL || $!);
		2104
1277	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2105	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1278	$self->{wbuf} .= $buf;	2106	$self->{wbuf} .= $tmp;
1279	$self->_drain_wbuf;	2107	$self->_drain_wbuf;
		2108	$self->{tls} or return; # tls session might have gone away in callback
1280	}	2109	}
1281		2110
1282	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	2111	$self->{_on_starttls}
1283	if (length $buf) {	2112	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1284	$self->{rbuf} .= $buf;	2113	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1285	$self->_drain_rbuf unless $self->{_in_drain};
1286	} else {
1287	# let's treat SSL-eof as we treat normal EOF
1288	$self->{_eof} = 1;
1289	$self->_shutdown;
1290	return;
1291	}
1292	}
1293
1294	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1295
1296	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1297	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1298	return $self->_error ($!, 1);
1299	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1300	return $self->_error (&Errno::EIO, 1);
1301	}
1302
1303	# all others are fine for our purposes
1304	}
1305	}	2114	}
1306		2115
1307	=item $handle->starttls ($tls[, $tls_ctx])	2116	=item $handle->starttls ($tls[, $tls_ctx])
1308		2117
1309	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2118	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1310	object is created, you can also do that at a later time by calling	2119	object is created, you can also do that at a later time by calling
1311	C<starttls>.	2120	C<starttls>. See the C<tls> constructor argument for general info.
		2121
		2122	Starting TLS is currently an asynchronous operation - when you push some
		2123	write data and then call C<< ->starttls >> then TLS negotiation will start
		2124	immediately, after which the queued write data is then sent. This might
		2125	change in future versions, so best make sure you have no outstanding write
		2126	data when calling this method.
1312		2127
1313	The first argument is the same as the C<tls> constructor argument (either	2128	The first argument is the same as the C<tls> constructor argument (either
1314	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2129	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1315		2130
1316	The second argument is the optional C<Net::SSLeay::CTX> object that is	2131	The second argument is the optional C<AnyEvent::TLS> object that is used
1317	used when AnyEvent::Handle has to create its own TLS connection object.	2132	when AnyEvent::Handle has to create its own TLS connection object, or
		2133	a hash reference with C<< key => value >> pairs that will be used to
		2134	construct a new context.
1318		2135
1319	The TLS connection object will end up in C<< $handle->{tls} >> after this	2136	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1320	call and can be used or changed to your liking. Note that the handshake	2137	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1321	might have already started when this function returns.	2138	changed to your liking. Note that the handshake might have already started
		2139	when this function returns.
1322		2140
		2141	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		2142	handshakes on the same stream. It is best to not attempt to use the
		2143	stream after stopping TLS.
		2144
		2145	This method may invoke callbacks (and therefore the handle might be
		2146	destroyed after it returns).
		2147
1323	=cut	2148	=cut
		2149
		2150	our %TLS_CACHE; #TODO not yet documented, should we?
1324		2151
1325	sub starttls {	2152	sub starttls {
1326	my ($self, $ssl, $ctx) = @_;	2153	my ($self, $tls, $ctx) = @_;
1327		2154
1328	$self->stoptls;	2155	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		2156	if $self->{tls};
1329		2157
1330	if ($ssl eq "accept") {	2158	unless (defined $AnyEvent::TLS::VERSION) {
1331	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	2159	eval {
1332	Net::SSLeay::set_accept_state ($ssl);	2160	require Net::SSLeay;
1333	} elsif ($ssl eq "connect") {	2161	require AnyEvent::TLS;
1334	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	2162	1
1335	Net::SSLeay::set_connect_state ($ssl);	2163	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2164	}
		2165
		2166	$self->{tls} = $tls;
		2167	$self->{tls_ctx} = $ctx if @_ > 2;
		2168
		2169	return unless $self->{fh};
		2170
		2171	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		2172	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		2173
		2174	$tls = delete $self->{tls};
		2175	$ctx = $self->{tls_ctx};
		2176
		2177	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		2178
		2179	if ("HASH" eq ref $ctx) {
		2180	if ($ctx->{cache}) {
		2181	my $key = $ctx+0;
		2182	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		2183	} else {
		2184	$ctx = new AnyEvent::TLS %$ctx;
		2185	}
		2186	}
1336	}	2187
1337		2188	$self->{tls_ctx} = $ctx || TLS_CTX ();
1338	$self->{tls} = $ssl;	2189	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1339		2190
1340	# basically, this is deep magic (because SSL_read should have the same issues)	2191	# basically, this is deep magic (because SSL_read should have the same issues)
1341	# but the openssl maintainers basically said: "trust us, it just works".	2192	# but the openssl maintainers basically said: "trust us, it just works".
1342	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	2193	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1343	# and mismaintained ssleay-module doesn't even offer them).	2194	# and mismaintained ssleay-module doesn't even offer them).
1344	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	2195	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		2196	#
		2197	# in short: this is a mess.
		2198	#
		2199	# note that we do not try to keep the length constant between writes as we are required to do.
		2200	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		2201	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		2202	# have identity issues in that area.
1345	Net::SSLeay::CTX_set_mode ($self->{tls},	2203	# Net::SSLeay::CTX_set_mode ($ssl,
1346	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	2204	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1347	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	2205	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		2206	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1348		2207
1349	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2208	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1350	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2209	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1351		2210
		2211	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2212	$self->{rbuf} = "";
		2213
1352	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	2214	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1353		2215
1354	$self->{filter_w} = sub {	2216	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1355	$_[0]{_tls_wbuf} .= ${$_[1]};	2217	if $self->{on_starttls};
1356	&_dotls;	2218
1357	};	2219	&_dotls; # need to trigger the initial handshake
1358	$self->{filter_r} = sub {	2220	$self->start_read; # make sure we actually do read
1359	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1360	&_dotls;
1361	};
1362	}	2221	}
1363		2222
1364	=item $handle->stoptls	2223	=item $handle->stoptls
1365		2224
1366	Destroys the SSL connection, if any. Partial read or write data will be	2225	Shuts down the SSL connection - this makes a proper EOF handshake by
1367	lost.	2226	sending a close notify to the other side, but since OpenSSL doesn't
		2227	support non-blocking shut downs, it is not guaranteed that you can re-use
		2228	the stream afterwards.
		2229
		2230	This method may invoke callbacks (and therefore the handle might be
		2231	destroyed after it returns).
1368		2232
1369	=cut	2233	=cut
1370		2234
1371	sub stoptls {	2235	sub stoptls {
1372	my ($self) = @_;	2236	my ($self) = @_;
1373		2237
1374	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	2238	if ($self->{tls} && $self->{fh}) {
		2239	Net::SSLeay::shutdown ($self->{tls});
1375		2240
1376	delete $self->{_rbio};	2241	&_dotls;
1377	delete $self->{_wbio};	2242
1378	delete $self->{_tls_wbuf};	2243	# # we don't give a shit. no, we do, but we can't. no...#d#
1379	delete $self->{filter_r};	2244	# # we, we... have to use openssl :/#d#
1380	delete $self->{filter_w};	2245	# &_freetls;#d#
		2246	}
1381	}	2247	}
		2248
		2249	sub _freetls {
		2250	my ($self) = @_;
		2251
		2252	return unless $self->{tls};
		2253
		2254	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2255	if $self->{tls} > 0;
		2256
		2257	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
		2258	}
		2259
		2260	=item $handle->resettls
		2261
		2262	This rarely-used method simply resets and TLS state on the handle, usually
		2263	causing data loss.
		2264
		2265	One case where it may be useful is when you want to skip over the data in
		2266	the stream but you are not interested in interpreting it, so data loss is
		2267	no concern.
		2268
		2269	=cut
		2270
		2271	*resettls = \&_freetls;
1382		2272
1383	sub DESTROY {	2273	sub DESTROY {
1384	my $self = shift;	2274	my ($self) = @_;
1385		2275
1386	$self->stoptls;	2276	&_freetls;
1387		2277
1388	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	2278	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1389		2279
1390	if ($linger && length $self->{wbuf}) {	2280	if ($linger && length $self->{wbuf} && $self->{fh}) {
1391	my $fh = delete $self->{fh};	2281	my $fh = delete $self->{fh};
1392	my $wbuf = delete $self->{wbuf};	2282	my $wbuf = delete $self->{wbuf};
1393		2283
1394	my @linger;	2284	my @linger;
1395		2285
1396	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2286	push @linger, AE::io $fh, 1, sub {
1397	my $len = syswrite $fh, $wbuf, length $wbuf;	2287	my $len = syswrite $fh, $wbuf, length $wbuf;
1398		2288
1399	if ($len > 0) {	2289	if ($len > 0) {
1400	substr $wbuf, 0, $len, "";	2290	substr $wbuf, 0, $len, "";
1401	} else {	2291	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1402	@linger = (); # end	2292	@linger = (); # end
1403	}	2293	}
		2294	};
		2295	push @linger, AE::timer $linger, 0, sub {
		2296	@linger = ();
		2297	};
		2298	}
		2299	}
		2300
		2301	=item $handle->destroy
		2302
		2303	Shuts down the handle object as much as possible - this call ensures that
		2304	no further callbacks will be invoked and as many resources as possible
		2305	will be freed. Any method you will call on the handle object after
		2306	destroying it in this way will be silently ignored (and it will return the
		2307	empty list).
		2308
		2309	Normally, you can just "forget" any references to an AnyEvent::Handle
		2310	object and it will simply shut down. This works in fatal error and EOF
		2311	callbacks, as well as code outside. It does I<NOT> work in a read or write
		2312	callback, so when you want to destroy the AnyEvent::Handle object from
		2313	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		2314	that case.
		2315
		2316	Destroying the handle object in this way has the advantage that callbacks
		2317	will be removed as well, so if those are the only reference holders (as
		2318	is common), then one doesn't need to do anything special to break any
		2319	reference cycles.
		2320
		2321	The handle might still linger in the background and write out remaining
		2322	data, as specified by the C<linger> option, however.
		2323
		2324	=cut
		2325
		2326	sub destroy {
		2327	my ($self) = @_;
		2328
		2329	$self->DESTROY;
		2330	%$self = ();
		2331	bless $self, "AnyEvent::Handle::destroyed";
		2332	}
		2333
		2334	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2335	#nop
		2336	}
		2337
		2338	=item $handle->destroyed
		2339
		2340	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2341	->destroy >>, true otherwise.
		2342
		2343	Can be useful to decide whether the handle is still valid after some
		2344	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2345	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2346	can destroy the handle, so work can be avoided by checking sometimes:
		2347
		2348	$hdl->starttls ("accept");
		2349	return if $hdl->destroyed;
		2350	$hdl->push_write (...
		2351
		2352	Note that the call to C<push_write> will silently be ignored if the handle
		2353	has been destroyed, so often you can just ignore the possibility of the
		2354	handle being destroyed.
		2355
		2356	=cut
		2357
		2358	sub destroyed { 0 }
		2359	sub AnyEvent::Handle::destroyed::destroyed { 1 }
		2360
		2361	=item AnyEvent::Handle::TLS_CTX
		2362
		2363	This function creates and returns the AnyEvent::TLS object used by default
		2364	for TLS mode.
		2365
		2366	The context is created by calling L<AnyEvent::TLS> without any arguments.
		2367
		2368	=cut
		2369
		2370	our $TLS_CTX;
		2371
		2372	sub TLS_CTX() {
		2373	$TLS_CTX ||= do {
		2374	require AnyEvent::TLS;
		2375
		2376	new AnyEvent::TLS
		2377	}
		2378	}
		2379
		2380	=back
		2381
		2382
		2383	=head1 NONFREQUENTLY ASKED QUESTIONS
		2384
		2385	=over 4
		2386
		2387	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		2388	still get further invocations!
		2389
		2390	That's because AnyEvent::Handle keeps a reference to itself when handling
		2391	read or write callbacks.
		2392
		2393	It is only safe to "forget" the reference inside EOF or error callbacks,
		2394	from within all other callbacks, you need to explicitly call the C<<
		2395	->destroy >> method.
		2396
		2397	=item Why is my C<on_eof> callback never called?
		2398
		2399	Probably because your C<on_error> callback is being called instead: When
		2400	you have outstanding requests in your read queue, then an EOF is
		2401	considered an error as you clearly expected some data.
		2402
		2403	To avoid this, make sure you have an empty read queue whenever your handle
		2404	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2405	an C<on_read> handler that simply pushes the first read requests in the
		2406	queue.
		2407
		2408	See also the next question, which explains this in a bit more detail.
		2409
		2410	=item How can I serve requests in a loop?
		2411
		2412	Most protocols consist of some setup phase (authentication for example)
		2413	followed by a request handling phase, where the server waits for requests
		2414	and handles them, in a loop.
		2415
		2416	There are two important variants: The first (traditional, better) variant
		2417	handles requests until the server gets some QUIT command, causing it to
		2418	close the connection first (highly desirable for a busy TCP server). A
		2419	client dropping the connection is an error, which means this variant can
		2420	detect an unexpected detection close.
		2421
		2422	To handle this case, always make sure you have a non-empty read queue, by
		2423	pushing the "read request start" handler on it:
		2424
		2425	# we assume a request starts with a single line
		2426	my @start_request; @start_request = (line => sub {
		2427	my ($hdl, $line) = @_;
		2428
		2429	... handle request
		2430
		2431	# push next request read, possibly from a nested callback
		2432	$hdl->push_read (@start_request);
		2433	});
		2434
		2435	# auth done, now go into request handling loop
		2436	# now push the first @start_request
		2437	$hdl->push_read (@start_request);
		2438
		2439	By always having an outstanding C<push_read>, the handle always expects
		2440	some data and raises the C<EPIPE> error when the connction is dropped
		2441	unexpectedly.
		2442
		2443	The second variant is a protocol where the client can drop the connection
		2444	at any time. For TCP, this means that the server machine may run out of
		2445	sockets easier, and in general, it means you cannot distinguish a protocl
		2446	failure/client crash from a normal connection close. Nevertheless, these
		2447	kinds of protocols are common (and sometimes even the best solution to the
		2448	problem).
		2449
		2450	Having an outstanding read request at all times is possible if you ignore
		2451	C<EPIPE> errors, but this doesn't help with when the client drops the
		2452	connection during a request, which would still be an error.
		2453
		2454	A better solution is to push the initial request read in an C<on_read>
		2455	callback. This avoids an error, as when the server doesn't expect data
		2456	(i.e. is idly waiting for the next request, an EOF will not raise an
		2457	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2458	and simpler:
		2459
		2460	# auth done, now go into request handling loop
		2461	$hdl->on_read (sub {
		2462	my ($hdl) = @_;
		2463
		2464	# called each time we receive data but the read queue is empty
		2465	# simply start read the request
		2466
		2467	$hdl->push_read (line => sub {
		2468	my ($hdl, $line) = @_;
		2469
		2470	... handle request
		2471
		2472	# do nothing special when the request has been handled, just
		2473	# let the request queue go empty.
1404	});	2474	});
1405	push @linger, AnyEvent->timer (after => $linger, cb => sub {
1406	@linger = ();
1407	});	2475	});
		2476
		2477	=item I get different callback invocations in TLS mode/Why can't I pause
		2478	reading?
		2479
		2480	Unlike, say, TCP, TLS connections do not consist of two independent
		2481	communication channels, one for each direction. Or put differently, the
		2482	read and write directions are not independent of each other: you cannot
		2483	write data unless you are also prepared to read, and vice versa.
		2484
		2485	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
		2486	callback invocations when you are not expecting any read data - the reason
		2487	is that AnyEvent::Handle always reads in TLS mode.
		2488
		2489	During the connection, you have to make sure that you always have a
		2490	non-empty read-queue, or an C<on_read> watcher. At the end of the
		2491	connection (or when you no longer want to use it) you can call the
		2492	C<destroy> method.
		2493
		2494	=item How do I read data until the other side closes the connection?
		2495
		2496	If you just want to read your data into a perl scalar, the easiest way
		2497	to achieve this is by setting an C<on_read> callback that does nothing,
		2498	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		2499	will be in C<$_[0]{rbuf}>:
		2500
		2501	$handle->on_read (sub { });
		2502	$handle->on_eof (undef);
		2503	$handle->on_error (sub {
		2504	my $data = delete $_[0]{rbuf};
		2505	});
		2506
		2507	Note that this example removes the C<rbuf> member from the handle object,
		2508	which is not normally allowed by the API. It is expressly permitted in
		2509	this case only, as the handle object needs to be destroyed afterwards.
		2510
		2511	The reason to use C<on_error> is that TCP connections, due to latencies
		2512	and packets loss, might get closed quite violently with an error, when in
		2513	fact all data has been received.
		2514
		2515	It is usually better to use acknowledgements when transferring data,
		2516	to make sure the other side hasn't just died and you got the data
		2517	intact. This is also one reason why so many internet protocols have an
		2518	explicit QUIT command.
		2519
		2520	=item I don't want to destroy the handle too early - how do I wait until
		2521	all data has been written?
		2522
		2523	After writing your last bits of data, set the C<on_drain> callback
		2524	and destroy the handle in there - with the default setting of
		2525	C<low_water_mark> this will be called precisely when all data has been
		2526	written to the socket:
		2527
		2528	$handle->push_write (...);
		2529	$handle->on_drain (sub {
		2530	AE::log debug => "All data submitted to the kernel.";
		2531	undef $handle;
		2532	});
		2533
		2534	If you just want to queue some data and then signal EOF to the other side,
		2535	consider using C<< ->push_shutdown >> instead.
		2536
		2537	=item I want to contact a TLS/SSL server, I don't care about security.
		2538
		2539	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2540	connect to it and then create the AnyEvent::Handle with the C<tls>
		2541	parameter:
		2542
		2543	tcp_connect $host, $port, sub {
		2544	my ($fh) = @_;
		2545
		2546	my $handle = new AnyEvent::Handle
		2547	fh => $fh,
		2548	tls => "connect",
		2549	on_error => sub { ... };
		2550
		2551	$handle->push_write (...);
1408	}	2552	};
1409	}
1410		2553
1411	=item AnyEvent::Handle::TLS_CTX	2554	=item I want to contact a TLS/SSL server, I do care about security.
1412		2555
1413	This function creates and returns the Net::SSLeay::CTX object used by	2556	Then you should additionally enable certificate verification, including
1414	default for TLS mode.	2557	peername verification, if the protocol you use supports it (see
		2558	L<AnyEvent::TLS>, C<verify_peername>).
1415		2559
1416	The context is created like this:	2560	E.g. for HTTPS:
1417		2561
1418	Net::SSLeay::load_error_strings;	2562	tcp_connect $host, $port, sub {
1419	Net::SSLeay::SSLeay_add_ssl_algorithms;	2563	my ($fh) = @_;
1420	Net::SSLeay::randomize;
1421		2564
1422	my $CTX = Net::SSLeay::CTX_new;	2565	my $handle = new AnyEvent::Handle
		2566	fh => $fh,
		2567	peername => $host,
		2568	tls => "connect",
		2569	tls_ctx => { verify => 1, verify_peername => "https" },
		2570	...
1423		2571
1424	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL	2572	Note that you must specify the hostname you connected to (or whatever
		2573	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2574	peername verification will be done.
1425		2575
1426	=cut	2576	The above will use the system-dependent default set of trusted CA
		2577	certificates. If you want to check against a specific CA, add the
		2578	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
1427		2579
1428	our $TLS_CTX;	2580	tls_ctx => {
		2581	verify => 1,
		2582	verify_peername => "https",
		2583	ca_file => "my-ca-cert.pem",
		2584	},
1429		2585
1430	sub TLS_CTX() {	2586	=item I want to create a TLS/SSL server, how do I do that?
1431	$TLS_CTX || do {
1432	require Net::SSLeay;
1433		2587
1434	Net::SSLeay::load_error_strings ();	2588	Well, you first need to get a server certificate and key. You have
1435	Net::SSLeay::SSLeay_add_ssl_algorithms ();	2589	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
1436	Net::SSLeay::randomize ();	2590	self-signed certificate (cheap. check the search engine of your choice,
		2591	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2592	nice program for that purpose).
1437		2593
1438	$TLS_CTX = Net::SSLeay::CTX_new ();	2594	Then create a file with your private key (in PEM format, see
		2595	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2596	file should then look like this:
1439		2597
1440	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());	2598	-----BEGIN RSA PRIVATE KEY-----
		2599	...header data
		2600	... lots of base64'y-stuff
		2601	-----END RSA PRIVATE KEY-----
1441		2602
1442	$TLS_CTX	2603	-----BEGIN CERTIFICATE-----
1443	}	2604	... lots of base64'y-stuff
1444	}	2605	-----END CERTIFICATE-----
		2606
		2607	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2608	specify this file as C<cert_file>:
		2609
		2610	tcp_server undef, $port, sub {
		2611	my ($fh) = @_;
		2612
		2613	my $handle = new AnyEvent::Handle
		2614	fh => $fh,
		2615	tls => "accept",
		2616	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2617	...
		2618
		2619	When you have intermediate CA certificates that your clients might not
		2620	know about, just append them to the C<cert_file>.
1445		2621
1446	=back	2622	=back
1447		2623
1448	=head1 SUBCLASSING AnyEvent::Handle	2624	=head1 SUBCLASSING AnyEvent::Handle
1449		2625
…		…
1468		2644
1469	=item * all members not documented here and not prefixed with an underscore	2645	=item * all members not documented here and not prefixed with an underscore
1470	are free to use in subclasses.	2646	are free to use in subclasses.
1471		2647
1472	Of course, new versions of AnyEvent::Handle may introduce more "public"	2648	Of course, new versions of AnyEvent::Handle may introduce more "public"
1473	member variables, but thats just life, at least it is documented.	2649	member variables, but that's just life. At least it is documented.
1474		2650
1475	=back	2651	=back
1476		2652
1477	=head1 AUTHOR	2653	=head1 AUTHOR
1478		2654
1479	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2655	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
1480		2656
1481	=cut	2657	=cut
1482		2658
1483	1; # End of AnyEvent::Handle	2659	1
		2660

Diff Legend

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