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.112 by root, Wed Jan 21 06:01:35 2009 UTC vs.
Revision 1.234 by root, Wed Apr 18 09:44:10 2012 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.331;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
		16	AE::log error => $msg;
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	},
34	);	19	};
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	say "got line <$line>";
43	$cv->send;	28	$cv->send;
44	});	29	});
45		30
46	$cv->recv;	31	$cv->recv;
47		32
48	=head1 DESCRIPTION	33	=head1 DESCRIPTION
49		34
50	This module is a helper module to make it easier to do event-based I/O on	35	This is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	36	stream-based filehandles (sockets, pipes, and other stream things).
52	on sockets see L<AnyEvent::Util>.
53		37
54	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
56		40
57	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
58	means characters. As sysread and syswrite are used for all I/O, their	42	characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
60		47
61	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
62	argument.	49	argument.
63		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
		80	sub MAX_READ_SIZE() { 131072 }
		81
64	=head1 METHODS	82	=head1 METHODS
65		83
66	=over 4	84	=over 4
67		85
68	=item B<new (%args)>	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69		87
70	The constructor supports these arguments (all as key => value pairs).	88	The constructor supports these arguments (all as C<< key => value >> pairs).
71		89
72	=over 4	90	=over 4
73		91
74	=item fh => $filehandle [MANDATORY]	92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		93
76	The filehandle this L<AnyEvent::Handle> object will operate on.	94	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	95	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	96	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	97	that mode.
81		98
		99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		100
		101	Try to connect to the specified host and service (port), using
		102	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		103	default C<peername>.
		104
		105	You have to specify either this parameter, or C<fh>, above.
		106
		107	It is possible to push requests on the read and write queues, and modify
		108	properties of the stream, even while AnyEvent::Handle is connecting.
		109
		110	When this parameter is specified, then the C<on_prepare>,
		111	C<on_connect_error> and C<on_connect> callbacks will be called under the
		112	appropriate circumstances:
		113
		114	=over 4
		115
		116	=item on_prepare => $cb->($handle)
		117
		118	This (rarely used) callback is called before a new connection is
		119	attempted, but after the file handle has been created (you can access that
		120	file handle via C<< $handle->{fh} >>). It could be used to prepare the
		121	file handle with parameters required for the actual connect (as opposed to
		122	settings that can be changed when the connection is already established).
		123
		124	The return value of this callback should be the connect timeout value in
		125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
		126	default timeout is to be used).
		127
		128	=item on_connect => $cb->($handle, $host, $port, $retry->())
		129
		130	This callback is called when a connection has been successfully established.
		131
		132	The peer's numeric host and port (the socket peername) are passed as
		133	parameters, together with a retry callback. 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.
		222
82	=item on_eof => $cb->($handle)	223	=item on_eof => $cb->($handle)
83		224
84	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,
85	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
86	connection cleanly.	227	connection cleanly, and there are no outstanding read requests in the
		228	queue (if there are read requests, then an EOF counts as an unexpected
		229	connection close and will be flagged as an error).
87		230
88	For sockets, this just means that the other side has stopped sending data,	231	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	232	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	233	callback and continue writing data, as only the read part has been shut
91	down.	234	down.
92		235
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	236	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	237	set, then a fatal error will be raised with C<$!> set to <0>.
99		238
100	=item on_error => $cb->($handle, $fatal)
101
102	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.
105
106	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.
111
112	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116
117	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
119
120	While not mandatory, it is I<highly> recommended to set this callback, as
121	you will not be notified of errors otherwise. The default simply calls
122	C<croak>.
123
124	=item on_read => $cb->($handle)
125
126	This sets the default read callback, which is called when data arrives
127	and no read request is in the queue (unlike read queue callbacks, this
128	callback will only be called when at least one octet of data is in the
129	read buffer).
130
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly.
133
134	When an EOF condition is detected then AnyEvent::Handle will first try to
135	feed all the remaining data to the queued callbacks and C<on_read> before
136	calling the C<on_eof> callback. If no progress can be made, then a fatal
137	error will be raised (with C<$!> set to C<EPIPE>).
138
139	=item on_drain => $cb->($handle)	239	=item on_drain => $cb->($handle)
140		240
141	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
142	(or when the callback is set and the buffer is empty already).	242	empty (and immediately when the handle object is created).
143		243
144	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.
145		245
146	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
147	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
…		…
149	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
150	the file when the write queue becomes empty.	250	the file when the write queue becomes empty.
151		251
152	=item timeout => $fractional_seconds	252	=item timeout => $fractional_seconds
153		253
		254	=item rtimeout => $fractional_seconds
		255
		256	=item wtimeout => $fractional_seconds
		257
154	If non-zero, then this enables an "inactivity" timeout: whenever this many	258	If non-zero, then these enables an "inactivity" timeout: whenever this
155	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
156	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
157	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).
158		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
159	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
160	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
161	idle then you should disable the timout temporarily or ignore the timeout	273	idle then you should disable the timeout temporarily or ignore the
162	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
163	restart the timeout.	275	AnyEvent::Handle will simply restart the timeout.
164		276
165	Zero (the default) disables this timeout.	277	Zero (the default) disables the corresponding timeout.
166		278
167	=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)
168		284
169	Called whenever the inactivity timeout passes. If you return from this	285	Called whenever the inactivity timeout passes. If you return from this
170	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,
171	so this condition is not fatal in any way.	287	so this condition is not fatal in any way.
172		288
…		…
180	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
181	(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
182	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
183	isn't finished).	299	isn't finished).
184		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
185	=item autocork => <boolean>	316	=item autocork => <boolean>
186		317
187	When disabled (the default), then C<push_write> will try to immediately	318	When disabled (the default), C<push_write> will try to immediately
188	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
189	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
190	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
191	disadvantage is usually avoided by your kernel's nagle algorithm, see	322	disadvantage is usually avoided by your kernel's nagle algorithm, see
192	C<no_delay>, but this option can save costly syscalls).	323	C<no_delay>, but this option can save costly syscalls).
193		324
194	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
195	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,
196	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
197	the write buffer often is full). It also increases write latency.	328	the write buffer often is full). It also increases write latency.
198		329
199	=item no_delay => <boolean>	330	=item no_delay => <boolean>
…		…
203	the Nagle algorithm, and usually it is beneficial.	334	the Nagle algorithm, and usually it is beneficial.
204		335
205	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
206	accomplishd by setting this option to a true value.	337	accomplishd by setting this option to a true value.
207		338
208	The default is your opertaing system's default behaviour (most likely	339	The default is your operating system's default behaviour (most likely
209	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.
210		373
211	=item read_size => <bytes>	374	=item read_size => <bytes>
212		375
213	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
214	try to read during each loop iteration, which affects memory	377	to read during each loop iteration. Each handle object will consume
215	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.
216		388
217	=item low_water_mark => <bytes>	389	=item low_water_mark => <bytes>
218		390
219	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
220	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
221	considered empty.	393	considered empty.
222		394
223	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
224	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
225	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
226	is good in almost all cases.	398	is good in almost all cases.
227		399
228	=item linger => <seconds>	400	=item linger => <seconds>
229		401
230	If non-zero (default: C<3600>), then the destructor of the	402	If this is non-zero (default: C<3600>), the destructor of the
231	AnyEvent::Handle object will check whether there is still outstanding	403	AnyEvent::Handle object will check whether there is still outstanding
232	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
233	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
234	system treats outstanding data at socket close time).	406	system treats outstanding data at socket close time).
235		407
236	This will not work for partial TLS data that could not be encoded	408	This will not work for partial TLS data that could not be encoded
237	yet. This data will be lost. Calling the C<stoptls> method in time might	409	yet. This data will be lost. Calling the C<stoptls> method in time might
238	help.	410	help.
239		411
		412	=item peername => $string
		413
		414	A string used to identify the remote site - usually the DNS hostname
		415	(I<not> IDN!) used to create the connection, rarely the IP address.
		416
		417	Apart from being useful in error messages, this string is also used in TLS
		418	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		419	verification will be skipped when C<peername> is not specified or is
		420	C<undef>.
		421
240	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	422	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
241		423
242	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
243	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
244	established and will transparently encrypt/decrypt data afterwards.	426	established and will transparently encrypt/decrypt data afterwards.
		427
		428	All TLS protocol errors will be signalled as C<EPROTO>, with an
		429	appropriate error message.
245		430
246	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
247	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
248	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
249	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.
250		436
251	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
252	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>
253	mode.	439	mode.
254		440
255	You can also provide your own TLS connection object, but you have	441	You can also provide your own TLS connection object, but you have
256	to make sure that you call either C<Net::SSLeay::set_connect_state>	442	to make sure that you call either C<Net::SSLeay::set_connect_state>
257	or C<Net::SSLeay::set_accept_state> on it before you pass it to	443	or C<Net::SSLeay::set_accept_state> on it before you pass it to
258	AnyEvent::Handle.	444	AnyEvent::Handle. Also, this module will take ownership of this connection
		445	object.
		446
		447	At some future point, AnyEvent::Handle might switch to another TLS
		448	implementation, then the option to use your own session object will go
		449	away.
