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.62 by root, Fri Jun 6 10:49:20 2008 UTC vs.
Revision 1.177 by root, Sun Aug 9 00:24:35 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.14;
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 _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	506	$self->start_read
248	}	507	if $self->{on_read} || @{ $self->{_queue} };
249		508
		509	$self->_drain_wbuf;
		510	}
		511
250	sub _shutdown {	512	#sub _shutdown {
251	my ($self) = @_;	513	# my ($self) = @_;
252		514	#
253	delete $self->{_tw};	515	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
254	delete $self->{_rw};	516	# $self->{_eof} = 1; # tell starttls et. al to stop trying
255	delete $self->{_ww};	517	#
256	delete $self->{fh};	518	# &_freetls;
257		519	#}
258	$self->stoptls;
259	}
260		520
261	sub _error {	521	sub _error {
262	my ($self, $errno, $fatal) = @_;	522	my ($self, $errno, $fatal, $message) = @_;
263
264	$self->_shutdown
265	if $fatal;
266		523
267	$! = $errno;	524	$! = $errno;
		525	$message ||= "$!";
268		526
269	if ($self->{on_error}) {	527	if ($self->{on_error}) {
270	$self->{on_error}($self, $fatal);	528	$self->{on_error}($self, $fatal, $message);
271	} else {	529	$self->destroy if $fatal;
		530	} elsif ($self->{fh}) {
		531	$self->destroy;
272	Carp::croak "AnyEvent::Handle uncaught error: $!";	532	Carp::croak "AnyEvent::Handle uncaught error: $message";
273	}	533	}
274	}	534	}
275		535
276	=item $fh = $handle->fh	536	=item $fh = $handle->fh
277		537
278	This method returns the file handle of the L<AnyEvent::Handle> object.	538	This method returns the file handle used to create the L<AnyEvent::Handle> object.
279		539
280	=cut	540	=cut
281		541
282	sub fh { $_[0]{fh} }	542	sub fh { $_[0]{fh} }
283		543
…		…
301	$_[0]{on_eof} = $_[1];	561	$_[0]{on_eof} = $_[1];
302	}	562	}
303		563
304	=item $handle->on_timeout ($cb)	564	=item $handle->on_timeout ($cb)
305		565
306	Replace the current C<on_timeout> callback, or disables the callback	566	=item $handle->on_rtimeout ($cb)
307	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
308	argument.
309		567
310	=cut	568	=item $handle->on_wtimeout ($cb)
311		569
312	sub on_timeout {	570	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
		571	callback, or disables the callback (but not the timeout) if C<$cb> =
		572	C<undef>. See the C<timeout> constructor argument and method.
		573
		574	=cut
		575
		576	# see below
		577
		578	=item $handle->autocork ($boolean)
		579
		580	Enables or disables the current autocork behaviour (see C<autocork>
		581	constructor argument). Changes will only take effect on the next write.
		582
		583	=cut
		584
		585	sub autocork {
		586	$_[0]{autocork} = $_[1];
		587	}
		588
		589	=item $handle->no_delay ($boolean)
		590
		591	Enables or disables the C<no_delay> setting (see constructor argument of
		592	the same name for details).
		593
		594	=cut
		595
		596	sub no_delay {
		597	$_[0]{no_delay} = $_[1];
		598
		599	eval {
		600	local $SIG{__DIE__};
		601	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		602	if $_[0]{fh};
		603	};
		604	}
		605
		606	=item $handle->on_starttls ($cb)
		607
		608	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		609
		610	=cut
		611
		612	sub on_starttls {
		613	$_[0]{on_starttls} = $_[1];
		614	}
		615
		616	=item $handle->on_stoptls ($cb)
		617
		618	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		619
		620	=cut
		621
		622	sub on_starttls {
313	$_[0]{on_timeout} = $_[1];	623	$_[0]{on_stoptls} = $_[1];
		624	}
		625
		626	=item $handle->rbuf_max ($max_octets)
		627
		628	Configures the C<rbuf_max> setting (C<undef> disables it).
		629
		630	=cut
		631
		632	sub rbuf_max {
		633	$_[0]{rbuf_max} = $_[1];
314	}	634	}
315		635
316	#############################################################################	636	#############################################################################
317		637
318	=item $handle->timeout ($seconds)	638	=item $handle->timeout ($seconds)
319		639
		640	=item $handle->rtimeout ($seconds)
		641
		642	=item $handle->wtimeout ($seconds)
		643
