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.132 by elmex, Thu Jul 2 22:25:13 2009 UTC vs.
Revision 1.204 by root, Mon Nov 15 03:29:17 2010 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.45;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
		16	warn "got error $msg\n";
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	},
34	);	19	};
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	warn "got line <$line>\n";
43	$cv->send;	28	$cv->send;
44	});	29	});
45		30
46	$cv->recv;	31	$cv->recv;
47		32
48	=head1 DESCRIPTION	33	=head1 DESCRIPTION
49		34
50	This module is a helper module to make it easier to do event-based I/O on	35	This is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	36	stream-based filehandles (sockets, pipes, and other stream things).
52	on sockets see L<AnyEvent::Util>.
53		37
54	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
56		40
57	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
58	means characters. As sysread and syswrite are used for all I/O, their	42	characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
60		47
61	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
62	argument.	49	argument.
63		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
		80	sub MAX_READ_SIZE() { 131072 }
		81
64	=head1 METHODS	82	=head1 METHODS
65		83
66	=over 4	84	=over 4
67		85
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69		87
70	The constructor supports these arguments (all as C<< key => value >> pairs).	88	The constructor supports these arguments (all as C<< key => value >> pairs).
71		89
72	=over 4	90	=over 4
73		91
74	=item fh => $filehandle [MANDATORY]	92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		93
76	The filehandle this L<AnyEvent::Handle> object will operate on.	94	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	95	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	96	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	97	that mode.
81		98
		99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		100
		101	Try to connect to the specified host and service (port), using
		102	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		103	default C<peername>.
		104
		105	You have to specify either this parameter, or C<fh>, above.
		106
		107	It is possible to push requests on the read and write queues, and modify
		108	properties of the stream, even while AnyEvent::Handle is connecting.
		109
		110	When this parameter is specified, then the C<on_prepare>,
		111	C<on_connect_error> and C<on_connect> callbacks will be called under the
		112	appropriate circumstances:
		113
		114	=over 4
		115
		116	=item on_prepare => $cb->($handle)
		117
		118	This (rarely used) callback is called before a new connection is
		119	attempted, but after the file handle has been created. It could be used to
		120	prepare the file handle with parameters required for the actual connect
		121	(as opposed to settings that can be changed when the connection is already
		122	established).
		123
		124	The return value of this callback should be the connect timeout value in
		125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
		126	default timeout is to be used).
		127
		128	=item on_connect => $cb->($handle, $host, $port, $retry->())
		129
		130	This callback is called when a connection has been successfully established.
		131
		132	The peer's numeric host and port (the socket peername) are passed as
		133	parameters, together with a retry callback.
		134
		135	If, for some reason, the handle is not acceptable, calling C<$retry>
		136	will continue with the next connection target (in case of multi-homed
		137	hosts or SRV records there can be multiple connection endpoints). At the
		138	time it is called the read and write queues, eof status, tls status and
		139	similar properties of the handle will have been reset.
		140
		141	In most cases, you should ignore the C<$retry> parameter.
		142
		143	=item on_connect_error => $cb->($handle, $message)
		144
		145	This callback is called when the connection could not be
		146	established. C<$!> will contain the relevant error code, and C<$message> a
		147	message describing it (usually the same as C<"$!">).
		148
		149	If this callback isn't specified, then C<on_error> will be called with a
		150	fatal error instead.
		151
		152	=back
		153
		154	=item on_error => $cb->($handle, $fatal, $message)
		155
		156	This is the error callback, which is called when, well, some error
		157	occured, such as not being able to resolve the hostname, failure to
		158	connect, or a read error.
		159
		160	Some errors are fatal (which is indicated by C<$fatal> being true). On
		161	fatal errors the handle object will be destroyed (by a call to C<< ->
		162	destroy >>) after invoking the error callback (which means you are free to
		163	examine the handle object). Examples of fatal errors are an EOF condition
		164	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
		165	cases where the other side can close the connection at will, it is
		166	often easiest to not report C<EPIPE> errors in this callback.
		167
		168	AnyEvent::Handle tries to find an appropriate error code for you to check
		169	against, but in some cases (TLS errors), this does not work well. It is
		170	recommended to always output the C<$message> argument in human-readable
		171	error messages (it's usually the same as C<"$!">).
		172
		173	Non-fatal errors can be retried by returning, but it is recommended
		174	to simply ignore this parameter and instead abondon the handle object
		175	when this callback is invoked. Examples of non-fatal errors are timeouts
		176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		177
		178	On entry to the callback, the value of C<$!> contains the operating
		179	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		180	C<EPROTO>).
		181
		182	While not mandatory, it is I<highly> recommended to set this callback, as
		183	you will not be notified of errors otherwise. The default just calls
		184	C<croak>.
		185
		186	=item on_read => $cb->($handle)
		187
		188	This sets the default read callback, which is called when data arrives
		189	and no read request is in the queue (unlike read queue callbacks, this
		190	callback will only be called when at least one octet of data is in the
		191	read buffer).
		192
		193	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		194	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		195	must not enlarge or modify the read buffer, you can only remove data at
		196	the beginning from it.
		197
		198	You can also call C<< ->push_read (...) >> or any other function that
		199	modifies the read queue. Or do both. Or ...
		200
		201	When an EOF condition is detected, AnyEvent::Handle will first try to
		202	feed all the remaining data to the queued callbacks and C<on_read> before
		203	calling the C<on_eof> callback. If no progress can be made, then a fatal
		204	error will be raised (with C<$!> set to C<EPIPE>).
		205
		206	Note that, unlike requests in the read queue, an C<on_read> callback
		207	doesn't mean you I<require> some data: if there is an EOF and there
		208	are outstanding read requests then an error will be flagged. With an
		209	C<on_read> callback, the C<on_eof> callback will be invoked.
		210
82	=item on_eof => $cb->($handle)	211	=item on_eof => $cb->($handle)
83		212
84	Set the callback to be called when an end-of-file condition is detected,	213	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	214	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	215	connection cleanly, and there are no outstanding read requests in the
		216	queue (if there are read requests, then an EOF counts as an unexpected
		217	connection close and will be flagged as an error).
87		218
88	For sockets, this just means that the other side has stopped sending data,	219	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	220	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	221	callback and continue writing data, as only the read part has been shut
91	down.	222	down.
92		223
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	224	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	225	set, then a fatal error will be raised with C<$!> set to <0>.
99		226
100	=item on_error => $cb->($handle, $fatal)
101
102	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.
105
106	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.
111
112	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116
117	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
119
120	While not mandatory, it is I<highly> recommended to set this callback, as
121	you will not be notified of errors otherwise. The default simply calls
122	C<croak>.
123
124	=item on_read => $cb->($handle)
125
126	This sets the default read callback, which is called when data arrives
127	and no read request is in the queue (unlike read queue callbacks, this
128	callback will only be called when at least one octet of data is in the
129	read buffer).
130
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly. Note that you
133	must not enlarge or modify the read buffer, you can only remove data at
134	the beginning from it.
135
136	When an EOF condition is detected then AnyEvent::Handle will first try to
137	feed all the remaining data to the queued callbacks and C<on_read> before
138	calling the C<on_eof> callback. If no progress can be made, then a fatal
139	error will be raised (with C<$!> set to C<EPIPE>).
140
141	=item on_drain => $cb->($handle)	227	=item on_drain => $cb->($handle)
142		228
143	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
144	(or when the callback is set and the buffer is empty already).	230	(or immediately if the buffer is empty already).
145		231
146	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.
147		233
148	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
149	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
…		…
151	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
152	the file when the write queue becomes empty.	238	the file when the write queue becomes empty.
153		239
154	=item timeout => $fractional_seconds	240	=item timeout => $fractional_seconds
155		241
		242	=item rtimeout => $fractional_seconds
		243
		244	=item wtimeout => $fractional_seconds
		245
156	If non-zero, then this enables an "inactivity" timeout: whenever this many	246	If non-zero, then these enables an "inactivity" timeout: whenever this
157	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
158	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
159	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).
160		251
		252	There are three variants of the timeouts that work independently
		253	of each other, for both read and write, just read, and just write:
		254	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		255	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		256	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
		257
