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.83 by root, Thu Aug 21 19:11:37 2008 UTC vs.
Revision 1.188 by root, Thu Sep 17 08:20:14 2009 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 file handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.232;
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 {
32	$cv->broadcast;	15	my ($hdl, $fatal, $msg) = @_;
33	},	16	warn "got error $msg\n";
		17	$hdl->destroy;
		18	$cv->send;
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 module 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	filehandles.
52	on sockets see L<AnyEvent::Util>.	37
		38	The L<AnyEvent::Intro> tutorial contains some well-documented
		39	AnyEvent::Handle examples.
53		40
54	In the following, when the documentation refers to of "bytes" then this	41	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	42	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
57		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
58	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
59	argument.	49	argument.
60		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
61	=head1 METHODS	80	=head1 METHODS
62		81
63	=over 4	82	=over 4
64		83
65	=item B<new (%args)>	84	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
66		85
67	The constructor supports these arguments (all as key => value pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
68		87
69	=over 4	88	=over 4
70		89
71	=item fh => $filehandle [MANDATORY]	90	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
72		91
73	The filehandle this L<AnyEvent::Handle> object will operate on.	92	The filehandle this L<AnyEvent::Handle> object will operate on.
74
75	NOTE: The filehandle will be set to non-blocking mode (using	93	NOTE: The filehandle will be set to non-blocking mode (using
76	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
77	that mode.	95	that mode.
78		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
79	=item on_eof => $cb->($handle)	114	=item on_prepare => $cb->($handle)
80		115
81	Set the callback to be called when an end-of-file condition is detected,	116	This (rarely used) callback is called before a new connection is
82	i.e. in the case of a socket, when the other side has closed the	117	attempted, but after the file handle has been created. It could be used to
83	connection cleanly.	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).
84		121
85	For sockets, this just means that the other side has stopped sending data,	122	The return value of this callback should be the connect timeout value in
86	you can still try to write data, and, in fact, one can return from the eof	123	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
87	callback and continue writing data, as only the read part has been shut	124	timeout is to be used).
88	down.
89		125
90	While not mandatory, it is I<highly> recommended to set an eof callback,	126	=item on_connect => $cb->($handle, $host, $port, $retry->())
91	otherwise you might end up with a closed socket while you are still
92	waiting for data.
93		127
94	If an EOF condition has been detected but no C<on_eof> callback has been	128	This callback is called when a connection has been successfully established.
95	set, then a fatal error will be raised with C<$!> set to <0>.
96		129
		130	The actual numeric host and port (the socket peername) are passed as
		131	parameters, together with a retry callback.
		132
		133	When, for some reason, the handle is not acceptable, then calling
		134	C<$retry> will continue with the next connection target (in case of
		135	multi-homed hosts or SRV records there can be multiple connection
		136	endpoints). At the time it is called the read and write queues, eof
		137	status, tls status and similar properties of the handle will have been
		138	reset.
		139
		140	In most cases, ignoring the C<$retry> parameter is the way to go.
		141
		142	=item on_connect_error => $cb->($handle, $message)
		143
		144	This callback is called when the connection could not be
		145	established. C<$!> will contain the relevant error code, and C<$message> a
		146	message describing it (usually the same as C<"$!">).
		147
		148	If this callback isn't specified, then C<on_error> will be called with a
		149	fatal error instead.
		150
		151	=back
		152
97	=item on_error => $cb->($handle, $fatal)	153	=item on_error => $cb->($handle, $fatal, $message)
98		154
99	This is the error callback, which is called when, well, some error	155	This is the error callback, which is called when, well, some error
100	occured, such as not being able to resolve the hostname, failure to	156	occured, such as not being able to resolve the hostname, failure to
101	connect or a read error.	157	connect or a read error.
102		158
103	Some errors are fatal (which is indicated by C<$fatal> being true). On	159	Some errors are fatal (which is indicated by C<$fatal> being true). On
104	fatal errors the handle object will be shut down and will not be usable	160	fatal errors the handle object will be destroyed (by a call to C<< ->
105	(but you are free to look at the current C< ->rbuf >). Examples of fatal	161	destroy >>) after invoking the error callback (which means you are free to
106	errors are an EOF condition with active (but unsatisifable) read watchers	162	examine the handle object). Examples of fatal errors are an EOF condition
107	(C<EPIPE>) or I/O errors.	163	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		164	cases where the other side can close the connection at their will it is
		165	often easiest to not report C<EPIPE> errors in this callback.
		166
		167	AnyEvent::Handle tries to find an appropriate error code for you to check
		168	against, but in some cases (TLS errors), this does not work well. It is
		169	recommended to always output the C<$message> argument in human-readable
		170	error messages (it's usually the same as C<"$!">).
108		171
109	Non-fatal errors can be retried by simply returning, but it is recommended	172	Non-fatal errors can be retried by simply returning, but it is recommended
110	to simply ignore this parameter and instead abondon the handle object	173	to simply ignore this parameter and instead abondon the handle object
111	when this callback is invoked. Examples of non-fatal errors are timeouts	174	when this callback is invoked. Examples of non-fatal errors are timeouts
112	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	175	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
113		176
114	On callback entrance, the value of C<$!> contains the operating system	177	On callback entrance, the value of C<$!> contains the operating system
115	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	178	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		179	C<EPROTO>).
116		180
117	While not mandatory, it is I<highly> recommended to set this callback, as	181	While not mandatory, it is I<highly> recommended to set this callback, as
118	you will not be notified of errors otherwise. The default simply calls	182	you will not be notified of errors otherwise. The default simply calls
119	C<croak>.	183	C<croak>.
120		184
…		…
124	and no read request is in the queue (unlike read queue callbacks, this	188	and no read request is in the queue (unlike read queue callbacks, this
125	callback will only be called when at least one octet of data is in the	189	callback will only be called when at least one octet of data is in the
126	read buffer).	190	read buffer).
127		191
128	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	192	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
129	method or access the C<$handle->{rbuf}> member directly.	193	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		194	must not enlarge or modify the read buffer, you can only remove data at
		195	the beginning from it.
130		196
131	When an EOF condition is detected then AnyEvent::Handle will first try to	197	When an EOF condition is detected then AnyEvent::Handle will first try to
132	feed all the remaining data to the queued callbacks and C<on_read> before	198	feed all the remaining data to the queued callbacks and C<on_read> before
133	calling the C<on_eof> callback. If no progress can be made, then a fatal	199	calling the C<on_eof> callback. If no progress can be made, then a fatal
134	error will be raised (with C<$!> set to C<EPIPE>).	200	error will be raised (with C<$!> set to C<EPIPE>).
		201
		202	Note that, unlike requests in the read queue, an C<on_read> callback
		203	doesn't mean you I<require> some data: if there is an EOF and there
		204	are outstanding read requests then an error will be flagged. With an
		205	C<on_read> callback, the C<on_eof> callback will be invoked.
		206
		207	=item on_eof => $cb->($handle)
		208
		209	Set the callback to be called when an end-of-file condition is detected,
		210	i.e. in the case of a socket, when the other side has closed the
		211	connection cleanly, and there are no outstanding read requests in the
		212	queue (if there are read requests, then an EOF counts as an unexpected
		213	connection close and will be flagged as an error).
		214
		215	For sockets, this just means that the other side has stopped sending data,
		216	you can still try to write data, and, in fact, one can return from the EOF
		217	callback and continue writing data, as only the read part has been shut
		218	down.
		219
		220	If an EOF condition has been detected but no C<on_eof> callback has been
		221	set, then a fatal error will be raised with C<$!> set to <0>.
135		222
136	=item on_drain => $cb->($handle)	223	=item on_drain => $cb->($handle)
137		224
138	This sets the callback that is called when the write buffer becomes empty	225	This sets the callback that is called when the write buffer becomes empty
139	(or when the callback is set and the buffer is empty already).	226	(or when the callback is set and the buffer is empty already).
…		…
146	memory and push it into the queue, but instead only read more data from	233	memory and push it into the queue, but instead only read more data from
147	the file when the write queue becomes empty.	234	the file when the write queue becomes empty.
148		235
149	=item timeout => $fractional_seconds	236	=item timeout => $fractional_seconds
150		237
		238	=item rtimeout => $fractional_seconds
		239
		240	=item wtimeout => $fractional_seconds
		241
151	If non-zero, then this enables an "inactivity" timeout: whenever this many	242	If non-zero, then these enables an "inactivity" timeout: whenever this
152	seconds pass without a successful read or write on the underlying file	243	many seconds pass without a successful read or write on the underlying
153	handle, the C<on_timeout> callback will be invoked (and if that one is	244	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
154	missing, an C<ETIMEDOUT> error will be raised).	245	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		246	error will be raised).
		247
		248	There are three variants of the timeouts that work fully independent
		249	of each other, for both read and write, just read, and just write:
		250	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		251	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		252	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