320	Configures (or disables) the inactivity timeout.	644	Configures (or disables) the inactivity timeout.
321		645
322	=cut	646	=item $handle->timeout_reset
323		647
324	sub timeout {	648	=item $handle->rtimeout_reset
		649
		650	=item $handle->wtimeout_reset
		651
		652	Reset the activity timeout, as if data was received or sent.
		653
		654	These methods are cheap to call.
		655
		656	=cut
		657
		658	for my $dir ("", "r", "w") {
		659	my $timeout = "${dir}timeout";
		660	my $tw = "_${dir}tw";
		661	my $on_timeout = "on_${dir}timeout";
		662	my $activity = "_${dir}activity";
		663	my $cb;
		664
		665	*$on_timeout = sub {
		666	$_[0]{$on_timeout} = $_[1];
		667	};
		668
		669	*$timeout = sub {
325	my ($self, $timeout) = @_;	670	my ($self, $new_value) = @_;
326		671
327	$self->{timeout} = $timeout;	672	$self->{$timeout} = $new_value;
328	$self->_timeout;	673	delete $self->{$tw}; &$cb;
329	}	674	};
330		675
		676	*{"${dir}timeout_reset"} = sub {
		677	$_[0]{$activity} = AE::now;
		678	};
		679
		680	# main workhorse:
331	# reset the timeout watcher, as neccessary	681	# reset the timeout watcher, as neccessary
332	# also check for time-outs	682	# also check for time-outs
333	sub _timeout {	683	$cb = sub {
334	my ($self) = @_;	684	my ($self) = @_;
335		685
336	if ($self->{timeout}) {	686	if ($self->{$timeout} && $self->{fh}) {
337	my $NOW = AnyEvent->now;	687	my $NOW = AE::now;
338		688
339	# when would the timeout trigger?	689	# when would the timeout trigger?
340	my $after = $self->{_activity} + $self->{timeout} - $NOW;	690	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
341		691
342	# now or in the past already?	692	# now or in the past already?
343	if ($after <= 0) {	693	if ($after <= 0) {
344	$self->{_activity} = $NOW;	694	$self->{$activity} = $NOW;
345		695
346	if ($self->{on_timeout}) {	696	if ($self->{$on_timeout}) {
347	$self->{on_timeout}($self);	697	$self->{$on_timeout}($self);
348	} else {	698	} else {
349	$self->_error (&Errno::ETIMEDOUT);	699	$self->_error (Errno::ETIMEDOUT);
		700	}
		701
		702	# callback could have changed timeout value, optimise
		703	return unless $self->{$timeout};
		704
		705	# calculate new after
		706	$after = $self->{$timeout};
350	}	707	}
351		708
352	# callback could have changed timeout value, optimise	709	Scalar::Util::weaken $self;
353	return unless $self->{timeout};	710	return unless $self; # ->error could have destroyed $self
354		711
355	# calculate new after	712	$self->{$tw} ||= AE::timer $after, 0, sub {
356	$after = $self->{timeout};	713	delete $self->{$tw};
		714	$cb->($self);
		715	};
		716	} else {
		717	delete $self->{$tw};
357	}	718	}
358
359	Scalar::Util::weaken $self;
360	return unless $self; # ->error could have destroyed $self
361
362	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
363	delete $self->{_tw};
364	$self->_timeout;
365	});
366	} else {
367	delete $self->{_tw};
368	}	719	}
369	}	720	}
370		721
371	#############################################################################	722	#############################################################################
372		723
…		…
396	my ($self, $cb) = @_;	747	my ($self, $cb) = @_;
397		748
398	$self->{on_drain} = $cb;	749	$self->{on_drain} = $cb;
399		750
400	$cb->($self)	751	$cb->($self)
401	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	752	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
402	}	753	}
403		754
404	=item $handle->push_write ($data)	755	=item $handle->push_write ($data)
405		756
406	Queues the given scalar to be written. You can push as much data as you	757	Queues the given scalar to be written. You can push as much data as you
…		…
417	Scalar::Util::weaken $self;	768	Scalar::Util::weaken $self;
418		769
419	my $cb = sub {	770	my $cb = sub {
420	my $len = syswrite $self->{fh}, $self->{wbuf};	771	my $len = syswrite $self->{fh}, $self->{wbuf};
421		772
422	if ($len >= 0) {	773	if (defined $len) {
423	substr $self->{wbuf}, 0, $len, "";	774	substr $self->{wbuf}, 0, $len, "";
424		775
425	$self->{_activity} = AnyEvent->now;	776	$self->{_activity} = $self->{_wactivity} = AE::now;
426		777
427	$self->{on_drain}($self)	778	$self->{on_drain}($self)
428	if $self->{low_water_mark} >= length $self->{wbuf}	779	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
429	&& $self->{on_drain};	780	&& $self->{on_drain};
430		781
431	delete $self->{_ww} unless length $self->{wbuf};	782	delete $self->{_ww} unless length $self->{wbuf};
432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	783	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
433	$self->_error ($!, 1);	784	$self->_error ($!, 1);
434	}	785	}
435	};	786	};
436		787
437	# try to write data immediately	788	# try to write data immediately
438	$cb->();	789	$cb->() unless $self->{autocork};
439		790
440	# if still data left in wbuf, we need to poll	791	# if still data left in wbuf, we need to poll
441	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	792	$self->{_ww} = AE::io $self->{fh}, 1, $cb
442	if length $self->{wbuf};	793	if length $self->{wbuf};
443	};	794	};
444	}	795	}
445		796
446	our %WH;	797	our %WH;
…		…
457		808
458	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	809	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
459	->($self, @_);	810	->($self, @_);
460	}	811	}
461		812
462	if ($self->{filter_w}) {	813	if ($self->{tls}) {
463	$self->{filter_w}($self, \$_[0]);	814	$self->{_tls_wbuf} .= $_[0];
		815	&_dotls ($self) if $self->{fh};
464	} else {	816	} else {
465	$self->{wbuf} .= $_[0];	817	$self->{wbuf} .= $_[0];
466	$self->_drain_wbuf;	818	$self->_drain_wbuf if $self->{fh};
467	}	819	}
468	}	820	}
469		821
470	=item $handle->push_write (type => @args)	822	=item $handle->push_write (type => @args)
471		823
…		…
485	=cut	837	=cut
486		838
487	register_write_type netstring => sub {	839	register_write_type netstring => sub {
488	my ($self, $string) = @_;	840	my ($self, $string) = @_;
489		841
490	sprintf "%d:%s,", (length $string), $string	842	(length $string) . ":$string,"
491	};	843	};
492		844
493	=item packstring => $format, $data	845	=item packstring => $format, $data
494		846
495	An octet string prefixed with an encoded length. The encoding C<$format>	847	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
500	=cut	852	=cut
501		853
502	register_write_type packstring => sub {	854	register_write_type packstring => sub {
503	my ($self, $format, $string) = @_;	855	my ($self, $format, $string) = @_;
504		856
505	pack "$format/a", $string	857	pack "$format/a*", $string
506	};	858	};
507		859
508	=item json => $array_or_hashref	860	=item json => $array_or_hashref
509		861
510	Encodes the given hash or array reference into a JSON object. Unless you	862	Encodes the given hash or array reference into a JSON object. Unless you
…		…
544		896
545	$self->{json} ? $self->{json}->encode ($ref)	897	$self->{json} ? $self->{json}->encode ($ref)
546	: JSON::encode_json ($ref)	898	: JSON::encode_json ($ref)
547	};	899	};
548		900
		901	=item storable => $reference
		902
		903	Freezes the given reference using L<Storable> and writes it to the
		904	handle. Uses the C<nfreeze> format.
		905
		906	=cut
		907
		908	register_write_type storable => sub {
		909	my ($self, $ref) = @_;
		910
		911	require Storable;
		912
		913	pack "w/a*", Storable::nfreeze ($ref)
		914	};
		915
