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.22 by root, Sat May 24 15:10:48 2008 UTC vs.
Revision 1.185 by root, Thu Sep 3 19:48:27 2009 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict;
5
6	use AnyEvent ();
7	use AnyEvent::Util ();
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16
17	This module is experimental.
18
19	=cut
20
21	our $VERSION = '0.04';
22		4
23	=head1 SYNOPSIS	5	=head1 SYNOPSIS
24		6
25	use AnyEvent;	7	use AnyEvent;
26	use AnyEvent::Handle;	8	use AnyEvent::Handle;
27		9
28	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
29		11
30	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	12	my $hdl; $hdl = new AnyEvent::Handle
31
32	#TODO
33
34	# or use the constructor to pass the callback:
35
36	my $ae_fh2 =
37	AnyEvent::Handle->new (
38	fh => \*STDIN,	13	fh => \*STDIN,
39	on_eof => sub {	14	on_error => sub {
40	$cv->broadcast;	15	my ($hdl, $fatal, $msg) = @_;
41	},	16	warn "got error $msg\n";
42	#TODO	17	$hdl->destroy;
		18	$cv->send;
43	);	19	);
44		20
45	$cv->wait;	21	# send some request line
		22	$hdl->push_write ("getinfo\015\012");
		23
		24	# read the response line
		25	$hdl->push_read (line => sub {
		26	my ($hdl, $line) = @_;
		27	warn "got line <$line>\n";
		28	$cv->send;
		29	});
		30
		31	$cv->recv;
46		32
47	=head1 DESCRIPTION	33	=head1 DESCRIPTION
48		34
49	This module is a helper module to make it easier to do event-based I/O on	35	This module is a helper module to make it easier to do event-based I/O on
50	filehandles. For utility functions for doing non-blocking connects and accepts	36	filehandles.
51	on sockets see L<AnyEvent::Util>.	37
		38	The L<AnyEvent::Intro> tutorial contains some well-documented
		39	AnyEvent::Handle examples.
52		40
53	In the following, when the documentation refers to of "bytes" then this	41	In the following, when the documentation refers to of "bytes" then this
54	means characters. As sysread and syswrite are used for all I/O, their	42	means characters. As sysread and syswrite are used for all I/O, their
55	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
56		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
57	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
58	argument.	49	argument.
59		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
60	=head1 METHODS	80	=head1 METHODS
61		81
62	=over 4	82	=over 4
63		83
64	=item B<new (%args)>	84	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
65		85
66	The constructor supports these arguments (all as key => value pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
67		87
68	=over 4	88	=over 4
69		89
70	=item fh => $filehandle [MANDATORY]	90	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
71		91
72	The filehandle this L<AnyEvent::Handle> object will operate on.	92	The filehandle this L<AnyEvent::Handle> object will operate on.
73
74	NOTE: The filehandle will be set to non-blocking (using	93	NOTE: The filehandle will be set to non-blocking mode (using
75	AnyEvent::Util::fh_nonblocking).	94	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		95	that mode.
76		96
77	=item on_eof => $cb->($self)	97	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
78		98
79	Set the callback to be called on EOF.	99	Try to connect to the specified host and service (port), using
		100	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		101	default C<peername>.
80		102
81	While not mandatory, it is highly recommended to set an eof callback,	103	You have to specify either this parameter, or C<fh>, above.
82	otherwise you might end up with a closed socket while you are still
83	waiting for data.
84		104
		105	It is possible to push requests on the read and write queues, and modify
		106	properties of the stream, even while AnyEvent::Handle is connecting.
		107
		108	When this parameter is specified, then the C<on_prepare>,
		109	C<on_connect_error> and C<on_connect> callbacks will be called under the
		110	appropriate circumstances:
		111
		112	=over 4
		113
85	=item on_error => $cb->($self)	114	=item on_prepare => $cb->($handle)
86		115
		116	This (rarely used) callback is called before a new connection is
		117	attempted, but after the file handle has been created. It could be used to
		118	prepare the file handle with parameters required for the actual connect
		119	(as opposed to settings that can be changed when the connection is already
		120	established).
		121
		122	The return value of this callback should be the connect timeout value in
		123	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		124	timeout is to be used).
		125
		126	=item on_connect => $cb->($handle, $host, $port, $retry->())
		127
		128	This callback is called when a connection has been successfully established.
		129
		130	The actual numeric host and port (the socket peername) are passed as
		131	parameters, together with a retry callback.
		132
		133	When, for some reason, the handle is not acceptable, then calling
		134	C<$retry> will continue with the next conenction target (in case of
		135	multi-homed hosts or SRV records there can be multiple connection
		136	endpoints). When it is called then the read and write queues, eof status,
		137	tls status and similar properties of the handle are being reset.
		138
		139	In most cases, ignoring the C<$retry> parameter is the way to go.
		140
		141	=item on_connect_error => $cb->($handle, $message)
		142
		143	This callback is called when the conenction could not be
		144	established. C<$!> will contain the relevant error code, and C<$message> a
		145	message describing it (usually the same as C<"$!">).
		146
		147	If this callback isn't specified, then C<on_error> will be called with a
		148	fatal error instead.
		149
		150	=back
		151
		152	=item on_error => $cb->($handle, $fatal, $message)
		153
87	This is the fatal error callback, that is called when, well, a fatal error	154	This is the error callback, which is called when, well, some error
88	occurs, such as not being able to resolve the hostname, failure to connect	155	occured, such as not being able to resolve the hostname, failure to
89	or a read error.	156	connect or a read error.
90		157
91	The object will not be in a usable state when this callback has been	158	Some errors are fatal (which is indicated by C<$fatal> being true). On
92	called.	159	fatal errors the handle object will be destroyed (by a call to C<< ->
		160	destroy >>) after invoking the error callback (which means you are free to
		161	examine the handle object). Examples of fatal errors are an EOF condition
		162	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		163	cases where the other side can close the connection at their will it is
		164	often easiest to not report C<EPIPE> errors in this callback.
		165
		166	AnyEvent::Handle tries to find an appropriate error code for you to check
		167	against, but in some cases (TLS errors), this does not work well. It is
		168	recommended to always output the C<$message> argument in human-readable
		169	error messages (it's usually the same as C<"$!">).
		170
		171	Non-fatal errors can be retried by simply returning, but it is recommended
		172	to simply ignore this parameter and instead abondon the handle object
		173	when this callback is invoked. Examples of non-fatal errors are timeouts
		174	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
93		175
94	On callback entrance, the value of C<$!> contains the operating system	176	On callback entrance, the value of C<$!> contains the operating system
95	error (or C<ENOSPC> or C<EPIPE>).	177	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		178	C<EPROTO>).
96		179
97	While not mandatory, it is I<highly> recommended to set this callback, as	180	While not mandatory, it is I<highly> recommended to set this callback, as
98	you will not be notified of errors otherwise. The default simply calls	181	you will not be notified of errors otherwise. The default simply calls
99	die.	182	C<croak>.
100		183
101	=item on_read => $cb->($self)	184	=item on_read => $cb->($handle)
102		185
103	This sets the default read callback, which is called when data arrives	186	This sets the default read callback, which is called when data arrives
104	and no read request is in the queue.	187	and no read request is in the queue (unlike read queue callbacks, this
		188	callback will only be called when at least one octet of data is in the
		189	read buffer).
105		190
106	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	191	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
107	method or access the C<$self->{rbuf}> member directly.	192	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		193	must not enlarge or modify the read buffer, you can only remove data at
		194	the beginning from it.
108		195
109	When an EOF condition is detected then AnyEvent::Handle will first try to	196	When an EOF condition is detected then AnyEvent::Handle will first try to
110	feed all the remaining data to the queued callbacks and C<on_read> before	197	feed all the remaining data to the queued callbacks and C<on_read> before
111	calling the C<on_eof> callback. If no progress can be made, then a fatal	198	calling the C<on_eof> callback. If no progress can be made, then a fatal
112	error will be raised (with C<$!> set to C<EPIPE>).	199	error will be raised (with C<$!> set to C<EPIPE>).
113		200
		201	Note that, unlike requests in the read queue, an C<on_read> callback
		202	doesn't mean you I<require> some data: if there is an EOF and there
		203	are outstanding read requests then an error will be flagged. With an
		204	C<on_read> callback, the C<on_eof> callback will be invoked.
		205
		206	=item on_eof => $cb->($handle)
		207
		208	Set the callback to be called when an end-of-file condition is detected,
		209	i.e. in the case of a socket, when the other side has closed the
		210	connection cleanly, and there are no outstanding read requests in the
		211	queue (if there are read requests, then an EOF counts as an unexpected
		212	connection close and will be flagged as an error).
		213
		214	For sockets, this just means that the other side has stopped sending data,
		215	you can still try to write data, and, in fact, one can return from the EOF
		216	callback and continue writing data, as only the read part has been shut
		217	down.
		218
		219	If an EOF condition has been detected but no C<on_eof> callback has been
		220	set, then a fatal error will be raised with C<$!> set to <0>.
		221
114	=item on_drain => $cb->()	222	=item on_drain => $cb->($handle)
115		223
116	This sets the callback that is called when the write buffer becomes empty	224	This sets the callback that is called when the write buffer becomes empty
117	(or when the callback is set and the buffer is empty already).	225	(or when the callback is set and the buffer is empty already).
118		226
119	To append to the write buffer, use the C<< ->push_write >> method.	227	To append to the write buffer, use the C<< ->push_write >> method.
120		228
		229	This callback is useful when you don't want to put all of your write data
		230	into the queue at once, for example, when you want to write the contents
		231	of some file to the socket you might not want to read the whole file into
		232	memory and push it into the queue, but instead only read more data from
		233	the file when the write queue becomes empty.
		234
		235	=item timeout => $fractional_seconds
		236
		237	=item rtimeout => $fractional_seconds
		238
		239	=item wtimeout => $fractional_seconds
		240
		241	If non-zero, then these enables an "inactivity" timeout: whenever this
		242	many seconds pass without a successful read or write on the underlying
		243	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
		244	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		245	error will be raised).
		246
		247	There are three variants of the timeouts that work fully independent
		248	of each other, for both read and write, just read, and just write:
		249	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		250	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		251	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
		252
		253	Note that timeout processing is also active when you currently do not have
		254	any outstanding read or write requests: If you plan to keep the connection
		255	idle then you should disable the timout temporarily or ignore the timeout
		256	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		257	restart the timeout.
		258
		259	Zero (the default) disables this timeout.
		260
		261	=item on_timeout => $cb->($handle)
		262
		263	Called whenever the inactivity timeout passes. If you return from this
		264	callback, then the timeout will be reset as if some activity had happened,
		265	so this condition is not fatal in any way.
		266
