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.36 by root, Mon May 26 18:26:52 2008 UTC vs.
Revision 1.170 by root, Sat Aug 1 09:14:54 2009 UTC

1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;
4	use strict;
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAWOULDBLOCK);
8	use Scalar::Util ();	3	use Scalar::Util ();
9	use Carp ();	4	use Carp ();
10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;	5	use Errno qw(EAGAIN EINTR);
		6
		7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
12		9
13	=head1 NAME	10	=head1 NAME
14		11
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		13
17	=cut	14	=cut
18		15
19	our $VERSION = '0.04';	16	our $VERSION = 4.9;
20		17
21	=head1 SYNOPSIS	18	=head1 SYNOPSIS
22		19
23	use AnyEvent;	20	use AnyEvent;
24	use AnyEvent::Handle;	21	use AnyEvent::Handle;
25		22
26	my $cv = AnyEvent->condvar;	23	my $cv = AnyEvent->condvar;
27		24
28	my $handle =	25	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	26	fh => \*STDIN,
31	on_eof => sub {	27	on_error => sub {
32	$cv->broadcast;	28	my ($hdl, $fatal, $msg) = @_;
33	},	29	warn "got error $msg\n";
		30	$hdl->destroy;
		31	$cv->send;
34	);	32	);
35		33
36	# send some request line	34	# send some request line
37	$handle->push_write ("getinfo\015\012");	35	$hdl->push_write ("getinfo\015\012");
38		36
39	# read the response line	37	# read the response line
40	$handle->push_read (line => sub {	38	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	39	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	40	warn "got line <$line>\n";
43	$cv->send;	41	$cv->send;
44	});	42	});
45		43
46	$cv->recv;	44	$cv->recv;
47		45
48	=head1 DESCRIPTION	46	=head1 DESCRIPTION
49		47
50	This module is a helper module to make it easier to do event-based I/O on	48	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	49	filehandles.
52	on sockets see L<AnyEvent::Util>.	50
		51	The L<AnyEvent::Intro> tutorial contains some well-documented
		52	AnyEvent::Handle examples.
53		53
54	In the following, when the documentation refers to of "bytes" then this	54	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	55	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
57		57
		58	At the very minimum, you should specify C<fh> or C<connect>, and the
		59	C<on_error> callback.
		60
58	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
59	argument.	62	argument.
60		63
61	=head1 METHODS	64	=head1 METHODS
62		65
63	=over 4	66	=over 4
64		67
65	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
66		69
67	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
68		71
69	=over 4	72	=over 4
70		73
71	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
72		75
73	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
74
75	NOTE: The filehandle will be set to non-blocking (using	77	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		79	that mode.
77		80
78	=item on_eof => $cb->($self)	81	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
79		82
80	Set the callback to be called on EOF.	83	Try to connect to the specified host and service (port), using
		84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		85	default C<peername>.
81		86
82	While not mandatory, it is highly recommended to set an eof callback,	87	You have to specify either this parameter, or C<fh>, above.
83	otherwise you might end up with a closed socket while you are still
84	waiting for data.
85		88
		89	It is possible to push requests on the read and write queues, and modify
		90	properties of the stream, even while AnyEvent::Handle is connecting.
		91
		92	When this parameter is specified, then the C<on_prepare>,
		93	C<on_connect_error> and C<on_connect> callbacks will be called under the
		94	appropriate circumstances:
		95
		96	=over 4
		97
86	=item on_error => $cb->($self)	98	=item on_prepare => $cb->($handle)
87		99
		100	This (rarely used) callback is called before a new connection is
		101	attempted, but after the file handle has been created. It could be used to
		102	prepare the file handle with parameters required for the actual connect
		103	(as opposed to settings that can be changed when the connection is already
		104	established).
		105
		106	The return value of this callback should be the connect timeout value in
		107	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		108	timeout is to be used).
		109
		110	=item on_connect => $cb->($handle, $host, $port, $retry->())
		111
		112	This callback is called when a connection has been successfully established.
		113
		114	The actual numeric host and port (the socket peername) are passed as
		115	parameters, together with a retry callback.
		116
		117	When, for some reason, the handle is not acceptable, then calling
		118	C<$retry> will continue with the next conenction target (in case of
		119	multi-homed hosts or SRV records there can be multiple connection
		120	endpoints). When it is called then the read and write queues, eof status,
		121	tls status and similar properties of the handle are being reset.
		122
		123	In most cases, ignoring the C<$retry> parameter is the way to go.
		124
		125	=item on_connect_error => $cb->($handle, $message)
		126
		127	This callback is called when the conenction could not be
		128	established. C<$!> will contain the relevant error code, and C<$message> a
		129	message describing it (usually the same as C<"$!">).
		130
		131	If this callback isn't specified, then C<on_error> will be called with a
		132	fatal error instead.
		133
		134	=back
		135
		136	=item on_error => $cb->($handle, $fatal, $message)
		137