549	=back	916	=back
		917
		918	=item $handle->push_shutdown
		919
		920	Sometimes you know you want to close the socket after writing your data
		921	before it was actually written. One way to do that is to replace your
		922	C<on_drain> handler by a callback that shuts down the socket (and set
		923	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		924	replaces the C<on_drain> callback with:
		925
		926	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		927
		928	This simply shuts down the write side and signals an EOF condition to the
		929	the peer.
		930
		931	You can rely on the normal read queue and C<on_eof> handling
		932	afterwards. This is the cleanest way to close a connection.
		933
		934	=cut
		935
		936	sub push_shutdown {
		937	my ($self) = @_;
		938
		939	delete $self->{low_water_mark};
		940	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		941	}
550		942
551	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	943	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
552		944
553	This function (not method) lets you add your own types to C<push_write>.	945	This function (not method) lets you add your own types to C<push_write>.
554	Whenever the given C<type> is used, C<push_write> will invoke the code	946	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
575	ways, the "simple" way, using only C<on_read> and the "complex" way, using	967	ways, the "simple" way, using only C<on_read> and the "complex" way, using
576	a queue.	968	a queue.
577		969
578	In the simple case, you just install an C<on_read> callback and whenever	970	In the simple case, you just install an C<on_read> callback and whenever
579	new data arrives, it will be called. You can then remove some data (if	971	new data arrives, it will be called. You can then remove some data (if
580	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	972	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
581	or not.	973	leave the data there if you want to accumulate more (e.g. when only a
		974	partial message has been received so far).
582		975
583	In the more complex case, you want to queue multiple callbacks. In this	976	In the more complex case, you want to queue multiple callbacks. In this
584	case, AnyEvent::Handle will call the first queued callback each time new	977	case, AnyEvent::Handle will call the first queued callback each time new
585	data arrives (also the first time it is queued) and removes it when it has	978	data arrives (also the first time it is queued) and removes it when it has
586	done its job (see C<push_read>, below).	979	done its job (see C<push_read>, below).
…		…
604	# handle xml	997	# handle xml
605	});	998	});
606	});	999	});
607	});	1000	});
608		1001
609	Example 2: Implement a client for a protocol that replies either with	1002	Example 2: Implement a client for a protocol that replies either with "OK"
610	"OK" and another line or "ERROR" for one request, and 64 bytes for the	1003	and another line or "ERROR" for the first request that is sent, and 64
611	second request. Due tot he availability of a full queue, we can just	1004	bytes for the second request. Due to the availability of a queue, we can
612	pipeline sending both requests and manipulate the queue as necessary in	1005	just pipeline sending both requests and manipulate the queue as necessary
613	the callbacks:	1006	in the callbacks.
614		1007
615	# request one	1008	When the first callback is called and sees an "OK" response, it will
		1009	C<unshift> another line-read. This line-read will be queued I<before> the
		1010	64-byte chunk callback.
		1011
		1012	# request one, returns either "OK + extra line" or "ERROR"
