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.142 by root, Mon Jul 6 20:24:47 2009 UTC vs.
Revision 1.202 by root, Sat Oct 16 02:01: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.452;
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, $message)
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	AnyEvent::Handle tries to find an appropriate error code for you to check
113	against, but in some cases (TLS errors), this does not work well. It is
114	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).
116
117	Non-fatal errors can be retried by simply returning, but it is recommended
118	to simply ignore this parameter and instead abondon the handle object
119	when this callback is invoked. Examples of non-fatal errors are timeouts
120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
121
122	On callback entrance, the value of C<$!> contains the operating system
123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
124	C<EPROTO>).
125
126	While not mandatory, it is I<highly> recommended to set this callback, as
127	you will not be notified of errors otherwise. The default simply calls
128	C<croak>.
129
130	=item on_read => $cb->($handle)
131
132	This sets the default read callback, which is called when data arrives
133	and no read request is in the queue (unlike read queue callbacks, this
134	callback will only be called when at least one octet of data is in the
135	read buffer).
136
137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
138	method or access the C<< $handle->{rbuf} >> member directly. Note that you
139	must not enlarge or modify the read buffer, you can only remove data at
140	the beginning from it.
141
142	When an EOF condition is detected then AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before
144	calling the C<on_eof> callback. If no progress can be made, then a fatal
145	error will be raised (with C<$!> set to C<EPIPE>).
146
147	=item on_drain => $cb->($handle)	225	=item on_drain => $cb->($handle)
148		226
149	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
150	(or when the callback is set and the buffer is empty already).	228	(or immediately if the buffer is empty already).
151		229
152	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.
153		231
154	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
155	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
…		…
157	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
158	the file when the write queue becomes empty.	236	the file when the write queue becomes empty.
159		237
160	=item timeout => $fractional_seconds	238	=item timeout => $fractional_seconds
161		239
		240	=item rtimeout => $fractional_seconds
		241
		242	=item wtimeout => $fractional_seconds
		243
162	If non-zero, then this enables an "inactivity" timeout: whenever this many	244	If non-zero, then these enables an "inactivity" timeout: whenever this
163	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
164	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
165	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).
166		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
167	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
168	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
169	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
170	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
171	restart the timeout.	260	restart the timeout.
172		261
173	Zero (the default) disables this timeout.	262	Zero (the default) disables this timeout.
174		263
…		…
190	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
191	isn't finished).	280	isn't finished).
192		281
193	=item autocork => <boolean>	282	=item autocork => <boolean>
194		283
195	When disabled (the default), then C<push_write> will try to immediately	284	When disabled (the default), C<push_write> will try to immediately
196	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
197	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
198	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
199	disadvantage is usually avoided by your kernel's nagle algorithm, see	288	disadvantage is usually avoided by your kernel's nagle algorithm, see
200	C<no_delay>, but this option can save costly syscalls).	289	C<no_delay>, but this option can save costly syscalls).
201		290
202	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
203	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,
204	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
205	the write buffer often is full). It also increases write latency.	294	the write buffer often is full). It also increases write latency.
206		295
207	=item no_delay => <boolean>	296	=item no_delay => <boolean>
…		…
211	the Nagle algorithm, and usually it is beneficial.	300	the Nagle algorithm, and usually it is beneficial.
212		301
213	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
214	accomplishd by setting this option to a true value.	303	accomplishd by setting this option to a true value.
215		304
216	The default is your opertaing system's default behaviour (most likely	305	The default is your operating system's default behaviour (most likely
217	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.
218		339
219	=item read_size => <bytes>	340	=item read_size => <bytes>
220		341
221	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
222	try to read during each loop iteration, which affects memory	343	try to read during each loop iteration, which affects memory
223	requirements). Default: C<8192>.	344	requirements). Default: C<8192>.
224		345
225	=item low_water_mark => <bytes>	346	=item low_water_mark => <bytes>
226		347
227	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
228	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
229	considered empty.	350	considered empty.
230		351
231	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
232	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
233	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
234	is good in almost all cases.	355	is good in almost all cases.
235		356
236	=item linger => <seconds>	357	=item linger => <seconds>
237		358
238	If non-zero (default: C<3600>), then the destructor of the	359	If this is non-zero (default: C<3600>), the destructor of the
239	AnyEvent::Handle object will check whether there is still outstanding	360	AnyEvent::Handle object will check whether there is still outstanding
240	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
241	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
242	system treats outstanding data at socket close time).	363	system treats outstanding data at socket close time).
243		364
…		…
249		370
250	A string used to identify the remote site - usually the DNS hostname	371	A string used to identify the remote site - usually the DNS hostname
251	(I<not> IDN!) used to create the connection, rarely the IP address.	372	(I<not> IDN!) used to create the connection, rarely the IP address.
252		373
253	Apart from being useful in error messages, this string is also used in TLS	374	Apart from being useful in error messages, this string is also used in TLS
254	peername verification (see C<verify_peername> in L<AnyEvent::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>.
255		378
256	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	379	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
257		380
258	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
259	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
260	established and will transparently encrypt/decrypt data afterwards.	383	established and will transparently encrypt/decrypt data afterwards.
261		384
262	All TLS protocol errors will be signalled as C<EPROTO>, with an	385	All TLS protocol errors will be signalled as C<EPROTO>, with an
263	appropriate error message.	386	appropriate error message.
264		387
…		…
284	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	407	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
285	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
286	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
287	segmentation fault.	410	segmentation fault.
288		411
289	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.
290		413
291	=item tls_ctx => $anyevent_tls	414	=item tls_ctx => $anyevent_tls
292		415
293	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
294	(unless a connection object was specified directly). If this parameter is	417	(unless a connection object was specified directly). If this parameter is
…		…
296		419
297	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
298	=> 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
299	new TLS context object.	422	new TLS context object.
300		423
301	=item on_starttls => $cb->($handle, $success)	424	=item on_starttls => $cb->($handle, $success[, $error_message])
302		425
303	This callback will be invoked when the TLS/SSL handshake has finished. If	426	This callback will be invoked when the TLS/SSL handshake has finished. If
304	C<$success> is true, then the TLS handshake succeeded, otherwise it failed	427	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
305	(C<on_stoptls> will not be called in this case).	428	(C<on_stoptls> will not be called in this case).
306		429
307	The session in C<< $handle->{tls} >> can still be examined in this	430	The session in C<< $handle->{tls} >> can still be examined in this
308	callback, even when the handshake was not successful.	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.
309		442
310	=item on_stoptls => $cb->($handle)	443	=item on_stoptls => $cb->($handle)
311		444
312	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is	445	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
313	set, then it will be invoked after freeing the TLS session. If it is not,	446	set, then it will be invoked after freeing the TLS session. If it is not,
…		…
337		470
338	sub new {	471	sub new {
339	my $class = shift;	472	my $class = shift;
340	my $self = bless { @_ }, $class;	473	my $self = bless { @_ }, $class;
341		474
342	$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;
343		544
344	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	545	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
345		546
		547	$self->{_activity} =
		548	$self->{_ractivity} =
346	$self->{_activity} = AnyEvent->now;	549	$self->{_wactivity} = AE::now;
347	$self->_timeout;
348		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
349	$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};
350		557
		558	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		559
351	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	560	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
352	if $self->{tls};	561	if $self->{tls};
353		562
354	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	563	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
355		564
356	$self->start_read	565	$self->start_read
357	if $self->{on_read};	566	if $self->{on_read} || @{ $self->{_queue} };
358		567
359	$self->{fh} && $self	568	$self->_drain_wbuf;
360	}
361
362	sub _shutdown {
363	my ($self) = @_;
364
365	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
366	$self->{_eof} = 1; # tell starttls et. al to stop trying
367
368	&_freetls;
369	}	569	}
370		570
371	sub _error {	571	sub _error {
372	my ($self, $errno, $fatal, $message) = @_;	572	my ($self, $errno, $fatal, $message) = @_;
373		573
374	$self->_shutdown
375	if $fatal;
376
377	$! = $errno;	574	$! = $errno;
378	$message ||= "$!";	575	$message ||= "$!";
379		576
380	if ($self->{on_error}) {	577	if ($self->{on_error}) {
381	$self->{on_error}($self, $fatal, $message);	578	$self->{on_error}($self, $fatal, $message);
382	} elsif ($self->{fh}) {	579	$self->destroy if $fatal;
		580	} elsif ($self->{fh} || $self->{connect}) {
		581	$self->destroy;
383	Carp::croak "AnyEvent::Handle uncaught error: $message";	582	Carp::croak "AnyEvent::Handle uncaught error: $message";
384	}	583	}
385	}	584	}
386		585
387	=item $fh = $handle->fh	586	=item $fh = $handle->fh
…		…
412	$_[0]{on_eof} = $_[1];	611	$_[0]{on_eof} = $_[1];
413	}	612	}
414		613
415	=item $handle->on_timeout ($cb)	614	=item $handle->on_timeout ($cb)
416		615
417	Replace the current C<on_timeout> callback, or disables the callback (but	616	=item $handle->on_rtimeout ($cb)
418	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
419	argument and method.
420		617
421	=cut	618	=item $handle->on_wtimeout ($cb)
422		619
423	sub on_timeout {	620	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
424	$_[0]{on_timeout} = $_[1];	621	callback, or disables the callback (but not the timeout) if C<$cb> =
425	}	622	C<undef>. See the C<timeout> constructor argument and method.
		623
		624	=cut
		625
		626	# see below
426		627
427	=item $handle->autocork ($boolean)	628	=item $handle->autocork ($boolean)
428		629
429	Enables or disables the current autocork behaviour (see C<autocork>	630	Enables or disables the current autocork behaviour (see C<autocork>
430	constructor argument). Changes will only take effect on the next write.	631	constructor argument). Changes will only take effect on the next write.
…		…
443	=cut	644	=cut
444		645
445	sub no_delay {	646	sub no_delay {
446	$_[0]{no_delay} = $_[1];	647	$_[0]{no_delay} = $_[1];
447		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
448	eval {	663	eval {
449	local $SIG{__DIE__};	664	local $SIG{__DIE__};
450	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};
		667	};
		668	}
		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};
451	};	701	};
452	}	702	}
453		703
454	=item $handle->on_starttls ($cb)	704	=item $handle->on_starttls ($cb)
455		705
…		…
465		715
466	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	716	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
467		717
468	=cut	718	=cut
469		719
470	sub on_starttls {	720	sub on_stoptls {
471	$_[0]{on_stoptls} = $_[1];	721	$_[0]{on_stoptls} = $_[1];
472	}	722	}
473		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
474	#############################################################################	734	#############################################################################
475		735
476	=item $handle->timeout ($seconds)	736	=item $handle->timeout ($seconds)
477		737
		738	=item $handle->rtimeout ($seconds)
		739
		740	=item $handle->wtimeout ($seconds)
		741