88	This is the fatal error callback, that is called when, well, a fatal error	138	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	139	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	140	connect or a read error.
91		141
92	The object will not be in a usable state when this callback has been	142	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	143	fatal errors the handle object will be destroyed (by a call to C<< ->
		144	destroy >>) after invoking the error callback (which means you are free to
		145	examine the handle object). Examples of fatal errors are an EOF condition
		146	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		147	cases where the other side can close the connection at their will it is
		148	often easiest to not report C<EPIPE> errors in this callback.
		149
		150	AnyEvent::Handle tries to find an appropriate error code for you to check
		151	against, but in some cases (TLS errors), this does not work well. It is
		152	recommended to always output the C<$message> argument in human-readable
		153	error messages (it's usually the same as C<"$!">).
		154
		155	Non-fatal errors can be retried by simply returning, but it is recommended
		156	to simply ignore this parameter and instead abondon the handle object
		157	when this callback is invoked. Examples of non-fatal errors are timeouts
		158	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
94		159
95	On callback entrance, the value of C<$!> contains the operating system	160	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	161	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		162	C<EPROTO>).
97		163
98	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
99	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
100	die.	166	C<croak>.
101		167
102	=item on_read => $cb->($self)	168	=item on_read => $cb->($handle)
103		169
104	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
105	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).
106		174
107	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 >>
108	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.
109		179
110	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
111	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
112	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
113	error will be raised (with C<$!> set to C<EPIPE>).	183	error will be raised (with C<$!> set to C<EPIPE>).
114		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
115	=item on_drain => $cb->()	206	=item on_drain => $cb->($handle)
116		207
117	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
118	(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).
119		210
120	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.
121		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
122	=item rbuf_max => <bytes>	240	=item rbuf_max => <bytes>
123		241
124	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>)
125	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
126	avoid denial-of-service attacks.	244	avoid some forms of denial-of-service attacks.
127		245
128	For example, a server accepting connections from untrusted sources should	246	For example, a server accepting connections from untrusted sources should
129	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
130	(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
131	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
132	isn't finished).	250	isn't finished).
133		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
134	=item read_size => <bytes>	278	=item read_size => <bytes>
135		279
136	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
137	on each [loop iteration). Default: C<4096>.	281	try to read during each loop iteration, which affects memory
		282	requirements). Default: C<8192>.
138		283
139	=item low_water_mark => <bytes>	284	=item low_water_mark => <bytes>
140		285
141	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
142	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
143	considered empty.	288	considered empty.
144		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
145	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	317	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
146		318
147	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
148	will start making tls handshake and will transparently encrypt/decrypt	320	AnyEvent will start a TLS handshake as soon as the conenction has been
149	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.
150		325
151	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
152	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.
153		330
154	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
155	connection, use C<connect> mode.	332	C<accept>, and for the TLS client side of a connection, use C<connect>
		333	mode.
156		334
157	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
158	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>
159	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
160	AnyEvent::Handle.	338	AnyEvent::Handle. Also, this module will take ownership of this connection
		339	object.
161		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
162	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.
163		351
164	=item tls_ctx => $ssl_ctx	352	=item tls_ctx => $anyevent_tls
165		353
166	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
167	(unless a connection object was specified directly). If this parameter is	355	(unless a connection object was specified directly). If this parameter is
168	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	356	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
169		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
170	=back	405	=back
171		406
172	=cut	407	=cut
173		408
174	sub new {	409	sub new {
175	my $class = shift;	410	my $class = shift;
176
177	my $self = bless { @_ }, $class;	411	my $self = bless { @_ }, $class;
178		412
179	$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) = @_;
180		476
181	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
182		478
183	if ($self->{tls}) {	479	$self->{_activity} = AnyEvent->now;
184	require Net::SSLeay;	480	$self->_timeout;
		481
		482	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		483
185	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	484	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
186	}	485	if $self->{tls};
187		486
188	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};
189	$self->on_error (delete $self->{on_error}) if $self->{on_error};
190	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
191	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
192		488
193	$self->start_read;	489	$self->start_read
		490	if $self->{on_read} || @{ $self->{_queue} };