161	Note that timeout processing is also active when you currently do not have	258	Note that timeout processing is active even when you do not have
162	any outstanding read or write requests: If you plan to keep the connection	259	any outstanding read or write requests: If you plan to keep the connection
163	idle then you should disable the timout temporarily or ignore the timeout	260	idle then you should disable the timeout temporarily or ignore the timeout
164	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	261	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
165	restart the timeout.	262	restart the timeout.
166		263
167	Zero (the default) disables this timeout.	264	Zero (the default) disables this timeout.
168		265
…		…
184	amount of data without a callback ever being called as long as the line	281	amount of data without a callback ever being called as long as the line
185	isn't finished).	282	isn't finished).
186		283
187	=item autocork => <boolean>	284	=item autocork => <boolean>
188		285
189	When disabled (the default), then C<push_write> will try to immediately	286	When disabled (the default), C<push_write> will try to immediately
190	write the data to the handle, if possible. This avoids having to register	287	write the data to the handle if possible. This avoids having to register
191	a write watcher and wait for the next event loop iteration, but can	288	a write watcher and wait for the next event loop iteration, but can
192	be inefficient if you write multiple small chunks (on the wire, this	289	be inefficient if you write multiple small chunks (on the wire, this
193	disadvantage is usually avoided by your kernel's nagle algorithm, see	290	disadvantage is usually avoided by your kernel's nagle algorithm, see
194	C<no_delay>, but this option can save costly syscalls).	291	C<no_delay>, but this option can save costly syscalls).
195		292
196	When enabled, then writes will always be queued till the next event loop	293	When enabled, writes will always be queued till the next event loop
197	iteration. This is efficient when you do many small writes per iteration,	294	iteration. This is efficient when you do many small writes per iteration,
198	but less efficient when you do a single write only per iteration (or when	295	but less efficient when you do a single write only per iteration (or when
199	the write buffer often is full). It also increases write latency.	296	the write buffer often is full). It also increases write latency.
200		297
201	=item no_delay => <boolean>	298	=item no_delay => <boolean>
…		…
205	the Nagle algorithm, and usually it is beneficial.	302	the Nagle algorithm, and usually it is beneficial.
206		303
207	In some situations you want as low a delay as possible, which can be	304	In some situations you want as low a delay as possible, which can be
208	accomplishd by setting this option to a true value.	305	accomplishd by setting this option to a true value.
209		306
210	The default is your opertaing system's default behaviour (most likely	307	The default is your operating system's default behaviour (most likely
211	enabled), this option explicitly enables or disables it, if possible.	308	enabled). This option explicitly enables or disables it, if possible.
		309
		310	=item keepalive => <boolean>
		311
		312	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		313	normally, TCP connections have no time-out once established, so TCP
		314	connections, once established, can stay alive forever even when the other
		315	side has long gone. TCP keepalives are a cheap way to take down long-lived
		316	TCP connections when the other side becomes unreachable. While the default
		317	is OS-dependent, TCP keepalives usually kick in after around two hours,
		318	and, if the other side doesn't reply, take down the TCP connection some 10
		319	to 15 minutes later.
		320
		321	It is harmless to specify this option for file handles that do not support
		322	keepalives, and enabling it on connections that are potentially long-lived
		323	is usually a good idea.
		324
		325	=item oobinline => <boolean>
		326
		327	BSD majorly fucked up the implementation of TCP urgent data. The result
		328	is that almost no OS implements TCP according to the specs, and every OS
		329	implements it slightly differently.
		330
		331	If you want to handle TCP urgent data, then setting this flag (the default
		332	is enabled) gives you the most portable way of getting urgent data, by
		333	putting it into the stream.
		334
		335	Since BSD emulation of OOB data on top of TCP's urgent data can have
		336	security implications, AnyEvent::Handle sets this flag automatically
		337	unless explicitly specified. Note that setting this flag after
		338	establishing a connection I<may> be a bit too late (data loss could
		339	already have occured on BSD systems), but at least it will protect you
		340	from most attacks.
212		341
213	=item read_size => <bytes>	342	=item read_size => <bytes>
214		343
215	The default read block size (the amount of bytes this module will	344	The initial read block size, the number of bytes this module will try to
216	try to read during each loop iteration, which affects memory	345	read during each loop iteration. Each handle object will consume at least
217	requirements). Default: C<8192>.	346	this amount of memory for the read buffer as well, so when handling many
		347	connections requirements). See also C<max_read_size>. Default: C<2048>.
		348
		349	=item max_read_size => <bytes>
		350
		351	The maximum read buffer size used by the dynamic adjustment
		352	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
		353	one go it will double C<read_size> up to the maximum given by this
		354	option. Default: C<131072> or C<read_size>, whichever is higher.
218		355
219	=item low_water_mark => <bytes>	356	=item low_water_mark => <bytes>
220		357
221	Sets the amount of bytes (default: C<0>) that make up an "empty" write	358	Sets the number of bytes (default: C<0>) that make up an "empty" write
222	buffer: If the write reaches this size or gets even samller it is	359	buffer: If the buffer reaches this size or gets even samller it is
223	considered empty.	360	considered empty.
224		361
225	Sometimes it can be beneficial (for performance reasons) to add data to	362	Sometimes it can be beneficial (for performance reasons) to add data to
226	the write buffer before it is fully drained, but this is a rare case, as	363	the write buffer before it is fully drained, but this is a rare case, as
227	the operating system kernel usually buffers data as well, so the default	364	the operating system kernel usually buffers data as well, so the default
228	is good in almost all cases.	365	is good in almost all cases.
229		366
230	=item linger => <seconds>	367	=item linger => <seconds>
231		368
232	If non-zero (default: C<3600>), then the destructor of the	369	If this is non-zero (default: C<3600>), the destructor of the
233	AnyEvent::Handle object will check whether there is still outstanding	370	AnyEvent::Handle object will check whether there is still outstanding
234	write data and will install a watcher that will write this data to the	371	write data and will install a watcher that will write this data to the
235	socket. No errors will be reported (this mostly matches how the operating	372	socket. No errors will be reported (this mostly matches how the operating
236	system treats outstanding data at socket close time).	373	system treats outstanding data at socket close time).
237		374
238	This will not work for partial TLS data that could not be encoded	375	This will not work for partial TLS data that could not be encoded
239	yet. This data will be lost. Calling the C<stoptls> method in time might	376	yet. This data will be lost. Calling the C<stoptls> method in time might
240	help.	377	help.
241		378
242	=item common_name => $string	379	=item peername => $string
243		380
244	The common name used by some verification methods (most notably SSL/TLS)	381	A string used to identify the remote site - usually the DNS hostname
245	associated with this connection. Usually this is the remote hostname used	382	(I<not> IDN!) used to create the connection, rarely the IP address.
246	to connect, but can be almost anything.	383
		384	Apart from being useful in error messages, this string is also used in TLS
		385	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		386	verification will be skipped when C<peername> is not specified or is
		387	C<undef>.
247		388
248	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	389	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
249		390
250	When this parameter is given, it enables TLS (SSL) mode, that means	391	When this parameter is given, it enables TLS (SSL) mode, that means
251	AnyEvent will start a TLS handshake as soon as the conenction has been	392	AnyEvent will start a TLS handshake as soon as the connection has been
252	established and will transparently encrypt/decrypt data afterwards.	393	established and will transparently encrypt/decrypt data afterwards.
		394
		395	All TLS protocol errors will be signalled as C<EPROTO>, with an
		396	appropriate error message.