478	Configures (or disables) the inactivity timeout.	742	Configures (or disables) the inactivity timeout.
479		743
480	=cut	744	=item $handle->timeout_reset
481		745
482	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 {
483	my ($self, $timeout) = @_;	768	my ($self, $new_value) = @_;
484		769
		770	$new_value >= 0
		771	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		772
485	$self->{timeout} = $timeout;	773	$self->{$timeout} = $new_value;
486	$self->_timeout;	774	delete $self->{$tw}; &$cb;
487	}	775	};
488		776
		777	*{"${dir}timeout_reset"} = sub {
		778	$_[0]{$activity} = AE::now;
		779	};
		780
		781	# main workhorse:
489	# reset the timeout watcher, as neccessary	782	# reset the timeout watcher, as neccessary
490	# also check for time-outs	783	# also check for time-outs
491	sub _timeout {	784	$cb = sub {
492	my ($self) = @_;	785	my ($self) = @_;
493		786
494	if ($self->{timeout}) {	787	if ($self->{$timeout} && $self->{fh}) {
495	my $NOW = AnyEvent->now;	788	my $NOW = AE::now;
496		789
497	# when would the timeout trigger?	790	# when would the timeout trigger?
498	my $after = $self->{_activity} + $self->{timeout} - $NOW;	791	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
499		792
500	# now or in the past already?	793	# now or in the past already?
501	if ($after <= 0) {	794	if ($after <= 0) {
502	$self->{_activity} = $NOW;	795	$self->{$activity} = $NOW;
503		796
504	if ($self->{on_timeout}) {	797	if ($self->{$on_timeout}) {
505	$self->{on_timeout}($self);	798	$self->{$on_timeout}($self);
506	} else {	799	} else {
507	$self->_error (&Errno::ETIMEDOUT);	800	$self->_error (Errno::ETIMEDOUT);
		801	}
		802
		803	# callback could have changed timeout value, optimise
		804	return unless $self->{$timeout};
		805
		806	# calculate new after
		807	$after = $self->{$timeout};
508	}	808	}
509		809
510	# callback could have changed timeout value, optimise	810	Scalar::Util::weaken $self;
511	return unless $self->{timeout};	811	return unless $self; # ->error could have destroyed $self
512		812
513	# calculate new after	813	$self->{$tw} ||= AE::timer $after, 0, sub {
514	$after = $self->{timeout};	814	delete $self->{$tw};
		815	$cb->($self);
		816	};
		817	} else {
		818	delete $self->{$tw};
515	}	819	}
516
517	Scalar::Util::weaken $self;
518	return unless $self; # ->error could have destroyed $self
519
520	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
521	delete $self->{_tw};
522	$self->_timeout;
523	});
524	} else {
525	delete $self->{_tw};
526	}	820	}
527	}	821	}
528		822
529	#############################################################################	823	#############################################################################
530		824
…		…
545		839
546	=item $handle->on_drain ($cb)	840	=item $handle->on_drain ($cb)
547		841
548	Sets the C<on_drain> callback or clears it (see the description of	842	Sets the C<on_drain> callback or clears it (see the description of
549	C<on_drain> in the constructor).	843	C<on_drain> in the constructor).
		844
		845	This method may invoke callbacks (and therefore the handle might be
		846	destroyed after it returns).