121	=item rbuf_max => <bytes>	267	=item rbuf_max => <bytes>
122		268
123	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	269	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
124	when the read buffer ever (strictly) exceeds this size. This is useful to	270	when the read buffer ever (strictly) exceeds this size. This is useful to
125	avoid denial-of-service attacks.	271	avoid some forms of denial-of-service attacks.
126		272
127	For example, a server accepting connections from untrusted sources should	273	For example, a server accepting connections from untrusted sources should
128	be configured to accept only so-and-so much data that it cannot act on	274	be configured to accept only so-and-so much data that it cannot act on
129	(for example, when expecting a line, an attacker could send an unlimited	275	(for example, when expecting a line, an attacker could send an unlimited
130	amount of data without a callback ever being called as long as the line	276	amount of data without a callback ever being called as long as the line
131	isn't finished).	277	isn't finished).
132		278
		279	=item autocork => <boolean>
		280
		281	When disabled (the default), then C<push_write> will try to immediately
		282	write the data to the handle, if possible. This avoids having to register
		283	a write watcher and wait for the next event loop iteration, but can
		284	be inefficient if you write multiple small chunks (on the wire, this
		285	disadvantage is usually avoided by your kernel's nagle algorithm, see
		286	C<no_delay>, but this option can save costly syscalls).
		287
		288	When enabled, then writes will always be queued till the next event loop
		289	iteration. This is efficient when you do many small writes per iteration,
		290	but less efficient when you do a single write only per iteration (or when
		291	the write buffer often is full). It also increases write latency.
		292
		293	=item no_delay => <boolean>
		294
		295	When doing small writes on sockets, your operating system kernel might
		296	wait a bit for more data before actually sending it out. This is called
		297	the Nagle algorithm, and usually it is beneficial.
		298
		299	In some situations you want as low a delay as possible, which can be
		300	accomplishd by setting this option to a true value.
		301
		302	The default is your opertaing system's default behaviour (most likely
		303	enabled), this option explicitly enables or disables it, if possible.
		304
		305	=item keepalive => <boolean>
		306
		307	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		308	normally, TCP connections have no time-out once established, so TCP
		309	conenctions, once established, can stay alive forever even when the other
		310	side has long gone. TCP keepalives are a cheap way to take down long-lived
		311	TCP connections whent he other side becomes unreachable. While the default
		312	is OS-dependent, TCP keepalives usually kick in after around two hours,
		313	and, if the other side doesn't reply, take down the TCP connection some 10
		314	to 15 minutes later.
		315
		316	It is harmless to specify this option for file handles that do not support
		317	keepalives, and enabling it on connections that are potentially long-lived
		318	is usually a good idea.
		319
		320	=item oobinline => <boolean>
		321
		322	BSD majorly fucked up the implementation of TCP urgent data. The result
		323	is that almost no OS implements TCP according to the specs, and every OS
		324	implements it slightly differently.
		325
		326	If you want to handle TCP urgent data, then setting this flag (the default
		327	is enabled) gives you the most portable way of getting urgent data, by
		328	putting it into the stream.
		329
		330	Since BSD emulation of OOB data on top of TCP's urgent data can have
		331	security implications, AnyEvent::Handle sets this flag automatically
		332	unless explicitly specified. Note that setting this flag after
		333	establishing a connection I<may> be a bit too late (data loss could
		334	already have occured on BSD systems), but at least it will protect you
		335	from most attacks.
		336