253		397
254	TLS mode requires Net::SSLeay to be installed (it will be loaded	398	TLS mode requires Net::SSLeay to be installed (it will be loaded
255	automatically when you try to create a TLS handle): this module doesn't	399	automatically when you try to create a TLS handle): this module doesn't
256	have a dependency on that module, so if your module requires it, you have	400	have a dependency on that module, so if your module requires it, you have
257	to add the dependency yourself.	401	to add the dependency yourself.
…		…
273	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	417	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
274	passing in the wrong integer will lead to certain crash. This most often	418	passing in the wrong integer will lead to certain crash. This most often
275	happens when one uses a stylish C<< tls => 1 >> and is surprised about the	419	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
276	segmentation fault.	420	segmentation fault.
277		421
278	See the C<< ->starttls >> method for when need to start TLS negotiation later.	422	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
279		423
280	=item tls_ctx => $anyevent_tls	424	=item tls_ctx => $anyevent_tls
281		425
282	Use the given C<AnyEvent::TLS> object to create the new TLS connection	426	Use the given C<AnyEvent::TLS> object to create the new TLS connection
283	(unless a connection object was specified directly). If this parameter is	427	(unless a connection object was specified directly). If this parameter is
…		…
285		429
286	Instead of an object, you can also specify a hash reference with C<< key	430	Instead of an object, you can also specify a hash reference with C<< key
287	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	431	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
288	new TLS context object.	432	new TLS context object.
289		433
		434	=item on_starttls => $cb->($handle, $success[, $error_message])
		435
		436	This callback will be invoked when the TLS/SSL handshake has finished. If
		437	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		438	(C<on_stoptls> will not be called in this case).
		439
		440	The session in C<< $handle->{tls} >> can still be examined in this
		441	callback, even when the handshake was not successful.
		442
		443	TLS handshake failures will not cause C<on_error> to be invoked when this
		444	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		445
		446	Without this callback, handshake failures lead to C<on_error> being
		447	called as usual.
		448
		449	Note that you cannot just call C<starttls> again in this callback. If you
		450	need to do that, start an zero-second timer instead whose callback can
		451	then call C<< ->starttls >> again.
		452
		453	=item on_stoptls => $cb->($handle)
		454
		455	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		456	set, then it will be invoked after freeing the TLS session. If it is not,
		457	then a TLS shutdown condition will be treated like a normal EOF condition
		458	on the handle.
		459
		460	The session in C<< $handle->{tls} >> can still be examined in this
		461	callback.
		462
		463	This callback will only be called on TLS shutdowns, not when the
		464	underlying handle signals EOF.
		465
290	=item json => JSON or JSON::XS object	466	=item json => JSON or JSON::XS object
291		467
292	This is the json coder object used by the C<json> read and write types.	468	This is the json coder object used by the C<json> read and write types.
293		469
294	If you don't supply it, then AnyEvent::Handle will create and use a	470	If you don't supply it, then AnyEvent::Handle will create and use a
…		…
304		480
305	sub new {	481	sub new {
306	my $class = shift;	482	my $class = shift;
307	my $self = bless { @_ }, $class;	483	my $self = bless { @_ }, $class;
308		484
309	$self->{fh} or Carp::croak "mandatory argument fh is missing";	485	if ($self->{fh}) {
		486	$self->_start;
		487	return unless $self->{fh}; # could be gone by now
		488
		489	} elsif ($self->{connect}) {
		490	require AnyEvent::Socket;
		491
		492	$self->{peername} = $self->{connect}[0]
		493	unless exists $self->{peername};
		494
		495	$self->{_skip_drain_rbuf} = 1;
		496
		497	{
		498	Scalar::Util::weaken (my $self = $self);
		499
		500	$self->{_connect} =
		501	AnyEvent::Socket::tcp_connect (
		502	$self->{connect}[0],
		503	$self->{connect}[1],
		504	sub {
		505	my ($fh, $host, $port, $retry) = @_;
		506
		507	if ($fh) {
		508	$self->{fh} = $fh;
		509
		510	delete $self->{_skip_drain_rbuf};
		511	$self->_start;
		512
		513	$self->{on_connect}
		514	and $self->{on_connect}($self, $host, $port, sub {
		515	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		516	$self->{_skip_drain_rbuf} = 1;
		517	&$retry;
		518	});
		519
		520	} else {
		521	if ($self->{on_connect_error}) {
		522	$self->{on_connect_error}($self, "$!");
		523	$self->destroy;
		524	} else {
		525	$self->_error ($!, 1);
		526	}
		527	}
		528	},
		529	sub {
		530	local $self->{fh} = $_[0];
		531
		532	$self->{on_prepare}
		533	? $self->{on_prepare}->($self)
		534	: ()
		535	}
		536	);
		537	}
		538
		539	} else {
		540	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		541	}
		542
		543	$self
		544	}
		545
		546	sub _start {
		547	my ($self) = @_;
		548
		549	# too many clueless people try to use udp and similar sockets
		550	# with AnyEvent::Handle, do them a favour.
		551	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		552	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		553	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
310		554
311	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	555	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
312		556
		557	$self->{_activity} =
		558	$self->{_ractivity} =
313	$self->{_activity} = AnyEvent->now;	559	$self->{_wactivity} = AE::now;
314	$self->_timeout;
315		560
		561	$self->{read_size} ||= 2048;
		562	$self->{max_read_size} = $self->{read_size}
		563	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		564
		565	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		566	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		567	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		568
316	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	569	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		570	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
317		571
		572	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		573
318	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	574	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
319	if $self->{tls};	575	if $self->{tls};
320		576
321	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	577	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
322		578
323	$self->start_read	579	$self->start_read
324	if $self->{on_read};	580	if $self->{on_read} || @{ $self->{_queue} };
325		581
326	$self->{fh} && $self	582	$self->_drain_wbuf;
327	}
328
329	sub _shutdown {
330	my ($self) = @_;
331
332	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
333	$self->{_eof} = 1; # tell starttls et. al to stop trying
334
335	&_freetls;
336	}	583	}
337		584
338	sub _error {	585	sub _error {
339	my ($self, $errno, $fatal) = @_;	586	my ($self, $errno, $fatal, $message) = @_;
340
341	$self->_shutdown
342	if $fatal;
343		587
344	$! = $errno;	588	$! = $errno;
		589	$message ||= "$!";
345		590
346	if ($self->{on_error}) {	591	if ($self->{on_error}) {
347	$self->{on_error}($self, $fatal);	592	$self->{on_error}($self, $fatal, $message);
348	} elsif ($self->{fh}) {	593	$self->destroy if $fatal;
		594	} elsif ($self->{fh} || $self->{connect}) {
		595	$self->destroy;
349	Carp::croak "AnyEvent::Handle uncaught error: $!";	596	Carp::croak "AnyEvent::Handle uncaught error: $message";
350	}	597	}
351	}	598	}
352		599
353	=item $fh = $handle->fh	600	=item $fh = $handle->fh
354		601
…		…
378	$_[0]{on_eof} = $_[1];	625	$_[0]{on_eof} = $_[1];
379	}	626	}
380		627
381	=item $handle->on_timeout ($cb)	628	=item $handle->on_timeout ($cb)
382		629
383	Replace the current C<on_timeout> callback, or disables the callback (but	630	=item $handle->on_rtimeout ($cb)
384	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
385	argument and method.
386		631
387	=cut	632	=item $handle->on_wtimeout ($cb)
388		633
389	sub on_timeout {	634	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
390	$_[0]{on_timeout} = $_[1];	635	callback, or disables the callback (but not the timeout) if C<$cb> =
391	}	636	C<undef>. See the C<timeout> constructor argument and method.
		637
		638	=cut
		639
		640	# see below
392		641
393	=item $handle->autocork ($boolean)	642	=item $handle->autocork ($boolean)
394		643
395	Enables or disables the current autocork behaviour (see C<autocork>	644	Enables or disables the current autocork behaviour (see C<autocork>
396	constructor argument). Changes will only take effect on the next write.	645	constructor argument). Changes will only take effect on the next write.
…		…
409	=cut	658	=cut
410		659
411	sub no_delay {	660	sub no_delay {
412	$_[0]{no_delay} = $_[1];	661	$_[0]{no_delay} = $_[1];
413		662
		663	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		664	if $_[0]{fh};
		665	}
		666
		667	=item $handle->keepalive ($boolean)
		668
		669	Enables or disables the C<keepalive> setting (see constructor argument of
		670	the same name for details).
		671
		672	=cut
		673
		674	sub keepalive {
		675	$_[0]{keepalive} = $_[1];
		676
414	eval {	677	eval {
415	local $SIG{__DIE__};	678	local $SIG{__DIE__};
416	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	679	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		680	if $_[0]{fh};
417	};	681	};
418	}	682	}
419		683
		684	=item $handle->oobinline ($boolean)
		685
		686	Enables or disables the C<oobinline> setting (see constructor argument of
		687	the same name for details).
		688
		689	=cut
		690
		691	sub oobinline {
		692	$_[0]{oobinline} = $_[1];
		693
		694	eval {
		695	local $SIG{__DIE__};
		696	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		697	if $_[0]{fh};
		698	};
		699	}
		700
		701	=item $handle->keepalive ($boolean)
		702
		703	Enables or disables the C<keepalive> setting (see constructor argument of
		704	the same name for details).
		705
		706	=cut
		707
		708	sub keepalive {
		709	$_[0]{keepalive} = $_[1];
		710
		711	eval {
		712	local $SIG{__DIE__};
		713	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		714	if $_[0]{fh};
		715	};
		716	}
		717
		718	=item $handle->on_starttls ($cb)
		719
		720	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		721
		722	=cut
		723
		724	sub on_starttls {
		725	$_[0]{on_starttls} = $_[1];
		726	}
		727
		728	=item $handle->on_stoptls ($cb)
		729
		730	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		731
		732	=cut
		733
		734	sub on_stoptls {
		735	$_[0]{on_stoptls} = $_[1];
		736	}
		737
		738	=item $handle->rbuf_max ($max_octets)
		739
		740	Configures the C<rbuf_max> setting (C<undef> disables it).
		741
		742	=cut
		743
		744	sub rbuf_max {
		745	$_[0]{rbuf_max} = $_[1];
		746	}
		747
420	#############################################################################	748	#############################################################################
421		749
422	=item $handle->timeout ($seconds)	750	=item $handle->timeout ($seconds)
423		751
		752	=item $handle->rtimeout ($seconds)
		753
		754	=item $handle->wtimeout ($seconds)
		755
424	Configures (or disables) the inactivity timeout.	756	Configures (or disables) the inactivity timeout.
425		757
426	=cut	758	=item $handle->timeout_reset
427		759
428	sub timeout {	760	=item $handle->rtimeout_reset
		761
		762	=item $handle->wtimeout_reset
		763
		764	Reset the activity timeout, as if data was received or sent.
		765
		766	These methods are cheap to call.
		767
		768	=cut
		769
		770	for my $dir ("", "r", "w") {
		771	my $timeout = "${dir}timeout";
		772	my $tw = "_${dir}tw";
		773	my $on_timeout = "on_${dir}timeout";
		774	my $activity = "_${dir}activity";
		775	my $cb;
		776
		777	*$on_timeout = sub {
		778	$_[0]{$on_timeout} = $_[1];
		779	};
		780
		781	*$timeout = sub {
429	my ($self, $timeout) = @_;	782	my ($self, $new_value) = @_;
430		783
		784	$new_value >= 0
		785	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		786
431	$self->{timeout} = $timeout;	787	$self->{$timeout} = $new_value;
432	$self->_timeout;	788	delete $self->{$tw}; &$cb;
433	}	789	};
434		790
		791	*{"${dir}timeout_reset"} = sub {
		792	$_[0]{$activity} = AE::now;
		793	};
		794
		795	# main workhorse:
435	# reset the timeout watcher, as neccessary	796	# reset the timeout watcher, as neccessary
436	# also check for time-outs	797	# also check for time-outs
437	sub _timeout {	798	$cb = sub {
438	my ($self) = @_;	799	my ($self) = @_;
439		800
440	if ($self->{timeout}) {	801	if ($self->{$timeout} && $self->{fh}) {
441	my $NOW = AnyEvent->now;	802	my $NOW = AE::now;
442		803
443	# when would the timeout trigger?	804	# when would the timeout trigger?
444	my $after = $self->{_activity} + $self->{timeout} - $NOW;	805	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
445		806
446	# now or in the past already?	807	# now or in the past already?
447	if ($after <= 0) {	808	if ($after <= 0) {
448	$self->{_activity} = $NOW;	809	$self->{$activity} = $NOW;
449		810
450	if ($self->{on_timeout}) {	811	if ($self->{$on_timeout}) {
451	$self->{on_timeout}($self);	812	$self->{$on_timeout}($self);
452	} else {	813	} else {
453	$self->_error (&Errno::ETIMEDOUT);	814	$self->_error (Errno::ETIMEDOUT);
		815	}
		816
		817	# callback could have changed timeout value, optimise
		818	return unless $self->{$timeout};
		819
		820	# calculate new after
		821	$after = $self->{$timeout};
454	}	822	}
455		823
456	# callback could have changed timeout value, optimise	824	Scalar::Util::weaken $self;
457	return unless $self->{timeout};	825	return unless $self; # ->error could have destroyed $self
458		826
459	# calculate new after	827	$self->{$tw} ||= AE::timer $after, 0, sub {
460	$after = $self->{timeout};	828	delete $self->{$tw};
		829	$cb->($self);
		830	};
		831	} else {
		832	delete $self->{$tw};
461	}	833	}
462
463	Scalar::Util::weaken $self;
464	return unless $self; # ->error could have destroyed $self
465
466	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
467	delete $self->{_tw};
468	$self->_timeout;
469	});
470	} else {
471	delete $self->{_tw};
472	}	834	}
473	}	835	}
474		836
475	#############################################################################	837	#############################################################################
476		838
…		…
491		853
492	=item $handle->on_drain ($cb)	854	=item $handle->on_drain ($cb)
493		855
494	Sets the C<on_drain> callback or clears it (see the description of	856	Sets the C<on_drain> callback or clears it (see the description of
495	C<on_drain> in the constructor).	857	C<on_drain> in the constructor).
		858
		859	This method may invoke callbacks (and therefore the handle might be
		860	destroyed after it returns).