155		253
156	Note that timeout processing is also active when you currently do not have	254	Note that timeout processing is also active when you currently do not have
157	any outstanding read or write requests: If you plan to keep the connection	255	any outstanding read or write requests: If you plan to keep the connection
158	idle then you should disable the timout temporarily or ignore the timeout	256	idle then you should disable the timout temporarily or ignore the timeout
159	in the C<on_timeout> callback.	257	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		258	restart the timeout.
160		259
161	Zero (the default) disables this timeout.	260	Zero (the default) disables this timeout.
162		261
163	=item on_timeout => $cb->($handle)	262	=item on_timeout => $cb->($handle)
164		263
…		…
168		267
169	=item rbuf_max => <bytes>	268	=item rbuf_max => <bytes>
170		269
171	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	270	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
172	when the read buffer ever (strictly) exceeds this size. This is useful to	271	when the read buffer ever (strictly) exceeds this size. This is useful to
173	avoid denial-of-service attacks.	272	avoid some forms of denial-of-service attacks.
174		273
175	For example, a server accepting connections from untrusted sources should	274	For example, a server accepting connections from untrusted sources should
176	be configured to accept only so-and-so much data that it cannot act on	275	be configured to accept only so-and-so much data that it cannot act on
177	(for example, when expecting a line, an attacker could send an unlimited	276	(for example, when expecting a line, an attacker could send an unlimited
178	amount of data without a callback ever being called as long as the line	277	amount of data without a callback ever being called as long as the line
179	isn't finished).	278	isn't finished).
180		279
181	=item autocork => <boolean>	280	=item autocork => <boolean>
182		281
183	When disabled (the default), then C<push_write> will try to immediately	282	When disabled (the default), then C<push_write> will try to immediately
184	write the data to the handle if possible. This avoids having to register	283	write the data to the handle, if possible. This avoids having to register
185	a write watcher and wait for the next event loop iteration, but can be	284	a write watcher and wait for the next event loop iteration, but can
186	inefficient if you write multiple small chunks (this disadvantage is	285	be inefficient if you write multiple small chunks (on the wire, this
187	usually avoided by your kernel's nagle algorithm, see C<low_delay>).	286	disadvantage is usually avoided by your kernel's nagle algorithm, see
		287	C<no_delay>, but this option can save costly syscalls).
188		288
189	When enabled, then writes will always be queued till the next event loop	289	When enabled, then writes will always be queued till the next event loop
190	iteration. This is efficient when you do many small writes per iteration,	290	iteration. This is efficient when you do many small writes per iteration,
191	but less efficient when you do a single write only.	291	but less efficient when you do a single write only per iteration (or when
		292	the write buffer often is full). It also increases write latency.
192		293
193	=item no_delay => <boolean>	294	=item no_delay => <boolean>
194		295
195	When doing small writes on sockets, your operating system kernel might	296	When doing small writes on sockets, your operating system kernel might
196	wait a bit for more data before actually sending it out. This is called	297	wait a bit for more data before actually sending it out. This is called
197	the Nagle algorithm, and usually it is beneficial.	298	the Nagle algorithm, and usually it is beneficial.
198		299
199	In some situations you want as low a delay as possible, which cna be	300	In some situations you want as low a delay as possible, which can be
200	accomplishd by setting this option to true.	301	accomplishd by setting this option to a true value.
201		302
202	The default is your opertaing system's default behaviour, this option	303	The default is your opertaing system's default behaviour (most likely
203	explicitly enables or disables it, if possible.	304	enabled), this option explicitly enables or disables it, if possible.
		305
		306	=item keepalive => <boolean>
		307
		308	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		309	normally, TCP connections have no time-out once established, so TCP
		310	connections, once established, can stay alive forever even when the other
		311	side has long gone. TCP keepalives are a cheap way to take down long-lived
		312	TCP connections whent he other side becomes unreachable. While the default
		313	is OS-dependent, TCP keepalives usually kick in after around two hours,
		314	and, if the other side doesn't reply, take down the TCP connection some 10
		315	to 15 minutes later.
		316
		317	It is harmless to specify this option for file handles that do not support
		318	keepalives, and enabling it on connections that are potentially long-lived
		319	is usually a good idea.
		320
		321	=item oobinline => <boolean>
		322
		323	BSD majorly fucked up the implementation of TCP urgent data. The result
		324	is that almost no OS implements TCP according to the specs, and every OS
		325	implements it slightly differently.
		326
		327	If you want to handle TCP urgent data, then setting this flag (the default
		328	is enabled) gives you the most portable way of getting urgent data, by
		329	putting it into the stream.
		330
		331	Since BSD emulation of OOB data on top of TCP's urgent data can have
		332	security implications, AnyEvent::Handle sets this flag automatically
		333	unless explicitly specified. Note that setting this flag after
		334	establishing a connection I<may> be a bit too late (data loss could
		335	already have occured on BSD systems), but at least it will protect you
		336	from most attacks.
204		337
205	=item read_size => <bytes>	338	=item read_size => <bytes>
206		339
207	The default read block size (the amount of bytes this module will try to read	340	The default read block size (the amount of bytes this module will
208	during each (loop iteration). Default: C<8192>.	341	try to read during each loop iteration, which affects memory
		342	requirements). Default: C<8192>.
209		343
210	=item low_water_mark => <bytes>	344	=item low_water_mark => <bytes>
211		345
212	Sets the amount of bytes (default: C<0>) that make up an "empty" write	346	Sets the amount of bytes (default: C<0>) that make up an "empty" write
213	buffer: If the write reaches this size or gets even samller it is	347	buffer: If the write reaches this size or gets even samller it is
214	considered empty.	348	considered empty.
215		349
		350	Sometimes it can be beneficial (for performance reasons) to add data to
		351	the write buffer before it is fully drained, but this is a rare case, as
		352	the operating system kernel usually buffers data as well, so the default
		353	is good in almost all cases.
		354
216	=item linger => <seconds>	355	=item linger => <seconds>
217		356
218	If non-zero (default: C<3600>), then the destructor of the	357	If non-zero (default: C<3600>), then the destructor of the
219	AnyEvent::Handle object will check wether there is still outstanding write	358	AnyEvent::Handle object will check whether there is still outstanding
220	data and will install a watcher that will write out this data. No errors	359	write data and will install a watcher that will write this data to the
221	will be reported (this mostly matches how the operating system treats	360	socket. No errors will be reported (this mostly matches how the operating
222	outstanding data at socket close time).	361	system treats outstanding data at socket close time).
223		362
224	This will not work for partial TLS data that could not yet been	363	This will not work for partial TLS data that could not be encoded
225	encoded. This data will be lost.	364	yet. This data will be lost. Calling the C<stoptls> method in time might
		365	help.
		366
		367	=item peername => $string
		368
		369	A string used to identify the remote site - usually the DNS hostname
		370	(I<not> IDN!) used to create the connection, rarely the IP address.
		371
		372	Apart from being useful in error messages, this string is also used in TLS
		373	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		374	verification will be skipped when C<peername> is not specified or
		375	C<undef>.
226		376
227	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	377	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
228		378
229	When this parameter is given, it enables TLS (SSL) mode, that means it	379	When this parameter is given, it enables TLS (SSL) mode, that means
230	will start making tls handshake and will transparently encrypt/decrypt	380	AnyEvent will start a TLS handshake as soon as the connection has been
231	data.	381	established and will transparently encrypt/decrypt data afterwards.
		382
		383	All TLS protocol errors will be signalled as C<EPROTO>, with an
		384	appropriate error message.
232		385
233	TLS mode requires Net::SSLeay to be installed (it will be loaded	386	TLS mode requires Net::SSLeay to be installed (it will be loaded
234	automatically when you try to create a TLS handle).	387	automatically when you try to create a TLS handle): this module doesn't
		388	have a dependency on that module, so if your module requires it, you have
		389	to add the dependency yourself.
235		390
236	For the TLS server side, use C<accept>, and for the TLS client side of a	391	Unlike TCP, TLS has a server and client side: for the TLS server side, use
237	connection, use C<connect> mode.	392	C<accept>, and for the TLS client side of a connection, use C<connect>
		393	mode.
238		394
239	You can also provide your own TLS connection object, but you have	395	You can also provide your own TLS connection object, but you have
240	to make sure that you call either C<Net::SSLeay::set_connect_state>	396	to make sure that you call either C<Net::SSLeay::set_connect_state>
241	or C<Net::SSLeay::set_accept_state> on it before you pass it to	397	or C<Net::SSLeay::set_accept_state> on it before you pass it to
242	AnyEvent::Handle.	398	AnyEvent::Handle. Also, this module will take ownership of this connection
		399	object.
243		400
		401	At some future point, AnyEvent::Handle might switch to another TLS
		402	implementation, then the option to use your own session object will go
		403	away.
		404
		405	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		406	passing in the wrong integer will lead to certain crash. This most often
		407	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		408	segmentation fault.
		409
244	See the C<starttls> method if you need to start TLS negotiation later.	410	See the C<< ->starttls >> method for when need to start TLS negotiation later.
245		411
246	=item tls_ctx => $ssl_ctx	412	=item tls_ctx => $anyevent_tls
247		413
248	Use the given Net::SSLeay::CTX object to create the new TLS connection	414	Use the given C<AnyEvent::TLS> object to create the new TLS connection
249	(unless a connection object was specified directly). If this parameter is	415	(unless a connection object was specified directly). If this parameter is
250	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	416	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
251		417
		418	Instead of an object, you can also specify a hash reference with C<< key
		419	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		420	new TLS context object.
		421
		422	=item on_starttls => $cb->($handle, $success[, $error_message])
		423
		424	This callback will be invoked when the TLS/SSL handshake has finished. If
		425	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		426	(C<on_stoptls> will not be called in this case).
		427
		428	The session in C<< $handle->{tls} >> can still be examined in this
		429	callback, even when the handshake was not successful.
		430
		431	TLS handshake failures will not cause C<on_error> to be invoked when this
		432	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		433
		434	Without this callback, handshake failures lead to C<on_error> being
		435	called, as normal.
		436
		437	Note that you cannot call C<starttls> right again in this callback. If you
		438	need to do that, start an zero-second timer instead whose callback can
		439	then call C<< ->starttls >> again.
		440
		441	=item on_stoptls => $cb->($handle)
		442
		443	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		444	set, then it will be invoked after freeing the TLS session. If it is not,
		445	then a TLS shutdown condition will be treated like a normal EOF condition
		446	on the handle.
		447
		448	The session in C<< $handle->{tls} >> can still be examined in this
		449	callback.
		450
		451	This callback will only be called on TLS shutdowns, not when the
		452	underlying handle signals EOF.
		453
252	=item json => JSON or JSON::XS object	454	=item json => JSON or JSON::XS object
253		455
254	This is the json coder object used by the C<json> read and write types.	456	This is the json coder object used by the C<json> read and write types.
255		457
256	If you don't supply it, then AnyEvent::Handle will create and use a	458	If you don't supply it, then AnyEvent::Handle will create and use a
257	suitable one, which will write and expect UTF-8 encoded JSON texts.	459	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		460	texts.
258		461
259	Note that you are responsible to depend on the JSON module if you want to	462	Note that you are responsible to depend on the JSON module if you want to
260	use this functionality, as AnyEvent does not have a dependency itself.	463	use this functionality, as AnyEvent does not have a dependency itself.
261		464
262	=item filter_r => $cb
263
264	=item filter_w => $cb
265
266	These exist, but are undocumented at this time.
267
268	=back	465	=back
269		466
270	=cut	467	=cut
271		468
272	sub new {	469	sub new {
273	my $class = shift;	470	my $class = shift;
274
275	my $self = bless { @_ }, $class;	471	my $self = bless { @_ }, $class;
276		472
277	$self->{fh} or Carp::croak "mandatory argument fh is missing";	473	if ($self->{fh}) {
		474	$self->_start;
		475	return unless $self->{fh}; # could be gone by now
		476
		477	} elsif ($self->{connect}) {
		478	require AnyEvent::Socket;
		479
		480	$self->{peername} = $self->{connect}[0]
		481	unless exists $self->{peername};
		482
		483	$self->{_skip_drain_rbuf} = 1;
		484
		485	{
		486	Scalar::Util::weaken (my $self = $self);
		487
		488	$self->{_connect} =
		489	AnyEvent::Socket::tcp_connect (
		490	$self->{connect}[0],
		491	$self->{connect}[1],
		492	sub {
		493	my ($fh, $host, $port, $retry) = @_;
		494
		495	if ($fh) {
		496	$self->{fh} = $fh;
		497
		498	delete $self->{_skip_drain_rbuf};
		499	$self->_start;
		500
		501	$self->{on_connect}
		502	and $self->{on_connect}($self, $host, $port, sub {
		503	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		504	$self->{_skip_drain_rbuf} = 1;
		505	&$retry;
		506	});
		507
		508	} else {
		509	if ($self->{on_connect_error}) {
		510	$self->{on_connect_error}($self, "$!");
		511	$self->destroy;
		512	} else {
		513	$self->_error ($!, 1);
		514	}
		515	}
		516	},
		517	sub {
		518	local $self->{fh} = $_[0];
		519
		520	$self->{on_prepare}
		521	? $self->{on_prepare}->($self)
		522	: ()
		523	}
		524	);
		525	}
		526
		527	} else {
		528	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		529	}
		530
		531	$self
		532	}
		533
		534	sub _start {
		535	my ($self) = @_;
278		536
279	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	537	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
280		538
281	if ($self->{tls}) {	539	$self->{_activity} =
282	require Net::SSLeay;	540	$self->{_ractivity} =
		541	$self->{_wactivity} = AE::now;
		542
		543	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		544	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		545	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		546
		547	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		548	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
		549
		550	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		551
283	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	552	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
284	}	553	if $self->{tls};
285		554
286	$self->{_activity} = AnyEvent->now;
287	$self->_timeout;
288
289	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	555	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
290	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
291		556
292	$self->start_read	557	$self->start_read
293	if $self->{on_read};	558	if $self->{on_read} || @{ $self->{_queue} };
294		559
295	$self	560	$self->_drain_wbuf;
296	}
297
298	sub _shutdown {
299	my ($self) = @_;
300
301	delete $self->{_tw};
302	delete $self->{_rw};
303	delete $self->{_ww};
304	delete $self->{fh};
305
306	$self->stoptls;
307
308	delete $self->{on_read};
309	delete $self->{_queue};
310	}	561	}
311		562
312	sub _error {	563	sub _error {
313	my ($self, $errno, $fatal) = @_;	564	my ($self, $errno, $fatal, $message) = @_;
314
315	$self->_shutdown
316	if $fatal;
317		565
318	$! = $errno;	566	$! = $errno;
		567	$message ||= "$!";
319		568
320	if ($self->{on_error}) {	569	if ($self->{on_error}) {
321	$self->{on_error}($self, $fatal);	570	$self->{on_error}($self, $fatal, $message);
322	} else {	571	$self->destroy if $fatal;
		572	} elsif ($self->{fh} || $self->{connect}) {
		573	$self->destroy;
323	Carp::croak "AnyEvent::Handle uncaught error: $!";	574	Carp::croak "AnyEvent::Handle uncaught error: $message";
324	}	575	}
325	}	576	}
326		577
327	=item $fh = $handle->fh	578	=item $fh = $handle->fh
328		579
329	This method returns the file handle of the L<AnyEvent::Handle> object.	580	This method returns the file handle used to create the L<AnyEvent::Handle> object.
330		581
331	=cut	582	=cut
332		583
333	sub fh { $_[0]{fh} }	584	sub fh { $_[0]{fh} }
334		585
…		…
352	$_[0]{on_eof} = $_[1];	603	$_[0]{on_eof} = $_[1];
353	}	604	}
354		605
355	=item $handle->on_timeout ($cb)	606	=item $handle->on_timeout ($cb)
356		607
357	Replace the current C<on_timeout> callback, or disables the callback	608	=item $handle->on_rtimeout ($cb)
358	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
359	argument.
360		609
361	=cut	610	=item $handle->on_wtimeout ($cb)
362		611
363	sub on_timeout {	612	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
364	$_[0]{on_timeout} = $_[1];	613	callback, or disables the callback (but not the timeout) if C<$cb> =
365	}	614	C<undef>. See the C<timeout> constructor argument and method.
		615
		616	=cut
		617
		618	# see below
366		619
367	=item $handle->autocork ($boolean)	620	=item $handle->autocork ($boolean)
368		621
369	Enables or disables the current autocork behaviour (see C<autocork>	622	Enables or disables the current autocork behaviour (see C<autocork>
370	constructor argument).	623	constructor argument). Changes will only take effect on the next write.
371		624
372	=cut	625	=cut
		626
		627	sub autocork {
		628	$_[0]{autocork} = $_[1];
		629	}
373		630
374	=item $handle->no_delay ($boolean)	631	=item $handle->no_delay ($boolean)
375		632
376	Enables or disables the C<no_delay> setting (see constructor argument of	633	Enables or disables the C<no_delay> setting (see constructor argument of
377	the same name for details).	634	the same name for details).
…		…
381	sub no_delay {	638	sub no_delay {
382	$_[0]{no_delay} = $_[1];	639	$_[0]{no_delay} = $_[1];
383		640
384	eval {	641	eval {
385	local $SIG{__DIE__};	642	local $SIG{__DIE__};
386	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	643	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		644	if $_[0]{fh};
387	};	645	};
388	}	646	}
389		647
		648	=item $handle->keepalive ($boolean)
		649
		650	Enables or disables the C<keepalive> setting (see constructor argument of
		651	the same name for details).
		652
		653	=cut
		654
		655	sub keepalive {
		656	$_[0]{keepalive} = $_[1];
		657
		658	eval {
		659	local $SIG{__DIE__};
		660	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		661	if $_[0]{fh};
		662	};
		663	}
		664
		665	=item $handle->oobinline ($boolean)
		666
		667	Enables or disables the C<oobinline> setting (see constructor argument of
		668	the same name for details).
		669
		670	=cut
		671
		672	sub oobinline {
		673	$_[0]{oobinline} = $_[1];
		674
		675	eval {
		676	local $SIG{__DIE__};
		677	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		678	if $_[0]{fh};
		679	};
		680	}
		681
		682	=item $handle->keepalive ($boolean)
		683
		684	Enables or disables the C<keepalive> setting (see constructor argument of
		685	the same name for details).
		686
		687	=cut
		688
		689	sub keepalive {
		690	$_[0]{keepalive} = $_[1];
		691
		692	eval {
		693	local $SIG{__DIE__};
		694	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		695	if $_[0]{fh};
		696	};
		697	}
		698
		699	=item $handle->on_starttls ($cb)
		700
		701	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		702
		703	=cut
		704
		705	sub on_starttls {
		706	$_[0]{on_starttls} = $_[1];
		707	}
		708
		709	=item $handle->on_stoptls ($cb)
		710
		711	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		712
		713	=cut
		714
		715	sub on_starttls {
		716	$_[0]{on_stoptls} = $_[1];
		717	}
		718
		719	=item $handle->rbuf_max ($max_octets)
		720
		721	Configures the C<rbuf_max> setting (C<undef> disables it).
		722
		723	=cut
		724
		725	sub rbuf_max {
		726	$_[0]{rbuf_max} = $_[1];
		727	}
		728
390	#############################################################################	729	#############################################################################
391		730
392	=item $handle->timeout ($seconds)	731	=item $handle->timeout ($seconds)
393		732
		733	=item $handle->rtimeout ($seconds)
		734
		735	=item $handle->wtimeout ($seconds)
		736
394	Configures (or disables) the inactivity timeout.	737	Configures (or disables) the inactivity timeout.
395		738
396	=cut	739	=item $handle->timeout_reset
397		740
398	sub timeout {	741	=item $handle->rtimeout_reset
		742
		743	=item $handle->wtimeout_reset
		744
		745	Reset the activity timeout, as if data was received or sent.
		746
		747	These methods are cheap to call.
		748
		749	=cut
		750
		751	for my $dir ("", "r", "w") {
		752	my $timeout = "${dir}timeout";
		753	my $tw = "_${dir}tw";
		754	my $on_timeout = "on_${dir}timeout";
		755	my $activity = "_${dir}activity";
		756	my $cb;
		757
		758	*$on_timeout = sub {
		759	$_[0]{$on_timeout} = $_[1];
		760	};
		761
		762	*$timeout = sub {
399	my ($self, $timeout) = @_;	763	my ($self, $new_value) = @_;
400		764
401	$self->{timeout} = $timeout;	765	$self->{$timeout} = $new_value;
402	$self->_timeout;	766	delete $self->{$tw}; &$cb;
403	}	767	};
404		768
		769	*{"${dir}timeout_reset"} = sub {
		770	$_[0]{$activity} = AE::now;
		771	};
		772
		773	# main workhorse:
405	# reset the timeout watcher, as neccessary	774	# reset the timeout watcher, as neccessary
406	# also check for time-outs	775	# also check for time-outs
407	sub _timeout {	776	$cb = sub {
408	my ($self) = @_;	777	my ($self) = @_;
409		778
410	if ($self->{timeout}) {	779	if ($self->{$timeout} && $self->{fh}) {
411	my $NOW = AnyEvent->now;	780	my $NOW = AE::now;
412		781
413	# when would the timeout trigger?	782	# when would the timeout trigger?
414	my $after = $self->{_activity} + $self->{timeout} - $NOW;	783	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
415		784
416	# now or in the past already?	785	# now or in the past already?
417	if ($after <= 0) {	786	if ($after <= 0) {
418	$self->{_activity} = $NOW;	787	$self->{$activity} = $NOW;
419		788
420	if ($self->{on_timeout}) {	789	if ($self->{$on_timeout}) {
421	$self->{on_timeout}($self);	790	$self->{$on_timeout}($self);
422	} else {	791	} else {
423	$self->_error (&Errno::ETIMEDOUT);	792	$self->_error (Errno::ETIMEDOUT);
		793	}
		794
		795	# callback could have changed timeout value, optimise
		796	return unless $self->{$timeout};
		797
		798	# calculate new after
		799	$after = $self->{$timeout};
424	}	800	}
425		801
426	# callback could have changed timeout value, optimise	802	Scalar::Util::weaken $self;
427	return unless $self->{timeout};	803	return unless $self; # ->error could have destroyed $self
428		804
429	# calculate new after	805	$self->{$tw} ||= AE::timer $after, 0, sub {
430	$after = $self->{timeout};	806	delete $self->{$tw};
		807	$cb->($self);
		808	};
		809	} else {
		810	delete $self->{$tw};
431	}	811	}
432
433	Scalar::Util::weaken $self;
434	return unless $self; # ->error could have destroyed $self
435
436	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
437	delete $self->{_tw};
438	$self->_timeout;
439	});
440	} else {
441	delete $self->{_tw};
442	}	812	}
443	}	813	}
444		814
445	#############################################################################	815	#############################################################################
446		816
…		…
470	my ($self, $cb) = @_;	840	my ($self, $cb) = @_;
471		841
472	$self->{on_drain} = $cb;	842	$self->{on_drain} = $cb;
473		843
474	$cb->($self)	844	$cb->($self)
475	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	845	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
476	}	846	}
477		847
478	=item $handle->push_write ($data)	848	=item $handle->push_write ($data)
479		849
480	Queues the given scalar to be written. You can push as much data as you	850	Queues the given scalar to be written. You can push as much data as you
…		…
491	Scalar::Util::weaken $self;	861	Scalar::Util::weaken $self;
492		862
493	my $cb = sub {	863	my $cb = sub {
494	my $len = syswrite $self->{fh}, $self->{wbuf};	864	my $len = syswrite $self->{fh}, $self->{wbuf};
495		865
496	if ($len >= 0) {	866	if (defined $len) {
497	substr $self->{wbuf}, 0, $len, "";	867	substr $self->{wbuf}, 0, $len, "";
498		868
499	$self->{_activity} = AnyEvent->now;	869	$self->{_activity} = $self->{_wactivity} = AE::now;
500		870
501	$self->{on_drain}($self)	871	$self->{on_drain}($self)
502	if $self->{low_water_mark} >= length $self->{wbuf}	872	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
503	&& $self->{on_drain};	873	&& $self->{on_drain};
504		874
505	delete $self->{_ww} unless length $self->{wbuf};	875	delete $self->{_ww} unless length $self->{wbuf};
506	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	876	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
507	$self->_error ($!, 1);	877	$self->_error ($!, 1);
…		…
510		880
511	# try to write data immediately	881	# try to write data immediately
512	$cb->() unless $self->{autocork};	882	$cb->() unless $self->{autocork};
513		883
514	# if still data left in wbuf, we need to poll	884	# if still data left in wbuf, we need to poll
515	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	885	$self->{_ww} = AE::io $self->{fh}, 1, $cb
516	if length $self->{wbuf};	886	if length $self->{wbuf};
517	};	887	};
518	}	888	}
519		889
520	our %WH;	890	our %WH;
521		891
		892	# deprecated
