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.64 by root, Fri Jun 6 11:01:17 2008 UTC vs.
Revision 1.161 by root, Sat Jul 25 06:16:45 2009 UTC

1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;
4	use strict;
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
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);
12		6
		7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		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 = 4.15;	16	our $VERSION = 4.86;
20		17
21	=head1 SYNOPSIS	18	=head1 SYNOPSIS
22		19
23	use AnyEvent;	20	use AnyEvent;
24	use AnyEvent::Handle;	21	use AnyEvent::Handle;
25		22
26	my $cv = AnyEvent->condvar;	23	my $cv = AnyEvent->condvar;
27		24
28	my $handle =	25	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	26	fh => \*STDIN,
31	on_eof => sub {	27	on_error => sub {
32	$cv->broadcast;	28	my ($hdl, $fatal, $msg) = @_;
33	},	29	warn "got error $msg\n";
		30	$hdl->destroy;
		31	$cv->send;
34	);	32	);
35		33
36	# send some request line	34	# send some request line
37	$handle->push_write ("getinfo\015\012");	35	$hdl->push_write ("getinfo\015\012");
38		36
39	# read the response line	37	# read the response line
40	$handle->push_read (line => sub {	38	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	39	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	40	warn "got line <$line>\n";
43	$cv->send;	41	$cv->send;
44	});	42	});
45		43
46	$cv->recv;	44	$cv->recv;
47		45
48	=head1 DESCRIPTION	46	=head1 DESCRIPTION
49		47
50	This module is a helper module to make it easier to do event-based I/O on	48	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	49	filehandles.
52	on sockets see L<AnyEvent::Util>.	50
		51	The L<AnyEvent::Intro> tutorial contains some well-documented
		52	AnyEvent::Handle examples.
53		53
54	In the following, when the documentation refers to of "bytes" then this	54	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	55	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
57		57
		58	At the very minimum, you should specify C<fh> or C<connect>, and the
		59	C<on_error> callback.
		60
58	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
59	argument.	62	argument.
60		63
61	=head1 METHODS	64	=head1 METHODS
62		65
63	=over 4	66	=over 4
64		67
65	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
66		69
67	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
68		71
69	=over 4	72	=over 4
70		73
71	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
72		75
73	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
74
75	NOTE: The filehandle will be set to non-blocking (using	77	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		79	that mode.
77		80
		81	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		82
		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>.
		86
		87	You have to specify either this parameter, or C<fh>, above.
		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
78	=item on_eof => $cb->($handle)	98	=item on_prepare => $cb->($handle)
79		99
80	Set the callback to be called when an end-of-file condition is detcted,	100	This (rarely used) callback is called before a new connection is
81	i.e. in the case of a socket, when the other side has closed the	101	attempted, but after the file handle has been created. It could be used to
82	connection cleanly.	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).
83		105
84	While not mandatory, it is highly recommended to set an eof callback,	106	The return value of this callback should be the connect timeout value in
85	otherwise you might end up with a closed socket while you are still	107	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
86	waiting for data.	108	timeout is to be used).
87		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
88	=item on_error => $cb->($handle, $fatal)	136	=item on_error => $cb->($handle, $fatal, $message)
89		137
90	This is the error callback, which is called when, well, some error	138	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	139	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	140	connect or a read error.
93		141
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	142	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	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
96	usable. Non-fatal errors can be retried by simply returning, but it is	155	Non-fatal errors can be retried by simply returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	156	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	157	when this callback is invoked. Examples of non-fatal errors are timeouts
		158	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		159
100	On callback entrance, the value of C<$!> contains the operating system	160	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	161	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		162	C<EPROTO>).
102		163
103	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
104	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
105	C<croak>.	166	C<croak>.
106		167
…		…
110	and no read request is in the queue (unlike read queue callbacks, this	171	and no read request is in the queue (unlike read queue callbacks, this
111	callback will only be called when at least one octet of data is in the	172	callback will only be called when at least one octet of data is in the
112	read buffer).	173	read buffer).
113		174
114	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 >>
115	method or access the C<$handle->{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.
116		179
117	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
118	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
119	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
120	error will be raised (with C<$!> set to C<EPIPE>).	183	error will be raised (with C<$!> set to C<EPIPE>).
121		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
122	=item on_drain => $cb->($handle)	206	=item on_drain => $cb->($handle)
123		207
124	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
125	(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).
126		210
127	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.
		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.
128		218
129	=item timeout => $fractional_seconds	219	=item timeout => $fractional_seconds
130		220
131	If non-zero, then this enables an "inactivity" timeout: whenever this many	221	If non-zero, then this enables an "inactivity" timeout: whenever this many
132	seconds pass without a successful read or write on the underlying file	222	seconds pass without a successful read or write on the underlying file
133	handle, the C<on_timeout> callback will be invoked (and if that one is	223	handle, the C<on_timeout> callback will be invoked (and if that one is
134	missing, an C<ETIMEDOUT> error will be raised).	224	missing, a non-fatal C<ETIMEDOUT> error will be raised).
135		225
136	Note that timeout processing is also active when you currently do not have	226	Note that timeout processing is also active when you currently do not have
137	any outstanding read or write requests: If you plan to keep the connection	227	any outstanding read or write requests: If you plan to keep the connection
138	idle then you should disable the timout temporarily or ignore the timeout	228	idle then you should disable the timout temporarily or ignore the timeout
139	in the C<on_timeout> callback.	229	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		230	restart the timeout.
140		231
141	Zero (the default) disables this timeout.	232	Zero (the default) disables this timeout.
142		233
143	=item on_timeout => $cb->($handle)	234	=item on_timeout => $cb->($handle)
144		235
…		…
148		239
149	=item rbuf_max => <bytes>	240	=item rbuf_max => <bytes>
150		241
151	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>)
152	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
153	avoid denial-of-service attacks.	244	avoid some forms of denial-of-service attacks.
154		245
155	For example, a server accepting connections from untrusted sources should	246	For example, a server accepting connections from untrusted sources should
156	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
157	(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
158	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
159	isn't finished).	250	isn't finished).
160		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
161	=item read_size => <bytes>	278	=item read_size => <bytes>
162		279
163	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
164	during each (loop iteration). Default: C<8192>.	281	try to read during each loop iteration, which affects memory
		282	requirements). Default: C<8192>.
165		283
166	=item low_water_mark => <bytes>	284	=item low_water_mark => <bytes>
167		285
168	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
169	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
170	considered empty.	288	considered empty.
171		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
172	=item linger => <seconds>	295	=item linger => <seconds>
173		296
174	If non-zero (default: C<3600>), then the destructor of the	297	If non-zero (default: C<3600>), then the destructor of the
175	AnyEvent::Handle object will check wether there is still outstanding write	298	AnyEvent::Handle object will check whether there is still outstanding
176	data and will install a watcher that will write out this data. No errors	299	write data and will install a watcher that will write this data to the
177	will be reported (this mostly matches how the operating system treats	300	socket. No errors will be reported (this mostly matches how the operating
178	outstanding data at socket close time).	301	system treats outstanding data at socket close time).
179		302
180	This will not work for partial TLS data that could not yet been	303	This will not work for partial TLS data that could not be encoded
181	encoded. This data will be lost.	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>.
182		316
183	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	317	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
184		318
185	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
186	will start making tls handshake and will transparently encrypt/decrypt	320	AnyEvent will start a TLS handshake as soon as the conenction has been
187	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.
188		325
189	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
190	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.
191		330
192	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
193	connection, use C<connect> mode.	332	C<accept>, and for the TLS client side of a connection, use C<connect>
		333	mode.