133	=item read_size => <bytes>	337	=item read_size => <bytes>
134		338
135	The default read block size (the amount of bytes this module will try to read	339	The default read block size (the amount of bytes this module will
136	on each [loop iteration). Default: C<4096>.	340	try to read during each loop iteration, which affects memory
		341	requirements). Default: C<8192>.
137		342
138	=item low_water_mark => <bytes>	343	=item low_water_mark => <bytes>
139		344
140	Sets the amount of bytes (default: C<0>) that make up an "empty" write	345	Sets the amount of bytes (default: C<0>) that make up an "empty" write
141	buffer: If the write reaches this size or gets even samller it is	346	buffer: If the write reaches this size or gets even samller it is
142	considered empty.	347	considered empty.
143		348
		349	Sometimes it can be beneficial (for performance reasons) to add data to
		350	the write buffer before it is fully drained, but this is a rare case, as
		351	the operating system kernel usually buffers data as well, so the default
		352	is good in almost all cases.
		353
		354	=item linger => <seconds>
		355
		356	If non-zero (default: C<3600>), then the destructor of the
		357	AnyEvent::Handle object will check whether there is still outstanding
		358	write data and will install a watcher that will write this data to the
		359	socket. No errors will be reported (this mostly matches how the operating
		360	system treats outstanding data at socket close time).
		361
		362	This will not work for partial TLS data that could not be encoded
		363	yet. This data will be lost. Calling the C<stoptls> method in time might
		364	help.
		365
		366	=item peername => $string
		367
		368	A string used to identify the remote site - usually the DNS hostname
		369	(I<not> IDN!) used to create the connection, rarely the IP address.
		370
		371	Apart from being useful in error messages, this string is also used in TLS
		372	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		373	verification will be skipped when C<peername> is not specified or
		374	C<undef>.
		375
144	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	376	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
145		377
146	When this parameter is given, it enables TLS (SSL) mode, that means it	378	When this parameter is given, it enables TLS (SSL) mode, that means
147	will start making tls handshake and will transparently encrypt/decrypt	379	AnyEvent will start a TLS handshake as soon as the conenction has been
148	data.	380	established and will transparently encrypt/decrypt data afterwards.
149		381
150	For the TLS server side, use C<accept>, and for the TLS client side of a	382	All TLS protocol errors will be signalled as C<EPROTO>, with an
151	connection, use C<connect> mode.	383	appropriate error message.
		384
		385	TLS mode requires Net::SSLeay to be installed (it will be loaded
		386	automatically when you try to create a TLS handle): this module doesn't
		387	have a dependency on that module, so if your module requires it, you have
		388	to add the dependency yourself.
		389
		390	Unlike TCP, TLS has a server and client side: for the TLS server side, use
		391	C<accept>, and for the TLS client side of a connection, use C<connect>
		392	mode.
152		393
153	You can also provide your own TLS connection object, but you have	394	You can also provide your own TLS connection object, but you have
154	to make sure that you call either C<Net::SSLeay::set_connect_state>	395	to make sure that you call either C<Net::SSLeay::set_connect_state>
155	or C<Net::SSLeay::set_accept_state> on it before you pass it to	396	or C<Net::SSLeay::set_accept_state> on it before you pass it to
156	AnyEvent::Handle.	397	AnyEvent::Handle. Also, this module will take ownership of this connection
		398	object.
157		399
158	=item tls_ctx => $ssl_ctx	400	At some future point, AnyEvent::Handle might switch to another TLS
		401	implementation, then the option to use your own session object will go
		402	away.
159		403
		404	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		405	passing in the wrong integer will lead to certain crash. This most often
		406	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		407	segmentation fault.
		408
		409	See the C<< ->starttls >> method for when need to start TLS negotiation later.
		410
		411	=item tls_ctx => $anyevent_tls
		412
160	Use the given Net::SSLeay::CTX object to create the new TLS connection	413	Use the given C<AnyEvent::TLS> object to create the new TLS connection
161	(unless a connection object was specified directly). If this parameter is	414	(unless a connection object was specified directly). If this parameter is
162	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	415	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
163		416
		417	Instead of an object, you can also specify a hash reference with C<< key
		418	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		419	new TLS context object.
		420
		421	=item on_starttls => $cb->($handle, $success[, $error_message])
		422
		423	This callback will be invoked when the TLS/SSL handshake has finished. If
		424	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		425	(C<on_stoptls> will not be called in this case).
		426
		427	The session in C<< $handle->{tls} >> can still be examined in this
		428	callback, even when the handshake was not successful.
		429
		430	TLS handshake failures will not cause C<on_error> to be invoked when this
		431	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		432
		433	Without this callback, handshake failures lead to C<on_error> being
		434	called, as normal.
		435
		436	Note that you cannot call C<starttls> right again in this callback. If you
		437	need to do that, start an zero-second timer instead whose callback can
		438	then call C<< ->starttls >> again.
		439
		440	=item on_stoptls => $cb->($handle)
		441
		442	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		443	set, then it will be invoked after freeing the TLS session. If it is not,
		444	then a TLS shutdown condition will be treated like a normal EOF condition
		445	on the handle.
		446
		447	The session in C<< $handle->{tls} >> can still be examined in this
		448	callback.
		449
		450	This callback will only be called on TLS shutdowns, not when the
		451	underlying handle signals EOF.
		452
		453	=item json => JSON or JSON::XS object
		454
		455	This is the json coder object used by the C<json> read and write types.
		456
		457	If you don't supply it, then AnyEvent::Handle will create and use a
		458	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		459	texts.
		460
		461	Note that you are responsible to depend on the JSON module if you want to
		462	use this functionality, as AnyEvent does not have a dependency itself.
		463
164	=back	464	=back
165		465
166	=cut	466	=cut
167		467
168	sub new {	468	sub new {
169	my $class = shift;	469	my $class = shift;
170
171	my $self = bless { @_ }, $class;	470	my $self = bless { @_ }, $class;
172		471
173	$self->{fh} or Carp::croak "mandatory argument fh is missing";	472	if ($self->{fh}) {
		473	$self->_start;
		474	return unless $self->{fh}; # could be gone by now
		475
		476	} elsif ($self->{connect}) {
		477	require AnyEvent::Socket;
		478
		479	$self->{peername} = $self->{connect}[0]
		480	unless exists $self->{peername};
		481
		482	$self->{_skip_drain_rbuf} = 1;
		483
		484	{
		485	Scalar::Util::weaken (my $self = $self);
		486
		487	$self->{_connect} =
		488	AnyEvent::Socket::tcp_connect (
		489	$self->{connect}[0],
		490	$self->{connect}[1],
		491	sub {
		492	my ($fh, $host, $port, $retry) = @_;
		493
		494	if ($fh) {
		495	$self->{fh} = $fh;
		496
		497	delete $self->{_skip_drain_rbuf};
		498	$self->_start;
		499
		500	$self->{on_connect}
		501	and $self->{on_connect}($self, $host, $port, sub {
		502	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		503	$self->{_skip_drain_rbuf} = 1;
		504	&$retry;
		505	});
		506
		507	} else {
		508	if ($self->{on_connect_error}) {
		509	$self->{on_connect_error}($self, "$!");
		510	$self->destroy;
		511	} else {
		512	$self->_error ($!, 1);
		513	}
		514	}
		515	},
		516	sub {
		517	local $self->{fh} = $_[0];
		518
		519	$self->{on_prepare}
		520	? $self->{on_prepare}->($self)
		521	: ()
		522	}
		523	);
		524	}
		525
		526	} else {
		527	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		528	}
		529
		530	$self
		531	}
		532
		533	sub _start {
		534	my ($self) = @_;
174		535
175	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	536	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
176		537
177	if ($self->{tls}) {	538	$self->{_activity} =
178	require Net::SSLeay;	539	$self->{_ractivity} =
		540	$self->{_wactivity} = AE::now;
		541
		542	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		543	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		544	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		545
		546	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		547	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
		548
		549	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		550
179	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	551	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
180	}	552	if $self->{tls};
181		553
182	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};
183	$self->on_error (delete $self->{on_error}) if $self->{on_error};
184	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	554	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
185	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
186		555
187	$self->start_read;	556	$self->start_read
		557	if $self->{on_read} || @{ $self->{_queue} };
188		558
189	$self	559	$self->_drain_wbuf;
190	}	560	}
191		561
192	sub _shutdown {
193	my ($self) = @_;
194
195	delete $self->{rw};
196	delete $self->{ww};
197	delete $self->{fh};
198	}
199
200	sub error {	562	sub _error {
201	my ($self) = @_;	563	my ($self, $errno, $fatal, $message) = @_;
202		564
203	{	565	$! = $errno;
204	local $!;	566	$message ||= "$!";
205	$self->_shutdown;
206	}
207		567
208	if ($self->{on_error}) {	568	if ($self->{on_error}) {
209	$self->{on_error}($self);	569	$self->{on_error}($self, $fatal, $message);
210	} else {	570	$self->destroy if $fatal;
		571	} elsif ($self->{fh}) {
		572	$self->destroy;
211	die "AnyEvent::Handle uncaught fatal error: $!";	573	Carp::croak "AnyEvent::Handle uncaught error: $message";
212	}	574	}
213	}	575	}
214		576
215	=item $fh = $handle->fh	577	=item $fh = $handle->fh
216		578
217	This method returns the file handle of the L<AnyEvent::Handle> object.	579	This method returns the file handle used to create the L<AnyEvent::Handle> object.
218		580
219	=cut	581	=cut
220		582
221	sub fh { $_[0]->{fh} }	583	sub fh { $_[0]{fh} }
222		584
223	=item $handle->on_error ($cb)	585	=item $handle->on_error ($cb)
224		586
225	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	587	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
226		588
…		…
238		600
239	sub on_eof {	601	sub on_eof {
240	$_[0]{on_eof} = $_[1];	602	$_[0]{on_eof} = $_[1];
241	}	603	}
242		604
		605	=item $handle->on_timeout ($cb)
		606
		607	=item $handle->on_rtimeout ($cb)
		608
		609	=item $handle->on_wtimeout ($cb)
		610
		611	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
		612	callback, or disables the callback (but not the timeout) if C<$cb> =
		613	C<undef>. See the C<timeout> constructor argument and method.
		614
		615	=cut
		616
		617	# see below
		618
		619	=item $handle->autocork ($boolean)
		620
		621	Enables or disables the current autocork behaviour (see C<autocork>
		622	constructor argument). Changes will only take effect on the next write.
		623
		624	=cut
		625
		626	sub autocork {
		627	$_[0]{autocork} = $_[1];
		628	}
		629
		630	=item $handle->no_delay ($boolean)
		631
		632	Enables or disables the C<no_delay> setting (see constructor argument of
		633	the same name for details).
		634
		635	=cut
		636
		637	sub no_delay {
		638	$_[0]{no_delay} = $_[1];
		639
		640	eval {
		641	local $SIG{__DIE__};
		642	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		643	if $_[0]{fh};
		644	};
		645	}
		646
		647	=item $handle->keepalive ($boolean)
		648
		649	Enables or disables the C<keepalive> setting (see constructor argument of
		650	the same name for details).
		651
		652	=cut
		653
		654	sub keepalive {
		655	$_[0]{keepalive} = $_[1];
		656
		657	eval {
		658	local $SIG{__DIE__};
		659	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		660	if $_[0]{fh};
		661	};
		662	}
		663
		664	=item $handle->oobinline ($boolean)
		665
		666	Enables or disables the C<oobinline> setting (see constructor argument of
		667	the same name for details).
		668
		669	=cut
		670
		671	sub oobinline {
		672	$_[0]{oobinline} = $_[1];
		673
		674	eval {
		675	local $SIG{__DIE__};
		676	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		677	if $_[0]{fh};
		678	};
		679	}
		680
		681	=item $handle->keepalive ($boolean)
		682
		683	Enables or disables the C<keepalive> setting (see constructor argument of
		684	the same name for details).
		685
		686	=cut
		687
		688	sub keepalive {
		689	$_[0]{keepalive} = $_[1];
		690
		691	eval {
		692	local $SIG{__DIE__};
		693	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		694	if $_[0]{fh};
		695	};
		696	}
		697
		698	=item $handle->on_starttls ($cb)
		699
		700	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		701
		702	=cut
		703
		704	sub on_starttls {
		705	$_[0]{on_starttls} = $_[1];
		706	}
		707
		708	=item $handle->on_stoptls ($cb)
		709
		710	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		711
		712	=cut
		713
		714	sub on_starttls {
		715	$_[0]{on_stoptls} = $_[1];
		716	}
		717
		718	=item $handle->rbuf_max ($max_octets)
		719
		720	Configures the C<rbuf_max> setting (C<undef> disables it).
		721
		722	=cut
		723
		724	sub rbuf_max {
		725	$_[0]{rbuf_max} = $_[1];
		726	}
		727
		728	#############################################################################
		729
		730	=item $handle->timeout ($seconds)
		731
		732	=item $handle->rtimeout ($seconds)
		733
		734	=item $handle->wtimeout ($seconds)
		735
		736	Configures (or disables) the inactivity timeout.
		737
		738	=item $handle->timeout_reset
		739
		740	=item $handle->rtimeout_reset
		741
		742	=item $handle->wtimeout_reset
		743
		744	Reset the activity timeout, as if data was received or sent.
		745
		746	These methods are cheap to call.
		747
		748	=cut
		749
		750	for my $dir ("", "r", "w") {
		751	my $timeout = "${dir}timeout";
		752	my $tw = "_${dir}tw";
		753	my $on_timeout = "on_${dir}timeout";
		754	my $activity = "_${dir}activity";
		755	my $cb;
		756
		757	*$on_timeout = sub {
		758	$_[0]{$on_timeout} = $_[1];
		759	};
		760
		761	*$timeout = sub {
		762	my ($self, $new_value) = @_;
		763
		764	$self->{$timeout} = $new_value;
		765	delete $self->{$tw}; &$cb;
		766	};
		767
		768	*{"${dir}timeout_reset"} = sub {
		769	$_[0]{$activity} = AE::now;
		770	};
		771
		772	# main workhorse:
		773	# reset the timeout watcher, as neccessary
		774	# also check for time-outs
		775	$cb = sub {
		776	my ($self) = @_;
		777
		778	if ($self->{$timeout} && $self->{fh}) {
		779	my $NOW = AE::now;
		780
		781	# when would the timeout trigger?
		782	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
		783
		784	# now or in the past already?
		785	if ($after <= 0) {
		786	$self->{$activity} = $NOW;
		787
		788	if ($self->{$on_timeout}) {
		789	$self->{$on_timeout}($self);
		790	} else {
		791	$self->_error (Errno::ETIMEDOUT);
		792	}
		793
		794	# callback could have changed timeout value, optimise
		795	return unless $self->{$timeout};
		796
		797	# calculate new after
		798	$after = $self->{$timeout};
		799	}
		800
		801	Scalar::Util::weaken $self;
		802	return unless $self; # ->error could have destroyed $self
		803
		804	$self->{$tw} ||= AE::timer $after, 0, sub {
		805	delete $self->{$tw};
		806	$cb->($self);
		807	};
		808	} else {
		809	delete $self->{$tw};
		810	}
		811	}
		812	}
		813
