ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.38 by root, Mon May 26 21:28:33 2008 UTC vs.
Revision 1.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(WSAWOULDBLOCK);
8	use Scalar::Util ();	3	use Scalar::Util ();
9	use Carp ();	4	use Carp ();
10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;	5	use Errno qw(EAGAIN EINTR);
		6
		7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
12		9
13	=head1 NAME	10	=head1 NAME
14		11
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		13
17	=cut	14	=cut
18		15
19	our $VERSION = '0.04';	16	our $VERSION = 4.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
78	=item on_eof => $cb->($self)	81	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
79		82
80	Set the callback to be called on EOF.	83	Try to connect to the specified host and service (port), using
		84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		85	default C<peername>.
81		86
82	While not mandatory, it is highly recommended to set an eof callback,	87	You have to specify either this parameter, or C<fh>, above.
83	otherwise you might end up with a closed socket while you are still
84	waiting for data.
85		88
		89	It is possible to push requests on the read and write queues, and modify
		90	properties of the stream, even while AnyEvent::Handle is connecting.
		91
		92	When this parameter is specified, then the C<on_prepare>,
		93	C<on_connect_error> and C<on_connect> callbacks will be called under the
		94	appropriate circumstances:
		95
		96	=over 4
		97
86	=item on_error => $cb->($self)	98	=item on_prepare => $cb->($handle)
87		99
		100	This (rarely used) callback is called before a new connection is
		101	attempted, but after the file handle has been created. It could be used to
		102	prepare the file handle with parameters required for the actual connect
		103	(as opposed to settings that can be changed when the connection is already
		104	established).
		105
		106	=item on_connect => $cb->($handle, $host, $port, $retry->())
		107
		108	This callback is called when a connection has been successfully established.
		109
		110	The actual numeric host and port (the socket peername) are passed as
		111	parameters, together with a retry callback.
		112
		113	When, for some reason, the handle is not acceptable, then calling
		114	C<$retry> will continue with the next conenction target (in case of
		115	multi-homed hosts or SRV records there can be multiple connection
		116	endpoints). When it is called then the read and write queues, eof status,
		117	tls status and similar properties of the handle are being reset.
		118
		119	In most cases, ignoring the C<$retry> parameter is the way to go.
		120
		121	=item on_connect_error => $cb->($handle, $message)
		122
		123	This callback is called when the conenction could not be
		124	established. C<$!> will contain the relevant error code, and C<$message> a
		125	message describing it (usually the same as C<"$!">).
		126
		127	If this callback isn't specified, then C<on_error> will be called with a
		128	fatal error instead.
		129
		130	=back
		131
		132	=item on_error => $cb->($handle, $fatal, $message)
		133
88	This is the fatal error callback, that is called when, well, a fatal error	134	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	135	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	136	connect or a read error.
91		137
92	The object will not be in a usable state when this callback has been	138	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	139	fatal errors the handle object will be destroyed (by a call to C<< ->
		140	destroy >>) after invoking the error callback (which means you are free to
		141	examine the handle object). Examples of fatal errors are an EOF condition
		142	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		143	cases where the other side can close the connection at their will it is
		144	often easiest to not report C<EPIPE> errors in this callback.
		145
		146	AnyEvent::Handle tries to find an appropriate error code for you to check
		147	against, but in some cases (TLS errors), this does not work well. It is
		148	recommended to always output the C<$message> argument in human-readable
		149	error messages (it's usually the same as C<"$!">).
		150
		151	Non-fatal errors can be retried by simply returning, but it is recommended
		152	to simply ignore this parameter and instead abondon the handle object
		153	when this callback is invoked. Examples of non-fatal errors are timeouts
		154	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
94		155
95	On callback entrance, the value of C<$!> contains the operating system	156	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	157	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
97		158	C<EPROTO>).
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100		159
101	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
102	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
103	die.	162	C<croak>.
104		163
105	=item on_read => $cb->($self)	164	=item on_read => $cb->($handle)
106		165
107	This sets the default read callback, which is called when data arrives	166	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	167	and no read request is in the queue (unlike read queue callbacks, this
		168	callback will only be called when at least one octet of data is in the
		169	read buffer).
109		170
110	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 >>
111	method or access the C<$self->{rbuf}> member directly.	172	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		173	must not enlarge or modify the read buffer, you can only remove data at
		174	the beginning from it.
112		175
113	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
114	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
115	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
116	error will be raised (with C<$!> set to C<EPIPE>).	179	error will be raised (with C<$!> set to C<EPIPE>).
117		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
118	=item on_drain => $cb->()	202	=item on_drain => $cb->($handle)
119		203
120	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
121	(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).
122		206
123	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.
124		208
		209	This callback is useful when you don't want to put all of your write data
		210	into the queue at once, for example, when you want to write the contents
		211	of some file to the socket you might not want to read the whole file into
		212	memory and push it into the queue, but instead only read more data from
		213	the file when the write queue becomes empty.
		214
		215	=item timeout => $fractional_seconds
		216
		217	If non-zero, then this enables an "inactivity" timeout: whenever this many
		218	seconds pass without a successful read or write on the underlying file
		219	handle, the C<on_timeout> callback will be invoked (and if that one is
		220	missing, a non-fatal C<ETIMEDOUT> error will be raised).
		221
		222	Note that timeout processing is also active when you currently do not have
		223	any outstanding read or write requests: If you plan to keep the connection
		224	idle then you should disable the timout temporarily or ignore the timeout
		225	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		226	restart the timeout.
		227
		228	Zero (the default) disables this timeout.
		229
		230	=item on_timeout => $cb->($handle)
		231
		232	Called whenever the inactivity timeout passes. If you return from this
		233	callback, then the timeout will be reset as if some activity had happened,
		234	so this condition is not fatal in any way.
		235
125	=item rbuf_max => <bytes>	236	=item rbuf_max => <bytes>
126		237
127	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>)
128	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
129	avoid denial-of-service attacks.	240	avoid some forms of denial-of-service attacks.
130		241
131	For example, a server accepting connections from untrusted sources should	242	For example, a server accepting connections from untrusted sources should
132	be configured to accept only so-and-so much data that it cannot act on	243	be configured to accept only so-and-so much data that it cannot act on
133	(for example, when expecting a line, an attacker could send an unlimited	244	(for example, when expecting a line, an attacker could send an unlimited
134	amount of data without a callback ever being called as long as the line	245	amount of data without a callback ever being called as long as the line
135	isn't finished).	246	isn't finished).
136		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
137	=item read_size => <bytes>	274	=item read_size => <bytes>
138		275
139	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
140	on each [loop iteration). Default: C<4096>.	277	try to read during each loop iteration, which affects memory
		278	requirements). Default: C<8192>.
