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.39 by root, Tue May 27 04:59:51 2008 UTC vs.
Revision 1.161 by root, Sat Jul 25 06:16:45 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.86;
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->($self)	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->($self)	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->($self)	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<$self->{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->()	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
173	=item filter_r => $cb	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.
174		361
175	=item filter_w => $cb	362	=item on_starttls => $cb->($handle, $success[, $error_message])
176		363
177	These exist, but are undocumented at this time.	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
		394	=item json => JSON or JSON::XS object
		395
		396	This is the json coder object used by the C<json> read and write types.
		397
		398	If you don't supply it, then AnyEvent::Handle will create and use a
		399	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		400	texts.
		401
		402	Note that you are responsible to depend on the JSON module if you want to
		403	use this functionality, as AnyEvent does not have a dependency itself.
178		404
179	=back	405	=back
180		406
181	=cut	407	=cut
182		408
183	sub new {	409	sub new {
184	my $class = shift;	410	my $class = shift;
185
186	my $self = bless { @_ }, $class;	411	my $self = bless { @_ }, $class;
187		412
188	$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) = @_;
189		476
190	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
191		478
192	if ($self->{tls}) {	479	$self->{_activity} = AnyEvent->now;
193	require Net::SSLeay;	480	$self->_timeout;
		481
		482	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		483
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	484	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
195	}	485	if $self->{tls};
196		486
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};
198	$self->on_error (delete $self->{on_error}) if $self->{on_error};
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
201		488
202	$self->start_read;	489	$self->start_read
		490	if $self->{on_read} || @{ $self->{_queue} };
203		491
204	$self	492	$self->_drain_wbuf;
205	}	493	}
206		494
207	sub _shutdown {	495	#sub _shutdown {
208	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	#}
209		503
210	delete $self->{_rw};
211	delete $self->{_ww};
212	delete $self->{fh};
213	}
214
215	sub error {	504	sub _error {
216	my ($self) = @_;	505	my ($self, $errno, $fatal, $message) = @_;
217		506
218	{	507	$! = $errno;
219	local $!;	508	$message ||= "$!";
220	$self->_shutdown;
221	}
222		509
223	$self->{on_error}($self)
224	if $self->{on_error};	510	if ($self->{on_error}) {
225		511	$self->{on_error}($self, $fatal, $message);
		512	$self->destroy if $fatal;
		513	} elsif ($self->{fh}) {
		514	$self->destroy;
226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	515	Carp::croak "AnyEvent::Handle uncaught error: $message";
		516	}
227	}	517	}
228		518
229	=item $fh = $handle->fh	519	=item $fh = $handle->fh
230		520
231	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.
232		522
233	=cut	523	=cut
234		524
235	sub fh { $_[0]{fh} }	525	sub fh { $_[0]{fh} }
236		526
…		…
252		542
253	sub on_eof {	543	sub on_eof {
254	$_[0]{on_eof} = $_[1];	544	$_[0]{on_eof} = $_[1];
255	}	545	}
256		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	#############################################################################
		608
		609	=item $handle->timeout ($seconds)
		610
		611	Configures (or disables) the inactivity timeout.
		612
		613	=cut
		614
		615	sub timeout {
		616	my ($self, $timeout) = @_;
		617
		618	$self->{timeout} = $timeout;
		619	$self->_timeout;
		620	}
		621
		622	# reset the timeout watcher, as neccessary
		623	# also check for time-outs
		624	sub _timeout {
		625	my ($self) = @_;
		626
		627	if ($self->{timeout} && $self->{fh}) {
		628	my $NOW = AnyEvent->now;
		629
		630	# when would the timeout trigger?
		631	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		632
		633	# now or in the past already?
		634	if ($after <= 0) {
		635	$self->{_activity} = $NOW;
		636
		637	if ($self->{on_timeout}) {
		638	$self->{on_timeout}($self);
		639	} else {
		640	$self->_error (Errno::ETIMEDOUT);
		641	}
		642
		643	# callback could have changed timeout value, optimise
		644	return unless $self->{timeout};
		645
		646	# calculate new after
		647	$after = $self->{timeout};
		648	}
		649
		650	Scalar::Util::weaken $self;
		651	return unless $self; # ->error could have destroyed $self
		652
		653	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
		654	delete $self->{_tw};
		655	$self->_timeout;
		656	});
		657	} else {
		658	delete $self->{_tw};
		659	}
		660	}
		661
