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

Diff Legend

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