259		450
260	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	451	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
261	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
262	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
263	segmentation fault.	454	segmentation fault.
264		455
265	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.
266		457
267	=item tls_ctx => $ssl_ctx	458	=item tls_ctx => $anyevent_tls
268		459
269	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	460	Use the given C<AnyEvent::TLS> object to create the new TLS connection
270	(unless a connection object was specified directly). If this parameter is	461	(unless a connection object was specified directly). If this
271	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>.
		464
		465	Instead of an object, you can also specify a hash reference with C<< key
		466	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		467	new TLS context object.
		468
		469	=item on_starttls => $cb->($handle, $success[, $error_message])
		470
		471	This callback will be invoked when the TLS/SSL handshake has finished. If
		472	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		473	(C<on_stoptls> will not be called in this case).
		474
		475	The session in C<< $handle->{tls} >> can still be examined in this
		476	callback, even when the handshake was not successful.
		477
		478	TLS handshake failures will not cause C<on_error> to be invoked when this
		479	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		480
		481	Without this callback, handshake failures lead to C<on_error> being
		482	called as usual.
		483
		484	Note that you cannot just call C<starttls> again in this callback. If you
		485	need to do that, start an zero-second timer instead whose callback can
		486	then call C<< ->starttls >> again.
		487
		488	=item on_stoptls => $cb->($handle)
		489
		490	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		491	set, then it will be invoked after freeing the TLS session. If it is not,
		492	then a TLS shutdown condition will be treated like a normal EOF condition
		493	on the handle.
		494
		495	The session in C<< $handle->{tls} >> can still be examined in this
		496	callback.
		497
		498	This callback will only be called on TLS shutdowns, not when the
		499	underlying handle signals EOF.
272		500
273	=item json => JSON or JSON::XS object	501	=item json => JSON or JSON::XS object
274		502
275	This is the json coder object used by the C<json> read and write types.	503	This is the json coder object used by the C<json> read and write types.
276		504
…		…
285		513
286	=cut	514	=cut
287		515
288	sub new {	516	sub new {
289	my $class = shift;	517	my $class = shift;
290
291	my $self = bless { @_ }, $class;	518	my $self = bless { @_ }, $class;
292		519
293	$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;
294		591
295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	592	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
296		593
		594	$self->{_activity} =
		595	$self->{_ractivity} =
		596	$self->{_wactivity} = AE::now;
		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
		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};
		608
		609	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		610
297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	611	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
298	if $self->{tls};	612	if $self->{tls};
299		613
300	$self->{_activity} = AnyEvent->now;
301	$self->_timeout;
302
303	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	614	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
304	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
305		615
306	$self->start_read	616	$self->start_read
307	if $self->{on_read};	617	if $self->{on_read} || @{ $self->{_queue} };
308		618
309	$self	619	$self->_drain_wbuf;
310	}
311
312	sub _shutdown {
313	my ($self) = @_;
314
315	delete $self->{_tw};
316	delete $self->{_rw};
317	delete $self->{_ww};
318	delete $self->{fh};
319
320	&_freetls;
321
322	delete $self->{on_read};
323	delete $self->{_queue};
324	}	620	}
325		621
326	sub _error {	622	sub _error {
327	my ($self, $errno, $fatal) = @_;	623	my ($self, $errno, $fatal, $message) = @_;
328
329	$self->_shutdown
330	if $fatal;
331		624
332	$! = $errno;	625	$! = $errno;
		626	$message ||= "$!";
333		627
334	if ($self->{on_error}) {	628	if ($self->{on_error}) {
335	$self->{on_error}($self, $fatal);	629	$self->{on_error}($self, $fatal, $message);
336	} elsif ($self->{fh}) {	630	$self->destroy if $fatal;
		631	} elsif ($self->{fh} || $self->{connect}) {
		632	$self->destroy;
337	Carp::croak "AnyEvent::Handle uncaught error: $!";	633	Carp::croak "AnyEvent::Handle uncaught error: $message";
338	}	634	}
339	}	635	}
340		636
341	=item $fh = $handle->fh	637	=item $fh = $handle->fh
342		638
…		…
366	$_[0]{on_eof} = $_[1];	662	$_[0]{on_eof} = $_[1];
367	}	663	}
368		664
369	=item $handle->on_timeout ($cb)	665	=item $handle->on_timeout ($cb)
370		666
371	Replace the current C<on_timeout> callback, or disables the callback (but	667	=item $handle->on_rtimeout ($cb)
372	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
373	argument and method.
374		668
375	=cut	669	=item $handle->on_wtimeout ($cb)
376		670
377	sub on_timeout {	671	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
378	$_[0]{on_timeout} = $_[1];	672	callback, or disables the callback (but not the timeout) if C<$cb> =
379	}	673	C<undef>. See the C<timeout> constructor argument and method.
		674
		675	=cut
		676
		677	# see below
380		678
381	=item $handle->autocork ($boolean)	679	=item $handle->autocork ($boolean)
382		680
383	Enables or disables the current autocork behaviour (see C<autocork>	681	Enables or disables the current autocork behaviour (see C<autocork>
384	constructor argument). Changes will only take effect on the next write.	682	constructor argument). Changes will only take effect on the next write.
…		…
397	=cut	695	=cut
398		696
399	sub no_delay {	697	sub no_delay {
400	$_[0]{no_delay} = $_[1];	698	$_[0]{no_delay} = $_[1];
401		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
402	eval {	714	eval {
403	local $SIG{__DIE__};	715	local $SIG{__DIE__};
404	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};
405	};	718	};
406	}	719	}
407		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};
		752	};
		753	}
		754
		755	=item $handle->on_starttls ($cb)
		756
		757	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		758
		759	=cut
		760
		761	sub on_starttls {
		762	$_[0]{on_starttls} = $_[1];
		763	}
		764
		765	=item $handle->on_stoptls ($cb)
		766
		767	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		768
		769	=cut
		770
		771	sub on_stoptls {
		772	$_[0]{on_stoptls} = $_[1];
		773	}
		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
408	#############################################################################	793	#############################################################################
409		794
410	=item $handle->timeout ($seconds)	795	=item $handle->timeout ($seconds)
411		796
		797	=item $handle->rtimeout ($seconds)
		798
		799	=item $handle->wtimeout ($seconds)
		800
412	Configures (or disables) the inactivity timeout.	801	Configures (or disables) the inactivity timeout.
413		802
414	=cut	803	The timeout will be checked instantly, so this method might destroy the
		804	handle before it returns.
415		805
416	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 {
417	my ($self, $timeout) = @_;	830	my ($self, $new_value) = @_;
418		831
		832	$new_value >= 0
		833	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		834
419	$self->{timeout} = $timeout;	835	$self->{$timeout} = $new_value;
420	$self->_timeout;	836	delete $self->{$tw}; &$cb;
421	}	837	};
422		838
		839	*{"${dir}timeout_reset"} = sub {
		840	$_[0]{$activity} = AE::now;
		841	};
		842
		843	# main workhorse:
423	# reset the timeout watcher, as neccessary	844	# reset the timeout watcher, as neccessary
424	# also check for time-outs	845	# also check for time-outs
425	sub _timeout {	846	$cb = sub {
426	my ($self) = @_;	847	my ($self) = @_;
427		848
428	if ($self->{timeout}) {	849	if ($self->{$timeout} && $self->{fh}) {
429	my $NOW = AnyEvent->now;	850	my $NOW = AE::now;
430		851
431	# when would the timeout trigger?	852	# when would the timeout trigger?
432	my $after = $self->{_activity} + $self->{timeout} - $NOW;	853	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
433		854
434	# now or in the past already?	855	# now or in the past already?
435	if ($after <= 0) {	856	if ($after <= 0) {
436	$self->{_activity} = $NOW;	857	$self->{$activity} = $NOW;
437		858
438	if ($self->{on_timeout}) {	859	if ($self->{$on_timeout}) {
439	$self->{on_timeout}($self);	860	$self->{$on_timeout}($self);
440	} else {	861	} else {
441	$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};
442	}	870	}
443		871
444	# callback could have changed timeout value, optimise	872	Scalar::Util::weaken $self;
445	return unless $self->{timeout};	873	return unless $self; # ->error could have destroyed $self
446		874
447	# calculate new after	875	$self->{$tw} ||= AE::timer $after, 0, sub {
448	$after = $self->{timeout};	876	delete $self->{$tw};
		877	$cb->($self);
		878	};
		879	} else {
		880	delete $self->{$tw};
449	}	881	}
450
451	Scalar::Util::weaken $self;
452	return unless $self; # ->error could have destroyed $self
453
454	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
455	delete $self->{_tw};
456	$self->_timeout;
457	});
458	} else {
459	delete $self->{_tw};
460	}	882	}
461	}	883	}
462		884
463	#############################################################################	885	#############################################################################
464		886
…		…
471		893
472	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
473	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.
474		896
475	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
476	water mark, the C<on_drain> callback will be invoked.	898	water mark, the C<on_drain> callback will be invoked once.
477		899
478	=over 4	900	=over 4
479		901
480	=item $handle->on_drain ($cb)	902	=item $handle->on_drain ($cb)
481		903
482	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
483	C<on_drain> in the constructor).	905	C<on_drain> in the constructor).
484		906
		907	This method may invoke callbacks (and therefore the handle might be
		908	destroyed after it returns).
		909
