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.38 by root, Mon May 26 21:28:33 2008 UTC vs.
Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC

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

Diff Legend

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