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

Diff Legend

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