194		334
195	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
196	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>
197	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
198	AnyEvent::Handle.	338	AnyEvent::Handle. Also, this module will take ownership of this connection
		339	object.
199		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
200	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.
201		351
202	=item tls_ctx => $ssl_ctx	352	=item tls_ctx => $anyevent_tls
203		353
204	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
205	(unless a connection object was specified directly). If this parameter is	355	(unless a connection object was specified directly). If this parameter is
206	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	356	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
207		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
208	=item json => JSON or JSON::XS object	394	=item json => JSON or JSON::XS object
209		395
210	This is the json coder object used by the C<json> read and write types.	396	This is the json coder object used by the C<json> read and write types.
211		397
212	If you don't supply it, then AnyEvent::Handle will create and use a	398	If you don't supply it, then AnyEvent::Handle will create and use a
213	suitable one, which will write and expect UTF-8 encoded JSON texts.	399	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		400	texts.
214		401
215	Note that you are responsible to depend on the JSON module if you want to	402	Note that you are responsible to depend on the JSON module if you want to
216	use this functionality, as AnyEvent does not have a dependency itself.	403	use this functionality, as AnyEvent does not have a dependency itself.
217		404
218	=item filter_r => $cb
219
220	=item filter_w => $cb
221
222	These exist, but are undocumented at this time.
223
224	=back	405	=back
225		406
226	=cut	407	=cut
227		408
228	sub new {	409	sub new {
229	my $class = shift;	410	my $class = shift;
230
231	my $self = bless { @_ }, $class;	411	my $self = bless { @_ }, $class;
232		412
233	$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) = @_;
234		476
235	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
236
237	if ($self->{tls}) {
238	require Net::SSLeay;
239	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
240	}
241		478
242	$self->{_activity} = AnyEvent->now;	479	$self->{_activity} = AnyEvent->now;
243	$self->_timeout;	480	$self->_timeout;
244		481
		482	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		483
		484	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		485	if $self->{tls};
		486
245	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
246		488
247	$self	489	$self->start_read
248	}	490	if $self->{on_read} || @{ $self->{_queue} };
249		491
		492	$self->_drain_wbuf;
		493	}
		494