522	sub register_write_type($$) {	893	sub register_write_type($$) {
523	$WH{$_[0]} = $_[1];	894	$WH{$_[0]} = $_[1];
524	}	895	}
525		896
526	sub push_write {	897	sub push_write {
527	my $self = shift;	898	my $self = shift;
528		899
529	if (@_ > 1) {	900	if (@_ > 1) {
530	my $type = shift;	901	my $type = shift;
531		902
		903	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
532	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	904	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
533	->($self, @_);	905	->($self, @_);
534	}	906	}
535		907
536	if ($self->{filter_w}) {	908	if ($self->{tls}) {
537	$self->{filter_w}($self, \$_[0]);	909	$self->{_tls_wbuf} .= $_[0];
		910	&_dotls ($self) if $self->{fh};
538	} else {	911	} else {
539	$self->{wbuf} .= $_[0];	912	$self->{wbuf} .= $_[0];
540	$self->_drain_wbuf;	913	$self->_drain_wbuf if $self->{fh};
541	}	914	}
542	}	915	}
543		916
544	=item $handle->push_write (type => @args)	917	=item $handle->push_write (type => @args)
545		918
546	Instead of formatting your data yourself, you can also let this module do	919	Instead of formatting your data yourself, you can also let this module
547	the job by specifying a type and type-specific arguments.	920	do the job by specifying a type and type-specific arguments. You
		921	can also specify the (fully qualified) name of a package, in which
		922	case AnyEvent tries to load the package and then expects to find the
		923	C<anyevent_read_type> function inside (see "custom write types", below).