141		279
142	=item low_water_mark => <bytes>	280	=item low_water_mark => <bytes>
143		281
144	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
145	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
146	considered empty.	284	considered empty.
147		285
		286	Sometimes it can be beneficial (for performance reasons) to add data to
		287	the write buffer before it is fully drained, but this is a rare case, as
		288	the operating system kernel usually buffers data as well, so the default
		289	is good in almost all cases.
		290
		291	=item linger => <seconds>
		292
		293	If non-zero (default: C<3600>), then the destructor of the
		294	AnyEvent::Handle object will check whether there is still outstanding
		295	write data and will install a watcher that will write this data to the
		296	socket. No errors will be reported (this mostly matches how the operating
		297	system treats outstanding data at socket close time).
		298
		299	This will not work for partial TLS data that could not be encoded
		300	yet. This data will be lost. Calling the C<stoptls> method in time might
		301	help.
		302
		303	=item peername => $string
		304
		305	A string used to identify the remote site - usually the DNS hostname
		306	(I<not> IDN!) used to create the connection, rarely the IP address.
		307
		308	Apart from being useful in error messages, this string is also used in TLS
		309	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		310	verification will be skipped when C<peername> is not specified or
		311	C<undef>.
		312
148	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	313	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
149		314
150	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
151	will start making tls handshake and will transparently encrypt/decrypt	316	AnyEvent will start a TLS handshake as soon as the conenction has been
152	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.
153		321
154	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
155	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.
156		326
157	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
158	connection, use C<connect> mode.	328	C<accept>, and for the TLS client side of a connection, use C<connect>
		329	mode.
159		330
160	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
161	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>
162	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
163	AnyEvent::Handle.	334	AnyEvent::Handle. Also, this module will take ownership of this connection
		335	object.
164		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
165	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.
166		347
167	=item tls_ctx => $ssl_ctx	348	=item tls_ctx => $anyevent_tls
168		349
169	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
170	(unless a connection object was specified directly). If this parameter is	351	(unless a connection object was specified directly). If this parameter is
171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	352	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
172		353
173	=item filter_r => $cb	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.
174		357
175	=item filter_w => $cb	358	=item on_starttls => $cb->($handle, $success[, $error_message])
176		359
177	These exist, but are undocumented at this time.	360	This callback will be invoked when the TLS/SSL handshake has finished. If
		361	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		362	(C<on_stoptls> will not be called in this case).
		363
		364	The session in C<< $handle->{tls} >> can still be examined in this
		365	callback, even when the handshake was not successful.
		366
		367	TLS handshake failures will not cause C<on_error> to be invoked when this
		368	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		369
		370	Without this callback, handshake failures lead to C<on_error> being
		371	called, as normal.
		372
		373	Note that you cannot call C<starttls> right again in this callback. If you
		374	need to do that, start an zero-second timer instead whose callback can
		375	then call C<< ->starttls >> again.
		376
		377	=item on_stoptls => $cb->($handle)
		378
		379	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		380	set, then it will be invoked after freeing the TLS session. If it is not,
		381	then a TLS shutdown condition will be treated like a normal EOF condition
		382	on the handle.
		383
		384	The session in C<< $handle->{tls} >> can still be examined in this
		385	callback.
		386
		387	This callback will only be called on TLS shutdowns, not when the
		388	underlying handle signals EOF.
		389
		390	=item json => JSON or JSON::XS object
		391
		392	This is the json coder object used by the C<json> read and write types.
		393
		394	If you don't supply it, then AnyEvent::Handle will create and use a
		395	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		396	texts.
		397
		398	Note that you are responsible to depend on the JSON module if you want to
		399	use this functionality, as AnyEvent does not have a dependency itself.