243	#############################################################################	814	#############################################################################
244		815
245	=back	816	=back
246		817
247	=head2 WRITE QUEUE	818	=head2 WRITE QUEUE
…		…
268	my ($self, $cb) = @_;	839	my ($self, $cb) = @_;
269		840
270	$self->{on_drain} = $cb;	841	$self->{on_drain} = $cb;
271		842
272	$cb->($self)	843	$cb->($self)
273	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	844	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
274	}	845	}
275		846
276	=item $handle->push_write ($data)	847	=item $handle->push_write ($data)
277		848
278	Queues the given scalar to be written. You can push as much data as you	849	Queues the given scalar to be written. You can push as much data as you
…		…
282	=cut	853	=cut
283		854
284	sub _drain_wbuf {	855	sub _drain_wbuf {
285	my ($self) = @_;	856	my ($self) = @_;
286		857
287	unless ($self->{ww}) {	858	if (!$self->{_ww} && length $self->{wbuf}) {
		859
288	Scalar::Util::weaken $self;	860	Scalar::Util::weaken $self;
		861
289	my $cb = sub {	862	my $cb = sub {
290	my $len = syswrite $self->{fh}, $self->{wbuf};	863	my $len = syswrite $self->{fh}, $self->{wbuf};
291		864
292	if ($len > 0) {	865	if (defined $len) {
293	substr $self->{wbuf}, 0, $len, "";	866	substr $self->{wbuf}, 0, $len, "";
294		867
		868	$self->{_activity} = $self->{_wactivity} = AE::now;
		869
295	$self->{on_drain}($self)	870	$self->{on_drain}($self)
296	if $self->{low_water_mark} >= length $self->{wbuf}	871	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
297	&& $self->{on_drain};	872	&& $self->{on_drain};
298		873
299	delete $self->{ww} unless length $self->{wbuf};	874	delete $self->{_ww} unless length $self->{wbuf};
300	} elsif ($! != EAGAIN && $! != EINTR) {	875	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
301	$self->error;	876	$self->_error ($!, 1);
302	}	877	}
303	};	878	};
304		879
305	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	880	# try to write data immediately
		881	$cb->() unless $self->{autocork};
306		882
307	$cb->($self);	883	# if still data left in wbuf, we need to poll
		884	$self->{_ww} = AE::io $self->{fh}, 1, $cb
		885	if length $self->{wbuf};
308	};	886	};
		887	}
		888
		889	our %WH;
		890
		891	# deprecated
		892	sub register_write_type($$) {
		893	$WH{$_[0]} = $_[1];
309	}	894	}
310		895
311	sub push_write {	896	sub push_write {
312	my $self = shift;	897	my $self = shift;
313		898
		899	if (@_ > 1) {
		900	my $type = shift;
		901
		902	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
		903	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
		904	->($self, @_);
		905	}
		906
314	if ($self->{filter_w}) {	907	if ($self->{tls}) {
315	$self->{filter_w}->($self, \$_[0]);	908	$self->{_tls_wbuf} .= $_[0];
		909	&_dotls ($self) if $self->{fh};
316	} else {	910	} else {
317	$self->{wbuf} .= $_[0];	911	$self->{wbuf} .= $_[0];
318	$self->_drain_wbuf;	912	$self->_drain_wbuf if $self->{fh};
319	}	913	}
320	}	914	}
		915
		916	=item $handle->push_write (type => @args)
		917
		918	Instead of formatting your data yourself, you can also let this module
		919	do the job by specifying a type and type-specific arguments. You
		920	can also specify the (fully qualified) name of a package, in which
		921	case AnyEvent tries to load the package and then expects to find the
		922	C<anyevent_read_type> function inside (see "custom write types", below).
		923
		924	Predefined types are (if you have ideas for additional types, feel free to
		925	drop by and tell us):
		926
		927	=over 4
		928
		929	=item netstring => $string
		930
		931	Formats the given value as netstring
		932	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		933
		934	=cut
		935
		936	register_write_type netstring => sub {
		937	my ($self, $string) = @_;
		938
		939	(length $string) . ":$string,"
		940	};
		941
		942	=item packstring => $format, $data
		943
		944	An octet string prefixed with an encoded length. The encoding C<$format>
		945	uses the same format as a Perl C<pack> format, but must specify a single
		946	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		947	optional C<!>, C<< < >> or C<< > >> modifier).
		948
		949	=cut
		950
		951	register_write_type packstring => sub {
		952	my ($self, $format, $string) = @_;
		953
		954	pack "$format/a*", $string
		955	};
		956
		957	=item json => $array_or_hashref
		958
		959	Encodes the given hash or array reference into a JSON object. Unless you
		960	provide your own JSON object, this means it will be encoded to JSON text
		961	in UTF-8.
		962
		963	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		964	one end of a handle and read them at the other end without using any
		965	additional framing.
		966
		967	The generated JSON text is guaranteed not to contain any newlines: While
		968	this module doesn't need delimiters after or between JSON texts to be
		969	able to read them, many other languages depend on that.
		970
		971	A simple RPC protocol that interoperates easily with others is to send
		972	JSON arrays (or objects, although arrays are usually the better choice as
		973	they mimic how function argument passing works) and a newline after each
		974	JSON text:
		975
		976	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		977	$handle->push_write ("\012");
		978
		979	An AnyEvent::Handle receiver would simply use the C<json> read type and
		980	rely on the fact that the newline will be skipped as leading whitespace:
		981
		982	$handle->push_read (json => sub { my $array = $_[1]; ... });
		983
		984	Other languages could read single lines terminated by a newline and pass
		985	this line into their JSON decoder of choice.
		986
		987	=cut
		988
		989	sub json_coder() {
		990	eval { require JSON::XS; JSON::XS->new->utf8 }
		991	|| do { require JSON; JSON->new->utf8 }
		992	}
		993
		994	register_write_type json => sub {
		995	my ($self, $ref) = @_;
		996
		997	my $json = $self->{json} ||= json_coder;
		998
		999	$json->encode ($ref)
		1000	};
		1001
		1002	=item storable => $reference
		1003
		1004	Freezes the given reference using L<Storable> and writes it to the
		1005	handle. Uses the C<nfreeze> format.
		1006
		1007	=cut
		1008
		1009	register_write_type storable => sub {
		1010	my ($self, $ref) = @_;
		1011
		1012	require Storable;
		1013
		1014	pack "w/a*", Storable::nfreeze ($ref)
		1015	};
		1016
		1017	=back
		1018
		1019	=item $handle->push_shutdown
		1020
		1021	Sometimes you know you want to close the socket after writing your data
		1022	before it was actually written. One way to do that is to replace your
		1023	C<on_drain> handler by a callback that shuts down the socket (and set
		1024	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1025	replaces the C<on_drain> callback with:
		1026
		1027	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		1028
		1029	This simply shuts down the write side and signals an EOF condition to the
		1030	the peer.
		1031
		1032	You can rely on the normal read queue and C<on_eof> handling
		1033	afterwards. This is the cleanest way to close a connection.
		1034
		1035	=cut
		1036
		1037	sub push_shutdown {
		1038	my ($self) = @_;
		1039
		1040	delete $self->{low_water_mark};
		1041	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1042	}
		1043
		1044	=item custom write types - Package::anyevent_write_type $handle, @args
		1045
		1046	Instead of one of the predefined types, you can also specify the name of
		1047	a package. AnyEvent will try to load the package and then expects to find
		1048	a function named C<anyevent_write_type> inside. If it isn't found, it
		1049	progressively tries to load the parent package until it either finds the
		1050	function (good) or runs out of packages (bad).
		1051
		1052	Whenever the given C<type> is used, C<push_write> will the function with
		1053	the handle object and the remaining arguments.
		1054
		1055	The function is supposed to return a single octet string that will be
		1056	appended to the write buffer, so you cna mentally treat this function as a
		1057	"arguments to on-the-wire-format" converter.
		1058
		1059	Example: implement a custom write type C<join> that joins the remaining
		1060	arguments using the first one.
		1061
		1062	$handle->push_write (My::Type => " ", 1,2,3);
		1063
		1064	# uses the following package, which can be defined in the "My::Type" or in
		1065	# the "My" modules to be auto-loaded, or just about anywhere when the
		1066	# My::Type::anyevent_write_type is defined before invoking it.
		1067
		1068	package My::Type;
		1069
		1070	sub anyevent_write_type {
		1071	my ($handle, $delim, @args) = @_;
		1072
		1073	join $delim, @args
		1074	}
		1075
		1076	=cut
321		1077
322	#############################################################################	1078	#############################################################################
323		1079
324	=back	1080	=back
325		1081
…		…
332	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1088	ways, the "simple" way, using only C<on_read> and the "complex" way, using
333	a queue.	1089	a queue.
334		1090
335	In the simple case, you just install an C<on_read> callback and whenever	1091	In the simple case, you just install an C<on_read> callback and whenever
336	new data arrives, it will be called. You can then remove some data (if	1092	new data arrives, it will be called. You can then remove some data (if
337	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	1093	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
338	or not.	1094	leave the data there if you want to accumulate more (e.g. when only a
		1095	partial message has been received so far).
339		1096
340	In the more complex case, you want to queue multiple callbacks. In this	1097	In the more complex case, you want to queue multiple callbacks. In this
341	case, AnyEvent::Handle will call the first queued callback each time new	1098	case, AnyEvent::Handle will call the first queued callback each time new
342	data arrives and removes it when it has done its job (see C<push_read>,	1099	data arrives (also the first time it is queued) and removes it when it has
343	below).	1100	done its job (see C<push_read>, below).
344		1101
345	This way you can, for example, push three line-reads, followed by reading	1102	This way you can, for example, push three line-reads, followed by reading
346	a chunk of data, and AnyEvent::Handle will execute them in order.	1103	a chunk of data, and AnyEvent::Handle will execute them in order.
347		1104
348	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	1105	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
349	the specified number of bytes which give an XML datagram.	1106	the specified number of bytes which give an XML datagram.
350		1107
351	# in the default state, expect some header bytes	1108	# in the default state, expect some header bytes
352	$handle->on_read (sub {	1109	$handle->on_read (sub {
353	# some data is here, now queue the length-header-read (4 octets)	1110	# some data is here, now queue the length-header-read (4 octets)
354	shift->unshift_read_chunk (4, sub {	1111	shift->unshift_read (chunk => 4, sub {
355	# header arrived, decode	1112	# header arrived, decode
356	my $len = unpack "N", $_[1];	1113	my $len = unpack "N", $_[1];
357		1114
358	# now read the payload	1115	# now read the payload
359	shift->unshift_read_chunk ($len, sub {	1116	shift->unshift_read (chunk => $len, sub {
360	my $xml = $_[1];	1117	my $xml = $_[1];
361	# handle xml	1118	# handle xml
362	});	1119	});
363	});	1120	});
364	});	1121	});
365		1122
366	Example 2: Implement a client for a protocol that replies either with	1123	Example 2: Implement a client for a protocol that replies either with "OK"
367	"OK" and another line or "ERROR" for one request, and 64 bytes for the	1124	and another line or "ERROR" for the first request that is sent, and 64
368	second request. Due tot he availability of a full queue, we can just	1125	bytes for the second request. Due to the availability of a queue, we can
369	pipeline sending both requests and manipulate the queue as necessary in	1126	just pipeline sending both requests and manipulate the queue as necessary
370	the callbacks:	1127	in the callbacks.
371		1128
372	# request one	1129	When the first callback is called and sees an "OK" response, it will
		1130	C<unshift> another line-read. This line-read will be queued I<before> the
		1131	64-byte chunk callback.
		1132
		1133	# request one, returns either "OK + extra line" or "ERROR"
373	$handle->push_write ("request 1\015\012");	1134	$handle->push_write ("request 1\015\012");
374		1135
375	# we expect "ERROR" or "OK" as response, so push a line read	1136	# we expect "ERROR" or "OK" as response, so push a line read
376	$handle->push_read_line (sub {	1137	$handle->push_read (line => sub {
377	# if we got an "OK", we have to _prepend_ another line,	1138	# if we got an "OK", we have to _prepend_ another line,
378	# so it will be read before the second request reads its 64 bytes	1139	# so it will be read before the second request reads its 64 bytes
379	# which are already in the queue when this callback is called	1140	# which are already in the queue when this callback is called
380	# we don't do this in case we got an error	1141	# we don't do this in case we got an error
381	if ($_[1] eq "OK") {	1142	if ($_[1] eq "OK") {
382	$_[0]->unshift_read_line (sub {	1143	$_[0]->unshift_read (line => sub {
383	my $response = $_[1];	1144	my $response = $_[1];
384	...	1145	...
385	});	1146	});
386	}	1147	}
387	});	1148	});
388		1149
389	# request two	1150	# request two, simply returns 64 octets
390	$handle->push_write ("request 2\015\012");	1151	$handle->push_write ("request 2\015\012");
391		1152
392	# simply read 64 bytes, always	1153	# simply read 64 bytes, always
393	$handle->push_read_chunk (64, sub {	1154	$handle->push_read (chunk => 64, sub {
394	my $response = $_[1];	1155	my $response = $_[1];
395	...	1156	...
396	});	1157	});
397		1158
398	=over 4	1159	=over 4
399		1160
400	=cut	1161	=cut
401		1162
402	sub _drain_rbuf {	1163	sub _drain_rbuf {
403	my ($self) = @_;	1164	my ($self) = @_;
		1165
		1166	# avoid recursion
		1167	return if $self->{_skip_drain_rbuf};
		1168	local $self->{_skip_drain_rbuf} = 1;
		1169
		1170	while () {
		1171	# we need to use a separate tls read buffer, as we must not receive data while
		1172	# we are draining the buffer, and this can only happen with TLS.
		1173	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1174	if exists $self->{_tls_rbuf};
		1175
		1176	my $len = length $self->{rbuf};
		1177
		1178	if (my $cb = shift @{ $self->{_queue} }) {
		1179	unless ($cb->($self)) {
		1180	# no progress can be made
		1181	# (not enough data and no data forthcoming)
		1182	$self->_error (Errno::EPIPE, 1), return
		1183	if $self->{_eof};
		1184
		1185	unshift @{ $self->{_queue} }, $cb;
		1186	last;
		1187	}
		1188	} elsif ($self->{on_read}) {
		1189	last unless $len;
		1190
		1191	$self->{on_read}($self);
		1192
		1193	if (
		1194	$len == length $self->{rbuf} # if no data has been consumed
		1195	&& !@{ $self->{_queue} } # and the queue is still empty
		1196	&& $self->{on_read} # but we still have on_read
		1197	) {
		1198	# no further data will arrive
		1199	# so no progress can be made
		1200	$self->_error (Errno::EPIPE, 1), return
		1201	if $self->{_eof};
		1202
		1203	last; # more data might arrive
		1204	}
		1205	} else {
		1206	# read side becomes idle
		1207	delete $self->{_rw} unless $self->{tls};
		1208	last;
		1209	}
		1210	}
		1211
		1212	if ($self->{_eof}) {
		1213	$self->{on_eof}
		1214	? $self->{on_eof}($self)
		1215	: $self->_error (0, 1, "Unexpected end-of-file");
		1216
		1217	return;
		1218	}
404		1219
405	if (	1220	if (
406	defined $self->{rbuf_max}	1221	defined $self->{rbuf_max}
407	&& $self->{rbuf_max} < length $self->{rbuf}	1222	&& $self->{rbuf_max} < length $self->{rbuf}
408	) {	1223	) {
409	$! = &Errno::ENOSPC; return $self->error;	1224	$self->_error (Errno::ENOSPC, 1), return;
410	}	1225	}
411		1226
412	return if $self->{in_drain};	1227	# may need to restart read watcher
413	local $self->{in_drain} = 1;	1228	unless ($self->{_rw}) {
414		1229	$self->start_read
415	while (my $len = length $self->{rbuf}) {	1230	if $self->{on_read} || @{ $self->{_queue} };
416	no strict 'refs';
417	if (my $cb = shift @{ $self->{queue} }) {
418	if (!$cb->($self)) {
419	if ($self->{eof}) {
420	# no progress can be made (not enough data and no data forthcoming)
421	$! = &Errno::EPIPE; return $self->error;
422	}
423
424	unshift @{ $self->{queue} }, $cb;
425	return;
426	}
427	} elsif ($self->{on_read}) {
428	$self->{on_read}($self);
429
430	if (
431	$self->{eof} # if no further data will arrive
432	&& $len == length $self->{rbuf} # and no data has been consumed
433	&& !@{ $self->{queue} } # and the queue is still empty
434	&& $self->{on_read} # and we still want to read data
435	) {
436	# then no progress can be made
437	$! = &Errno::EPIPE; return $self->error;
438	}
439	} else {
440	# read side becomes idle
441	delete $self->{rw};
442	return;
443	}
444	}
445
446	if ($self->{eof}) {
447	$self->_shutdown;
448	$self->{on_eof}($self)
449	if $self->{on_eof};
450	}	1231	}
451	}	1232	}
452		1233
453	=item $handle->on_read ($cb)	1234	=item $handle->on_read ($cb)
454		1235
…		…
460		1241
461	sub on_read {	1242	sub on_read {
462	my ($self, $cb) = @_;	1243	my ($self, $cb) = @_;
463		1244
464	$self->{on_read} = $cb;	1245	$self->{on_read} = $cb;
		1246	$self->_drain_rbuf if $cb;
465	}	1247	}
466		1248
467	=item $handle->rbuf	1249	=item $handle->rbuf
468		1250
469	Returns the read buffer (as a modifiable lvalue).	1251	Returns the read buffer (as a modifiable lvalue).
470		1252
471	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1253	You can access the read buffer directly as the C<< ->{rbuf} >>
472	you want.	1254	member, if you want. However, the only operation allowed on the
		1255	read buffer (apart from looking at it) is removing data from its
		1256	beginning. Otherwise modifying or appending to it is not allowed and will
		1257	lead to hard-to-track-down bugs.
473		1258
474	NOTE: The read buffer should only be used or modified if the C<on_read>,	1259	NOTE: The read buffer should only be used or modified if the C<on_read>,
475	C<push_read> or C<unshift_read> methods are used. The other read methods	1260	C<push_read> or C<unshift_read> methods are used. The other read methods
476	automatically manage the read buffer.	1261	automatically manage the read buffer.
477		1262
…		…
500	interested in (which can be none at all) and return a true value. After returning	1285	interested in (which can be none at all) and return a true value. After returning
501	true, it will be removed from the queue.	1286	true, it will be removed from the queue.
502		1287
503	=cut	1288	=cut
504		1289
		1290	our %RH;
		1291
		1292	sub register_read_type($$) {
		1293	$RH{$_[0]} = $_[1];
		1294	}
		1295
505	sub push_read {	1296	sub push_read {
506	my ($self, $cb) = @_;	1297	my $self = shift;
		1298	my $cb = pop;
507		1299
		1300	if (@_) {
		1301	my $type = shift;
		1302
		1303	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
		1304	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
		1305	->($self, $cb, @_);
		1306	}
		1307
508	push @{ $self->{queue} }, $cb;	1308	push @{ $self->{_queue} }, $cb;
509	$self->_drain_rbuf;	1309	$self->_drain_rbuf;
510	}	1310	}
511		1311
512	sub unshift_read {	1312	sub unshift_read {
513	my ($self, $cb) = @_;	1313	my $self = shift;
		1314	my $cb = pop;
514		1315
		1316	if (@_) {
		1317	my $type = shift;
		1318
		1319	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		1320	->($self, $cb, @_);
		1321	}
		1322
515	push @{ $self->{queue} }, $cb;	1323	unshift @{ $self->{_queue} }, $cb;
516	$self->_drain_rbuf;	1324	$self->_drain_rbuf;
517	}	1325	}
518		1326
519	=item $handle->push_read_chunk ($len, $cb->($self, $data))	1327	=item $handle->push_read (type => @args, $cb)
520		1328
521	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	1329	=item $handle->unshift_read (type => @args, $cb)
522		1330
523	Append the given callback to the end of the queue (C<push_read_chunk>) or	1331	Instead of providing a callback that parses the data itself you can chose
524	prepend it (C<unshift_read_chunk>).	1332	between a number of predefined parsing formats, for chunks of data, lines
		1333	etc. You can also specify the (fully qualified) name of a package, in
		1334	which case AnyEvent tries to load the package and then expects to find the
		1335	C<anyevent_read_type> function inside (see "custom read types", below).
525		1336
526	The callback will be called only once C<$len> bytes have been read, and	1337	Predefined types are (if you have ideas for additional types, feel free to
527	these C<$len> bytes will be passed to the callback.	1338	drop by and tell us):
528		1339
529	=cut	1340	=over 4
530		1341
531	sub _read_chunk($$) {	1342	=item chunk => $octets, $cb->($handle, $data)
		1343
		1344	Invoke the callback only once C<$octets> bytes have been read. Pass the
		1345	data read to the callback. The callback will never be called with less
		1346	data.
		1347
		1348	Example: read 2 bytes.
		1349
		1350	$handle->push_read (chunk => 2, sub {
		1351	warn "yay ", unpack "H*", $_[1];
		1352	});
		1353
		1354	=cut
		1355
		1356	register_read_type chunk => sub {
532	my ($self, $len, $cb) = @_;	1357	my ($self, $cb, $len) = @_;
533		1358
534	sub {	1359	sub {
535	$len <= length $_[0]{rbuf} or return;	1360	$len <= length $_[0]{rbuf} or return;
536	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1361	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
537	1	1362	1
538	}	1363	}
539	}	1364	};
540		1365
541	sub push_read_chunk {	1366	=item line => [$eol, ]$cb->($handle, $line, $eol)
542	$_[0]->push_read (&_read_chunk);
543	}
544
545
546	sub unshift_read_chunk {
547	$_[0]->unshift_read (&_read_chunk);
548	}
549
550	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))
551
552	=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
553
554	Append the given callback to the end of the queue (C<push_read_line>) or
555	prepend it (C<unshift_read_line>).
556		1367
557	The callback will be called only once a full line (including the end of	1368	The callback will be called only once a full line (including the end of
558	line marker, C<$eol>) has been read. This line (excluding the end of line	1369	line marker, C<$eol>) has been read. This line (excluding the end of line
559	marker) will be passed to the callback as second argument (C<$line>), and	1370	marker) will be passed to the callback as second argument (C<$line>), and
560	the end of line marker as the third argument (C<$eol>).	1371	the end of line marker as the third argument (C<$eol>).
…		…
571	Partial lines at the end of the stream will never be returned, as they are	1382	Partial lines at the end of the stream will never be returned, as they are
572	not marked by the end of line marker.	1383	not marked by the end of line marker.
573		1384
574	=cut	1385	=cut
575		1386
576	sub _read_line($$) {	1387	register_read_type line => sub {
577	my $self = shift;	1388	my ($self, $cb, $eol) = @_;
578	my $cb = pop;
579	my $eol = @_ ? shift : qr|(\015?\012)|;
580	my $pos;
581		1389
		1390	if (@_ < 3) {
		1391	# this is more than twice as fast as the generic code below
		1392	sub {
		1393	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		1394
		1395	$cb->($_[0], $1, $2);
		1396	1
		1397	}
		1398	} else {
582	$eol = quotemeta $eol unless ref $eol;	1399	$eol = quotemeta $eol unless ref $eol;
583	$eol = qr|^(.*?)($eol)|s;	1400	$eol = qr|^(.*?)($eol)|s;
		1401
		1402	sub {
		1403	$_[0]{rbuf} =~ s/$eol// or return;
		1404
		1405	$cb->($_[0], $1, $2);
		1406	1
		1407	}
		1408	}
		1409	};
		1410
		1411	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		1412
		1413	Makes a regex match against the regex object C<$accept> and returns
		1414	everything up to and including the match.
		1415
		1416	Example: read a single line terminated by '\n'.
		1417
		1418	$handle->push_read (regex => qr<\n>, sub { ... });
		1419
		1420	If C<$reject> is given and not undef, then it determines when the data is
		1421	to be rejected: it is matched against the data when the C<$accept> regex
		1422	does not match and generates an C<EBADMSG> error when it matches. This is
		1423	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		1424	receive buffer overflow).
		1425
		1426	Example: expect a single decimal number followed by whitespace, reject
		1427	anything else (not the use of an anchor).
		1428
		1429	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		1430
		1431	If C<$skip> is given and not C<undef>, then it will be matched against
		1432	the receive buffer when neither C<$accept> nor C<$reject> match,
		1433	and everything preceding and including the match will be accepted
		1434	unconditionally. This is useful to skip large amounts of data that you
		1435	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		1436	have to start matching from the beginning. This is purely an optimisation
		1437	and is usually worth only when you expect more than a few kilobytes.
		1438
		1439	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		1440	expect the header to be very large (it isn't in practise, but...), we use
		1441	a skip regex to skip initial portions. The skip regex is tricky in that
		1442	it only accepts something not ending in either \015 or \012, as these are
		1443	required for the accept regex.
		1444
		1445	$handle->push_read (regex =>
		1446	qr<\015\012\015\012>,
		1447	undef, # no reject
		1448	qr<^.*[^\015\012]>,
		1449	sub { ... });
		1450
		1451	=cut
		1452
		1453	register_read_type regex => sub {
		1454	my ($self, $cb, $accept, $reject, $skip) = @_;
		1455
		1456	my $data;
		1457	my $rbuf = \$self->{rbuf};
584		1458
585	sub {	1459	sub {
586	$_[0]{rbuf} =~ s/$eol// or return;	1460	# accept
		1461	if ($$rbuf =~ $accept) {
		1462	$data .= substr $$rbuf, 0, $+[0], "";
		1463	$cb->($self, $data);
		1464	return 1;
		1465	}
		1466
		1467	# reject
		1468	if ($reject && $$rbuf =~ $reject) {
		1469	$self->_error (Errno::EBADMSG);
		1470	}
587		1471
588	$cb->($_[0], $1, $2);	1472	# skip
		1473	if ($skip && $$rbuf =~ $skip) {
		1474	$data .= substr $$rbuf, 0, $+[0], "";
		1475	}
		1476
		1477	()
		1478	}
		1479	};
		1480
		1481	=item netstring => $cb->($handle, $string)
		1482
		1483	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1484
		1485	Throws an error with C<$!> set to EBADMSG on format violations.
		1486
		1487	=cut
		1488
		1489	register_read_type netstring => sub {
		1490	my ($self, $cb) = @_;
		1491
		1492	sub {
		1493	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
		1494	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1495	$self->_error (Errno::EBADMSG);
		1496	}
		1497	return;
		1498	}
		1499
		1500	my $len = $1;
		1501
		1502	$self->unshift_read (chunk => $len, sub {
		1503	my $string = $_[1];
		1504	$_[0]->unshift_read (chunk => 1, sub {
		1505	if ($_[1] eq ",") {
		1506	$cb->($_[0], $string);
		1507	} else {
		1508	$self->_error (Errno::EBADMSG);
		1509	}
		1510	});
		1511	});
		1512
589	1	1513	1
590	}	1514	}
591	}	1515	};
592		1516
593	sub push_read_line {	1517	=item packstring => $format, $cb->($handle, $string)
594	$_[0]->push_read (&_read_line);
595	}
596		1518
597	sub unshift_read_line {	1519	An octet string prefixed with an encoded length. The encoding C<$format>
598	$_[0]->unshift_read (&_read_line);	1520	uses the same format as a Perl C<pack> format, but must specify a single
599	}	1521	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1522	optional C<!>, C<< < >> or C<< > >> modifier).
		1523
		1524	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1525	EPP uses a prefix of C<N> (4 octtes).
		1526
		1527	Example: read a block of data prefixed by its length in BER-encoded
		1528	format (very efficient).
		1529
		1530	$handle->push_read (packstring => "w", sub {
		1531	my ($handle, $data) = @_;
		1532	});
		1533
		1534	=cut
		1535
		1536	register_read_type packstring => sub {
		1537	my ($self, $cb, $format) = @_;
		1538
		1539	sub {
		1540	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1541	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1542	or return;
		1543
		1544	$format = length pack $format, $len;
		1545
		1546	# bypass unshift if we already have the remaining chunk
		1547	if ($format + $len <= length $_[0]{rbuf}) {
		1548	my $data = substr $_[0]{rbuf}, $format, $len;
		1549	substr $_[0]{rbuf}, 0, $format + $len, "";
		1550	$cb->($_[0], $data);
		1551	} else {
		1552	# remove prefix
		1553	substr $_[0]{rbuf}, 0, $format, "";
		1554
		1555	# read remaining chunk
		1556	$_[0]->unshift_read (chunk => $len, $cb);
		1557	}
		1558
		1559	1
		1560	}
		1561	};
		1562
		1563	=item json => $cb->($handle, $hash_or_arrayref)
		1564
		1565	Reads a JSON object or array, decodes it and passes it to the
		1566	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
		1567
		1568	If a C<json> object was passed to the constructor, then that will be used
		1569	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1570
		1571	This read type uses the incremental parser available with JSON version
		1572	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1573	dependency on your own: this module will load the JSON module, but
		1574	AnyEvent does not depend on it itself.
		1575
		1576	Since JSON texts are fully self-delimiting, the C<json> read and write
		1577	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1578	the C<json> write type description, above, for an actual example.
		1579
		1580	=cut
		1581
		1582	register_read_type json => sub {
		1583	my ($self, $cb) = @_;
		1584
		1585	my $json = $self->{json} ||= json_coder;
		1586
		1587	my $data;
		1588	my $rbuf = \$self->{rbuf};
		1589
		1590	sub {
		1591	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
		1592
		1593	if ($ref) {
		1594	$self->{rbuf} = $json->incr_text;
		1595	$json->incr_text = "";
		1596	$cb->($self, $ref);
		1597
		1598	1
		1599	} elsif ($@) {
		1600	# error case
		1601	$json->incr_skip;
		1602
		1603	$self->{rbuf} = $json->incr_text;
		1604	$json->incr_text = "";
		1605
		1606	$self->_error (Errno::EBADMSG);
		1607
		1608	()
		1609	} else {
		1610	$self->{rbuf} = "";
		1611
		1612	()
		1613	}
		1614	}
		1615	};
		1616
		1617	=item storable => $cb->($handle, $ref)
		1618
		1619	Deserialises a L<Storable> frozen representation as written by the
		1620	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1621	data).
		1622
		1623	Raises C<EBADMSG> error if the data could not be decoded.
		1624
		1625	=cut
		1626
		1627	register_read_type storable => sub {
		1628	my ($self, $cb) = @_;
		1629
		1630	require Storable;
		1631
		1632	sub {
		1633	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1634	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1635	or return;
		1636
		1637	my $format = length pack "w", $len;
		1638
		1639	# bypass unshift if we already have the remaining chunk
		1640	if ($format + $len <= length $_[0]{rbuf}) {
		1641	my $data = substr $_[0]{rbuf}, $format, $len;
		1642	substr $_[0]{rbuf}, 0, $format + $len, "";
		1643	$cb->($_[0], Storable::thaw ($data));
		1644	} else {
		1645	# remove prefix
		1646	substr $_[0]{rbuf}, 0, $format, "";
		1647
		1648	# read remaining chunk
		1649	$_[0]->unshift_read (chunk => $len, sub {
		1650	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1651	$cb->($_[0], $ref);
		1652	} else {
		1653	$self->_error (Errno::EBADMSG);
		1654	}
		1655	});
		1656	}
		1657
		1658	1
		1659	}
		1660	};
		1661
		1662	=back
		1663
		1664	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
		1665
		1666	Instead of one of the predefined types, you can also specify the name
		1667	of a package. AnyEvent will try to load the package and then expects to
		1668	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1669	progressively tries to load the parent package until it either finds the
		1670	function (good) or runs out of packages (bad).
		1671
		1672	Whenever this type is used, C<push_read> will invoke the function with the
		1673	handle object, the original callback and the remaining arguments.
		1674
		1675	The function is supposed to return a callback (usually a closure) that
		1676	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1677	mentally treat the function as a "configurable read type to read callback"
		1678	converter.
		1679
		1680	It should invoke the original callback when it is done reading (remember
		1681	to pass C<$handle> as first argument as all other callbacks do that,
		1682	although there is no strict requirement on this).
		1683
		1684	For examples, see the source of this module (F<perldoc -m
		1685	AnyEvent::Handle>, search for C<register_read_type>)).