548		924
549	Predefined types are (if you have ideas for additional types, feel free to	925	Predefined types are (if you have ideas for additional types, feel free to
550	drop by and tell us):	926	drop by and tell us):
551		927
552	=over 4	928	=over 4
…		…
559	=cut	935	=cut
560		936
561	register_write_type netstring => sub {	937	register_write_type netstring => sub {
562	my ($self, $string) = @_;	938	my ($self, $string) = @_;
563		939
564	sprintf "%d:%s,", (length $string), $string	940	(length $string) . ":$string,"
565	};	941	};
566		942
567	=item packstring => $format, $data	943	=item packstring => $format, $data
568		944
569	An octet string prefixed with an encoded length. The encoding C<$format>	945	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
609	Other languages could read single lines terminated by a newline and pass	985	Other languages could read single lines terminated by a newline and pass
610	this line into their JSON decoder of choice.	986	this line into their JSON decoder of choice.
611		987
612	=cut	988	=cut
613		989
		990	sub json_coder() {
		991	eval { require JSON::XS; JSON::XS->new->utf8 }
		992	|| do { require JSON; JSON->new->utf8 }
		993	}
		994
614	register_write_type json => sub {	995	register_write_type json => sub {
615	my ($self, $ref) = @_;	996	my ($self, $ref) = @_;
616		997
617	require JSON;	998	my $json = $self->{json} ||= json_coder;
618		999
619	$self->{json} ? $self->{json}->encode ($ref)	1000	$json->encode ($ref)
620	: JSON::encode_json ($ref)
621	};	1001	};
622		1002
623	=item storable => $reference	1003	=item storable => $reference
624		1004
625	Freezes the given reference using L<Storable> and writes it to the	1005	Freezes the given reference using L<Storable> and writes it to the
…		…
635	pack "w/a*", Storable::nfreeze ($ref)	1015	pack "w/a*", Storable::nfreeze ($ref)
636	};	1016	};
637		1017
638	=back	1018	=back
639		1019
640	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1020	=item $handle->push_shutdown
641		1021
642	This function (not method) lets you add your own types to C<push_write>.	1022	Sometimes you know you want to close the socket after writing your data
		1023	before it was actually written. One way to do that is to replace your
		1024	C<on_drain> handler by a callback that shuts down the socket (and set
		1025	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1026	replaces the C<on_drain> callback with:
		1027
		1028	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		1029
		1030	This simply shuts down the write side and signals an EOF condition to the
		1031	the peer.
		1032
		1033	You can rely on the normal read queue and C<on_eof> handling
		1034	afterwards. This is the cleanest way to close a connection.
		1035
		1036	=cut
		1037
		1038	sub push_shutdown {
		1039	my ($self) = @_;
		1040
		1041	delete $self->{low_water_mark};
		1042	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1043	}
		1044
		1045	=item custom write types - Package::anyevent_write_type $handle, @args
		1046
		1047	Instead of one of the predefined types, you can also specify the name of
		1048	a package. AnyEvent will try to load the package and then expects to find
		1049	a function named C<anyevent_write_type> inside. If it isn't found, it
		1050	progressively tries to load the parent package until it either finds the
		1051	function (good) or runs out of packages (bad).
		1052
643	Whenever the given C<type> is used, C<push_write> will invoke the code	1053	Whenever the given C<type> is used, C<push_write> will the function with
644	reference with the handle object and the remaining arguments.	1054	the handle object and the remaining arguments.
645		1055
646	The code reference is supposed to return a single octet string that will	1056	The function is supposed to return a single octet string that will be
647	be appended to the write buffer.	1057	appended to the write buffer, so you cna mentally treat this function as a
		1058	"arguments to on-the-wire-format" converter.
648		1059
649	Note that this is a function, and all types registered this way will be	1060	Example: implement a custom write type C<join> that joins the remaining
650	global, so try to use unique names.	1061	arguments using the first one.
		1062
		1063	$handle->push_write (My::Type => " ", 1,2,3);
		1064
		1065	# uses the following package, which can be defined in the "My::Type" or in
		1066	# the "My" modules to be auto-loaded, or just about anywhere when the
		1067	# My::Type::anyevent_write_type is defined before invoking it.
		1068
		1069	package My::Type;
		1070
		1071	sub anyevent_write_type {
		1072	my ($handle, $delim, @args) = @_;
		1073
		1074	join $delim, @args
		1075	}
651		1076
652	=cut	1077	=cut
653		1078
654	#############################################################################	1079	#############################################################################
655		1080
…		…
737	=cut	1162	=cut
738		1163
739	sub _drain_rbuf {	1164	sub _drain_rbuf {
740	my ($self) = @_;	1165	my ($self) = @_;
741		1166
		1167	# avoid recursion
		1168	return if $self->{_skip_drain_rbuf};
742	local $self->{_in_drain} = 1;	1169	local $self->{_skip_drain_rbuf} = 1;
743
744	if (
745	defined $self->{rbuf_max}
746	&& $self->{rbuf_max} < length $self->{rbuf}
747	) {
748	$self->_error (&Errno::ENOSPC, 1), return;
749	}
750		1170
751	while () {	1171	while () {
		1172	# we need to use a separate tls read buffer, as we must not receive data while
		1173	# we are draining the buffer, and this can only happen with TLS.
		1174	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1175	if exists $self->{_tls_rbuf};
		1176
752	my $len = length $self->{rbuf};	1177	my $len = length $self->{rbuf};
753		1178
754	if (my $cb = shift @{ $self->{_queue} }) {	1179	if (my $cb = shift @{ $self->{_queue} }) {
755	unless ($cb->($self)) {	1180	unless ($cb->($self)) {
756	if ($self->{_eof}) {	1181	# no progress can be made
757	# no progress can be made (not enough data and no data forthcoming)	1182	# (not enough data and no data forthcoming)
758	$self->_error (&Errno::EPIPE, 1), return;	1183	$self->_error (Errno::EPIPE, 1), return
759	}	1184	if $self->{_eof};
760		1185
761	unshift @{ $self->{_queue} }, $cb;	1186	unshift @{ $self->{_queue} }, $cb;
762	last;	1187	last;
763	}	1188	}
764	} elsif ($self->{on_read}) {	1189	} elsif ($self->{on_read}) {
…		…
771	&& !@{ $self->{_queue} } # and the queue is still empty	1196	&& !@{ $self->{_queue} } # and the queue is still empty
772	&& $self->{on_read} # but we still have on_read	1197	&& $self->{on_read} # but we still have on_read
773	) {	1198	) {
774	# no further data will arrive	1199	# no further data will arrive
775	# so no progress can be made	1200	# so no progress can be made
776	$self->_error (&Errno::EPIPE, 1), return	1201	$self->_error (Errno::EPIPE, 1), return
777	if $self->{_eof};	1202	if $self->{_eof};
778		1203
779	last; # more data might arrive	1204	last; # more data might arrive
780	}	1205	}
781	} else {	1206	} else {
782	# read side becomes idle	1207	# read side becomes idle
783	delete $self->{_rw};	1208	delete $self->{_rw} unless $self->{tls};
784	last;	1209	last;
785	}	1210	}
786	}	1211	}
787		1212
788	if ($self->{_eof}) {	1213	if ($self->{_eof}) {
789	if ($self->{on_eof}) {	1214	$self->{on_eof}
790	$self->{on_eof}($self)	1215	? $self->{on_eof}($self)
791	} else {	1216	: $self->_error (0, 1, "Unexpected end-of-file");
792	$self->_error (0, 1);	1217
793	}	1218	return;
		1219	}
		1220
		1221	if (
		1222	defined $self->{rbuf_max}
		1223	&& $self->{rbuf_max} < length $self->{rbuf}
		1224	) {
		1225	$self->_error (Errno::ENOSPC, 1), return;
794	}	1226	}
795		1227
796	# may need to restart read watcher	1228	# may need to restart read watcher
797	unless ($self->{_rw}) {	1229	unless ($self->{_rw}) {
798	$self->start_read	1230	$self->start_read
…		…
810		1242
811	sub on_read {	1243	sub on_read {
812	my ($self, $cb) = @_;	1244	my ($self, $cb) = @_;
813		1245
814	$self->{on_read} = $cb;	1246	$self->{on_read} = $cb;
815	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1247	$self->_drain_rbuf if $cb;
816	}	1248	}
817		1249
818	=item $handle->rbuf	1250	=item $handle->rbuf
819		1251
820	Returns the read buffer (as a modifiable lvalue).	1252	Returns the read buffer (as a modifiable lvalue).
821		1253
822	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1254	You can access the read buffer directly as the C<< ->{rbuf} >>
823	you want.	1255	member, if you want. However, the only operation allowed on the
		1256	read buffer (apart from looking at it) is removing data from its
		1257	beginning. Otherwise modifying or appending to it is not allowed and will
		1258	lead to hard-to-track-down bugs.
824		1259
825	NOTE: The read buffer should only be used or modified if the C<on_read>,	1260	NOTE: The read buffer should only be used or modified if the C<on_read>,
826	C<push_read> or C<unshift_read> methods are used. The other read methods	1261	C<push_read> or C<unshift_read> methods are used. The other read methods
827	automatically manage the read buffer.	1262	automatically manage the read buffer.
828		1263
…		…
864	my $cb = pop;	1299	my $cb = pop;
865		1300
866	if (@_) {	1301	if (@_) {
867	my $type = shift;	1302	my $type = shift;
868		1303
		1304	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
869	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1305	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
870	->($self, $cb, @_);	1306	->($self, $cb, @_);
871	}	1307	}
872		1308
873	push @{ $self->{_queue} }, $cb;	1309	push @{ $self->{_queue} }, $cb;
874	$self->_drain_rbuf unless $self->{_in_drain};	1310	$self->_drain_rbuf;
875	}	1311	}
876		1312
877	sub unshift_read {	1313	sub unshift_read {
878	my $self = shift;	1314	my $self = shift;
879	my $cb = pop;	1315	my $cb = pop;
…		…
883		1319
884	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1320	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
885	->($self, $cb, @_);	1321	->($self, $cb, @_);
886	}	1322	}
887		1323
888
889	unshift @{ $self->{_queue} }, $cb;	1324	unshift @{ $self->{_queue} }, $cb;
890	$self->_drain_rbuf unless $self->{_in_drain};	1325	$self->_drain_rbuf;
891	}	1326	}
892		1327
893	=item $handle->push_read (type => @args, $cb)	1328	=item $handle->push_read (type => @args, $cb)
894		1329
895	=item $handle->unshift_read (type => @args, $cb)	1330	=item $handle->unshift_read (type => @args, $cb)
896		1331
897	Instead of providing a callback that parses the data itself you can chose	1332	Instead of providing a callback that parses the data itself you can chose
898	between a number of predefined parsing formats, for chunks of data, lines	1333	between a number of predefined parsing formats, for chunks of data, lines
899	etc.	1334	etc. You can also specify the (fully qualified) name of a package, in
		1335	which case AnyEvent tries to load the package and then expects to find the
		1336	C<anyevent_read_type> function inside (see "custom read types", below).