178		400
179	=back	401	=back
180		402
181	=cut	403	=cut
182		404
183	sub new {	405	sub new {
184	my $class = shift;	406	my $class = shift;
185
186	my $self = bless { @_ }, $class;	407	my $self = bless { @_ }, $class;
187		408
188	$self->{fh} or Carp::croak "mandatory argument fh is missing";	409	if ($self->{fh}) {
		410	$self->_start;
		411	return unless $self->{fh}; # could be gone by now
		412
		413	} elsif ($self->{connect}) {
		414	require AnyEvent::Socket;
		415
		416	$self->{peername} = $self->{connect}[0]
		417	unless exists $self->{peername};
		418
		419	$self->{_skip_drain_rbuf} = 1;
		420
		421	{
		422	Scalar::Util::weaken (my $self = $self);
		423
		424	$self->{_connect} =
		425	AnyEvent::Socket::tcp_connect (
		426	$self->{connect}[0],
		427	$self->{connect}[1],
		428	sub {
		429	my ($fh, $host, $port, $retry) = @_;
		430
		431	if ($fh) {
		432	$self->{fh} = $fh;
		433
		434	delete $self->{_skip_drain_rbuf};
		435	$self->_start;
		436
		437	$self->{on_connect}
		438	and $self->{on_connect}($self, $host, $port, sub {
		439	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		440	$self->{_skip_drain_rbuf} = 1;
		441	&$retry;
		442	});
		443
		444	} else {
		445	if ($self->{on_connect_error}) {
		446	$self->{on_connect_error}($self, "$!");
		447	$self->destroy;
		448	} else {
		449	$self->fatal ($!, 1);
		450	}
		451	}
		452	},
		453	sub {
		454	local $self->{fh} = $_[0];
		455
		456	$self->{on_prepare}->($self)
		457	if $self->{on_prepare};
		458	}
		459	);
		460	}
		461
		462	} else {
		463	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		464	}
		465
		466	$self
		467	}
		468
		469	sub _start {
		470	my ($self) = @_;
189		471
190	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	472	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
191		473
192	if ($self->{tls}) {	474	$self->{_activity} = AnyEvent->now;
193	require Net::SSLeay;	475	$self->_timeout;
		476
		477	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		478
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	479	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
195	}	480	if $self->{tls};
196		481
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};
198	$self->on_error (delete $self->{on_error}) if $self->{on_error};
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	482	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
201		483
202	$self->start_read;	484	$self->start_read
		485	if $self->{on_read} || @{ $self->{_queue} };
203		486
204	$self	487	$self->_drain_wbuf;
205	}	488	}
206		489
207	sub _shutdown {	490	#sub _shutdown {
208	my ($self) = @_;	491	# my ($self) = @_;
		492	#
		493	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
		494	# $self->{_eof} = 1; # tell starttls et. al to stop trying
		495	#
		496	# &_freetls;
		497	#}
209		498
210	delete $self->{_rw};
211	delete $self->{_ww};
212	delete $self->{fh};
213	}
214
215	sub error {	499	sub _error {
216	my ($self) = @_;	500	my ($self, $errno, $fatal, $message) = @_;
217		501
218	{	502	$! = $errno;
219	local $!;	503	$message ||= "$!";
220	$self->_shutdown;
221	}
222		504
223	$self->{on_error}($self)
224	if $self->{on_error};	505	if ($self->{on_error}) {
225		506	$self->{on_error}($self, $fatal, $message);
		507	$self->destroy if $fatal;
		508	} elsif ($self->{fh}) {
		509	$self->destroy;
226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	510	Carp::croak "AnyEvent::Handle uncaught error: $message";
		511	}
227	}	512	}
228		513
229	=item $fh = $handle->fh	514	=item $fh = $handle->fh
230		515
231	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.
232		517
233	=cut	518	=cut
234		519
235	sub fh { $_[0]{fh} }	520	sub fh { $_[0]{fh} }
236		521
…		…
252		537
253	sub on_eof {	538	sub on_eof {
254	$_[0]{on_eof} = $_[1];	539	$_[0]{on_eof} = $_[1];
255	}	540	}
256		541
		542	=item $handle->on_timeout ($cb)
		543
		544	Replace the current C<on_timeout> callback, or disables the callback (but
		545	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
		546	argument and method.
		547
		548	=cut
		549
		550	sub on_timeout {
		551	$_[0]{on_timeout} = $_[1];
		552	}
		553
		554	=item $handle->autocork ($boolean)
		555
		556	Enables or disables the current autocork behaviour (see C<autocork>
		557	constructor argument). Changes will only take effect on the next write.
		558
		559	=cut
		560
		561	sub autocork {
		562	$_[0]{autocork} = $_[1];
		563	}
		564
		565	=item $handle->no_delay ($boolean)
		566
		567	Enables or disables the C<no_delay> setting (see constructor argument of
		568	the same name for details).
		569
		570	=cut
		571
		572	sub no_delay {
		573	$_[0]{no_delay} = $_[1];
		574
		575	eval {
		576	local $SIG{__DIE__};
		577	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		578	if $_[0]{fh};
		579	};
		580	}
		581
		582	=item $handle->on_starttls ($cb)
		583
		584	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		585
		586	=cut
		587
		588	sub on_starttls {
		589	$_[0]{on_starttls} = $_[1];
		590	}
		591
		592	=item $handle->on_stoptls ($cb)
		593
		594	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		595
		596	=cut
		597
		598	sub on_starttls {
		599	$_[0]{on_stoptls} = $_[1];
		600	}
		601
		602	#############################################################################
		603
		604	=item $handle->timeout ($seconds)
		605
		606	Configures (or disables) the inactivity timeout.
		607
		608	=cut
		609
		610	sub timeout {
		611	my ($self, $timeout) = @_;
		612
		613	$self->{timeout} = $timeout;
		614	$self->_timeout;
		615	}
		616
		617	# reset the timeout watcher, as neccessary
		618	# also check for time-outs
		619	sub _timeout {
		620	my ($self) = @_;
		621
		622	if ($self->{timeout} && $self->{fh}) {
		623	my $NOW = AnyEvent->now;
		624
		625	# when would the timeout trigger?
		626	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		627
		628	# now or in the past already?
		629	if ($after <= 0) {
		630	$self->{_activity} = $NOW;
		631
		632	if ($self->{on_timeout}) {
		633	$self->{on_timeout}($self);
		634	} else {
		635	$self->_error (Errno::ETIMEDOUT);
		636	}
		637
		638	# callback could have changed timeout value, optimise
		639	return unless $self->{timeout};
		640
		641	# calculate new after
		642	$after = $self->{timeout};
		643	}
		644
		645	Scalar::Util::weaken $self;
		646	return unless $self; # ->error could have destroyed $self
		647
		648	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
		649	delete $self->{_tw};
		650	$self->_timeout;
		651	});
		652	} else {
		653	delete $self->{_tw};
		654	}
		655	}
		656