600		1686
601	=item $handle->stop_read	1687	=item $handle->stop_read
602		1688
603	=item $handle->start_read	1689	=item $handle->start_read
604		1690
605	In rare cases you actually do not want to read anything from the	1691	In rare cases you actually do not want to read anything from the
606	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1692	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
607	any queued callbacks will be executed then. To start reading again, call	1693	any queued callbacks will be executed then. To start reading again, call
608	C<start_read>.	1694	C<start_read>.
609		1695
		1696	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1697	you change the C<on_read> callback or push/unshift a read callback, and it
		1698	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1699	there are any read requests in the queue.
		1700
		1701	These methods will have no effect when in TLS mode (as TLS doesn't support
		1702	half-duplex connections).
		1703
610	=cut	1704	=cut
611		1705
612	sub stop_read {	1706	sub stop_read {
613	my ($self) = @_;	1707	my ($self) = @_;
614		1708
615	delete $self->{rw};	1709	delete $self->{_rw} unless $self->{tls};
616	}	1710	}
617		1711
618	sub start_read {	1712	sub start_read {
619	my ($self) = @_;	1713	my ($self) = @_;
620		1714
621	unless ($self->{rw} || $self->{eof}) {	1715	unless ($self->{_rw} || $self->{_eof}) {
622	Scalar::Util::weaken $self;	1716	Scalar::Util::weaken $self;
623		1717
624	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1718	$self->{_rw} = AE::io $self->{fh}, 0, sub {
625	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1719	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
626	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1720	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
627		1721
628	if ($len > 0) {	1722	if ($len > 0) {
629	$self->{filter_r}	1723	$self->{_activity} = $self->{_ractivity} = AE::now;
630	? $self->{filter_r}->($self, $rbuf)	1724
		1725	if ($self->{tls}) {
		1726	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
		1727
		1728	&_dotls ($self);
		1729	} else {
631	: $self->_drain_rbuf;	1730	$self->_drain_rbuf;
		1731	}
632		1732
633	} elsif (defined $len) {	1733	} elsif (defined $len) {
634	delete $self->{rw};	1734	delete $self->{_rw};
635	$self->{eof} = 1;	1735	$self->{_eof} = 1;
636	$self->_drain_rbuf;	1736	$self->_drain_rbuf;
637		1737
638	} elsif ($! != EAGAIN && $! != EINTR) {	1738	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
639	return $self->error;	1739	return $self->_error ($!, 1);
640	}	1740	}
641	});	1741	};
642	}	1742	}
643	}	1743	}
644		1744
		1745	our $ERROR_SYSCALL;
		1746	our $ERROR_WANT_READ;
		1747
		1748	sub _tls_error {
		1749	my ($self, $err) = @_;
		1750
		1751	return $self->_error ($!, 1)
		1752	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1753
		1754	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1755
		1756	# reduce error string to look less scary
		1757	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1758
		1759	if ($self->{_on_starttls}) {
		1760	(delete $self->{_on_starttls})->($self, undef, $err);
		1761	&_freetls;
		1762	} else {
		1763	&_freetls;
		1764	$self->_error (Errno::EPROTO, 1, $err);
		1765	}
		1766	}
		1767
		1768	# poll the write BIO and send the data if applicable
		1769	# also decode read data if possible
		1770	# this is basiclaly our TLS state machine
		1771	# more efficient implementations are possible with openssl,
		1772	# but not with the buggy and incomplete Net::SSLeay.