485	=cut	910	=cut
486		911
487	sub on_drain {	912	sub on_drain {
488	my ($self, $cb) = @_;	913	my ($self, $cb) = @_;
489		914
…		…
493	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});
494	}	919	}
495		920
496	=item $handle->push_write ($data)	921	=item $handle->push_write ($data)
497		922
498	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
499	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
500	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).
501		929
502	=cut	930	=cut
503		931
504	sub _drain_wbuf {	932	sub _drain_wbuf {
505	my ($self) = @_;	933	my ($self) = @_;
…		…
509	Scalar::Util::weaken $self;	937	Scalar::Util::weaken $self;
510		938
511	my $cb = sub {	939	my $cb = sub {
512	my $len = syswrite $self->{fh}, $self->{wbuf};	940	my $len = syswrite $self->{fh}, $self->{wbuf};
513		941
514	if ($len >= 0) {	942	if (defined $len) {
515	substr $self->{wbuf}, 0, $len, "";	943	substr $self->{wbuf}, 0, $len, "";
516		944
517	$self->{_activity} = AnyEvent->now;	945	$self->{_activity} = $self->{_wactivity} = AE::now;
518		946
519	$self->{on_drain}($self)	947	$self->{on_drain}($self)
520	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})
521	&& $self->{on_drain};	949	&& $self->{on_drain};
522		950
…		…
528		956
529	# try to write data immediately	957	# try to write data immediately
530	$cb->() unless $self->{autocork};	958	$cb->() unless $self->{autocork};
531		959
532	# if still data left in wbuf, we need to poll	960	# if still data left in wbuf, we need to poll
533	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	961	$self->{_ww} = AE::io $self->{fh}, 1, $cb
534	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	}
535	};	970	};
536	}	971	}
537		972
538	our %WH;	973	our %WH;
539		974
		975	# deprecated
540	sub register_write_type($$) {	976	sub register_write_type($$) {
541	$WH{$_[0]} = $_[1];	977	$WH{$_[0]} = $_[1];
542	}	978	}
543		979
544	sub push_write {	980	sub push_write {
545	my $self = shift;	981	my $self = shift;
546		982
547	if (@_ > 1) {	983	if (@_ > 1) {
548	my $type = shift;	984	my $type = shift;
549		985
		986	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
550	@_ = ($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")
551	->($self, @_);	988	->($self, @_);
552	}	989	}
553		990
		991	# we downgrade here to avoid hard-to-track-down bugs,
		992	# and diagnose the problem earlier and better.
		993
554	if ($self->{tls}) {	994	if ($self->{tls}) {
555	$self->{_tls_wbuf} .= $_[0];	995	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
556		996	&_dotls ($self) if $self->{fh};
557	&_dotls ($self);
558	} else {	997	} else {
559	$self->{wbuf} .= $_[0];	998	utf8::downgrade $self->{wbuf} .= $_[0];
560	$self->_drain_wbuf;	999	$self->_drain_wbuf if $self->{fh};
561	}	1000	}
562	}	1001	}
563		1002
564	=item $handle->push_write (type => @args)	1003	=item $handle->push_write (type => @args)
565		1004
566	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
567	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).
568		1010
569	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
570	drop by and tell us):	1012	drop by and tell us):
571		1013
572	=over 4	1014	=over 4
…		…
629	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
630	this line into their JSON decoder of choice.	1072	this line into their JSON decoder of choice.
631		1073
632	=cut	1074	=cut
633		1075
		1076	sub json_coder() {
		1077	eval { require JSON::XS; JSON::XS->new->utf8 }
		1078	|| do { require JSON; JSON->new->utf8 }
		1079	}
		1080