257	#############################################################################	657	#############################################################################
258		658
259	=back	659	=back
260		660
261	=head2 WRITE QUEUE	661	=head2 WRITE QUEUE
…		…
282	my ($self, $cb) = @_;	682	my ($self, $cb) = @_;
283		683
284	$self->{on_drain} = $cb;	684	$self->{on_drain} = $cb;
285		685
286	$cb->($self)	686	$cb->($self)
287	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	687	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
288	}	688	}
289		689
290	=item $handle->push_write ($data)	690	=item $handle->push_write ($data)
291		691
292	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
…		…
303	Scalar::Util::weaken $self;	703	Scalar::Util::weaken $self;
304		704
305	my $cb = sub {	705	my $cb = sub {
306	my $len = syswrite $self->{fh}, $self->{wbuf};	706	my $len = syswrite $self->{fh}, $self->{wbuf};
307		707
308	if ($len >= 0) {	708	if (defined $len) {
309	substr $self->{wbuf}, 0, $len, "";	709	substr $self->{wbuf}, 0, $len, "";
310		710
		711	$self->{_activity} = AnyEvent->now;
		712
311	$self->{on_drain}($self)	713	$self->{on_drain}($self)
312	if $self->{low_water_mark} >= length $self->{wbuf}	714	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
313	&& $self->{on_drain};	715	&& $self->{on_drain};
314		716
315	delete $self->{_ww} unless length $self->{wbuf};	717	delete $self->{_ww} unless length $self->{wbuf};
316	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	718	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
317	$self->error;	719	$self->_error ($!, 1);
318	}	720	}
319	};	721	};
320		722
321	# try to write data immediately	723	# try to write data immediately
322	$cb->();	724	$cb->() unless $self->{autocork};
323		725
324	# if still data left in wbuf, we need to poll	726	# if still data left in wbuf, we need to poll
325	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	727	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
326	if length $self->{wbuf};	728	if length $self->{wbuf};
327	};	729	};
…		…
341		743
342	@_ = ($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")
343	->($self, @_);	745	->($self, @_);
344	}	746	}
345		747
346	if ($self->{filter_w}) {	748	if ($self->{tls}) {
347	$self->{filter_w}->($self, \$_[0]);	749	$self->{_tls_wbuf} .= $_[0];
		750	&_dotls ($self) if $self->{fh};
348	} else {	751	} else {
349	$self->{wbuf} .= $_[0];	752	$self->{wbuf} .= $_[0];
350	$self->_drain_wbuf;	753	$self->_drain_wbuf if $self->{fh};
351	}	754	}
352	}	755	}
353		756
354	=item $handle->push_write (type => @args)	757	=item $handle->push_write (type => @args)
355
356	=item $handle->unshift_write (type => @args)
357		758
358	Instead of formatting your data yourself, you can also let this module do	759	Instead of formatting your data yourself, you can also let this module do
359	the job by specifying a type and type-specific arguments.	760	the job by specifying a type and type-specific arguments.
360		761
361	Predefined types are (if you have ideas for additional types, feel free to	762	Predefined types are (if you have ideas for additional types, feel free to
…		…
366	=item netstring => $string	767	=item netstring => $string
367		768
368	Formats the given value as netstring	769	Formats the given value as netstring
369	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	770	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
370		771
371	=back
372
373	=cut	772	=cut
374		773
375	register_write_type netstring => sub {	774	register_write_type netstring => sub {
376	my ($self, $string) = @_;	775	my ($self, $string) = @_;
377		776
378	sprintf "%d:%s,", (length $string), $string	777	(length $string) . ":$string,"
379	};	778	};
380		779
		780	=item packstring => $format, $data
		781
		782	An octet string prefixed with an encoded length. The encoding C<$format>
		783	uses the same format as a Perl C<pack> format, but must specify a single
		784	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		785	optional C<!>, C<< < >> or C<< > >> modifier).
		786
		787	=cut
		788
		789	register_write_type packstring => sub {
		790	my ($self, $format, $string) = @_;
		791
		792	pack "$format/a*", $string
		793	};
		794
		795	=item json => $array_or_hashref
		796
		797	Encodes the given hash or array reference into a JSON object. Unless you
		798	provide your own JSON object, this means it will be encoded to JSON text
		799	in UTF-8.
		800
		801	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		802	one end of a handle and read them at the other end without using any
		803	additional framing.
		804
		805	The generated JSON text is guaranteed not to contain any newlines: While
		806	this module doesn't need delimiters after or between JSON texts to be
		807	able to read them, many other languages depend on that.
		808
		809	A simple RPC protocol that interoperates easily with others is to send
		810	JSON arrays (or objects, although arrays are usually the better choice as
		811	they mimic how function argument passing works) and a newline after each
		812	JSON text:
		813
		814	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		815	$handle->push_write ("\012");
		816
		817	An AnyEvent::Handle receiver would simply use the C<json> read type and
		818	rely on the fact that the newline will be skipped as leading whitespace:
		819
		820	$handle->push_read (json => sub { my $array = $_[1]; ... });
		821
		822	Other languages could read single lines terminated by a newline and pass
		823	this line into their JSON decoder of choice.
		824
		825	=cut
		826
		827	register_write_type json => sub {
		828	my ($self, $ref) = @_;
		829
		830	require JSON;
		831
		832	$self->{json} ? $self->{json}->encode ($ref)
		833	: JSON::encode_json ($ref)
		834	};
		835
		836	=item storable => $reference
		837
		838	Freezes the given reference using L<Storable> and writes it to the
		839	handle. Uses the C<nfreeze> format.
		840
		841	=cut
		842
		843	register_write_type storable => sub {
		844	my ($self, $ref) = @_;
		845
		846	require Storable;
		847
		848	pack "w/a*", Storable::nfreeze ($ref)
		849	};
		850
		851	=back
		852
		853	=item $handle->push_shutdown
		854
		855	Sometimes you know you want to close the socket after writing your data
		856	before it was actually written. One way to do that is to replace your
		857	C<on_drain> handler by a callback that shuts down the socket (and set
		858	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		859	replaces the C<on_drain> callback with:
		860
		861	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		862
		863	This simply shuts down the write side and signals an EOF condition to the
		864	the peer.
		865
		866	You can rely on the normal read queue and C<on_eof> handling
		867	afterwards. This is the cleanest way to close a connection.
		868
		869	=cut
		870
		871	sub push_shutdown {
		872	my ($self) = @_;
		873
		874	delete $self->{low_water_mark};
		875	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		876	}
		877
381	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	878	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
382		879
383	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>.
384	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
385	reference with the handle object and the remaining arguments.	882	reference with the handle object and the remaining arguments.
386		883
…		…
405	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
406	a queue.	903	a queue.
407		904
408	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
409	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
410	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
411	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).
412		910
413	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
414	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
415	data arrives and removes it when it has done its job (see C<push_read>,	913	data arrives (also the first time it is queued) and removes it when it has
416	below).	914	done its job (see C<push_read>, below).
417		915
418	This way you can, for example, push three line-reads, followed by reading	916	This way you can, for example, push three line-reads, followed by reading
419	a chunk of data, and AnyEvent::Handle will execute them in order.	917	a chunk of data, and AnyEvent::Handle will execute them in order.
420		918
421	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	919	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
422	the specified number of bytes which give an XML datagram.	920	the specified number of bytes which give an XML datagram.
423		921
424	# in the default state, expect some header bytes	922	# in the default state, expect some header bytes
425	$handle->on_read (sub {	923	$handle->on_read (sub {
426	# some data is here, now queue the length-header-read (4 octets)	924	# some data is here, now queue the length-header-read (4 octets)
427	shift->unshift_read_chunk (4, sub {	925	shift->unshift_read (chunk => 4, sub {
428	# header arrived, decode	926	# header arrived, decode
429	my $len = unpack "N", $_[1];	927	my $len = unpack "N", $_[1];
430		928
431	# now read the payload	929	# now read the payload
432	shift->unshift_read_chunk ($len, sub {	930	shift->unshift_read (chunk => $len, sub {
433	my $xml = $_[1];	931	my $xml = $_[1];
434	# handle xml	932	# handle xml
435	});	933	});
436	});	934	});
437	});	935	});
438		936
439	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"
440	"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
441	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
442	pipeline sending both requests and manipulate the queue as necessary in	940	just pipeline sending both requests and manipulate the queue as necessary
443	the callbacks:	941	in the callbacks.
444		942
445	# 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"
446	$handle->push_write ("request 1\015\012");	948	$handle->push_write ("request 1\015\012");
447		949
448	# 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
449	$handle->push_read_line (sub {	951	$handle->push_read (line => sub {
450	# if we got an "OK", we have to _prepend_ another line,	952	# if we got an "OK", we have to _prepend_ another line,
451	# so it will be read before the second request reads its 64 bytes	953	# so it will be read before the second request reads its 64 bytes
452	# which are already in the queue when this callback is called	954	# which are already in the queue when this callback is called
453	# we don't do this in case we got an error	955	# we don't do this in case we got an error
454	if ($_[1] eq "OK") {	956	if ($_[1] eq "OK") {
455	$_[0]->unshift_read_line (sub {	957	$_[0]->unshift_read (line => sub {
456	my $response = $_[1];	958	my $response = $_[1];
457	...	959	...
458	});	960	});
459	}	961	}
460	});	962	});
461		963
462	# request two	964	# request two, simply returns 64 octets
463	$handle->push_write ("request 2\015\012");	965	$handle->push_write ("request 2\015\012");
464		966
465	# simply read 64 bytes, always	967	# simply read 64 bytes, always
466	$handle->push_read_chunk (64, sub {	968	$handle->push_read (chunk => 64, sub {
467	my $response = $_[1];	969	my $response = $_[1];
468	...	970	...
469	});	971	});
470		972
471	=over 4	973	=over 4
472		974
473	=cut	975	=cut
474		976
475	sub _drain_rbuf {	977	sub _drain_rbuf {
476	my ($self) = @_;	978	my ($self) = @_;
		979
		980	# avoid recursion
		981	return if exists $self->{_skip_drain_rbuf};
		982	local $self->{_skip_drain_rbuf} = 1;
477		983
478	if (	984	if (
479	defined $self->{rbuf_max}	985	defined $self->{rbuf_max}
480	&& $self->{rbuf_max} < length $self->{rbuf}	986	&& $self->{rbuf_max} < length $self->{rbuf}
481	) {	987	) {
482	$! = &Errno::ENOSPC;	988	$self->_error (Errno::ENOSPC, 1), return;
483	$self->error;
484	}	989	}
485		990
486	return if $self->{in_drain};	991	while () {
487	local $self->{in_drain} = 1;	992	# we need to use a separate tls read buffer, as we must not receive data while
		993	# we are draining the buffer, and this can only happen with TLS.
		994	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
488		995
489	while (my $len = length $self->{rbuf}) {	996	my $len = length $self->{rbuf};
490	no strict 'refs';	997
491	if (my $cb = shift @{ $self->{_queue} }) {	998	if (my $cb = shift @{ $self->{_queue} }) {
492	unless ($cb->($self)) {	999	unless ($cb->($self)) {
493	if ($self->{_eof}) {	1000	if ($self->{_eof}) {
494	# 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)
495	$! = &Errno::EPIPE;	1002	$self->_error (Errno::EPIPE, 1), return;
496	$self->error;
497	}	1003	}
498		1004
499	unshift @{ $self->{_queue} }, $cb;	1005	unshift @{ $self->{_queue} }, $cb;
500	return;	1006	last;
501	}	1007	}
502	} elsif ($self->{on_read}) {	1008	} elsif ($self->{on_read}) {
		1009	last unless $len;
		1010
503	$self->{on_read}($self);	1011	$self->{on_read}($self);
504		1012
505	if (	1013	if (
506	$self->{_eof} # if no further data will arrive
507	&& $len == length $self->{rbuf} # and no data has been consumed	1014	$len == length $self->{rbuf} # if no data has been consumed
508	&& !@{ $self->{_queue} } # and the queue is still empty	1015	&& !@{ $self->{_queue} } # and the queue is still empty
509	&& $self->{on_read} # and we still want to read data	1016	&& $self->{on_read} # but we still have on_read
510	) {	1017	) {
		1018	# no further data will arrive
511	# then no progress can be made	1019	# so no progress can be made
512	$! = &Errno::EPIPE;	1020	$self->_error (Errno::EPIPE, 1), return
513	$self->error;	1021	if $self->{_eof};
		1022
		1023	last; # more data might arrive
514	}	1024	}
515	} else {	1025	} else {
516	# read side becomes idle	1026	# read side becomes idle
517	delete $self->{_rw};	1027	delete $self->{_rw} unless $self->{tls};
518	return;	1028	last;
519	}	1029	}
520	}	1030	}
521		1031
522	if ($self->{_eof}) {	1032	if ($self->{_eof}) {
523	$self->_shutdown;	1033	if ($self->{on_eof}) {
524	$self->{on_eof}($self)	1034	$self->{on_eof}($self)
525	if $self->{on_eof};	1035	} else {
		1036	$self->_error (0, 1, "Unexpected end-of-file");
		1037	}
		1038	}
		1039
		1040	# may need to restart read watcher
		1041	unless ($self->{_rw}) {
		1042	$self->start_read
		1043	if $self->{on_read} || @{ $self->{_queue} };
526	}	1044	}
527	}	1045	}
528		1046
529	=item $handle->on_read ($cb)	1047	=item $handle->on_read ($cb)
530		1048
…		…
536		1054
537	sub on_read {	1055	sub on_read {
538	my ($self, $cb) = @_;	1056	my ($self, $cb) = @_;
539		1057
540	$self->{on_read} = $cb;	1058	$self->{on_read} = $cb;
		1059	$self->_drain_rbuf if $cb;
541	}	1060	}
542		1061
543	=item $handle->rbuf	1062	=item $handle->rbuf
544		1063
545	Returns the read buffer (as a modifiable lvalue).	1064	Returns the read buffer (as a modifiable lvalue).
546		1065
547	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} >>
548	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.
549		1071
550	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>,
551	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
552	automatically manage the read buffer.	1074	automatically manage the read buffer.
553		1075
…		…
626	Predefined types are (if you have ideas for additional types, feel free to	1148	Predefined types are (if you have ideas for additional types, feel free to
627	drop by and tell us):	1149	drop by and tell us):
628		1150
629	=over 4	1151	=over 4
630		1152
631	=item chunk => $octets, $cb->($self, $data)	1153	=item chunk => $octets, $cb->($handle, $data)
632		1154
633	Invoke the callback only once C<$octets> bytes have been read. Pass the	1155	Invoke the callback only once C<$octets> bytes have been read. Pass the
634	data read to the callback. The callback will never be called with less	1156	data read to the callback. The callback will never be called with less
635	data.	1157	data.
636		1158
…		…
650	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1172	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
651	1	1173	1
652	}	1174	}
653	};	1175	};
654		1176
655	# compatibility with older API
656	sub push_read_chunk {
657	$_[0]->push_read (chunk => $_[1], $_[2]);
658	}
659
660	sub unshift_read_chunk {
661	$_[0]->unshift_read (chunk => $_[1], $_[2]);
662	}
663
664	=item line => [$eol, ]$cb->($self, $line, $eol)	1177	=item line => [$eol, ]$cb->($handle, $line, $eol)
665		1178
666	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
667	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
668	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
669	the end of line marker as the third argument (C<$eol>).	1182	the end of line marker as the third argument (C<$eol>).
…		…
683	=cut	1196	=cut
684		1197
685	register_read_type line => sub {	1198	register_read_type line => sub {
686	my ($self, $cb, $eol) = @_;	1199	my ($self, $cb, $eol) = @_;
687		1200
688	$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 {
689	$eol = quotemeta $eol unless ref $eol;	1210	$eol = quotemeta $eol unless ref $eol;
690	$eol = qr|^(.*?)($eol)|s;	1211	$eol = qr|^(.*?)($eol)|s;
691		1212
692	sub {	1213	sub {
693	$_[0]{rbuf} =~ s/$eol// or return;	1214	$_[0]{rbuf} =~ s/$eol// or return;
694		1215
695	$cb->($_[0], $1, $2);	1216	$cb->($_[0], $1, $2);
		1217	1
696	1	1218	}
697	}	1219	}
698	};	1220	};
699		1221
700	# compatibility with older API
701	sub push_read_line {
702	my $self = shift;
703	$self->push_read (line => @_);
704	}
705
706	sub unshift_read_line {
707	my $self = shift;
708	$self->unshift_read (line => @_);
709	}
710
711	=item netstring => $cb->($string)
712
713	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
714
715	Throws an error with C<$!> set to EBADMSG on format violations.
716
717	=cut
718
719	register_read_type netstring => sub {
720	my ($self, $cb) = @_;
721
722	sub {
723	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
724	if ($_[0]{rbuf} =~ /[^0-9]/) {
725	$! = &Errno::EBADMSG;
726	$self->error;
727	}
728	return;
729	}
730
731	my $len = $1;
732
733	$self->unshift_read (chunk => $len, sub {
734	my $string = $_[1];
735	$_[0]->unshift_read (chunk => 1, sub {
736	if ($_[1] eq ",") {
737	$cb->($_[0], $string);
738	} else {
739	$! = &Errno::EBADMSG;
740	$self->error;
741	}
742	});
743	});
744
745	1
746	}
747	};
748
749	=item regex => $accept[, $reject[, $skip], $cb->($data)	1222	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
750		1223
751	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
752	everything up to and including the match.	1225	everything up to and including the match.
753		1226
754	Example: read a single line terminated by '\n'.	1227	Example: read a single line terminated by '\n'.
…		…
802	return 1;	1275	return 1;
803	}	1276	}
804		1277
805	# reject	1278	# reject
806	if ($reject && $$rbuf =~ $reject) {	1279	if ($reject && $$rbuf =~ $reject) {
807	$! = &Errno::EBADMSG;	1280	$self->_error (Errno::EBADMSG);
808	$self->error;
809	}	1281	}
810		1282
811	# skip	1283	# skip
812	if ($skip && $$rbuf =~ $skip) {	1284	if ($skip && $$rbuf =~ $skip) {
813	$data .= substr $$rbuf, 0, $+[0], "";	1285	$data .= substr $$rbuf, 0, $+[0], "";
…		…
815		1287
816	()	1288	()
817	}	1289	}
818	};	1290	};
819		1291
		1292	=item netstring => $cb->($handle, $string)
		1293
		1294	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1295
		1296	Throws an error with C<$!> set to EBADMSG on format violations.
		1297
		1298	=cut
		1299
		1300	register_read_type netstring => sub {
		1301	my ($self, $cb) = @_;
		1302
		1303	sub {
		1304	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
		1305	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1306	$self->_error (Errno::EBADMSG);
		1307	}
		1308	return;
		1309	}
		1310
		1311	my $len = $1;
		1312
		1313	$self->unshift_read (chunk => $len, sub {
		1314	my $string = $_[1];
		1315	$_[0]->unshift_read (chunk => 1, sub {
		1316	if ($_[1] eq ",") {
		1317	$cb->($_[0], $string);
		1318	} else {
		1319	$self->_error (Errno::EBADMSG);
		1320	}
		1321	});
		1322	});
		1323
		1324	1
		1325	}
		1326	};
		1327
		1328	=item packstring => $format, $cb->($handle, $string)
		1329
		1330	An octet string prefixed with an encoded length. The encoding C<$format>
		1331	uses the same format as a Perl C<pack> format, but must specify a single
		1332	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1333	optional C<!>, C<< < >> or C<< > >> modifier).
		1334
		1335	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1336	EPP uses a prefix of C<N> (4 octtes).
		1337
		1338	Example: read a block of data prefixed by its length in BER-encoded
		1339	format (very efficient).
		1340
		1341	$handle->push_read (packstring => "w", sub {
		1342	my ($handle, $data) = @_;
		1343	});
		1344
		1345	=cut
		1346
		1347	register_read_type packstring => sub {
		1348	my ($self, $cb, $format) = @_;
		1349
		1350	sub {
		1351	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1352	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1353	or return;
		1354
		1355	$format = length pack $format, $len;
		1356
		1357	# bypass unshift if we already have the remaining chunk
		1358	if ($format + $len <= length $_[0]{rbuf}) {
		1359	my $data = substr $_[0]{rbuf}, $format, $len;
		1360	substr $_[0]{rbuf}, 0, $format + $len, "";
		1361	$cb->($_[0], $data);
		1362	} else {
		1363	# remove prefix
		1364	substr $_[0]{rbuf}, 0, $format, "";
		1365
		1366	# read remaining chunk
		1367	$_[0]->unshift_read (chunk => $len, $cb);
		1368	}
		1369
		1370	1
		1371	}
		1372	};
		1373
		1374	=item json => $cb->($handle, $hash_or_arrayref)
		1375
		1376	Reads a JSON object or array, decodes it and passes it to the
		1377	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
		1378
		1379	If a C<json> object was passed to the constructor, then that will be used
		1380	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1381
		1382	This read type uses the incremental parser available with JSON version
		1383	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1384	dependency on your own: this module will load the JSON module, but
		1385	AnyEvent does not depend on it itself.
		1386
		1387	Since JSON texts are fully self-delimiting, the C<json> read and write
		1388	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1389	the C<json> write type description, above, for an actual example.
		1390
		1391	=cut
		1392
		1393	register_read_type json => sub {
		1394	my ($self, $cb) = @_;
		1395
		1396	my $json = $self->{json} ||=
		1397	eval { require JSON::XS; JSON::XS->new->utf8 }
		1398	|| do { require JSON; JSON->new->utf8 };
		1399
		1400	my $data;
		1401	my $rbuf = \$self->{rbuf};
		1402
		1403	sub {
		1404	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
		1405
		1406	if ($ref) {
		1407	$self->{rbuf} = $json->incr_text;
		1408	$json->incr_text = "";
		1409	$cb->($self, $ref);
		1410
		1411	1
		1412	} elsif ($@) {
		1413	# error case
		1414	$json->incr_skip;
		1415
		1416	$self->{rbuf} = $json->incr_text;
		1417	$json->incr_text = "";
		1418
		1419	$self->_error (Errno::EBADMSG);
		1420
		1421	()
		1422	} else {
		1423	$self->{rbuf} = "";
		1424
		1425	()
		1426	}
		1427	}
		1428	};
		1429
		1430	=item storable => $cb->($handle, $ref)
		1431
		1432	Deserialises a L<Storable> frozen representation as written by the
		1433	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1434	data).
		1435
		1436	Raises C<EBADMSG> error if the data could not be decoded.
		1437
		1438	=cut
		1439
		1440	register_read_type storable => sub {
		1441	my ($self, $cb) = @_;
		1442
		1443	require Storable;
		1444
		1445	sub {
		1446	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1447	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1448	or return;
		1449
		1450	my $format = length pack "w", $len;
		1451
		1452	# bypass unshift if we already have the remaining chunk
		1453	if ($format + $len <= length $_[0]{rbuf}) {
		1454	my $data = substr $_[0]{rbuf}, $format, $len;
		1455	substr $_[0]{rbuf}, 0, $format + $len, "";
		1456	$cb->($_[0], Storable::thaw ($data));
		1457	} else {
		1458	# remove prefix
		1459	substr $_[0]{rbuf}, 0, $format, "";
		1460
		1461	# read remaining chunk
		1462	$_[0]->unshift_read (chunk => $len, sub {
		1463	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1464	$cb->($_[0], $ref);
		1465	} else {
		1466	$self->_error (Errno::EBADMSG);
		1467	}
		1468	});
		1469	}
		1470
		1471	1
		1472	}
		1473	};
		1474