194		491
195	$self	492	$self->_drain_wbuf;
196	}	493	}
197		494
198	sub _shutdown {	495	#sub _shutdown {
199	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	#}
200		503
201	delete $self->{rw};
202	delete $self->{ww};
203	delete $self->{fh};
204	}
205
206	sub error {	504	sub _error {
207	my ($self) = @_;	505	my ($self, $errno, $fatal, $message) = @_;
208		506
209	{	507	$! = $errno;
210	local $!;	508	$message ||= "$!";
211	$self->_shutdown;
212	}
213		509
214	if ($self->{on_error}) {	510	if ($self->{on_error}) {
215	$self->{on_error}($self);	511	$self->{on_error}($self, $fatal, $message);
216	} else {	512	$self->destroy if $fatal;
		513	} elsif ($self->{fh}) {
		514	$self->destroy;
217	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	515	Carp::croak "AnyEvent::Handle uncaught error: $message";
218	}	516	}
219	}	517	}
220		518
221	=item $fh = $handle->fh	519	=item $fh = $handle->fh
222		520
223	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.
224		522
225	=cut	523	=cut
226		524
227	sub fh { $_[0]->{fh} }	525	sub fh { $_[0]{fh} }
228		526
229	=item $handle->on_error ($cb)	527	=item $handle->on_error ($cb)
230		528
231	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).
232		530
…		…
244		542
245	sub on_eof {	543	sub on_eof {
246	$_[0]{on_eof} = $_[1];	544	$_[0]{on_eof} = $_[1];
247	}	545	}
248		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
249	#############################################################################	672	#############################################################################
250		673
251	=back	674	=back
252		675
253	=head2 WRITE QUEUE	676	=head2 WRITE QUEUE
…		…
274	my ($self, $cb) = @_;	697	my ($self, $cb) = @_;
275		698
276	$self->{on_drain} = $cb;	699	$self->{on_drain} = $cb;
277		700
278	$cb->($self)	701	$cb->($self)
279	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	702	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
280	}	703	}
281		704
282	=item $handle->push_write ($data)	705	=item $handle->push_write ($data)
283		706
284	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
…		…
288	=cut	711	=cut
289		712
290	sub _drain_wbuf {	713	sub _drain_wbuf {
291	my ($self) = @_;	714	my ($self) = @_;
292		715
293	if (!$self->{ww} && length $self->{wbuf}) {	716	if (!$self->{_ww} && length $self->{wbuf}) {
294		717
295	Scalar::Util::weaken $self;	718	Scalar::Util::weaken $self;
296		719
297	my $cb = sub {	720	my $cb = sub {
298	my $len = syswrite $self->{fh}, $self->{wbuf};	721	my $len = syswrite $self->{fh}, $self->{wbuf};
299		722
300	if ($len >= 0) {	723	if (defined $len) {
301	substr $self->{wbuf}, 0, $len, "";	724	substr $self->{wbuf}, 0, $len, "";
302		725
		726	$self->{_activity} = AnyEvent->now;
		727
303	$self->{on_drain}($self)	728	$self->{on_drain}($self)
304	if $self->{low_water_mark} >= length $self->{wbuf}	729	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
305	&& $self->{on_drain};	730	&& $self->{on_drain};
306		731
307	delete $self->{ww} unless length $self->{wbuf};	732	delete $self->{_ww} unless length $self->{wbuf};
308	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	733	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
309	$self->error;	734	$self->_error ($!, 1);
310	}	735	}
311	};	736	};
312		737
313	# try to write data immediately	738	# try to write data immediately
314	$cb->();	739	$cb->() unless $self->{autocork};
315		740
316	# if still data left in wbuf, we need to poll	741	# if still data left in wbuf, we need to poll
317	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	742	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
318	if length $self->{wbuf};	743	if length $self->{wbuf};
319	};	744	};
320	}	745	}
321		746
322	our %WH;	747	our %WH;
…		…
333		758
334	@_ = ($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")
335	->($self, @_);	760	->($self, @_);
336	}	761	}
337		762
338	if ($self->{filter_w}) {	763	if ($self->{tls}) {
339	$self->{filter_w}->($self, \$_[0]);	764	$self->{_tls_wbuf} .= $_[0];
		765	&_dotls ($self) if $self->{fh};
340	} else {	766	} else {
341	$self->{wbuf} .= $_[0];	767	$self->{wbuf} .= $_[0];
342	$self->_drain_wbuf;	768	$self->_drain_wbuf if $self->{fh};
343	}	769	}
344	}	770	}
345		771
346	=item $handle->push_write (type => @args)	772	=item $handle->push_write (type => @args)
347
348	=item $handle->unshift_write (type => @args)
349		773
350	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
351	the job by specifying a type and type-specific arguments.	775	the job by specifying a type and type-specific arguments.
352		776
353	Predefined types are (if you have ideas for additional types, feel free to	777	Predefined types are (if you have ideas for additional types, feel free to
…		…
358	=item netstring => $string	782	=item netstring => $string
359		783
360	Formats the given value as netstring	784	Formats the given value as netstring
361	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	785	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
362		786
363	=back
364
365	=cut	787	=cut
366		788
367	register_write_type netstring => sub {	789	register_write_type netstring => sub {
368	my ($self, $string) = @_;	790	my ($self, $string) = @_;
369		791
370	sprintf "%d:%s,", (length $string), $string	792	(length $string) . ":$string,"
371	};	793	};
372		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
		866	=back
		867
		868	=item $handle->push_shutdown
		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:
		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
373	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	893	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
374		894
375	This function (not method) lets you add your own types to C<push_write>.	895	This function (not method) lets you add your own types to C<push_write>.
376	Whenever the given C<type> is used, C<push_write> will invoke the code	896	Whenever the given C<type> is used, C<push_write> will invoke the code
377	reference with the handle object and the remaining arguments.	897	reference with the handle object and the remaining arguments.
378		898
…		…
397	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
398	a queue.	918	a queue.
399		919
400	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
401	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
402	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
403	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).
404		925
405	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
406	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
407	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
408	below).	929	done its job (see C<push_read>, below).
409		930
410	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
411	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.
412		933
413	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
414	the specified number of bytes which give an XML datagram.	935	the specified number of bytes which give an XML datagram.
415		936
416	# in the default state, expect some header bytes	937	# in the default state, expect some header bytes
417	$handle->on_read (sub {	938	$handle->on_read (sub {
418	# 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)
419	shift->unshift_read_chunk (4, sub {	940	shift->unshift_read (chunk => 4, sub {
420	# header arrived, decode	941	# header arrived, decode
421	my $len = unpack "N", $_[1];	942	my $len = unpack "N", $_[1];
422		943
423	# now read the payload	944	# now read the payload
424	shift->unshift_read_chunk ($len, sub {	945	shift->unshift_read (chunk => $len, sub {
425	my $xml = $_[1];	946	my $xml = $_[1];
426	# handle xml	947	# handle xml
427	});	948	});
428	});	949	});
429	});	950	});
430		951
431	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"
432	"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
433	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
434	pipeline sending both requests and manipulate the queue as necessary in	955	just pipeline sending both requests and manipulate the queue as necessary
435	the callbacks:	956	in the callbacks.
436		957
437	# 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"
438	$handle->push_write ("request 1\015\012");	963	$handle->push_write ("request 1\015\012");
439		964
440	# 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
441	$handle->push_read_line (sub {	966	$handle->push_read (line => sub {
442	# if we got an "OK", we have to _prepend_ another line,	967	# if we got an "OK", we have to _prepend_ another line,
443	# 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
444	# which are already in the queue when this callback is called	969	# which are already in the queue when this callback is called
445	# we don't do this in case we got an error	970	# we don't do this in case we got an error
446	if ($_[1] eq "OK") {	971	if ($_[1] eq "OK") {
447	$_[0]->unshift_read_line (sub {	972	$_[0]->unshift_read (line => sub {
448	my $response = $_[1];	973	my $response = $_[1];
449	...	974	...
450	});	975	});
451	}	976	}
452	});	977	});
453		978
454	# request two	979	# request two, simply returns 64 octets
455	$handle->push_write ("request 2\015\012");	980	$handle->push_write ("request 2\015\012");
456		981
457	# simply read 64 bytes, always	982	# simply read 64 bytes, always
458	$handle->push_read_chunk (64, sub {	983	$handle->push_read (chunk => 64, sub {
459	my $response = $_[1];	984	my $response = $_[1];
460	...	985	...
461	});	986	});
462		987
463	=over 4	988	=over 4
464		989
465	=cut	990	=cut
466		991
467	sub _drain_rbuf {	992	sub _drain_rbuf {
468	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	}
469		1048
470	if (	1049	if (
471	defined $self->{rbuf_max}	1050	defined $self->{rbuf_max}
472	&& $self->{rbuf_max} < length $self->{rbuf}	1051	&& $self->{rbuf_max} < length $self->{rbuf}
473	) {	1052	) {
474	$! = &Errno::ENOSPC; return $self->error;	1053	$self->_error (Errno::ENOSPC, 1), return;
475	}	1054	}
476		1055
477	return if $self->{in_drain};	1056	# may need to restart read watcher
478	local $self->{in_drain} = 1;	1057	unless ($self->{_rw}) {
479		1058	$self->start_read
480	while (my $len = length $self->{rbuf}) {	1059	if $self->{on_read} || @{ $self->{_queue} };
481	no strict 'refs';
482	if (my $cb = shift @{ $self->{queue} }) {
483	unless ($cb->($self)) {
484	if ($self->{eof}) {
485	# no progress can be made (not enough data and no data forthcoming)
486	$! = &Errno::EPIPE; return $self->error;
487	}
488
489	unshift @{ $self->{queue} }, $cb;
490	return;
491	}
492	} elsif ($self->{on_read}) {
493	$self->{on_read}($self);
494
495	if (
496	$self->{eof} # if no further data will arrive
497	&& $len == length $self->{rbuf} # and no data has been consumed
498	&& !@{ $self->{queue} } # and the queue is still empty
499	&& $self->{on_read} # and we still want to read data
500	) {
501	# then no progress can be made
502	$! = &Errno::EPIPE; return $self->error;
503	}
504	} else {
505	# read side becomes idle
506	delete $self->{rw};
507	return;
508	}
509	}
510
511	if ($self->{eof}) {
512	$self->_shutdown;
513	$self->{on_eof}($self)
514	if $self->{on_eof};
515	}	1060	}
516	}	1061	}
517		1062
518	=item $handle->on_read ($cb)	1063	=item $handle->on_read ($cb)
519		1064
…		…
525		1070
526	sub on_read {	1071	sub on_read {
527	my ($self, $cb) = @_;	1072	my ($self, $cb) = @_;
528		1073
529	$self->{on_read} = $cb;	1074	$self->{on_read} = $cb;
		1075	$self->_drain_rbuf if $cb;
530	}	1076	}
531		1077
532	=item $handle->rbuf	1078	=item $handle->rbuf
533		1079
534	Returns the read buffer (as a modifiable lvalue).	1080	Returns the read buffer (as a modifiable lvalue).
535		1081
536	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} >>
537	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.
538		1087
539	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>,
540	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
541	automatically manage the read buffer.	1090	automatically manage the read buffer.
542		1091
…		…
582		1131
583	$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")
584	->($self, $cb, @_);	1133	->($self, $cb, @_);
585	}	1134	}
586		1135
587	push @{ $self->{queue} }, $cb;	1136	push @{ $self->{_queue} }, $cb;
588	$self->_drain_rbuf;	1137	$self->_drain_rbuf;
589	}	1138	}
590		1139
591	sub unshift_read {	1140	sub unshift_read {
592	my $self = shift;	1141	my $self = shift;
…		…
598	$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")
599	->($self, $cb, @_);	1148	->($self, $cb, @_);
600	}	1149	}
601		1150
602		1151
603	unshift @{ $self->{queue} }, $cb;	1152	unshift @{ $self->{_queue} }, $cb;
604	$self->_drain_rbuf;	1153	$self->_drain_rbuf;
605	}	1154	}
606		1155
607	=item $handle->push_read (type => @args, $cb)	1156	=item $handle->push_read (type => @args, $cb)
608		1157
…		…
615	Predefined types are (if you have ideas for additional types, feel free to	1164	Predefined types are (if you have ideas for additional types, feel free to
616	drop by and tell us):	1165	drop by and tell us):
617		1166
618	=over 4	1167	=over 4
619		1168
620	=item chunk => $octets, $cb->($self, $data)	1169	=item chunk => $octets, $cb->($handle, $data)
621		1170
622	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
623	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
624	data.	1173	data.
625		1174
…		…
639	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1188	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
640	1	1189	1
641	}	1190	}
642	};	1191	};
643		1192
644	# compatibility with older API
645	sub push_read_chunk {
646	$_[0]->push_read (chunk => $_[1], $_[2]);
647	}
648
649	sub unshift_read_chunk {
650	$_[0]->unshift_read (chunk => $_[1], $_[2]);
651	}
652
653	=item line => [$eol, ]$cb->($self, $line, $eol)	1193	=item line => [$eol, ]$cb->($handle, $line, $eol)
654		1194
655	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
656	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
657	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
658	the end of line marker as the third argument (C<$eol>).	1198	the end of line marker as the third argument (C<$eol>).
…		…
672	=cut	1212	=cut
673		1213
674	register_read_type line => sub {	1214	register_read_type line => sub {
675	my ($self, $cb, $eol) = @_;	1215	my ($self, $cb, $eol) = @_;
676		1216
677	$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 {
678	$eol = quotemeta $eol unless ref $eol;	1226	$eol = quotemeta $eol unless ref $eol;
679	$eol = qr|^(.*?)($eol)|s;	1227	$eol = qr|^(.*?)($eol)|s;
680		1228
681	sub {	1229	sub {
682	$_[0]{rbuf} =~ s/$eol// or return;	1230	$_[0]{rbuf} =~ s/$eol// or return;
683		1231
684	$cb->($_[0], $1, $2);	1232	$cb->($_[0], $1, $2);
		1233	1
685	1	1234	}
686	}	1235	}
687	};	1236	};
688		1237
689	# compatibility with older API
690	sub push_read_line {
691	my $self = shift;
692	$self->push_read (line => @_);
693	}
694
695	sub unshift_read_line {
696	my $self = shift;
697	$self->unshift_read (line => @_);
698	}
699
700	=item netstring => $cb->($string)
701
702	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
703
704	Throws an error with C<$!> set to EBADMSG on format violations.
705
706	=cut
707
708	register_read_type netstring => sub {
709	my ($self, $cb) = @_;
710
711	sub {
712	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
713	if ($_[0]{rbuf} =~ /[^0-9]/) {
714	$! = &Errno::EBADMSG;
715	$self->error;
716	}
717	return;
718	}
719
720	my $len = $1;
721
722	$self->unshift_read (chunk => $len, sub {
723	my $string = $_[1];
724	$_[0]->unshift_read (chunk => 1, sub {
725	if ($_[1] eq ",") {
726	$cb->($_[0], $string);
727	} else {
728	$! = &Errno::EBADMSG;
729	$self->error;
730	}
731	});
732	});
733
734	1
735	}
736	};
737
738	=item regex => $accept[, $reject[, $skip], $cb->($data)	1238	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
739		1239
740	Makes a regex match against the regex object C<$accept> and returns	1240	Makes a regex match against the regex object C<$accept> and returns
741	everything up to and including the match.	1241	everything up to and including the match.
742		1242
743	Example: read a single line terminated by '\n'.	1243	Example: read a single line terminated by '\n'.
…		…
791	return 1;	1291	return 1;
792	}	1292	}
793		1293
794	# reject	1294	# reject
795	if ($reject && $$rbuf =~ $reject) {	1295	if ($reject && $$rbuf =~ $reject) {
796	$! = &Errno::EBADMSG;	1296	$self->_error (Errno::EBADMSG);
797	$self->error;
798	}	1297	}
799		1298
800	# skip	1299	# skip
801	if ($skip && $$rbuf =~ $skip) {	1300	if ($skip && $$rbuf =~ $skip) {
802	$data .= substr $$rbuf, 0, $+[0], "";	1301	$data .= substr $$rbuf, 0, $+[0], "";
…		…
804		1303
805	()	1304	()
806	}	1305	}
807	};	1306	};
808		1307
		1308	=item netstring => $cb->($handle, $string)
		1309
		1310	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1311
		1312	Throws an error with C<$!> set to EBADMSG on format violations.
		1313
		1314	=cut
		1315
		1316	register_read_type netstring => sub {
		1317	my ($self, $cb) = @_;
		1318
		1319	sub {
		1320	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
		1321	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1322	$self->_error (Errno::EBADMSG);
		1323	}
		1324	return;
		1325	}
		1326
		1327	my $len = $1;
		1328
		1329	$self->unshift_read (chunk => $len, sub {
		1330	my $string = $_[1];
		1331	$_[0]->unshift_read (chunk => 1, sub {
		1332	if ($_[1] eq ",") {
		1333	$cb->($_[0], $string);
		1334	} else {
		1335	$self->_error (Errno::EBADMSG);
		1336	}
		1337	});
		1338	});
		1339
		1340	1
		1341	}
		1342	};
		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