900		1337
901	Predefined types are (if you have ideas for additional types, feel free to	1338	Predefined types are (if you have ideas for additional types, feel free to
902	drop by and tell us):	1339	drop by and tell us):
903		1340
904	=over 4	1341	=over 4
…		…
1028	return 1;	1465	return 1;
1029	}	1466	}
1030		1467
1031	# reject	1468	# reject
1032	if ($reject && $$rbuf =~ $reject) {	1469	if ($reject && $$rbuf =~ $reject) {
1033	$self->_error (&Errno::EBADMSG);	1470	$self->_error (Errno::EBADMSG);
1034	}	1471	}
1035		1472
1036	# skip	1473	# skip
1037	if ($skip && $$rbuf =~ $skip) {	1474	if ($skip && $$rbuf =~ $skip) {
1038	$data .= substr $$rbuf, 0, $+[0], "";	1475	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1054	my ($self, $cb) = @_;	1491	my ($self, $cb) = @_;
1055		1492
1056	sub {	1493	sub {
1057	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1494	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1058	if ($_[0]{rbuf} =~ /[^0-9]/) {	1495	if ($_[0]{rbuf} =~ /[^0-9]/) {
1059	$self->_error (&Errno::EBADMSG);	1496	$self->_error (Errno::EBADMSG);
1060	}	1497	}
1061	return;	1498	return;
1062	}	1499	}
1063		1500
1064	my $len = $1;	1501	my $len = $1;
…		…
1067	my $string = $_[1];	1504	my $string = $_[1];
1068	$_[0]->unshift_read (chunk => 1, sub {	1505	$_[0]->unshift_read (chunk => 1, sub {
1069	if ($_[1] eq ",") {	1506	if ($_[1] eq ",") {
1070	$cb->($_[0], $string);	1507	$cb->($_[0], $string);
1071	} else {	1508	} else {
1072	$self->_error (&Errno::EBADMSG);	1509	$self->_error (Errno::EBADMSG);
1073	}	1510	}
1074	});	1511	});
1075	});	1512	});
1076		1513
1077	1	1514	1
…		…
1083	An octet string prefixed with an encoded length. The encoding C<$format>	1520	An octet string prefixed with an encoded length. The encoding C<$format>
1084	uses the same format as a Perl C<pack> format, but must specify a single	1521	uses the same format as a Perl C<pack> format, but must specify a single
1085	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1522	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1086	optional C<!>, C<< < >> or C<< > >> modifier).	1523	optional C<!>, C<< < >> or C<< > >> modifier).
1087		1524
1088	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1525	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1526	EPP uses a prefix of C<N> (4 octtes).
1089		1527
1090	Example: read a block of data prefixed by its length in BER-encoded	1528	Example: read a block of data prefixed by its length in BER-encoded
1091	format (very efficient).	1529	format (very efficient).
1092		1530
1093	$handle->push_read (packstring => "w", sub {	1531	$handle->push_read (packstring => "w", sub {
…		…
1123	}	1561	}
1124	};	1562	};
1125		1563
1126	=item json => $cb->($handle, $hash_or_arrayref)	1564	=item json => $cb->($handle, $hash_or_arrayref)
1127		1565
1128	Reads a JSON object or array, decodes it and passes it to the callback.	1566	Reads a JSON object or array, decodes it and passes it to the
		1567	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1129		1568