550		847
551	=cut	848	=cut
552		849
553	sub on_drain {	850	sub on_drain {
554	my ($self, $cb) = @_;	851	my ($self, $cb) = @_;
…		…
563		860
564	Queues the given scalar to be written. You can push as much data as you	861	Queues the given scalar to be written. You can push as much data as you
565	want (only limited by the available memory), as C<AnyEvent::Handle>	862	want (only limited by the available memory), as C<AnyEvent::Handle>
566	buffers it independently of the kernel.	863	buffers it independently of the kernel.
567		864
		865	This method may invoke callbacks (and therefore the handle might be
		866	destroyed after it returns).
		867
568	=cut	868	=cut
569		869
570	sub _drain_wbuf {	870	sub _drain_wbuf {
571	my ($self) = @_;	871	my ($self) = @_;
572		872
…		…
575	Scalar::Util::weaken $self;	875	Scalar::Util::weaken $self;
576		876
577	my $cb = sub {	877	my $cb = sub {
578	my $len = syswrite $self->{fh}, $self->{wbuf};	878	my $len = syswrite $self->{fh}, $self->{wbuf};
579		879
580	if ($len >= 0) {	880	if (defined $len) {
581	substr $self->{wbuf}, 0, $len, "";	881	substr $self->{wbuf}, 0, $len, "";
582		882
583	$self->{_activity} = AnyEvent->now;	883	$self->{_activity} = $self->{_wactivity} = AE::now;
584		884
585	$self->{on_drain}($self)	885	$self->{on_drain}($self)
586	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	886	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
587	&& $self->{on_drain};	887	&& $self->{on_drain};
588		888
…		…
594		894
595	# try to write data immediately	895	# try to write data immediately
596	$cb->() unless $self->{autocork};	896	$cb->() unless $self->{autocork};
597		897
598	# if still data left in wbuf, we need to poll	898	# if still data left in wbuf, we need to poll
599	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	899	$self->{_ww} = AE::io $self->{fh}, 1, $cb
600	if length $self->{wbuf};	900	if length $self->{wbuf};
601	};	901	};
602	}	902	}
603		903
604	our %WH;	904	our %WH;
605		905
		906	# deprecated
606	sub register_write_type($$) {	907	sub register_write_type($$) {
607	$WH{$_[0]} = $_[1];	908	$WH{$_[0]} = $_[1];
608	}	909	}
609		910
610	sub push_write {	911	sub push_write {
611	my $self = shift;	912	my $self = shift;
612		913
613	if (@_ > 1) {	914	if (@_ > 1) {
614	my $type = shift;	915	my $type = shift;
615		916
		917	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
616	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	918	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
617	->($self, @_);	919	->($self, @_);
618	}	920	}
619		921
		922	# we downgrade here to avoid hard-to-track-down bugs,
		923	# and diagnose the problem earlier and better.
		924
620	if ($self->{tls}) {	925	if ($self->{tls}) {
621	$self->{_tls_wbuf} .= $_[0];	926	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
622		927	&_dotls ($self) if $self->{fh};
623	&_dotls ($self);
624	} else {	928	} else {
625	$self->{wbuf} .= $_[0];	929	utf8::downgrade $self->{wbuf} .= $_[0];
626	$self->_drain_wbuf;	930	$self->_drain_wbuf if $self->{fh};
627	}	931	}
628	}	932	}
629		933
630	=item $handle->push_write (type => @args)	934	=item $handle->push_write (type => @args)
631		935
632	Instead of formatting your data yourself, you can also let this module do	936	Instead of formatting your data yourself, you can also let this module
633	the job by specifying a type and type-specific arguments.	937	do the job by specifying a type and type-specific arguments. You
		938	can also specify the (fully qualified) name of a package, in which
		939	case AnyEvent tries to load the package and then expects to find the
		940	C<anyevent_write_type> function inside (see "custom write types", below).
634		941
635	Predefined types are (if you have ideas for additional types, feel free to	942	Predefined types are (if you have ideas for additional types, feel free to
636	drop by and tell us):	943	drop by and tell us):
637		944
638	=over 4	945	=over 4
…		…
695	Other languages could read single lines terminated by a newline and pass	1002	Other languages could read single lines terminated by a newline and pass
696	this line into their JSON decoder of choice.	1003	this line into their JSON decoder of choice.
697		1004
698	=cut	1005	=cut
699		1006
		1007	sub json_coder() {
		1008	eval { require JSON::XS; JSON::XS->new->utf8 }
		1009	|| do { require JSON; JSON->new->utf8 }
		1010	}
		1011
700	register_write_type json => sub {	1012	register_write_type json => sub {
701	my ($self, $ref) = @_;	1013	my ($self, $ref) = @_;
702		1014
703	require JSON;	1015	my $json = $self->{json} ||= json_coder;
704		1016
705	$self->{json} ? $self->{json}->encode ($ref)	1017	$json->encode ($ref)
706	: JSON::encode_json ($ref)
707	};	1018	};
708		1019
709	=item storable => $reference	1020	=item storable => $reference
710		1021
711	Freezes the given reference using L<Storable> and writes it to the	1022	Freezes the given reference using L<Storable> and writes it to the
…		…
737	the peer.	1048	the peer.
738		1049
739	You can rely on the normal read queue and C<on_eof> handling	1050	You can rely on the normal read queue and C<on_eof> handling
740	afterwards. This is the cleanest way to close a connection.	1051	afterwards. This is the cleanest way to close a connection.
741		1052
		1053	This method may invoke callbacks (and therefore the handle might be
		1054	destroyed after it returns).
		1055
742	=cut	1056	=cut
743		1057
744	sub push_shutdown {	1058	sub push_shutdown {
745	my ($self) = @_;	1059	my ($self) = @_;
746		1060
747	delete $self->{low_water_mark};	1061	delete $self->{low_water_mark};
748	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1062	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
749	}	1063	}
750		1064
751	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1065	=item custom write types - Package::anyevent_write_type $handle, @args
752		1066
753	This function (not method) lets you add your own types to C<push_write>.	1067	Instead of one of the predefined types, you can also specify the name of
		1068	a package. AnyEvent will try to load the package and then expects to find
		1069	a function named C<anyevent_write_type> inside. If it isn't found, it
		1070	progressively tries to load the parent package until it either finds the
		1071	function (good) or runs out of packages (bad).
		1072
754	Whenever the given C<type> is used, C<push_write> will invoke the code	1073	Whenever the given C<type> is used, C<push_write> will the function with
755	reference with the handle object and the remaining arguments.	1074	the handle object and the remaining arguments.
756		1075
757	The code reference is supposed to return a single octet string that will	1076	The function is supposed to return a single octet string that will be
758	be appended to the write buffer.	1077	appended to the write buffer, so you cna mentally treat this function as a
		1078	"arguments to on-the-wire-format" converter.
759		1079
760	Note that this is a function, and all types registered this way will be	1080	Example: implement a custom write type C<join> that joins the remaining
761	global, so try to use unique names.	1081	arguments using the first one.
		1082
		1083	$handle->push_write (My::Type => " ", 1,2,3);
		1084
		1085	# uses the following package, which can be defined in the "My::Type" or in
		1086	# the "My" modules to be auto-loaded, or just about anywhere when the
		1087	# My::Type::anyevent_write_type is defined before invoking it.
		1088
		1089	package My::Type;
		1090
		1091	sub anyevent_write_type {
		1092	my ($handle, $delim, @args) = @_;
		1093
		1094	join $delim, @args
		1095	}
762		1096
763	=cut	1097	=cut
764		1098
765	#############################################################################	1099	#############################################################################
766		1100
…		…
775	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1109	ways, the "simple" way, using only C<on_read> and the "complex" way, using
776	a queue.	1110	a queue.
777		1111
778	In the simple case, you just install an C<on_read> callback and whenever	1112	In the simple case, you just install an C<on_read> callback and whenever
779	new data arrives, it will be called. You can then remove some data (if	1113	new data arrives, it will be called. You can then remove some data (if
780	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1114	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
781	leave the data there if you want to accumulate more (e.g. when only a	1115	leave the data there if you want to accumulate more (e.g. when only a
782	partial message has been received so far).	1116	partial message has been received so far), or change the read queue with
		1117	e.g. C<push_read>.
783		1118
784	In the more complex case, you want to queue multiple callbacks. In this	1119	In the more complex case, you want to queue multiple callbacks. In this
785	case, AnyEvent::Handle will call the first queued callback each time new	1120	case, AnyEvent::Handle will call the first queued callback each time new
786	data arrives (also the first time it is queued) and removes it when it has	1121	data arrives (also the first time it is queued) and remove it when it has
787	done its job (see C<push_read>, below).	1122	done its job (see C<push_read>, below).
788		1123
789	This way you can, for example, push three line-reads, followed by reading	1124	This way you can, for example, push three line-reads, followed by reading
790	a chunk of data, and AnyEvent::Handle will execute them in order.	1125	a chunk of data, and AnyEvent::Handle will execute them in order.
791		1126
…		…
848	=cut	1183	=cut
849		1184
850	sub _drain_rbuf {	1185	sub _drain_rbuf {
851	my ($self) = @_;	1186	my ($self) = @_;
852		1187
		1188	# avoid recursion
		1189	return if $self->{_skip_drain_rbuf};
853	local $self->{_in_drain} = 1;	1190	local $self->{_skip_drain_rbuf} = 1;
854
855	if (
856	defined $self->{rbuf_max}
857	&& $self->{rbuf_max} < length $self->{rbuf}
858	) {
859	$self->_error (&Errno::ENOSPC, 1), return;
860	}
861		1191
862	while () {	1192	while () {
863	# we need to use a separate tls read buffer, as we must not receive data while	1193	# we need to use a separate tls read buffer, as we must not receive data while
864	# we are draining the buffer, and this can only happen with TLS.	1194	# we are draining the buffer, and this can only happen with TLS.
865	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1195	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1196	if exists $self->{_tls_rbuf};
866		1197
867	my $len = length $self->{rbuf};	1198	my $len = length $self->{rbuf};
868		1199
869	if (my $cb = shift @{ $self->{_queue} }) {	1200	if (my $cb = shift @{ $self->{_queue} }) {
870	unless ($cb->($self)) {	1201	unless ($cb->($self)) {
871	if ($self->{_eof}) {	1202	# no progress can be made
872	# no progress can be made (not enough data and no data forthcoming)	1203	# (not enough data and no data forthcoming)
873	$self->_error (&Errno::EPIPE, 1), return;	1204	$self->_error (Errno::EPIPE, 1), return
874	}	1205	if $self->{_eof};
875		1206
876	unshift @{ $self->{_queue} }, $cb;	1207	unshift @{ $self->{_queue} }, $cb;
877	last;	1208	last;
878	}	1209	}
879	} elsif ($self->{on_read}) {	1210	} elsif ($self->{on_read}) {
…		…
886	&& !@{ $self->{_queue} } # and the queue is still empty	1217	&& !@{ $self->{_queue} } # and the queue is still empty
887	&& $self->{on_read} # but we still have on_read	1218	&& $self->{on_read} # but we still have on_read
888	) {	1219	) {
889	# no further data will arrive	1220	# no further data will arrive
890	# so no progress can be made	1221	# so no progress can be made
891	$self->_error (&Errno::EPIPE, 1), return	1222	$self->_error (Errno::EPIPE, 1), return
892	if $self->{_eof};	1223	if $self->{_eof};
893		1224
894	last; # more data might arrive	1225	last; # more data might arrive
895	}	1226	}
896	} else {	1227	} else {
…		…
899	last;	1230	last;
900	}	1231	}
901	}	1232	}
902		1233
903	if ($self->{_eof}) {	1234	if ($self->{_eof}) {
904	if ($self->{on_eof}) {	1235	$self->{on_eof}
905	$self->{on_eof}($self)	1236	? $self->{on_eof}($self)
906	} else {
907	$self->_error (0, 1, "Unexpected end-of-file");	1237	: $self->_error (0, 1, "Unexpected end-of-file");
908	}	1238
		1239	return;
		1240	}
		1241
		1242	if (
		1243	defined $self->{rbuf_max}
		1244	&& $self->{rbuf_max} < length $self->{rbuf}
		1245	) {
		1246	$self->_error (Errno::ENOSPC, 1), return;
909	}	1247	}
910		1248
911	# may need to restart read watcher	1249	# may need to restart read watcher
912	unless ($self->{_rw}) {	1250	unless ($self->{_rw}) {
913	$self->start_read	1251	$self->start_read
…		…
919		1257
920	This replaces the currently set C<on_read> callback, or clears it (when	1258	This replaces the currently set C<on_read> callback, or clears it (when
921	the new callback is C<undef>). See the description of C<on_read> in the	1259	the new callback is C<undef>). See the description of C<on_read> in the
922	constructor.	1260	constructor.
923		1261
		1262	This method may invoke callbacks (and therefore the handle might be
		1263	destroyed after it returns).
		1264
924	=cut	1265	=cut
925		1266
926	sub on_read {	1267	sub on_read {
927	my ($self, $cb) = @_;	1268	my ($self, $cb) = @_;
928		1269
929	$self->{on_read} = $cb;	1270	$self->{on_read} = $cb;
930	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1271	$self->_drain_rbuf if $cb;
931	}	1272	}
932		1273
933	=item $handle->rbuf	1274	=item $handle->rbuf
934		1275
935	Returns the read buffer (as a modifiable lvalue).	1276	Returns the read buffer (as a modifiable lvalue). You can also access the
		1277	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1278	much faster, and no less clean).
936		1279
937	You can access the read buffer directly as the C<< ->{rbuf} >>	1280	The only operation allowed on the read buffer (apart from looking at it)
938	member, if you want. However, the only operation allowed on the	1281	is removing data from its beginning. Otherwise modifying or appending to
939	read buffer (apart from looking at it) is removing data from its	1282	it is not allowed and will lead to hard-to-track-down bugs.
940	beginning. Otherwise modifying or appending to it is not allowed and will
941	lead to hard-to-track-down bugs.
942		1283
943	NOTE: The read buffer should only be used or modified if the C<on_read>,	1284	NOTE: The read buffer should only be used or modified in the C<on_read>
944	C<push_read> or C<unshift_read> methods are used. The other read methods	1285	callback or when C<push_read> or C<unshift_read> are used with a single
945	automatically manage the read buffer.	1286	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1287	will manage the read buffer on their own.
946		1288
947	=cut	1289	=cut
948		1290
949	sub rbuf : lvalue {	1291	sub rbuf : lvalue {
950	$_[0]{rbuf}	1292	$_[0]{rbuf}
…		…
967		1309
968	If enough data was available, then the callback must remove all data it is	1310	If enough data was available, then the callback must remove all data it is
969	interested in (which can be none at all) and return a true value. After returning	1311	interested in (which can be none at all) and return a true value. After returning
970	true, it will be removed from the queue.	1312	true, it will be removed from the queue.
971		1313
		1314	These methods may invoke callbacks (and therefore the handle might be
		1315	destroyed after it returns).
		1316
972	=cut	1317	=cut
973		1318
974	our %RH;	1319	our %RH;
975		1320
976	sub register_read_type($$) {	1321	sub register_read_type($$) {
…		…
982	my $cb = pop;	1327	my $cb = pop;
983		1328
984	if (@_) {	1329	if (@_) {
985	my $type = shift;	1330	my $type = shift;
986		1331
		1332	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
987	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1333	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
988	->($self, $cb, @_);	1334	->($self, $cb, @_);
989	}	1335	}
990		1336
991	push @{ $self->{_queue} }, $cb;	1337	push @{ $self->{_queue} }, $cb;
992	$self->_drain_rbuf unless $self->{_in_drain};	1338	$self->_drain_rbuf;
993	}	1339	}
994		1340
995	sub unshift_read {	1341	sub unshift_read {
996	my $self = shift;	1342	my $self = shift;
997	my $cb = pop;	1343	my $cb = pop;
998		1344
999	if (@_) {	1345	if (@_) {
1000	my $type = shift;	1346	my $type = shift;
1001		1347
		1348	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1002	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1349	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1003	->($self, $cb, @_);	1350	->($self, $cb, @_);
1004	}	1351	}
1005		1352
1006
1007	unshift @{ $self->{_queue} }, $cb;	1353	unshift @{ $self->{_queue} }, $cb;
1008	$self->_drain_rbuf unless $self->{_in_drain};	1354	$self->_drain_rbuf;
1009	}	1355	}
1010		1356
1011	=item $handle->push_read (type => @args, $cb)	1357	=item $handle->push_read (type => @args, $cb)
1012		1358
1013	=item $handle->unshift_read (type => @args, $cb)	1359	=item $handle->unshift_read (type => @args, $cb)
1014		1360
1015	Instead of providing a callback that parses the data itself you can chose	1361	Instead of providing a callback that parses the data itself you can chose
1016	between a number of predefined parsing formats, for chunks of data, lines	1362	between a number of predefined parsing formats, for chunks of data, lines
1017	etc.	1363	etc. You can also specify the (fully qualified) name of a package, in
		1364	which case AnyEvent tries to load the package and then expects to find the
		1365	C<anyevent_read_type> function inside (see "custom read types", below).
1018		1366
1019	Predefined types are (if you have ideas for additional types, feel free to	1367	Predefined types are (if you have ideas for additional types, feel free to
1020	drop by and tell us):	1368	drop by and tell us):
1021		1369
1022	=over 4	1370	=over 4
…		…
1114	the receive buffer when neither C<$accept> nor C<$reject> match,	1462	the receive buffer when neither C<$accept> nor C<$reject> match,
1115	and everything preceding and including the match will be accepted	1463	and everything preceding and including the match will be accepted
1116	unconditionally. This is useful to skip large amounts of data that you	1464	unconditionally. This is useful to skip large amounts of data that you
1117	know cannot be matched, so that the C<$accept> or C<$reject> regex do not	1465	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1118	have to start matching from the beginning. This is purely an optimisation	1466	have to start matching from the beginning. This is purely an optimisation
1119	and is usually worth only when you expect more than a few kilobytes.	1467	and is usually worth it only when you expect more than a few kilobytes.
1120		1468
1121	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1469	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1122	expect the header to be very large (it isn't in practise, but...), we use	1470	expect the header to be very large (it isn't in practice, but...), we use
1123	a skip regex to skip initial portions. The skip regex is tricky in that	1471	a skip regex to skip initial portions. The skip regex is tricky in that
1124	it only accepts something not ending in either \015 or \012, as these are	1472	it only accepts something not ending in either \015 or \012, as these are
1125	required for the accept regex.	1473	required for the accept regex.
1126		1474
1127	$handle->push_read (regex =>	1475	$handle->push_read (regex =>
…		…
1146	return 1;	1494	return 1;
1147	}	1495	}
1148		1496
1149	# reject	1497	# reject
1150	if ($reject && $$rbuf =~ $reject) {	1498	if ($reject && $$rbuf =~ $reject) {
1151	$self->_error (&Errno::EBADMSG);	1499	$self->_error (Errno::EBADMSG);
1152	}	1500	}
1153		1501
1154	# skip	1502	# skip
1155	if ($skip && $$rbuf =~ $skip) {	1503	if ($skip && $$rbuf =~ $skip) {
1156	$data .= substr $$rbuf, 0, $+[0], "";	1504	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1172	my ($self, $cb) = @_;	1520	my ($self, $cb) = @_;
1173		1521
1174	sub {	1522	sub {
1175	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1523	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1176	if ($_[0]{rbuf} =~ /[^0-9]/) {	1524	if ($_[0]{rbuf} =~ /[^0-9]/) {
1177	$self->_error (&Errno::EBADMSG);	1525	$self->_error (Errno::EBADMSG);
1178	}	1526	}
1179	return;	1527	return;
1180	}	1528	}
1181		1529
1182	my $len = $1;	1530	my $len = $1;
…		…
1185	my $string = $_[1];	1533	my $string = $_[1];
1186	$_[0]->unshift_read (chunk => 1, sub {	1534	$_[0]->unshift_read (chunk => 1, sub {
1187	if ($_[1] eq ",") {	1535	if ($_[1] eq ",") {
1188	$cb->($_[0], $string);	1536	$cb->($_[0], $string);
1189	} else {	1537	} else {
1190	$self->_error (&Errno::EBADMSG);	1538	$self->_error (Errno::EBADMSG);
1191	}	1539	}
1192	});	1540	});
1193	});	1541	});
1194		1542
1195	1	1543	1
…		…
1262	=cut	1610	=cut
1263		1611
1264	register_read_type json => sub {	1612	register_read_type json => sub {
1265	my ($self, $cb) = @_;	1613	my ($self, $cb) = @_;
1266		1614
1267	my $json = $self->{json} ||=	1615	my $json = $self->{json} ||= json_coder;
1268	eval { require JSON::XS; JSON::XS->new->utf8 }
1269	|| do { require JSON; JSON->new->utf8 };
1270		1616
1271	my $data;	1617	my $data;
1272	my $rbuf = \$self->{rbuf};	1618	my $rbuf = \$self->{rbuf};
1273		1619
1274	sub {	1620	sub {
…		…
1285	$json->incr_skip;	1631	$json->incr_skip;
1286		1632
1287	$self->{rbuf} = $json->incr_text;	1633	$self->{rbuf} = $json->incr_text;
1288	$json->incr_text = "";	1634	$json->incr_text = "";
1289		1635
1290	$self->_error (&Errno::EBADMSG);	1636	$self->_error (Errno::EBADMSG);
1291		1637
1292	()	1638	()
1293	} else {	1639	} else {
1294	$self->{rbuf} = "";	1640	$self->{rbuf} = "";
1295		1641
…		…
1332	# read remaining chunk	1678	# read remaining chunk
1333	$_[0]->unshift_read (chunk => $len, sub {	1679	$_[0]->unshift_read (chunk => $len, sub {
1334	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1680	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1335	$cb->($_[0], $ref);	1681	$cb->($_[0], $ref);
1336	} else {	1682	} else {
1337	$self->_error (&Errno::EBADMSG);	1683	$self->_error (Errno::EBADMSG);
1338	}	1684	}
1339	});	1685	});
1340	}	1686	}
1341		1687
1342	1	1688	1
1343	}	1689	}
1344	};	1690	};
1345		1691
1346	=back	1692	=back
1347		1693
1348	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1694	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1349		1695
1350	This function (not method) lets you add your own types to C<push_read>.	1696	Instead of one of the predefined types, you can also specify the name
		1697	of a package. AnyEvent will try to load the package and then expects to
		1698	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1699	progressively tries to load the parent package until it either finds the
		1700	function (good) or runs out of packages (bad).
1351		1701
1352	Whenever the given C<type> is used, C<push_read> will invoke the code	1702	Whenever this type is used, C<push_read> will invoke the function with the
1353	reference with the handle object, the callback and the remaining	1703	handle object, the original callback and the remaining arguments.
1354	arguments.
1355		1704
1356	The code reference is supposed to return a callback (usually a closure)	1705	The function is supposed to return a callback (usually a closure) that
1357	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1706	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1707	mentally treat the function as a "configurable read type to read callback"
		1708	converter.
1358		1709
1359	It should invoke the passed callback when it is done reading (remember to	1710	It should invoke the original callback when it is done reading (remember
1360	pass C<$handle> as first argument as all other callbacks do that).	1711	to pass C<$handle> as first argument as all other callbacks do that,
		1712	although there is no strict requirement on this).
1361		1713
1362	Note that this is a function, and all types registered this way will be
1363	global, so try to use unique names.
1364
1365	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1714	For examples, see the source of this module (F<perldoc -m
1366	search for C<register_read_type>)).	1715	AnyEvent::Handle>, search for C<register_read_type>)).
1367		1716
1368	=item $handle->stop_read	1717	=item $handle->stop_read
1369		1718
1370	=item $handle->start_read	1719	=item $handle->start_read
1371		1720
…		…
1391	}	1740	}
1392		1741
1393	sub start_read {	1742	sub start_read {
1394	my ($self) = @_;	1743	my ($self) = @_;
1395		1744
1396	unless ($self->{_rw} || $self->{_eof}) {	1745	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1397	Scalar::Util::weaken $self;	1746	Scalar::Util::weaken $self;
1398		1747
1399	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1748	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1400	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1749	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1401	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1750	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1402		1751
1403	if ($len > 0) {	1752	if ($len > 0) {
1404	$self->{_activity} = AnyEvent->now;	1753	$self->{_activity} = $self->{_ractivity} = AE::now;
1405		1754
1406	if ($self->{tls}) {	1755	if ($self->{tls}) {
1407	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1756	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1408		1757
1409	&_dotls ($self);	1758	&_dotls ($self);
1410	} else {	1759	} else {
1411	$self->_drain_rbuf unless $self->{_in_drain};	1760	$self->_drain_rbuf;
1412	}	1761	}
1413		1762
1414	} elsif (defined $len) {	1763	} elsif (defined $len) {
1415	delete $self->{_rw};	1764	delete $self->{_rw};
1416	$self->{_eof} = 1;	1765	$self->{_eof} = 1;
1417	$self->_drain_rbuf unless $self->{_in_drain};	1766	$self->_drain_rbuf;
1418		1767
1419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1768	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1420	return $self->_error ($!, 1);	1769	return $self->_error ($!, 1);
1421	}	1770	}
1422	});	1771	};
1423	}	1772	}
1424	}	1773	}
1425		1774
1426	our $ERROR_SYSCALL;	1775	our $ERROR_SYSCALL;
1427	our $ERROR_WANT_READ;	1776	our $ERROR_WANT_READ;
…		…
1435	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	1784	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1436		1785
1437	# reduce error string to look less scary	1786	# reduce error string to look less scary
1438	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	1787	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1439		1788
		1789	if ($self->{_on_starttls}) {
		1790	(delete $self->{_on_starttls})->($self, undef, $err);
		1791	&_freetls;
		1792	} else {
		1793	&_freetls;
1440	$self->_error (&Errno::EPROTO, 1, $err);	1794	$self->_error (Errno::EPROTO, 1, $err);
		1795	}
