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

Diff Legend

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