1130	If a C<json> object was passed to the constructor, then that will be used	1569	If a C<json> object was passed to the constructor, then that will be used
1131	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1570	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1132		1571
1133	This read type uses the incremental parser available with JSON version	1572	This read type uses the incremental parser available with JSON version
…		…
1142	=cut	1581	=cut
1143		1582
1144	register_read_type json => sub {	1583	register_read_type json => sub {
1145	my ($self, $cb) = @_;	1584	my ($self, $cb) = @_;
1146		1585
1147	require JSON;	1586	my $json = $self->{json} ||= json_coder;
1148		1587
1149	my $data;	1588	my $data;
1150	my $rbuf = \$self->{rbuf};	1589	my $rbuf = \$self->{rbuf};
1151		1590
1152	my $json = $self->{json} ||= JSON->new->utf8;
1153
1154	sub {	1591	sub {
1155	my $ref = $json->incr_parse ($self->{rbuf});	1592	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1156		1593
1157	if ($ref) {	1594	if ($ref) {
1158	$self->{rbuf} = $json->incr_text;	1595	$self->{rbuf} = $json->incr_text;
1159	$json->incr_text = "";	1596	$json->incr_text = "";
1160	$cb->($self, $ref);	1597	$cb->($self, $ref);
1161		1598
1162	1	1599	1
		1600	} elsif ($@) {
		1601	# error case
		1602	$json->incr_skip;
		1603
		1604	$self->{rbuf} = $json->incr_text;
		1605	$json->incr_text = "";
		1606
		1607	$self->_error (Errno::EBADMSG);
		1608
		1609	()
1163	} else {	1610	} else {
1164	$self->{rbuf} = "";	1611	$self->{rbuf} = "";
		1612
1165	()	1613	()
1166	}	1614	}
1167	}	1615	}
1168	};	1616	};
1169		1617
…		…
1201	# read remaining chunk	1649	# read remaining chunk
1202	$_[0]->unshift_read (chunk => $len, sub {	1650	$_[0]->unshift_read (chunk => $len, sub {
1203	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1651	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1204	$cb->($_[0], $ref);	1652	$cb->($_[0], $ref);
1205	} else {	1653	} else {
1206	$self->_error (&Errno::EBADMSG);	1654	$self->_error (Errno::EBADMSG);
1207	}	1655	}
1208	});	1656	});
1209	}	1657	}
1210		1658
1211	1	1659	1
1212	}	1660	}
1213	};	1661	};
1214		1662
1215	=back	1663	=back
1216		1664
1217	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1665	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1218		1666
1219	This function (not method) lets you add your own types to C<push_read>.	1667	Instead of one of the predefined types, you can also specify the name
		1668	of a package. AnyEvent will try to load the package and then expects to
		1669	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1670	progressively tries to load the parent package until it either finds the
		1671	function (good) or runs out of packages (bad).
1220		1672
1221	Whenever the given C<type> is used, C<push_read> will invoke the code	1673	Whenever this type is used, C<push_read> will invoke the function with the
1222	reference with the handle object, the callback and the remaining	1674	handle object, the original callback and the remaining arguments.
1223	arguments.
1224		1675
1225	The code reference is supposed to return a callback (usually a closure)	1676	The function is supposed to return a callback (usually a closure) that
1226	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1677	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1678	mentally treat the function as a "configurable read type to read callback"
		1679	converter.
1227		1680
1228	It should invoke the passed callback when it is done reading (remember to	1681	It should invoke the original callback when it is done reading (remember
1229	pass C<$handle> as first argument as all other callbacks do that).	1682	to pass C<$handle> as first argument as all other callbacks do that,
		1683	although there is no strict requirement on this).
1230		1684
1231	Note that this is a function, and all types registered this way will be
1232	global, so try to use unique names.
1233
1234	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1685	For examples, see the source of this module (F<perldoc -m
1235	search for C<register_read_type>)).	1686	AnyEvent::Handle>, search for C<register_read_type>)).
1236		1687
1237	=item $handle->stop_read	1688	=item $handle->stop_read
1238		1689
1239	=item $handle->start_read	1690	=item $handle->start_read
1240		1691
…		…
1246	Note that AnyEvent::Handle will automatically C<start_read> for you when	1697	Note that AnyEvent::Handle will automatically C<start_read> for you when
1247	you change the C<on_read> callback or push/unshift a read callback, and it	1698	you change the C<on_read> callback or push/unshift a read callback, and it
1248	will automatically C<stop_read> for you when neither C<on_read> is set nor	1699	will automatically C<stop_read> for you when neither C<on_read> is set nor
1249	there are any read requests in the queue.	1700	there are any read requests in the queue.
1250		1701
		1702	These methods will have no effect when in TLS mode (as TLS doesn't support
		1703	half-duplex connections).
		1704
1251	=cut	1705	=cut
1252		1706
1253	sub stop_read {	1707	sub stop_read {
1254	my ($self) = @_;	1708	my ($self) = @_;
1255		1709
1256	delete $self->{_rw};	1710	delete $self->{_rw} unless $self->{tls};
1257	}	1711	}
1258		1712
1259	sub start_read {	1713	sub start_read {
1260	my ($self) = @_;	1714	my ($self) = @_;
1261		1715
1262	unless ($self->{_rw} || $self->{_eof}) {	1716	unless ($self->{_rw} || $self->{_eof}) {
1263	Scalar::Util::weaken $self;	1717	Scalar::Util::weaken $self;
1264		1718
1265	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1719	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1266	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1720	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1267	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1721	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1268		1722
1269	if ($len > 0) {	1723	if ($len > 0) {
1270	$self->{_activity} = AnyEvent->now;	1724	$self->{_activity} = $self->{_ractivity} = AE::now;
1271		1725
1272	$self->{filter_r}	1726	if ($self->{tls}) {
1273	? $self->{filter_r}($self, $rbuf)	1727	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1274	: $self->{_in_drain} || $self->_drain_rbuf;	1728
		1729	&_dotls ($self);
		1730	} else {
		1731	$self->_drain_rbuf;
		1732	}
1275		1733
1276	} elsif (defined $len) {	1734	} elsif (defined $len) {
1277	delete $self->{_rw};	1735	delete $self->{_rw};
1278	$self->{_eof} = 1;	1736	$self->{_eof} = 1;
1279	$self->_drain_rbuf unless $self->{_in_drain};	1737	$self->_drain_rbuf;
1280		1738
1281	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1739	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1282	return $self->_error ($!, 1);	1740	return $self->_error ($!, 1);
1283	}	1741	}
1284	});	1742	};
1285	}	1743	}
1286	}	1744	}
1287		1745
		1746	our $ERROR_SYSCALL;
		1747	our $ERROR_WANT_READ;
		1748
		1749	sub _tls_error {
		1750	my ($self, $err) = @_;
		1751
		1752	return $self->_error ($!, 1)
		1753	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1754
		1755	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1756
		1757	# reduce error string to look less scary
		1758	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1759
		1760	if ($self->{_on_starttls}) {
		1761	(delete $self->{_on_starttls})->($self, undef, $err);
		1762	&_freetls;
		1763	} else {
		1764	&_freetls;
		1765	$self->_error (Errno::EPROTO, 1, $err);
		1766	}
		1767	}
		1768
		1769	# poll the write BIO and send the data if applicable
		1770	# also decode read data if possible
		1771	# this is basiclaly our TLS state machine
		1772	# more efficient implementations are possible with openssl,
		1773	# but not with the buggy and incomplete Net::SSLeay.