809	=back	1491	=back
810		1492
811	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1493	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
812		1494
813	This function (not method) lets you add your own types to C<push_read>.	1495	This function (not method) lets you add your own types to C<push_read>.
814		1496
815	Whenever the given C<type> is used, C<push_read> will invoke the code	1497	Whenever the given C<type> is used, C<push_read> will invoke the code
816	reference with the handle object, the callback and the remaining	1498	reference with the handle object, the callback and the remaining
…		…
818		1500
819	The code reference is supposed to return a callback (usually a closure)	1501	The code reference is supposed to return a callback (usually a closure)
820	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1502	that works as a plain read callback (see C<< ->push_read ($cb) >>).
821		1503
822	It should invoke the passed callback when it is done reading (remember to	1504	It should invoke the passed callback when it is done reading (remember to
823	pass C<$self> as first argument as all other callbacks do that).	1505	pass C<$handle> as first argument as all other callbacks do that).
824		1506
825	Note that this is a function, and all types registered this way will be	1507	Note that this is a function, and all types registered this way will be
826	global, so try to use unique names.	1508	global, so try to use unique names.
827		1509
828	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1510	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
831	=item $handle->stop_read	1513	=item $handle->stop_read
832		1514
833	=item $handle->start_read	1515	=item $handle->start_read
834		1516
835	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
836	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
837	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
838	C<start_read>.	1520	C<start_read>.
839		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
840	=cut	1530	=cut
841		1531
842	sub stop_read {	1532	sub stop_read {
843	my ($self) = @_;	1533	my ($self) = @_;
844		1534
845	delete $self->{rw};	1535	delete $self->{_rw} unless $self->{tls};
846	}	1536	}
847		1537
848	sub start_read {	1538	sub start_read {
849	my ($self) = @_;	1539	my ($self) = @_;
850		1540
851	unless ($self->{rw} || $self->{eof}) {	1541	unless ($self->{_rw} || $self->{_eof}) {
852	Scalar::Util::weaken $self;	1542	Scalar::Util::weaken $self;
853		1543
854	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1544	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
855	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1545	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
856	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;
857		1547
858	if ($len > 0) {	1548	if ($len > 0) {
859	$self->{filter_r}	1549	$self->{_activity} = AnyEvent->now;
860	? $self->{filter_r}->($self, $rbuf)	1550
		1551	if ($self->{tls}) {
		1552	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
		1553
		1554	&_dotls ($self);
		1555	} else {
861	: $self->_drain_rbuf;	1556	$self->_drain_rbuf;
		1557	}
862		1558
863	} elsif (defined $len) {	1559	} elsif (defined $len) {
864	delete $self->{rw};	1560	delete $self->{_rw};
865	$self->{eof} = 1;	1561	$self->{_eof} = 1;
866	$self->_drain_rbuf;	1562	$self->_drain_rbuf;
867		1563
868	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1564	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
869	return $self->error;	1565	return $self->_error ($!, 1);
870	}	1566	}
871	});	1567	});
872	}	1568	}
873	}	1569	}
874		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.
875	sub _dotls {	1599	sub _dotls {
876	my ($self) = @_;	1600	my ($self) = @_;
877		1601
		1602	my $tmp;
		1603
878	if (length $self->{tls_wbuf}) {	1604	if (length $self->{_tls_wbuf}) {
879	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1605	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
880	substr $self->{tls_wbuf}, 0, $len, "";	1606	substr $self->{_tls_wbuf}, 0, $tmp, "";
881	}	1607	}
882	}
883		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
884	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}))) {
885	$self->{wbuf} .= $buf;	1642	$self->{wbuf} .= $tmp;
886	$self->_drain_wbuf;	1643	$self->_drain_wbuf;
887	}	1644	}
888		1645
889	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1646	$self->{_on_starttls}
890	$self->{rbuf} .= $buf;	1647	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
891	$self->_drain_rbuf;	1648	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
892	}
893
894	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
895
896	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
897	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
898	$self->error;
899	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
900	$! = &Errno::EIO;
901	$self->error;
902	}
903
904	# all others are fine for our purposes
905	}
906	}	1649	}
907		1650
908	=item $handle->starttls ($tls[, $tls_ctx])	1651	=item $handle->starttls ($tls[, $tls_ctx])
909		1652
910	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1653	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
911	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
912	C<starttls>.	1655	C<starttls>.
913		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
914	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
915	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1662	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
916		1663
917	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
918	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.
919		1668
920	=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.
921		1673
922	# 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
923	sub starttls {	1682	sub starttls {
924	my ($self, $ssl, $ctx) = @_;	1683	my ($self, $tls, $ctx) = @_;
925		1684
926	$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};
927		1687
928	if ($ssl eq "accept") {	1688	$self->{tls} = $tls;
929	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1689	$self->{tls_ctx} = $ctx if @_ > 2;
930	Net::SSLeay::set_accept_state ($ssl);	1690
931	} elsif ($ssl eq "connect") {	1691	return unless $self->{fh};
932	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1692
933	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	}
934	}	1713
935		1714	$self->{tls_ctx} = $ctx || TLS_CTX ();
936	$self->{tls} = $ssl;	1715	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
937		1716
938	# 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)
939	# but the openssl maintainers basically said: "trust us, it just works".	1718	# but the openssl maintainers basically said: "trust us, it just works".
940	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1719	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
941	# and mismaintained ssleay-module doesn't even offer them).	1720	# and mismaintained ssleay-module doesn't even offer them).
942	# 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.
943	Net::SSLeay::CTX_set_mode ($self->{tls},	1729	# Net::SSLeay::CTX_set_mode ($ssl,
944	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1730	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
945	| (eval { local $SIG{__DIE__}; 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);
946		1733
947	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1734	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
948	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1735	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
949		1736
950	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1737	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
951		1738
952	$self->{filter_w} = sub {	1739	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
953	$_[0]{tls_wbuf} .= ${$_[1]};	1740	if $self->{on_starttls};
954	&_dotls;	1741
955	};	1742	&_dotls; # need to trigger the initial handshake
956	$self->{filter_r} = sub {	1743	$self->start_read; # make sure we actually do read
957	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});
958	&_dotls;
959	};
960	}	1744	}
961		1745
962	=item $handle->stoptls	1746	=item $handle->stoptls
963		1747
964	Destroys the SSL connection, if any. Partial read or write data will be	1748	Shuts down the SSL connection - this makes a proper EOF handshake by
965	lost.	1749	sending a close notify to the other side, but since OpenSSL doesn't
		1750	support non-blocking shut downs, it is not guarenteed that you can re-use
		1751	the stream afterwards.
