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.92 by root, Wed Oct 1 08:52:06 2008 UTC vs.
Revision 1.212 by root, Fri Dec 31 04:50:44 2010 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.3;
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
54	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
56		40
57	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
58	means characters. As sysread and syswrite are used for all I/O, their	42	characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
60		47
61	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
62	argument.	49	argument.
63		50
64	=head2 SIGPIPE is not handled by this module	51	=cut
65		52
66	SIGPIPE is not handled by this module, so one of the practical	53	package AnyEvent::Handle;
67	requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} =	54
68	'IGNORE'>). At least, this is highly recommend in a networked program: If	55	use Scalar::Util ();
69	you use AnyEvent::Handle in a filter program (like sort), exiting on	56	use List::Util ();
70	SIGPIPE is probably the right thing to do.	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 }
71		81
72	=head1 METHODS	82	=head1 METHODS
73		83
74	=over 4	84	=over 4
75		85
76	=item B<new (%args)>	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
77		87
78	The constructor supports these arguments (all as key => value pairs).	88	The constructor supports these arguments (all as C<< key => value >> pairs).
79		89
80	=over 4	90	=over 4
81		91
82	=item fh => $filehandle [MANDATORY]	92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
83		93
84	The filehandle this L<AnyEvent::Handle> object will operate on.	94	The filehandle this L<AnyEvent::Handle> object will operate on.
85
86	NOTE: The filehandle will be set to non-blocking mode (using	95	NOTE: The filehandle will be set to non-blocking mode (using
87	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	96	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
88	that mode.	97	that mode.
89		98
		99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		100
		101	Try to connect to the specified host and service (port), using
		102	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		103	default C<peername>.
		104
		105	You have to specify either this parameter, or C<fh>, above.
		106
		107	It is possible to push requests on the read and write queues, and modify
		108	properties of the stream, even while AnyEvent::Handle is connecting.
		109
		110	When this parameter is specified, then the C<on_prepare>,
		111	C<on_connect_error> and C<on_connect> callbacks will be called under the
		112	appropriate circumstances:
		113
		114	=over 4
		115
90	=item on_eof => $cb->($handle)	116	=item on_prepare => $cb->($handle)
91		117
92	Set the callback to be called when an end-of-file condition is detected,	118	This (rarely used) callback is called before a new connection is
93	i.e. in the case of a socket, when the other side has closed the	119	attempted, but after the file handle has been created (you can access that
94	connection cleanly.	120	file handle via C<< $handle->{fh} >>). It could be used to prepare the
		121	file handle with parameters required for the actual connect (as opposed to
		122	settings that can be changed when the connection is already established).
95		123
96	For sockets, this just means that the other side has stopped sending data,	124	The return value of this callback should be the connect timeout value in
97	you can still try to write data, and, in fact, one can return from the eof	125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
98	callback and continue writing data, as only the read part has been shut	126	default timeout is to be used).
99	down.
100		127
101	While not mandatory, it is I<highly> recommended to set an eof callback,	128	=item on_connect => $cb->($handle, $host, $port, $retry->())
102	otherwise you might end up with a closed socket while you are still
103	waiting for data.
104		129
105	If an EOF condition has been detected but no C<on_eof> callback has been	130	This callback is called when a connection has been successfully established.
106	set, then a fatal error will be raised with C<$!> set to <0>.
107		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
108	=item on_error => $cb->($handle, $fatal)	154	=item on_error => $cb->($handle, $fatal, $message)
109		155
110	This is the error callback, which is called when, well, some error	156	This is the error callback, which is called when, well, some error
111	occured, such as not being able to resolve the hostname, failure to	157	occured, such as not being able to resolve the hostname, failure to
112	connect or a read error.	158	connect, or a read error.
113		159
114	Some errors are fatal (which is indicated by C<$fatal> being true). On	160	Some errors are fatal (which is indicated by C<$fatal> being true). On
115	fatal errors the handle object will be shut down and will not be usable	161	fatal errors the handle object will be destroyed (by a call to C<< ->
116	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal	162	destroy >>) after invoking the error callback (which means you are free to
117	errors are an EOF condition with active (but unsatisifable) read watchers	163	examine the handle object). Examples of fatal errors are an EOF condition
118	(C<EPIPE>) or I/O errors.	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.
119		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
120	Non-fatal errors can be retried by simply returning, but it is recommended	173	Non-fatal errors can be retried by returning, but it is recommended
121	to simply ignore this parameter and instead abondon the handle object	174	to simply ignore this parameter and instead abondon the handle object
122	when this callback is invoked. Examples of non-fatal errors are timeouts	175	when this callback is invoked. Examples of non-fatal errors are timeouts
123	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
124		177
125	On callback entrance, the value of C<$!> contains the operating system	178	On entry to the callback, the value of C<$!> contains the operating
126	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	179	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		180	C<EPROTO>).
127		181
128	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
129	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
130	C<croak>.	184	C<croak>.
131		185
132	=item on_read => $cb->($handle)	186	=item on_read => $cb->($handle)
133		187
134	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
135	and no read request is in the queue (unlike read queue callbacks, this	189	and no read request is in the queue (unlike read queue callbacks, this
136	callback will only be called when at least one octet of data is in the	190	callback will only be called when at least one octet of data is in the
137	read buffer).	191	read buffer).
138		192
139	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 >>
140	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.
141		197
		198	You can also call C<< ->push_read (...) >> or any other function that
		199	modifies the read queue. Or do both. Or ...
		200
142	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
143	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
144	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
145	error will be raised (with C<$!> set to C<EPIPE>).	204	error will be raised (with C<$!> set to C<EPIPE>).
146		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
147	=item on_drain => $cb->($handle)	227	=item on_drain => $cb->($handle)
148		228
149	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
150	(or when the callback is set and the buffer is empty already).	230	(or immediately if the buffer is empty already).
151		231
152	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.
153		233
154	This callback is useful when you don't want to put all of your write data	234	This callback is useful when you don't want to put all of your write data
155	into the queue at once, for example, when you want to write the contents	235	into the queue at once, for example, when you want to write the contents
…		…
157	memory and push it into the queue, but instead only read more data from	237	memory and push it into the queue, but instead only read more data from
158	the file when the write queue becomes empty.	238	the file when the write queue becomes empty.
159		239
160	=item timeout => $fractional_seconds	240	=item timeout => $fractional_seconds
161		241
		242	=item rtimeout => $fractional_seconds
		243
		244	=item wtimeout => $fractional_seconds
		245
