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

Diff Legend

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