1441	}	1796	}
1442		1797
1443	# poll the write BIO and send the data if applicable	1798	# poll the write BIO and send the data if applicable
1444	# also decode read data if possible	1799	# also decode read data if possible
1445	# this is basiclaly our TLS state machine	1800	# this is basiclaly our TLS state machine
…		…
1461	&& ($tmp != $ERROR_SYSCALL || $!);	1816	&& ($tmp != $ERROR_SYSCALL || $!);
1462	}	1817	}
1463		1818
1464	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1819	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1465	unless (length $tmp) {	1820	unless (length $tmp) {
		1821	$self->{_on_starttls}
		1822	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1466	&_freetls;	1823	&_freetls;
		1824
1467	if ($self->{on_stoptls}) {	1825	if ($self->{on_stoptls}) {
1468	$self->{on_stoptls}($self);	1826	$self->{on_stoptls}($self);
1469	return;	1827	return;
1470	} else {	1828	} else {
1471	# let's treat SSL-eof as we treat normal EOF	1829	# let's treat SSL-eof as we treat normal EOF
…		…
1473	$self->{_eof} = 1;	1831	$self->{_eof} = 1;
1474	}	1832	}
1475	}	1833	}
1476		1834
1477	$self->{_tls_rbuf} .= $tmp;	1835	$self->{_tls_rbuf} .= $tmp;
1478	$self->_drain_rbuf unless $self->{_in_drain};	1836	$self->_drain_rbuf;
1479	$self->{tls} or return; # tls session might have gone away in callback	1837	$self->{tls} or return; # tls session might have gone away in callback
1480	}	1838	}
1481		1839
1482	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1840	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1483	return $self->_tls_error ($tmp)	1841	return $self->_tls_error ($tmp)
…		…
1485	&& ($tmp != $ERROR_SYSCALL || $!);	1843	&& ($tmp != $ERROR_SYSCALL || $!);
1486		1844
1487	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1845	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1488	$self->{wbuf} .= $tmp;	1846	$self->{wbuf} .= $tmp;
1489	$self->_drain_wbuf;	1847	$self->_drain_wbuf;
		1848	$self->{tls} or return; # tls session might have gone away in callback