1288	sub _dotls {	1774	sub _dotls {
1289	my ($self) = @_;	1775	my ($self) = @_;
1290		1776
1291	my $buf;	1777	my $tmp;
1292		1778
1293	if (length $self->{_tls_wbuf}) {	1779	if (length $self->{_tls_wbuf}) {
1294	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1780	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1295	substr $self->{_tls_wbuf}, 0, $len, "";	1781	substr $self->{_tls_wbuf}, 0, $tmp, "";
1296	}	1782	}
1297	}
1298		1783
		1784	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1785	return $self->_tls_error ($tmp)
		1786	if $tmp != $ERROR_WANT_READ
		1787	&& ($tmp != $ERROR_SYSCALL || $!);
		1788	}
		1789
		1790	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1791	unless (length $tmp) {
		1792	$self->{_on_starttls}
		1793	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1794	&_freetls;
		1795
		1796	if ($self->{on_stoptls}) {
		1797	$self->{on_stoptls}($self);
		1798	return;
		1799	} else {
		1800	# let's treat SSL-eof as we treat normal EOF
		1801	delete $self->{_rw};
		1802	$self->{_eof} = 1;
		1803	}
		1804	}
		1805
		1806	$self->{_tls_rbuf} .= $tmp;
		1807	$self->_drain_rbuf;
		1808	$self->{tls} or return; # tls session might have gone away in callback
		1809	}
		1810
		1811	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1812	return $self->_tls_error ($tmp)
		1813	if $tmp != $ERROR_WANT_READ
		1814	&& ($tmp != $ERROR_SYSCALL || $!);
		1815
1299	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1816	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1300	$self->{wbuf} .= $buf;	1817	$self->{wbuf} .= $tmp;
1301	$self->_drain_wbuf;	1818	$self->_drain_wbuf;
1302	}	1819	}
1303		1820
1304	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1821	$self->{_on_starttls}
1305	if (length $buf) {	1822	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1306	$self->{rbuf} .= $buf;	1823	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1307	$self->_drain_rbuf unless $self->{_in_drain};
1308	} else {
1309	# let's treat SSL-eof as we treat normal EOF
1310	$self->{_eof} = 1;
1311	$self->_shutdown;
1312	return;
1313	}
1314	}
1315
1316	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1317
1318	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1319	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1320	return $self->_error ($!, 1);
1321	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1322	return $self->_error (&Errno::EIO, 1);
1323	}
1324
1325	# all others are fine for our purposes
1326	}
1327	}	1824	}
1328		1825
1329	=item $handle->starttls ($tls[, $tls_ctx])	1826	=item $handle->starttls ($tls[, $tls_ctx])
1330		1827
1331	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1828	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1332	object is created, you can also do that at a later time by calling	1829	object is created, you can also do that at a later time by calling
1333	C<starttls>.	1830	C<starttls>.
1334		1831
		1832	Starting TLS is currently an asynchronous operation - when you push some
		1833	write data and then call C<< ->starttls >> then TLS negotiation will start
		1834	immediately, after which the queued write data is then sent.
		1835
1335	The first argument is the same as the C<tls> constructor argument (either	1836	The first argument is the same as the C<tls> constructor argument (either
1336	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1837	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1337		1838
1338	The second argument is the optional C<Net::SSLeay::CTX> object that is	1839	The second argument is the optional C<AnyEvent::TLS> object that is used
1339	used when AnyEvent::Handle has to create its own TLS connection object.	1840	when AnyEvent::Handle has to create its own TLS connection object, or
		1841	a hash reference with C<< key => value >> pairs that will be used to
		1842	construct a new context.
1340		1843
1341	The TLS connection object will end up in C<< $handle->{tls} >> after this	1844	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1342	call and can be used or changed to your liking. Note that the handshake	1845	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1343	might have already started when this function returns.	1846	changed to your liking. Note that the handshake might have already started
		1847	when this function returns.
1344		1848
		1849	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		1850	handshakes on the same stream. Best do not attempt to use the stream after
		1851	stopping TLS.
		1852
1345	=cut	1853	=cut
		1854
		1855	our %TLS_CACHE; #TODO not yet documented, should we?
1346		1856
1347	sub starttls {	1857	sub starttls {
1348	my ($self, $ssl, $ctx) = @_;	1858	my ($self, $tls, $ctx) = @_;
1349		1859
1350	$self->stoptls;	1860	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1861	if $self->{tls};
1351		1862
1352	if ($ssl eq "accept") {	1863	$self->{tls} = $tls;
1353	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1864	$self->{tls_ctx} = $ctx if @_ > 2;
1354	Net::SSLeay::set_accept_state ($ssl);	1865
1355	} elsif ($ssl eq "connect") {	1866	return unless $self->{fh};
1356	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1867
1357	Net::SSLeay::set_connect_state ($ssl);	1868	require Net::SSLeay;
		1869
		1870	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1871	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1872
		1873	$tls = delete $self->{tls};
		1874	$ctx = $self->{tls_ctx};
		1875
		1876	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1877
		1878	if ("HASH" eq ref $ctx) {
		1879	require AnyEvent::TLS;
		1880
		1881	if ($ctx->{cache}) {
		1882	my $key = $ctx+0;
		1883	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1884	} else {
		1885	$ctx = new AnyEvent::TLS %$ctx;
		1886	}
		1887	}
1358	}	1888
1359		1889	$self->{tls_ctx} = $ctx || TLS_CTX ();
1360	$self->{tls} = $ssl;	1890	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1361		1891
1362	# basically, this is deep magic (because SSL_read should have the same issues)	1892	# basically, this is deep magic (because SSL_read should have the same issues)
1363	# but the openssl maintainers basically said: "trust us, it just works".	1893	# but the openssl maintainers basically said: "trust us, it just works".
1364	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1894	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1365	# and mismaintained ssleay-module doesn't even offer them).	1895	# and mismaintained ssleay-module doesn't even offer them).
1366	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1896	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1897	#
		1898	# in short: this is a mess.
		1899	#
		1900	# note that we do not try to keep the length constant between writes as we are required to do.
		1901	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1902	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1903	# have identity issues in that area.
1367	Net::SSLeay::CTX_set_mode ($self->{tls},	1904	# Net::SSLeay::CTX_set_mode ($ssl,
1368	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1905	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1369	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1906	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1907	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1370		1908
1371	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1909	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1372	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1910	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1373		1911
		1912	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1913
1374	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1914	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1375		1915
1376	$self->{filter_w} = sub {	1916	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1377	$_[0]{_tls_wbuf} .= ${$_[1]};	1917	if $self->{on_starttls};
1378	&_dotls;	1918
1379	};	1919	&_dotls; # need to trigger the initial handshake
1380	$self->{filter_r} = sub {	1920	$self->start_read; # make sure we actually do read
1381	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1382	&_dotls;
1383	};
1384	}	1921	}
1385		1922
1386	=item $handle->stoptls	1923	=item $handle->stoptls
1387		1924
1388	Destroys the SSL connection, if any. Partial read or write data will be	1925	Shuts down the SSL connection - this makes a proper EOF handshake by
1389	lost.	1926	sending a close notify to the other side, but since OpenSSL doesn't
		1927	support non-blocking shut downs, it is not guarenteed that you can re-use
		1928	the stream afterwards.
1390		1929
1391	=cut	1930	=cut
1392		1931
1393	sub stoptls {	1932	sub stoptls {
1394	my ($self) = @_;	1933	my ($self) = @_;
1395		1934
1396	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1935	if ($self->{tls}) {
		1936	Net::SSLeay::shutdown ($self->{tls});
1397		1937
1398	delete $self->{_rbio};	1938	&_dotls;
1399	delete $self->{_wbio};	1939
1400	delete $self->{_tls_wbuf};	1940	# # we don't give a shit. no, we do, but we can't. no...#d#
1401	delete $self->{filter_r};	1941	# # we, we... have to use openssl :/#d#
1402	delete $self->{filter_w};	1942	# &_freetls;#d#
		1943	}
		1944	}
		1945
		1946	sub _freetls {
		1947	my ($self) = @_;
		1948
		1949	return unless $self->{tls};
		1950
		1951	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1952	if $self->{tls} > 0;
		1953
		1954	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1403	}	1955	}
1404		1956
1405	sub DESTROY {	1957	sub DESTROY {
1406	my $self = shift;	1958	my ($self) = @_;
1407		1959
1408	$self->stoptls;	1960	&_freetls;
1409		1961
1410	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1962	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1411		1963
1412	if ($linger && length $self->{wbuf}) {	1964	if ($linger && length $self->{wbuf} && $self->{fh}) {
1413	my $fh = delete $self->{fh};	1965	my $fh = delete $self->{fh};
1414	my $wbuf = delete $self->{wbuf};	1966	my $wbuf = delete $self->{wbuf};
1415		1967
1416	my @linger;	1968	my @linger;
1417		1969
1418	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1970	push @linger, AE::io $fh, 1, sub {
1419	my $len = syswrite $fh, $wbuf, length $wbuf;	1971	my $len = syswrite $fh, $wbuf, length $wbuf;
1420		1972
1421	if ($len > 0) {	1973	if ($len > 0) {
1422	substr $wbuf, 0, $len, "";	1974	substr $wbuf, 0, $len, "";
1423	} else {	1975	} else {
1424	@linger = (); # end	1976	@linger = (); # end
1425	}	1977	}
1426	});	1978	};
1427	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1979	push @linger, AE::timer $linger, 0, sub {
1428	@linger = ();	1980	@linger = ();
1429	});	1981	};
1430	}	1982	}
		1983	}
		1984
		1985	=item $handle->destroy
		1986
		1987	Shuts down the handle object as much as possible - this call ensures that
		1988	no further callbacks will be invoked and as many resources as possible
		1989	will be freed. Any method you will call on the handle object after
		1990	destroying it in this way will be silently ignored (and it will return the
		1991	empty list).
		1992
		1993	Normally, you can just "forget" any references to an AnyEvent::Handle
		1994	object and it will simply shut down. This works in fatal error and EOF
		1995	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1996	callback, so when you want to destroy the AnyEvent::Handle object from
		1997	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1998	that case.
		1999
		2000	Destroying the handle object in this way has the advantage that callbacks
		2001	will be removed as well, so if those are the only reference holders (as
		2002	is common), then one doesn't need to do anything special to break any
		2003	reference cycles.
		2004
		2005	The handle might still linger in the background and write out remaining
		2006	data, as specified by the C<linger> option, however.
		2007
		2008	=cut
		2009
		2010	sub destroy {
		2011	my ($self) = @_;
		2012
		2013	$self->DESTROY;
		2014	%$self = ();
		2015	bless $self, "AnyEvent::Handle::destroyed";
		2016	}
		2017
		2018	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2019	#nop