634	register_write_type json => sub {	1081	register_write_type json => sub {
635	my ($self, $ref) = @_;	1082	my ($self, $ref) = @_;
636		1083
637	require JSON;	1084	my $json = $self->{json} ||= json_coder;
638		1085
639	$self->{json} ? $self->{json}->encode ($ref)	1086	$json->encode ($ref)
640	: JSON::encode_json ($ref)
641	};	1087	};
642		1088
643	=item storable => $reference	1089	=item storable => $reference
644		1090
645	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
…		…
648	=cut	1094	=cut
649		1095
650	register_write_type storable => sub {	1096	register_write_type storable => sub {
651	my ($self, $ref) = @_;	1097	my ($self, $ref) = @_;
652		1098
653	require Storable;	1099	require Storable unless $Storable::VERSION;
654		1100
655	pack "w/a*", Storable::nfreeze ($ref)	1101	pack "w/a*", Storable::nfreeze ($ref)
656	};	1102	};
657		1103
658	=back	1104	=back
659		1105
660	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1106	=item $handle->push_shutdown
661		1107
662	This function (not method) lets you add your own types to C<push_write>.	1108	Sometimes you know you want to close the socket after writing your data
		1109	before it was actually written. One way to do that is to replace your
		1110	C<on_drain> handler by a callback that shuts down the socket (and set
		1111	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1112	replaces the C<on_drain> callback with:
		1113
		1114	sub { shutdown $_[0]{fh}, 1 }
		1115
		1116	This simply shuts down the write side and signals an EOF condition to the
		1117	the peer.
		1118
		1119	You can rely on the normal read queue and C<on_eof> handling
		1120	afterwards. This is the cleanest way to close a connection.
		1121
		1122	This method may invoke callbacks (and therefore the handle might be
		1123	destroyed after it returns).
		1124
		1125	=cut
		1126
		1127	sub push_shutdown {
		1128	my ($self) = @_;
		1129
		1130	delete $self->{low_water_mark};
		1131	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1132	}
		1133
		1134	=item custom write types - Package::anyevent_write_type $handle, @args
		1135
		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
663	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
664	reference with the handle object and the remaining arguments.	1143	the handle object and the remaining arguments.
665		1144
666	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
667	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.
668		1148
669	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
670	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	}
671		1165
672	=cut	1166	=cut
673		1167
674	#############################################################################	1168	#############################################################################
675		1169
…		…
684	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
685	a queue.	1179	a queue.
686		1180
687	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
688	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
689	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
690	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
691	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>.
692		1187
693	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
694	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
695	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
696	done its job (see C<push_read>, below).	1191	done its job (see C<push_read>, below).
697		1192
698	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
699	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.
700		1195
…		…
757	=cut	1252	=cut
758		1253
759	sub _drain_rbuf {	1254	sub _drain_rbuf {
760	my ($self) = @_;	1255	my ($self) = @_;
761		1256
		1257	# avoid recursion
		1258	return if $self->{_skip_drain_rbuf};
762	local $self->{_in_drain} = 1;	1259	local $self->{_skip_drain_rbuf} = 1;
763
764	if (
765	defined $self->{rbuf_max}
766	&& $self->{rbuf_max} < length $self->{rbuf}
767	) {
768	$self->_error (&Errno::ENOSPC, 1), return;
769	}
770		1260
771	while () {	1261	while () {
		1262	# we need to use a separate tls read buffer, as we must not receive data while
		1263	# we are draining the buffer, and this can only happen with TLS.
		1264	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1265	if exists $self->{_tls_rbuf};
		1266
772	my $len = length $self->{rbuf};	1267	my $len = length $self->{rbuf};
773		1268
774	if (my $cb = shift @{ $self->{_queue} }) {	1269	if (my $cb = shift @{ $self->{_queue} }) {
775	unless ($cb->($self)) {	1270	unless ($cb->($self)) {
776	if ($self->{_eof}) {	1271	# no progress can be made
777	# no progress can be made (not enough data and no data forthcoming)	1272	# (not enough data and no data forthcoming)
778	$self->_error (&Errno::EPIPE, 1), return;	1273	$self->_error (Errno::EPIPE, 1), return
779	}	1274	if $self->{_eof};
780		1275
781	unshift @{ $self->{_queue} }, $cb;	1276	unshift @{ $self->{_queue} }, $cb;
782	last;	1277	last;
783	}	1278	}
784	} elsif ($self->{on_read}) {	1279	} elsif ($self->{on_read}) {
…		…
791	&& !@{ $self->{_queue} } # and the queue is still empty	1286	&& !@{ $self->{_queue} } # and the queue is still empty
792	&& $self->{on_read} # but we still have on_read	1287	&& $self->{on_read} # but we still have on_read
793	) {	1288	) {
794	# no further data will arrive	1289	# no further data will arrive
795	# so no progress can be made	1290	# so no progress can be made
796	$self->_error (&Errno::EPIPE, 1), return	1291	$self->_error (Errno::EPIPE, 1), return
797	if $self->{_eof};	1292	if $self->{_eof};
798		1293
799	last; # more data might arrive	1294	last; # more data might arrive
800	}	1295	}
801	} else {	1296	} else {
…		…
804	last;	1299	last;
805	}	1300	}
806	}	1301	}
807		1302
808	if ($self->{_eof}) {	1303	if ($self->{_eof}) {
809	if ($self->{on_eof}) {	1304	$self->{on_eof}
810	$self->{on_eof}($self)	1305	? $self->{on_eof}($self)
811	} else {	1306	: $self->_error (0, 1, "Unexpected end-of-file");
812	$self->_error (0, 1);	1307
813	}	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;
814	}	1316	}
815		1317
816	# may need to restart read watcher	1318	# may need to restart read watcher
817	unless ($self->{_rw}) {	1319	unless ($self->{_rw}) {
818	$self->start_read	1320	$self->start_read
…		…
824		1326
825	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
826	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
827	constructor.	1329	constructor.
828		1330
		1331	This method may invoke callbacks (and therefore the handle might be
		1332	destroyed after it returns).
		1333
829	=cut	1334	=cut
830		1335
831	sub on_read {	1336	sub on_read {
832	my ($self, $cb) = @_;	1337	my ($self, $cb) = @_;
833		1338
834	$self->{on_read} = $cb;	1339	$self->{on_read} = $cb;
835	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1340	$self->_drain_rbuf if $cb;
836	}	1341	}
837		1342
838	=item $handle->rbuf	1343	=item $handle->rbuf
839		1344
840	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).
841		1348
842	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1349	The only operation allowed on the read buffer (apart from looking at it)
843	you want.	1350	is removing data from its beginning. Otherwise modifying or appending to
		1351	it is not allowed and will lead to hard-to-track-down bugs.
844		1352
845	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>
846	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
847	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.
848		1357
849	=cut	1358	=cut
850		1359
851	sub rbuf : lvalue {	1360	sub rbuf : lvalue {
852	$_[0]{rbuf}	1361	$_[0]{rbuf}
…		…
869		1378
870	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
871	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
872	true, it will be removed from the queue.	1381	true, it will be removed from the queue.
873		1382
		1383	These methods may invoke callbacks (and therefore the handle might be
		1384	destroyed after it returns).
		1385
874	=cut	1386	=cut
875		1387
876	our %RH;	1388	our %RH;
877		1389
878	sub register_read_type($$) {	1390	sub register_read_type($$) {
…		…
884	my $cb = pop;	1396	my $cb = pop;
885		1397
886	if (@_) {	1398	if (@_) {
887	my $type = shift;	1399	my $type = shift;
888		1400
		1401	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
889	$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")
890	->($self, $cb, @_);	1403	->($self, $cb, @_);
891	}	1404	}
892		1405
893	push @{ $self->{_queue} }, $cb;	1406	push @{ $self->{_queue} }, $cb;
894	$self->_drain_rbuf unless $self->{_in_drain};	1407	$self->_drain_rbuf;
895	}	1408	}
896		1409
897	sub unshift_read {	1410	sub unshift_read {
898	my $self = shift;	1411	my $self = shift;
899	my $cb = pop;	1412	my $cb = pop;
900		1413
901	if (@_) {	1414	if (@_) {
902	my $type = shift;	1415	my $type = shift;
903		1416
		1417	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
904	$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")
905	->($self, $cb, @_);	1419	->($self, $cb, @_);
906	}	1420	}
907		1421
908
909	unshift @{ $self->{_queue} }, $cb;	1422	unshift @{ $self->{_queue} }, $cb;
910	$self->_drain_rbuf unless $self->{_in_drain};	1423	$self->_drain_rbuf;
911	}	1424	}
912		1425
913	=item $handle->push_read (type => @args, $cb)	1426	=item $handle->push_read (type => @args, $cb)
914		1427
915	=item $handle->unshift_read (type => @args, $cb)	1428	=item $handle->unshift_read (type => @args, $cb)
916		1429
917	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
918	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
919	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).
920		1435
921	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
922	drop by and tell us):	1437	drop by and tell us):
923		1438
924	=over 4	1439	=over 4
…		…
930	data.	1445	data.
931		1446
932	Example: read 2 bytes.	1447	Example: read 2 bytes.
933		1448
934	$handle->push_read (chunk => 2, sub {	1449	$handle->push_read (chunk => 2, sub {
935	warn "yay ", unpack "H*", $_[1];	1450	say "yay " . unpack "H*", $_[1];
936	});	1451	});
937		1452
938	=cut	1453	=cut
939		1454
940	register_read_type chunk => sub {	1455	register_read_type chunk => sub {
…		…
974	if (@_ < 3) {	1489	if (@_ < 3) {
975	# this is more than twice as fast as the generic code below	1490	# this is more than twice as fast as the generic code below
976	sub {	1491	sub {
977	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1492	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
978		1493
979	$cb->($_[0], $1, $2);	1494	$cb->($_[0], "$1", "$2");
980	1	1495	1
981	}	1496	}
982	} else {	1497	} else {
983	$eol = quotemeta $eol unless ref $eol;	1498	$eol = quotemeta $eol unless ref $eol;
984	$eol = qr|^(.*?)($eol)|s;	1499	$eol = qr|^(.*?)($eol)|s;
985		1500
986	sub {	1501	sub {
987	$_[0]{rbuf} =~ s/$eol// or return;	1502	$_[0]{rbuf} =~ s/$eol// or return;
988		1503
989	$cb->($_[0], $1, $2);	1504	$cb->($_[0], "$1", "$2");
990	1	1505	1
991	}	1506	}
992	}	1507	}
993	};	1508	};
994		1509
…		…
1016	the receive buffer when neither C<$accept> nor C<$reject> match,	1531	the receive buffer when neither C<$accept> nor C<$reject> match,
1017	and everything preceding and including the match will be accepted	1532	and everything preceding and including the match will be accepted
1018	unconditionally. This is useful to skip large amounts of data that you	1533	unconditionally. This is useful to skip large amounts of data that you
1019	know cannot be matched, so that the C<$accept> or C<$reject> regex do not	1534	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1020	have to start matching from the beginning. This is purely an optimisation	1535	have to start matching from the beginning. This is purely an optimisation
1021	and is usually worth only when you expect more than a few kilobytes.	1536	and is usually worth it only when you expect more than a few kilobytes.
1022		1537
1023	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1538	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1024	expect the header to be very large (it isn't in practise, but...), we use	1539	expect the header to be very large (it isn't in practice, but...), we use
1025	a skip regex to skip initial portions. The skip regex is tricky in that	1540	a skip regex to skip initial portions. The skip regex is tricky in that
1026	it only accepts something not ending in either \015 or \012, as these are	1541	it only accepts something not ending in either \015 or \012, as these are
1027	required for the accept regex.	1542	required for the accept regex.
1028		1543
1029	$handle->push_read (regex =>	1544	$handle->push_read (regex =>
…		…
1042		1557
1043	sub {	1558	sub {
1044	# accept	1559	# accept
1045	if ($$rbuf =~ $accept) {	1560	if ($$rbuf =~ $accept) {
1046	$data .= substr $$rbuf, 0, $+[0], "";	1561	$data .= substr $$rbuf, 0, $+[0], "";
1047	$cb->($self, $data);	1562	$cb->($_[0], $data);
1048	return 1;	1563	return 1;
1049	}	1564	}
1050		1565
1051	# reject	1566	# reject
1052	if ($reject && $$rbuf =~ $reject) {	1567	if ($reject && $$rbuf =~ $reject) {
1053	$self->_error (&Errno::EBADMSG);	1568	$_[0]->_error (Errno::EBADMSG);
1054	}	1569	}
1055		1570
1056	# skip	1571	# skip
1057	if ($skip && $$rbuf =~ $skip) {	1572	if ($skip && $$rbuf =~ $skip) {
1058	$data .= substr $$rbuf, 0, $+[0], "";	1573	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1074	my ($self, $cb) = @_;	1589	my ($self, $cb) = @_;
1075		1590
1076	sub {	1591	sub {
1077	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1592	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1078	if ($_[0]{rbuf} =~ /[^0-9]/) {	1593	if ($_[0]{rbuf} =~ /[^0-9]/) {
1079	$self->_error (&Errno::EBADMSG);	1594	$_[0]->_error (Errno::EBADMSG);
1080	}	1595	}
1081	return;	1596	return;
1082	}	1597	}
1083		1598
1084	my $len = $1;	1599	my $len = $1;
1085		1600
1086	$self->unshift_read (chunk => $len, sub {	1601	$_[0]->unshift_read (chunk => $len, sub {
1087	my $string = $_[1];	1602	my $string = $_[1];
1088	$_[0]->unshift_read (chunk => 1, sub {	1603	$_[0]->unshift_read (chunk => 1, sub {
1089	if ($_[1] eq ",") {	1604	if ($_[1] eq ",") {
1090	$cb->($_[0], $string);	1605	$cb->($_[0], $string);
1091	} else {	1606	} else {
1092	$self->_error (&Errno::EBADMSG);	1607	$_[0]->_error (Errno::EBADMSG);
1093	}	1608	}
1094	});	1609	});
1095	});	1610	});
1096		1611
1097	1	1612	1
…		…
1164	=cut	1679	=cut
1165		1680
1166	register_read_type json => sub {	1681	register_read_type json => sub {
1167	my ($self, $cb) = @_;	1682	my ($self, $cb) = @_;
1168		1683
1169	require JSON;	1684	my $json = $self->{json} ||= json_coder;
1170		1685
1171	my $data;	1686	my $data;
1172	my $rbuf = \$self->{rbuf};	1687	my $rbuf = \$self->{rbuf};
1173		1688
1174	my $json = $self->{json} ||= JSON->new->utf8;
1175
1176	sub {	1689	sub {
1177	eval {
1178	my $ref = $json->incr_parse ($self->{rbuf});	1690	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1179		1691
1180	if ($ref) {	1692	if ($ref) {
1181	$self->{rbuf} = $json->incr_text;	1693	$_[0]{rbuf} = $json->incr_text;
1182	$json->incr_text = "";	1694	$json->incr_text = "";
1183	$cb->($self, $ref);	1695	$cb->($_[0], $ref);
1184
1185	1
1186	} else {
1187	$self->{rbuf} = "";
1188	()
1189	}
1190		1696
1191	1	1697	1
1192	} or do {	1698	} elsif ($@) {
1193	# error case	1699	# error case
1194	$json->incr_skip;	1700	$json->incr_skip;
1195		1701
1196	$self->{rbuf} = $json->incr_text;	1702	$_[0]{rbuf} = $json->incr_text;
1197	$json->incr_text = "";	1703	$json->incr_text = "";
1198		1704
1199	$self->_error (&Errno::EBADMSG);	1705	$_[0]->_error (Errno::EBADMSG);
		1706
		1707	()
		1708	} else {
		1709	$_[0]{rbuf} = "";
		1710
		1711	()
1200	};	1712	}
1201	}	1713	}
1202	};	1714	};
1203		1715
1204	=item storable => $cb->($handle, $ref)	1716	=item storable => $cb->($handle, $ref)
1205		1717
…		…
1212	=cut	1724	=cut
1213		1725
1214	register_read_type storable => sub {	1726	register_read_type storable => sub {
1215	my ($self, $cb) = @_;	1727	my ($self, $cb) = @_;
1216		1728
1217	require Storable;	1729	require Storable unless $Storable::VERSION;
1218		1730
1219	sub {	1731	sub {
1220	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1732	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1221	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1733	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1222	or return;	1734	or return;
…		…
1225		1737
1226	# bypass unshift if we already have the remaining chunk	1738	# bypass unshift if we already have the remaining chunk
1227	if ($format + $len <= length $_[0]{rbuf}) {	1739	if ($format + $len <= length $_[0]{rbuf}) {
1228	my $data = substr $_[0]{rbuf}, $format, $len;	1740	my $data = substr $_[0]{rbuf}, $format, $len;
1229	substr $_[0]{rbuf}, 0, $format + $len, "";	1741	substr $_[0]{rbuf}, 0, $format + $len, "";
		1742
1230	$cb->($_[0], Storable::thaw ($data));	1743	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1744	or return $_[0]->_error (Errno::EBADMSG);
1231	} else {	1745	} else {
1232	# remove prefix	1746	# remove prefix
1233	substr $_[0]{rbuf}, 0, $format, "";	1747	substr $_[0]{rbuf}, 0, $format, "";
1234		1748
1235	# read remaining chunk	1749	# read remaining chunk
1236	$_[0]->unshift_read (chunk => $len, sub {	1750	$_[0]->unshift_read (chunk => $len, sub {
1237	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1751	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1238	$cb->($_[0], $ref);
1239	} else {
1240	$self->_error (&Errno::EBADMSG);	1752	or $_[0]->_error (Errno::EBADMSG);
1241	}
1242	});	1753	});
1243	}	1754	}
1244		1755
1245	1	1756	1
1246	}	1757	}
1247	};	1758	};
1248		1759
1249	=back	1760	=back
1250		1761
1251	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1762	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1252		1763
1253	This function (not method) lets you add your own types to C<push_read>.	1764	Instead of one of the predefined types, you can also specify the name
		1765	of a package. AnyEvent will try to load the package and then expects to
		1766	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1767	progressively tries to load the parent package until it either finds the
		1768	function (good) or runs out of packages (bad).
1254		1769
1255	Whenever the given C<type> is used, C<push_read> will invoke the code	1770	Whenever this type is used, C<push_read> will invoke the function with the
1256	reference with the handle object, the callback and the remaining	1771	handle object, the original callback and the remaining arguments.
1257	arguments.
1258		1772
1259	The code reference is supposed to return a callback (usually a closure)	1773	The function is supposed to return a callback (usually a closure) that
1260	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1774	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1775	mentally treat the function as a "configurable read type to read callback"
		1776	converter.
1261		1777
1262	It should invoke the passed callback when it is done reading (remember to	1778	It should invoke the original callback when it is done reading (remember
1263	pass C<$handle> as first argument as all other callbacks do that).	1779	to pass C<$handle> as first argument as all other callbacks do that,
		1780	although there is no strict requirement on this).
1264		1781
1265	Note that this is a function, and all types registered this way will be
1266	global, so try to use unique names.
1267
1268	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1782	For examples, see the source of this module (F<perldoc -m
1269	search for C<register_read_type>)).	1783	AnyEvent::Handle>, search for C<register_read_type>)).
1270		1784
1271	=item $handle->stop_read	1785	=item $handle->stop_read
1272		1786
1273	=item $handle->start_read	1787	=item $handle->start_read
1274		1788
…		…
1280	Note that AnyEvent::Handle will automatically C<start_read> for you when	1794	Note that AnyEvent::Handle will automatically C<start_read> for you when
1281	you change the C<on_read> callback or push/unshift a read callback, and it	1795	you change the C<on_read> callback or push/unshift a read callback, and it
1282	will automatically C<stop_read> for you when neither C<on_read> is set nor	1796	will automatically C<stop_read> for you when neither C<on_read> is set nor
1283	there are any read requests in the queue.	1797	there are any read requests in the queue.
1284		1798
1285	These methods will have no effect when in TLS mode (as TLS doesn't support	1799	In older versions of this module (<= 5.3), these methods had no effect,
1286	half-duplex connections).	1800	as TLS does not support half-duplex connections. In current versions they
		1801	work as expected, as this behaviour is required to avoid certain resource
		1802	attacks, where the program would be forced to read (and buffer) arbitrary
		1803	amounts of data before being able to send some data. The drawback is that
		1804	some readings of the the SSL/TLS specifications basically require this
		1805	attack to be working, as SSL/TLS implementations might stall sending data
		1806	during a rehandshake.
		1807
		1808	As a guideline, during the initial handshake, you should not stop reading,
		1809	and as a client, it might cause problems, depending on your application.
1287		1810
1288	=cut	1811	=cut
1289		1812
1290	sub stop_read {	1813	sub stop_read {
1291	my ($self) = @_;	1814	my ($self) = @_;
1292		1815
1293	delete $self->{_rw} unless $self->{tls};	1816	delete $self->{_rw};
1294	}	1817	}
1295		1818
1296	sub start_read {	1819	sub start_read {
1297	my ($self) = @_;	1820	my ($self) = @_;
1298		1821
1299	unless ($self->{_rw} || $self->{_eof}) {	1822	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1300	Scalar::Util::weaken $self;	1823	Scalar::Util::weaken $self;
1301		1824
1302	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1825	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1303	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1826	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1304	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1827	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1305		1828
1306	if ($len > 0) {	1829	if ($len > 0) {
1307	$self->{_activity} = AnyEvent->now;	1830	$self->{_activity} = $self->{_ractivity} = AE::now;
1308		1831
1309	if ($self->{tls}) {	1832	if ($self->{tls}) {
1310	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1833	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1311		1834
1312	&_dotls ($self);	1835	&_dotls ($self);
1313	} else {	1836	} else {
1314	$self->_drain_rbuf unless $self->{_in_drain};	1837	$self->_drain_rbuf;
		1838	}
		1839
		1840	if ($len == $self->{read_size}) {
		1841	$self->{read_size} *= 2;
		1842	$self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
		1843	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1315	}	1844	}
1316		1845
1317	} elsif (defined $len) {	1846	} elsif (defined $len) {
1318	delete $self->{_rw};	1847	delete $self->{_rw};
1319	$self->{_eof} = 1;	1848	$self->{_eof} = 1;
1320	$self->_drain_rbuf unless $self->{_in_drain};	1849	$self->_drain_rbuf;
1321		1850
1322	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1851	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1323	return $self->_error ($!, 1);	1852	return $self->_error ($!, 1);
1324	}	1853	}
1325	});	1854	};
		1855	}
		1856	}
		1857
		1858	our $ERROR_SYSCALL;
		1859	our $ERROR_WANT_READ;
		1860
		1861	sub _tls_error {
		1862	my ($self, $err) = @_;
		1863
		1864	return $self->_error ($!, 1)
		1865	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1866
		1867	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1868
		1869	# reduce error string to look less scary
		1870	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1871
		1872	if ($self->{_on_starttls}) {
		1873	(delete $self->{_on_starttls})->($self, undef, $err);
		1874	&_freetls;
		1875	} else {
		1876	&_freetls;
		1877	$self->_error (Errno::EPROTO, 1, $err);
1326	}	1878	}
1327	}	1879	}
1328		1880
1329	# poll the write BIO and send the data if applicable	1881	# poll the write BIO and send the data if applicable
		1882	# also decode read data if possible
		1883	# this is basiclaly our TLS state machine
		1884	# more efficient implementations are possible with openssl,
		1885	# but not with the buggy and incomplete Net::SSLeay.