162	If non-zero, then this enables an "inactivity" timeout: whenever this many	246	If non-zero, then these enables an "inactivity" timeout: whenever this
163	seconds pass without a successful read or write on the underlying file	247	many seconds pass without a successful read or write on the underlying
164	handle, the C<on_timeout> callback will be invoked (and if that one is	248	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
165	missing, a non-fatal C<ETIMEDOUT> error will be raised).	249	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		250	error will be raised).
166		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
167	Note that timeout processing is also active when you currently do not have	258	Note that timeout processing is active even when you do not have
168	any outstanding read or write requests: If you plan to keep the connection	259	any outstanding read or write requests: If you plan to keep the connection
169	idle then you should disable the timout temporarily or ignore the timeout	260	idle then you should disable the timeout temporarily or ignore the timeout
170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	261	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
171	restart the timeout.	262	restart the timeout.
172		263
173	Zero (the default) disables this timeout.	264	Zero (the default) disables this timeout.
174		265
…		…
188	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
189	(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
190	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
191	isn't finished).	282	isn't finished).
192		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
193	=item autocork => <boolean>	299	=item autocork => <boolean>
194		300
195	When disabled (the default), then C<push_write> will try to immediately	301	When disabled (the default), C<push_write> will try to immediately
196	write the data to the handle, if possible. This avoids having to register	302	write the data to the handle if possible. This avoids having to register
197	a write watcher and wait for the next event loop iteration, but can	303	a write watcher and wait for the next event loop iteration, but can
198	be inefficient if you write multiple small chunks (on the wire, this	304	be inefficient if you write multiple small chunks (on the wire, this
199	disadvantage is usually avoided by your kernel's nagle algorithm, see	305	disadvantage is usually avoided by your kernel's nagle algorithm, see
200	C<no_delay>, but this option can save costly syscalls).	306	C<no_delay>, but this option can save costly syscalls).
201		307
202	When enabled, then writes will always be queued till the next event loop	308	When enabled, writes will always be queued till the next event loop
203	iteration. This is efficient when you do many small writes per iteration,	309	iteration. This is efficient when you do many small writes per iteration,
204	but less efficient when you do a single write only per iteration (or when	310	but less efficient when you do a single write only per iteration (or when
205	the write buffer often is full). It also increases write latency.	311	the write buffer often is full). It also increases write latency.
206		312
207	=item no_delay => <boolean>	313	=item no_delay => <boolean>
…		…
211	the Nagle algorithm, and usually it is beneficial.	317	the Nagle algorithm, and usually it is beneficial.
212		318
213	In some situations you want as low a delay as possible, which can be	319	In some situations you want as low a delay as possible, which can be
214	accomplishd by setting this option to a true value.	320	accomplishd by setting this option to a true value.
215		321
216	The default is your opertaing system's default behaviour (most likely	322	The default is your operating system's default behaviour (most likely
217	enabled), this option explicitly enables or disables it, if possible.	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.
218		356
219	=item read_size => <bytes>	357	=item read_size => <bytes>
220		358
221	The default read block size (the amount of bytes this module will	359	The initial read block size, the number of bytes this module will try to
222	try to read during each loop iteration, which affects memory	360	read during each loop iteration. Each handle object will consume at least
223	requirements). Default: C<8192>.	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.
224		370
225	=item low_water_mark => <bytes>	371	=item low_water_mark => <bytes>
226		372
227	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
228	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
229	considered empty.	375	considered empty.
230		376
231	Sometimes it can be beneficial (for performance reasons) to add data to	377	Sometimes it can be beneficial (for performance reasons) to add data to
232	the write buffer before it is fully drained, but this is a rare case, as	378	the write buffer before it is fully drained, but this is a rare case, as
233	the operating system kernel usually buffers data as well, so the default	379	the operating system kernel usually buffers data as well, so the default
234	is good in almost all cases.	380	is good in almost all cases.
235		381
236	=item linger => <seconds>	382	=item linger => <seconds>
237		383
238	If non-zero (default: C<3600>), then the destructor of the	384	If this is non-zero (default: C<3600>), the destructor of the
239	AnyEvent::Handle object will check whether there is still outstanding	385	AnyEvent::Handle object will check whether there is still outstanding
240	write data and will install a watcher that will write this data to the	386	write data and will install a watcher that will write this data to the
241	socket. No errors will be reported (this mostly matches how the operating	387	socket. No errors will be reported (this mostly matches how the operating
242	system treats outstanding data at socket close time).	388	system treats outstanding data at socket close time).
243		389
244	This will not work for partial TLS data that could not be encoded	390	This will not work for partial TLS data that could not be encoded
245	yet. This data will be lost.	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>.
246		403
247	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	404	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
248		405
249	When this parameter is given, it enables TLS (SSL) mode, that means	406	When this parameter is given, it enables TLS (SSL) mode, that means
250	AnyEvent will start a TLS handshake as soon as the conenction has been	407	AnyEvent will start a TLS handshake as soon as the connection has been
251	established and will transparently encrypt/decrypt data afterwards.	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.
252		412
253	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
254	automatically when you try to create a TLS handle): this module doesn't	414	automatically when you try to create a TLS handle): this module doesn't
255	have a dependency on that module, so if your module requires it, you have	415	have a dependency on that module, so if your module requires it, you have
256	to add the dependency yourself.	416	to add the dependency yourself.
…		…
260	mode.	420	mode.
261		421
262	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
263	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>
264	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
265	AnyEvent::Handle.	425	AnyEvent::Handle. Also, this module will take ownership of this connection
		426	object.
266		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
267	See the C<< ->starttls >> method for when need to start TLS negotiation later.	437	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
268		438
269	=item tls_ctx => $ssl_ctx	439	=item tls_ctx => $anyevent_tls
270		440
271	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	441	Use the given C<AnyEvent::TLS> object to create the new TLS connection
272	(unless a connection object was specified directly). If this parameter is	442	(unless a connection object was specified directly). If this
273	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.
274		481
275	=item json => JSON or JSON::XS object	482	=item json => JSON or JSON::XS object
276		483
277	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.
278		485
…		…
281	texts.	488	texts.
282		489
283	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
284	use this functionality, as AnyEvent does not have a dependency itself.	491	use this functionality, as AnyEvent does not have a dependency itself.
285		492
286	=item filter_r => $cb
287
288	=item filter_w => $cb
289
290	These exist, but are undocumented at this time. (They are used internally
291	by the TLS code).
292
293	=back	493	=back
294		494
295	=cut	495	=cut
296		496
297	sub new {	497	sub new {
298	my $class = shift;	498	my $class = shift;
299
300	my $self = bless { @_ }, $class;	499	my $self = bless { @_ }, $class;
301		500
302	$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;
303		572
304	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	573	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
305		574
306	if ($self->{tls}) {	575	$self->{_activity} =
307	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
308	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	592	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
309	}	593	if $self->{tls};
310		594
311	$self->{_activity} = AnyEvent->now;
312	$self->_timeout;
313
314	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	595	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
315	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
316		596
317	$self->start_read	597	$self->start_read
318	if $self->{on_read};	598	if $self->{on_read} || @{ $self->{_queue} };
319		599
320	$self	600	$self->_drain_wbuf;
321	}
322
323	sub _shutdown {
324	my ($self) = @_;
325
326	delete $self->{_tw};
327	delete $self->{_rw};
328	delete $self->{_ww};
329	delete $self->{fh};
330
331	&_freetls;
332
333	delete $self->{on_read};
334	delete $self->{_queue};
335	}	601	}
336		602
337	sub _error {	603	sub _error {
338	my ($self, $errno, $fatal) = @_;	604	my ($self, $errno, $fatal, $message) = @_;
339
340	$self->_shutdown
341	if $fatal;
342		605
343	$! = $errno;	606	$! = $errno;
		607	$message ||= "$!";
344		608
345	if ($self->{on_error}) {	609	if ($self->{on_error}) {
346	$self->{on_error}($self, $fatal);	610	$self->{on_error}($self, $fatal, $message);
347	} else {	611	$self->destroy if $fatal;
		612	} elsif ($self->{fh} || $self->{connect}) {
		613	$self->destroy;
348	Carp::croak "AnyEvent::Handle uncaught error: $!";	614	Carp::croak "AnyEvent::Handle uncaught error: $message";
349	}	615	}
350	}	616	}
351		617
352	=item $fh = $handle->fh	618	=item $fh = $handle->fh
353		619
…		…
377	$_[0]{on_eof} = $_[1];	643	$_[0]{on_eof} = $_[1];
378	}	644	}
379		645
380	=item $handle->on_timeout ($cb)	646	=item $handle->on_timeout ($cb)
381		647
382	Replace the current C<on_timeout> callback, or disables the callback (but	648	=item $handle->on_rtimeout ($cb)
383	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
384	argument and method.
385		649
386	=cut	650	=item $handle->on_wtimeout ($cb)
387		651
388	sub on_timeout {	652	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
389	$_[0]{on_timeout} = $_[1];	653	callback, or disables the callback (but not the timeout) if C<$cb> =
390	}	654	C<undef>. See the C<timeout> constructor argument and method.
		655
		656	=cut
		657
		658	# see below
391		659
392	=item $handle->autocork ($boolean)	660	=item $handle->autocork ($boolean)
393		661
394	Enables or disables the current autocork behaviour (see C<autocork>	662	Enables or disables the current autocork behaviour (see C<autocork>
395	constructor argument).	663	constructor argument). Changes will only take effect on the next write.
396		664
397	=cut	665	=cut
		666
		667	sub autocork {
		668	$_[0]{autocork} = $_[1];
		669	}
398		670
399	=item $handle->no_delay ($boolean)	671	=item $handle->no_delay ($boolean)
400		672
401	Enables or disables the C<no_delay> setting (see constructor argument of	673	Enables or disables the C<no_delay> setting (see constructor argument of
402	the same name for details).	674	the same name for details).
…		…
404	=cut	676	=cut
405		677
406	sub no_delay {	678	sub no_delay {
407	$_[0]{no_delay} = $_[1];	679	$_[0]{no_delay} = $_[1];
408		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
409	eval {	695	eval {
410	local $SIG{__DIE__};	696	local $SIG{__DIE__};
411	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	697	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		698	if $_[0]{fh};
412	};	699	};
413	}	700	}
414		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
415	#############################################################################	774	#############################################################################
416		775
417	=item $handle->timeout ($seconds)	776	=item $handle->timeout ($seconds)
418		777
		778	=item $handle->rtimeout ($seconds)
		779
		780	=item $handle->wtimeout ($seconds)
		781
419	Configures (or disables) the inactivity timeout.	782	Configures (or disables) the inactivity timeout.
420		783
421	=cut	784	=item $handle->timeout_reset
422		785
423	sub timeout {	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 {
424	my ($self, $timeout) = @_;	808	my ($self, $new_value) = @_;
425		809
		810	$new_value >= 0
		811	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		812
426	$self->{timeout} = $timeout;	813	$self->{$timeout} = $new_value;
427	$self->_timeout;	814	delete $self->{$tw}; &$cb;
428	}	815	};
429		816
		817	*{"${dir}timeout_reset"} = sub {
		818	$_[0]{$activity} = AE::now;
		819	};
		820
		821	# main workhorse:
430	# reset the timeout watcher, as neccessary	822	# reset the timeout watcher, as neccessary
431	# also check for time-outs	823	# also check for time-outs
432	sub _timeout {	824	$cb = sub {
433	my ($self) = @_;	825	my ($self) = @_;
434		826
435	if ($self->{timeout}) {	827	if ($self->{$timeout} && $self->{fh}) {
436	my $NOW = AnyEvent->now;	828	my $NOW = AE::now;
437		829
438	# when would the timeout trigger?	830	# when would the timeout trigger?
439	my $after = $self->{_activity} + $self->{timeout} - $NOW;	831	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
440		832
441	# now or in the past already?	833	# now or in the past already?
442	if ($after <= 0) {	834	if ($after <= 0) {
443	$self->{_activity} = $NOW;	835	$self->{$activity} = $NOW;
444		836
445	if ($self->{on_timeout}) {	837	if ($self->{$on_timeout}) {
446	$self->{on_timeout}($self);	838	$self->{$on_timeout}($self);
447	} else {	839	} else {
448	$self->_error (&Errno::ETIMEDOUT);	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};
449	}	848	}
450		849
451	# callback could have changed timeout value, optimise	850	Scalar::Util::weaken $self;
452	return unless $self->{timeout};	851	return unless $self; # ->error could have destroyed $self
453		852
454	# calculate new after	853	$self->{$tw} ||= AE::timer $after, 0, sub {
455	$after = $self->{timeout};	854	delete $self->{$tw};
		855	$cb->($self);
		856	};
		857	} else {
		858	delete $self->{$tw};
456	}	859	}
457
458	Scalar::Util::weaken $self;
459	return unless $self; # ->error could have destroyed $self
460
461	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
462	delete $self->{_tw};
463	$self->_timeout;
464	});
465	} else {
466	delete $self->{_tw};
467	}	860	}
468	}	861	}
469		862
470	#############################################################################	863	#############################################################################
471		864
…		…
487	=item $handle->on_drain ($cb)	880	=item $handle->on_drain ($cb)
488		881
489	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
490	C<on_drain> in the constructor).	883	C<on_drain> in the constructor).
491		884
		885	This method may invoke callbacks (and therefore the handle might be
		886	destroyed after it returns).
		887