616	$handle->push_write ("request 1\015\012");	1013	$handle->push_write ("request 1\015\012");
617		1014
618	# we expect "ERROR" or "OK" as response, so push a line read	1015	# we expect "ERROR" or "OK" as response, so push a line read
619	$handle->push_read (line => sub {	1016	$handle->push_read (line => sub {
620	# if we got an "OK", we have to _prepend_ another line,	1017	# if we got an "OK", we have to _prepend_ another line,
…		…
627	...	1024	...
628	});	1025	});
629	}	1026	}
630	});	1027	});
631		1028
632	# request two	1029	# request two, simply returns 64 octets
633	$handle->push_write ("request 2\015\012");	1030	$handle->push_write ("request 2\015\012");
634		1031
635	# simply read 64 bytes, always	1032	# simply read 64 bytes, always
636	$handle->push_read (chunk => 64, sub {	1033	$handle->push_read (chunk => 64, sub {
637	my $response = $_[1];	1034	my $response = $_[1];
…		…
643	=cut	1040	=cut
644		1041
645	sub _drain_rbuf {	1042	sub _drain_rbuf {
646	my ($self) = @_;	1043	my ($self) = @_;
647		1044
		1045	# avoid recursion
		1046	return if $self->{_skip_drain_rbuf};
648	local $self->{_in_drain} = 1;	1047	local $self->{_skip_drain_rbuf} = 1;
649
650	if (
651	defined $self->{rbuf_max}
652	&& $self->{rbuf_max} < length $self->{rbuf}
653	) {
654	return $self->_error (&Errno::ENOSPC, 1);
655	}
656		1048
657	while () {	1049	while () {
658	no strict 'refs';	1050	# we need to use a separate tls read buffer, as we must not receive data while
		1051	# we are draining the buffer, and this can only happen with TLS.
		1052	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1053	if exists $self->{_tls_rbuf};
659		1054
660	my $len = length $self->{rbuf};	1055	my $len = length $self->{rbuf};
661		1056
662	if (my $cb = shift @{ $self->{_queue} }) {	1057	if (my $cb = shift @{ $self->{_queue} }) {
663	unless ($cb->($self)) {	1058	unless ($cb->($self)) {
664	if ($self->{_eof}) {	1059	# no progress can be made
665	# no progress can be made (not enough data and no data forthcoming)	1060	# (not enough data and no data forthcoming)
666	$self->_error (&Errno::EPIPE, 1), last;	1061	$self->_error (Errno::EPIPE, 1), return
667	}	1062	if $self->{_eof};
668		1063
669	unshift @{ $self->{_queue} }, $cb;	1064	unshift @{ $self->{_queue} }, $cb;
670	last;	1065	last;
671	}	1066	}
672	} elsif ($self->{on_read}) {	1067	} elsif ($self->{on_read}) {
…		…
679	&& !@{ $self->{_queue} } # and the queue is still empty	1074	&& !@{ $self->{_queue} } # and the queue is still empty
680	&& $self->{on_read} # but we still have on_read	1075	&& $self->{on_read} # but we still have on_read
681	) {	1076	) {
682	# no further data will arrive	1077	# no further data will arrive
683	# so no progress can be made	1078	# so no progress can be made
684	$self->_error (&Errno::EPIPE, 1), last	1079	$self->_error (Errno::EPIPE, 1), return
685	if $self->{_eof};	1080	if $self->{_eof};
686		1081
687	last; # more data might arrive	1082	last; # more data might arrive
688	}	1083	}
689	} else {	1084	} else {
690	# read side becomes idle	1085	# read side becomes idle
691	delete $self->{_rw};	1086	delete $self->{_rw} unless $self->{tls};
692	last;	1087	last;
693	}	1088	}
694	}	1089	}
695		1090
		1091	if ($self->{_eof}) {
		1092	$self->{on_eof}
696	$self->{on_eof}($self)	1093	? $self->{on_eof}($self)
697	if $self->{_eof} && $self->{on_eof};	1094	: $self->_error (0, 1, "Unexpected end-of-file");
		1095
		1096	return;
		1097	}
		1098
		1099	if (
		1100	defined $self->{rbuf_max}
		1101	&& $self->{rbuf_max} < length $self->{rbuf}
		1102	) {
		1103	$self->_error (Errno::ENOSPC, 1), return;
		1104	}
698		1105
699	# may need to restart read watcher	1106	# may need to restart read watcher
700	unless ($self->{_rw}) {	1107	unless ($self->{_rw}) {
701	$self->start_read	1108	$self->start_read
702	if $self->{on_read} || @{ $self->{_queue} };	1109	if $self->{on_read} || @{ $self->{_queue} };
…		…
713		1120
714	sub on_read {	1121	sub on_read {
715	my ($self, $cb) = @_;	1122	my ($self, $cb) = @_;
716		1123
717	$self->{on_read} = $cb;	1124	$self->{on_read} = $cb;
718	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1125	$self->_drain_rbuf if $cb;
719	}	1126	}
720		1127
721	=item $handle->rbuf	1128	=item $handle->rbuf
722		1129
723	Returns the read buffer (as a modifiable lvalue).	1130	Returns the read buffer (as a modifiable lvalue).
724		1131
725	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1132	You can access the read buffer directly as the C<< ->{rbuf} >>
726	you want.	1133	member, if you want. However, the only operation allowed on the
		1134	read buffer (apart from looking at it) is removing data from its
		1135	beginning. Otherwise modifying or appending to it is not allowed and will
		1136	lead to hard-to-track-down bugs.
727		1137
728	NOTE: The read buffer should only be used or modified if the C<on_read>,	1138	NOTE: The read buffer should only be used or modified if the C<on_read>,
729	C<push_read> or C<unshift_read> methods are used. The other read methods	1139	C<push_read> or C<unshift_read> methods are used. The other read methods
730	automatically manage the read buffer.	1140	automatically manage the read buffer.
731		1141
…		…
772	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1182	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
773	->($self, $cb, @_);	1183	->($self, $cb, @_);
774	}	1184	}
775		1185
776	push @{ $self->{_queue} }, $cb;	1186	push @{ $self->{_queue} }, $cb;
777	$self->_drain_rbuf unless $self->{_in_drain};	1187	$self->_drain_rbuf;
778	}	1188	}
779		1189
780	sub unshift_read {	1190	sub unshift_read {
781	my $self = shift;	1191	my $self = shift;
782	my $cb = pop;	1192	my $cb = pop;
…		…
788	->($self, $cb, @_);	1198	->($self, $cb, @_);
789	}	1199	}
790		1200
791		1201
792	unshift @{ $self->{_queue} }, $cb;	1202	unshift @{ $self->{_queue} }, $cb;
793	$self->_drain_rbuf unless $self->{_in_drain};	1203	$self->_drain_rbuf;
794	}	1204	}
795		1205
796	=item $handle->push_read (type => @args, $cb)	1206	=item $handle->push_read (type => @args, $cb)
797		1207
798	=item $handle->unshift_read (type => @args, $cb)	1208	=item $handle->unshift_read (type => @args, $cb)
…		…
828	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1238	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
829	1	1239	1
830	}	1240	}
831	};	1241	};
832		1242
833	# compatibility with older API
834	sub push_read_chunk {
835	$_[0]->push_read (chunk => $_[1], $_[2]);
836	}
837
838	sub unshift_read_chunk {
839	$_[0]->unshift_read (chunk => $_[1], $_[2]);
840	}
841
842	=item line => [$eol, ]$cb->($handle, $line, $eol)	1243	=item line => [$eol, ]$cb->($handle, $line, $eol)
843		1244
844	The callback will be called only once a full line (including the end of	1245	The callback will be called only once a full line (including the end of
845	line marker, C<$eol>) has been read. This line (excluding the end of line	1246	line marker, C<$eol>) has been read. This line (excluding the end of line
846	marker) will be passed to the callback as second argument (C<$line>), and	1247	marker) will be passed to the callback as second argument (C<$line>), and
…		…
861	=cut	1262	=cut
862		1263
863	register_read_type line => sub {	1264	register_read_type line => sub {
864	my ($self, $cb, $eol) = @_;	1265	my ($self, $cb, $eol) = @_;
865		1266
866	$eol = qr|(\015?\012)| if @_ < 3;	1267	if (@_ < 3) {
		1268	# this is more than twice as fast as the generic code below
		1269	sub {
		1270	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		1271
		1272	$cb->($_[0], $1, $2);
		1273	1
		1274	}
		1275	} else {
867	$eol = quotemeta $eol unless ref $eol;	1276	$eol = quotemeta $eol unless ref $eol;
868	$eol = qr|^(.*?)($eol)|s;	1277	$eol = qr|^(.*?)($eol)|s;
869		1278
870	sub {	1279	sub {
871	$_[0]{rbuf} =~ s/$eol// or return;	1280	$_[0]{rbuf} =~ s/$eol// or return;
872		1281
873	$cb->($_[0], $1, $2);	1282	$cb->($_[0], $1, $2);
		1283	1
874	1	1284	}
875	}	1285	}
876	};	1286	};
877
878	# compatibility with older API
879	sub push_read_line {
880	my $self = shift;
881	$self->push_read (line => @_);
882	}
883
884	sub unshift_read_line {
885	my $self = shift;
886	$self->unshift_read (line => @_);
887	}
888		1287
889	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1288	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
890		1289
891	Makes a regex match against the regex object C<$accept> and returns	1290	Makes a regex match against the regex object C<$accept> and returns
892	everything up to and including the match.	1291	everything up to and including the match.
…		…
942	return 1;	1341	return 1;
943	}	1342	}
944		1343
945	# reject	1344	# reject
946	if ($reject && $$rbuf =~ $reject) {	1345	if ($reject && $$rbuf =~ $reject) {
947	$self->_error (&Errno::EBADMSG);	1346	$self->_error (Errno::EBADMSG);
948	}	1347	}
949		1348
950	# skip	1349	# skip
951	if ($skip && $$rbuf =~ $skip) {	1350	if ($skip && $$rbuf =~ $skip) {
952	$data .= substr $$rbuf, 0, $+[0], "";	1351	$data .= substr $$rbuf, 0, $+[0], "";
…		…
968	my ($self, $cb) = @_;	1367	my ($self, $cb) = @_;
969		1368
970	sub {	1369	sub {
971	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1370	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
972	if ($_[0]{rbuf} =~ /[^0-9]/) {	1371	if ($_[0]{rbuf} =~ /[^0-9]/) {
973	$self->_error (&Errno::EBADMSG);	1372	$self->_error (Errno::EBADMSG);
974	}	1373	}
975	return;	1374	return;
976	}	1375	}
977		1376
978	my $len = $1;	1377	my $len = $1;
…		…
981	my $string = $_[1];	1380	my $string = $_[1];
982	$_[0]->unshift_read (chunk => 1, sub {	1381	$_[0]->unshift_read (chunk => 1, sub {
983	if ($_[1] eq ",") {	1382	if ($_[1] eq ",") {
984	$cb->($_[0], $string);	1383	$cb->($_[0], $string);
985	} else {	1384	} else {
986	$self->_error (&Errno::EBADMSG);	1385	$self->_error (Errno::EBADMSG);
987	}	1386	}
988	});	1387	});
989	});	1388	});
990		1389
991	1	1390	1
…		…
997	An octet string prefixed with an encoded length. The encoding C<$format>	1396	An octet string prefixed with an encoded length. The encoding C<$format>
998	uses the same format as a Perl C<pack> format, but must specify a single	1397	uses the same format as a Perl C<pack> format, but must specify a single
999	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1398	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1000	optional C<!>, C<< < >> or C<< > >> modifier).	1399	optional C<!>, C<< < >> or C<< > >> modifier).
1001		1400
1002	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1401	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1402	EPP uses a prefix of C<N> (4 octtes).
1003		1403
1004	Example: read a block of data prefixed by its length in BER-encoded	1404	Example: read a block of data prefixed by its length in BER-encoded
1005	format (very efficient).	1405	format (very efficient).
1006		1406
1007	$handle->push_read (packstring => "w", sub {	1407	$handle->push_read (packstring => "w", sub {
…		…
1013	register_read_type packstring => sub {	1413	register_read_type packstring => sub {
1014	my ($self, $cb, $format) = @_;	1414	my ($self, $cb, $format) = @_;
1015		1415
1016	sub {	1416	sub {
1017	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1417	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1018	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1418	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1019	or return;	1419	or return;
1020		1420
		1421	$format = length pack $format, $len;
		1422
		1423	# bypass unshift if we already have the remaining chunk
		1424	if ($format + $len <= length $_[0]{rbuf}) {
		1425	my $data = substr $_[0]{rbuf}, $format, $len;
		1426	substr $_[0]{rbuf}, 0, $format + $len, "";
		1427	$cb->($_[0], $data);
		1428	} else {
1021	# remove prefix	1429	# remove prefix
1022	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1430	substr $_[0]{rbuf}, 0, $format, "";
1023		1431
1024	# read rest	1432	# read remaining chunk
1025	$_[0]->unshift_read (chunk => $len, $cb);	1433	$_[0]->unshift_read (chunk => $len, $cb);
		1434	}
1026		1435
1027	1	1436	1
1028	}	1437	}
1029	};	1438	};
1030		1439
1031	=item json => $cb->($handle, $hash_or_arrayref)	1440	=item json => $cb->($handle, $hash_or_arrayref)
1032		1441
1033	Reads a JSON object or array, decodes it and passes it to the callback.	1442	Reads a JSON object or array, decodes it and passes it to the
		1443	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1034		1444
1035	If a C<json> object was passed to the constructor, then that will be used	1445	If a C<json> object was passed to the constructor, then that will be used
1036	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1446	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1037		1447
1038	This read type uses the incremental parser available with JSON version	1448	This read type uses the incremental parser available with JSON version
…		…
1045	the C<json> write type description, above, for an actual example.	1455	the C<json> write type description, above, for an actual example.
1046		1456
1047	=cut	1457	=cut
1048		1458
1049	register_read_type json => sub {	1459	register_read_type json => sub {
1050	my ($self, $cb, $accept, $reject, $skip) = @_;	1460	my ($self, $cb) = @_;
1051		1461
1052	require JSON;	1462	my $json = $self->{json} ||=
		1463	eval { require JSON::XS; JSON::XS->new->utf8 }
		1464	|| do { require JSON; JSON->new->utf8 };
1053		1465
1054	my $data;	1466	my $data;
1055	my $rbuf = \$self->{rbuf};	1467	my $rbuf = \$self->{rbuf};
1056		1468
1057	my $json = $self->{json} ||= JSON->new->utf8;
1058
1059	sub {	1469	sub {
1060	my $ref = $json->incr_parse ($self->{rbuf});	1470	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1061		1471
1062	if ($ref) {	1472	if ($ref) {
1063	$self->{rbuf} = $json->incr_text;	1473	$self->{rbuf} = $json->incr_text;
1064	$json->incr_text = "";	1474	$json->incr_text = "";
1065	$cb->($self, $ref);	1475	$cb->($self, $ref);
1066		1476
1067	1	1477	1
		1478	} elsif ($@) {
		1479	# error case
		1480	$json->incr_skip;
		1481
		1482	$self->{rbuf} = $json->incr_text;
		1483	$json->incr_text = "";
		1484
		1485	$self->_error (Errno::EBADMSG);
		1486
		1487	()
1068	} else {	1488	} else {
1069	$self->{rbuf} = "";	1489	$self->{rbuf} = "";
		1490
1070	()	1491	()
1071	}	1492	}
		1493	}
		1494	};
		1495
		1496	=item storable => $cb->($handle, $ref)
		1497
		1498	Deserialises a L<Storable> frozen representation as written by the
		1499	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1500	data).
		1501
		1502	Raises C<EBADMSG> error if the data could not be decoded.
		1503
		1504	=cut
		1505
		1506	register_read_type storable => sub {
		1507	my ($self, $cb) = @_;
		1508
		1509	require Storable;
		1510
		1511	sub {
		1512	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1513	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1514	or return;
		1515
		1516	my $format = length pack "w", $len;
		1517
		1518	# bypass unshift if we already have the remaining chunk
		1519	if ($format + $len <= length $_[0]{rbuf}) {
		1520	my $data = substr $_[0]{rbuf}, $format, $len;
		1521	substr $_[0]{rbuf}, 0, $format + $len, "";
		1522	$cb->($_[0], Storable::thaw ($data));
		1523	} else {
		1524	# remove prefix
		1525	substr $_[0]{rbuf}, 0, $format, "";
		1526
		1527	# read remaining chunk
		1528	$_[0]->unshift_read (chunk => $len, sub {
		1529	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1530	$cb->($_[0], $ref);
		1531	} else {
		1532	$self->_error (Errno::EBADMSG);
		1533	}
		1534	});
		1535	}
		1536
		1537	1
1072	}	1538	}
1073	};	1539	};
1074		1540
1075	=back	1541	=back
1076		1542
…		…
1106	Note that AnyEvent::Handle will automatically C<start_read> for you when	1572	Note that AnyEvent::Handle will automatically C<start_read> for you when
1107	you change the C<on_read> callback or push/unshift a read callback, and it	1573	you change the C<on_read> callback or push/unshift a read callback, and it
1108	will automatically C<stop_read> for you when neither C<on_read> is set nor	1574	will automatically C<stop_read> for you when neither C<on_read> is set nor
1109	there are any read requests in the queue.	1575	there are any read requests in the queue.
1110		1576
		1577	These methods will have no effect when in TLS mode (as TLS doesn't support
		1578	half-duplex connections).
		1579
1111	=cut	1580	=cut
1112		1581
1113	sub stop_read {	1582	sub stop_read {
1114	my ($self) = @_;	1583	my ($self) = @_;
1115		1584
1116	delete $self->{_rw};	1585	delete $self->{_rw} unless $self->{tls};
1117	}	1586	}
1118		1587
1119	sub start_read {	1588	sub start_read {
1120	my ($self) = @_;	1589	my ($self) = @_;
1121		1590
1122	unless ($self->{_rw} || $self->{_eof}) {	1591	unless ($self->{_rw} || $self->{_eof}) {
1123	Scalar::Util::weaken $self;	1592	Scalar::Util::weaken $self;
1124		1593
1125	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1594	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1126	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1595	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1127	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1596	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1128		1597
1129	if ($len > 0) {	1598	if ($len > 0) {
1130	$self->{_activity} = AnyEvent->now;	1599	$self->{_activity} = $self->{_ractivity} = AE::now;
1131		1600
1132	$self->{filter_r}	1601	if ($self->{tls}) {
1133	? $self->{filter_r}($self, $rbuf)	1602	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1134	: $self->{_in_drain} || $self->_drain_rbuf;	1603
		1604	&_dotls ($self);
		1605	} else {
		1606	$self->_drain_rbuf;
		1607	}
1135		1608
1136	} elsif (defined $len) {	1609	} elsif (defined $len) {
1137	delete $self->{_rw};	1610	delete $self->{_rw};
1138	$self->{_eof} = 1;	1611	$self->{_eof} = 1;
1139	$self->_drain_rbuf unless $self->{_in_drain};	1612	$self->_drain_rbuf;
1140		1613
1141	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1614	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1142	return $self->_error ($!, 1);	1615	return $self->_error ($!, 1);
1143	}	1616	}
1144	});	1617	};
1145	}	1618	}
1146	}	1619	}
1147		1620
		1621	our $ERROR_SYSCALL;
		1622	our $ERROR_WANT_READ;
		1623
		1624	sub _tls_error {
		1625	my ($self, $err) = @_;
		1626
		1627	return $self->_error ($!, 1)
		1628	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1629
		1630	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1631
		1632	# reduce error string to look less scary
		1633	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1634
		1635	if ($self->{_on_starttls}) {
		1636	(delete $self->{_on_starttls})->($self, undef, $err);
		1637	&_freetls;
		1638	} else {
		1639	&_freetls;
		1640	$self->_error (Errno::EPROTO, 1, $err);
		1641	}
		1642	}
		1643
		1644	# poll the write BIO and send the data if applicable
		1645	# also decode read data if possible
		1646	# this is basiclaly our TLS state machine
		1647	# more efficient implementations are possible with openssl,
		1648	# but not with the buggy and incomplete Net::SSLeay.