257	#############################################################################	662	#############################################################################
258		663
259	=back	664	=back
260		665
261	=head2 WRITE QUEUE	666	=head2 WRITE QUEUE
…		…
282	my ($self, $cb) = @_;	687	my ($self, $cb) = @_;
283		688
284	$self->{on_drain} = $cb;	689	$self->{on_drain} = $cb;
285		690
286	$cb->($self)	691	$cb->($self)
287	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	692	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
288	}	693	}
289		694
290	=item $handle->push_write ($data)	695	=item $handle->push_write ($data)
291		696
292	Queues the given scalar to be written. You can push as much data as you	697	Queues the given scalar to be written. You can push as much data as you
…		…
303	Scalar::Util::weaken $self;	708	Scalar::Util::weaken $self;
304		709
305	my $cb = sub {	710	my $cb = sub {
306	my $len = syswrite $self->{fh}, $self->{wbuf};	711	my $len = syswrite $self->{fh}, $self->{wbuf};
307		712
308	if ($len >= 0) {	713	if (defined $len) {
309	substr $self->{wbuf}, 0, $len, "";	714	substr $self->{wbuf}, 0, $len, "";
310		715
		716	$self->{_activity} = AnyEvent->now;
		717
311	$self->{on_drain}($self)	718	$self->{on_drain}($self)
312	if $self->{low_water_mark} >= length $self->{wbuf}	719	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
313	&& $self->{on_drain};	720	&& $self->{on_drain};
314		721
315	delete $self->{_ww} unless length $self->{wbuf};	722	delete $self->{_ww} unless length $self->{wbuf};
316	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	723	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
317	$self->error;	724	$self->_error ($!, 1);
318	}	725	}
319	};	726	};
320		727
321	# try to write data immediately	728	# try to write data immediately
322	$cb->();	729	$cb->() unless $self->{autocork};
323		730
324	# if still data left in wbuf, we need to poll	731	# if still data left in wbuf, we need to poll
325	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	732	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
326	if length $self->{wbuf};	733	if length $self->{wbuf};
327	};	734	};
…		…
341		748
342	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	749	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
343	->($self, @_);	750	->($self, @_);
344	}	751	}
345		752
346	if ($self->{filter_w}) {	753	if ($self->{tls}) {
347	$self->{filter_w}->($self, \$_[0]);	754	$self->{_tls_wbuf} .= $_[0];
		755	&_dotls ($self) if $self->{fh};
348	} else {	756	} else {
349	$self->{wbuf} .= $_[0];	757	$self->{wbuf} .= $_[0];
350	$self->_drain_wbuf;	758	$self->_drain_wbuf if $self->{fh};
351	}	759	}
352	}	760	}
353		761
354	=item $handle->push_write (type => @args)	762	=item $handle->push_write (type => @args)
355
356	=item $handle->unshift_write (type => @args)
357		763
358	Instead of formatting your data yourself, you can also let this module do	764	Instead of formatting your data yourself, you can also let this module do
359	the job by specifying a type and type-specific arguments.	765	the job by specifying a type and type-specific arguments.
360		766
361	Predefined types are (if you have ideas for additional types, feel free to	767	Predefined types are (if you have ideas for additional types, feel free to
…		…
366	=item netstring => $string	772	=item netstring => $string
367		773
368	Formats the given value as netstring	774	Formats the given value as netstring
369	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	775	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
370		776
371	=back
372
373	=cut	777	=cut
374		778
375	register_write_type netstring => sub {	779	register_write_type netstring => sub {
376	my ($self, $string) = @_;	780	my ($self, $string) = @_;
377		781
378	sprintf "%d:%s,", (length $string), $string	782	(length $string) . ":$string,"
379	};	783	};
380		784
		785	=item packstring => $format, $data
		786
		787	An octet string prefixed with an encoded length. The encoding C<$format>
		788	uses the same format as a Perl C<pack> format, but must specify a single
		789	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		790	optional C<!>, C<< < >> or C<< > >> modifier).
		791
		792	=cut
		793
		794	register_write_type packstring => sub {
		795	my ($self, $format, $string) = @_;
		796
		797	pack "$format/a*", $string
		798	};
		799
381	=item json => $array_or_hashref	800	=item json => $array_or_hashref
382		801
		802	Encodes the given hash or array reference into a JSON object. Unless you
		803	provide your own JSON object, this means it will be encoded to JSON text
		804	in UTF-8.
		805
		806	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		807	one end of a handle and read them at the other end without using any
		808	additional framing.
		809
		810	The generated JSON text is guaranteed not to contain any newlines: While
		811	this module doesn't need delimiters after or between JSON texts to be
		812	able to read them, many other languages depend on that.
		813
		814	A simple RPC protocol that interoperates easily with others is to send
		815	JSON arrays (or objects, although arrays are usually the better choice as
		816	they mimic how function argument passing works) and a newline after each
		817	JSON text:
		818
		819	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		820	$handle->push_write ("\012");
		821
		822	An AnyEvent::Handle receiver would simply use the C<json> read type and
		823	rely on the fact that the newline will be skipped as leading whitespace:
		824
		825	$handle->push_read (json => sub { my $array = $_[1]; ... });
		826
		827	Other languages could read single lines terminated by a newline and pass
		828	this line into their JSON decoder of choice.
		829
		830	=cut
		831
		832	register_write_type json => sub {
		833	my ($self, $ref) = @_;
		834
		835	require JSON;
		836
		837	$self->{json} ? $self->{json}->encode ($ref)
		838	: JSON::encode_json ($ref)
		839	};
		840
		841	=item storable => $reference
		842
		843	Freezes the given reference using L<Storable> and writes it to the
		844	handle. Uses the C<nfreeze> format.
		845
		846	=cut
		847
		848	register_write_type storable => sub {
		849	my ($self, $ref) = @_;
		850
		851	require Storable;
		852
		853	pack "w/a*", Storable::nfreeze ($ref)
		854	};
		855
		856	=back
		857
		858	=item $handle->push_shutdown
		859
		860	Sometimes you know you want to close the socket after writing your data
		861	before it was actually written. One way to do that is to replace your
		862	C<on_drain> handler by a callback that shuts down the socket (and set
		863	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		864	replaces the C<on_drain> callback with:
		865
		866	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		867
		868	This simply shuts down the write side and signals an EOF condition to the
		869	the peer.
		870
		871	You can rely on the normal read queue and C<on_eof> handling
		872	afterwards. This is the cleanest way to close a connection.
		873
		874	=cut
		875
		876	sub push_shutdown {
		877	my ($self) = @_;
		878
		879	delete $self->{low_water_mark};
		880	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		881	}
		882
383	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	883	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
384		884
385	This function (not method) lets you add your own types to C<push_write>.	885	This function (not method) lets you add your own types to C<push_write>.
386	Whenever the given C<type> is used, C<push_write> will invoke the code	886	Whenever the given C<type> is used, C<push_write> will invoke the code
387	reference with the handle object and the remaining arguments.	887	reference with the handle object and the remaining arguments.
388		888
…		…
407	ways, the "simple" way, using only C<on_read> and the "complex" way, using	907	ways, the "simple" way, using only C<on_read> and the "complex" way, using
408	a queue.	908	a queue.
409		909
410	In the simple case, you just install an C<on_read> callback and whenever	910	In the simple case, you just install an C<on_read> callback and whenever
411	new data arrives, it will be called. You can then remove some data (if	911	new data arrives, it will be called. You can then remove some data (if
412	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	912	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
413	or not.	913	leave the data there if you want to accumulate more (e.g. when only a
		914	partial message has been received so far).
414		915
415	In the more complex case, you want to queue multiple callbacks. In this	916	In the more complex case, you want to queue multiple callbacks. In this
416	case, AnyEvent::Handle will call the first queued callback each time new	917	case, AnyEvent::Handle will call the first queued callback each time new
417	data arrives and removes it when it has done its job (see C<push_read>,	918	data arrives (also the first time it is queued) and removes it when it has
418	below).	919	done its job (see C<push_read>, below).
419		920
420	This way you can, for example, push three line-reads, followed by reading	921	This way you can, for example, push three line-reads, followed by reading
421	a chunk of data, and AnyEvent::Handle will execute them in order.	922	a chunk of data, and AnyEvent::Handle will execute them in order.
422		923
423	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	924	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
424	the specified number of bytes which give an XML datagram.	925	the specified number of bytes which give an XML datagram.
425		926
426	# in the default state, expect some header bytes	927	# in the default state, expect some header bytes
427	$handle->on_read (sub {	928	$handle->on_read (sub {
428	# some data is here, now queue the length-header-read (4 octets)	929	# some data is here, now queue the length-header-read (4 octets)
429	shift->unshift_read_chunk (4, sub {	930	shift->unshift_read (chunk => 4, sub {
430	# header arrived, decode	931	# header arrived, decode
431	my $len = unpack "N", $_[1];	932	my $len = unpack "N", $_[1];
432		933
433	# now read the payload	934	# now read the payload
434	shift->unshift_read_chunk ($len, sub {	935	shift->unshift_read (chunk => $len, sub {
435	my $xml = $_[1];	936	my $xml = $_[1];
436	# handle xml	937	# handle xml
437	});	938	});
438	});	939	});
439	});	940	});
440		941
441	Example 2: Implement a client for a protocol that replies either with	942	Example 2: Implement a client for a protocol that replies either with "OK"
442	"OK" and another line or "ERROR" for one request, and 64 bytes for the	943	and another line or "ERROR" for the first request that is sent, and 64
443	second request. Due tot he availability of a full queue, we can just	944	bytes for the second request. Due to the availability of a queue, we can
444	pipeline sending both requests and manipulate the queue as necessary in	945	just pipeline sending both requests and manipulate the queue as necessary
445	the callbacks:	946	in the callbacks.
446		947
447	# request one	948	When the first callback is called and sees an "OK" response, it will
		949	C<unshift> another line-read. This line-read will be queued I<before> the
		950	64-byte chunk callback.
		951
		952	# request one, returns either "OK + extra line" or "ERROR"
448	$handle->push_write ("request 1\015\012");	953	$handle->push_write ("request 1\015\012");
449		954
450	# we expect "ERROR" or "OK" as response, so push a line read	955	# we expect "ERROR" or "OK" as response, so push a line read
451	$handle->push_read_line (sub {	956	$handle->push_read (line => sub {
452	# if we got an "OK", we have to _prepend_ another line,	957	# if we got an "OK", we have to _prepend_ another line,
453	# so it will be read before the second request reads its 64 bytes	958	# so it will be read before the second request reads its 64 bytes
454	# which are already in the queue when this callback is called	959	# which are already in the queue when this callback is called
455	# we don't do this in case we got an error	960	# we don't do this in case we got an error
456	if ($_[1] eq "OK") {	961	if ($_[1] eq "OK") {
457	$_[0]->unshift_read_line (sub {	962	$_[0]->unshift_read (line => sub {
458	my $response = $_[1];	963	my $response = $_[1];
459	...	964	...
460	});	965	});
461	}	966	}
462	});	967	});
463		968
464	# request two	969	# request two, simply returns 64 octets
465	$handle->push_write ("request 2\015\012");	970	$handle->push_write ("request 2\015\012");
466		971
467	# simply read 64 bytes, always	972	# simply read 64 bytes, always
468	$handle->push_read_chunk (64, sub {	973	$handle->push_read (chunk => 64, sub {
469	my $response = $_[1];	974	my $response = $_[1];
470	...	975	...
471	});	976	});
472		977
473	=over 4	978	=over 4
474		979
475	=cut	980	=cut
476		981
477	sub _drain_rbuf {	982	sub _drain_rbuf {
478	my ($self) = @_;	983	my ($self) = @_;
		984
		985	# avoid recursion
		986	return if exists $self->{_skip_drain_rbuf};
		987	local $self->{_skip_drain_rbuf} = 1;
479		988
480	if (	989	if (
481	defined $self->{rbuf_max}	990	defined $self->{rbuf_max}
482	&& $self->{rbuf_max} < length $self->{rbuf}	991	&& $self->{rbuf_max} < length $self->{rbuf}
483	) {	992	) {
484	$! = &Errno::ENOSPC;	993	$self->_error (Errno::ENOSPC, 1), return;
485	$self->error;
486	}	994	}
487		995
488	return if $self->{in_drain};	996	while () {
489	local $self->{in_drain} = 1;	997	# we need to use a separate tls read buffer, as we must not receive data while
		998	# we are draining the buffer, and this can only happen with TLS.
		999	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
490		1000
491	while (my $len = length $self->{rbuf}) {	1001	my $len = length $self->{rbuf};
492	no strict 'refs';	1002
493	if (my $cb = shift @{ $self->{_queue} }) {	1003	if (my $cb = shift @{ $self->{_queue} }) {
494	unless ($cb->($self)) {	1004	unless ($cb->($self)) {
495	if ($self->{_eof}) {	1005	if ($self->{_eof}) {
496	# no progress can be made (not enough data and no data forthcoming)	1006	# no progress can be made (not enough data and no data forthcoming)
497	$! = &Errno::EPIPE;	1007	$self->_error (Errno::EPIPE, 1), return;
498	$self->error;
499	}	1008	}
500		1009
501	unshift @{ $self->{_queue} }, $cb;	1010	unshift @{ $self->{_queue} }, $cb;
502	return;	1011	last;
503	}	1012	}
504	} elsif ($self->{on_read}) {	1013	} elsif ($self->{on_read}) {
		1014	last unless $len;
		1015
505	$self->{on_read}($self);	1016	$self->{on_read}($self);
506		1017
507	if (	1018	if (
508	$self->{_eof} # if no further data will arrive
509	&& $len == length $self->{rbuf} # and no data has been consumed	1019	$len == length $self->{rbuf} # if no data has been consumed
510	&& !@{ $self->{_queue} } # and the queue is still empty	1020	&& !@{ $self->{_queue} } # and the queue is still empty
511	&& $self->{on_read} # and we still want to read data	1021	&& $self->{on_read} # but we still have on_read
512	) {	1022	) {
		1023	# no further data will arrive
513	# then no progress can be made	1024	# so no progress can be made
514	$! = &Errno::EPIPE;	1025	$self->_error (Errno::EPIPE, 1), return
515	$self->error;	1026	if $self->{_eof};
		1027
		1028	last; # more data might arrive
516	}	1029	}
517	} else {	1030	} else {
518	# read side becomes idle	1031	# read side becomes idle
519	delete $self->{_rw};	1032	delete $self->{_rw} unless $self->{tls};
520	return;	1033	last;
521	}	1034	}
522	}	1035	}
523		1036
524	if ($self->{_eof}) {	1037	if ($self->{_eof}) {
525	$self->_shutdown;	1038	if ($self->{on_eof}) {
526	$self->{on_eof}($self)	1039	$self->{on_eof}($self)
527	if $self->{on_eof};	1040	} else {
		1041	$self->_error (0, 1, "Unexpected end-of-file");
		1042	}
		1043	}
		1044
		1045	# may need to restart read watcher
		1046	unless ($self->{_rw}) {
		1047	$self->start_read
		1048	if $self->{on_read} || @{ $self->{_queue} };
528	}	1049	}
529	}	1050	}
530		1051
531	=item $handle->on_read ($cb)	1052	=item $handle->on_read ($cb)
532		1053
…		…
538		1059
539	sub on_read {	1060	sub on_read {
540	my ($self, $cb) = @_;	1061	my ($self, $cb) = @_;
541		1062
542	$self->{on_read} = $cb;	1063	$self->{on_read} = $cb;
		1064	$self->_drain_rbuf if $cb;
543	}	1065	}
544		1066
545	=item $handle->rbuf	1067	=item $handle->rbuf
546		1068
547	Returns the read buffer (as a modifiable lvalue).	1069	Returns the read buffer (as a modifiable lvalue).
548		1070
549	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1071	You can access the read buffer directly as the C<< ->{rbuf} >>
550	you want.	1072	member, if you want. However, the only operation allowed on the
		1073	read buffer (apart from looking at it) is removing data from its
		1074	beginning. Otherwise modifying or appending to it is not allowed and will
		1075	lead to hard-to-track-down bugs.
551		1076
552	NOTE: The read buffer should only be used or modified if the C<on_read>,	1077	NOTE: The read buffer should only be used or modified if the C<on_read>,
553	C<push_read> or C<unshift_read> methods are used. The other read methods	1078	C<push_read> or C<unshift_read> methods are used. The other read methods
554	automatically manage the read buffer.	1079	automatically manage the read buffer.
555		1080
…		…
628	Predefined types are (if you have ideas for additional types, feel free to	1153	Predefined types are (if you have ideas for additional types, feel free to
629	drop by and tell us):	1154	drop by and tell us):
630		1155
631	=over 4	1156	=over 4
632		1157
633	=item chunk => $octets, $cb->($self, $data)	1158	=item chunk => $octets, $cb->($handle, $data)
634		1159
635	Invoke the callback only once C<$octets> bytes have been read. Pass the	1160	Invoke the callback only once C<$octets> bytes have been read. Pass the
636	data read to the callback. The callback will never be called with less	1161	data read to the callback. The callback will never be called with less
637	data.	1162	data.
638		1163
…		…
652	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1177	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
653	1	1178	1
654	}	1179	}
655	};	1180	};
656		1181
657	# compatibility with older API
658	sub push_read_chunk {
659	$_[0]->push_read (chunk => $_[1], $_[2]);
660	}
661
662	sub unshift_read_chunk {
663	$_[0]->unshift_read (chunk => $_[1], $_[2]);
664	}
665
666	=item line => [$eol, ]$cb->($self, $line, $eol)	1182	=item line => [$eol, ]$cb->($handle, $line, $eol)
667		1183
668	The callback will be called only once a full line (including the end of	1184	The callback will be called only once a full line (including the end of
669	line marker, C<$eol>) has been read. This line (excluding the end of line	1185	line marker, C<$eol>) has been read. This line (excluding the end of line
670	marker) will be passed to the callback as second argument (C<$line>), and	1186	marker) will be passed to the callback as second argument (C<$line>), and
671	the end of line marker as the third argument (C<$eol>).	1187	the end of line marker as the third argument (C<$eol>).
…		…
685	=cut	1201	=cut
686		1202
687	register_read_type line => sub {	1203	register_read_type line => sub {
688	my ($self, $cb, $eol) = @_;	1204	my ($self, $cb, $eol) = @_;
689		1205
690	$eol = qr|(\015?\012)| if @_ < 3;	1206	if (@_ < 3) {
		1207	# this is more than twice as fast as the generic code below
		1208	sub {
		1209	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		1210
		1211	$cb->($_[0], $1, $2);
		1212	1
		1213	}
		1214	} else {
691	$eol = quotemeta $eol unless ref $eol;	1215	$eol = quotemeta $eol unless ref $eol;
692	$eol = qr|^(.*?)($eol)|s;	1216	$eol = qr|^(.*?)($eol)|s;
693		1217
694	sub {	1218	sub {
695	$_[0]{rbuf} =~ s/$eol// or return;	1219	$_[0]{rbuf} =~ s/$eol// or return;
696		1220
697	$cb->($_[0], $1, $2);	1221	$cb->($_[0], $1, $2);
		1222	1
698	1	1223	}
699	}	1224	}
700	};	1225	};
701		1226
702	# compatibility with older API
703	sub push_read_line {
704	my $self = shift;
705	$self->push_read (line => @_);
706	}
707
708	sub unshift_read_line {
709	my $self = shift;
710	$self->unshift_read (line => @_);
711	}
712
713	=item netstring => $cb->($string)
714
715	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
716
717	Throws an error with C<$!> set to EBADMSG on format violations.
718
719	=cut
720
721	register_read_type netstring => sub {
722	my ($self, $cb) = @_;
723
724	sub {
725	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
726	if ($_[0]{rbuf} =~ /[^0-9]/) {
727	$! = &Errno::EBADMSG;
728	$self->error;
729	}
730	return;
731	}
732
733	my $len = $1;
734
735	$self->unshift_read (chunk => $len, sub {
736	my $string = $_[1];
737	$_[0]->unshift_read (chunk => 1, sub {
738	if ($_[1] eq ",") {
739	$cb->($_[0], $string);
740	} else {
741	$! = &Errno::EBADMSG;
742	$self->error;
743	}
744	});
745	});
746
747	1
748	}
749	};
750
751	=item regex => $accept[, $reject[, $skip], $cb->($data)	1227	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
752		1228
753	Makes a regex match against the regex object C<$accept> and returns	1229	Makes a regex match against the regex object C<$accept> and returns
754	everything up to and including the match.	1230	everything up to and including the match.
755		1231
756	Example: read a single line terminated by '\n'.	1232	Example: read a single line terminated by '\n'.
…		…
804	return 1;	1280	return 1;
805	}	1281	}
806		1282
807	# reject	1283	# reject
808	if ($reject && $$rbuf =~ $reject) {	1284	if ($reject && $$rbuf =~ $reject) {
809	$! = &Errno::EBADMSG;	1285	$self->_error (Errno::EBADMSG);
810	$self->error;
811	}	1286	}
812		1287
813	# skip	1288	# skip
814	if ($skip && $$rbuf =~ $skip) {	1289	if ($skip && $$rbuf =~ $skip) {
815	$data .= substr $$rbuf, 0, $+[0], "";	1290	$data .= substr $$rbuf, 0, $+[0], "";
…		…
817		1292
818	()	1293	()
819	}	1294	}
820	};	1295	};
821		1296
		1297	=item netstring => $cb->($handle, $string)
		1298
		1299	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1300
		1301	Throws an error with C<$!> set to EBADMSG on format violations.
		1302
		1303	=cut
		1304
		1305	register_read_type netstring => sub {
		1306	my ($self, $cb) = @_;
		1307
		1308	sub {
		1309	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
		1310	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1311	$self->_error (Errno::EBADMSG);
		1312	}
		1313	return;
		1314	}
		1315
		1316	my $len = $1;
		1317
		1318	$self->unshift_read (chunk => $len, sub {
		1319	my $string = $_[1];
		1320	$_[0]->unshift_read (chunk => 1, sub {
		1321	if ($_[1] eq ",") {
		1322	$cb->($_[0], $string);
		1323	} else {
		1324	$self->_error (Errno::EBADMSG);
		1325	}
		1326	});
		1327	});
		1328
		1329	1
		1330	}
		1331	};
		1332
		1333	=item packstring => $format, $cb->($handle, $string)
		1334
		1335	An octet string prefixed with an encoded length. The encoding C<$format>
		1336	uses the same format as a Perl C<pack> format, but must specify a single
		1337	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1338	optional C<!>, C<< < >> or C<< > >> modifier).
		1339
		1340	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1341	EPP uses a prefix of C<N> (4 octtes).
		1342
		1343	Example: read a block of data prefixed by its length in BER-encoded
		1344	format (very efficient).
		1345
		1346	$handle->push_read (packstring => "w", sub {
		1347	my ($handle, $data) = @_;
		1348	});
		1349
		1350	=cut
		1351
		1352	register_read_type packstring => sub {
		1353	my ($self, $cb, $format) = @_;
		1354
		1355	sub {
		1356	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1357	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1358	or return;
		1359
		1360	$format = length pack $format, $len;
		1361
		1362	# bypass unshift if we already have the remaining chunk
		1363	if ($format + $len <= length $_[0]{rbuf}) {
		1364	my $data = substr $_[0]{rbuf}, $format, $len;
		1365	substr $_[0]{rbuf}, 0, $format + $len, "";
		1366	$cb->($_[0], $data);
		1367	} else {
		1368	# remove prefix
		1369	substr $_[0]{rbuf}, 0, $format, "";
		1370
		1371	# read remaining chunk
		1372	$_[0]->unshift_read (chunk => $len, $cb);
		1373	}
		1374
		1375	1
		1376	}
		1377	};
		1378
		1379	=item json => $cb->($handle, $hash_or_arrayref)
		1380
		1381	Reads a JSON object or array, decodes it and passes it to the
		1382	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
		1383
		1384	If a C<json> object was passed to the constructor, then that will be used
		1385	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1386
		1387	This read type uses the incremental parser available with JSON version
		1388	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1389	dependency on your own: this module will load the JSON module, but
		1390	AnyEvent does not depend on it itself.
		1391
		1392	Since JSON texts are fully self-delimiting, the C<json> read and write
		1393	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1394	the C<json> write type description, above, for an actual example.
		1395
		1396	=cut
		1397
		1398	register_read_type json => sub {
		1399	my ($self, $cb) = @_;
		1400
		1401	my $json = $self->{json} ||=
		1402	eval { require JSON::XS; JSON::XS->new->utf8 }
		1403	|| do { require JSON; JSON->new->utf8 };
		1404
		1405	my $data;
		1406	my $rbuf = \$self->{rbuf};
		1407
		1408	sub {
		1409	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
		1410
		1411	if ($ref) {
		1412	$self->{rbuf} = $json->incr_text;
		1413	$json->incr_text = "";
		1414	$cb->($self, $ref);
		1415
		1416	1
		1417	} elsif ($@) {
		1418	# error case
		1419	$json->incr_skip;
		1420
		1421	$self->{rbuf} = $json->incr_text;
		1422	$json->incr_text = "";
		1423
		1424	$self->_error (Errno::EBADMSG);
		1425
		1426	()
		1427	} else {
		1428	$self->{rbuf} = "";
		1429
		1430	()
		1431	}
		1432	}
		1433	};
		1434
		1435	=item storable => $cb->($handle, $ref)
		1436
		1437	Deserialises a L<Storable> frozen representation as written by the
		1438	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1439	data).
		1440
		1441	Raises C<EBADMSG> error if the data could not be decoded.
		1442
		1443	=cut
		1444
		1445	register_read_type storable => sub {
		1446	my ($self, $cb) = @_;
		1447
		1448	require Storable;
		1449
		1450	sub {
		1451	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1452	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1453	or return;
		1454
		1455	my $format = length pack "w", $len;
		1456
		1457	# bypass unshift if we already have the remaining chunk
		1458	if ($format + $len <= length $_[0]{rbuf}) {
		1459	my $data = substr $_[0]{rbuf}, $format, $len;
		1460	substr $_[0]{rbuf}, 0, $format + $len, "";
		1461	$cb->($_[0], Storable::thaw ($data));
		1462	} else {
		1463	# remove prefix
		1464	substr $_[0]{rbuf}, 0, $format, "";
		1465
		1466	# read remaining chunk
		1467	$_[0]->unshift_read (chunk => $len, sub {
		1468	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1469	$cb->($_[0], $ref);
		1470	} else {
		1471	$self->_error (Errno::EBADMSG);
		1472	}
		1473	});
		1474	}
		1475
		1476	1
		1477	}
		1478	};
		1479