1431	}	2020	}
1432		2021
1433	=item AnyEvent::Handle::TLS_CTX	2022	=item AnyEvent::Handle::TLS_CTX
1434		2023
1435	This function creates and returns the Net::SSLeay::CTX object used by	2024	This function creates and returns the AnyEvent::TLS object used by default
1436	default for TLS mode.	2025	for TLS mode.
1437		2026
1438	The context is created like this:	2027	The context is created by calling L<AnyEvent::TLS> without any arguments.
1439
1440	Net::SSLeay::load_error_strings;
1441	Net::SSLeay::SSLeay_add_ssl_algorithms;
1442	Net::SSLeay::randomize;
1443
1444	my $CTX = Net::SSLeay::CTX_new;
1445
1446	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1447		2028
1448	=cut	2029	=cut
1449		2030
1450	our $TLS_CTX;	2031	our $TLS_CTX;
1451		2032
1452	sub TLS_CTX() {	2033	sub TLS_CTX() {
1453	$TLS_CTX || do {	2034	$TLS_CTX ||= do {
1454	require Net::SSLeay;	2035	require AnyEvent::TLS;
1455		2036
1456	Net::SSLeay::load_error_strings ();	2037	new AnyEvent::TLS
1457	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1458	Net::SSLeay::randomize ();
1459
1460	$TLS_CTX = Net::SSLeay::CTX_new ();
1461
1462	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1463
1464	$TLS_CTX
1465	}	2038	}
1466	}	2039	}
1467		2040
1468	=back	2041	=back
		2042
		2043
		2044	=head1 NONFREQUENTLY ASKED QUESTIONS
		2045
		2046	=over 4
		2047
		2048	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		2049	still get further invocations!
		2050
		2051	That's because AnyEvent::Handle keeps a reference to itself when handling
		2052	read or write callbacks.
		2053
		2054	It is only safe to "forget" the reference inside EOF or error callbacks,
		2055	from within all other callbacks, you need to explicitly call the C<<
		2056	->destroy >> method.
		2057
		2058	=item I get different callback invocations in TLS mode/Why can't I pause
		2059	reading?
		2060
		2061	Unlike, say, TCP, TLS connections do not consist of two independent
		2062	communication channels, one for each direction. Or put differently. The
		2063	read and write directions are not independent of each other: you cannot
		2064	write data unless you are also prepared to read, and vice versa.
		2065
		2066	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		2067	callback invocations when you are not expecting any read data - the reason
		2068	is that AnyEvent::Handle always reads in TLS mode.
		2069
		2070	During the connection, you have to make sure that you always have a
		2071	non-empty read-queue, or an C<on_read> watcher. At the end of the
		2072	connection (or when you no longer want to use it) you can call the
		2073	C<destroy> method.
		2074
		2075	=item How do I read data until the other side closes the connection?
		2076
		2077	If you just want to read your data into a perl scalar, the easiest way
		2078	to achieve this is by setting an C<on_read> callback that does nothing,
		2079	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		2080	will be in C<$_[0]{rbuf}>:
		2081
		2082	$handle->on_read (sub { });
		2083	$handle->on_eof (undef);
		2084	$handle->on_error (sub {
		2085	my $data = delete $_[0]{rbuf};
		2086	});
		2087
		2088	The reason to use C<on_error> is that TCP connections, due to latencies
		2089	and packets loss, might get closed quite violently with an error, when in
		2090	fact, all data has been received.
		2091
		2092	It is usually better to use acknowledgements when transferring data,
		2093	to make sure the other side hasn't just died and you got the data
		2094	intact. This is also one reason why so many internet protocols have an
		2095	explicit QUIT command.
		2096
		2097	=item I don't want to destroy the handle too early - how do I wait until
		2098	all data has been written?
		2099
		2100	After writing your last bits of data, set the C<on_drain> callback
		2101	and destroy the handle in there - with the default setting of
		2102	C<low_water_mark> this will be called precisely when all data has been
		2103	written to the socket:
		2104
		2105	$handle->push_write (...);
		2106	$handle->on_drain (sub {
		2107	warn "all data submitted to the kernel\n";
		2108	undef $handle;
		2109	});
		2110
		2111	If you just want to queue some data and then signal EOF to the other side,
		2112	consider using C<< ->push_shutdown >> instead.
		2113
		2114	=item I want to contact a TLS/SSL server, I don't care about security.
		2115
		2116	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2117	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		2118	parameter:
		2119
		2120	tcp_connect $host, $port, sub {
		2121	my ($fh) = @_;
		2122
		2123	my $handle = new AnyEvent::Handle
		2124	fh => $fh,
		2125	tls => "connect",
		2126	on_error => sub { ... };
		2127
		2128	$handle->push_write (...);
		2129	};
		2130
		2131	=item I want to contact a TLS/SSL server, I do care about security.
		2132
		2133	Then you should additionally enable certificate verification, including
		2134	peername verification, if the protocol you use supports it (see
		2135	L<AnyEvent::TLS>, C<verify_peername>).
		2136
		2137	E.g. for HTTPS:
		2138
		2139	tcp_connect $host, $port, sub {
		2140	my ($fh) = @_;
		2141
		2142	my $handle = new AnyEvent::Handle
		2143	fh => $fh,
		2144	peername => $host,
		2145	tls => "connect",
		2146	tls_ctx => { verify => 1, verify_peername => "https" },
		2147	...
		2148
		2149	Note that you must specify the hostname you connected to (or whatever
		2150	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2151	peername verification will be done.
		2152
		2153	The above will use the system-dependent default set of trusted CA
		2154	certificates. If you want to check against a specific CA, add the
		2155	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2156
		2157	tls_ctx => {
		2158	verify => 1,
		2159	verify_peername => "https",
		2160	ca_file => "my-ca-cert.pem",
		2161	},
		2162
		2163	=item I want to create a TLS/SSL server, how do I do that?
		2164
		2165	Well, you first need to get a server certificate and key. You have
		2166	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2167	self-signed certificate (cheap. check the search engine of your choice,
		2168	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2169	nice program for that purpose).
		2170
		2171	Then create a file with your private key (in PEM format, see
		2172	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2173	file should then look like this:
		2174
		2175	-----BEGIN RSA PRIVATE KEY-----
		2176	...header data
		2177	... lots of base64'y-stuff
		2178	-----END RSA PRIVATE KEY-----
		2179
		2180	-----BEGIN CERTIFICATE-----
		2181	... lots of base64'y-stuff
		2182	-----END CERTIFICATE-----
		2183
		2184	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2185	specify this file as C<cert_file>:
		2186
		2187	tcp_server undef, $port, sub {
		2188	my ($fh) = @_;
		2189
		2190	my $handle = new AnyEvent::Handle
		2191	fh => $fh,
		2192	tls => "accept",
		2193	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2194	...
		2195
		2196	When you have intermediate CA certificates that your clients might not
		2197	know about, just append them to the C<cert_file>.
		2198
		2199	=back
		2200
1469		2201
1470	=head1 SUBCLASSING AnyEvent::Handle	2202	=head1 SUBCLASSING AnyEvent::Handle
1471		2203
1472	In many cases, you might want to subclass AnyEvent::Handle.	2204	In many cases, you might want to subclass AnyEvent::Handle.
1473		2205

Diff Legend

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