496		861
497	=cut	862	=cut
498		863
499	sub on_drain {	864	sub on_drain {
500	my ($self, $cb) = @_;	865	my ($self, $cb) = @_;
…		…
509		874
510	Queues the given scalar to be written. You can push as much data as you	875	Queues the given scalar to be written. You can push as much data as you
511	want (only limited by the available memory), as C<AnyEvent::Handle>	876	want (only limited by the available memory), as C<AnyEvent::Handle>
512	buffers it independently of the kernel.	877	buffers it independently of the kernel.
513		878
		879	This method may invoke callbacks (and therefore the handle might be
		880	destroyed after it returns).
		881
514	=cut	882	=cut
515		883
516	sub _drain_wbuf {	884	sub _drain_wbuf {
517	my ($self) = @_;	885	my ($self) = @_;
518		886
…		…
521	Scalar::Util::weaken $self;	889	Scalar::Util::weaken $self;
522		890
523	my $cb = sub {	891	my $cb = sub {
524	my $len = syswrite $self->{fh}, $self->{wbuf};	892	my $len = syswrite $self->{fh}, $self->{wbuf};
525		893
526	if ($len >= 0) {	894	if (defined $len) {
527	substr $self->{wbuf}, 0, $len, "";	895	substr $self->{wbuf}, 0, $len, "";
528		896
529	$self->{_activity} = AnyEvent->now;	897	$self->{_activity} = $self->{_wactivity} = AE::now;
530		898
531	$self->{on_drain}($self)	899	$self->{on_drain}($self)
532	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	900	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
533	&& $self->{on_drain};	901	&& $self->{on_drain};
534		902
…		…
540		908
541	# try to write data immediately	909	# try to write data immediately
542	$cb->() unless $self->{autocork};	910	$cb->() unless $self->{autocork};
543		911
544	# if still data left in wbuf, we need to poll	912	# if still data left in wbuf, we need to poll
545	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	913	$self->{_ww} = AE::io $self->{fh}, 1, $cb
546	if length $self->{wbuf};	914	if length $self->{wbuf};
547	};	915	};
548	}	916	}
549		917
550	our %WH;	918	our %WH;
551		919
		920	# deprecated
552	sub register_write_type($$) {	921	sub register_write_type($$) {
553	$WH{$_[0]} = $_[1];	922	$WH{$_[0]} = $_[1];
554	}	923	}
555		924
556	sub push_write {	925	sub push_write {
557	my $self = shift;	926	my $self = shift;
558		927
559	if (@_ > 1) {	928	if (@_ > 1) {
560	my $type = shift;	929	my $type = shift;
561		930
		931	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
562	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	932	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
563	->($self, @_);	933	->($self, @_);
564	}	934	}
565		935
		936	# we downgrade here to avoid hard-to-track-down bugs,
		937	# and diagnose the problem earlier and better.
		938
566	if ($self->{tls}) {	939	if ($self->{tls}) {
567	$self->{_tls_wbuf} .= $_[0];	940	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
568		941	&_dotls ($self) if $self->{fh};
569	&_dotls ($self);
570	} else {	942	} else {
571	$self->{wbuf} .= $_[0];	943	utf8::downgrade $self->{wbuf} .= $_[0];
572	$self->_drain_wbuf;	944	$self->_drain_wbuf if $self->{fh};
573	}	945	}
574	}	946	}
575		947
576	=item $handle->push_write (type => @args)	948	=item $handle->push_write (type => @args)
577		949
578	Instead of formatting your data yourself, you can also let this module do	950	Instead of formatting your data yourself, you can also let this module
579	the job by specifying a type and type-specific arguments.	951	do the job by specifying a type and type-specific arguments. You
		952	can also specify the (fully qualified) name of a package, in which
		953	case AnyEvent tries to load the package and then expects to find the
		954	C<anyevent_write_type> function inside (see "custom write types", below).
580		955
581	Predefined types are (if you have ideas for additional types, feel free to	956	Predefined types are (if you have ideas for additional types, feel free to
582	drop by and tell us):	957	drop by and tell us):
583		958
584	=over 4	959	=over 4
…		…
641	Other languages could read single lines terminated by a newline and pass	1016	Other languages could read single lines terminated by a newline and pass
642	this line into their JSON decoder of choice.	1017	this line into their JSON decoder of choice.
643		1018
644	=cut	1019	=cut
645		1020
		1021	sub json_coder() {
		1022	eval { require JSON::XS; JSON::XS->new->utf8 }
		1023	|| do { require JSON; JSON->new->utf8 }
		1024	}
		1025
646	register_write_type json => sub {	1026	register_write_type json => sub {
647	my ($self, $ref) = @_;	1027	my ($self, $ref) = @_;
648		1028
649	require JSON;	1029	my $json = $self->{json} ||= json_coder;
650		1030
651	$self->{json} ? $self->{json}->encode ($ref)	1031	$json->encode ($ref)
652	: JSON::encode_json ($ref)
653	};	1032	};
654		1033
655	=item storable => $reference	1034	=item storable => $reference
656		1035
657	Freezes the given reference using L<Storable> and writes it to the	1036	Freezes the given reference using L<Storable> and writes it to the
…		…
667	pack "w/a*", Storable::nfreeze ($ref)	1046	pack "w/a*", Storable::nfreeze ($ref)
668	};	1047	};
669		1048
670	=back	1049	=back
671		1050
672	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1051	=item $handle->push_shutdown
673		1052
674	This function (not method) lets you add your own types to C<push_write>.	1053	Sometimes you know you want to close the socket after writing your data
		1054	before it was actually written. One way to do that is to replace your
		1055	C<on_drain> handler by a callback that shuts down the socket (and set
		1056	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1057	replaces the C<on_drain> callback with:
		1058
		1059	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		1060
		1061	This simply shuts down the write side and signals an EOF condition to the
		1062	the peer.
		1063
		1064	You can rely on the normal read queue and C<on_eof> handling
		1065	afterwards. This is the cleanest way to close a connection.
		1066
		1067	This method may invoke callbacks (and therefore the handle might be
		1068	destroyed after it returns).
		1069
		1070	=cut
		1071
		1072	sub push_shutdown {
		1073	my ($self) = @_;
		1074
		1075	delete $self->{low_water_mark};
		1076	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1077	}
		1078
		1079	=item custom write types - Package::anyevent_write_type $handle, @args
		1080
		1081	Instead of one of the predefined types, you can also specify the name of
		1082	a package. AnyEvent will try to load the package and then expects to find
		1083	a function named C<anyevent_write_type> inside. If it isn't found, it
		1084	progressively tries to load the parent package until it either finds the
		1085	function (good) or runs out of packages (bad).
		1086
675	Whenever the given C<type> is used, C<push_write> will invoke the code	1087	Whenever the given C<type> is used, C<push_write> will the function with
676	reference with the handle object and the remaining arguments.	1088	the handle object and the remaining arguments.
677		1089
678	The code reference is supposed to return a single octet string that will	1090	The function is supposed to return a single octet string that will be
679	be appended to the write buffer.	1091	appended to the write buffer, so you cna mentally treat this function as a
		1092	"arguments to on-the-wire-format" converter.
680		1093
681	Note that this is a function, and all types registered this way will be	1094	Example: implement a custom write type C<join> that joins the remaining
682	global, so try to use unique names.	1095	arguments using the first one.
		1096
		1097	$handle->push_write (My::Type => " ", 1,2,3);
		1098
		1099	# uses the following package, which can be defined in the "My::Type" or in
		1100	# the "My" modules to be auto-loaded, or just about anywhere when the
		1101	# My::Type::anyevent_write_type is defined before invoking it.
		1102
		1103	package My::Type;
		1104
		1105	sub anyevent_write_type {
		1106	my ($handle, $delim, @args) = @_;
		1107
		1108	join $delim, @args
		1109	}
683		1110
684	=cut	1111	=cut
685		1112
686	#############################################################################	1113	#############################################################################
687		1114
…		…
696	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1123	ways, the "simple" way, using only C<on_read> and the "complex" way, using
697	a queue.	1124	a queue.
698		1125
699	In the simple case, you just install an C<on_read> callback and whenever	1126	In the simple case, you just install an C<on_read> callback and whenever
700	new data arrives, it will be called. You can then remove some data (if	1127	new data arrives, it will be called. You can then remove some data (if
701	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1128	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
702	leave the data there if you want to accumulate more (e.g. when only a	1129	leave the data there if you want to accumulate more (e.g. when only a
703	partial message has been received so far).	1130	partial message has been received so far), or change the read queue with
		1131	e.g. C<push_read>.
704		1132
705	In the more complex case, you want to queue multiple callbacks. In this	1133	In the more complex case, you want to queue multiple callbacks. In this
706	case, AnyEvent::Handle will call the first queued callback each time new	1134	case, AnyEvent::Handle will call the first queued callback each time new
707	data arrives (also the first time it is queued) and removes it when it has	1135	data arrives (also the first time it is queued) and remove it when it has
708	done its job (see C<push_read>, below).	1136	done its job (see C<push_read>, below).
709		1137
710	This way you can, for example, push three line-reads, followed by reading	1138	This way you can, for example, push three line-reads, followed by reading
711	a chunk of data, and AnyEvent::Handle will execute them in order.	1139	a chunk of data, and AnyEvent::Handle will execute them in order.
712		1140
…		…
769	=cut	1197	=cut
770		1198
771	sub _drain_rbuf {	1199	sub _drain_rbuf {
772	my ($self) = @_;	1200	my ($self) = @_;
773		1201
		1202	# avoid recursion
		1203	return if $self->{_skip_drain_rbuf};
774	local $self->{_in_drain} = 1;	1204	local $self->{_skip_drain_rbuf} = 1;
775
776	if (
777	defined $self->{rbuf_max}
778	&& $self->{rbuf_max} < length $self->{rbuf}
779	) {
780	$self->_error (&Errno::ENOSPC, 1), return;
781	}
782		1205
783	while () {	1206	while () {
784	# we need to use a separate tls read buffer, as we must not receive data while	1207	# we need to use a separate tls read buffer, as we must not receive data while
785	# we are draining the buffer, and this can only happen with TLS.	1208	# we are draining the buffer, and this can only happen with TLS.
786	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1209	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1210	if exists $self->{_tls_rbuf};
787		1211
788	my $len = length $self->{rbuf};	1212	my $len = length $self->{rbuf};
789		1213
790	if (my $cb = shift @{ $self->{_queue} }) {	1214	if (my $cb = shift @{ $self->{_queue} }) {
791	unless ($cb->($self)) {	1215	unless ($cb->($self)) {
792	if ($self->{_eof}) {	1216	# no progress can be made
793	# no progress can be made (not enough data and no data forthcoming)	1217	# (not enough data and no data forthcoming)
794	$self->_error (&Errno::EPIPE, 1), return;	1218	$self->_error (Errno::EPIPE, 1), return
795	}	1219	if $self->{_eof};
796		1220
797	unshift @{ $self->{_queue} }, $cb;	1221	unshift @{ $self->{_queue} }, $cb;
798	last;	1222	last;
799	}	1223	}
800	} elsif ($self->{on_read}) {	1224	} elsif ($self->{on_read}) {
…		…
807	&& !@{ $self->{_queue} } # and the queue is still empty	1231	&& !@{ $self->{_queue} } # and the queue is still empty
808	&& $self->{on_read} # but we still have on_read	1232	&& $self->{on_read} # but we still have on_read
809	) {	1233	) {
810	# no further data will arrive	1234	# no further data will arrive
811	# so no progress can be made	1235	# so no progress can be made
812	$self->_error (&Errno::EPIPE, 1), return	1236	$self->_error (Errno::EPIPE, 1), return
813	if $self->{_eof};	1237	if $self->{_eof};
814		1238
815	last; # more data might arrive	1239	last; # more data might arrive
816	}	1240	}
817	} else {	1241	} else {
…		…
820	last;	1244	last;
821	}	1245	}
822	}	1246	}
823		1247
824	if ($self->{_eof}) {	1248	if ($self->{_eof}) {
825	if ($self->{on_eof}) {	1249	$self->{on_eof}
826	$self->{on_eof}($self)	1250	? $self->{on_eof}($self)
827	} else {	1251	: $self->_error (0, 1, "Unexpected end-of-file");
828	$self->_error (0, 1);	1252
829	}	1253	return;
		1254	}
		1255
		1256	if (
		1257	defined $self->{rbuf_max}
		1258	&& $self->{rbuf_max} < length $self->{rbuf}
		1259	) {
		1260	$self->_error (Errno::ENOSPC, 1), return;
830	}	1261	}
831		1262
832	# may need to restart read watcher	1263	# may need to restart read watcher
833	unless ($self->{_rw}) {	1264	unless ($self->{_rw}) {
834	$self->start_read	1265	$self->start_read
…		…
840		1271
841	This replaces the currently set C<on_read> callback, or clears it (when	1272	This replaces the currently set C<on_read> callback, or clears it (when
842	the new callback is C<undef>). See the description of C<on_read> in the	1273	the new callback is C<undef>). See the description of C<on_read> in the
843	constructor.	1274	constructor.
844		1275
		1276	This method may invoke callbacks (and therefore the handle might be
		1277	destroyed after it returns).
		1278
845	=cut	1279	=cut
846		1280
847	sub on_read {	1281	sub on_read {
848	my ($self, $cb) = @_;	1282	my ($self, $cb) = @_;
849		1283
850	$self->{on_read} = $cb;	1284	$self->{on_read} = $cb;
851	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1285	$self->_drain_rbuf if $cb;
852	}	1286	}
853		1287
854	=item $handle->rbuf	1288	=item $handle->rbuf
855		1289
856	Returns the read buffer (as a modifiable lvalue).	1290	Returns the read buffer (as a modifiable lvalue). You can also access the
		1291	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1292	much faster, and no less clean).
857		1293
858	You can access the read buffer directly as the C<< ->{rbuf} >>	1294	The only operation allowed on the read buffer (apart from looking at it)
859	member, if you want. However, the only operation allowed on the	1295	is removing data from its beginning. Otherwise modifying or appending to
860	read buffer (apart from looking at it) is removing data from its	1296	it is not allowed and will lead to hard-to-track-down bugs.
861	beginning. Otherwise modifying or appending to it is not allowed and will
862	lead to hard-to-track-down bugs.
863		1297
864	NOTE: The read buffer should only be used or modified if the C<on_read>,	1298	NOTE: The read buffer should only be used or modified in the C<on_read>
865	C<push_read> or C<unshift_read> methods are used. The other read methods	1299	callback or when C<push_read> or C<unshift_read> are used with a single
866	automatically manage the read buffer.	1300	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1301	will manage the read buffer on their own.
867		1302
868	=cut	1303	=cut
869		1304
870	sub rbuf : lvalue {	1305	sub rbuf : lvalue {
871	$_[0]{rbuf}	1306	$_[0]{rbuf}
…		…
888		1323
889	If enough data was available, then the callback must remove all data it is	1324	If enough data was available, then the callback must remove all data it is
890	interested in (which can be none at all) and return a true value. After returning	1325	interested in (which can be none at all) and return a true value. After returning
891	true, it will be removed from the queue.	1326	true, it will be removed from the queue.
892		1327
		1328	These methods may invoke callbacks (and therefore the handle might be
		1329	destroyed after it returns).
		1330
893	=cut	1331	=cut
894		1332
895	our %RH;	1333	our %RH;
896		1334
897	sub register_read_type($$) {	1335	sub register_read_type($$) {
…		…
903	my $cb = pop;	1341	my $cb = pop;
904		1342
905	if (@_) {	1343	if (@_) {
906	my $type = shift;	1344	my $type = shift;
907		1345
		1346	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
908	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1347	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
909	->($self, $cb, @_);	1348	->($self, $cb, @_);
910	}	1349	}
911		1350
912	push @{ $self->{_queue} }, $cb;	1351	push @{ $self->{_queue} }, $cb;
913	$self->_drain_rbuf unless $self->{_in_drain};	1352	$self->_drain_rbuf;
914	}	1353	}
915		1354
916	sub unshift_read {	1355	sub unshift_read {
917	my $self = shift;	1356	my $self = shift;
918	my $cb = pop;	1357	my $cb = pop;
919		1358
920	if (@_) {	1359	if (@_) {
921	my $type = shift;	1360	my $type = shift;
922		1361
		1362	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
923	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1363	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
924	->($self, $cb, @_);	1364	->($self, $cb, @_);
925	}	1365	}
926		1366
927
928	unshift @{ $self->{_queue} }, $cb;	1367	unshift @{ $self->{_queue} }, $cb;
929	$self->_drain_rbuf unless $self->{_in_drain};	1368	$self->_drain_rbuf;
930	}	1369	}
931		1370
932	=item $handle->push_read (type => @args, $cb)	1371	=item $handle->push_read (type => @args, $cb)
933		1372
934	=item $handle->unshift_read (type => @args, $cb)	1373	=item $handle->unshift_read (type => @args, $cb)
935		1374
936	Instead of providing a callback that parses the data itself you can chose	1375	Instead of providing a callback that parses the data itself you can chose
937	between a number of predefined parsing formats, for chunks of data, lines	1376	between a number of predefined parsing formats, for chunks of data, lines
938	etc.	1377	etc. You can also specify the (fully qualified) name of a package, in
		1378	which case AnyEvent tries to load the package and then expects to find the
		1379	C<anyevent_read_type> function inside (see "custom read types", below).
939		1380
940	Predefined types are (if you have ideas for additional types, feel free to	1381	Predefined types are (if you have ideas for additional types, feel free to
941	drop by and tell us):	1382	drop by and tell us):
942		1383
943	=over 4	1384	=over 4
…		…
1035	the receive buffer when neither C<$accept> nor C<$reject> match,	1476	the receive buffer when neither C<$accept> nor C<$reject> match,
1036	and everything preceding and including the match will be accepted	1477	and everything preceding and including the match will be accepted
1037	unconditionally. This is useful to skip large amounts of data that you	1478	unconditionally. This is useful to skip large amounts of data that you
1038	know cannot be matched, so that the C<$accept> or C<$reject> regex do not	1479	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1039	have to start matching from the beginning. This is purely an optimisation	1480	have to start matching from the beginning. This is purely an optimisation
1040	and is usually worth only when you expect more than a few kilobytes.	1481	and is usually worth it only when you expect more than a few kilobytes.
1041		1482
1042	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1483	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1043	expect the header to be very large (it isn't in practise, but...), we use	1484	expect the header to be very large (it isn't in practice, but...), we use
1044	a skip regex to skip initial portions. The skip regex is tricky in that	1485	a skip regex to skip initial portions. The skip regex is tricky in that
1045	it only accepts something not ending in either \015 or \012, as these are	1486	it only accepts something not ending in either \015 or \012, as these are
1046	required for the accept regex.	1487	required for the accept regex.
1047		1488
1048	$handle->push_read (regex =>	1489	$handle->push_read (regex =>
…		…
1067	return 1;	1508	return 1;
1068	}	1509	}
1069		1510
1070	# reject	1511	# reject
1071	if ($reject && $$rbuf =~ $reject) {	1512	if ($reject && $$rbuf =~ $reject) {
1072	$self->_error (&Errno::EBADMSG);	1513	$self->_error (Errno::EBADMSG);
1073	}	1514	}
1074		1515
1075	# skip	1516	# skip
1076	if ($skip && $$rbuf =~ $skip) {	1517	if ($skip && $$rbuf =~ $skip) {
1077	$data .= substr $$rbuf, 0, $+[0], "";	1518	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1093	my ($self, $cb) = @_;	1534	my ($self, $cb) = @_;
1094		1535
1095	sub {	1536	sub {
1096	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1537	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1097	if ($_[0]{rbuf} =~ /[^0-9]/) {	1538	if ($_[0]{rbuf} =~ /[^0-9]/) {
1098	$self->_error (&Errno::EBADMSG);	1539	$self->_error (Errno::EBADMSG);
1099	}	1540	}
1100	return;	1541	return;
1101	}	1542	}
1102		1543
1103	my $len = $1;	1544	my $len = $1;
…		…
1106	my $string = $_[1];	1547	my $string = $_[1];
1107	$_[0]->unshift_read (chunk => 1, sub {	1548	$_[0]->unshift_read (chunk => 1, sub {
1108	if ($_[1] eq ",") {	1549	if ($_[1] eq ",") {
1109	$cb->($_[0], $string);	1550	$cb->($_[0], $string);
1110	} else {	1551	} else {
1111	$self->_error (&Errno::EBADMSG);	1552	$self->_error (Errno::EBADMSG);
1112	}	1553	}
1113	});	1554	});
1114	});	1555	});
1115		1556
1116	1	1557	1
…		…
1183	=cut	1624	=cut
1184		1625
1185	register_read_type json => sub {	1626	register_read_type json => sub {
1186	my ($self, $cb) = @_;	1627	my ($self, $cb) = @_;
1187		1628
1188	require JSON;	1629	my $json = $self->{json} ||= json_coder;
1189		1630
1190	my $data;	1631	my $data;
1191	my $rbuf = \$self->{rbuf};	1632	my $rbuf = \$self->{rbuf};
1192
1193	my $json = $self->{json} ||= JSON->new->utf8;
1194		1633
1195	sub {	1634	sub {
1196	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1635	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1197		1636
1198	if ($ref) {	1637	if ($ref) {
…		…
1206	$json->incr_skip;	1645	$json->incr_skip;
1207		1646
1208	$self->{rbuf} = $json->incr_text;	1647	$self->{rbuf} = $json->incr_text;
1209	$json->incr_text = "";	1648	$json->incr_text = "";
1210		1649
1211	$self->_error (&Errno::EBADMSG);	1650	$self->_error (Errno::EBADMSG);
1212		1651
1213	()	1652	()
1214	} else {	1653	} else {
1215	$self->{rbuf} = "";	1654	$self->{rbuf} = "";
1216		1655
…		…
1253	# read remaining chunk	1692	# read remaining chunk
1254	$_[0]->unshift_read (chunk => $len, sub {	1693	$_[0]->unshift_read (chunk => $len, sub {
1255	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1694	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1256	$cb->($_[0], $ref);	1695	$cb->($_[0], $ref);
1257	} else {	1696	} else {
1258	$self->_error (&Errno::EBADMSG);	1697	$self->_error (Errno::EBADMSG);
1259	}	1698	}
1260	});	1699	});
1261	}	1700	}
1262		1701
1263	1	1702	1
1264	}	1703	}
1265	};	1704	};
1266		1705
1267	=back	1706	=back
1268		1707
1269	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1708	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1270		1709
1271	This function (not method) lets you add your own types to C<push_read>.	1710	Instead of one of the predefined types, you can also specify the name
		1711	of a package. AnyEvent will try to load the package and then expects to
		1712	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1713	progressively tries to load the parent package until it either finds the
		1714	function (good) or runs out of packages (bad).
1272		1715
1273	Whenever the given C<type> is used, C<push_read> will invoke the code	1716	Whenever this type is used, C<push_read> will invoke the function with the
1274	reference with the handle object, the callback and the remaining	1717	handle object, the original callback and the remaining arguments.
1275	arguments.
1276		1718
1277	The code reference is supposed to return a callback (usually a closure)	1719	The function is supposed to return a callback (usually a closure) that
1278	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1720	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1721	mentally treat the function as a "configurable read type to read callback"
		1722	converter.
1279		1723
1280	It should invoke the passed callback when it is done reading (remember to	1724	It should invoke the original callback when it is done reading (remember
1281	pass C<$handle> as first argument as all other callbacks do that).	1725	to pass C<$handle> as first argument as all other callbacks do that,
		1726	although there is no strict requirement on this).
1282		1727
1283	Note that this is a function, and all types registered this way will be
1284	global, so try to use unique names.
1285
1286	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1728	For examples, see the source of this module (F<perldoc -m
1287	search for C<register_read_type>)).	1729	AnyEvent::Handle>, search for C<register_read_type>)).
1288		1730
1289	=item $handle->stop_read	1731	=item $handle->stop_read
1290		1732
1291	=item $handle->start_read	1733	=item $handle->start_read
1292		1734
…		…
1312	}	1754	}
1313		1755
1314	sub start_read {	1756	sub start_read {
1315	my ($self) = @_;	1757	my ($self) = @_;
1316		1758
1317	unless ($self->{_rw} || $self->{_eof}) {	1759	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1318	Scalar::Util::weaken $self;	1760	Scalar::Util::weaken $self;
1319		1761
1320	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1762	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1321	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1763	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1322	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1764	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1323		1765
1324	if ($len > 0) {	1766	if ($len > 0) {
1325	$self->{_activity} = AnyEvent->now;	1767	$self->{_activity} = $self->{_ractivity} = AE::now;
1326		1768
1327	if ($self->{tls}) {	1769	if ($self->{tls}) {
1328	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1770	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1329		1771
1330	&_dotls ($self);	1772	&_dotls ($self);
1331	} else {	1773	} else {
1332	$self->_drain_rbuf unless $self->{_in_drain};	1774	$self->_drain_rbuf;
		1775	}
		1776
		1777	if ($len == $self->{read_size}) {
		1778	$self->{read_size} *= 2;
		1779	$self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
		1780	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1333	}	1781	}
1334		1782
1335	} elsif (defined $len) {	1783	} elsif (defined $len) {
1336	delete $self->{_rw};	1784	delete $self->{_rw};
1337	$self->{_eof} = 1;	1785	$self->{_eof} = 1;
1338	$self->_drain_rbuf unless $self->{_in_drain};	1786	$self->_drain_rbuf;
1339		1787
1340	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1788	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1341	return $self->_error ($!, 1);	1789	return $self->_error ($!, 1);
1342	}	1790	}
1343	});	1791	};
		1792	}
		1793	}
		1794
		1795	our $ERROR_SYSCALL;
		1796	our $ERROR_WANT_READ;
		1797
		1798	sub _tls_error {
		1799	my ($self, $err) = @_;
		1800
		1801	return $self->_error ($!, 1)
		1802	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1803
		1804	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1805
		1806	# reduce error string to look less scary
		1807	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1808
		1809	if ($self->{_on_starttls}) {
		1810	(delete $self->{_on_starttls})->($self, undef, $err);
		1811	&_freetls;
		1812	} else {
		1813	&_freetls;
		1814	$self->_error (Errno::EPROTO, 1, $err);
1344	}	1815	}
1345	}	1816	}
1346		1817
1347	# poll the write BIO and send the data if applicable	1818	# poll the write BIO and send the data if applicable
		1819	# also decode read data if possible
		1820	# this is basiclaly our TLS state machine
		1821	# more efficient implementations are possible with openssl,
		1822	# but not with the buggy and incomplete Net::SSLeay.