492	=cut	888	=cut
493		889
494	sub on_drain {	890	sub on_drain {
495	my ($self, $cb) = @_;	891	my ($self, $cb) = @_;
496		892
497	$self->{on_drain} = $cb;	893	$self->{on_drain} = $cb;
498		894
499	$cb->($self)	895	$cb->($self)
500	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	896	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
501	}	897	}
502		898
503	=item $handle->push_write ($data)	899	=item $handle->push_write ($data)
504		900
505	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
506	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
507	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).
508		907
509	=cut	908	=cut
510		909
511	sub _drain_wbuf {	910	sub _drain_wbuf {
512	my ($self) = @_;	911	my ($self) = @_;
…		…
516	Scalar::Util::weaken $self;	915	Scalar::Util::weaken $self;
517		916
518	my $cb = sub {	917	my $cb = sub {
519	my $len = syswrite $self->{fh}, $self->{wbuf};	918	my $len = syswrite $self->{fh}, $self->{wbuf};
520		919
521	if ($len >= 0) {	920	if (defined $len) {
522	substr $self->{wbuf}, 0, $len, "";	921	substr $self->{wbuf}, 0, $len, "";
523		922
524	$self->{_activity} = AnyEvent->now;	923	$self->{_activity} = $self->{_wactivity} = AE::now;
525		924
526	$self->{on_drain}($self)	925	$self->{on_drain}($self)
527	if $self->{low_water_mark} >= length $self->{wbuf}	926	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
528	&& $self->{on_drain};	927	&& $self->{on_drain};
529		928
530	delete $self->{_ww} unless length $self->{wbuf};	929	delete $self->{_ww} unless length $self->{wbuf};
531	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	930	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
532	$self->_error ($!, 1);	931	$self->_error ($!, 1);
…		…
535		934
536	# try to write data immediately	935	# try to write data immediately
537	$cb->() unless $self->{autocork};	936	$cb->() unless $self->{autocork};
538		937
539	# if still data left in wbuf, we need to poll	938	# if still data left in wbuf, we need to poll
540	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	939	$self->{_ww} = AE::io $self->{fh}, 1, $cb
541	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	}
542	};	948	};
543	}	949	}
544		950
545	our %WH;	951	our %WH;
546		952
		953	# deprecated
547	sub register_write_type($$) {	954	sub register_write_type($$) {
548	$WH{$_[0]} = $_[1];	955	$WH{$_[0]} = $_[1];
549	}	956	}
550		957
551	sub push_write {	958	sub push_write {
552	my $self = shift;	959	my $self = shift;
553		960
554	if (@_ > 1) {	961	if (@_ > 1) {
555	my $type = shift;	962	my $type = shift;
556		963
		964	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
557	@_ = ($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")
558	->($self, @_);	966	->($self, @_);
559	}	967	}
560		968
		969	# we downgrade here to avoid hard-to-track-down bugs,
		970	# and diagnose the problem earlier and better.
		971
561	if ($self->{filter_w}) {	972	if ($self->{tls}) {
562	$self->{filter_w}($self, \$_[0]);	973	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
		974	&_dotls ($self) if $self->{fh};
563	} else {	975	} else {
564	$self->{wbuf} .= $_[0];	976	utf8::downgrade $self->{wbuf} .= $_[0];
565	$self->_drain_wbuf;	977	$self->_drain_wbuf if $self->{fh};
566	}	978	}
567	}	979	}
568		980
569	=item $handle->push_write (type => @args)	981	=item $handle->push_write (type => @args)
570		982
571	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
572	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).
573		988
574	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
575	drop by and tell us):	990	drop by and tell us):
576		991
577	=over 4	992	=over 4
…		…
584	=cut	999	=cut
585		1000
586	register_write_type netstring => sub {	1001	register_write_type netstring => sub {
587	my ($self, $string) = @_;	1002	my ($self, $string) = @_;
588		1003
589	sprintf "%d:%s,", (length $string), $string	1004	(length $string) . ":$string,"
590	};	1005	};
591		1006
592	=item packstring => $format, $data	1007	=item packstring => $format, $data
593		1008
594	An octet string prefixed with an encoded length. The encoding C<$format>	1009	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
634	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
635	this line into their JSON decoder of choice.	1050	this line into their JSON decoder of choice.
636		1051
637	=cut	1052	=cut
638		1053
		1054	sub json_coder() {
		1055	eval { require JSON::XS; JSON::XS->new->utf8 }
		1056	|| do { require JSON; JSON->new->utf8 }
		1057	}
		1058
639	register_write_type json => sub {	1059	register_write_type json => sub {
640	my ($self, $ref) = @_;	1060	my ($self, $ref) = @_;
641		1061
642	require JSON;	1062	my $json = $self->{json} ||= json_coder;
643		1063
644	$self->{json} ? $self->{json}->encode ($ref)	1064	$json->encode ($ref)
645	: JSON::encode_json ($ref)
646	};	1065	};
647		1066
648	=item storable => $reference	1067	=item storable => $reference
649		1068
650	Freezes the given reference using L<Storable> and writes it to the	1069	Freezes the given reference using L<Storable> and writes it to the
…		…
660	pack "w/a*", Storable::nfreeze ($ref)	1079	pack "w/a*", Storable::nfreeze ($ref)
661	};	1080	};
662		1081
663	=back	1082	=back
664		1083
665	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1084	=item $handle->push_shutdown
666		1085
667	This function (not method) lets you add your own types to C<push_write>.	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
668	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
669	reference with the handle object and the remaining arguments.	1121	the handle object and the remaining arguments.
670		1122
671	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
672	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.
673		1126
674	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
675	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	}
676		1143
677	=cut	1144	=cut
678		1145
679	#############################################################################	1146	#############################################################################
680		1147
…		…
689	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
690	a queue.	1157	a queue.
691		1158
692	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
693	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
694	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1161	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
695	leave the data there if you want to accumulate more (e.g. when only a	1162	leave the data there if you want to accumulate more (e.g. when only a
696	partial message has been received so far).	1163	partial message has been received so far), or change the read queue with
		1164	e.g. C<push_read>.
