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.62 by root, Fri Jun 6 10:49:20 2008 UTC vs.
Revision 1.205 by root, Mon Nov 15 17:11:00 2010 UTC

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

Diff Legend

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