822	=back	1480	=back
823		1481
824	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1482	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
825		1483
826	This function (not method) lets you add your own types to C<push_read>.	1484	This function (not method) lets you add your own types to C<push_read>.
827		1485
828	Whenever the given C<type> is used, C<push_read> will invoke the code	1486	Whenever the given C<type> is used, C<push_read> will invoke the code
829	reference with the handle object, the callback and the remaining	1487	reference with the handle object, the callback and the remaining
…		…
831		1489
832	The code reference is supposed to return a callback (usually a closure)	1490	The code reference is supposed to return a callback (usually a closure)
833	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1491	that works as a plain read callback (see C<< ->push_read ($cb) >>).
834		1492
835	It should invoke the passed callback when it is done reading (remember to	1493	It should invoke the passed callback when it is done reading (remember to
836	pass C<$self> as first argument as all other callbacks do that).	1494	pass C<$handle> as first argument as all other callbacks do that).
837		1495
838	Note that this is a function, and all types registered this way will be	1496	Note that this is a function, and all types registered this way will be
839	global, so try to use unique names.	1497	global, so try to use unique names.
840		1498
841	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1499	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
844	=item $handle->stop_read	1502	=item $handle->stop_read
845		1503
846	=item $handle->start_read	1504	=item $handle->start_read
847		1505
848	In rare cases you actually do not want to read anything from the	1506	In rare cases you actually do not want to read anything from the
849	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1507	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
850	any queued callbacks will be executed then. To start reading again, call	1508	any queued callbacks will be executed then. To start reading again, call
851	C<start_read>.	1509	C<start_read>.
852		1510
		1511	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1512	you change the C<on_read> callback or push/unshift a read callback, and it
		1513	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1514	there are any read requests in the queue.
		1515
		1516	These methods will have no effect when in TLS mode (as TLS doesn't support
		1517	half-duplex connections).
		1518
