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.66 by root, Fri Jun 6 15:32:54 2008 UTC vs.
Revision 1.181 by root, Tue Sep 1 10:40:05 2009 UTC

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

Diff Legend

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