250	sub _shutdown {	495	#sub _shutdown {
251	my ($self) = @_;	496	# my ($self) = @_;
252		497	#
253	delete $self->{_tw};	498	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
254	delete $self->{_rw};	499	# $self->{_eof} = 1; # tell starttls et. al to stop trying
255	delete $self->{_ww};	500	#
256	delete $self->{fh};	501	# &_freetls;
257		502	#}
258	$self->stoptls;
259	}
260		503
261	sub _error {	504	sub _error {
262	my ($self, $errno, $fatal) = @_;	505	my ($self, $errno, $fatal, $message) = @_;
263
264	$self->_shutdown
265	if $fatal;
266		506
267	$! = $errno;	507	$! = $errno;
		508	$message ||= "$!";
268		509
269	if ($self->{on_error}) {	510	if ($self->{on_error}) {
270	$self->{on_error}($self, $fatal);	511	$self->{on_error}($self, $fatal, $message);
271	} else {	512	$self->destroy if $fatal;
		513	} elsif ($self->{fh}) {
		514	$self->destroy;
272	Carp::croak "AnyEvent::Handle uncaught error: $!";	515	Carp::croak "AnyEvent::Handle uncaught error: $message";
273	}	516	}
274	}	517	}
275		518
276	=item $fh = $handle->fh	519	=item $fh = $handle->fh
277		520
278	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.
279		522
280	=cut	523	=cut
281		524
282	sub fh { $_[0]{fh} }	525	sub fh { $_[0]{fh} }
283		526
…		…
301	$_[0]{on_eof} = $_[1];	544	$_[0]{on_eof} = $_[1];
302	}	545	}
303		546
304	=item $handle->on_timeout ($cb)	547	=item $handle->on_timeout ($cb)
305		548
306	Replace the current C<on_timeout> callback, or disables the callback	549	Replace the current C<on_timeout> callback, or disables the callback (but
307	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	550	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
308	argument.	551	argument and method.
309		552
310	=cut	553	=cut
311		554
312	sub on_timeout {	555	sub on_timeout {
313	$_[0]{on_timeout} = $_[1];	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];
314	}	605	}
315		606
316	#############################################################################	607	#############################################################################
317		608
318	=item $handle->timeout ($seconds)	609	=item $handle->timeout ($seconds)
…		…
331	# reset the timeout watcher, as neccessary	622	# reset the timeout watcher, as neccessary
332	# also check for time-outs	623	# also check for time-outs
333	sub _timeout {	624	sub _timeout {
334	my ($self) = @_;	625	my ($self) = @_;
335		626
336	if ($self->{timeout}) {	627	if ($self->{timeout} && $self->{fh}) {
337	my $NOW = AnyEvent->now;	628	my $NOW = AnyEvent->now;
338		629
339	# when would the timeout trigger?	630	# when would the timeout trigger?
340	my $after = $self->{_activity} + $self->{timeout} - $NOW;	631	my $after = $self->{_activity} + $self->{timeout} - $NOW;
341		632
…		…
344	$self->{_activity} = $NOW;	635	$self->{_activity} = $NOW;
345		636
346	if ($self->{on_timeout}) {	637	if ($self->{on_timeout}) {
347	$self->{on_timeout}($self);	638	$self->{on_timeout}($self);
348	} else {	639	} else {
349	$self->_error (&Errno::ETIMEDOUT);	640	$self->_error (Errno::ETIMEDOUT);
350	}	641	}
351		642
352	# callback could have changed timeout value, optimise	643	# callback could have changed timeout value, optimise
353	return unless $self->{timeout};	644	return unless $self->{timeout};
354		645
…		…
396	my ($self, $cb) = @_;	687	my ($self, $cb) = @_;
397		688
398	$self->{on_drain} = $cb;	689	$self->{on_drain} = $cb;
399		690
400	$cb->($self)	691	$cb->($self)
401	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	692	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
402	}	693	}
403		694
404	=item $handle->push_write ($data)	695	=item $handle->push_write ($data)
405		696
406	Queues the given scalar to be written. You can push as much data as you	697	Queues the given scalar to be written. You can push as much data as you
…		…
417	Scalar::Util::weaken $self;	708	Scalar::Util::weaken $self;
418		709
419	my $cb = sub {	710	my $cb = sub {
420	my $len = syswrite $self->{fh}, $self->{wbuf};	711	my $len = syswrite $self->{fh}, $self->{wbuf};
421		712
422	if ($len >= 0) {	713	if (defined $len) {
423	substr $self->{wbuf}, 0, $len, "";	714	substr $self->{wbuf}, 0, $len, "";
424		715
425	$self->{_activity} = AnyEvent->now;	716	$self->{_activity} = AnyEvent->now;
426		717
427	$self->{on_drain}($self)	718	$self->{on_drain}($self)
428	if $self->{low_water_mark} >= length $self->{wbuf}	719	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
429	&& $self->{on_drain};	720	&& $self->{on_drain};
430		721
431	delete $self->{_ww} unless length $self->{wbuf};	722	delete $self->{_ww} unless length $self->{wbuf};
432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	723	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
433	$self->_error ($!, 1);	724	$self->_error ($!, 1);
434	}	725	}
435	};	726	};
436		727
437	# try to write data immediately	728	# try to write data immediately
438	$cb->();	729	$cb->() unless $self->{autocork};
439		730
440	# if still data left in wbuf, we need to poll	731	# if still data left in wbuf, we need to poll
441	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	732	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
442	if length $self->{wbuf};	733	if length $self->{wbuf};
443	};	734	};
…		…
457		748
458	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	749	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
459	->($self, @_);	750	->($self, @_);
460	}	751	}
461		752
462	if ($self->{filter_w}) {	753	if ($self->{tls}) {
463	$self->{filter_w}($self, \$_[0]);	754	$self->{_tls_wbuf} .= $_[0];
		755	&_dotls ($self) if $self->{fh};
464	} else {	756	} else {
465	$self->{wbuf} .= $_[0];	757	$self->{wbuf} .= $_[0];
466	$self->_drain_wbuf;	758	$self->_drain_wbuf if $self->{fh};
467	}	759	}
468	}	760	}
469		761
470	=item $handle->push_write (type => @args)	762	=item $handle->push_write (type => @args)
471		763
…		…
485	=cut	777	=cut
486		778
487	register_write_type netstring => sub {	779	register_write_type netstring => sub {
488	my ($self, $string) = @_;	780	my ($self, $string) = @_;
489		781
490	sprintf "%d:%s,", (length $string), $string	782	(length $string) . ":$string,"
491	};	783	};
492		784
493	=item packstring => $format, $data	785	=item packstring => $format, $data
494		786
495	An octet string prefixed with an encoded length. The encoding C<$format>	787	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
500	=cut	792	=cut
501		793
502	register_write_type packstring => sub {	794	register_write_type packstring => sub {
503	my ($self, $format, $string) = @_;	795	my ($self, $format, $string) = @_;
504		796
505	pack "$format/a", $string	797	pack "$format/a*", $string
506	};	798	};
507		799
508	=item json => $array_or_hashref	800	=item json => $array_or_hashref
509		801
510	Encodes the given hash or array reference into a JSON object. Unless you	802	Encodes the given hash or array reference into a JSON object. Unless you
…		…
556	register_write_type storable => sub {	848	register_write_type storable => sub {
557	my ($self, $ref) = @_;	849	my ($self, $ref) = @_;
558		850
559	require Storable;	851	require Storable;
560		852
561	pack "w/a", Storable::nfreeze ($ref)	853	pack "w/a*", Storable::nfreeze ($ref)
562	};	854	};
563		855
564	=back	856	=back
		857
		858	=item $handle->push_shutdown
		859
		860	Sometimes you know you want to close the socket after writing your data
		861	before it was actually written. One way to do that is to replace your
		862	C<on_drain> handler by a callback that shuts down the socket (and set
		863	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		864	replaces the C<on_drain> callback with:
		865
		866	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		867
		868	This simply shuts down the write side and signals an EOF condition to the
		869	the peer.
		870
		871	You can rely on the normal read queue and C<on_eof> handling
		872	afterwards. This is the cleanest way to close a connection.
		873
		874	=cut
		875
		876	sub push_shutdown {
		877	my ($self) = @_;
		878
		879	delete $self->{low_water_mark};
		880	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		881	}
565		882
566	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	883	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
567		884
568	This function (not method) lets you add your own types to C<push_write>.	885	This function (not method) lets you add your own types to C<push_write>.
569	Whenever the given C<type> is used, C<push_write> will invoke the code	886	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
590	ways, the "simple" way, using only C<on_read> and the "complex" way, using	907	ways, the "simple" way, using only C<on_read> and the "complex" way, using
591	a queue.	908	a queue.
592		909
593	In the simple case, you just install an C<on_read> callback and whenever	910	In the simple case, you just install an C<on_read> callback and whenever
594	new data arrives, it will be called. You can then remove some data (if	911	new data arrives, it will be called. You can then remove some data (if
595	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	912	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
596	or not.	913	leave the data there if you want to accumulate more (e.g. when only a
		914	partial message has been received so far).
597		915
598	In the more complex case, you want to queue multiple callbacks. In this	916	In the more complex case, you want to queue multiple callbacks. In this
599	case, AnyEvent::Handle will call the first queued callback each time new	917	case, AnyEvent::Handle will call the first queued callback each time new
600	data arrives (also the first time it is queued) and removes it when it has	918	data arrives (also the first time it is queued) and removes it when it has
601	done its job (see C<push_read>, below).	919	done its job (see C<push_read>, below).
…		…
619	# handle xml	937	# handle xml
620	});	938	});
621	});	939	});
622	});	940	});
623		941
624	Example 2: Implement a client for a protocol that replies either with	942	Example 2: Implement a client for a protocol that replies either with "OK"
625	"OK" and another line or "ERROR" for one request, and 64 bytes for the	943	and another line or "ERROR" for the first request that is sent, and 64
626	second request. Due tot he availability of a full queue, we can just	944	bytes for the second request. Due to the availability of a queue, we can
627	pipeline sending both requests and manipulate the queue as necessary in	945	just pipeline sending both requests and manipulate the queue as necessary
628	the callbacks:	946	in the callbacks.
629		947
630	# request one	948	When the first callback is called and sees an "OK" response, it will
		949	C<unshift> another line-read. This line-read will be queued I<before> the
		950	64-byte chunk callback.
		951
		952	# request one, returns either "OK + extra line" or "ERROR"
