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

Diff Legend

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