645	sub _dotls {	1773	sub _dotls {
646	my ($self) = @_;	1774	my ($self) = @_;
647		1775
		1776	my $tmp;
		1777
648	if (length $self->{tls_wbuf}) {	1778	if (length $self->{_tls_wbuf}) {
649	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1779	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
650	substr $self->{tls_wbuf}, 0, $len, "";	1780	substr $self->{_tls_wbuf}, 0, $tmp, "";
651	}	1781	}
652	}
653		1782
		1783	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1784	return $self->_tls_error ($tmp)
		1785	if $tmp != $ERROR_WANT_READ
		1786	&& ($tmp != $ERROR_SYSCALL || $!);
		1787	}
		1788
654	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1789	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1790	unless (length $tmp) {
		1791	$self->{_on_starttls}
		1792	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1793	&_freetls;
		1794
		1795	if ($self->{on_stoptls}) {
		1796	$self->{on_stoptls}($self);
		1797	return;
		1798	} else {
		1799	# let's treat SSL-eof as we treat normal EOF
		1800	delete $self->{_rw};
		1801	$self->{_eof} = 1;
		1802	}
		1803	}
		1804
		1805	$self->{_tls_rbuf} .= $tmp;
		1806	$self->_drain_rbuf;
		1807	$self->{tls} or return; # tls session might have gone away in callback
		1808	}
		1809
		1810	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1811	return $self->_tls_error ($tmp)
		1812	if $tmp != $ERROR_WANT_READ
		1813	&& ($tmp != $ERROR_SYSCALL || $!);
		1814
		1815	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
