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.48 by root, Thu May 29 00:27:06 2008 UTC vs.
Revision 1.246 by root, Sun Jun 28 09:30:37 2015 UTC

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

Diff Legend

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