631	$handle->push_write ("request 1\015\012");	953	$handle->push_write ("request 1\015\012");
632		954
633	# we expect "ERROR" or "OK" as response, so push a line read	955	# we expect "ERROR" or "OK" as response, so push a line read
634	$handle->push_read (line => sub {	956	$handle->push_read (line => sub {
635	# if we got an "OK", we have to _prepend_ another line,	957	# if we got an "OK", we have to _prepend_ another line,
…		…
642	...	964	...
643	});	965	});
644	}	966	}
645	});	967	});
646		968
647	# request two	969	# request two, simply returns 64 octets
648	$handle->push_write ("request 2\015\012");	970	$handle->push_write ("request 2\015\012");
649		971
650	# simply read 64 bytes, always	972	# simply read 64 bytes, always
651	$handle->push_read (chunk => 64, sub {	973	$handle->push_read (chunk => 64, sub {
652	my $response = $_[1];	974	my $response = $_[1];
…		…
658	=cut	980	=cut
659		981
660	sub _drain_rbuf {	982	sub _drain_rbuf {
661	my ($self) = @_;	983	my ($self) = @_;
662		984
		985	# avoid recursion
		986	return if exists $self->{_skip_drain_rbuf};
663	local $self->{_in_drain} = 1;	987	local $self->{_skip_drain_rbuf} = 1;
664		988
665	if (	989	if (
666	defined $self->{rbuf_max}	990	defined $self->{rbuf_max}
667	&& $self->{rbuf_max} < length $self->{rbuf}	991	&& $self->{rbuf_max} < length $self->{rbuf}
668	) {	992	) {
669	return $self->_error (&Errno::ENOSPC, 1);	993	$self->_error (Errno::ENOSPC, 1), return;
670	}	994	}
671		995
672	while () {	996	while () {
673	no strict 'refs';	997	# we need to use a separate tls read buffer, as we must not receive data while
		998	# we are draining the buffer, and this can only happen with TLS.
		999	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
674		1000
675	my $len = length $self->{rbuf};	1001	my $len = length $self->{rbuf};
676		1002
677	if (my $cb = shift @{ $self->{_queue} }) {	1003	if (my $cb = shift @{ $self->{_queue} }) {
678	unless ($cb->($self)) {	1004	unless ($cb->($self)) {
679	if ($self->{_eof}) {	1005	if ($self->{_eof}) {
680	# no progress can be made (not enough data and no data forthcoming)	1006	# no progress can be made (not enough data and no data forthcoming)
681	$self->_error (&Errno::EPIPE, 1), last;	1007	$self->_error (Errno::EPIPE, 1), return;
682	}	1008	}
683		1009
684	unshift @{ $self->{_queue} }, $cb;	1010	unshift @{ $self->{_queue} }, $cb;
685	last;	1011	last;
686	}	1012	}
…		…
694	&& !@{ $self->{_queue} } # and the queue is still empty	1020	&& !@{ $self->{_queue} } # and the queue is still empty
695	&& $self->{on_read} # but we still have on_read	1021	&& $self->{on_read} # but we still have on_read
696	) {	1022	) {
697	# no further data will arrive	1023	# no further data will arrive
698	# so no progress can be made	1024	# so no progress can be made
699	$self->_error (&Errno::EPIPE, 1), last	1025	$self->_error (Errno::EPIPE, 1), return
700	if $self->{_eof};	1026	if $self->{_eof};
701		1027
702	last; # more data might arrive	1028	last; # more data might arrive
703	}	1029	}
704	} else {	1030	} else {
705	# read side becomes idle	1031	# read side becomes idle
706	delete $self->{_rw};	1032	delete $self->{_rw} unless $self->{tls};
707	last;	1033	last;
708	}	1034	}
709	}	1035	}
710		1036
		1037	if ($self->{_eof}) {
		1038	if ($self->{on_eof}) {
711	$self->{on_eof}($self)	1039	$self->{on_eof}($self)
712	if $self->{_eof} && $self->{on_eof};	1040	} else {
		1041	$self->_error (0, 1, "Unexpected end-of-file");
		1042	}
		1043	}
713		1044
714	# may need to restart read watcher	1045	# may need to restart read watcher
715	unless ($self->{_rw}) {	1046	unless ($self->{_rw}) {
716	$self->start_read	1047	$self->start_read
717	if $self->{on_read} || @{ $self->{_queue} };	1048	if $self->{on_read} || @{ $self->{_queue} };
…		…
728		1059
729	sub on_read {	1060	sub on_read {
730	my ($self, $cb) = @_;	1061	my ($self, $cb) = @_;
731		1062
732	$self->{on_read} = $cb;	1063	$self->{on_read} = $cb;
733	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1064	$self->_drain_rbuf if $cb;
734	}	1065	}
735		1066
736	=item $handle->rbuf	1067	=item $handle->rbuf
737		1068
738	Returns the read buffer (as a modifiable lvalue).	1069	Returns the read buffer (as a modifiable lvalue).
739		1070
740	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1071	You can access the read buffer directly as the C<< ->{rbuf} >>
741	you want.	1072	member, if you want. However, the only operation allowed on the
		1073	read buffer (apart from looking at it) is removing data from its
		1074	beginning. Otherwise modifying or appending to it is not allowed and will
		1075	lead to hard-to-track-down bugs.
742		1076
743	NOTE: The read buffer should only be used or modified if the C<on_read>,	1077	NOTE: The read buffer should only be used or modified if the C<on_read>,
744	C<push_read> or C<unshift_read> methods are used. The other read methods	1078	C<push_read> or C<unshift_read> methods are used. The other read methods
745	automatically manage the read buffer.	1079	automatically manage the read buffer.
746		1080
…		…
787	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1121	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
788	->($self, $cb, @_);	1122	->($self, $cb, @_);
789	}	1123	}
790		1124
791	push @{ $self->{_queue} }, $cb;	1125	push @{ $self->{_queue} }, $cb;
792	$self->_drain_rbuf unless $self->{_in_drain};	1126	$self->_drain_rbuf;
793	}	1127	}
794		1128
795	sub unshift_read {	1129	sub unshift_read {
796	my $self = shift;	1130	my $self = shift;
797	my $cb = pop;	1131	my $cb = pop;
…		…
803	->($self, $cb, @_);	1137	->($self, $cb, @_);
804	}	1138	}
805		1139
806		1140
807	unshift @{ $self->{_queue} }, $cb;	1141	unshift @{ $self->{_queue} }, $cb;
808	$self->_drain_rbuf unless $self->{_in_drain};	1142	$self->_drain_rbuf;
809	}	1143	}
810		1144
811	=item $handle->push_read (type => @args, $cb)	1145	=item $handle->push_read (type => @args, $cb)
812		1146
813	=item $handle->unshift_read (type => @args, $cb)	1147	=item $handle->unshift_read (type => @args, $cb)
…		…
843	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1177	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
844	1	1178	1
845	}	1179	}
846	};	1180	};
847		1181
848	# compatibility with older API
849	sub push_read_chunk {
850	$_[0]->push_read (chunk => $_[1], $_[2]);
851	}
852
853	sub unshift_read_chunk {
854	$_[0]->unshift_read (chunk => $_[1], $_[2]);
855	}
856
857	=item line => [$eol, ]$cb->($handle, $line, $eol)	1182	=item line => [$eol, ]$cb->($handle, $line, $eol)
858		1183
859	The callback will be called only once a full line (including the end of	1184	The callback will be called only once a full line (including the end of
860	line marker, C<$eol>) has been read. This line (excluding the end of line	1185	line marker, C<$eol>) has been read. This line (excluding the end of line
861	marker) will be passed to the callback as second argument (C<$line>), and	1186	marker) will be passed to the callback as second argument (C<$line>), and
…		…
876	=cut	1201	=cut
877		1202
878	register_read_type line => sub {	1203	register_read_type line => sub {
879	my ($self, $cb, $eol) = @_;	1204	my ($self, $cb, $eol) = @_;
880		1205
881	$eol = qr|(\015?\012)| if @_ < 3;	1206	if (@_ < 3) {
		1207	# this is more than twice as fast as the generic code below
		1208	sub {
		1209	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		1210
		1211	$cb->($_[0], $1, $2);
		1212	1
		1213	}
		1214	} else {
882	$eol = quotemeta $eol unless ref $eol;	1215	$eol = quotemeta $eol unless ref $eol;
883	$eol = qr|^(.*?)($eol)|s;	1216	$eol = qr|^(.*?)($eol)|s;
884		1217
885	sub {	1218	sub {
886	$_[0]{rbuf} =~ s/$eol// or return;	1219	$_[0]{rbuf} =~ s/$eol// or return;
887		1220
888	$cb->($_[0], $1, $2);	1221	$cb->($_[0], $1, $2);
		1222	1
889	1	1223	}
890	}	1224	}
891	};	1225	};
892
893	# compatibility with older API
894	sub push_read_line {
895	my $self = shift;
896	$self->push_read (line => @_);
897	}
898
899	sub unshift_read_line {
900	my $self = shift;
901	$self->unshift_read (line => @_);
902	}
903		1226
904	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1227	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
905		1228
906	Makes a regex match against the regex object C<$accept> and returns	1229	Makes a regex match against the regex object C<$accept> and returns
907	everything up to and including the match.	1230	everything up to and including the match.
…		…
957	return 1;	1280	return 1;
958	}	1281	}
959		1282
960	# reject	1283	# reject
961	if ($reject && $$rbuf =~ $reject) {	1284	if ($reject && $$rbuf =~ $reject) {
962	$self->_error (&Errno::EBADMSG);	1285	$self->_error (Errno::EBADMSG);
963	}	1286	}
964		1287
965	# skip	1288	# skip
966	if ($skip && $$rbuf =~ $skip) {	1289	if ($skip && $$rbuf =~ $skip) {
967	$data .= substr $$rbuf, 0, $+[0], "";	1290	$data .= substr $$rbuf, 0, $+[0], "";
…		…
983	my ($self, $cb) = @_;	1306	my ($self, $cb) = @_;
984		1307
985	sub {	1308	sub {
986	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1309	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
987	if ($_[0]{rbuf} =~ /[^0-9]/) {	1310	if ($_[0]{rbuf} =~ /[^0-9]/) {
988	$self->_error (&Errno::EBADMSG);	1311	$self->_error (Errno::EBADMSG);
989	}	1312	}
990	return;	1313	return;
991	}	1314	}
992		1315
993	my $len = $1;	1316	my $len = $1;
…		…
996	my $string = $_[1];	1319	my $string = $_[1];
997	$_[0]->unshift_read (chunk => 1, sub {	1320	$_[0]->unshift_read (chunk => 1, sub {
998	if ($_[1] eq ",") {	1321	if ($_[1] eq ",") {
999	$cb->($_[0], $string);	1322	$cb->($_[0], $string);
1000	} else {	1323	} else {
1001	$self->_error (&Errno::EBADMSG);	1324	$self->_error (Errno::EBADMSG);
1002	}	1325	}
1003	});	1326	});
1004	});	1327	});
1005		1328
1006	1	1329	1
…		…
1012	An octet string prefixed with an encoded length. The encoding C<$format>	1335	An octet string prefixed with an encoded length. The encoding C<$format>
1013	uses the same format as a Perl C<pack> format, but must specify a single	1336	uses the same format as a Perl C<pack> format, but must specify a single
1014	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1337	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1015	optional C<!>, C<< < >> or C<< > >> modifier).	1338	optional C<!>, C<< < >> or C<< > >> modifier).
1016		1339
1017	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1340	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1341	EPP uses a prefix of C<N> (4 octtes).
1018		1342
1019	Example: read a block of data prefixed by its length in BER-encoded	1343	Example: read a block of data prefixed by its length in BER-encoded
1020	format (very efficient).	1344	format (very efficient).
1021		1345
1022	$handle->push_read (packstring => "w", sub {	1346	$handle->push_read (packstring => "w", sub {
…		…
1028	register_read_type packstring => sub {	1352	register_read_type packstring => sub {
1029	my ($self, $cb, $format) = @_;	1353	my ($self, $cb, $format) = @_;
1030		1354
1031	sub {	1355	sub {
1032	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1356	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1033	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1357	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1034	or return;	1358	or return;
1035		1359
		1360	$format = length pack $format, $len;
		1361
		1362	# bypass unshift if we already have the remaining chunk
		1363	if ($format + $len <= length $_[0]{rbuf}) {
		1364	my $data = substr $_[0]{rbuf}, $format, $len;
		1365	substr $_[0]{rbuf}, 0, $format + $len, "";
		1366	$cb->($_[0], $data);
		1367	} else {
1036	# remove prefix	1368	# remove prefix
1037	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1369	substr $_[0]{rbuf}, 0, $format, "";
1038		1370
1039	# read rest	1371	# read remaining chunk
1040	$_[0]->unshift_read (chunk => $len, $cb);	1372	$_[0]->unshift_read (chunk => $len, $cb);
		1373	}
1041		1374
1042	1	1375	1
1043	}	1376	}
1044	};	1377	};
1045		1378
1046	=item json => $cb->($handle, $hash_or_arrayref)	1379	=item json => $cb->($handle, $hash_or_arrayref)
1047		1380
1048	Reads a JSON object or array, decodes it and passes it to the callback.	1381	Reads a JSON object or array, decodes it and passes it to the
		1382	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1049		1383
1050	If a C<json> object was passed to the constructor, then that will be used	1384	If a C<json> object was passed to the constructor, then that will be used
1051	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1385	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1052		1386
1053	This read type uses the incremental parser available with JSON version	1387	This read type uses the incremental parser available with JSON version
…		…
1062	=cut	1396	=cut
1063		1397
1064	register_read_type json => sub {	1398	register_read_type json => sub {
1065	my ($self, $cb) = @_;	1399	my ($self, $cb) = @_;
1066		1400
1067	require JSON;	1401	my $json = $self->{json} ||=
		1402	eval { require JSON::XS; JSON::XS->new->utf8 }
		1403	|| do { require JSON; JSON->new->utf8 };
1068		1404
1069	my $data;	1405	my $data;
1070	my $rbuf = \$self->{rbuf};	1406	my $rbuf = \$self->{rbuf};
1071		1407
1072	my $json = $self->{json} ||= JSON->new->utf8;
1073
1074	sub {	1408	sub {
1075	my $ref = $json->incr_parse ($self->{rbuf});	1409	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1076		1410
1077	if ($ref) {	1411	if ($ref) {
1078	$self->{rbuf} = $json->incr_text;	1412	$self->{rbuf} = $json->incr_text;
1079	$json->incr_text = "";	1413	$json->incr_text = "";
1080	$cb->($self, $ref);	1414	$cb->($self, $ref);
1081		1415
1082	1	1416	1
		1417	} elsif ($@) {
		1418	# error case
		1419	$json->incr_skip;
		1420
		1421	$self->{rbuf} = $json->incr_text;
		1422	$json->incr_text = "";
		1423
		1424	$self->_error (Errno::EBADMSG);
		1425
		1426	()
1083	} else {	1427	} else {
1084	$self->{rbuf} = "";	1428	$self->{rbuf} = "";
		1429
1085	()	1430	()
1086	}	1431	}
1087	}	1432	}
1088	};	1433	};
1089		1434
…		…
1102		1447
1103	require Storable;	1448	require Storable;
1104		1449
1105	sub {	1450	sub {
1106	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1451	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1107	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })	1452	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1108	or return;	1453	or return;
1109		1454
		1455	my $format = length pack "w", $len;
		1456
		1457	# bypass unshift if we already have the remaining chunk
		1458	if ($format + $len <= length $_[0]{rbuf}) {
		1459	my $data = substr $_[0]{rbuf}, $format, $len;
		1460	substr $_[0]{rbuf}, 0, $format + $len, "";
		1461	$cb->($_[0], Storable::thaw ($data));
		1462	} else {
1110	# remove prefix	1463	# remove prefix
1111	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";	1464	substr $_[0]{rbuf}, 0, $format, "";
1112		1465
1113	# read rest	1466	# read remaining chunk
1114	$_[0]->unshift_read (chunk => $len, sub {	1467	$_[0]->unshift_read (chunk => $len, sub {
1115	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1468	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1116	$cb->($_[0], $ref);	1469	$cb->($_[0], $ref);
1117	} else {	1470	} else {
1118	$self->_error (&Errno::EBADMSG);	1471	$self->_error (Errno::EBADMSG);
		1472	}
1119	}	1473	});
1120	});	1474	}
		1475
		1476	1
1121	}	1477	}
1122	};	1478	};
1123		1479
1124	=back	1480	=back
1125		1481
…		…
1155	Note that AnyEvent::Handle will automatically C<start_read> for you when	1511	Note that AnyEvent::Handle will automatically C<start_read> for you when
1156	you change the C<on_read> callback or push/unshift a read callback, and it	1512	you change the C<on_read> callback or push/unshift a read callback, and it
1157	will automatically C<stop_read> for you when neither C<on_read> is set nor	1513	will automatically C<stop_read> for you when neither C<on_read> is set nor
1158	there are any read requests in the queue.	1514	there are any read requests in the queue.
1159		1515
		1516	These methods will have no effect when in TLS mode (as TLS doesn't support
		1517	half-duplex connections).
		1518