853	=cut	1519	=cut
854		1520
855	sub stop_read {	1521	sub stop_read {
856	my ($self) = @_;	1522	my ($self) = @_;
857		1523
858	delete $self->{_rw};	1524	delete $self->{_rw} unless $self->{tls};
859	}	1525	}
860		1526
861	sub start_read {	1527	sub start_read {
862	my ($self) = @_;	1528	my ($self) = @_;
863		1529
864	unless ($self->{_rw} || $self->{_eof}) {	1530	unless ($self->{_rw} || $self->{_eof}) {
865	Scalar::Util::weaken $self;	1531	Scalar::Util::weaken $self;
866		1532
867	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1533	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
868	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1534	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
869	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1535	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
870		1536
871	if ($len > 0) {	1537	if ($len > 0) {
872	$self->{filter_r}	1538	$self->{_activity} = AnyEvent->now;
873	? $self->{filter_r}->($self, $rbuf)	1539
		1540	if ($self->{tls}) {
		1541	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
		1542
		1543	&_dotls ($self);
		1544	} else {
874	: $self->_drain_rbuf;	1545	$self->_drain_rbuf;
		1546	}
875		1547
876	} elsif (defined $len) {	1548	} elsif (defined $len) {
877	delete $self->{_rw};	1549	delete $self->{_rw};
878	$self->{_eof} = 1;	1550	$self->{_eof} = 1;
879	$self->_drain_rbuf;	1551	$self->_drain_rbuf;
880		1552
881	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1553	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
882	return $self->error;	1554	return $self->_error ($!, 1);
883	}	1555	}
884	});	1556	});
885	}	1557	}
886	}	1558	}
887		1559
		1560	our $ERROR_SYSCALL;
		1561	our $ERROR_WANT_READ;
		1562
		1563	sub _tls_error {
		1564	my ($self, $err) = @_;
		1565
		1566	return $self->_error ($!, 1)
		1567	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1568
		1569	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1570
		1571	# reduce error string to look less scary
		1572	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1573
		1574	if ($self->{_on_starttls}) {
		1575	(delete $self->{_on_starttls})->($self, undef, $err);
		1576	&_freetls;
		1577	} else {
		1578	&_freetls;
		1579	$self->_error (Errno::EPROTO, 1, $err);
		1580	}
		1581	}
		1582
		1583	# poll the write BIO and send the data if applicable
		1584	# also decode read data if possible
		1585	# this is basiclaly our TLS state machine
		1586	# more efficient implementations are possible with openssl,
		1587	# but not with the buggy and incomplete Net::SSLeay.
