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.62 by root, Fri Jun 6 10:49:20 2008 UTC vs.
Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC

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

Diff Legend

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