1160	=cut	1519	=cut
1161		1520
1162	sub stop_read {	1521	sub stop_read {
1163	my ($self) = @_;	1522	my ($self) = @_;
1164		1523
1165	delete $self->{_rw};	1524	delete $self->{_rw} unless $self->{tls};
1166	}	1525	}
1167		1526
1168	sub start_read {	1527	sub start_read {
1169	my ($self) = @_;	1528	my ($self) = @_;
1170		1529
1171	unless ($self->{_rw} || $self->{_eof}) {	1530	unless ($self->{_rw} || $self->{_eof}) {
1172	Scalar::Util::weaken $self;	1531	Scalar::Util::weaken $self;
1173		1532
1174	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1533	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1175	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1534	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1176	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1535	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1177		1536
1178	if ($len > 0) {	1537	if ($len > 0) {
1179	$self->{_activity} = AnyEvent->now;	1538	$self->{_activity} = AnyEvent->now;
1180		1539
1181	$self->{filter_r}	1540	if ($self->{tls}) {
1182	? $self->{filter_r}($self, $rbuf)	1541	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1183	: $self->{_in_drain} || $self->_drain_rbuf;	1542
		1543	&_dotls ($self);
		1544	} else {
		1545	$self->_drain_rbuf;
		1546	}
1184		1547
1185	} elsif (defined $len) {	1548	} elsif (defined $len) {
1186	delete $self->{_rw};	1549	delete $self->{_rw};
1187	$self->{_eof} = 1;	1550	$self->{_eof} = 1;
1188	$self->_drain_rbuf unless $self->{_in_drain};	1551	$self->_drain_rbuf;
1189		1552
1190	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1553	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1191	return $self->_error ($!, 1);	1554	return $self->_error ($!, 1);
1192	}	1555	}
1193	});	1556	});
1194	}	1557	}
1195	}	1558	}
1196		1559
		1560	our $ERROR_SYSCALL;
		1561	our $ERROR_WANT_READ;
		1562
		1563	sub _tls_error {
		1564	my ($self, $err) = @_;
		1565
		1566	return $self->_error ($!, 1)
		1567	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1568
		1569	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1570
		1571	# reduce error string to look less scary
		1572	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1573
		1574	if ($self->{_on_starttls}) {
		1575	(delete $self->{_on_starttls})->($self, undef, $err);
		1576	&_freetls;
		1577	} else {
		1578	&_freetls;
		1579	$self->_error (Errno::EPROTO, 1, $err);
		1580	}
		1581	}
		1582
		1583	# poll the write BIO and send the data if applicable
		1584	# also decode read data if possible
		1585	# this is basiclaly our TLS state machine
		1586	# more efficient implementations are possible with openssl,
		1587	# but not with the buggy and incomplete Net::SSLeay.