1490	}	1849	}
1491		1850
1492	$self->{_on_starttls}	1851	$self->{_on_starttls}
1493	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1852	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1494	and (delete $self->{_on_starttls})->($self, 1);	1853	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1495	}	1854	}
1496		1855
1497	=item $handle->starttls ($tls[, $tls_ctx])	1856	=item $handle->starttls ($tls[, $tls_ctx])
1498		1857
1499	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1858	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1500	object is created, you can also do that at a later time by calling	1859	object is created, you can also do that at a later time by calling
1501	C<starttls>.	1860	C<starttls>.
		1861
		1862	Starting TLS is currently an asynchronous operation - when you push some
		1863	write data and then call C<< ->starttls >> then TLS negotiation will start
		1864	immediately, after which the queued write data is then sent.
1502		1865
1503	The first argument is the same as the C<tls> constructor argument (either	1866	The first argument is the same as the C<tls> constructor argument (either
1504	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1867	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1505		1868
1506	The second argument is the optional C<AnyEvent::TLS> object that is used	1869	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1511	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1874	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1512	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1875	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1513	changed to your liking. Note that the handshake might have already started	1876	changed to your liking. Note that the handshake might have already started
1514	when this function returns.	1877	when this function returns.
1515		1878
1516	If it an error to start a TLS handshake more than once per	1879	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1517	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1880	handshakes on the same stream. It is best to not attempt to use the
		1881	stream after stopping TLS.
		1882
		1883	This method may invoke callbacks (and therefore the handle might be
		1884	destroyed after it returns).
1518		1885
1519	=cut	1886	=cut
1520		1887
1521	our %TLS_CACHE; #TODO not yet documented, should we?	1888	our %TLS_CACHE; #TODO not yet documented, should we?
1522		1889
1523	sub starttls {	1890	sub starttls {
1524	my ($self, $ssl, $ctx) = @_;	1891	my ($self, $tls, $ctx) = @_;
		1892
		1893	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1894	if $self->{tls};
		1895
		1896	$self->{tls} = $tls;
		1897	$self->{tls_ctx} = $ctx if @_ > 2;
		1898
		1899	return unless $self->{fh};
1525		1900
1526	require Net::SSLeay;	1901	require Net::SSLeay;
1527
1528	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1529	if $self->{tls};
1530		1902
1531	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1903	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1532	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1904	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1533		1905
		1906	$tls = delete $self->{tls};
1534	$ctx ||= $self->{tls_ctx};	1907	$ctx = $self->{tls_ctx};
		1908
		1909	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1535		1910
1536	if ("HASH" eq ref $ctx) {	1911	if ("HASH" eq ref $ctx) {
1537	require AnyEvent::TLS;	1912	require AnyEvent::TLS;
1538
1539	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1540		1913
1541	if ($ctx->{cache}) {	1914	if ($ctx->{cache}) {
1542	my $key = $ctx+0;	1915	my $key = $ctx+0;
1543	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;	1916	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1544	} else {	1917	} else {
1545	$ctx = new AnyEvent::TLS %$ctx;	1918	$ctx = new AnyEvent::TLS %$ctx;
1546	}	1919	}
1547	}	1920	}
1548		1921
1549	$self->{tls_ctx} = $ctx || TLS_CTX ();	1922	$self->{tls_ctx} = $ctx || TLS_CTX ();
1550	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1923	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1551		1924
1552	# basically, this is deep magic (because SSL_read should have the same issues)	1925	# basically, this is deep magic (because SSL_read should have the same issues)
1553	# but the openssl maintainers basically said: "trust us, it just works".	1926	# but the openssl maintainers basically said: "trust us, it just works".
1554	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1927	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1555	# and mismaintained ssleay-module doesn't even offer them).	1928	# and mismaintained ssleay-module doesn't even offer them).
…		…
1562	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1935	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1563	# have identity issues in that area.	1936	# have identity issues in that area.
1564	# Net::SSLeay::CTX_set_mode ($ssl,	1937	# Net::SSLeay::CTX_set_mode ($ssl,
1565	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1938	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1566	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1939	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1567	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	1940	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1568		1941
1569	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1942	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1570	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1943	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1571		1944
		1945	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1946
1572	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1947	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1573		1948
1574	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1949	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1575	if exists $self->{on_starttls};	1950	if $self->{on_starttls};
1576		1951
1577	&_dotls; # need to trigger the initial handshake	1952	&_dotls; # need to trigger the initial handshake
1578	$self->start_read; # make sure we actually do read	1953	$self->start_read; # make sure we actually do read
1579	}	1954	}
1580		1955
1581	=item $handle->stoptls	1956	=item $handle->stoptls
1582		1957
1583	Shuts down the SSL connection - this makes a proper EOF handshake by	1958	Shuts down the SSL connection - this makes a proper EOF handshake by
1584	sending a close notify to the other side, but since OpenSSL doesn't	1959	sending a close notify to the other side, but since OpenSSL doesn't
1585	support non-blocking shut downs, it is not possible to re-use the stream	1960	support non-blocking shut downs, it is not guaranteed that you can re-use
1586	afterwards.	1961	the stream afterwards.
		1962
		1963	This method may invoke callbacks (and therefore the handle might be
		1964	destroyed after it returns).
1587		1965
1588	=cut	1966	=cut
1589		1967
1590	sub stoptls {	1968	sub stoptls {
1591	my ($self) = @_;	1969	my ($self) = @_;
1592		1970
1593	if ($self->{tls}) {	1971	if ($self->{tls} && $self->{fh}) {
1594	Net::SSLeay::shutdown ($self->{tls});	1972	Net::SSLeay::shutdown ($self->{tls});
1595		1973
1596	&_dotls;	1974	&_dotls;
1597		1975
1598	# # we don't give a shit. no, we do, but we can't. no...#d#	1976	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1604	sub _freetls {	1982	sub _freetls {
1605	my ($self) = @_;	1983	my ($self) = @_;
1606		1984
1607	return unless $self->{tls};	1985	return unless $self->{tls};
1608		1986
1609	$self->{_on_starttls}
1610	and (delete $self->{_on_starttls})->($self, undef);
1611
1612	$self->{tls_ctx}->_put_session (delete $self->{tls});	1987	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1988	if $self->{tls} > 0;
1613		1989
1614	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1990	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1615	}	1991	}
1616		1992
1617	sub DESTROY {	1993	sub DESTROY {
1618	my ($self) = @_;	1994	my ($self) = @_;
1619		1995
1620	&_freetls;	1996	&_freetls;
1621		1997
1622	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1998	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1623		1999
1624	if ($linger && length $self->{wbuf}) {	2000	if ($linger && length $self->{wbuf} && $self->{fh}) {
1625	my $fh = delete $self->{fh};	2001	my $fh = delete $self->{fh};
1626	my $wbuf = delete $self->{wbuf};	2002	my $wbuf = delete $self->{wbuf};
1627		2003
1628	my @linger;	2004	my @linger;
1629		2005
1630	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2006	push @linger, AE::io $fh, 1, sub {
1631	my $len = syswrite $fh, $wbuf, length $wbuf;	2007	my $len = syswrite $fh, $wbuf, length $wbuf;
1632		2008
1633	if ($len > 0) {	2009	if ($len > 0) {
1634	substr $wbuf, 0, $len, "";	2010	substr $wbuf, 0, $len, "";
1635	} else {	2011	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1636	@linger = (); # end	2012	@linger = (); # end
1637	}	2013	}
1638	});	2014	};
1639	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2015	push @linger, AE::timer $linger, 0, sub {
1640	@linger = ();	2016	@linger = ();
1641	});	2017	};
1642	}	2018	}
1643	}	2019	}
1644		2020
1645	=item $handle->destroy	2021	=item $handle->destroy
1646		2022
1647	Shuts down the handle object as much as possible - this call ensures that	2023	Shuts down the handle object as much as possible - this call ensures that
1648	no further callbacks will be invoked and as many resources as possible	2024	no further callbacks will be invoked and as many resources as possible
1649	will be freed. You must not call any methods on the object afterwards.	2025	will be freed. Any method you will call on the handle object after
		2026	destroying it in this way will be silently ignored (and it will return the
		2027	empty list).
