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.156 by root, Wed Jul 22 05:37:32 2009 UTC vs.
Revision 1.237 by root, Tue Jul 30 23:14:32 2013 UTC

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

Diff Legend

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