1348	sub _dotls {	1823	sub _dotls {
1349	my ($self) = @_;	1824	my ($self) = @_;
1350		1825
1351	my $tmp;	1826	my $tmp;
1352		1827
1353	if (length $self->{_tls_wbuf}) {	1828	if (length $self->{_tls_wbuf}) {
1354	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1829	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1355	substr $self->{_tls_wbuf}, 0, $tmp, "";	1830	substr $self->{_tls_wbuf}, 0, $tmp, "";
1356	}	1831	}
		1832
		1833	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1834	return $self->_tls_error ($tmp)
		1835	if $tmp != $ERROR_WANT_READ
		1836	&& ($tmp != $ERROR_SYSCALL || $!);
1357	}	1837	}
1358		1838
1359	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1839	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1360	unless (length $tmp) {	1840	unless (length $tmp) {
1361	# let's treat SSL-eof as we treat normal EOF	1841	$self->{_on_starttls}
1362	delete $self->{_rw};	1842	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1363	$self->{_eof} = 1;
1364	&_freetls;	1843	&_freetls;
		1844
		1845	if ($self->{on_stoptls}) {
		1846	$self->{on_stoptls}($self);
		1847	return;
		1848	} else {
		1849	# let's treat SSL-eof as we treat normal EOF
		1850	delete $self->{_rw};
		1851	$self->{_eof} = 1;
		1852	}
1365	}	1853	}
1366		1854
1367	$self->{_tls_rbuf} .= $tmp;	1855	$self->{_tls_rbuf} .= $tmp;
1368	$self->_drain_rbuf unless $self->{_in_drain};	1856	$self->_drain_rbuf;
1369	$self->{tls} or return; # tls session might have gone away in callback	1857	$self->{tls} or return; # tls session might have gone away in callback
1370	}	1858	}
1371		1859
1372	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1860	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1373
1374	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1375	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1376	return $self->_error ($!, 1);	1861	return $self->_tls_error ($tmp)
1377	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1862	if $tmp != $ERROR_WANT_READ
1378	return $self->_error (&Errno::EIO, 1);	1863	&& ($tmp != $ERROR_SYSCALL || $!);
1379	}
1380
1381	# all other errors are fine for our purposes
1382	}
1383		1864
1384	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1865	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1385	$self->{wbuf} .= $tmp;	1866	$self->{wbuf} .= $tmp;
1386	$self->_drain_wbuf;	1867	$self->_drain_wbuf;
		1868	$self->{tls} or return; # tls session might have gone away in callback
