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

Diff Legend

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