1330	sub _dotls {	1886	sub _dotls {
1331	my ($self) = @_;	1887	my ($self) = @_;
1332		1888
1333	my $tmp;	1889	my $tmp;
1334		1890
1335	if (length $self->{_tls_wbuf}) {	1891	if (length $self->{_tls_wbuf}) {
1336	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1892	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1337	substr $self->{_tls_wbuf}, 0, $tmp, "";	1893	substr $self->{_tls_wbuf}, 0, $tmp, "";
1338	}	1894	}
		1895
		1896	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1897	return $self->_tls_error ($tmp)
		1898	if $tmp != $ERROR_WANT_READ
		1899	&& ($tmp != $ERROR_SYSCALL || $!);
1339	}	1900	}
1340		1901
1341	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1902	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1342	unless (length $tmp) {	1903	unless (length $tmp) {
1343	# let's treat SSL-eof as we treat normal EOF	1904	$self->{_on_starttls}
1344	delete $self->{_rw};	1905	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1345	$self->{_eof} = 1;
1346	&_freetls;	1906	&_freetls;
		1907
		1908	if ($self->{on_stoptls}) {
		1909	$self->{on_stoptls}($self);
		1910	return;
		1911	} else {
		1912	# let's treat SSL-eof as we treat normal EOF
		1913	delete $self->{_rw};
		1914	$self->{_eof} = 1;
		1915	}
1347	}	1916	}
1348		1917
1349	$self->{rbuf} .= $tmp;	1918	$self->{_tls_rbuf} .= $tmp;
1350	$self->_drain_rbuf unless $self->{_in_drain};	1919	$self->_drain_rbuf;
1351	$self->{tls} or return; # tls session might have gone away in callback	1920	$self->{tls} or return; # tls session might have gone away in callback
1352	}	1921	}
1353		1922
1354	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1923	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1355
1356	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1357	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1358	return $self->_error ($!, 1);	1924	return $self->_tls_error ($tmp)
1359	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1925	if $tmp != $ERROR_WANT_READ
1360	return $self->_error (&Errno::EIO, 1);	1926	&& ($tmp != $ERROR_SYSCALL || $!);
1361	}
1362
1363	# all other errors are fine for our purposes
1364	}
1365		1927
1366	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1928	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1367	$self->{wbuf} .= $tmp;	1929	$self->{wbuf} .= $tmp;
1368	$self->_drain_wbuf;	1930	$self->_drain_wbuf;
		1931	$self->{tls} or return; # tls session might have gone away in callback