1148	sub _dotls {	1649	sub _dotls {
1149	my ($self) = @_;	1650	my ($self) = @_;
1150		1651
1151	my $buf;	1652	my $tmp;
1152		1653
1153	if (length $self->{_tls_wbuf}) {	1654	if (length $self->{_tls_wbuf}) {
1154	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1655	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1155	substr $self->{_tls_wbuf}, 0, $len, "";	1656	substr $self->{_tls_wbuf}, 0, $tmp, "";
1156	}	1657	}
1157	}
1158		1658
		1659	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1660	return $self->_tls_error ($tmp)
		1661	if $tmp != $ERROR_WANT_READ
		1662	&& ($tmp != $ERROR_SYSCALL || $!);
		1663	}
		1664
		1665	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1666	unless (length $tmp) {
		1667	$self->{_on_starttls}
		1668	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1669	&_freetls;
		1670
		1671	if ($self->{on_stoptls}) {
		1672	$self->{on_stoptls}($self);
		1673	return;
		1674	} else {
		1675	# let's treat SSL-eof as we treat normal EOF
		1676	delete $self->{_rw};
		1677	$self->{_eof} = 1;
		1678	}
		1679	}
		1680
		1681	$self->{_tls_rbuf} .= $tmp;
		1682	$self->_drain_rbuf;
		1683	$self->{tls} or return; # tls session might have gone away in callback
		1684	}
		1685
		1686	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1687	return $self->_tls_error ($tmp)
		1688	if $tmp != $ERROR_WANT_READ
		1689	&& ($tmp != $ERROR_SYSCALL || $!);
		1690