1197	sub _dotls {	1588	sub _dotls {
1198	my ($self) = @_;	1589	my ($self) = @_;
1199		1590
1200	my $buf;	1591	my $tmp;
1201		1592
1202	if (length $self->{_tls_wbuf}) {	1593	if (length $self->{_tls_wbuf}) {
1203	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1594	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1204	substr $self->{_tls_wbuf}, 0, $len, "";	1595	substr $self->{_tls_wbuf}, 0, $tmp, "";
1205	}	1596	}
1206	}
1207		1597
		1598	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1599	return $self->_tls_error ($tmp)
		1600	if $tmp != $ERROR_WANT_READ
		1601	&& ($tmp != $ERROR_SYSCALL || $!);
		1602	}
		1603
		1604	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1605	unless (length $tmp) {
		1606	$self->{_on_starttls}
		1607	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1608	&_freetls;
		1609
		1610	if ($self->{on_stoptls}) {
		1611	$self->{on_stoptls}($self);
		1612	return;
		1613	} else {
		1614	# let's treat SSL-eof as we treat normal EOF
		1615	delete $self->{_rw};
		1616	$self->{_eof} = 1;
		1617	}
		1618	}
		1619
		1620	$self->{_tls_rbuf} .= $tmp;
		1621	$self->_drain_rbuf;
		1622	$self->{tls} or return; # tls session might have gone away in callback
		1623	}
		1624
		1625	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1626	return $self->_tls_error ($tmp)
		1627	if $tmp != $ERROR_WANT_READ
		1628	&& ($tmp != $ERROR_SYSCALL || $!);
		1629
1208	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1630	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1209	$self->{wbuf} .= $buf;	1631	$self->{wbuf} .= $tmp;
1210	$self->_drain_wbuf;	1632	$self->_drain_wbuf;
1211	}	1633	}
1212		1634
1213	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1635	$self->{_on_starttls}
1214	if (length $buf) {	1636	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1215	$self->{rbuf} .= $buf;	1637	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1216	$self->_drain_rbuf unless $self->{_in_drain};
1217	} else {
1218	# let's treat SSL-eof as we treat normal EOF
1219	$self->{_eof} = 1;
1220	$self->_shutdown;
1221	return;
1222	}
1223	}
1224
1225	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1226
1227	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1228	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1229	return $self->_error ($!, 1);
1230	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1231	return $self->_error (&Errno::EIO, 1);
1232	}
1233
1234	# all others are fine for our purposes
1235	}
1236	}	1638	}
1237		1639
1238	=item $handle->starttls ($tls[, $tls_ctx])	1640	=item $handle->starttls ($tls[, $tls_ctx])
1239		1641
1240	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1642	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1241	object is created, you can also do that at a later time by calling	1643	object is created, you can also do that at a later time by calling
1242	C<starttls>.	1644	C<starttls>.
1243		1645
		1646	Starting TLS is currently an asynchronous operation - when you push some
		1647	write data and then call C<< ->starttls >> then TLS negotiation will start
		1648	immediately, after which the queued write data is then sent.
		1649