697		1165
698	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
699	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
700	data arrives (also the first time it is queued) and removes it when it has	1168	data arrives (also the first time it is queued) and remove it when it has
701	done its job (see C<push_read>, below).	1169	done its job (see C<push_read>, below).
702		1170
703	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
704	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.
705		1173
…		…
762	=cut	1230	=cut
763		1231
764	sub _drain_rbuf {	1232	sub _drain_rbuf {
765	my ($self) = @_;	1233	my ($self) = @_;
766		1234
		1235	# avoid recursion
		1236	return if $self->{_skip_drain_rbuf};
767	local $self->{_in_drain} = 1;	1237	local $self->{_skip_drain_rbuf} = 1;
768
769	if (
770	defined $self->{rbuf_max}
771	&& $self->{rbuf_max} < length $self->{rbuf}
772	) {
773	$self->_error (&Errno::ENOSPC, 1), return;
774	}
775		1238
776	while () {	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
777	my $len = length $self->{rbuf};	1245	my $len = length $self->{rbuf};
778		1246
779	if (my $cb = shift @{ $self->{_queue} }) {	1247	if (my $cb = shift @{ $self->{_queue} }) {
780	unless ($cb->($self)) {	1248	unless ($cb->($self)) {
781	if ($self->{_eof}) {	1249	# no progress can be made
782	# no progress can be made (not enough data and no data forthcoming)	1250	# (not enough data and no data forthcoming)
783	$self->_error (&Errno::EPIPE, 1), return;	1251	$self->_error (Errno::EPIPE, 1), return
784	}	1252	if $self->{_eof};
785		1253
786	unshift @{ $self->{_queue} }, $cb;	1254	unshift @{ $self->{_queue} }, $cb;
787	last;	1255	last;
788	}	1256	}
789	} elsif ($self->{on_read}) {	1257	} elsif ($self->{on_read}) {
…		…
796	&& !@{ $self->{_queue} } # and the queue is still empty	1264	&& !@{ $self->{_queue} } # and the queue is still empty
797	&& $self->{on_read} # but we still have on_read	1265	&& $self->{on_read} # but we still have on_read
798	) {	1266	) {
799	# no further data will arrive	1267	# no further data will arrive
800	# so no progress can be made	1268	# so no progress can be made
801	$self->_error (&Errno::EPIPE, 1), return	1269	$self->_error (Errno::EPIPE, 1), return
802	if $self->{_eof};	1270	if $self->{_eof};
803		1271
804	last; # more data might arrive	1272	last; # more data might arrive
805	}	1273	}
806	} else {	1274	} else {
807	# read side becomes idle	1275	# read side becomes idle
808	delete $self->{_rw};	1276	delete $self->{_rw} unless $self->{tls};
809	last;	1277	last;
810	}	1278	}
811	}	1279	}
812		1280
813	if ($self->{_eof}) {	1281	if ($self->{_eof}) {
814	if ($self->{on_eof}) {	1282	$self->{on_eof}
815	$self->{on_eof}($self)	1283	? $self->{on_eof}($self)
816	} else {	1284	: $self->_error (0, 1, "Unexpected end-of-file");
817	$self->_error (0, 1);	1285
818	}	1286	return;
		1287	}
		1288
		1289	if (
		1290	defined $self->{rbuf_max}
		1291	&& $self->{rbuf_max} < length $self->{rbuf}
		1292	) {
		1293	$self->_error (Errno::ENOSPC, 1), return;
819	}	1294	}
820		1295
821	# may need to restart read watcher	1296	# may need to restart read watcher
822	unless ($self->{_rw}) {	1297	unless ($self->{_rw}) {
823	$self->start_read	1298	$self->start_read
…		…
829		1304
830	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
831	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
832	constructor.	1307	constructor.
833		1308
		1309	This method may invoke callbacks (and therefore the handle might be
		1310	destroyed after it returns).
		1311
834	=cut	1312	=cut
835		1313
836	sub on_read {	1314	sub on_read {
837	my ($self, $cb) = @_;	1315	my ($self, $cb) = @_;
838		1316
839	$self->{on_read} = $cb;	1317	$self->{on_read} = $cb;
840	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1318	$self->_drain_rbuf if $cb;
841	}	1319	}
842		1320
843	=item $handle->rbuf	1321	=item $handle->rbuf
844		1322
845	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).
846		1326
847	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)
848	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.
849		1330
850	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>
851	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
852	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.
853		1335
854	=cut	1336	=cut
855		1337
856	sub rbuf : lvalue {	1338	sub rbuf : lvalue {
857	$_[0]{rbuf}	1339	$_[0]{rbuf}
…		…
874		1356
875	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
876	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
877	true, it will be removed from the queue.	1359	true, it will be removed from the queue.
878		1360
		1361	These methods may invoke callbacks (and therefore the handle might be
		1362	destroyed after it returns).
		1363
879	=cut	1364	=cut
880		1365
881	our %RH;	1366	our %RH;
882		1367
883	sub register_read_type($$) {	1368	sub register_read_type($$) {
…		…
889	my $cb = pop;	1374	my $cb = pop;
890		1375
891	if (@_) {	1376	if (@_) {
892	my $type = shift;	1377	my $type = shift;
893		1378
		1379	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
894	$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")
895	->($self, $cb, @_);	1381	->($self, $cb, @_);
896	}	1382	}
897		1383
898	push @{ $self->{_queue} }, $cb;	1384	push @{ $self->{_queue} }, $cb;
899	$self->_drain_rbuf unless $self->{_in_drain};	1385	$self->_drain_rbuf;
900	}	1386	}
901		1387
902	sub unshift_read {	1388	sub unshift_read {
903	my $self = shift;	1389	my $self = shift;
904	my $cb = pop;	1390	my $cb = pop;
905		1391
906	if (@_) {	1392	if (@_) {
907	my $type = shift;	1393	my $type = shift;
908		1394
		1395	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
909	$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")
910	->($self, $cb, @_);	1397	->($self, $cb, @_);
911	}	1398	}
912		1399
913
914	unshift @{ $self->{_queue} }, $cb;	1400	unshift @{ $self->{_queue} }, $cb;
915	$self->_drain_rbuf unless $self->{_in_drain};	1401	$self->_drain_rbuf;
916	}	1402	}
917		1403
918	=item $handle->push_read (type => @args, $cb)	1404	=item $handle->push_read (type => @args, $cb)
919		1405
920	=item $handle->unshift_read (type => @args, $cb)	1406	=item $handle->unshift_read (type => @args, $cb)
921		1407
922	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
923	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
924	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).
925		1413
926	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
927	drop by and tell us):	1415	drop by and tell us):
928		1416
929	=over 4	1417	=over 4
…		…
1021	the receive buffer when neither C<$accept> nor C<$reject> match,	1509	the receive buffer when neither C<$accept> nor C<$reject> match,
1022	and everything preceding and including the match will be accepted	1510	and everything preceding and including the match will be accepted
1023	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
1024	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
1025	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
1026	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.
1027		1515
1028	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
1029	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
1030	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
1031	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
1032	required for the accept regex.	1520	required for the accept regex.
1033		1521
1034	$handle->push_read (regex =>	1522	$handle->push_read (regex =>
…		…
1053	return 1;	1541	return 1;
1054	}	1542	}
1055		1543
1056	# reject	1544	# reject
1057	if ($reject && $$rbuf =~ $reject) {	1545	if ($reject && $$rbuf =~ $reject) {
1058	$self->_error (&Errno::EBADMSG);	1546	$self->_error (Errno::EBADMSG);
1059	}	1547	}
1060		1548
1061	# skip	1549	# skip
1062	if ($skip && $$rbuf =~ $skip) {	1550	if ($skip && $$rbuf =~ $skip) {
1063	$data .= substr $$rbuf, 0, $+[0], "";	1551	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1079	my ($self, $cb) = @_;	1567	my ($self, $cb) = @_;
1080		1568
1081	sub {	1569	sub {
1082	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1570	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1083	if ($_[0]{rbuf} =~ /[^0-9]/) {	1571	if ($_[0]{rbuf} =~ /[^0-9]/) {
1084	$self->_error (&Errno::EBADMSG);	1572	$self->_error (Errno::EBADMSG);
1085	}	1573	}
1086	return;	1574	return;
1087	}	1575	}
1088		1576
1089	my $len = $1;	1577	my $len = $1;
…		…
1092	my $string = $_[1];	1580	my $string = $_[1];
1093	$_[0]->unshift_read (chunk => 1, sub {	1581	$_[0]->unshift_read (chunk => 1, sub {
1094	if ($_[1] eq ",") {	1582	if ($_[1] eq ",") {
1095	$cb->($_[0], $string);	1583	$cb->($_[0], $string);
1096	} else {	1584	} else {
1097	$self->_error (&Errno::EBADMSG);	1585	$self->_error (Errno::EBADMSG);
1098	}	1586	}
1099	});	1587	});
1100	});	1588	});
1101		1589
1102	1	1590	1
…		…
1108	An octet string prefixed with an encoded length. The encoding C<$format>	1596	An octet string prefixed with an encoded length. The encoding C<$format>
1109	uses the same format as a Perl C<pack> format, but must specify a single	1597	uses the same format as a Perl C<pack> format, but must specify a single
1110	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1598	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1111	optional C<!>, C<< < >> or C<< > >> modifier).	1599	optional C<!>, C<< < >> or C<< > >> modifier).
1112		1600
1113	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	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).
1114		1603
1115	Example: read a block of data prefixed by its length in BER-encoded	1604	Example: read a block of data prefixed by its length in BER-encoded
1116	format (very efficient).	1605	format (very efficient).
1117		1606
1118	$handle->push_read (packstring => "w", sub {	1607	$handle->push_read (packstring => "w", sub {
…		…
1148	}	1637	}
1149	};	1638	};
1150		1639
1151	=item json => $cb->($handle, $hash_or_arrayref)	1640	=item json => $cb->($handle, $hash_or_arrayref)
1152		1641
1153	Reads a JSON object or array, decodes it and passes it to the callback.	1642	Reads a JSON object or array, decodes it and passes it to the
		1643	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1154		1644
