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

Diff Legend

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