1369	}	1932	}
		1933
		1934	$self->{_on_starttls}
		1935	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1936	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1370	}	1937	}
1371		1938
1372	=item $handle->starttls ($tls[, $tls_ctx])	1939	=item $handle->starttls ($tls[, $tls_ctx])
1373		1940
1374	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1941	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1375	object is created, you can also do that at a later time by calling	1942	object is created, you can also do that at a later time by calling
1376	C<starttls>.	1943	C<starttls>. See the C<tls> constructor argument for general info.
		1944
		1945	Starting TLS is currently an asynchronous operation - when you push some
		1946	write data and then call C<< ->starttls >> then TLS negotiation will start
		1947	immediately, after which the queued write data is then sent. This might
		1948	change in future versions, so best make sure you have no outstanding write
		1949	data when calling this method.
1377		1950
1378	The first argument is the same as the C<tls> constructor argument (either	1951	The first argument is the same as the C<tls> constructor argument (either
1379	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1952	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1380		1953
1381	The second argument is the optional C<Net::SSLeay::CTX> object that is	1954	The second argument is the optional C<AnyEvent::TLS> object that is used
1382	used when AnyEvent::Handle has to create its own TLS connection object.	1955	when AnyEvent::Handle has to create its own TLS connection object, or
		1956	a hash reference with C<< key => value >> pairs that will be used to
		1957	construct a new context.
1383		1958
1384	The TLS connection object will end up in C<< $handle->{tls} >> after this	1959	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1385	call and can be used or changed to your liking. Note that the handshake	1960	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1386	might have already started when this function returns.	1961	changed to your liking. Note that the handshake might have already started
		1962	when this function returns.
1387		1963
1388	If it an error to start a TLS handshake more than once per	1964	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1389	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1965	handshakes on the same stream. It is best to not attempt to use the
		1966	stream after stopping TLS.
1390		1967
		1968	This method may invoke callbacks (and therefore the handle might be
		1969	destroyed after it returns).
		1970
1391	=cut	1971	=cut
		1972
		1973	our %TLS_CACHE; #TODO not yet documented, should we?
1392		1974
1393	sub starttls {	1975	sub starttls {
1394	my ($self, $ssl, $ctx) = @_;	1976	my ($self, $tls, $ctx) = @_;
1395		1977
1396	require Net::SSLeay;	1978	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1397
1398	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1399	if $self->{tls};	1979	if $self->{tls};
		1980
		1981	unless (defined $AnyEvent::TLS::VERSION) {
		1982	eval {
		1983	require Net::SSLeay;
		1984	require AnyEvent::TLS;
		1985	1
		1986	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		1987	}
		1988
		1989	$self->{tls} = $tls;
		1990	$self->{tls_ctx} = $ctx if @_ > 2;
		1991
		1992	return unless $self->{fh};
		1993
		1994	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1995	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1996
		1997	$tls = delete $self->{tls};
		1998	$ctx = $self->{tls_ctx};
		1999
		2000	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		2001
		2002	if ("HASH" eq ref $ctx) {
		2003	if ($ctx->{cache}) {
		2004	my $key = $ctx+0;
		2005	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		2006	} else {
		2007	$ctx = new AnyEvent::TLS %$ctx;
		2008	}
		2009	}
1400		2010
1401	if ($ssl eq "accept") {	2011	$self->{tls_ctx} = $ctx || TLS_CTX ();
1402	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	2012	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1403	Net::SSLeay::set_accept_state ($ssl);
1404	} elsif ($ssl eq "connect") {
1405	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1406	Net::SSLeay::set_connect_state ($ssl);
1407	}
1408
1409	$self->{tls} = $ssl;
1410		2013
1411	# basically, this is deep magic (because SSL_read should have the same issues)	2014	# basically, this is deep magic (because SSL_read should have the same issues)
1412	# but the openssl maintainers basically said: "trust us, it just works".	2015	# but the openssl maintainers basically said: "trust us, it just works".
1413	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	2016	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1414	# and mismaintained ssleay-module doesn't even offer them).	2017	# and mismaintained ssleay-module doesn't even offer them).
…		…
1418	#	2021	#
1419	# note that we do not try to keep the length constant between writes as we are required to do.	2022	# note that we do not try to keep the length constant between writes as we are required to do.
1420	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	2023	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1421	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	2024	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1422	# have identity issues in that area.	2025	# have identity issues in that area.
1423	Net::SSLeay::CTX_set_mode ($self->{tls},	2026	# Net::SSLeay::CTX_set_mode ($ssl,
1424	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	2027	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1425	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	2028	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		2029	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1426		2030
1427	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2031	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1428	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2032	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1429		2033
		2034	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2035	$self->{rbuf} = "";
		2036
1430	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	2037	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		2038
		2039	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		2040	if $self->{on_starttls};
1431		2041
1432	&_dotls; # need to trigger the initial handshake	2042	&_dotls; # need to trigger the initial handshake
1433	$self->start_read; # make sure we actually do read	2043	$self->start_read; # make sure we actually do read
1434	}	2044	}
1435		2045
1436	=item $handle->stoptls	2046	=item $handle->stoptls
1437		2047
1438	Shuts down the SSL connection - this makes a proper EOF handshake by	2048	Shuts down the SSL connection - this makes a proper EOF handshake by
1439	sending a close notify to the other side, but since OpenSSL doesn't	2049	sending a close notify to the other side, but since OpenSSL doesn't
1440	support non-blocking shut downs, it is not possible to re-use the stream	2050	support non-blocking shut downs, it is not guaranteed that you can re-use
1441	afterwards.	2051	the stream afterwards.
		2052
		2053	This method may invoke callbacks (and therefore the handle might be
		2054	destroyed after it returns).
1442		2055
1443	=cut	2056	=cut
1444		2057
1445	sub stoptls {	2058	sub stoptls {
1446	my ($self) = @_;	2059	my ($self) = @_;
1447		2060
1448	if ($self->{tls}) {	2061	if ($self->{tls} && $self->{fh}) {
1449	Net::SSLeay::shutdown ($self->{tls});	2062	Net::SSLeay::shutdown ($self->{tls});
1450		2063
1451	&_dotls;	2064	&_dotls;
1452		2065
1453	# we don't give a shit. no, we do, but we can't. no...	2066	# # we don't give a shit. no, we do, but we can't. no...#d#
1454	# we, we... have to use openssl :/	2067	# # we, we... have to use openssl :/#d#
1455	&_freetls;	2068	# &_freetls;#d#
1456	}	2069	}
1457	}	2070	}
1458		2071
1459	sub _freetls {	2072	sub _freetls {
1460	my ($self) = @_;	2073	my ($self) = @_;
1461		2074
1462	return unless $self->{tls};	2075	return unless $self->{tls};
1463		2076
1464	Net::SSLeay::free (delete $self->{tls});	2077	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2078	if $self->{tls} > 0;
1465		2079
1466	delete @$self{qw(_rbio _wbio _tls_wbuf)};	2080	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1467	}	2081	}
		2082
		2083	=item $handle->resettls
		2084
		2085	This rarely-used method simply resets and TLS state on the handle, usually
		2086	causing data loss.
		2087
		2088	One case where it may be useful is when you want to skip over the data in
		2089	the stream but you are not interested in interpreting it, so data loss is
		2090	no concern.
		2091
		2092	=cut
		2093
		2094	*resettls = \&_freetls;
1468		2095
1469	sub DESTROY {	2096	sub DESTROY {
1470	my $self = shift;	2097	my ($self) = @_;
1471		2098
1472	&_freetls;	2099	&_freetls;
1473		2100
1474	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	2101	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1475		2102
1476	if ($linger && length $self->{wbuf}) {	2103	if ($linger && length $self->{wbuf} && $self->{fh}) {
1477	my $fh = delete $self->{fh};	2104	my $fh = delete $self->{fh};
1478	my $wbuf = delete $self->{wbuf};	2105	my $wbuf = delete $self->{wbuf};
1479		2106
1480	my @linger;	2107	my @linger;
1481		2108
1482	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2109	push @linger, AE::io $fh, 1, sub {
1483	my $len = syswrite $fh, $wbuf, length $wbuf;	2110	my $len = syswrite $fh, $wbuf, length $wbuf;
1484		2111
1485	if ($len > 0) {	2112	if ($len > 0) {
1486	substr $wbuf, 0, $len, "";	2113	substr $wbuf, 0, $len, "";
1487	} else {	2114	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1488	@linger = (); # end	2115	@linger = (); # end
1489	}	2116	}
1490	});	2117	};
1491	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2118	push @linger, AE::timer $linger, 0, sub {
1492	@linger = ();	2119	@linger = ();
1493	});	2120	};
1494	}	2121	}
1495	}	2122	}
1496		2123
1497	=item $handle->destroy	2124	=item $handle->destroy
1498		2125
1499	Shuts down the handle object as much as possible - this call ensures that	2126	Shuts down the handle object as much as possible - this call ensures that
1500	no further callbacks will be invoked and resources will be freed as much	2127	no further callbacks will be invoked and as many resources as possible
1501	as possible. You must not call any methods on the object afterwards.	2128	will be freed. Any method you will call on the handle object after
		2129	destroying it in this way will be silently ignored (and it will return the
		2130	empty list).