1155	If a C<json> object was passed to the constructor, then that will be used	1645	If a C<json> object was passed to the constructor, then that will be used
1156	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1646	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1157		1647
1158	This read type uses the incremental parser available with JSON version	1648	This read type uses the incremental parser available with JSON version
…		…
1167	=cut	1657	=cut
1168		1658
1169	register_read_type json => sub {	1659	register_read_type json => sub {
1170	my ($self, $cb) = @_;	1660	my ($self, $cb) = @_;
1171		1661
1172	require JSON;	1662	my $json = $self->{json} ||= json_coder;
1173		1663
1174	my $data;	1664	my $data;
1175	my $rbuf = \$self->{rbuf};	1665	my $rbuf = \$self->{rbuf};
1176		1666
1177	my $json = $self->{json} ||= JSON->new->utf8;
1178
1179	sub {	1667	sub {
1180	my $ref = $json->incr_parse ($self->{rbuf});	1668	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1181		1669
1182	if ($ref) {	1670	if ($ref) {
1183	$self->{rbuf} = $json->incr_text;	1671	$self->{rbuf} = $json->incr_text;
1184	$json->incr_text = "";	1672	$json->incr_text = "";
1185	$cb->($self, $ref);	1673	$cb->($self, $ref);
1186		1674
1187	1	1675	1
		1676	} elsif ($@) {
		1677	# error case
		1678	$json->incr_skip;
		1679
		1680	$self->{rbuf} = $json->incr_text;
		1681	$json->incr_text = "";
		1682
		1683	$self->_error (Errno::EBADMSG);
		1684
		1685	()
1188	} else {	1686	} else {
1189	$self->{rbuf} = "";	1687	$self->{rbuf} = "";
		1688
1190	()	1689	()
1191	}	1690	}
1192	}	1691	}
1193	};	1692	};
1194		1693
…		…
1226	# read remaining chunk	1725	# read remaining chunk
1227	$_[0]->unshift_read (chunk => $len, sub {	1726	$_[0]->unshift_read (chunk => $len, sub {
1228	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1727	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1229	$cb->($_[0], $ref);	1728	$cb->($_[0], $ref);
1230	} else {	1729	} else {
1231	$self->_error (&Errno::EBADMSG);	1730	$self->_error (Errno::EBADMSG);
1232	}	1731	}
1233	});	1732	});
1234	}	1733	}
1235		1734
1236	1	1735	1
1237	}	1736	}
1238	};	1737	};
1239		1738
1240	=back	1739	=back
1241		1740
1242	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1741	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1243		1742
1244	This function (not method) lets you add your own types to C<push_read>.	1743	Instead of one of the predefined types, you can also specify the name
		1744	of a package. AnyEvent will try to load the package and then expects to
		1745	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1746	progressively tries to load the parent package until it either finds the
		1747	function (good) or runs out of packages (bad).
1245		1748
1246	Whenever the given C<type> is used, C<push_read> will invoke the code	1749	Whenever this type is used, C<push_read> will invoke the function with the
1247	reference with the handle object, the callback and the remaining	1750	handle object, the original callback and the remaining arguments.
1248	arguments.
1249		1751
1250	The code reference is supposed to return a callback (usually a closure)	1752	The function is supposed to return a callback (usually a closure) that
1251	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1753	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1754	mentally treat the function as a "configurable read type to read callback"
		1755	converter.
1252		1756
1253	It should invoke the passed callback when it is done reading (remember to	1757	It should invoke the original callback when it is done reading (remember
1254	pass C<$handle> as first argument as all other callbacks do that).	1758	to pass C<$handle> as first argument as all other callbacks do that,
		1759	although there is no strict requirement on this).
1255		1760
1256	Note that this is a function, and all types registered this way will be
1257	global, so try to use unique names.
1258
1259	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1761	For examples, see the source of this module (F<perldoc -m
1260	search for C<register_read_type>)).	1762	AnyEvent::Handle>, search for C<register_read_type>)).
1261		1763
1262	=item $handle->stop_read	1764	=item $handle->stop_read
1263		1765
1264	=item $handle->start_read	1766	=item $handle->start_read
1265		1767
…		…
1271	Note that AnyEvent::Handle will automatically C<start_read> for you when	1773	Note that AnyEvent::Handle will automatically C<start_read> for you when
1272	you change the C<on_read> callback or push/unshift a read callback, and it	1774	you change the C<on_read> callback or push/unshift a read callback, and it
1273	will automatically C<stop_read> for you when neither C<on_read> is set nor	1775	will automatically C<stop_read> for you when neither C<on_read> is set nor
1274	there are any read requests in the queue.	1776	there are any read requests in the queue.
1275		1777
		1778	These methods will have no effect when in TLS mode (as TLS doesn't support
		1779	half-duplex connections).
		1780