1387	}	1869	}
		1870
		1871	$self->{_on_starttls}
		1872	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1873	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1388	}	1874	}
1389		1875
1390	=item $handle->starttls ($tls[, $tls_ctx])	1876	=item $handle->starttls ($tls[, $tls_ctx])
1391		1877
1392	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1878	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1393	object is created, you can also do that at a later time by calling	1879	object is created, you can also do that at a later time by calling
1394	C<starttls>.	1880	C<starttls>.
		1881
		1882	Starting TLS is currently an asynchronous operation - when you push some
		1883	write data and then call C<< ->starttls >> then TLS negotiation will start
		1884	immediately, after which the queued write data is then sent.
1395		1885
1396	The first argument is the same as the C<tls> constructor argument (either	1886	The first argument is the same as the C<tls> constructor argument (either
1397	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1887	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1398		1888
1399	The second argument is the optional C<AnyEvent::TLS> object that is used	1889	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1404	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1894	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1405	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1895	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1406	changed to your liking. Note that the handshake might have already started	1896	changed to your liking. Note that the handshake might have already started
1407	when this function returns.	1897	when this function returns.
1408		1898
1409	If it an error to start a TLS handshake more than once per	1899	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1410	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1900	handshakes on the same stream. It is best to not attempt to use the
		1901	stream after stopping TLS.
1411		1902
		1903	This method may invoke callbacks (and therefore the handle might be
		1904	destroyed after it returns).
		1905
1412	=cut	1906	=cut
		1907
		1908	our %TLS_CACHE; #TODO not yet documented, should we?
1413		1909
1414	sub starttls {	1910	sub starttls {
1415	my ($self, $ssl, $ctx) = @_;	1911	my ($self, $tls, $ctx) = @_;
		1912
		1913	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1914	if $self->{tls};
		1915
		1916	$self->{tls} = $tls;
		1917	$self->{tls_ctx} = $ctx if @_ > 2;
		1918
		1919	return unless $self->{fh};
1416		1920
1417	require Net::SSLeay;	1921	require Net::SSLeay;
1418		1922
1419	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1923	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1420	if $self->{tls};	1924	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1421		1925
		1926	$tls = delete $self->{tls};
1422	$ctx ||= $self->{tls_ctx};	1927	$ctx = $self->{tls_ctx};
		1928
		1929	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1423		1930
1424	if ("HASH" eq ref $ctx) {	1931	if ("HASH" eq ref $ctx) {
1425	require AnyEvent::TLS;	1932	require AnyEvent::TLS;
1426		1933
1427	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context	1934	if ($ctx->{cache}) {
		1935	my $key = $ctx+0;
		1936	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1937	} else {
1428	$ctx = new AnyEvent::TLS %$ctx;	1938	$ctx = new AnyEvent::TLS %$ctx;
		1939	}
1429	}	1940	}
1430		1941
1431	$self->{tls_ctx} = $ctx || TLS_CTX ();	1942	$self->{tls_ctx} = $ctx || TLS_CTX ();
1432	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self);	1943	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1433		1944
1434	# basically, this is deep magic (because SSL_read should have the same issues)	1945	# basically, this is deep magic (because SSL_read should have the same issues)
1435	# but the openssl maintainers basically said: "trust us, it just works".	1946	# but the openssl maintainers basically said: "trust us, it just works".
1436	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1947	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1437	# and mismaintained ssleay-module doesn't even offer them).	1948	# and mismaintained ssleay-module doesn't even offer them).
…		…
1444	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1955	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1445	# have identity issues in that area.	1956	# have identity issues in that area.
1446	# Net::SSLeay::CTX_set_mode ($ssl,	1957	# Net::SSLeay::CTX_set_mode ($ssl,
1447	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1958	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1448	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1959	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1449	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	1960	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1450		1961
1451	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1962	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1452	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1963	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1453		1964
		1965	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1966
1454	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1967	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1968
		1969	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1970	if $self->{on_starttls};
1455		1971
1456	&_dotls; # need to trigger the initial handshake	1972	&_dotls; # need to trigger the initial handshake
1457	$self->start_read; # make sure we actually do read	1973	$self->start_read; # make sure we actually do read
1458	}	1974	}
1459		1975
1460	=item $handle->stoptls	1976	=item $handle->stoptls
1461		1977
1462	Shuts down the SSL connection - this makes a proper EOF handshake by	1978	Shuts down the SSL connection - this makes a proper EOF handshake by
1463	sending a close notify to the other side, but since OpenSSL doesn't	1979	sending a close notify to the other side, but since OpenSSL doesn't
1464	support non-blocking shut downs, it is not possible to re-use the stream	1980	support non-blocking shut downs, it is not guaranteed that you can re-use
1465	afterwards.	1981	the stream afterwards.
		1982
		1983	This method may invoke callbacks (and therefore the handle might be
		1984	destroyed after it returns).
1466		1985
1467	=cut	1986	=cut
1468		1987
1469	sub stoptls {	1988	sub stoptls {
1470	my ($self) = @_;	1989	my ($self) = @_;
1471		1990
1472	if ($self->{tls}) {	1991	if ($self->{tls} && $self->{fh}) {
1473	Net::SSLeay::shutdown ($self->{tls});	1992	Net::SSLeay::shutdown ($self->{tls});
1474		1993
1475	&_dotls;	1994	&_dotls;
1476		1995
1477	# we don't give a shit. no, we do, but we can't. no...	1996	# # we don't give a shit. no, we do, but we can't. no...#d#
1478	# we, we... have to use openssl :/	1997	# # we, we... have to use openssl :/#d#
1479	&_freetls;	1998	# &_freetls;#d#
1480	}	1999	}
1481	}	2000	}
1482		2001
1483	sub _freetls {	2002	sub _freetls {
1484	my ($self) = @_;	2003	my ($self) = @_;
1485		2004
1486	return unless $self->{tls};	2005	return unless $self->{tls};
1487		2006
1488	$self->{tls_ctx}->_put_session (delete $self->{tls});	2007	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2008	if $self->{tls} > 0;
1489		2009
1490	delete @$self{qw(_rbio _wbio _tls_wbuf)};	2010	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1491	}	2011	}
1492		2012
1493	sub DESTROY {	2013	sub DESTROY {
1494	my ($self) = @_;	2014	my ($self) = @_;
1495		2015
1496	&_freetls;	2016	&_freetls;
1497		2017
1498	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	2018	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1499		2019
1500	if ($linger && length $self->{wbuf}) {	2020	if ($linger && length $self->{wbuf} && $self->{fh}) {
1501	my $fh = delete $self->{fh};	2021	my $fh = delete $self->{fh};
1502	my $wbuf = delete $self->{wbuf};	2022	my $wbuf = delete $self->{wbuf};
1503		2023
1504	my @linger;	2024	my @linger;
1505		2025
1506	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2026	push @linger, AE::io $fh, 1, sub {
1507	my $len = syswrite $fh, $wbuf, length $wbuf;	2027	my $len = syswrite $fh, $wbuf, length $wbuf;
1508		2028
1509	if ($len > 0) {	2029	if ($len > 0) {
1510	substr $wbuf, 0, $len, "";	2030	substr $wbuf, 0, $len, "";
1511	} else {	2031	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1512	@linger = (); # end	2032	@linger = (); # end
1513	}	2033	}
1514	});	2034	};
1515	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2035	push @linger, AE::timer $linger, 0, sub {
1516	@linger = ();	2036	@linger = ();
1517	});	2037	};
1518	}	2038	}
1519	}	2039	}
1520		2040
1521	=item $handle->destroy	2041	=item $handle->destroy
1522		2042
1523	Shuts down the handle object as much as possible - this call ensures that	2043	Shuts down the handle object as much as possible - this call ensures that
1524	no further callbacks will be invoked and resources will be freed as much	2044	no further callbacks will be invoked and as many resources as possible
1525	as possible. You must not call any methods on the object afterwards.	2045	will be freed. Any method you will call on the handle object after
		2046	destroying it in this way will be silently ignored (and it will return the
		2047	empty list).