888	sub _dotls {	1588	sub _dotls {
889	my ($self) = @_;	1589	my ($self) = @_;
890		1590
		1591	my $tmp;
		1592
891	if (length $self->{_tls_wbuf}) {	1593	if (length $self->{_tls_wbuf}) {
892	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1594	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
893	substr $self->{_tls_wbuf}, 0, $len, "";	1595	substr $self->{_tls_wbuf}, 0, $tmp, "";
894	}	1596	}
895	}
896		1597
		1598	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1599	return $self->_tls_error ($tmp)
		1600	if $tmp != $ERROR_WANT_READ
		1601	&& ($tmp != $ERROR_SYSCALL || $!);
		1602	}
		1603
		1604	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1605	unless (length $tmp) {
		1606	$self->{_on_starttls}
		1607	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1608	&_freetls;
		1609
		1610	if ($self->{on_stoptls}) {
		1611	$self->{on_stoptls}($self);
		1612	return;
		1613	} else {
		1614	# let's treat SSL-eof as we treat normal EOF
		1615	delete $self->{_rw};
		1616	$self->{_eof} = 1;
		1617	}
		1618	}
		1619
		1620	$self->{_tls_rbuf} .= $tmp;
		1621	$self->_drain_rbuf;
		1622	$self->{tls} or return; # tls session might have gone away in callback
		1623	}
		1624
		1625	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1626	return $self->_tls_error ($tmp)
		1627	if $tmp != $ERROR_WANT_READ
		1628	&& ($tmp != $ERROR_SYSCALL || $!);
		1629
