ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.156 by root, Wed Jul 22 05:37:32 2009 UTC vs.
Revision 1.219 by root, Mon Jul 18 01:19:43 2011 UTC

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

Diff Legend

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