820	=back	1475	=back
821		1476
822	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1477	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
823		1478
824	This function (not method) lets you add your own types to C<push_read>.	1479	This function (not method) lets you add your own types to C<push_read>.
825		1480
826	Whenever the given C<type> is used, C<push_read> will invoke the code	1481	Whenever the given C<type> is used, C<push_read> will invoke the code
827	reference with the handle object, the callback and the remaining	1482	reference with the handle object, the callback and the remaining
…		…
829		1484
830	The code reference is supposed to return a callback (usually a closure)	1485	The code reference is supposed to return a callback (usually a closure)
831	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1486	that works as a plain read callback (see C<< ->push_read ($cb) >>).
832		1487
833	It should invoke the passed callback when it is done reading (remember to	1488	It should invoke the passed callback when it is done reading (remember to
834	pass C<$self> as first argument as all other callbacks do that).	1489	pass C<$handle> as first argument as all other callbacks do that).
835		1490
836	Note that this is a function, and all types registered this way will be	1491	Note that this is a function, and all types registered this way will be
837	global, so try to use unique names.	1492	global, so try to use unique names.
838		1493
839	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1494	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
842	=item $handle->stop_read	1497	=item $handle->stop_read
843		1498
844	=item $handle->start_read	1499	=item $handle->start_read
845		1500
846	In rare cases you actually do not want to read anything from the	1501	In rare cases you actually do not want to read anything from the
847	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1502	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
848	any queued callbacks will be executed then. To start reading again, call	1503	any queued callbacks will be executed then. To start reading again, call
849	C<start_read>.	1504	C<start_read>.
850		1505
		1506	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1507	you change the C<on_read> callback or push/unshift a read callback, and it
		1508	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1509	there are any read requests in the queue.
		1510
		1511	These methods will have no effect when in TLS mode (as TLS doesn't support
		1512	half-duplex connections).
		1513