655	$self->{wbuf} .= $buf;	1816	$self->{wbuf} .= $tmp;
656	$self->_drain_wbuf;	1817	$self->_drain_wbuf;
657	}	1818	}
658		1819
659	while () {	1820	$self->{_on_starttls}
660	if (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1821	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
661	$self->{rbuf} .= $buf;	1822	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
662	$self->_drain_rbuf;	1823	}
663	} elsif (
664	(my $err = Net::SSLeay::get_error ($self->{tls}, -1))
665	!= Net::SSLeay::ERROR_WANT_READ ()
666	) {
667	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
668	$self->error;
669	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
670	$! = &Errno::EIO;
671	$self->error;
672	}
673		1824
674	last;	1825	=item $handle->starttls ($tls[, $tls_ctx])
675	# all others are fine for our purposes	1826
		1827	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
		1828	object is created, you can also do that at a later time by calling
		1829	C<starttls>.
		1830
		1831	Starting TLS is currently an asynchronous operation - when you push some
		1832	write data and then call C<< ->starttls >> then TLS negotiation will start
		1833	immediately, after which the queued write data is then sent.
		1834
		1835	The first argument is the same as the C<tls> constructor argument (either
		1836	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
		1837
		1838	The second argument is the optional C<AnyEvent::TLS> object that is used
		1839	when AnyEvent::Handle has to create its own TLS connection object, or
		1840	a hash reference with C<< key => value >> pairs that will be used to
		1841	construct a new context.
		1842
		1843	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
		1844	context in C<< $handle->{tls_ctx} >> after this call and can be used or
		1845	changed to your liking. Note that the handshake might have already started
		1846	when this function returns.
		1847
		1848	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		1849	handshakes on the same stream. Best do not attempt to use the stream after
		1850	stopping TLS.
		1851
		1852	=cut
		1853
		1854	our %TLS_CACHE; #TODO not yet documented, should we?
		1855
		1856	sub starttls {
		1857	my ($self, $tls, $ctx) = @_;
		1858
		1859	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1860	if $self->{tls};
		1861
		1862	$self->{tls} = $tls;
		1863	$self->{tls_ctx} = $ctx if @_ > 2;
		1864
		1865	return unless $self->{fh};
		1866
		1867	require Net::SSLeay;
		1868
		1869	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1870	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1871
		1872	$tls = delete $self->{tls};
		1873	$ctx = $self->{tls_ctx};
		1874
		1875	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1876
		1877	if ("HASH" eq ref $ctx) {
		1878	require AnyEvent::TLS;
		1879
		1880	if ($ctx->{cache}) {
		1881	my $key = $ctx+0;
		1882	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
676	} else {	1883	} else {
677	last;	1884	$ctx = new AnyEvent::TLS %$ctx;
678	}	1885	}
679	}	1886	}
680	}
681
682	# TODO: maybe document...
683	sub starttls {
684	my ($self, $ssl, $ctx) = @_;
685
686	if ($ssl eq "accept") {
687	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
688	Net::SSLeay::set_accept_state ($ssl);
689	} elsif ($ssl eq "connect") {
690	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
691	Net::SSLeay::set_connect_state ($ssl);
692	}	1887
693		1888	$self->{tls_ctx} = $ctx || TLS_CTX ();
694	$self->{tls} = $ssl;	1889	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
695		1890
696	# basically, this is deep magic (because SSL_read should have the same issues)	1891	# basically, this is deep magic (because SSL_read should have the same issues)
697	# but the openssl maintainers basically said: "trust us, it just works".	1892	# but the openssl maintainers basically said: "trust us, it just works".
698	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1893	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
699	# and mismaintained ssleay-module doesn't even offer them).	1894	# and mismaintained ssleay-module doesn't even offer them).
		1895	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1896	#
		1897	# in short: this is a mess.
		1898	#
		1899	# note that we do not try to keep the length constant between writes as we are required to do.
		1900	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1901	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1902	# have identity issues in that area.
700	Net::SSLeay::CTX_set_mode ($self->{tls},	1903	# Net::SSLeay::CTX_set_mode ($ssl,
701	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1904	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
702	| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1905	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1906	Net::SSLeay::CTX_set_mode ($tls, 1|2);
703		1907
704	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1908	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
705	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1909	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
706		1910
		1911	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1912
707	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1913	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
708		1914
709	$self->{filter_w} = sub {	1915	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
710	$_[0]{tls_wbuf} .= ${$_[1]};	1916	if $self->{on_starttls};
		1917
		1918	&_dotls; # need to trigger the initial handshake
		1919	$self->start_read; # make sure we actually do read
		1920	}
		1921
		1922	=item $handle->stoptls
		1923
		1924	Shuts down the SSL connection - this makes a proper EOF handshake by
		1925	sending a close notify to the other side, but since OpenSSL doesn't
		1926	support non-blocking shut downs, it is not guarenteed that you can re-use
		1927	the stream afterwards.
		1928
		1929	=cut
		1930
		1931	sub stoptls {
		1932	my ($self) = @_;
		1933
		1934	if ($self->{tls}) {
		1935	Net::SSLeay::shutdown ($self->{tls});
		1936
711	&_dotls;	1937	&_dotls;
		1938
		1939	# # we don't give a shit. no, we do, but we can't. no...#d#
		1940	# # we, we... have to use openssl :/#d#
		1941	# &_freetls;#d#
		1942	}
		1943	}
		1944
		1945	sub _freetls {
		1946	my ($self) = @_;
		1947
		1948	return unless $self->{tls};
		1949
		1950	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1951	if $self->{tls} > 0;
		1952
		1953	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
		1954	}
		1955
		1956	sub DESTROY {
		1957	my ($self) = @_;
		1958
		1959	&_freetls;
		1960
		1961	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1962
		1963	if ($linger && length $self->{wbuf} && $self->{fh}) {
		1964	my $fh = delete $self->{fh};
		1965	my $wbuf = delete $self->{wbuf};
		1966
		1967	my @linger;
		1968
		1969	push @linger, AE::io $fh, 1, sub {
		1970	my $len = syswrite $fh, $wbuf, length $wbuf;
		1971
		1972	if ($len > 0) {
		1973	substr $wbuf, 0, $len, "";
		1974	} else {
		1975	@linger = (); # end
		1976	}
		1977	};
		1978	push @linger, AE::timer $linger, 0, sub {
		1979	@linger = ();
		1980	};
		1981	}
		1982	}
		1983
		1984	=item $handle->destroy
		1985
		1986	Shuts down the handle object as much as possible - this call ensures that
		1987	no further callbacks will be invoked and as many resources as possible
		1988	will be freed. Any method you will call on the handle object after
		1989	destroying it in this way will be silently ignored (and it will return the
		1990	empty list).
		1991
		1992	Normally, you can just "forget" any references to an AnyEvent::Handle
		1993	object and it will simply shut down. This works in fatal error and EOF
		1994	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1995	callback, so when you want to destroy the AnyEvent::Handle object from
		1996	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1997	that case.
		1998
		1999	Destroying the handle object in this way has the advantage that callbacks
		2000	will be removed as well, so if those are the only reference holders (as
		2001	is common), then one doesn't need to do anything special to break any
		2002	reference cycles.
		2003
		2004	The handle might still linger in the background and write out remaining
		2005	data, as specified by the C<linger> option, however.
		2006
		2007	=cut
		2008
		2009	sub destroy {
		2010	my ($self) = @_;
		2011
		2012	$self->DESTROY;
		2013	%$self = ();
		2014	bless $self, "AnyEvent::Handle::destroyed";
		2015	}
		2016
		2017	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2018	#nop
		2019	}
		2020
		2021	=item AnyEvent::Handle::TLS_CTX
		2022
		2023	This function creates and returns the AnyEvent::TLS object used by default
		2024	for TLS mode.
		2025
		2026	The context is created by calling L<AnyEvent::TLS> without any arguments.
		2027
		2028	=cut
		2029
		2030	our $TLS_CTX;
		2031
		2032	sub TLS_CTX() {
		2033	$TLS_CTX ||= do {
		2034	require AnyEvent::TLS;
		2035
		2036	new AnyEvent::TLS
		2037	}
		2038	}
		2039
		2040	=back
		2041
		2042
		2043	=head1 NONFREQUENTLY ASKED QUESTIONS
		2044
		2045	=over 4
		2046
		2047	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		2048	still get further invocations!
		2049
		2050	That's because AnyEvent::Handle keeps a reference to itself when handling
		2051	read or write callbacks.
		2052
		2053	It is only safe to "forget" the reference inside EOF or error callbacks,
		2054	from within all other callbacks, you need to explicitly call the C<<
		2055	->destroy >> method.
		2056
		2057	=item I get different callback invocations in TLS mode/Why can't I pause
		2058	reading?
		2059
		2060	Unlike, say, TCP, TLS connections do not consist of two independent
		2061	communication channels, one for each direction. Or put differently. The
		2062	read and write directions are not independent of each other: you cannot
		2063	write data unless you are also prepared to read, and vice versa.
		2064
		2065	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		2066	callback invocations when you are not expecting any read data - the reason
		2067	is that AnyEvent::Handle always reads in TLS mode.
		2068
		2069	During the connection, you have to make sure that you always have a
		2070	non-empty read-queue, or an C<on_read> watcher. At the end of the
		2071	connection (or when you no longer want to use it) you can call the
		2072	C<destroy> method.
		2073
		2074	=item How do I read data until the other side closes the connection?
		2075
		2076	If you just want to read your data into a perl scalar, the easiest way
		2077	to achieve this is by setting an C<on_read> callback that does nothing,
		2078	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		2079	will be in C<$_[0]{rbuf}>:
		2080
		2081	$handle->on_read (sub { });
		2082	$handle->on_eof (undef);
		2083	$handle->on_error (sub {
		2084	my $data = delete $_[0]{rbuf};
		2085	});
		2086
		2087	The reason to use C<on_error> is that TCP connections, due to latencies
		2088	and packets loss, might get closed quite violently with an error, when in
		2089	fact, all data has been received.
		2090
		2091	It is usually better to use acknowledgements when transferring data,
		2092	to make sure the other side hasn't just died and you got the data
		2093	intact. This is also one reason why so many internet protocols have an
		2094	explicit QUIT command.
		2095
		2096	=item I don't want to destroy the handle too early - how do I wait until
		2097	all data has been written?
		2098
		2099	After writing your last bits of data, set the C<on_drain> callback
		2100	and destroy the handle in there - with the default setting of
		2101	C<low_water_mark> this will be called precisely when all data has been
		2102	written to the socket:
		2103
		2104	$handle->push_write (...);
		2105	$handle->on_drain (sub {
		2106	warn "all data submitted to the kernel\n";
		2107	undef $handle;
		2108	});
		2109
		2110	If you just want to queue some data and then signal EOF to the other side,
		2111	consider using C<< ->push_shutdown >> instead.
		2112
		2113	=item I want to contact a TLS/SSL server, I don't care about security.
		2114
		2115	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2116	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		2117	parameter:
		2118
		2119	tcp_connect $host, $port, sub {
		2120	my ($fh) = @_;
		2121
		2122	my $handle = new AnyEvent::Handle
		2123	fh => $fh,
		2124	tls => "connect",
		2125	on_error => sub { ... };
		2126
		2127	$handle->push_write (...);
712	};	2128	};
713	$self->{filter_r} = sub {
714	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});
715	&_dotls;
716	};
717	}
718		2129
719	sub DESTROY {	2130	=item I want to contact a TLS/SSL server, I do care about security.
720	my $self = shift;
721		2131
722	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	2132	Then you should additionally enable certificate verification, including
723	}	2133	peername verification, if the protocol you use supports it (see
		2134	L<AnyEvent::TLS>, C<verify_peername>).