1244	The first argument is the same as the C<tls> constructor argument (either	1650	The first argument is the same as the C<tls> constructor argument (either
1245	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1651	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1246		1652
1247	The second argument is the optional C<Net::SSLeay::CTX> object that is	1653	The second argument is the optional C<AnyEvent::TLS> object that is used
1248	used when AnyEvent::Handle has to create its own TLS connection object.	1654	when AnyEvent::Handle has to create its own TLS connection object, or
		1655	a hash reference with C<< key => value >> pairs that will be used to
		1656	construct a new context.
1249		1657
1250	The TLS connection object will end up in C<< $handle->{tls} >> after this	1658	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1251	call and can be used or changed to your liking. Note that the handshake	1659	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1252	might have already started when this function returns.	1660	changed to your liking. Note that the handshake might have already started
		1661	when this function returns.
1253		1662
		1663	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		1664	handshakes on the same stream. Best do not attempt to use the stream after
		1665	stopping TLS.
		1666
1254	=cut	1667	=cut
		1668
		1669	our %TLS_CACHE; #TODO not yet documented, should we?
1255		1670
1256	sub starttls {	1671	sub starttls {
1257	my ($self, $ssl, $ctx) = @_;	1672	my ($self, $tls, $ctx) = @_;
1258		1673
1259	$self->stoptls;	1674	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1675	if $self->{tls};
1260		1676
1261	if ($ssl eq "accept") {	1677	$self->{tls} = $tls;
1262	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1678	$self->{tls_ctx} = $ctx if @_ > 2;
1263	Net::SSLeay::set_accept_state ($ssl);	1679
1264	} elsif ($ssl eq "connect") {	1680	return unless $self->{fh};
1265	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1681
1266	Net::SSLeay::set_connect_state ($ssl);	1682	require Net::SSLeay;
		1683
		1684	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1685	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1686
		1687	$tls = $self->{tls};
		1688	$ctx = $self->{tls_ctx};
		1689
		1690	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1691
		1692	if ("HASH" eq ref $ctx) {
		1693	require AnyEvent::TLS;
		1694
		1695	if ($ctx->{cache}) {
		1696	my $key = $ctx+0;
		1697	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1698	} else {
		1699	$ctx = new AnyEvent::TLS %$ctx;
		1700	}
		1701	}
1267	}	1702
1268		1703	$self->{tls_ctx} = $ctx || TLS_CTX ();
1269	$self->{tls} = $ssl;	1704	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1270		1705
1271	# basically, this is deep magic (because SSL_read should have the same issues)	1706	# basically, this is deep magic (because SSL_read should have the same issues)
1272	# but the openssl maintainers basically said: "trust us, it just works".	1707	# but the openssl maintainers basically said: "trust us, it just works".
1273	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1708	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1274	# and mismaintained ssleay-module doesn't even offer them).	1709	# and mismaintained ssleay-module doesn't even offer them).
1275	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1710	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1711	#
		1712	# in short: this is a mess.
		1713	#
		1714	# note that we do not try to keep the length constant between writes as we are required to do.
		1715	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1716	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1717	# have identity issues in that area.
1276	Net::SSLeay::CTX_set_mode ($self->{tls},	1718	# Net::SSLeay::CTX_set_mode ($ssl,
1277	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1719	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1278	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1720	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1721	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1279		1722
1280	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1723	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1281	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1724	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1282		1725
1283	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1726	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1284		1727
1285	$self->{filter_w} = sub {	1728	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1286	$_[0]{_tls_wbuf} .= ${$_[1]};	1729	if $self->{on_starttls};
1287	&_dotls;	1730
1288	};	1731	&_dotls; # need to trigger the initial handshake
1289	$self->{filter_r} = sub {	1732	$self->start_read; # make sure we actually do read
1290	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1291	&_dotls;
1292	};
1293	}	1733	}
1294		1734
1295	=item $handle->stoptls	1735	=item $handle->stoptls
1296		1736
1297	Destroys the SSL connection, if any. Partial read or write data will be	1737	Shuts down the SSL connection - this makes a proper EOF handshake by
1298	lost.	1738	sending a close notify to the other side, but since OpenSSL doesn't
		1739	support non-blocking shut downs, it is not guarenteed that you can re-use
		1740	the stream afterwards.
1299		1741
1300	=cut	1742	=cut
1301		1743
1302	sub stoptls {	1744	sub stoptls {
1303	my ($self) = @_;	1745	my ($self) = @_;
1304		1746
1305	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1747	if ($self->{tls}) {
		1748	Net::SSLeay::shutdown ($self->{tls});
1306		1749
1307	delete $self->{_rbio};	1750	&_dotls;
1308	delete $self->{_wbio};	1751
1309	delete $self->{_tls_wbuf};	1752	# # we don't give a shit. no, we do, but we can't. no...#d#
1310	delete $self->{filter_r};	1753	# # we, we... have to use openssl :/#d#
1311	delete $self->{filter_w};	1754	# &_freetls;#d#
		1755	}
		1756	}
		1757
		1758	sub _freetls {
		1759	my ($self) = @_;
		1760
		1761	return unless $self->{tls};
		1762
		1763	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1764	if ref $self->{tls};
		1765
		1766	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1312	}	1767	}
1313		1768
1314	sub DESTROY {	1769	sub DESTROY {
1315	my $self = shift;	1770	my ($self) = @_;
1316		1771
1317	$self->stoptls;	1772	&_freetls;
1318		1773
1319	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1774	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1320		1775
1321	if ($linger && length $self->{wbuf}) {	1776	if ($linger && length $self->{wbuf} && $self->{fh}) {
1322	my $fh = delete $self->{fh};	1777	my $fh = delete $self->{fh};
1323	my $wbuf = delete $self->{wbuf};	1778	my $wbuf = delete $self->{wbuf};
1324		1779
1325	my @linger;	1780	my @linger;
1326		1781
…		…
1337	@linger = ();	1792	@linger = ();
1338	});	1793	});
1339	}	1794	}
1340	}	1795	}
1341		1796
		1797	=item $handle->destroy
		1798
		1799	Shuts down the handle object as much as possible - this call ensures that
		1800	no further callbacks will be invoked and as many resources as possible
		1801	will be freed. You must not call any methods on the object afterwards.
		1802
		1803	Normally, you can just "forget" any references to an AnyEvent::Handle
		1804	object and it will simply shut down. This works in fatal error and EOF
		1805	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1806	callback, so when you want to destroy the AnyEvent::Handle object from
		1807	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1808	that case.
		1809
		1810	Destroying the handle object in this way has the advantage that callbacks
		1811	will be removed as well, so if those are the only reference holders (as
		1812	is common), then one doesn't need to do anything special to break any
		1813	reference cycles.
		1814
		1815	The handle might still linger in the background and write out remaining
		1816	data, as specified by the C<linger> option, however.
		1817
		1818	=cut
		1819
		1820	sub destroy {
		1821	my ($self) = @_;
		1822
		1823	$self->DESTROY;
		1824	%$self = ();
		1825	}
		1826