851	=cut	1514	=cut
852		1515
853	sub stop_read {	1516	sub stop_read {
854	my ($self) = @_;	1517	my ($self) = @_;
855		1518
856	delete $self->{_rw};	1519	delete $self->{_rw} unless $self->{tls};
857	}	1520	}
858		1521
859	sub start_read {	1522	sub start_read {
860	my ($self) = @_;	1523	my ($self) = @_;
861		1524
862	unless ($self->{_rw} || $self->{_eof}) {	1525	unless ($self->{_rw} || $self->{_eof}) {
863	Scalar::Util::weaken $self;	1526	Scalar::Util::weaken $self;
864		1527
865	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1528	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
866	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1529	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
867	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;
868		1531
869	if ($len > 0) {	1532	if ($len > 0) {
870	$self->{filter_r}	1533	$self->{_activity} = AnyEvent->now;
871	? $self->{filter_r}->($self, $rbuf)	1534
		1535	if ($self->{tls}) {
		1536	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
		1537
		1538	&_dotls ($self);
		1539	} else {
872	: $self->_drain_rbuf;	1540	$self->_drain_rbuf;
		1541	}
873		1542
874	} elsif (defined $len) {	1543	} elsif (defined $len) {
875	delete $self->{_rw};	1544	delete $self->{_rw};
876	$self->{_eof} = 1;	1545	$self->{_eof} = 1;
877	$self->_drain_rbuf;	1546	$self->_drain_rbuf;
878		1547
879	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1548	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
880	return $self->error;	1549	return $self->_error ($!, 1);
881	}	1550	}
882	});	1551	});
883	}	1552	}
884	}	1553	}
885		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.
886	sub _dotls {	1583	sub _dotls {
887	my ($self) = @_;	1584	my ($self) = @_;
888		1585
		1586	my $tmp;
		1587
889	if (length $self->{_tls_wbuf}) {	1588	if (length $self->{_tls_wbuf}) {
890	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1589	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
891	substr $self->{_tls_wbuf}, 0, $len, "";	1590	substr $self->{_tls_wbuf}, 0, $tmp, "";
892	}	1591	}
893	}
894		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
895	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1625	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
896	$self->{wbuf} .= $buf;	1626	$self->{wbuf} .= $tmp;
897	$self->_drain_wbuf;	1627	$self->_drain_wbuf;
898	}	1628	}
899		1629
900	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1630	$self->{_on_starttls}
901	$self->{rbuf} .= $buf;	1631	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
902	$self->_drain_rbuf;	1632	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
903	}
904
905	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
906
907	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
908	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
909	$self->error;
910	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
911	$! = &Errno::EIO;
912	$self->error;
913	}
914
915	# all others are fine for our purposes
916	}
917	}	1633	}
918		1634
919	=item $handle->starttls ($tls[, $tls_ctx])	1635	=item $handle->starttls ($tls[, $tls_ctx])
920		1636
921	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1637	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
922	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
923	C<starttls>.	1639	C<starttls>.
924		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
925	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
926	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1646	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
927		1647
928	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
929	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.
930		1652
931	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
932	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
933	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.
934		1657
935	=cut	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.
936		1661
937	# TODO: maybe document...	1662	=cut
		1663
		1664	our %TLS_CACHE; #TODO not yet documented, should we?
		1665