1159	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1691	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1160	$self->{wbuf} .= $buf;	1692	$self->{wbuf} .= $tmp;
1161	$self->_drain_wbuf;	1693	$self->_drain_wbuf;
1162	}	1694	}
1163		1695
1164	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1696	$self->{_on_starttls}
1165	if (length $buf) {	1697	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1166	$self->{rbuf} .= $buf;	1698	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1167	$self->_drain_rbuf unless $self->{_in_drain};
1168	} else {
1169	# let's treat SSL-eof as we treat normal EOF
1170	$self->{_eof} = 1;
1171	$self->_shutdown;
1172	return;
1173	}
1174	}
1175
1176	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1177
1178	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1179	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1180	return $self->_error ($!, 1);
1181	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1182	return $self->_error (&Errno::EIO, 1);
1183	}
1184
1185	# all others are fine for our purposes
1186	}
1187	}	1699	}
1188		1700
1189	=item $handle->starttls ($tls[, $tls_ctx])	1701	=item $handle->starttls ($tls[, $tls_ctx])
1190		1702
1191	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1703	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1192	object is created, you can also do that at a later time by calling	1704	object is created, you can also do that at a later time by calling
1193	C<starttls>.	1705	C<starttls>.
1194		1706
		1707	Starting TLS is currently an asynchronous operation - when you push some
		1708	write data and then call C<< ->starttls >> then TLS negotiation will start
		1709	immediately, after which the queued write data is then sent.
		1710