1276	=cut	1781	=cut
1277		1782
1278	sub stop_read {	1783	sub stop_read {
1279	my ($self) = @_;	1784	my ($self) = @_;
1280		1785
1281	delete $self->{_rw};	1786	delete $self->{_rw} unless $self->{tls};
1282	}	1787	}
1283		1788
1284	sub start_read {	1789	sub start_read {
1285	my ($self) = @_;	1790	my ($self) = @_;
1286		1791
1287	unless ($self->{_rw} || $self->{_eof}) {	1792	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1288	Scalar::Util::weaken $self;	1793	Scalar::Util::weaken $self;
1289		1794
1290	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1795	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1291	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1796	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1292	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1797	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1293		1798
1294	if ($len > 0) {	1799	if ($len > 0) {
1295	$self->{_activity} = AnyEvent->now;	1800	$self->{_activity} = $self->{_ractivity} = AE::now;
1296		1801
1297	$self->{filter_r}	1802	if ($self->{tls}) {
1298	? $self->{filter_r}($self, $rbuf)	1803	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1299	: $self->{_in_drain} || $self->_drain_rbuf;	1804
		1805	&_dotls ($self);
		1806	} else {
		1807	$self->_drain_rbuf;
		1808	}
		1809
		1810	if ($len == $self->{read_size}) {
		1811	$self->{read_size} *= 2;
		1812	$self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
		1813	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		1814	}
1300		1815
1301	} elsif (defined $len) {	1816	} elsif (defined $len) {
1302	delete $self->{_rw};	1817	delete $self->{_rw};
1303	$self->{_eof} = 1;	1818	$self->{_eof} = 1;
1304	$self->_drain_rbuf unless $self->{_in_drain};	1819	$self->_drain_rbuf;
1305		1820
1306	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1821	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1307	return $self->_error ($!, 1);	1822	return $self->_error ($!, 1);
1308	}	1823	}
1309	});	1824	};
1310	}	1825	}
1311	}	1826	}
1312		1827
		1828	our $ERROR_SYSCALL;
		1829	our $ERROR_WANT_READ;
		1830
		1831	sub _tls_error {
		1832	my ($self, $err) = @_;
		1833
		1834	return $self->_error ($!, 1)
		1835	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1836
		1837	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1838
		1839	# reduce error string to look less scary
		1840	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1841
		1842	if ($self->{_on_starttls}) {
		1843	(delete $self->{_on_starttls})->($self, undef, $err);
		1844	&_freetls;
		1845	} else {
		1846	&_freetls;
		1847	$self->_error (Errno::EPROTO, 1, $err);
		1848	}
		1849	}
		1850
		1851	# poll the write BIO and send the data if applicable
		1852	# also decode read data if possible
		1853	# this is basiclaly our TLS state machine
		1854	# more efficient implementations are possible with openssl,
		1855	# but not with the buggy and incomplete Net::SSLeay.
1313	sub _dotls {	1856	sub _dotls {
1314	my ($self) = @_;	1857	my ($self) = @_;
1315		1858
1316	my $buf;	1859	my $tmp;
1317		1860
1318	if (length $self->{_tls_wbuf}) {	1861	if (length $self->{_tls_wbuf}) {
1319	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1862	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1320	substr $self->{_tls_wbuf}, 0, $len, "";	1863	substr $self->{_tls_wbuf}, 0, $tmp, "";
1321	}	1864	}
1322	}
1323		1865
		1866	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1867	return $self->_tls_error ($tmp)
		1868	if $tmp != $ERROR_WANT_READ
		1869	&& ($tmp != $ERROR_SYSCALL || $!);
		1870	}
		1871
1324	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1872	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1325	unless (length $buf) {	1873	unless (length $tmp) {
1326	# let's treat SSL-eof as we treat normal EOF	1874	$self->{_on_starttls}
1327	delete $self->{_rw};	1875	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1328	$self->{_eof} = 1;
1329	&_freetls;	1876	&_freetls;
		1877
		1878	if ($self->{on_stoptls}) {
		1879	$self->{on_stoptls}($self);
		1880	return;
		1881	} else {
		1882	# let's treat SSL-eof as we treat normal EOF
		1883	delete $self->{_rw};
		1884	$self->{_eof} = 1;
		1885	}
1330	}	1886	}
1331		1887
1332	$self->{rbuf} .= $buf;	1888	$self->{_tls_rbuf} .= $tmp;
1333	$self->_drain_rbuf unless $self->{_in_drain};	1889	$self->_drain_rbuf;
1334	$self->{tls} or return; # tls session might have gone away in callback	1890	$self->{tls} or return; # tls session might have gone away in callback
1335	}	1891	}
1336		1892
1337	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1893	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1338
1339	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1340	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1341	return $self->_error ($!, 1);	1894	return $self->_tls_error ($tmp)
1342	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1895	if $tmp != $ERROR_WANT_READ
1343	return $self->_error (&Errno::EIO, 1);	1896	&& ($tmp != $ERROR_SYSCALL || $!);
1344	}
1345		1897
1346	# all others are fine for our purposes
1347	}
1348
1349	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1898	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1350	$self->{wbuf} .= $buf;	1899	$self->{wbuf} .= $tmp;
1351	$self->_drain_wbuf;	1900	$self->_drain_wbuf;
		1901	$self->{tls} or return; # tls session might have gone away in callback
1352	}	1902	}
		1903
		1904	$self->{_on_starttls}
		1905	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1906	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1353	}	1907	}
1354		1908
1355	=item $handle->starttls ($tls[, $tls_ctx])	1909	=item $handle->starttls ($tls[, $tls_ctx])
1356		1910
1357	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1911	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1358	object is created, you can also do that at a later time by calling	1912	object is created, you can also do that at a later time by calling
1359	C<starttls>.	1913	C<starttls>.
1360		1914
		1915	Starting TLS is currently an asynchronous operation - when you push some
		1916	write data and then call C<< ->starttls >> then TLS negotiation will start
		1917	immediately, after which the queued write data is then sent.
		1918