966		1752
967	=cut	1753	=cut
968		1754
969	sub stoptls {	1755	sub stoptls {
970	my ($self) = @_;	1756	my ($self) = @_;
971		1757
972	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1758	if ($self->{tls}) {
973	delete $self->{tls_rbio};	1759	Net::SSLeay::shutdown ($self->{tls});
974	delete $self->{tls_wbio};	1760
975	delete $self->{tls_wbuf};	1761	&_dotls;
976	delete $self->{filter_r};	1762
977	delete $self->{filter_w};	1763	# # we don't give a shit. no, we do, but we can't. no...#d#
		1764	# # we, we... have to use openssl :/#d#
		1765	# &_freetls;#d#
		1766	}
		1767	}
		1768
		1769	sub _freetls {
		1770	my ($self) = @_;
		1771
		1772	return unless $self->{tls};
		1773
		1774	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1775	if ref $self->{tls};
		1776
		1777	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
978	}	1778	}
979		1779
980	sub DESTROY {	1780	sub DESTROY {
981	my $self = shift;	1781	my ($self) = @_;
982		1782
983	$self->stoptls;	1783	&_freetls;
		1784
		1785	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1786
		1787	if ($linger && length $self->{wbuf} && $self->{fh}) {
		1788	my $fh = delete $self->{fh};
		1789	my $wbuf = delete $self->{wbuf};
		1790
		1791	my @linger;
		1792
		1793	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1794	my $len = syswrite $fh, $wbuf, length $wbuf;
		1795
		1796	if ($len > 0) {
		1797	substr $wbuf, 0, $len, "";
		1798	} else {
		1799	@linger = (); # end
		1800	}
		1801	});
		1802	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1803	@linger = ();
		1804	});
		1805	}
		1806	}
		1807
		1808	=item $handle->destroy
		1809
		1810	Shuts down the handle object as much as possible - this call ensures that
		1811	no further callbacks will be invoked and as many resources as possible
		1812	will be freed. Any method you will call on the handle object after
		1813	destroying it in this way will be silently ignored (and it will return the
		1814	empty list).
		1815
		1816	Normally, you can just "forget" any references to an AnyEvent::Handle
		1817	object and it will simply shut down. This works in fatal error and EOF
		1818	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1819	callback, so when you want to destroy the AnyEvent::Handle object from
		1820	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1821	that case.
		1822
		1823	Destroying the handle object in this way has the advantage that callbacks
		1824	will be removed as well, so if those are the only reference holders (as
		1825	is common), then one doesn't need to do anything special to break any
		1826	reference cycles.
		1827
		1828	The handle might still linger in the background and write out remaining
		1829	data, as specified by the C<linger> option, however.
		1830
		1831	=cut
		1832
		1833	sub destroy {
		1834	my ($self) = @_;
		1835
		1836	$self->DESTROY;
		1837	%$self = ();
		1838	bless $self, "AnyEvent::Handle::destroyed";
		1839	}
		1840
		1841	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1842	#nop