1195	The first argument is the same as the C<tls> constructor argument (either	1711	The first argument is the same as the C<tls> constructor argument (either
1196	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1712	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1197		1713
1198	The second argument is the optional C<Net::SSLeay::CTX> object that is	1714	The second argument is the optional C<AnyEvent::TLS> object that is used
1199	used when AnyEvent::Handle has to create its own TLS connection object.	1715	when AnyEvent::Handle has to create its own TLS connection object, or
		1716	a hash reference with C<< key => value >> pairs that will be used to
		1717	construct a new context.
1200		1718
1201	The TLS connection object will end up in C<< $handle->{tls} >> after this	1719	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1202	call and can be used or changed to your liking. Note that the handshake	1720	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1203	might have already started when this function returns.	1721	changed to your liking. Note that the handshake might have already started
		1722	when this function returns.
1204		1723
		1724	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		1725	handshakes on the same stream. Best do not attempt to use the stream after
		1726	stopping TLS.
		1727
1205	=cut	1728	=cut
		1729
		1730	our %TLS_CACHE; #TODO not yet documented, should we?
1206		1731
1207	sub starttls {	1732	sub starttls {
1208	my ($self, $ssl, $ctx) = @_;	1733	my ($self, $tls, $ctx) = @_;
1209		1734
1210	$self->stoptls;	1735	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1736	if $self->{tls};
1211		1737
1212	if ($ssl eq "accept") {	1738	$self->{tls} = $tls;
1213	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1739	$self->{tls_ctx} = $ctx if @_ > 2;
1214	Net::SSLeay::set_accept_state ($ssl);	1740
1215	} elsif ($ssl eq "connect") {	1741	return unless $self->{fh};
1216	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1742
1217	Net::SSLeay::set_connect_state ($ssl);	1743	require Net::SSLeay;
		1744
		1745	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1746	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1747
		1748	$tls = $self->{tls};
		1749	$ctx = $self->{tls_ctx};
		1750
		1751	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1752
		1753	if ("HASH" eq ref $ctx) {
		1754	require AnyEvent::TLS;
		1755
		1756	if ($ctx->{cache}) {
		1757	my $key = $ctx+0;
		1758	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1759	} else {
		1760	$ctx = new AnyEvent::TLS %$ctx;
		1761	}
		1762	}
1218	}	1763
1219		1764	$self->{tls_ctx} = $ctx || TLS_CTX ();
1220	$self->{tls} = $ssl;	1765	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1221		1766
1222	# basically, this is deep magic (because SSL_read should have the same issues)	1767	# basically, this is deep magic (because SSL_read should have the same issues)
1223	# but the openssl maintainers basically said: "trust us, it just works".	1768	# but the openssl maintainers basically said: "trust us, it just works".
1224	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1769	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1225	# and mismaintained ssleay-module doesn't even offer them).	1770	# and mismaintained ssleay-module doesn't even offer them).
1226	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1771	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1772	#
		1773	# in short: this is a mess.
		1774	#
		1775	# note that we do not try to keep the length constant between writes as we are required to do.
		1776	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1777	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1778	# have identity issues in that area.
1227	Net::SSLeay::CTX_set_mode ($self->{tls},	1779	# Net::SSLeay::CTX_set_mode ($ssl,
1228	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1780	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1229	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1781	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1782	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1230		1783
1231	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1784	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1232	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1785	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1233		1786
		1787	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1788
1234	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1789	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1235		1790
1236	$self->{filter_w} = sub {	1791	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1237	$_[0]{_tls_wbuf} .= ${$_[1]};	1792	if $self->{on_starttls};
1238	&_dotls;	1793
1239	};	1794	&_dotls; # need to trigger the initial handshake
1240	$self->{filter_r} = sub {	1795	$self->start_read; # make sure we actually do read
1241	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1242	&_dotls;
1243	};
1244	}	1796	}
1245		1797
1246	=item $handle->stoptls	1798	=item $handle->stoptls
1247		1799
1248	Destroys the SSL connection, if any. Partial read or write data will be	1800	Shuts down the SSL connection - this makes a proper EOF handshake by
1249	lost.	1801	sending a close notify to the other side, but since OpenSSL doesn't
		1802	support non-blocking shut downs, it is not guarenteed that you can re-use
		1803	the stream afterwards.
1250		1804
1251	=cut	1805	=cut
1252		1806
1253	sub stoptls {	1807	sub stoptls {
1254	my ($self) = @_;	1808	my ($self) = @_;
1255		1809
1256	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1810	if ($self->{tls}) {
		1811	Net::SSLeay::shutdown ($self->{tls});
1257		1812
1258	delete $self->{_rbio};	1813	&_dotls;
1259	delete $self->{_wbio};	1814
1260	delete $self->{_tls_wbuf};	1815	# # we don't give a shit. no, we do, but we can't. no...#d#
1261	delete $self->{filter_r};	1816	# # we, we... have to use openssl :/#d#
1262	delete $self->{filter_w};	1817	# &_freetls;#d#
		1818	}
		1819	}
		1820
		1821	sub _freetls {
		1822	my ($self) = @_;
		1823
		1824	return unless $self->{tls};
		1825
		1826	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1827	if $self->{tls} > 0;
		1828
		1829	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1263	}	1830	}
1264		1831
1265	sub DESTROY {	1832	sub DESTROY {
1266	my $self = shift;	1833	my ($self) = @_;
1267		1834
1268	$self->stoptls;	1835	&_freetls;
1269		1836
1270	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1837	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1271		1838
1272	if ($linger && length $self->{wbuf}) {	1839	if ($linger && length $self->{wbuf} && $self->{fh}) {
1273	my $fh = delete $self->{fh};	1840	my $fh = delete $self->{fh};
1274	my $wbuf = delete $self->{wbuf};	1841	my $wbuf = delete $self->{wbuf};
1275		1842
1276	my @linger;	1843	my @linger;
1277		1844
1278	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1845	push @linger, AE::io $fh, 1, sub {
1279	my $len = syswrite $fh, $wbuf, length $wbuf;	1846	my $len = syswrite $fh, $wbuf, length $wbuf;
1280		1847
1281	if ($len > 0) {	1848	if ($len > 0) {
1282	substr $wbuf, 0, $len, "";	1849	substr $wbuf, 0, $len, "";
1283	} else {	1850	} else {
1284	@linger = (); # end	1851	@linger = (); # end
1285	}	1852	}
1286	});	1853	};
1287	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1854	push @linger, AE::timer $linger, 0, sub {
1288	@linger = ();	1855	@linger = ();
1289	});	1856	};
1290	}	1857	}
		1858	}
		1859
		1860	=item $handle->destroy
		1861
		1862	Shuts down the handle object as much as possible - this call ensures that
		1863	no further callbacks will be invoked and as many resources as possible
		1864	will be freed. Any method you will call on the handle object after
		1865	destroying it in this way will be silently ignored (and it will return the
		1866	empty list).
		1867
		1868	Normally, you can just "forget" any references to an AnyEvent::Handle
		1869	object and it will simply shut down. This works in fatal error and EOF
		1870	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1871	callback, so when you want to destroy the AnyEvent::Handle object from
		1872	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1873	that case.
		1874
		1875	Destroying the handle object in this way has the advantage that callbacks
		1876	will be removed as well, so if those are the only reference holders (as
		1877	is common), then one doesn't need to do anything special to break any
		1878	reference cycles.
		1879
		1880	The handle might still linger in the background and write out remaining
		1881	data, as specified by the C<linger> option, however.
		1882
		1883	=cut
		1884
		1885	sub destroy {
		1886	my ($self) = @_;
		1887
		1888	$self->DESTROY;
		1889	%$self = ();
		1890	bless $self, "AnyEvent::Handle::destroyed";
		1891	}
		1892
		1893	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1894	#nop