897	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1630	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
898	$self->{wbuf} .= $buf;	1631	$self->{wbuf} .= $tmp;
899	$self->_drain_wbuf;	1632	$self->_drain_wbuf;
900	}	1633	}
901		1634
902	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1635	$self->{_on_starttls}
903	$self->{rbuf} .= $buf;	1636	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
904	$self->_drain_rbuf;	1637	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
905	}
906
907	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
908
909	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
910	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
911	$self->error;
912	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
913	$! = &Errno::EIO;
914	$self->error;
915	}
916
917	# all others are fine for our purposes
918	}
919	}	1638	}
920		1639
921	=item $handle->starttls ($tls[, $tls_ctx])	1640	=item $handle->starttls ($tls[, $tls_ctx])
922		1641
923	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1642	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
924	object is created, you can also do that at a later time by calling	1643	object is created, you can also do that at a later time by calling
925	C<starttls>.	1644	C<starttls>.
926		1645
		1646	Starting TLS is currently an asynchronous operation - when you push some
		1647	write data and then call C<< ->starttls >> then TLS negotiation will start
		1648	immediately, after which the queued write data is then sent.
		1649
927	The first argument is the same as the C<tls> constructor argument (either	1650	The first argument is the same as the C<tls> constructor argument (either
928	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1651	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
929		1652
930	The second argument is the optional C<Net::SSLeay::CTX> object that is	1653	The second argument is the optional C<AnyEvent::TLS> object that is used
931	used when AnyEvent::Handle has to create its own TLS connection object.	1654	when AnyEvent::Handle has to create its own TLS connection object, or
		1655	a hash reference with C<< key => value >> pairs that will be used to
		1656	construct a new context.
932		1657
933	The TLS connection object will end up in C<< $handle->{tls} >> after this	1658	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
934	call and can be used or changed to your liking. Note that the handshake	1659	context in C<< $handle->{tls_ctx} >> after this call and can be used or
935	might have already started when this function returns.	1660	changed to your liking. Note that the handshake might have already started
		1661	when this function returns.
936		1662
937	=cut	1663	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		1664	handshakes on the same stream. Best do not attempt to use the stream after
		1665	stopping TLS.
938		1666
939	# TODO: maybe document...	1667	=cut
		1668
		1669	our %TLS_CACHE; #TODO not yet documented, should we?
		1670
940	sub starttls {	1671	sub starttls {
941	my ($self, $ssl, $ctx) = @_;	1672	my ($self, $tls, $ctx) = @_;
942		1673
943	$self->stoptls;	1674	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1675	if $self->{tls};
944		1676
945	if ($ssl eq "accept") {	1677	$self->{tls} = $tls;
946	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1678	$self->{tls_ctx} = $ctx if @_ > 2;
947	Net::SSLeay::set_accept_state ($ssl);	1679
948	} elsif ($ssl eq "connect") {	1680	return unless $self->{fh};
949	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1681
950	Net::SSLeay::set_connect_state ($ssl);	1682	require Net::SSLeay;
		1683
		1684	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1685	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1686
		1687	$tls = $self->{tls};
		1688	$ctx = $self->{tls_ctx};
		1689
		1690	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1691
		1692	if ("HASH" eq ref $ctx) {
		1693	require AnyEvent::TLS;
		1694
		1695	if ($ctx->{cache}) {
		1696	my $key = $ctx+0;
		1697	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1698	} else {
		1699	$ctx = new AnyEvent::TLS %$ctx;
		1700	}
		1701	}
951	}	1702
952		1703	$self->{tls_ctx} = $ctx || TLS_CTX ();
953	$self->{tls} = $ssl;	1704	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
954		1705
955	# basically, this is deep magic (because SSL_read should have the same issues)	1706	# basically, this is deep magic (because SSL_read should have the same issues)
956	# but the openssl maintainers basically said: "trust us, it just works".	1707	# but the openssl maintainers basically said: "trust us, it just works".
957	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1708	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
958	# and mismaintained ssleay-module doesn't even offer them).	1709	# and mismaintained ssleay-module doesn't even offer them).
959	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1710	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1711	#
		1712	# in short: this is a mess.
		1713	#
		1714	# note that we do not try to keep the length constant between writes as we are required to do.
		1715	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1716	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1717	# have identity issues in that area.
960	Net::SSLeay::CTX_set_mode ($self->{tls},	1718	# Net::SSLeay::CTX_set_mode ($ssl,
961	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1719	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
962	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1720	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1721	Net::SSLeay::CTX_set_mode ($tls, 1|2);
963		1722
964	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1723	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
965	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1724	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
966		1725
967	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1726	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
968		1727
969	$self->{filter_w} = sub {	1728	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
970	$_[0]{_tls_wbuf} .= ${$_[1]};	1729	if $self->{on_starttls};
971	&_dotls;	1730
972	};	1731	&_dotls; # need to trigger the initial handshake
973	$self->{filter_r} = sub {	1732	$self->start_read; # make sure we actually do read
974	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
975	&_dotls;
976	};
977	}	1733	}
978		1734
979	=item $handle->stoptls	1735	=item $handle->stoptls
980		1736
981	Destroys the SSL connection, if any. Partial read or write data will be	1737	Shuts down the SSL connection - this makes a proper EOF handshake by
982	lost.	1738	sending a close notify to the other side, but since OpenSSL doesn't
		1739	support non-blocking shut downs, it is not guarenteed that you can re-use
		1740	the stream afterwards.
983		1741
984	=cut	1742	=cut
985		1743
986	sub stoptls {	1744	sub stoptls {
987	my ($self) = @_;	1745	my ($self) = @_;
988		1746
989	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1747	if ($self->{tls}) {
		1748	Net::SSLeay::shutdown ($self->{tls});
990		1749
991	delete $self->{_rbio};	1750	&_dotls;
992	delete $self->{_wbio};	1751
993	delete $self->{_tls_wbuf};	1752	# # we don't give a shit. no, we do, but we can't. no...#d#
994	delete $self->{filter_r};	1753	# # we, we... have to use openssl :/#d#
995	delete $self->{filter_w};	1754	# &_freetls;#d#
		1755	}
		1756	}
		1757
		1758	sub _freetls {
		1759	my ($self) = @_;
		1760
		1761	return unless $self->{tls};
		1762
		1763	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1764	if ref $self->{tls};
		1765
		1766	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
996	}	1767	}
997		1768
998	sub DESTROY {	1769	sub DESTROY {
999	my $self = shift;	1770	my ($self) = @_;
1000		1771
1001	$self->stoptls;	1772	&_freetls;
		1773
		1774	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1775
		1776	if ($linger && length $self->{wbuf} && $self->{fh}) {
		1777	my $fh = delete $self->{fh};
		1778	my $wbuf = delete $self->{wbuf};
		1779
		1780	my @linger;
		1781
		1782	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1783	my $len = syswrite $fh, $wbuf, length $wbuf;
		1784
		1785	if ($len > 0) {
		1786	substr $wbuf, 0, $len, "";
		1787	} else {
		1788	@linger = (); # end
		1789	}
		1790	});
		1791	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1792	@linger = ();
		1793	});
		1794	}
		1795	}
		1796
		1797	=item $handle->destroy
		1798
		1799	Shuts down the handle object as much as possible - this call ensures that
		1800	no further callbacks will be invoked and as many resources as possible
		1801	will be freed. You must not call any methods on the object afterwards.
		1802
		1803	Normally, you can just "forget" any references to an AnyEvent::Handle
		1804	object and it will simply shut down. This works in fatal error and EOF
		1805	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1806	callback, so when you want to destroy the AnyEvent::Handle object from
		1807	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1808	that case.
		1809
		1810	Destroying the handle object in this way has the advantage that callbacks
		1811	will be removed as well, so if those are the only reference holders (as
		1812	is common), then one doesn't need to do anything special to break any
		1813	reference cycles.
		1814
		1815	The handle might still linger in the background and write out remaining
		1816	data, as specified by the C<linger> option, however.
		1817
		1818	=cut
		1819
		1820	sub destroy {
		1821	my ($self) = @_;
		1822
		1823	$self->DESTROY;
		1824	%$self = ();
1002	}	1825	}
1003		1826
1004	=item AnyEvent::Handle::TLS_CTX	1827	=item AnyEvent::Handle::TLS_CTX
1005		1828
1006	This function creates and returns the Net::SSLeay::CTX object used by	1829	This function creates and returns the AnyEvent::TLS object used by default
1007	default for TLS mode.	1830	for TLS mode.
1008		1831
1009	The context is created like this:	1832	The context is created by calling L<AnyEvent::TLS> without any arguments.
1010
1011	Net::SSLeay::load_error_strings;
1012	Net::SSLeay::SSLeay_add_ssl_algorithms;
1013	Net::SSLeay::randomize;
1014
1015	my $CTX = Net::SSLeay::CTX_new;
1016
1017	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1018		1833
1019	=cut	1834	=cut
1020		1835
1021	our $TLS_CTX;	1836	our $TLS_CTX;
1022		1837
1023	sub TLS_CTX() {	1838	sub TLS_CTX() {
1024	$TLS_CTX || do {	1839	$TLS_CTX ||= do {
1025	require Net::SSLeay;	1840	require AnyEvent::TLS;
1026		1841
1027	Net::SSLeay::load_error_strings ();	1842	new AnyEvent::TLS
1028	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1029	Net::SSLeay::randomize ();
1030
1031	$TLS_CTX = Net::SSLeay::CTX_new ();
1032
1033	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1034
1035	$TLS_CTX
1036	}	1843	}
1037	}	1844	}
1038		1845
1039	=back	1846	=back
		1847
		1848
		1849	=head1 NONFREQUENTLY ASKED QUESTIONS
		1850
		1851	=over 4
		1852
		1853	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1854	still get further invocations!
		1855
		1856	That's because AnyEvent::Handle keeps a reference to itself when handling
		1857	read or write callbacks.
		1858
		1859	It is only safe to "forget" the reference inside EOF or error callbacks,
		1860	from within all other callbacks, you need to explicitly call the C<<
		1861	->destroy >> method.
		1862
		1863	=item I get different callback invocations in TLS mode/Why can't I pause
		1864	reading?
		1865
		1866	Unlike, say, TCP, TLS connections do not consist of two independent
		1867	communication channels, one for each direction. Or put differently. The
		1868	read and write directions are not independent of each other: you cannot
		1869	write data unless you are also prepared to read, and vice versa.
		1870
		1871	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1872	callback invocations when you are not expecting any read data - the reason
		1873	is that AnyEvent::Handle always reads in TLS mode.
		1874
		1875	During the connection, you have to make sure that you always have a
		1876	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1877	connection (or when you no longer want to use it) you can call the
		1878	C<destroy> method.
		1879
		1880	=item How do I read data until the other side closes the connection?
		1881
		1882	If you just want to read your data into a perl scalar, the easiest way
		1883	to achieve this is by setting an C<on_read> callback that does nothing,
		1884	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1885	will be in C<$_[0]{rbuf}>:
		1886
		1887	$handle->on_read (sub { });
		1888	$handle->on_eof (undef);
		1889	$handle->on_error (sub {
		1890	my $data = delete $_[0]{rbuf};
		1891	});
		1892
		1893	The reason to use C<on_error> is that TCP connections, due to latencies
		1894	and packets loss, might get closed quite violently with an error, when in
		1895	fact, all data has been received.
		1896
		1897	It is usually better to use acknowledgements when transferring data,
		1898	to make sure the other side hasn't just died and you got the data
		1899	intact. This is also one reason why so many internet protocols have an
		1900	explicit QUIT command.
		1901
		1902	=item I don't want to destroy the handle too early - how do I wait until
		1903	all data has been written?
		1904
		1905	After writing your last bits of data, set the C<on_drain> callback
		1906	and destroy the handle in there - with the default setting of
		1907	C<low_water_mark> this will be called precisely when all data has been
		1908	written to the socket:
		1909
		1910	$handle->push_write (...);
		1911	$handle->on_drain (sub {
		1912	warn "all data submitted to the kernel\n";
		1913	undef $handle;
		1914	});
		1915
		1916	If you just want to queue some data and then signal EOF to the other side,
		1917	consider using C<< ->push_shutdown >> instead.
		1918
		1919	=item I want to contact a TLS/SSL server, I don't care about security.
		1920
		1921	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1922	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1923	parameter:
		1924
		1925	tcp_connect $host, $port, sub {
		1926	my ($fh) = @_;
		1927
		1928	my $handle = new AnyEvent::Handle
		1929	fh => $fh,
		1930	tls => "connect",
		1931	on_error => sub { ... };
		1932
		1933	$handle->push_write (...);
		1934	};
		1935
		1936	=item I want to contact a TLS/SSL server, I do care about security.
		1937
		1938	Then you should additionally enable certificate verification, including
		1939	peername verification, if the protocol you use supports it (see
		1940	L<AnyEvent::TLS>, C<verify_peername>).
		1941
		1942	E.g. for HTTPS:
		1943
		1944	tcp_connect $host, $port, sub {
		1945	my ($fh) = @_;
		1946
		1947	my $handle = new AnyEvent::Handle
		1948	fh => $fh,
		1949	peername => $host,
		1950	tls => "connect",
		1951	tls_ctx => { verify => 1, verify_peername => "https" },
		1952	...
		1953
		1954	Note that you must specify the hostname you connected to (or whatever
		1955	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1956	peername verification will be done.
		1957
		1958	The above will use the system-dependent default set of trusted CA
		1959	certificates. If you want to check against a specific CA, add the
		1960	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1961
		1962	tls_ctx => {
		1963	verify => 1,
		1964	verify_peername => "https",
		1965	ca_file => "my-ca-cert.pem",
		1966	},
		1967
		1968	=item I want to create a TLS/SSL server, how do I do that?
		1969
		1970	Well, you first need to get a server certificate and key. You have
		1971	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1972	self-signed certificate (cheap. check the search engine of your choice,
		1973	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1974	nice program for that purpose).
		1975
		1976	Then create a file with your private key (in PEM format, see
		1977	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1978	file should then look like this:
		1979
		1980	-----BEGIN RSA PRIVATE KEY-----
		1981	...header data
		1982	... lots of base64'y-stuff
		1983	-----END RSA PRIVATE KEY-----
		1984
		1985	-----BEGIN CERTIFICATE-----
		1986	... lots of base64'y-stuff
		1987	-----END CERTIFICATE-----
		1988
		1989	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1990	specify this file as C<cert_file>:
		1991
		1992	tcp_server undef, $port, sub {
		1993	my ($fh) = @_;
		1994
		1995	my $handle = new AnyEvent::Handle
		1996	fh => $fh,
		1997	tls => "accept",
		1998	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1999	...
		2000
		2001	When you have intermediate CA certificates that your clients might not
		2002	know about, just append them to the C<cert_file>.
		2003
		2004	=back
		2005
1040		2006
1041	=head1 SUBCLASSING AnyEvent::Handle	2007	=head1 SUBCLASSING AnyEvent::Handle
1042		2008
1043	In many cases, you might want to subclass AnyEvent::Handle.	2009	In many cases, you might want to subclass AnyEvent::Handle.
1044		2010
…		…
1048	=over 4	2014	=over 4
1049		2015
1050	=item * all constructor arguments become object members.	2016	=item * all constructor arguments become object members.
1051		2017
1052	At least initially, when you pass a C<tls>-argument to the constructor it	2018	At least initially, when you pass a C<tls>-argument to the constructor it
1053	will end up in C<< $handle->{tls} >>. Those members might be changes or	2019	will end up in C<< $handle->{tls} >>. Those members might be changed or
1054	mutated later on (for example C<tls> will hold the TLS connection object).	2020	mutated later on (for example C<tls> will hold the TLS connection object).
1055		2021
1056	=item * other object member names are prefixed with an C<_>.	2022	=item * other object member names are prefixed with an C<_>.
1057		2023
1058	All object members not explicitly documented (internal use) are prefixed	2024	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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