984	}	1843	}
985		1844
986	=item AnyEvent::Handle::TLS_CTX	1845	=item AnyEvent::Handle::TLS_CTX
987		1846
988	This function creates and returns the Net::SSLeay::CTX object used by	1847	This function creates and returns the AnyEvent::TLS object used by default
989	default for TLS mode.	1848	for TLS mode.
990		1849
991	The context is created like this:	1850	The context is created by calling L<AnyEvent::TLS> without any arguments.
992
993	Net::SSLeay::load_error_strings;
994	Net::SSLeay::SSLeay_add_ssl_algorithms;
995	Net::SSLeay::randomize;
996
997	my $CTX = Net::SSLeay::CTX_new;
998
999	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1000		1851
1001	=cut	1852	=cut
1002		1853
1003	our $TLS_CTX;	1854	our $TLS_CTX;
1004		1855
1005	sub TLS_CTX() {	1856	sub TLS_CTX() {
1006	$TLS_CTX || do {	1857	$TLS_CTX ||= do {
1007	require Net::SSLeay;	1858	require AnyEvent::TLS;
1008		1859
1009	Net::SSLeay::load_error_strings ();	1860	new AnyEvent::TLS
1010	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1011	Net::SSLeay::randomize ();
1012
1013	$TLS_CTX = Net::SSLeay::CTX_new ();
1014
1015	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1016
1017	$TLS_CTX
1018	}	1861	}
1019	}	1862	}
1020		1863
1021	=back	1864	=back
1022		1865
		1866
		1867	=head1 NONFREQUENTLY ASKED QUESTIONS
		1868
		1869	=over 4
		1870
		1871	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1872	still get further invocations!
		1873
		1874	That's because AnyEvent::Handle keeps a reference to itself when handling
		1875	read or write callbacks.
		1876
		1877	It is only safe to "forget" the reference inside EOF or error callbacks,
		1878	from within all other callbacks, you need to explicitly call the C<<
		1879	->destroy >> method.
		1880
		1881	=item I get different callback invocations in TLS mode/Why can't I pause
		1882	reading?
		1883
		1884	Unlike, say, TCP, TLS connections do not consist of two independent
		1885	communication channels, one for each direction. Or put differently. The
		1886	read and write directions are not independent of each other: you cannot
		1887	write data unless you are also prepared to read, and vice versa.
		1888
		1889	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1890	callback invocations when you are not expecting any read data - the reason
		1891	is that AnyEvent::Handle always reads in TLS mode.
		1892
		1893	During the connection, you have to make sure that you always have a
		1894	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1895	connection (or when you no longer want to use it) you can call the
		1896	C<destroy> method.
		1897
		1898	=item How do I read data until the other side closes the connection?
		1899
		1900	If you just want to read your data into a perl scalar, the easiest way
		1901	to achieve this is by setting an C<on_read> callback that does nothing,
		1902	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1903	will be in C<$_[0]{rbuf}>:
		1904
		1905	$handle->on_read (sub { });
		1906	$handle->on_eof (undef);
		1907	$handle->on_error (sub {
		1908	my $data = delete $_[0]{rbuf};
		1909	});
		1910
		1911	The reason to use C<on_error> is that TCP connections, due to latencies
		1912	and packets loss, might get closed quite violently with an error, when in
		1913	fact, all data has been received.
		1914
		1915	It is usually better to use acknowledgements when transferring data,
		1916	to make sure the other side hasn't just died and you got the data
		1917	intact. This is also one reason why so many internet protocols have an
		1918	explicit QUIT command.
		1919
		1920	=item I don't want to destroy the handle too early - how do I wait until
		1921	all data has been written?
		1922
		1923	After writing your last bits of data, set the C<on_drain> callback
		1924	and destroy the handle in there - with the default setting of
		1925	C<low_water_mark> this will be called precisely when all data has been
		1926	written to the socket:
		1927
		1928	$handle->push_write (...);
		1929	$handle->on_drain (sub {
		1930	warn "all data submitted to the kernel\n";
		1931	undef $handle;
		1932	});
		1933
		1934	If you just want to queue some data and then signal EOF to the other side,
		1935	consider using C<< ->push_shutdown >> instead.
		1936
		1937	=item I want to contact a TLS/SSL server, I don't care about security.
		1938
		1939	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1940	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1941	parameter:
		1942
		1943	tcp_connect $host, $port, sub {
		1944	my ($fh) = @_;
		1945
		1946	my $handle = new AnyEvent::Handle
		1947	fh => $fh,
		1948	tls => "connect",
		1949	on_error => sub { ... };
		1950
		1951	$handle->push_write (...);
		1952	};
		1953
		1954	=item I want to contact a TLS/SSL server, I do care about security.
		1955
		1956	Then you should additionally enable certificate verification, including
		1957	peername verification, if the protocol you use supports it (see
		1958	L<AnyEvent::TLS>, C<verify_peername>).
		1959
		1960	E.g. for HTTPS:
		1961
		1962	tcp_connect $host, $port, sub {
		1963	my ($fh) = @_;
		1964
		1965	my $handle = new AnyEvent::Handle
		1966	fh => $fh,
		1967	peername => $host,
		1968	tls => "connect",
		1969	tls_ctx => { verify => 1, verify_peername => "https" },
		1970	...
		1971
		1972	Note that you must specify the hostname you connected to (or whatever
		1973	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1974	peername verification will be done.
		1975
		1976	The above will use the system-dependent default set of trusted CA
		1977	certificates. If you want to check against a specific CA, add the
		1978	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1979
		1980	tls_ctx => {
		1981	verify => 1,
		1982	verify_peername => "https",
		1983	ca_file => "my-ca-cert.pem",
		1984	},
		1985
		1986	=item I want to create a TLS/SSL server, how do I do that?
		1987
		1988	Well, you first need to get a server certificate and key. You have
		1989	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1990	self-signed certificate (cheap. check the search engine of your choice,
		1991	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1992	nice program for that purpose).
		1993
		1994	Then create a file with your private key (in PEM format, see
		1995	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1996	file should then look like this:
		1997
		1998	-----BEGIN RSA PRIVATE KEY-----
		1999	...header data
		2000	... lots of base64'y-stuff
		2001	-----END RSA PRIVATE KEY-----
		2002
		2003	-----BEGIN CERTIFICATE-----
		2004	... lots of base64'y-stuff
		2005	-----END CERTIFICATE-----
		2006
		2007	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2008	specify this file as C<cert_file>:
		2009
		2010	tcp_server undef, $port, sub {
		2011	my ($fh) = @_;
		2012
		2013	my $handle = new AnyEvent::Handle
		2014	fh => $fh,
		2015	tls => "accept",
		2016	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2017	...
		2018
		2019	When you have intermediate CA certificates that your clients might not
		2020	know about, just append them to the C<cert_file>.
		2021
		2022	=back
		2023
		2024
		2025	=head1 SUBCLASSING AnyEvent::Handle
		2026
		2027	In many cases, you might want to subclass AnyEvent::Handle.
		2028
		2029	To make this easier, a given version of AnyEvent::Handle uses these
		2030	conventions:
		2031
		2032	=over 4
		2033
		2034	=item * all constructor arguments become object members.
		2035
		2036	At least initially, when you pass a C<tls>-argument to the constructor it
		2037	will end up in C<< $handle->{tls} >>. Those members might be changed or
		2038	mutated later on (for example C<tls> will hold the TLS connection object).
		2039
		2040	=item * other object member names are prefixed with an C<_>.
		2041
		2042	All object members not explicitly documented (internal use) are prefixed
		2043	with an underscore character, so the remaining non-C<_>-namespace is free
		2044	for use for subclasses.
		2045
		2046	=item * all members not documented here and not prefixed with an underscore
		2047	are free to use in subclasses.
		2048
		2049	Of course, new versions of AnyEvent::Handle may introduce more "public"
		2050	member variables, but thats just life, at least it is documented.
		2051
		2052	=back
		2053
1023	=head1 AUTHOR	2054	=head1 AUTHOR
1024		2055
1025	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2056	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
1026		2057
1027	=cut	2058	=cut

Diff Legend

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