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.40 by root, Tue May 27 05:36:27 2008 UTC vs.
Revision 1.174 by root, Sat Aug 8 20:52:06 2009 UTC

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

Diff Legend

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