1526		2048
1527	Normally, you can just "forget" any references to an AnyEvent::Handle	2049	Normally, you can just "forget" any references to an AnyEvent::Handle
1528	object and it will simply shut down. This works in fatal error and EOF	2050	object and it will simply shut down. This works in fatal error and EOF
1529	callbacks, as well as code outside. It does I<NOT> work in a read or write	2051	callbacks, as well as code outside. It does I<NOT> work in a read or write
1530	callback, so when you want to destroy the AnyEvent::Handle object from	2052	callback, so when you want to destroy the AnyEvent::Handle object from
1531	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	2053	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1532	that case.	2054	that case.
1533		2055
		2056	Destroying the handle object in this way has the advantage that callbacks
		2057	will be removed as well, so if those are the only reference holders (as
		2058	is common), then one doesn't need to do anything special to break any
		2059	reference cycles.
		2060
1534	The handle might still linger in the background and write out remaining	2061	The handle might still linger in the background and write out remaining
1535	data, as specified by the C<linger> option, however.	2062	data, as specified by the C<linger> option, however.
1536		2063
1537	=cut	2064	=cut
1538		2065
1539	sub destroy {	2066	sub destroy {
1540	my ($self) = @_;	2067	my ($self) = @_;
1541		2068
1542	$self->DESTROY;	2069	$self->DESTROY;
1543	%$self = ();	2070	%$self = ();
		2071	bless $self, "AnyEvent::Handle::destroyed";
1544	}	2072	}
		2073
		2074	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2075	#nop
		2076	}
		2077
		2078	=item $handle->destroyed
		2079
		2080	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2081	->destroy >>, true otherwise.
		2082
		2083	Can be useful to decide whether the handle is still valid after some
		2084	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2085	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2086	can destroy the handle, so work can be avoided by checking sometimes:
		2087
		2088	$hdl->starttls ("accept");
		2089	return if $hdl->destroyed;
		2090	$hdl->push_write (...
		2091
		2092	Note that the call to C<push_write> will silently be ignored if the handle
		2093	has been destroyed, so often you can just ignore the possibility of the
		2094	handle being destroyed.
		2095
		2096	=cut
		2097
		2098	sub destroyed { 0 }
		2099	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1545		2100
1546	=item AnyEvent::Handle::TLS_CTX	2101	=item AnyEvent::Handle::TLS_CTX
1547		2102
1548	This function creates and returns the AnyEvent::TLS object used by default	2103	This function creates and returns the AnyEvent::TLS object used by default
1549	for TLS mode.	2104	for TLS mode.
…		…
1581		2136
1582	=item I get different callback invocations in TLS mode/Why can't I pause	2137	=item I get different callback invocations in TLS mode/Why can't I pause
1583	reading?	2138	reading?
1584		2139
1585	Unlike, say, TCP, TLS connections do not consist of two independent	2140	Unlike, say, TCP, TLS connections do not consist of two independent
1586	communication channels, one for each direction. Or put differently. The	2141	communication channels, one for each direction. Or put differently, the
1587	read and write directions are not independent of each other: you cannot	2142	read and write directions are not independent of each other: you cannot
1588	write data unless you are also prepared to read, and vice versa.	2143	write data unless you are also prepared to read, and vice versa.
1589		2144
1590	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2145	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1591	callback invocations when you are not expecting any read data - the reason	2146	callback invocations when you are not expecting any read data - the reason
1592	is that AnyEvent::Handle always reads in TLS mode.	2147	is that AnyEvent::Handle always reads in TLS mode.
1593		2148
1594	During the connection, you have to make sure that you always have a	2149	During the connection, you have to make sure that you always have a
1595	non-empty read-queue, or an C<on_read> watcher. At the end of the	2150	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1605		2160
1606	$handle->on_read (sub { });	2161	$handle->on_read (sub { });
1607	$handle->on_eof (undef);	2162	$handle->on_eof (undef);
1608	$handle->on_error (sub {	2163	$handle->on_error (sub {
1609	my $data = delete $_[0]{rbuf};	2164	my $data = delete $_[0]{rbuf};
1610	undef $handle;
1611	});	2165	});
1612		2166
1613	The reason to use C<on_error> is that TCP connections, due to latencies	2167	The reason to use C<on_error> is that TCP connections, due to latencies
1614	and packets loss, might get closed quite violently with an error, when in	2168	and packets loss, might get closed quite violently with an error, when in
1615	fact, all data has been received.	2169	fact all data has been received.
1616		2170
1617	It is usually better to use acknowledgements when transferring data,	2171	It is usually better to use acknowledgements when transferring data,
1618	to make sure the other side hasn't just died and you got the data	2172	to make sure the other side hasn't just died and you got the data
1619	intact. This is also one reason why so many internet protocols have an	2173	intact. This is also one reason why so many internet protocols have an
1620	explicit QUIT command.	2174	explicit QUIT command.
…		…
1631	$handle->on_drain (sub {	2185	$handle->on_drain (sub {
1632	warn "all data submitted to the kernel\n";	2186	warn "all data submitted to the kernel\n";
1633	undef $handle;	2187	undef $handle;
1634	});	2188	});
1635		2189
		2190	If you just want to queue some data and then signal EOF to the other side,
		2191	consider using C<< ->push_shutdown >> instead.
		2192
		2193	=item I want to contact a TLS/SSL server, I don't care about security.
		2194
		2195	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2196	connect to it and then create the AnyEvent::Handle with the C<tls>
		2197	parameter:
		2198
		2199	tcp_connect $host, $port, sub {
		2200	my ($fh) = @_;
		2201
		2202	my $handle = new AnyEvent::Handle
		2203	fh => $fh,
		2204	tls => "connect",
		2205	on_error => sub { ... };
		2206
		2207	$handle->push_write (...);
		2208	};
		2209
		2210	=item I want to contact a TLS/SSL server, I do care about security.
		2211
		2212	Then you should additionally enable certificate verification, including
		2213	peername verification, if the protocol you use supports it (see
		2214	L<AnyEvent::TLS>, C<verify_peername>).
		2215
		2216	E.g. for HTTPS:
		2217
		2218	tcp_connect $host, $port, sub {
		2219	my ($fh) = @_;
		2220
		2221	my $handle = new AnyEvent::Handle
		2222	fh => $fh,
		2223	peername => $host,
		2224	tls => "connect",
		2225	tls_ctx => { verify => 1, verify_peername => "https" },
		2226	...
		2227
		2228	Note that you must specify the hostname you connected to (or whatever
		2229	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2230	peername verification will be done.
		2231
		2232	The above will use the system-dependent default set of trusted CA
		2233	certificates. If you want to check against a specific CA, add the
		2234	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2235
		2236	tls_ctx => {
		2237	verify => 1,
		2238	verify_peername => "https",
		2239	ca_file => "my-ca-cert.pem",
		2240	},
		2241
		2242	=item I want to create a TLS/SSL server, how do I do that?
		2243
		2244	Well, you first need to get a server certificate and key. You have
		2245	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2246	self-signed certificate (cheap. check the search engine of your choice,
		2247	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2248	nice program for that purpose).
		2249
		2250	Then create a file with your private key (in PEM format, see
		2251	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2252	file should then look like this:
		2253
		2254	-----BEGIN RSA PRIVATE KEY-----
		2255	...header data
		2256	... lots of base64'y-stuff
		2257	-----END RSA PRIVATE KEY-----
		2258
		2259	-----BEGIN CERTIFICATE-----
		2260	... lots of base64'y-stuff
		2261	-----END CERTIFICATE-----
		2262
		2263	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2264	specify this file as C<cert_file>:
		2265
		2266	tcp_server undef, $port, sub {
		2267	my ($fh) = @_;
		2268
		2269	my $handle = new AnyEvent::Handle
		2270	fh => $fh,
		2271	tls => "accept",
		2272	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2273	...
		2274
		2275	When you have intermediate CA certificates that your clients might not
		2276	know about, just append them to the C<cert_file>.
		2277
1636	=back	2278	=back
1637		2279
1638		2280
1639	=head1 SUBCLASSING AnyEvent::Handle	2281	=head1 SUBCLASSING AnyEvent::Handle
1640		2282
…		…
1659		2301
1660	=item * all members not documented here and not prefixed with an underscore	2302	=item * all members not documented here and not prefixed with an underscore
1661	are free to use in subclasses.	2303	are free to use in subclasses.
1662		2304
1663	Of course, new versions of AnyEvent::Handle may introduce more "public"	2305	Of course, new versions of AnyEvent::Handle may introduce more "public"
1664	member variables, but thats just life, at least it is documented.	2306	member variables, but that's just life. At least it is documented.
1665		2307
1666	=back	2308	=back
1667		2309
1668	=head1 AUTHOR	2310	=head1 AUTHOR
1669		2311

Diff Legend

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