1502		2131
1503	Normally, you can just "forget" any references to an AnyEvent::Handle	2132	Normally, you can just "forget" any references to an AnyEvent::Handle
1504	object and it will simply shut down. This works in fatal error and EOF	2133	object and it will simply shut down. This works in fatal error and EOF
1505	callbacks, as well as code outside. It does I<NOT> work in a read or write	2134	callbacks, as well as code outside. It does I<NOT> work in a read or write
1506	callback, so when you want to destroy the AnyEvent::Handle object from	2135	callback, so when you want to destroy the AnyEvent::Handle object from
1507	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	2136	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1508	that case.	2137	that case.
1509		2138
		2139	Destroying the handle object in this way has the advantage that callbacks
		2140	will be removed as well, so if those are the only reference holders (as
		2141	is common), then one doesn't need to do anything special to break any
		2142	reference cycles.
		2143
1510	The handle might still linger in the background and write out remaining	2144	The handle might still linger in the background and write out remaining
1511	data, as specified by the C<linger> option, however.	2145	data, as specified by the C<linger> option, however.
1512		2146
1513	=cut	2147	=cut
1514		2148
1515	sub destroy {	2149	sub destroy {
1516	my ($self) = @_;	2150	my ($self) = @_;
1517		2151
1518	$self->DESTROY;	2152	$self->DESTROY;
1519	%$self = ();	2153	%$self = ();
		2154	bless $self, "AnyEvent::Handle::destroyed";
1520	}	2155	}
		2156
		2157	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2158	#nop
		2159	}
		2160
		2161	=item $handle->destroyed
		2162
		2163	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2164	->destroy >>, true otherwise.
		2165
		2166	Can be useful to decide whether the handle is still valid after some
		2167	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2168	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2169	can destroy the handle, so work can be avoided by checking sometimes:
		2170
		2171	$hdl->starttls ("accept");
		2172	return if $hdl->destroyed;
		2173	$hdl->push_write (...
		2174
		2175	Note that the call to C<push_write> will silently be ignored if the handle
		2176	has been destroyed, so often you can just ignore the possibility of the
		2177	handle being destroyed.
		2178
		2179	=cut
		2180
		2181	sub destroyed { 0 }
		2182	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1521		2183
1522	=item AnyEvent::Handle::TLS_CTX	2184	=item AnyEvent::Handle::TLS_CTX
1523		2185
1524	This function creates and returns the Net::SSLeay::CTX object used by	2186	This function creates and returns the AnyEvent::TLS object used by default
1525	default for TLS mode.	2187	for TLS mode.
1526		2188
1527	The context is created like this:	2189	The context is created by calling L<AnyEvent::TLS> without any arguments.
1528
1529	Net::SSLeay::load_error_strings;
1530	Net::SSLeay::SSLeay_add_ssl_algorithms;
1531	Net::SSLeay::randomize;
1532
1533	my $CTX = Net::SSLeay::CTX_new;
1534
1535	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1536		2190
1537	=cut	2191	=cut
1538		2192
1539	our $TLS_CTX;	2193	our $TLS_CTX;
1540		2194
1541	sub TLS_CTX() {	2195	sub TLS_CTX() {
1542	$TLS_CTX || do {	2196	$TLS_CTX ||= do {
1543	require Net::SSLeay;	2197	require AnyEvent::TLS;
1544		2198
1545	Net::SSLeay::load_error_strings ();	2199	new AnyEvent::TLS
1546	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1547	Net::SSLeay::randomize ();
1548
1549	$TLS_CTX = Net::SSLeay::CTX_new ();
1550
1551	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1552
1553	$TLS_CTX
1554	}	2200	}
1555	}	2201	}
1556		2202
1557	=back	2203	=back
1558		2204
…		…
1569		2215
1570	It is only safe to "forget" the reference inside EOF or error callbacks,	2216	It is only safe to "forget" the reference inside EOF or error callbacks,
1571	from within all other callbacks, you need to explicitly call the C<<	2217	from within all other callbacks, you need to explicitly call the C<<
1572	->destroy >> method.	2218	->destroy >> method.
1573		2219
		2220	=item Why is my C<on_eof> callback never called?
		2221
		2222	Probably because your C<on_error> callback is being called instead: When
		2223	you have outstanding requests in your read queue, then an EOF is
		2224	considered an error as you clearly expected some data.
		2225
		2226	To avoid this, make sure you have an empty read queue whenever your handle
		2227	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2228	an C<on_read> handler that simply pushes the first read requests in the
		2229	queue.
		2230
		2231	See also the next question, which explains this in a bit more detail.
		2232
		2233	=item How can I serve requests in a loop?
		2234
		2235	Most protocols consist of some setup phase (authentication for example)
		2236	followed by a request handling phase, where the server waits for requests
		2237	and handles them, in a loop.
		2238
		2239	There are two important variants: The first (traditional, better) variant
		2240	handles requests until the server gets some QUIT command, causing it to
		2241	close the connection first (highly desirable for a busy TCP server). A
		2242	client dropping the connection is an error, which means this variant can
		2243	detect an unexpected detection close.
		2244
		2245	To handle this case, always make sure you have a on-empty read queue, by
		2246	pushing the "read request start" handler on it:
		2247
		2248	# we assume a request starts with a single line
		2249	my @start_request; @start_request = (line => sub {
		2250	my ($hdl, $line) = @_;
		2251
		2252	... handle request
		2253
		2254	# push next request read, possibly from a nested callback
		2255	$hdl->push_read (@start_request);
		2256	});
		2257
		2258	# auth done, now go into request handling loop
		2259	# now push the first @start_request
		2260	$hdl->push_read (@start_request);
		2261
		2262	By always having an outstanding C<push_read>, the handle always expects
		2263	some data and raises the C<EPIPE> error when the connction is dropped
		2264	unexpectedly.
		2265
		2266	The second variant is a protocol where the client can drop the connection
		2267	at any time. For TCP, this means that the server machine may run out of
		2268	sockets easier, and in general, it means you cannot distinguish a protocl
		2269	failure/client crash from a normal connection close. Nevertheless, these
		2270	kinds of protocols are common (and sometimes even the best solution to the
		2271	problem).
		2272
		2273	Having an outstanding read request at all times is possible if you ignore
		2274	C<EPIPE> errors, but this doesn't help with when the client drops the
		2275	connection during a request, which would still be an error.
		2276
		2277	A better solution is to push the initial request read in an C<on_read>
		2278	callback. This avoids an error, as when the server doesn't expect data
		2279	(i.e. is idly waiting for the next request, an EOF will not raise an
		2280	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2281	and simpler:
		2282
		2283	# auth done, now go into request handling loop
		2284	$hdl->on_read (sub {
		2285	my ($hdl) = @_;
		2286
		2287	# called each time we receive data but the read queue is empty
		2288	# simply start read the request
		2289
		2290	$hdl->push_read (line => sub {
		2291	my ($hdl, $line) = @_;
		2292
		2293	... handle request
		2294
		2295	# do nothing special when the request has been handled, just
		2296	# let the request queue go empty.
		2297	});
		2298	});
		2299
1574	=item I get different callback invocations in TLS mode/Why can't I pause	2300	=item I get different callback invocations in TLS mode/Why can't I pause
1575	reading?	2301	reading?
1576		2302
1577	Unlike, say, TCP, TLS connections do not consist of two independent	2303	Unlike, say, TCP, TLS connections do not consist of two independent
1578	communication channels, one for each direction. Or put differently. The	2304	communication channels, one for each direction. Or put differently, the
1579	read and write directions are not independent of each other: you cannot	2305	read and write directions are not independent of each other: you cannot
1580	write data unless you are also prepared to read, and vice versa.	2306	write data unless you are also prepared to read, and vice versa.
1581		2307
1582	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2308	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1583	callback invocations when you are not expecting any read data - the reason	2309	callback invocations when you are not expecting any read data - the reason
1584	is that AnyEvent::Handle always reads in TLS mode.	2310	is that AnyEvent::Handle always reads in TLS mode.
1585		2311
1586	During the connection, you have to make sure that you always have a	2312	During the connection, you have to make sure that you always have a
1587	non-empty read-queue, or an C<on_read> watcher. At the end of the	2313	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1597		2323
1598	$handle->on_read (sub { });	2324	$handle->on_read (sub { });
1599	$handle->on_eof (undef);	2325	$handle->on_eof (undef);
1600	$handle->on_error (sub {	2326	$handle->on_error (sub {
1601	my $data = delete $_[0]{rbuf};	2327	my $data = delete $_[0]{rbuf};
1602	undef $handle;
1603	});	2328	});
		2329
		2330	Note that this example removes the C<rbuf> member from the handle object,
		2331	which is not normally allowed by the API. It is expressly permitted in
		2332	this case only, as the handle object needs to be destroyed afterwards.
1604		2333
1605	The reason to use C<on_error> is that TCP connections, due to latencies	2334	The reason to use C<on_error> is that TCP connections, due to latencies
1606	and packets loss, might get closed quite violently with an error, when in	2335	and packets loss, might get closed quite violently with an error, when in
1607	fact, all data has been received.	2336	fact all data has been received.
1608		2337
1609	It is usually better to use acknowledgements when transferring data,	2338	It is usually better to use acknowledgements when transferring data,
1610	to make sure the other side hasn't just died and you got the data	2339	to make sure the other side hasn't just died and you got the data
1611	intact. This is also one reason why so many internet protocols have an	2340	intact. This is also one reason why so many internet protocols have an
1612	explicit QUIT command.	2341	explicit QUIT command.
…		…
1619	C<low_water_mark> this will be called precisely when all data has been	2348	C<low_water_mark> this will be called precisely when all data has been
1620	written to the socket:	2349	written to the socket:
1621		2350
1622	$handle->push_write (...);	2351	$handle->push_write (...);
1623	$handle->on_drain (sub {	2352	$handle->on_drain (sub {
1624	warn "all data submitted to the kernel\n";	2353	AE::log debug => "All data submitted to the kernel.";
1625	undef $handle;	2354	undef $handle;
1626	});	2355	});
1627		2356
		2357	If you just want to queue some data and then signal EOF to the other side,
		2358	consider using C<< ->push_shutdown >> instead.
		2359
		2360	=item I want to contact a TLS/SSL server, I don't care about security.
		2361
		2362	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2363	connect to it and then create the AnyEvent::Handle with the C<tls>
		2364	parameter:
		2365
		2366	tcp_connect $host, $port, sub {
		2367	my ($fh) = @_;
		2368
		2369	my $handle = new AnyEvent::Handle
		2370	fh => $fh,
		2371	tls => "connect",
		2372	on_error => sub { ... };
		2373
		2374	$handle->push_write (...);
		2375	};
		2376
		2377	=item I want to contact a TLS/SSL server, I do care about security.
		2378
		2379	Then you should additionally enable certificate verification, including
		2380	peername verification, if the protocol you use supports it (see
		2381	L<AnyEvent::TLS>, C<verify_peername>).
		2382
		2383	E.g. for HTTPS:
		2384
		2385	tcp_connect $host, $port, sub {
		2386	my ($fh) = @_;
		2387
		2388	my $handle = new AnyEvent::Handle
		2389	fh => $fh,
		2390	peername => $host,
		2391	tls => "connect",
		2392	tls_ctx => { verify => 1, verify_peername => "https" },
		2393	...
		2394
		2395	Note that you must specify the hostname you connected to (or whatever
		2396	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2397	peername verification will be done.
		2398
		2399	The above will use the system-dependent default set of trusted CA
		2400	certificates. If you want to check against a specific CA, add the
		2401	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2402
		2403	tls_ctx => {
		2404	verify => 1,
		2405	verify_peername => "https",
		2406	ca_file => "my-ca-cert.pem",
		2407	},
		2408
		2409	=item I want to create a TLS/SSL server, how do I do that?
		2410
		2411	Well, you first need to get a server certificate and key. You have
		2412	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2413	self-signed certificate (cheap. check the search engine of your choice,
		2414	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2415	nice program for that purpose).
		2416
		2417	Then create a file with your private key (in PEM format, see
		2418	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2419	file should then look like this:
		2420
		2421	-----BEGIN RSA PRIVATE KEY-----
		2422	...header data
		2423	... lots of base64'y-stuff
		2424	-----END RSA PRIVATE KEY-----
		2425
		2426	-----BEGIN CERTIFICATE-----
		2427	... lots of base64'y-stuff
		2428	-----END CERTIFICATE-----
		2429
		2430	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2431	specify this file as C<cert_file>:
		2432
		2433	tcp_server undef, $port, sub {
		2434	my ($fh) = @_;
		2435
		2436	my $handle = new AnyEvent::Handle
		2437	fh => $fh,
		2438	tls => "accept",
		2439	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2440	...
		2441
		2442	When you have intermediate CA certificates that your clients might not
		2443	know about, just append them to the C<cert_file>.
		2444
1628	=back	2445	=back
1629
1630		2446
1631	=head1 SUBCLASSING AnyEvent::Handle	2447	=head1 SUBCLASSING AnyEvent::Handle
1632		2448
1633	In many cases, you might want to subclass AnyEvent::Handle.	2449	In many cases, you might want to subclass AnyEvent::Handle.
1634		2450
…		…
1651		2467
1652	=item * all members not documented here and not prefixed with an underscore	2468	=item * all members not documented here and not prefixed with an underscore
1653	are free to use in subclasses.	2469	are free to use in subclasses.
1654		2470
1655	Of course, new versions of AnyEvent::Handle may introduce more "public"	2471	Of course, new versions of AnyEvent::Handle may introduce more "public"
1656	member variables, but thats just life, at least it is documented.	2472	member variables, but that's just life. At least it is documented.
1657		2473
1658	=back	2474	=back
1659		2475
1660	=head1 AUTHOR	2476	=head1 AUTHOR
1661		2477
1662	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2478	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
1663		2479
1664	=cut	2480	=cut
1665		2481
1666	1; # End of AnyEvent::Handle	2482	1
		2483

Diff Legend

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