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

Diff Legend

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