1361	The first argument is the same as the C<tls> constructor argument (either	1919	The first argument is the same as the C<tls> constructor argument (either
1362	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1920	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1363		1921
1364	The second argument is the optional C<Net::SSLeay::CTX> object that is	1922	The second argument is the optional C<AnyEvent::TLS> object that is used
1365	used when AnyEvent::Handle has to create its own TLS connection object.	1923	when AnyEvent::Handle has to create its own TLS connection object, or
		1924	a hash reference with C<< key => value >> pairs that will be used to
		1925	construct a new context.
1366		1926
1367	The TLS connection object will end up in C<< $handle->{tls} >> after this	1927	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1368	call and can be used or changed to your liking. Note that the handshake	1928	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1369	might have already started when this function returns.	1929	changed to your liking. Note that the handshake might have already started
		1930	when this function returns.
1370		1931
1371	If it an error to start a TLS handshake more than once per	1932	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1372	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1933	handshakes on the same stream. It is best to not attempt to use the
		1934	stream after stopping TLS.
1373		1935
		1936	This method may invoke callbacks (and therefore the handle might be
		1937	destroyed after it returns).
		1938
1374	=cut	1939	=cut
		1940
		1941	our %TLS_CACHE; #TODO not yet documented, should we?
1375		1942
1376	sub starttls {	1943	sub starttls {
1377	my ($self, $ssl, $ctx) = @_;	1944	my ($self, $tls, $ctx) = @_;
1378		1945
1379	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"	1946	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1380	if $self->{tls};	1947	if $self->{tls};
		1948
		1949	$self->{tls} = $tls;
		1950	$self->{tls_ctx} = $ctx if @_ > 2;
		1951
		1952	return unless $self->{fh};
		1953
		1954	require Net::SSLeay;
		1955
		1956	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1957	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1958
		1959	$tls = delete $self->{tls};
		1960	$ctx = $self->{tls_ctx};
		1961
		1962	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1963
		1964	if ("HASH" eq ref $ctx) {
		1965	require AnyEvent::TLS;
		1966
		1967	if ($ctx->{cache}) {
		1968	my $key = $ctx+0;
		1969	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1970	} else {
		1971	$ctx = new AnyEvent::TLS %$ctx;
		1972	}
		1973	}
1381		1974
1382	if ($ssl eq "accept") {	1975	$self->{tls_ctx} = $ctx || TLS_CTX ();
1383	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1976	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1384	Net::SSLeay::set_accept_state ($ssl);
1385	} elsif ($ssl eq "connect") {
1386	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1387	Net::SSLeay::set_connect_state ($ssl);
1388	}
1389
1390	$self->{tls} = $ssl;
1391		1977
1392	# basically, this is deep magic (because SSL_read should have the same issues)	1978	# basically, this is deep magic (because SSL_read should have the same issues)
1393	# but the openssl maintainers basically said: "trust us, it just works".	1979	# but the openssl maintainers basically said: "trust us, it just works".
1394	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1980	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1395	# and mismaintained ssleay-module doesn't even offer them).	1981	# and mismaintained ssleay-module doesn't even offer them).
1396	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1982	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1397	#	1983	#
1398	# in short: this is a mess.	1984	# in short: this is a mess.
1399	#	1985	#
1400	# note that we do not try to kepe the length constant between writes as we are required to do.	1986	# note that we do not try to keep the length constant between writes as we are required to do.
1401	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1987	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1402	# and we drive openssl fully in blocking mode here.	1988	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1989	# have identity issues in that area.
1403	Net::SSLeay::CTX_set_mode ($self->{tls},	1990	# Net::SSLeay::CTX_set_mode ($ssl,
1404	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1991	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1405	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1992	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1993	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1406		1994
1407	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1995	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1408	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1996	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1409		1997
		1998	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1999
1410	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	2000	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1411		2001
1412	$self->{filter_w} = sub {	2002	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1413	$_[0]{_tls_wbuf} .= ${$_[1]};	2003	if $self->{on_starttls};
1414	&_dotls;
1415	};
1416	$self->{filter_r} = sub {
1417	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1418	&_dotls;
1419	};
1420		2004
1421	&_dotls; # need to trigger the initial negotiation exchange	2005	&_dotls; # need to trigger the initial handshake
		2006	$self->start_read; # make sure we actually do read
1422	}	2007	}
1423		2008
1424	=item $handle->stoptls	2009	=item $handle->stoptls
1425		2010
1426	Shuts down the SSL connection - this makes a proper EOF handshake by	2011	Shuts down the SSL connection - this makes a proper EOF handshake by
1427	sending a close notify to the other side, but since OpenSSL doesn't	2012	sending a close notify to the other side, but since OpenSSL doesn't
1428	support non-blocking shut downs, it is not possible to re-use the stream	2013	support non-blocking shut downs, it is not guaranteed that you can re-use
1429	afterwards.	2014	the stream afterwards.
		2015
		2016	This method may invoke callbacks (and therefore the handle might be
		2017	destroyed after it returns).
1430		2018
1431	=cut	2019	=cut
1432		2020
1433	sub stoptls {	2021	sub stoptls {
1434	my ($self) = @_;	2022	my ($self) = @_;
1435		2023
1436	if ($self->{tls}) {	2024	if ($self->{tls} && $self->{fh}) {
1437	Net::SSLeay::shutdown $self->{tls};	2025	Net::SSLeay::shutdown ($self->{tls});
1438		2026
1439	&_dotls;	2027	&_dotls;
1440		2028
1441	# we don't give a shit. no, we do, but we can't. no...	2029	# # we don't give a shit. no, we do, but we can't. no...#d#
1442	# we, we... have to use openssl :/	2030	# # we, we... have to use openssl :/#d#
1443	&_freetls;	2031	# &_freetls;#d#
1444	}	2032	}
1445	}	2033	}
1446		2034
1447	sub _freetls {	2035	sub _freetls {
1448	my ($self) = @_;	2036	my ($self) = @_;
1449		2037
1450	return unless $self->{tls};	2038	return unless $self->{tls};
1451		2039
1452	Net::SSLeay::free (delete $self->{tls});	2040	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2041	if $self->{tls} > 0;
1453		2042
1454	delete @$self{qw(_rbio filter_w _wbio filter_r)};	2043	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1455	}	2044	}
1456		2045
1457	sub DESTROY {	2046	sub DESTROY {
1458	my $self = shift;	2047	my ($self) = @_;
1459		2048
1460	&_freetls;	2049	&_freetls;
1461		2050
1462	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	2051	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1463		2052
1464	if ($linger && length $self->{wbuf}) {	2053	if ($linger && length $self->{wbuf} && $self->{fh}) {
1465	my $fh = delete $self->{fh};	2054	my $fh = delete $self->{fh};
1466	my $wbuf = delete $self->{wbuf};	2055	my $wbuf = delete $self->{wbuf};
1467		2056
1468	my @linger;	2057	my @linger;
1469		2058
1470	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2059	push @linger, AE::io $fh, 1, sub {
1471	my $len = syswrite $fh, $wbuf, length $wbuf;	2060	my $len = syswrite $fh, $wbuf, length $wbuf;
1472		2061
1473	if ($len > 0) {	2062	if ($len > 0) {
1474	substr $wbuf, 0, $len, "";	2063	substr $wbuf, 0, $len, "";
1475	} else {	2064	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1476	@linger = (); # end	2065	@linger = (); # end
1477	}	2066	}
		2067	};
		2068	push @linger, AE::timer $linger, 0, sub {
		2069	@linger = ();
		2070	};
		2071	}
		2072	}
		2073
		2074	=item $handle->destroy
		2075
		2076	Shuts down the handle object as much as possible - this call ensures that
		2077	no further callbacks will be invoked and as many resources as possible
		2078	will be freed. Any method you will call on the handle object after
		2079	destroying it in this way will be silently ignored (and it will return the
		2080	empty list).
		2081
		2082	Normally, you can just "forget" any references to an AnyEvent::Handle
		2083	object and it will simply shut down. This works in fatal error and EOF
		2084	callbacks, as well as code outside. It does I<NOT> work in a read or write
		2085	callback, so when you want to destroy the AnyEvent::Handle object from
		2086	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		2087	that case.
		2088
		2089	Destroying the handle object in this way has the advantage that callbacks
		2090	will be removed as well, so if those are the only reference holders (as
		2091	is common), then one doesn't need to do anything special to break any
		2092	reference cycles.
		2093
		2094	The handle might still linger in the background and write out remaining
		2095	data, as specified by the C<linger> option, however.
		2096
		2097	=cut
		2098
		2099	sub destroy {
		2100	my ($self) = @_;
		2101
		2102	$self->DESTROY;
		2103	%$self = ();
		2104	bless $self, "AnyEvent::Handle::destroyed";
		2105	}
		2106
		2107	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2108	#nop
		2109	}
		2110
		2111	=item $handle->destroyed
		2112
		2113	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2114	->destroy >>, true otherwise.
		2115
		2116	Can be useful to decide whether the handle is still valid after some
		2117	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2118	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2119	can destroy the handle, so work can be avoided by checking sometimes:
		2120
		2121	$hdl->starttls ("accept");
		2122	return if $hdl->destroyed;
		2123	$hdl->push_write (...
		2124
		2125	Note that the call to C<push_write> will silently be ignored if the handle
		2126	has been destroyed, so often you can just ignore the possibility of the
		2127	handle being destroyed.
		2128
		2129	=cut
		2130
		2131	sub destroyed { 0 }
		2132	sub AnyEvent::Handle::destroyed::destroyed { 1 }
		2133
		2134	=item AnyEvent::Handle::TLS_CTX
		2135
		2136	This function creates and returns the AnyEvent::TLS object used by default
		2137	for TLS mode.
		2138
		2139	The context is created by calling L<AnyEvent::TLS> without any arguments.
		2140
		2141	=cut
		2142
		2143	our $TLS_CTX;
		2144
		2145	sub TLS_CTX() {
		2146	$TLS_CTX ||= do {
		2147	require AnyEvent::TLS;
		2148
		2149	new AnyEvent::TLS
		2150	}
		2151	}
		2152
		2153	=back
		2154
		2155
		2156	=head1 NONFREQUENTLY ASKED QUESTIONS
		2157
		2158	=over 4
		2159
		2160	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		2161	still get further invocations!
		2162
		2163	That's because AnyEvent::Handle keeps a reference to itself when handling
		2164	read or write callbacks.
		2165
		2166	It is only safe to "forget" the reference inside EOF or error callbacks,
		2167	from within all other callbacks, you need to explicitly call the C<<
		2168	->destroy >> method.
		2169
		2170	=item Why is my C<on_eof> callback never called?
		2171
		2172	Probably because your C<on_error> callback is being called instead: When
		2173	you have outstanding requests in your read queue, then an EOF is
		2174	considered an error as you clearly expected some data.
		2175
		2176	To avoid this, make sure you have an empty read queue whenever your handle
		2177	is supposed to be "idle" (i.e. connection closes are O.K.). You cna set
		2178	an C<on_read> handler that simply pushes the first read requests in the
		2179	queue.
		2180
		2181	See also the next question, which explains this in a bit more detail.
		2182
		2183	=item How can I serve requests in a loop?
		2184
		2185	Most protocols consist of some setup phase (authentication for example)
		2186	followed by a request handling phase, where the server waits for requests
		2187	and handles them, in a loop.
		2188
		2189	There are two important variants: The first (traditional, better) variant
		2190	handles requests until the server gets some QUIT command, causing it to
		2191	close the connection first (highly desirable for a busy TCP server). A
		2192	client dropping the connection is an error, which means this variant can
		2193	detect an unexpected detection close.
		2194
		2195	To handle this case, always make sure you have a on-empty read queue, by
		2196	pushing the "read request start" handler on it:
		2197
		2198	# we assume a request starts with a single line
		2199	my @start_request; @start_request = (line => sub {
		2200	my ($hdl, $line) = @_;
		2201
		2202	... handle request
		2203
		2204	# push next request read, possibly from a nested callback
		2205	$hdl->push_read (@start_request);
		2206	});
		2207
		2208	# auth done, now go into request handling loop
		2209	# now push the first @start_request
		2210	$hdl->push_read (@start_request);
		2211
		2212	By always having an outstanding C<push_read>, the handle always expects
		2213	some data and raises the C<EPIPE> error when the connction is dropped
		2214	unexpectedly.
		2215
		2216	The second variant is a protocol where the client can drop the connection
		2217	at any time. For TCP, this means that the server machine may run out of
		2218	sockets easier, and in general, it means you cnanot distinguish a protocl
		2219	failure/client crash from a normal connection close. Nevertheless, these
		2220	kinds of protocols are common (and sometimes even the best solution to the
		2221	problem).
		2222
		2223	Having an outstanding read request at all times is possible if you ignore
		2224	C<EPIPE> errors, but this doesn't help with when the client drops the
		2225	connection during a request, which would still be an error.
		2226
		2227	A better solution is to push the initial request read in an C<on_read>
		2228	callback. This avoids an error, as when the server doesn't expect data
		2229	(i.e. is idly waiting for the next request, an EOF will not raise an
		2230	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2231	and simpler:
		2232
		2233	# auth done, now go into request handling loop
		2234	$hdl->on_read (sub {
		2235	my ($hdl) = @_;
		2236
		2237	# called each time we receive data but the read queue is empty
		2238	# simply start read the request
		2239
		2240	$hdl->push_read (line => sub {
		2241	my ($hdl, $line) = @_;
		2242
		2243	... handle request
		2244
		2245	# do nothing special when the request has been handled, just
		2246	# let the request queue go empty.
1478	});	2247	});
1479	push @linger, AnyEvent->timer (after => $linger, cb => sub {
1480	@linger = ();
1481	});	2248	});
		2249
		2250	=item I get different callback invocations in TLS mode/Why can't I pause
		2251	reading?
		2252
		2253	Unlike, say, TCP, TLS connections do not consist of two independent
		2254	communication channels, one for each direction. Or put differently, the
		2255	read and write directions are not independent of each other: you cannot
		2256	write data unless you are also prepared to read, and vice versa.
		2257
		2258	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
		2259	callback invocations when you are not expecting any read data - the reason
		2260	is that AnyEvent::Handle always reads in TLS mode.
		2261
		2262	During the connection, you have to make sure that you always have a
		2263	non-empty read-queue, or an C<on_read> watcher. At the end of the
		2264	connection (or when you no longer want to use it) you can call the
		2265	C<destroy> method.
		2266
		2267	=item How do I read data until the other side closes the connection?
		2268
		2269	If you just want to read your data into a perl scalar, the easiest way
		2270	to achieve this is by setting an C<on_read> callback that does nothing,
		2271	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		2272	will be in C<$_[0]{rbuf}>:
		2273
		2274	$handle->on_read (sub { });
		2275	$handle->on_eof (undef);
		2276	$handle->on_error (sub {
		2277	my $data = delete $_[0]{rbuf};
		2278	});
		2279
		2280	The reason to use C<on_error> is that TCP connections, due to latencies
		2281	and packets loss, might get closed quite violently with an error, when in
		2282	fact all data has been received.
		2283
		2284	It is usually better to use acknowledgements when transferring data,
		2285	to make sure the other side hasn't just died and you got the data
		2286	intact. This is also one reason why so many internet protocols have an
		2287	explicit QUIT command.
		2288
		2289	=item I don't want to destroy the handle too early - how do I wait until
		2290	all data has been written?
		2291
		2292	After writing your last bits of data, set the C<on_drain> callback
		2293	and destroy the handle in there - with the default setting of
		2294	C<low_water_mark> this will be called precisely when all data has been
		2295	written to the socket:
		2296
		2297	$handle->push_write (...);
		2298	$handle->on_drain (sub {
		2299	warn "all data submitted to the kernel\n";
		2300	undef $handle;
		2301	});
		2302
		2303	If you just want to queue some data and then signal EOF to the other side,
		2304	consider using C<< ->push_shutdown >> instead.
		2305
		2306	=item I want to contact a TLS/SSL server, I don't care about security.
		2307
		2308	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2309	connect to it and then create the AnyEvent::Handle with the C<tls>
		2310	parameter:
		2311
		2312	tcp_connect $host, $port, sub {
		2313	my ($fh) = @_;
		2314
		2315	my $handle = new AnyEvent::Handle
		2316	fh => $fh,
		2317	tls => "connect",
		2318	on_error => sub { ... };
		2319
		2320	$handle->push_write (...);
1482	}	2321	};
1483	}
1484		2322
1485	=item AnyEvent::Handle::TLS_CTX	2323	=item I want to contact a TLS/SSL server, I do care about security.
1486		2324
1487	This function creates and returns the Net::SSLeay::CTX object used by	2325	Then you should additionally enable certificate verification, including
1488	default for TLS mode.	2326	peername verification, if the protocol you use supports it (see
		2327	L<AnyEvent::TLS>, C<verify_peername>).
1489		2328
1490	The context is created like this:	2329	E.g. for HTTPS:
1491		2330
1492	Net::SSLeay::load_error_strings;	2331	tcp_connect $host, $port, sub {
1493	Net::SSLeay::SSLeay_add_ssl_algorithms;	2332	my ($fh) = @_;
1494	Net::SSLeay::randomize;
1495		2333
1496	my $CTX = Net::SSLeay::CTX_new;	2334	my $handle = new AnyEvent::Handle
		2335	fh => $fh,
		2336	peername => $host,
		2337	tls => "connect",
		2338	tls_ctx => { verify => 1, verify_peername => "https" },
		2339	...
1497		2340
1498	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL	2341	Note that you must specify the hostname you connected to (or whatever
		2342	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2343	peername verification will be done.
1499		2344
1500	=cut	2345	The above will use the system-dependent default set of trusted CA
		2346	certificates. If you want to check against a specific CA, add the
		2347	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
1501		2348
1502	our $TLS_CTX;	2349	tls_ctx => {
		2350	verify => 1,
		2351	verify_peername => "https",
		2352	ca_file => "my-ca-cert.pem",
		2353	},
1503		2354
1504	sub TLS_CTX() {	2355	=item I want to create a TLS/SSL server, how do I do that?
1505	$TLS_CTX || do {
1506	require Net::SSLeay;
1507		2356
1508	Net::SSLeay::load_error_strings ();	2357	Well, you first need to get a server certificate and key. You have
1509	Net::SSLeay::SSLeay_add_ssl_algorithms ();	2358	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
1510	Net::SSLeay::randomize ();	2359	self-signed certificate (cheap. check the search engine of your choice,
		2360	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2361	nice program for that purpose).
1511		2362
1512	$TLS_CTX = Net::SSLeay::CTX_new ();	2363	Then create a file with your private key (in PEM format, see
		2364	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2365	file should then look like this:
1513		2366
1514	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());	2367	-----BEGIN RSA PRIVATE KEY-----
		2368	...header data
		2369	... lots of base64'y-stuff
		2370	-----END RSA PRIVATE KEY-----
1515		2371
1516	$TLS_CTX	2372	-----BEGIN CERTIFICATE-----
1517	}	2373	... lots of base64'y-stuff
1518	}	2374	-----END CERTIFICATE-----
		2375
		2376	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2377	specify this file as C<cert_file>:
		2378
		2379	tcp_server undef, $port, sub {
		2380	my ($fh) = @_;
		2381
		2382	my $handle = new AnyEvent::Handle
		2383	fh => $fh,
		2384	tls => "accept",
		2385	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2386	...
		2387
		2388	When you have intermediate CA certificates that your clients might not
		2389	know about, just append them to the C<cert_file>.
1519		2390
1520	=back	2391	=back
		2392
1521		2393
1522	=head1 SUBCLASSING AnyEvent::Handle	2394	=head1 SUBCLASSING AnyEvent::Handle
1523		2395
1524	In many cases, you might want to subclass AnyEvent::Handle.	2396	In many cases, you might want to subclass AnyEvent::Handle.
1525		2397
…		…
1542		2414
1543	=item * all members not documented here and not prefixed with an underscore	2415	=item * all members not documented here and not prefixed with an underscore
1544	are free to use in subclasses.	2416	are free to use in subclasses.
1545		2417
1546	Of course, new versions of AnyEvent::Handle may introduce more "public"	2418	Of course, new versions of AnyEvent::Handle may introduce more "public"
1547	member variables, but thats just life, at least it is documented.	2419	member variables, but that's just life. At least it is documented.
1548		2420
1549	=back	2421	=back
1550		2422
1551	=head1 AUTHOR	2423	=head1 AUTHOR
1552		2424

Diff Legend

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