1342	=item AnyEvent::Handle::TLS_CTX	1827	=item AnyEvent::Handle::TLS_CTX
1343		1828
1344	This function creates and returns the Net::SSLeay::CTX object used by	1829	This function creates and returns the AnyEvent::TLS object used by default
1345	default for TLS mode.	1830	for TLS mode.
1346		1831
1347	The context is created like this:	1832	The context is created by calling L<AnyEvent::TLS> without any arguments.
1348
1349	Net::SSLeay::load_error_strings;
1350	Net::SSLeay::SSLeay_add_ssl_algorithms;
1351	Net::SSLeay::randomize;
1352
1353	my $CTX = Net::SSLeay::CTX_new;
1354
1355	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1356		1833
1357	=cut	1834	=cut
1358		1835
1359	our $TLS_CTX;	1836	our $TLS_CTX;
1360		1837
1361	sub TLS_CTX() {	1838	sub TLS_CTX() {
1362	$TLS_CTX || do {	1839	$TLS_CTX ||= do {
1363	require Net::SSLeay;	1840	require AnyEvent::TLS;
1364		1841
1365	Net::SSLeay::load_error_strings ();	1842	new AnyEvent::TLS
1366	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1367	Net::SSLeay::randomize ();
1368
1369	$TLS_CTX = Net::SSLeay::CTX_new ();
1370
1371	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1372
1373	$TLS_CTX
1374	}	1843	}
1375	}	1844	}
1376		1845
1377	=back	1846	=back
		1847
		1848
		1849	=head1 NONFREQUENTLY ASKED QUESTIONS
		1850
		1851	=over 4
		1852
		1853	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1854	still get further invocations!
		1855
		1856	That's because AnyEvent::Handle keeps a reference to itself when handling
		1857	read or write callbacks.
		1858
		1859	It is only safe to "forget" the reference inside EOF or error callbacks,
		1860	from within all other callbacks, you need to explicitly call the C<<
		1861	->destroy >> method.
		1862
		1863	=item I get different callback invocations in TLS mode/Why can't I pause
		1864	reading?
		1865
		1866	Unlike, say, TCP, TLS connections do not consist of two independent
		1867	communication channels, one for each direction. Or put differently. The
		1868	read and write directions are not independent of each other: you cannot
		1869	write data unless you are also prepared to read, and vice versa.
		1870
		1871	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1872	callback invocations when you are not expecting any read data - the reason
		1873	is that AnyEvent::Handle always reads in TLS mode.
		1874
		1875	During the connection, you have to make sure that you always have a
		1876	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1877	connection (or when you no longer want to use it) you can call the
		1878	C<destroy> method.
		1879
		1880	=item How do I read data until the other side closes the connection?
		1881
		1882	If you just want to read your data into a perl scalar, the easiest way
		1883	to achieve this is by setting an C<on_read> callback that does nothing,
		1884	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1885	will be in C<$_[0]{rbuf}>:
		1886
		1887	$handle->on_read (sub { });
		1888	$handle->on_eof (undef);
		1889	$handle->on_error (sub {
		1890	my $data = delete $_[0]{rbuf};
		1891	});
		1892
		1893	The reason to use C<on_error> is that TCP connections, due to latencies
		1894	and packets loss, might get closed quite violently with an error, when in
		1895	fact, all data has been received.
		1896
		1897	It is usually better to use acknowledgements when transferring data,
		1898	to make sure the other side hasn't just died and you got the data
		1899	intact. This is also one reason why so many internet protocols have an
		1900	explicit QUIT command.
		1901
		1902	=item I don't want to destroy the handle too early - how do I wait until
		1903	all data has been written?
		1904
		1905	After writing your last bits of data, set the C<on_drain> callback
		1906	and destroy the handle in there - with the default setting of
		1907	C<low_water_mark> this will be called precisely when all data has been
		1908	written to the socket:
		1909
		1910	$handle->push_write (...);
		1911	$handle->on_drain (sub {
		1912	warn "all data submitted to the kernel\n";
		1913	undef $handle;
		1914	});
		1915
		1916	If you just want to queue some data and then signal EOF to the other side,
		1917	consider using C<< ->push_shutdown >> instead.
		1918
		1919	=item I want to contact a TLS/SSL server, I don't care about security.
		1920
		1921	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1922	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1923	parameter:
		1924
		1925	tcp_connect $host, $port, sub {
		1926	my ($fh) = @_;
		1927
		1928	my $handle = new AnyEvent::Handle
		1929	fh => $fh,
		1930	tls => "connect",
		1931	on_error => sub { ... };
		1932
		1933	$handle->push_write (...);
		1934	};
		1935
		1936	=item I want to contact a TLS/SSL server, I do care about security.
		1937
		1938	Then you should additionally enable certificate verification, including
		1939	peername verification, if the protocol you use supports it (see
		1940	L<AnyEvent::TLS>, C<verify_peername>).
		1941
		1942	E.g. for HTTPS:
		1943
		1944	tcp_connect $host, $port, sub {
		1945	my ($fh) = @_;
		1946
		1947	my $handle = new AnyEvent::Handle
		1948	fh => $fh,
		1949	peername => $host,
		1950	tls => "connect",
		1951	tls_ctx => { verify => 1, verify_peername => "https" },
		1952	...
		1953
		1954	Note that you must specify the hostname you connected to (or whatever
		1955	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1956	peername verification will be done.
		1957
		1958	The above will use the system-dependent default set of trusted CA
		1959	certificates. If you want to check against a specific CA, add the
		1960	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1961
		1962	tls_ctx => {
		1963	verify => 1,
		1964	verify_peername => "https",
		1965	ca_file => "my-ca-cert.pem",
		1966	},
		1967
		1968	=item I want to create a TLS/SSL server, how do I do that?
		1969
		1970	Well, you first need to get a server certificate and key. You have
		1971	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1972	self-signed certificate (cheap. check the search engine of your choice,
		1973	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1974	nice program for that purpose).
		1975
		1976	Then create a file with your private key (in PEM format, see
		1977	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1978	file should then look like this:
		1979
		1980	-----BEGIN RSA PRIVATE KEY-----
		1981	...header data
		1982	... lots of base64'y-stuff
		1983	-----END RSA PRIVATE KEY-----
		1984
		1985	-----BEGIN CERTIFICATE-----
		1986	... lots of base64'y-stuff
		1987	-----END CERTIFICATE-----
		1988
		1989	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1990	specify this file as C<cert_file>:
		1991
		1992	tcp_server undef, $port, sub {
		1993	my ($fh) = @_;
		1994
		1995	my $handle = new AnyEvent::Handle
		1996	fh => $fh,
		1997	tls => "accept",
		1998	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1999	...
		2000
		2001	When you have intermediate CA certificates that your clients might not
		2002	know about, just append them to the C<cert_file>.
		2003
		2004	=back
		2005
1378		2006
1379	=head1 SUBCLASSING AnyEvent::Handle	2007	=head1 SUBCLASSING AnyEvent::Handle
1380		2008
1381	In many cases, you might want to subclass AnyEvent::Handle.	2009	In many cases, you might want to subclass AnyEvent::Handle.
1382		2010
…		…
1386	=over 4	2014	=over 4
1387		2015
1388	=item * all constructor arguments become object members.	2016	=item * all constructor arguments become object members.
1389		2017
1390	At least initially, when you pass a C<tls>-argument to the constructor it	2018	At least initially, when you pass a C<tls>-argument to the constructor it
1391	will end up in C<< $handle->{tls} >>. Those members might be changes or	2019	will end up in C<< $handle->{tls} >>. Those members might be changed or
1392	mutated later on (for example C<tls> will hold the TLS connection object).	2020	mutated later on (for example C<tls> will hold the TLS connection object).
1393		2021
1394	=item * other object member names are prefixed with an C<_>.	2022	=item * other object member names are prefixed with an C<_>.
1395		2023
1396	All object members not explicitly documented (internal use) are prefixed	2024	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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