724		2135
725	=item AnyEvent::Handle::TLS_CTX	2136	E.g. for HTTPS:
726		2137
727	This function creates and returns the Net::SSLeay::CTX object used by	2138	tcp_connect $host, $port, sub {
728	default for TLS mode.	2139	my ($fh) = @_;
729		2140
730	The context is created like this:	2141	my $handle = new AnyEvent::Handle
		2142	fh => $fh,
		2143	peername => $host,
		2144	tls => "connect",
		2145	tls_ctx => { verify => 1, verify_peername => "https" },
		2146	...
731		2147
732	Net::SSLeay::load_error_strings;	2148	Note that you must specify the hostname you connected to (or whatever
733	Net::SSLeay::SSLeay_add_ssl_algorithms;	2149	"peername" the protocol needs) as the C<peername> argument, otherwise no
734	Net::SSLeay::randomize;	2150	peername verification will be done.
735		2151
736	my $CTX = Net::SSLeay::CTX_new;	2152	The above will use the system-dependent default set of trusted CA
		2153	certificates. If you want to check against a specific CA, add the
		2154	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
737		2155
738	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL	2156	tls_ctx => {
		2157	verify => 1,
		2158	verify_peername => "https",
		2159	ca_file => "my-ca-cert.pem",
		2160	},
739		2161
740	=cut	2162	=item I want to create a TLS/SSL server, how do I do that?
741		2163
742	our $TLS_CTX;	2164	Well, you first need to get a server certificate and key. You have
		2165	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2166	self-signed certificate (cheap. check the search engine of your choice,
		2167	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2168	nice program for that purpose).
743		2169
744	sub TLS_CTX() {	2170	Then create a file with your private key (in PEM format, see
745	$TLS_CTX || do {	2171	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
746	require Net::SSLeay;	2172	file should then look like this:
747		2173
748	Net::SSLeay::load_error_strings ();	2174	-----BEGIN RSA PRIVATE KEY-----
749	Net::SSLeay::SSLeay_add_ssl_algorithms ();	2175	...header data
750	Net::SSLeay::randomize ();	2176	... lots of base64'y-stuff
		2177	-----END RSA PRIVATE KEY-----
751		2178
752	$TLS_CTX = Net::SSLeay::CTX_new ();	2179	-----BEGIN CERTIFICATE-----
		2180	... lots of base64'y-stuff
		2181	-----END CERTIFICATE-----
753		2182
754	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());	2183	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2184	specify this file as C<cert_file>:
755		2185
756	$TLS_CTX	2186	tcp_server undef, $port, sub {
757	}	2187	my ($fh) = @_;
758	}	2188
		2189	my $handle = new AnyEvent::Handle
		2190	fh => $fh,
		2191	tls => "accept",
		2192	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2193	...
		2194
		2195	When you have intermediate CA certificates that your clients might not
		2196	know about, just append them to the C<cert_file>.
759		2197
760	=back	2198	=back
761		2199
		2200
		2201	=head1 SUBCLASSING AnyEvent::Handle
		2202
		2203	In many cases, you might want to subclass AnyEvent::Handle.
		2204
		2205	To make this easier, a given version of AnyEvent::Handle uses these
		2206	conventions:
		2207
		2208	=over 4
		2209
		2210	=item * all constructor arguments become object members.
		2211
		2212	At least initially, when you pass a C<tls>-argument to the constructor it
		2213	will end up in C<< $handle->{tls} >>. Those members might be changed or
		2214	mutated later on (for example C<tls> will hold the TLS connection object).
		2215
		2216	=item * other object member names are prefixed with an C<_>.
		2217
		2218	All object members not explicitly documented (internal use) are prefixed
		2219	with an underscore character, so the remaining non-C<_>-namespace is free
		2220	for use for subclasses.
		2221
		2222	=item * all members not documented here and not prefixed with an underscore
		2223	are free to use in subclasses.
		2224
		2225	Of course, new versions of AnyEvent::Handle may introduce more "public"
		2226	member variables, but thats just life, at least it is documented.
		2227
		2228	=back
		2229
762	=head1 AUTHOR	2230	=head1 AUTHOR
763		2231
764	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2232	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
765		2233
766	=cut	2234	=cut

Diff Legend

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