938	sub starttls {	1666	sub starttls {
939	my ($self, $ssl, $ctx) = @_;	1667	my ($self, $tls, $ctx) = @_;
940		1668
941	$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};
942		1671
943	if ($ssl eq "accept") {	1672	$self->{tls} = $tls;
944	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1673	$self->{tls_ctx} = $ctx if @_ > 2;
945	Net::SSLeay::set_accept_state ($ssl);	1674
946	} elsif ($ssl eq "connect") {	1675	return unless $self->{fh};
947	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1676
948	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	}
949	}	1697
950		1698	$self->{tls_ctx} = $ctx || TLS_CTX ();
951	$self->{tls} = $ssl;	1699	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
952		1700
953	# 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)
954	# but the openssl maintainers basically said: "trust us, it just works".	1702	# but the openssl maintainers basically said: "trust us, it just works".
955	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1703	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
956	# and mismaintained ssleay-module doesn't even offer them).	1704	# and mismaintained ssleay-module doesn't even offer them).
957	# 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.
958	Net::SSLeay::CTX_set_mode ($self->{tls},	1713	# Net::SSLeay::CTX_set_mode ($ssl,
959	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1714	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
960	| (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);
961		1717
962	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1718	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
963	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1719	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
964		1720
965	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1721	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
966		1722
967	$self->{filter_w} = sub {	1723	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
968	$_[0]{_tls_wbuf} .= ${$_[1]};	1724	if $self->{on_starttls};
969	&_dotls;	1725
970	};	1726	&_dotls; # need to trigger the initial handshake
971	$self->{filter_r} = sub {	1727	$self->start_read; # make sure we actually do read
972	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
973	&_dotls;
974	};
975	}	1728	}
976		1729
977	=item $handle->stoptls	1730	=item $handle->stoptls
978		1731
979	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
980	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.
981		1736
982	=cut	1737	=cut
983		1738
984	sub stoptls {	1739	sub stoptls {
985	my ($self) = @_;	1740	my ($self) = @_;
986		1741
987	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1742	if ($self->{tls}) {
		1743	Net::SSLeay::shutdown ($self->{tls});
988		1744
989	delete $self->{_rbio};	1745	&_dotls;
990	delete $self->{_wbio};	1746
991	delete $self->{_tls_wbuf};	1747	# # we don't give a shit. no, we do, but we can't. no...#d#
992	delete $self->{filter_r};	1748	# # we, we... have to use openssl :/#d#
993	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)};
994	}	1762	}
995		1763
996	sub DESTROY {	1764	sub DESTROY {
997	my $self = shift;	1765	my ($self) = @_;
998		1766
999	$self->stoptls;	1767	&_freetls;
		1768
		1769	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1770
		1771	if ($linger && length $self->{wbuf} && $self->{fh}) {
		1772	my $fh = delete $self->{fh};
		1773	my $wbuf = delete $self->{wbuf};
		1774
		1775	my @linger;
		1776
		1777	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1778	my $len = syswrite $fh, $wbuf, length $wbuf;
		1779
		1780	if ($len > 0) {
		1781	substr $wbuf, 0, $len, "";
		1782	} else {
		1783	@linger = (); # end
		1784	}
		1785	});
		1786	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1787	@linger = ();
		1788	});
		1789	}
		1790	}
		1791
		1792	=item $handle->destroy
		1793
		1794	Shuts down the handle object as much as possible - this call ensures that
		1795	no further callbacks will be invoked and as many resources as possible
		1796	will be freed. You must not call any methods on the object afterwards.
		1797
		1798	Normally, you can just "forget" any references to an AnyEvent::Handle
		1799	object and it will simply shut down. This works in fatal error and EOF
		1800	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1801	callback, so when you want to destroy the AnyEvent::Handle object from
		1802	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1803	that case.
		1804
		1805	Destroying the handle object in this way has the advantage that callbacks
		1806	will be removed as well, so if those are the only reference holders (as
		1807	is common), then one doesn't need to do anything special to break any
		1808	reference cycles.
		1809
		1810	The handle might still linger in the background and write out remaining
		1811	data, as specified by the C<linger> option, however.
		1812
		1813	=cut
		1814
		1815	sub destroy {
		1816	my ($self) = @_;
		1817
		1818	$self->DESTROY;
		1819	%$self = ();
1000	}	1820	}
1001		1821
1002	=item AnyEvent::Handle::TLS_CTX	1822	=item AnyEvent::Handle::TLS_CTX
1003		1823
1004	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
1005	default for TLS mode.	1825	for TLS mode.
1006		1826
1007	The context is created like this:	1827	The context is created by calling L<AnyEvent::TLS> without any arguments.
1008
1009	Net::SSLeay::load_error_strings;
1010	Net::SSLeay::SSLeay_add_ssl_algorithms;
1011	Net::SSLeay::randomize;
1012
1013	my $CTX = Net::SSLeay::CTX_new;
1014
1015	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1016		1828
1017	=cut	1829	=cut
1018		1830
1019	our $TLS_CTX;	1831	our $TLS_CTX;
1020		1832
1021	sub TLS_CTX() {	1833	sub TLS_CTX() {
1022	$TLS_CTX || do {	1834	$TLS_CTX ||= do {
1023	require Net::SSLeay;	1835	require AnyEvent::TLS;
1024		1836
1025	Net::SSLeay::load_error_strings ();	1837	new AnyEvent::TLS
1026	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1027	Net::SSLeay::randomize ();
1028
1029	$TLS_CTX = Net::SSLeay::CTX_new ();
1030
1031	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1032
1033	$TLS_CTX
1034	}	1838	}
1035	}	1839	}
1036		1840
1037	=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
1038		2001
1039	=head1 SUBCLASSING AnyEvent::Handle	2002	=head1 SUBCLASSING AnyEvent::Handle
1040		2003
1041	In many cases, you might want to subclass AnyEvent::Handle.	2004	In many cases, you might want to subclass AnyEvent::Handle.
1042		2005
…		…
1046	=over 4	2009	=over 4
1047		2010
1048	=item * all constructor arguments become object members.	2011	=item * all constructor arguments become object members.
1049		2012
1050	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
1051	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
1052	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).
1053		2016
1054	=item * other object member names are prefixed with an C<_>.	2017	=item * other object member names are prefixed with an C<_>.
1055		2018
1056	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