1650		2028
1651	Normally, you can just "forget" any references to an AnyEvent::Handle	2029	Normally, you can just "forget" any references to an AnyEvent::Handle
1652	object and it will simply shut down. This works in fatal error and EOF	2030	object and it will simply shut down. This works in fatal error and EOF
1653	callbacks, as well as code outside. It does I<NOT> work in a read or write	2031	callbacks, as well as code outside. It does I<NOT> work in a read or write
1654	callback, so when you want to destroy the AnyEvent::Handle object from	2032	callback, so when you want to destroy the AnyEvent::Handle object from
1655	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	2033	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1656	that case.	2034	that case.
1657		2035
		2036	Destroying the handle object in this way has the advantage that callbacks
		2037	will be removed as well, so if those are the only reference holders (as
		2038	is common), then one doesn't need to do anything special to break any
		2039	reference cycles.
		2040
1658	The handle might still linger in the background and write out remaining	2041	The handle might still linger in the background and write out remaining
1659	data, as specified by the C<linger> option, however.	2042	data, as specified by the C<linger> option, however.
1660		2043
1661	=cut	2044	=cut
1662		2045
1663	sub destroy {	2046	sub destroy {
1664	my ($self) = @_;	2047	my ($self) = @_;
1665		2048
1666	$self->DESTROY;	2049	$self->DESTROY;
1667	%$self = ();	2050	%$self = ();
		2051	bless $self, "AnyEvent::Handle::destroyed";
1668	}	2052	}
		2053
		2054	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2055	#nop
		2056	}
		2057
		2058	=item $handle->destroyed
		2059
		2060	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2061	->destroy >>, true otherwise.
		2062
		2063	Can be useful to decide whether the handle is still valid after some
		2064	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2065	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2066	can destroy the handle, so work can be avoided by checking sometimes:
		2067
		2068	$hdl->starttls ("accept");
		2069	return if $hdl->destroyed;
		2070	$hdl->push_write (...
		2071
		2072	Note that the call to C<push_write> will silently be ignored if the handle
		2073	has been destroyed, so often you can just ignore the possibility of the
		2074	handle being destroyed.
		2075
		2076	=cut
		2077
		2078	sub destroyed { 0 }
		2079	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1669		2080
1670	=item AnyEvent::Handle::TLS_CTX	2081	=item AnyEvent::Handle::TLS_CTX
1671		2082
1672	This function creates and returns the AnyEvent::TLS object used by default	2083	This function creates and returns the AnyEvent::TLS object used by default
1673	for TLS mode.	2084	for TLS mode.
…		…
1705		2116
1706	=item I get different callback invocations in TLS mode/Why can't I pause	2117	=item I get different callback invocations in TLS mode/Why can't I pause
1707	reading?	2118	reading?
1708		2119
1709	Unlike, say, TCP, TLS connections do not consist of two independent	2120	Unlike, say, TCP, TLS connections do not consist of two independent
1710	communication channels, one for each direction. Or put differently. The	2121	communication channels, one for each direction. Or put differently, the
1711	read and write directions are not independent of each other: you cannot	2122	read and write directions are not independent of each other: you cannot
1712	write data unless you are also prepared to read, and vice versa.	2123	write data unless you are also prepared to read, and vice versa.
1713		2124
1714	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2125	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1715	callback invocations when you are not expecting any read data - the reason	2126	callback invocations when you are not expecting any read data - the reason
1716	is that AnyEvent::Handle always reads in TLS mode.	2127	is that AnyEvent::Handle always reads in TLS mode.
1717		2128
1718	During the connection, you have to make sure that you always have a	2129	During the connection, you have to make sure that you always have a
1719	non-empty read-queue, or an C<on_read> watcher. At the end of the	2130	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1729		2140
1730	$handle->on_read (sub { });	2141	$handle->on_read (sub { });
1731	$handle->on_eof (undef);	2142	$handle->on_eof (undef);
1732	$handle->on_error (sub {	2143	$handle->on_error (sub {
1733	my $data = delete $_[0]{rbuf};	2144	my $data = delete $_[0]{rbuf};
1734	undef $handle;
1735	});	2145	});
1736		2146
1737	The reason to use C<on_error> is that TCP connections, due to latencies	2147	The reason to use C<on_error> is that TCP connections, due to latencies
1738	and packets loss, might get closed quite violently with an error, when in	2148	and packets loss, might get closed quite violently with an error, when in
1739	fact, all data has been received.	2149	fact all data has been received.
1740		2150
1741	It is usually better to use acknowledgements when transferring data,	2151	It is usually better to use acknowledgements when transferring data,
1742	to make sure the other side hasn't just died and you got the data	2152	to make sure the other side hasn't just died and you got the data
1743	intact. This is also one reason why so many internet protocols have an	2153	intact. This is also one reason why so many internet protocols have an
1744	explicit QUIT command.	2154	explicit QUIT command.
…		…
1755	$handle->on_drain (sub {	2165	$handle->on_drain (sub {
1756	warn "all data submitted to the kernel\n";	2166	warn "all data submitted to the kernel\n";
1757	undef $handle;	2167	undef $handle;
1758	});	2168	});
1759		2169
		2170	If you just want to queue some data and then signal EOF to the other side,
		2171	consider using C<< ->push_shutdown >> instead.
		2172
		2173	=item I want to contact a TLS/SSL server, I don't care about security.
		2174
		2175	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2176	connect to it and then create the AnyEvent::Handle with the C<tls>
		2177	parameter:
		2178
		2179	tcp_connect $host, $port, sub {
		2180	my ($fh) = @_;
		2181
		2182	my $handle = new AnyEvent::Handle
		2183	fh => $fh,
		2184	tls => "connect",
		2185	on_error => sub { ... };
		2186
		2187	$handle->push_write (...);
		2188	};
		2189
		2190	=item I want to contact a TLS/SSL server, I do care about security.
		2191
		2192	Then you should additionally enable certificate verification, including
		2193	peername verification, if the protocol you use supports it (see
		2194	L<AnyEvent::TLS>, C<verify_peername>).
		2195
		2196	E.g. for HTTPS:
		2197
		2198	tcp_connect $host, $port, sub {
		2199	my ($fh) = @_;
		2200
		2201	my $handle = new AnyEvent::Handle
		2202	fh => $fh,
		2203	peername => $host,
		2204	tls => "connect",
		2205	tls_ctx => { verify => 1, verify_peername => "https" },
		2206	...
		2207
		2208	Note that you must specify the hostname you connected to (or whatever
		2209	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2210	peername verification will be done.
		2211
		2212	The above will use the system-dependent default set of trusted CA
		2213	certificates. If you want to check against a specific CA, add the
		2214	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2215
		2216	tls_ctx => {
		2217	verify => 1,
		2218	verify_peername => "https",
		2219	ca_file => "my-ca-cert.pem",
		2220	},
		2221
		2222	=item I want to create a TLS/SSL server, how do I do that?
		2223
		2224	Well, you first need to get a server certificate and key. You have
		2225	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2226	self-signed certificate (cheap. check the search engine of your choice,
		2227	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2228	nice program for that purpose).
		2229
		2230	Then create a file with your private key (in PEM format, see
		2231	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2232	file should then look like this:
		2233
		2234	-----BEGIN RSA PRIVATE KEY-----
		2235	...header data
		2236	... lots of base64'y-stuff
		2237	-----END RSA PRIVATE KEY-----
		2238
		2239	-----BEGIN CERTIFICATE-----
		2240	... lots of base64'y-stuff
		2241	-----END CERTIFICATE-----
		2242
		2243	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2244	specify this file as C<cert_file>:
		2245
		2246	tcp_server undef, $port, sub {
		2247	my ($fh) = @_;
		2248
		2249	my $handle = new AnyEvent::Handle
		2250	fh => $fh,
		2251	tls => "accept",
		2252	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2253	...
		2254
		2255	When you have intermediate CA certificates that your clients might not
		2256	know about, just append them to the C<cert_file>.
		2257
1760	=back	2258	=back
1761		2259
1762		2260
1763	=head1 SUBCLASSING AnyEvent::Handle	2261	=head1 SUBCLASSING AnyEvent::Handle
1764		2262
…		…
1783		2281
1784	=item * all members not documented here and not prefixed with an underscore	2282	=item * all members not documented here and not prefixed with an underscore
1785	are free to use in subclasses.	2283	are free to use in subclasses.
1786		2284
1787	Of course, new versions of AnyEvent::Handle may introduce more "public"	2285	Of course, new versions of AnyEvent::Handle may introduce more "public"
1788	member variables, but thats just life, at least it is documented.	2286	member variables, but that's just life. At least it is documented.
1789		2287
1790	=back	2288	=back
1791		2289
1792	=head1 AUTHOR	2290	=head1 AUTHOR
1793		2291

Diff Legend

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