1291	}	1895	}
1292		1896
1293	=item AnyEvent::Handle::TLS_CTX	1897	=item AnyEvent::Handle::TLS_CTX
1294		1898
1295	This function creates and returns the Net::SSLeay::CTX object used by	1899	This function creates and returns the AnyEvent::TLS object used by default
1296	default for TLS mode.	1900	for TLS mode.
1297		1901
1298	The context is created like this:	1902	The context is created by calling L<AnyEvent::TLS> without any arguments.
1299
1300	Net::SSLeay::load_error_strings;
1301	Net::SSLeay::SSLeay_add_ssl_algorithms;
1302	Net::SSLeay::randomize;
1303
1304	my $CTX = Net::SSLeay::CTX_new;
1305
1306	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1307		1903
1308	=cut	1904	=cut
1309		1905
1310	our $TLS_CTX;	1906	our $TLS_CTX;
1311		1907
1312	sub TLS_CTX() {	1908	sub TLS_CTX() {
1313	$TLS_CTX || do {	1909	$TLS_CTX ||= do {
1314	require Net::SSLeay;	1910	require AnyEvent::TLS;
1315		1911
1316	Net::SSLeay::load_error_strings ();	1912	new AnyEvent::TLS
1317	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1318	Net::SSLeay::randomize ();
1319
1320	$TLS_CTX = Net::SSLeay::CTX_new ();
1321
1322	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1323
1324	$TLS_CTX
1325	}	1913	}
1326	}	1914	}
1327		1915
1328	=back	1916	=back
		1917
		1918
		1919	=head1 NONFREQUENTLY ASKED QUESTIONS
		1920
		1921	=over 4
		1922
		1923	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1924	still get further invocations!
		1925
		1926	That's because AnyEvent::Handle keeps a reference to itself when handling
		1927	read or write callbacks.
		1928
		1929	It is only safe to "forget" the reference inside EOF or error callbacks,
		1930	from within all other callbacks, you need to explicitly call the C<<
		1931	->destroy >> method.
		1932
		1933	=item I get different callback invocations in TLS mode/Why can't I pause
		1934	reading?
		1935
		1936	Unlike, say, TCP, TLS connections do not consist of two independent
		1937	communication channels, one for each direction. Or put differently. The
		1938	read and write directions are not independent of each other: you cannot
		1939	write data unless you are also prepared to read, and vice versa.
		1940
		1941	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1942	callback invocations when you are not expecting any read data - the reason
		1943	is that AnyEvent::Handle always reads in TLS mode.
		1944
		1945	During the connection, you have to make sure that you always have a
		1946	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1947	connection (or when you no longer want to use it) you can call the
		1948	C<destroy> method.
		1949
		1950	=item How do I read data until the other side closes the connection?
		1951
		1952	If you just want to read your data into a perl scalar, the easiest way
		1953	to achieve this is by setting an C<on_read> callback that does nothing,
		1954	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1955	will be in C<$_[0]{rbuf}>:
		1956
		1957	$handle->on_read (sub { });
		1958	$handle->on_eof (undef);
		1959	$handle->on_error (sub {
		1960	my $data = delete $_[0]{rbuf};
		1961	});
		1962
		1963	The reason to use C<on_error> is that TCP connections, due to latencies
		1964	and packets loss, might get closed quite violently with an error, when in
		1965	fact, all data has been received.
		1966
		1967	It is usually better to use acknowledgements when transferring data,
		1968	to make sure the other side hasn't just died and you got the data
		1969	intact. This is also one reason why so many internet protocols have an
		1970	explicit QUIT command.
		1971
		1972	=item I don't want to destroy the handle too early - how do I wait until
		1973	all data has been written?
		1974
		1975	After writing your last bits of data, set the C<on_drain> callback
		1976	and destroy the handle in there - with the default setting of
		1977	C<low_water_mark> this will be called precisely when all data has been
		1978	written to the socket:
		1979
		1980	$handle->push_write (...);
		1981	$handle->on_drain (sub {
		1982	warn "all data submitted to the kernel\n";
		1983	undef $handle;
		1984	});
		1985
		1986	If you just want to queue some data and then signal EOF to the other side,
		1987	consider using C<< ->push_shutdown >> instead.
		1988
		1989	=item I want to contact a TLS/SSL server, I don't care about security.
		1990
		1991	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1992	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1993	parameter:
		1994
		1995	tcp_connect $host, $port, sub {
		1996	my ($fh) = @_;
		1997
		1998	my $handle = new AnyEvent::Handle
		1999	fh => $fh,
		2000	tls => "connect",
		2001	on_error => sub { ... };
		2002
		2003	$handle->push_write (...);
		2004	};
		2005
		2006	=item I want to contact a TLS/SSL server, I do care about security.
		2007
		2008	Then you should additionally enable certificate verification, including
		2009	peername verification, if the protocol you use supports it (see
		2010	L<AnyEvent::TLS>, C<verify_peername>).
		2011
		2012	E.g. for HTTPS:
		2013
		2014	tcp_connect $host, $port, sub {
		2015	my ($fh) = @_;
		2016
		2017	my $handle = new AnyEvent::Handle
		2018	fh => $fh,
		2019	peername => $host,
		2020	tls => "connect",
		2021	tls_ctx => { verify => 1, verify_peername => "https" },
		2022	...
		2023
		2024	Note that you must specify the hostname you connected to (or whatever
		2025	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2026	peername verification will be done.
		2027
		2028	The above will use the system-dependent default set of trusted CA
		2029	certificates. If you want to check against a specific CA, add the
		2030	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2031
		2032	tls_ctx => {
		2033	verify => 1,
		2034	verify_peername => "https",
		2035	ca_file => "my-ca-cert.pem",
		2036	},
		2037
		2038	=item I want to create a TLS/SSL server, how do I do that?
		2039
		2040	Well, you first need to get a server certificate and key. You have
		2041	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2042	self-signed certificate (cheap. check the search engine of your choice,
		2043	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2044	nice program for that purpose).
		2045
		2046	Then create a file with your private key (in PEM format, see
		2047	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2048	file should then look like this:
		2049
		2050	-----BEGIN RSA PRIVATE KEY-----
		2051	...header data
		2052	... lots of base64'y-stuff
		2053	-----END RSA PRIVATE KEY-----
		2054
		2055	-----BEGIN CERTIFICATE-----
		2056	... lots of base64'y-stuff
		2057	-----END CERTIFICATE-----
		2058
		2059	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2060	specify this file as C<cert_file>:
		2061
		2062	tcp_server undef, $port, sub {
		2063	my ($fh) = @_;
		2064
		2065	my $handle = new AnyEvent::Handle
		2066	fh => $fh,
		2067	tls => "accept",
		2068	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2069	...
		2070
		2071	When you have intermediate CA certificates that your clients might not
		2072	know about, just append them to the C<cert_file>.
		2073
		2074	=back
		2075
1329		2076
1330	=head1 SUBCLASSING AnyEvent::Handle	2077	=head1 SUBCLASSING AnyEvent::Handle
1331		2078
1332	In many cases, you might want to subclass AnyEvent::Handle.	2079	In many cases, you might want to subclass AnyEvent::Handle.
1333		2080
…		…
1337	=over 4	2084	=over 4
1338		2085
1339	=item * all constructor arguments become object members.	2086	=item * all constructor arguments become object members.
1340		2087
1341	At least initially, when you pass a C<tls>-argument to the constructor it	2088	At least initially, when you pass a C<tls>-argument to the constructor it
1342	will end up in C<< $handle->{tls} >>. Those members might be changes or	2089	will end up in C<< $handle->{tls} >>. Those members might be changed or
1343	mutated later on (for example C<tls> will hold the TLS connection object).	2090	mutated later on (for example C<tls> will hold the TLS connection object).
1344		2091
1345	=item * other object member names are prefixed with an C<_>.	2092	=item * other object member names are prefixed with an C<_>.
1346		2093
1347	All object members not explicitly documented (internal use) are prefixed	2094	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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