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.67 by root, Fri Jun 6 15:33:10 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 qw(WSAEWOULDBLOCK);
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	=cut
18
19	our $VERSION = 4.15;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
32	$cv->broadcast;	15	my ($hdl, $fatal, $msg) = @_;
33	},	16	warn "got error $msg\n";
		17	$hdl->destroy;
		18	$cv->send;
34	);	19	);
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	warn "got line <$line>\n";
43	$cv->send;	28	$cv->send;
44	});	29	});
45		30
46	$cv->recv;	31	$cv->recv;
47		32
48	=head1 DESCRIPTION	33	=head1 DESCRIPTION
49		34
50	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
51	filehandles. For utility functions for doing non-blocking connects and accepts	36	filehandles.
52	on sockets see L<AnyEvent::Util>.	37
		38	The L<AnyEvent::Intro> tutorial contains some well-documented
		39	AnyEvent::Handle examples.
53		40
54	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
55	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
56	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
57		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
58	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
59	argument.	49	argument.
60		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
61	=head1 METHODS	65	=head1 METHODS
62		66
63	=over 4	67	=over 4
64		68
65	=item B<new (%args)>	69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
66		70
67	The constructor supports these arguments (all as key => value pairs).	71	The constructor supports these arguments (all as C<< key => value >> pairs).
68		72
69	=over 4	73	=over 4
70		74
71	=item fh => $filehandle [MANDATORY]	75	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
72		76
73	The filehandle this L<AnyEvent::Handle> object will operate on.	77	The filehandle this L<AnyEvent::Handle> object will operate on.
74
75	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
77		81
		82	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		83
		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>.
		87
		88	You have to specify either this parameter, or C<fh>, above.
		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
78	=item on_eof => $cb->($handle)	99	=item on_prepare => $cb->($handle)
79		100
80	Set the callback to be called when an end-of-file condition is detcted,	101	This (rarely used) callback is called before a new connection is
81	i.e. in the case of a socket, when the other side has closed the	102	attempted, but after the file handle has been created. It could be used to
82	connection cleanly.	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).
83		106
84	While not mandatory, it is highly recommended to set an eof callback,	107	The return value of this callback should be the connect timeout value in
85	otherwise you might end up with a closed socket while you are still	108	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
86	waiting for data.	109	timeout is to be used).
87		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
88	=item on_error => $cb->($handle, $fatal)	137	=item on_error => $cb->($handle, $fatal, $message)
89		138
90	This is the error callback, which is called when, well, some error	139	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	140	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	141	connect or a read error.
93		142
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	143	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	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
96	usable. Non-fatal errors can be retried by simply returning, but it is	156	Non-fatal errors can be retried by simply returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	157	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	158	when this callback is invoked. Examples of non-fatal errors are timeouts
		159	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		160
100	On callback entrance, the value of C<$!> contains the operating system	161	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	162	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		163	C<EPROTO>).
102		164
103	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
104	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
105	C<croak>.	167	C<croak>.
106		168
…		…
110	and no read request is in the queue (unlike read queue callbacks, this	172	and no read request is in the queue (unlike read queue callbacks, this
111	callback will only be called when at least one octet of data is in the	173	callback will only be called when at least one octet of data is in the
112	read buffer).	174	read buffer).
113		175
114	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 >>
115	method or access the C<$handle->{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.
116		180
117	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
118	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
119	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
120	error will be raised (with C<$!> set to C<EPIPE>).	184	error will be raised (with C<$!> set to C<EPIPE>).
121		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
122	=item on_drain => $cb->($handle)	207	=item on_drain => $cb->($handle)
123		208
124	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
125	(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).
126		211
127	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.
128		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
129	=item timeout => $fractional_seconds	220	=item timeout => $fractional_seconds
130		221
		222	=item rtimeout => $fractional_seconds
		223
		224	=item wtimeout => $fractional_seconds
		225
131	If non-zero, then this enables an "inactivity" timeout: whenever this many	226	If non-zero, then these enables an "inactivity" timeout: whenever this
132	seconds pass without a successful read or write on the underlying file	227	many seconds pass without a successful read or write on the underlying
133	handle, the C<on_timeout> callback will be invoked (and if that one is	228	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
134	missing, an C<ETIMEDOUT> error will be raised).	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>.
135		237
136	Note that timeout processing is also active when you currently do not have	238	Note that timeout processing is also active when you currently do not have
137	any outstanding read or write requests: If you plan to keep the connection	239	any outstanding read or write requests: If you plan to keep the connection
138	idle then you should disable the timout temporarily or ignore the timeout	240	idle then you should disable the timout temporarily or ignore the timeout
139	in the C<on_timeout> callback.	241	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		242	restart the timeout.
140		243
141	Zero (the default) disables this timeout.	244	Zero (the default) disables this timeout.
142		245
143	=item on_timeout => $cb->($handle)	246	=item on_timeout => $cb->($handle)
144		247
…		…
148		251
149	=item rbuf_max => <bytes>	252	=item rbuf_max => <bytes>
150		253
151	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>)
152	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
153	avoid denial-of-service attacks.	256	avoid some forms of denial-of-service attacks.
154		257
155	For example, a server accepting connections from untrusted sources should	258	For example, a server accepting connections from untrusted sources should
156	be configured to accept only so-and-so much data that it cannot act on	259	be configured to accept only so-and-so much data that it cannot act on
157	(for example, when expecting a line, an attacker could send an unlimited	260	(for example, when expecting a line, an attacker could send an unlimited
158	amount of data without a callback ever being called as long as the line	261	amount of data without a callback ever being called as long as the line
159	isn't finished).	262	isn't finished).
160		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
161	=item read_size => <bytes>	322	=item read_size => <bytes>
162		323
163	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
164	during each (loop iteration). Default: C<8192>.	325	try to read during each loop iteration, which affects memory
		326	requirements). Default: C<8192>.
165		327
166	=item low_water_mark => <bytes>	328	=item low_water_mark => <bytes>
167		329
168	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
169	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
170	considered empty.	332	considered empty.
171		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
172	=item linger => <seconds>	339	=item linger => <seconds>
173		340
174	If non-zero (default: C<3600>), then the destructor of the	341	If non-zero (default: C<3600>), then the destructor of the
175	AnyEvent::Handle object will check wether there is still outstanding write	342	AnyEvent::Handle object will check whether there is still outstanding
176	data and will install a watcher that will write out this data. No errors	343	write data and will install a watcher that will write this data to the
177	will be reported (this mostly matches how the operating system treats	344	socket. No errors will be reported (this mostly matches how the operating
178	outstanding data at socket close time).	345	system treats outstanding data at socket close time).
179		346
180	This will not work for partial TLS data that could not yet been	347	This will not work for partial TLS data that could not be encoded
181	encoded. This data will be lost.	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>.
182		360
183	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	361	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
184		362
185	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
186	will start making tls handshake and will transparently encrypt/decrypt	364	AnyEvent will start a TLS handshake as soon as the conenction has been
187	data.	365	established and will transparently encrypt/decrypt data afterwards.
		366
		367	All TLS protocol errors will be signalled as C<EPROTO>, with an
		368	appropriate error message.
188		369
189	TLS mode requires Net::SSLeay to be installed (it will be loaded	370	TLS mode requires Net::SSLeay to be installed (it will be loaded
190	automatically when you try to create a TLS handle).	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.
191		374
192	For the TLS server side, use C<accept>, and for the TLS client side of a	375	Unlike TCP, TLS has a server and client side: for the TLS server side, use
193	connection, use C<connect> mode.	376	C<accept>, and for the TLS client side of a connection, use C<connect>
		377	mode.
194		378
195	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
196	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>
197	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
198	AnyEvent::Handle.	382	AnyEvent::Handle. Also, this module will take ownership of this connection
		383	object.
199		384
		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.
		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
200	See the C<starttls> method if you need to start TLs negotiation later.	394	See the C<< ->starttls >> method for when need to start TLS negotiation later.
201		395
202	=item tls_ctx => $ssl_ctx	396	=item tls_ctx => $anyevent_tls
203		397
204	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
205	(unless a connection object was specified directly). If this parameter is	399	(unless a connection object was specified directly). If this parameter is
206	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	400	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
207		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
208	=item json => JSON or JSON::XS object	438	=item json => JSON or JSON::XS object
209		439
210	This is the json coder object used by the C<json> read and write types.	440	This is the json coder object used by the C<json> read and write types.
211		441
212	If you don't supply it, then AnyEvent::Handle will create and use a	442	If you don't supply it, then AnyEvent::Handle will create and use a
213	suitable one, which will write and expect UTF-8 encoded JSON texts.	443	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		444	texts.
214		445
215	Note that you are responsible to depend on the JSON module if you want to	446	Note that you are responsible to depend on the JSON module if you want to
216	use this functionality, as AnyEvent does not have a dependency itself.	447	use this functionality, as AnyEvent does not have a dependency itself.
217		448
218	=item filter_r => $cb
219
220	=item filter_w => $cb
221
222	These exist, but are undocumented at this time.
223
224	=back	449	=back
225		450
226	=cut	451	=cut
227		452
228	sub new {	453	sub new {
229	my $class = shift;	454	my $class = shift;
230
231	my $self = bless { @_ }, $class;	455	my $self = bless { @_ }, $class;
232		456
233	$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) = @_;
234		520
235	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	521	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
236		522
237	if ($self->{tls}) {	523	$self->{_activity} =
238	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
239	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	536	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
240	}	537	if $self->{tls};
241		538
242	$self->{_activity} = AnyEvent->now;
243	$self->_timeout;
244
245	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	539	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
246		540
247	$self->start_read	541	$self->start_read
248	if $self->{on_read};	542	if $self->{on_read} || @{ $self->{_queue} };
249		543
250	$self	544	$self->_drain_wbuf;
251	}
252
253	sub _shutdown {
254	my ($self) = @_;
255
256	delete $self->{_tw};
257	delete $self->{_rw};
258	delete $self->{_ww};
259	delete $self->{fh};
260
261	$self->stoptls;
262	}	545	}
263		546
264	sub _error {	547	sub _error {
265	my ($self, $errno, $fatal) = @_;	548	my ($self, $errno, $fatal, $message) = @_;
266
267	$self->_shutdown
268	if $fatal;
269		549
270	$! = $errno;	550	$! = $errno;
		551	$message ||= "$!";
271		552
272	if ($self->{on_error}) {	553	if ($self->{on_error}) {
273	$self->{on_error}($self, $fatal);	554	$self->{on_error}($self, $fatal, $message);
274	} else {	555	$self->destroy if $fatal;
		556	} elsif ($self->{fh}) {
		557	$self->destroy;
275	Carp::croak "AnyEvent::Handle uncaught error: $!";	558	Carp::croak "AnyEvent::Handle uncaught error: $message";
276	}	559	}
277	}	560	}
278		561
279	=item $fh = $handle->fh	562	=item $fh = $handle->fh
280		563
281	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.
282		565
283	=cut	566	=cut
284		567
285	sub fh { $_[0]{fh} }	568	sub fh { $_[0]{fh} }
286		569
…		…
304	$_[0]{on_eof} = $_[1];	587	$_[0]{on_eof} = $_[1];
305	}	588	}
306		589
307	=item $handle->on_timeout ($cb)	590	=item $handle->on_timeout ($cb)
308		591
309	Replace the current C<on_timeout> callback, or disables the callback	592	=item $handle->on_rtimeout ($cb)
310	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
311	argument.
312		593
313	=cut	594	=item $handle->on_wtimeout ($cb)
314		595
315	sub on_timeout {	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 {
316	$_[0]{on_timeout} = $_[1];	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];
317	}	711	}
318		712
319	#############################################################################	713	#############################################################################
320		714
321	=item $handle->timeout ($seconds)	715	=item $handle->timeout ($seconds)
322		716
		717	=item $handle->rtimeout ($seconds)
		718
		719	=item $handle->wtimeout ($seconds)
		720
323	Configures (or disables) the inactivity timeout.	721	Configures (or disables) the inactivity timeout.
324		722
325	=cut	723	=item $handle->timeout_reset
326		724
327	sub timeout {	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 {
328	my ($self, $timeout) = @_;	747	my ($self, $new_value) = @_;
329		748
330	$self->{timeout} = $timeout;	749	$self->{$timeout} = $new_value;
331	$self->_timeout;	750	delete $self->{$tw}; &$cb;
332	}	751	};
333		752
		753	*{"${dir}timeout_reset"} = sub {
		754	$_[0]{$activity} = AE::now;
		755	};
		756
		757	# main workhorse:
334	# reset the timeout watcher, as neccessary	758	# reset the timeout watcher, as neccessary
335	# also check for time-outs	759	# also check for time-outs
336	sub _timeout {	760	$cb = sub {
337	my ($self) = @_;	761	my ($self) = @_;
338		762
339	if ($self->{timeout}) {	763	if ($self->{$timeout} && $self->{fh}) {
340	my $NOW = AnyEvent->now;	764	my $NOW = AE::now;
341		765
342	# when would the timeout trigger?	766	# when would the timeout trigger?
343	my $after = $self->{_activity} + $self->{timeout} - $NOW;	767	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
344		768
345	# now or in the past already?	769	# now or in the past already?
346	if ($after <= 0) {	770	if ($after <= 0) {
347	$self->{_activity} = $NOW;	771	$self->{$activity} = $NOW;
348		772
349	if ($self->{on_timeout}) {	773	if ($self->{$on_timeout}) {
350	$self->{on_timeout}($self);	774	$self->{$on_timeout}($self);
351	} else {	775	} else {
352	$self->_error (&Errno::ETIMEDOUT);	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};
353	}	784	}
354		785
355	# callback could have changed timeout value, optimise	786	Scalar::Util::weaken $self;
356	return unless $self->{timeout};	787	return unless $self; # ->error could have destroyed $self
357		788
358	# calculate new after	789	$self->{$tw} ||= AE::timer $after, 0, sub {
359	$after = $self->{timeout};	790	delete $self->{$tw};
		791	$cb->($self);
		792	};
		793	} else {
		794	delete $self->{$tw};
360	}	795	}
361
362	Scalar::Util::weaken $self;
363	return unless $self; # ->error could have destroyed $self
364
365	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
366	delete $self->{_tw};
367	$self->_timeout;
368	});
369	} else {
370	delete $self->{_tw};
371	}	796	}
372	}	797	}
373		798
374	#############################################################################	799	#############################################################################
375		800
…		…
399	my ($self, $cb) = @_;	824	my ($self, $cb) = @_;
400		825
401	$self->{on_drain} = $cb;	826	$self->{on_drain} = $cb;
402		827
403	$cb->($self)	828	$cb->($self)
404	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	829	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
405	}	830	}
406		831
407	=item $handle->push_write ($data)	832	=item $handle->push_write ($data)
408		833
409	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
…		…
420	Scalar::Util::weaken $self;	845	Scalar::Util::weaken $self;
421		846
422	my $cb = sub {	847	my $cb = sub {
423	my $len = syswrite $self->{fh}, $self->{wbuf};	848	my $len = syswrite $self->{fh}, $self->{wbuf};
424		849
425	if ($len >= 0) {	850	if (defined $len) {
426	substr $self->{wbuf}, 0, $len, "";	851	substr $self->{wbuf}, 0, $len, "";
427		852
428	$self->{_activity} = AnyEvent->now;	853	$self->{_activity} = $self->{_wactivity} = AE::now;
429		854
430	$self->{on_drain}($self)	855	$self->{on_drain}($self)
431	if $self->{low_water_mark} >= length $self->{wbuf}	856	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
432	&& $self->{on_drain};	857	&& $self->{on_drain};
433		858
434	delete $self->{_ww} unless length $self->{wbuf};	859	delete $self->{_ww} unless length $self->{wbuf};
435	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	860	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
436	$self->_error ($!, 1);	861	$self->_error ($!, 1);
437	}	862	}
438	};	863	};
439		864
440	# try to write data immediately	865	# try to write data immediately
441	$cb->();	866	$cb->() unless $self->{autocork};
442		867
443	# if still data left in wbuf, we need to poll	868	# if still data left in wbuf, we need to poll
444	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	869	$self->{_ww} = AE::io $self->{fh}, 1, $cb
445	if length $self->{wbuf};	870	if length $self->{wbuf};
446	};	871	};
447	}	872	}
448		873
449	our %WH;	874	our %WH;
…		…
460		885
461	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	886	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
462	->($self, @_);	887	->($self, @_);
463	}	888	}
464		889
465	if ($self->{filter_w}) {	890	if ($self->{tls}) {
466	$self->{filter_w}($self, \$_[0]);	891	$self->{_tls_wbuf} .= $_[0];
		892	&_dotls ($self) if $self->{fh};
467	} else {	893	} else {
468	$self->{wbuf} .= $_[0];	894	$self->{wbuf} .= $_[0];
469	$self->_drain_wbuf;	895	$self->_drain_wbuf if $self->{fh};
470	}	896	}
471	}	897	}
472		898
473	=item $handle->push_write (type => @args)	899	=item $handle->push_write (type => @args)
474		900
…		…
488	=cut	914	=cut
489		915
490	register_write_type netstring => sub {	916	register_write_type netstring => sub {
491	my ($self, $string) = @_;	917	my ($self, $string) = @_;
492		918
493	sprintf "%d:%s,", (length $string), $string	919	(length $string) . ":$string,"
494	};	920	};
495		921
496	=item packstring => $format, $data	922	=item packstring => $format, $data
497		923
498	An octet string prefixed with an encoded length. The encoding C<$format>	924	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
538	Other languages could read single lines terminated by a newline and pass	964	Other languages could read single lines terminated by a newline and pass
539	this line into their JSON decoder of choice.	965	this line into their JSON decoder of choice.
540		966
541	=cut	967	=cut
542		968
		969	sub json_coder() {
		970	eval { require JSON::XS; JSON::XS->new->utf8 }
		971	|| do { require JSON; JSON->new->utf8 }
		972	}
		973
543	register_write_type json => sub {	974	register_write_type json => sub {
544	my ($self, $ref) = @_;	975	my ($self, $ref) = @_;
545		976
546	require JSON;	977	my $json = $self->{json} ||= json_coder;
547		978
548	$self->{json} ? $self->{json}->encode ($ref)	979	$json->encode ($ref)
549	: JSON::encode_json ($ref)
550	};	980	};
551		981
552	=item storable => $reference	982	=item storable => $reference
553		983
554	Freezes the given reference using L<Storable> and writes it to the	984	Freezes the given reference using L<Storable> and writes it to the
…		…
563		993
564	pack "w/a*", Storable::nfreeze ($ref)	994	pack "w/a*", Storable::nfreeze ($ref)
565	};	995	};
566		996
567	=back	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	}
568		1023
569	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1024	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
570		1025
571	This function (not method) lets you add your own types to C<push_write>.	1026	This function (not method) lets you add your own types to C<push_write>.
572	Whenever the given C<type> is used, C<push_write> will invoke the code	1027	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
593	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
594	a queue.	1049	a queue.
595		1050
596	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
597	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
598	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
599	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).
600		1056
601	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
602	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
603	data arrives (also the first time it is queued) and removes it when it has	1059	data arrives (also the first time it is queued) and removes it when it has
604	done its job (see C<push_read>, below).	1060	done its job (see C<push_read>, below).
…		…
622	# handle xml	1078	# handle xml
623	});	1079	});
624	});	1080	});
625	});	1081	});
626		1082
627	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"
628	"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
629	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
630	pipeline sending both requests and manipulate the queue as necessary in	1086	just pipeline sending both requests and manipulate the queue as necessary
631	the callbacks:	1087	in the callbacks.
632		1088
633	# 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"
634	$handle->push_write ("request 1\015\012");	1094	$handle->push_write ("request 1\015\012");
635		1095
636	# 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
637	$handle->push_read (line => sub {	1097	$handle->push_read (line => sub {
638	# if we got an "OK", we have to _prepend_ another line,	1098	# if we got an "OK", we have to _prepend_ another line,
…		…
645	...	1105	...
646	});	1106	});
647	}	1107	}
648	});	1108	});
649		1109
650	# request two	1110	# request two, simply returns 64 octets
651	$handle->push_write ("request 2\015\012");	1111	$handle->push_write ("request 2\015\012");
652		1112
653	# simply read 64 bytes, always	1113	# simply read 64 bytes, always
654	$handle->push_read (chunk => 64, sub {	1114	$handle->push_read (chunk => 64, sub {
655	my $response = $_[1];	1115	my $response = $_[1];
…		…
661	=cut	1121	=cut
662		1122
663	sub _drain_rbuf {	1123	sub _drain_rbuf {
664	my ($self) = @_;	1124	my ($self) = @_;
665		1125
		1126	# avoid recursion
		1127	return if $self->{_skip_drain_rbuf};
666	local $self->{_in_drain} = 1;	1128	local $self->{_skip_drain_rbuf} = 1;
667
668	if (
669	defined $self->{rbuf_max}
670	&& $self->{rbuf_max} < length $self->{rbuf}
671	) {
672	return $self->_error (&Errno::ENOSPC, 1);
673	}
674		1129
675	while () {	1130	while () {
676	no strict 'refs';	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};
677		1135
678	my $len = length $self->{rbuf};	1136	my $len = length $self->{rbuf};
679		1137
680	if (my $cb = shift @{ $self->{_queue} }) {	1138	if (my $cb = shift @{ $self->{_queue} }) {
681	unless ($cb->($self)) {	1139	unless ($cb->($self)) {
682	if ($self->{_eof}) {	1140	# no progress can be made
683	# no progress can be made (not enough data and no data forthcoming)	1141	# (not enough data and no data forthcoming)
684	$self->_error (&Errno::EPIPE, 1), last;	1142	$self->_error (Errno::EPIPE, 1), return
685	}	1143	if $self->{_eof};
686		1144
687	unshift @{ $self->{_queue} }, $cb;	1145	unshift @{ $self->{_queue} }, $cb;
688	last;	1146	last;
689	}	1147	}
690	} elsif ($self->{on_read}) {	1148	} elsif ($self->{on_read}) {
…		…
697	&& !@{ $self->{_queue} } # and the queue is still empty	1155	&& !@{ $self->{_queue} } # and the queue is still empty
698	&& $self->{on_read} # but we still have on_read	1156	&& $self->{on_read} # but we still have on_read
699	) {	1157	) {
700	# no further data will arrive	1158	# no further data will arrive
701	# so no progress can be made	1159	# so no progress can be made
702	$self->_error (&Errno::EPIPE, 1), last	1160	$self->_error (Errno::EPIPE, 1), return
703	if $self->{_eof};	1161	if $self->{_eof};
704		1162
705	last; # more data might arrive	1163	last; # more data might arrive
706	}	1164	}
707	} else {	1165	} else {
708	# read side becomes idle	1166	# read side becomes idle
709	delete $self->{_rw};	1167	delete $self->{_rw} unless $self->{tls};
710	last;	1168	last;
711	}	1169	}
712	}	1170	}
713		1171
		1172	if ($self->{_eof}) {
		1173	$self->{on_eof}
714	$self->{on_eof}($self)	1174	? $self->{on_eof}($self)
715	if $self->{_eof} && $self->{on_eof};	1175	: $self->_error (0, 1, "Unexpected end-of-file");
		1176
		1177	return;
		1178	}
		1179
		1180	if (
		1181	defined $self->{rbuf_max}
		1182	&& $self->{rbuf_max} < length $self->{rbuf}
		1183	) {
		1184	$self->_error (Errno::ENOSPC, 1), return;
		1185	}
716		1186
717	# may need to restart read watcher	1187	# may need to restart read watcher
718	unless ($self->{_rw}) {	1188	unless ($self->{_rw}) {
719	$self->start_read	1189	$self->start_read
720	if $self->{on_read} || @{ $self->{_queue} };	1190	if $self->{on_read} || @{ $self->{_queue} };
…		…
731		1201
732	sub on_read {	1202	sub on_read {
733	my ($self, $cb) = @_;	1203	my ($self, $cb) = @_;
734		1204
735	$self->{on_read} = $cb;	1205	$self->{on_read} = $cb;
736	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1206	$self->_drain_rbuf if $cb;
737	}	1207	}
738		1208
739	=item $handle->rbuf	1209	=item $handle->rbuf
740		1210
741	Returns the read buffer (as a modifiable lvalue).	1211	Returns the read buffer (as a modifiable lvalue).
742		1212
743	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} >>
744	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.
745		1218
746	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>,
747	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
748	automatically manage the read buffer.	1221	automatically manage the read buffer.
749		1222
…		…
790	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1263	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
791	->($self, $cb, @_);	1264	->($self, $cb, @_);
792	}	1265	}
793		1266
794	push @{ $self->{_queue} }, $cb;	1267	push @{ $self->{_queue} }, $cb;
795	$self->_drain_rbuf unless $self->{_in_drain};	1268	$self->_drain_rbuf;
796	}	1269	}
797		1270
798	sub unshift_read {	1271	sub unshift_read {
799	my $self = shift;	1272	my $self = shift;
800	my $cb = pop;	1273	my $cb = pop;
…		…
804		1277
805	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1278	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
806	->($self, $cb, @_);	1279	->($self, $cb, @_);
807	}	1280	}
808		1281
809
810	unshift @{ $self->{_queue} }, $cb;	1282	unshift @{ $self->{_queue} }, $cb;
811	$self->_drain_rbuf unless $self->{_in_drain};	1283	$self->_drain_rbuf;
812	}	1284	}
813		1285
814	=item $handle->push_read (type => @args, $cb)	1286	=item $handle->push_read (type => @args, $cb)
815		1287
816	=item $handle->unshift_read (type => @args, $cb)	1288	=item $handle->unshift_read (type => @args, $cb)
…		…
846	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1318	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
847	1	1319	1
848	}	1320	}
849	};	1321	};
850		1322
851	# compatibility with older API
852	sub push_read_chunk {
853	$_[0]->push_read (chunk => $_[1], $_[2]);
854	}
855
856	sub unshift_read_chunk {
857	$_[0]->unshift_read (chunk => $_[1], $_[2]);
858	}
859
860	=item line => [$eol, ]$cb->($handle, $line, $eol)	1323	=item line => [$eol, ]$cb->($handle, $line, $eol)
861		1324
862	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
863	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
864	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
…		…
879	=cut	1342	=cut
880		1343
881	register_read_type line => sub {	1344	register_read_type line => sub {
882	my ($self, $cb, $eol) = @_;	1345	my ($self, $cb, $eol) = @_;
883		1346
884	$eol = qr|(\015?\012)| if @_ < 3;	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 {
885	$eol = quotemeta $eol unless ref $eol;	1356	$eol = quotemeta $eol unless ref $eol;
886	$eol = qr|^(.*?)($eol)|s;	1357	$eol = qr|^(.*?)($eol)|s;
887		1358
888	sub {	1359	sub {
889	$_[0]{rbuf} =~ s/$eol// or return;	1360	$_[0]{rbuf} =~ s/$eol// or return;
890		1361
891	$cb->($_[0], $1, $2);	1362	$cb->($_[0], $1, $2);
		1363	1
892	1	1364	}
893	}	1365	}
894	};	1366	};
895
896	# compatibility with older API
897	sub push_read_line {
898	my $self = shift;
899	$self->push_read (line => @_);
900	}
901
902	sub unshift_read_line {
903	my $self = shift;
904	$self->unshift_read (line => @_);
905	}
906		1367
907	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1368	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
908		1369
909	Makes a regex match against the regex object C<$accept> and returns	1370	Makes a regex match against the regex object C<$accept> and returns
910	everything up to and including the match.	1371	everything up to and including the match.
…		…
960	return 1;	1421	return 1;
961	}	1422	}
962		1423
963	# reject	1424	# reject
964	if ($reject && $$rbuf =~ $reject) {	1425	if ($reject && $$rbuf =~ $reject) {
965	$self->_error (&Errno::EBADMSG);	1426	$self->_error (Errno::EBADMSG);
966	}	1427	}
967		1428
968	# skip	1429	# skip
969	if ($skip && $$rbuf =~ $skip) {	1430	if ($skip && $$rbuf =~ $skip) {
970	$data .= substr $$rbuf, 0, $+[0], "";	1431	$data .= substr $$rbuf, 0, $+[0], "";
…		…
986	my ($self, $cb) = @_;	1447	my ($self, $cb) = @_;
987		1448
988	sub {	1449	sub {
989	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1450	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
990	if ($_[0]{rbuf} =~ /[^0-9]/) {	1451	if ($_[0]{rbuf} =~ /[^0-9]/) {
991	$self->_error (&Errno::EBADMSG);	1452	$self->_error (Errno::EBADMSG);
992	}	1453	}
993	return;	1454	return;
994	}	1455	}
995		1456
996	my $len = $1;	1457	my $len = $1;
…		…
999	my $string = $_[1];	1460	my $string = $_[1];
1000	$_[0]->unshift_read (chunk => 1, sub {	1461	$_[0]->unshift_read (chunk => 1, sub {
1001	if ($_[1] eq ",") {	1462	if ($_[1] eq ",") {
1002	$cb->($_[0], $string);	1463	$cb->($_[0], $string);
1003	} else {	1464	} else {
1004	$self->_error (&Errno::EBADMSG);	1465	$self->_error (Errno::EBADMSG);
1005	}	1466	}
1006	});	1467	});
1007	});	1468	});
1008		1469
1009	1	1470	1
…		…
1015	An octet string prefixed with an encoded length. The encoding C<$format>	1476	An octet string prefixed with an encoded length. The encoding C<$format>
1016	uses the same format as a Perl C<pack> format, but must specify a single	1477	uses the same format as a Perl C<pack> format, but must specify a single
1017	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1478	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1018	optional C<!>, C<< < >> or C<< > >> modifier).	1479	optional C<!>, C<< < >> or C<< > >> modifier).
1019		1480
1020	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	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).
1021		1483
1022	Example: read a block of data prefixed by its length in BER-encoded	1484	Example: read a block of data prefixed by its length in BER-encoded
1023	format (very efficient).	1485	format (very efficient).
1024		1486
1025	$handle->push_read (packstring => "w", sub {	1487	$handle->push_read (packstring => "w", sub {
…		…
1031	register_read_type packstring => sub {	1493	register_read_type packstring => sub {
1032	my ($self, $cb, $format) = @_;	1494	my ($self, $cb, $format) = @_;
1033		1495
1034	sub {	1496	sub {
1035	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1497	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1036	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1498	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1037	or return;	1499	or return;
1038		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 {
1039	# remove prefix	1509	# remove prefix
1040	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1510	substr $_[0]{rbuf}, 0, $format, "";
1041		1511
1042	# read rest	1512	# read remaining chunk
1043	$_[0]->unshift_read (chunk => $len, $cb);	1513	$_[0]->unshift_read (chunk => $len, $cb);
		1514	}
1044		1515
1045	1	1516	1
1046	}	1517	}
1047	};	1518	};
1048		1519
1049	=item json => $cb->($handle, $hash_or_arrayref)	1520	=item json => $cb->($handle, $hash_or_arrayref)
1050		1521
1051	Reads a JSON object or array, decodes it and passes it to the callback.	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.
1052		1524
1053	If a C<json> object was passed to the constructor, then that will be used	1525	If a C<json> object was passed to the constructor, then that will be used
1054	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1526	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1055		1527
1056	This read type uses the incremental parser available with JSON version	1528	This read type uses the incremental parser available with JSON version
…		…
1065	=cut	1537	=cut
1066		1538
1067	register_read_type json => sub {	1539	register_read_type json => sub {
1068	my ($self, $cb) = @_;	1540	my ($self, $cb) = @_;
1069		1541
1070	require JSON;	1542	my $json = $self->{json} ||= json_coder;
1071		1543
1072	my $data;	1544	my $data;
1073	my $rbuf = \$self->{rbuf};	1545	my $rbuf = \$self->{rbuf};
1074		1546
1075	my $json = $self->{json} ||= JSON->new->utf8;
1076
1077	sub {	1547	sub {
1078	my $ref = $json->incr_parse ($self->{rbuf});	1548	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1079		1549
1080	if ($ref) {	1550	if ($ref) {
1081	$self->{rbuf} = $json->incr_text;	1551	$self->{rbuf} = $json->incr_text;
1082	$json->incr_text = "";	1552	$json->incr_text = "";
1083	$cb->($self, $ref);	1553	$cb->($self, $ref);
1084		1554
1085	1	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	()
1086	} else {	1566	} else {
1087	$self->{rbuf} = "";	1567	$self->{rbuf} = "";
		1568
1088	()	1569	()
1089	}	1570	}
1090	}	1571	}
1091	};	1572	};
1092		1573
…		…
1105		1586
1106	require Storable;	1587	require Storable;
1107		1588
1108	sub {	1589	sub {
1109	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1590	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1110	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })	1591	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1111	or return;	1592	or return;
1112		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 {
1113	# remove prefix	1602	# remove prefix
1114	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";	1603	substr $_[0]{rbuf}, 0, $format, "";
1115		1604
1116	# read rest	1605	# read remaining chunk
1117	$_[0]->unshift_read (chunk => $len, sub {	1606	$_[0]->unshift_read (chunk => $len, sub {
1118	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1607	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1119	$cb->($_[0], $ref);	1608	$cb->($_[0], $ref);
1120	} else {	1609	} else {
1121	$self->_error (&Errno::EBADMSG);	1610	$self->_error (Errno::EBADMSG);
		1611	}
1122	}	1612	});
1123	});	1613	}
		1614
		1615	1
1124	}	1616	}
1125	};	1617	};
1126		1618
1127	=back	1619	=back
1128		1620
…		…
1158	Note that AnyEvent::Handle will automatically C<start_read> for you when	1650	Note that AnyEvent::Handle will automatically C<start_read> for you when
1159	you change the C<on_read> callback or push/unshift a read callback, and it	1651	you change the C<on_read> callback or push/unshift a read callback, and it
1160	will automatically C<stop_read> for you when neither C<on_read> is set nor	1652	will automatically C<stop_read> for you when neither C<on_read> is set nor
1161	there are any read requests in the queue.	1653	there are any read requests in the queue.
1162		1654
		1655	These methods will have no effect when in TLS mode (as TLS doesn't support
		1656	half-duplex connections).
		1657
1163	=cut	1658	=cut
1164		1659
1165	sub stop_read {	1660	sub stop_read {
1166	my ($self) = @_;	1661	my ($self) = @_;
1167		1662
1168	delete $self->{_rw};	1663	delete $self->{_rw} unless $self->{tls};
1169	}	1664	}
1170		1665
1171	sub start_read {	1666	sub start_read {
1172	my ($self) = @_;	1667	my ($self) = @_;
1173		1668
1174	unless ($self->{_rw} || $self->{_eof}) {	1669	unless ($self->{_rw} || $self->{_eof}) {
1175	Scalar::Util::weaken $self;	1670	Scalar::Util::weaken $self;
1176		1671
1177	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1672	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1178	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1673	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1179	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;
1180		1675
1181	if ($len > 0) {	1676	if ($len > 0) {
1182	$self->{_activity} = AnyEvent->now;	1677	$self->{_activity} = $self->{_ractivity} = AE::now;
1183		1678
1184	$self->{filter_r}	1679	if ($self->{tls}) {
1185	? $self->{filter_r}($self, $rbuf)	1680	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1186	: $self->{_in_drain} || $self->_drain_rbuf;	1681
		1682	&_dotls ($self);
		1683	} else {
		1684	$self->_drain_rbuf;
		1685	}
1187		1686
1188	} elsif (defined $len) {	1687	} elsif (defined $len) {
1189	delete $self->{_rw};	1688	delete $self->{_rw};
1190	$self->{_eof} = 1;	1689	$self->{_eof} = 1;
1191	$self->_drain_rbuf unless $self->{_in_drain};	1690	$self->_drain_rbuf;
1192		1691
1193	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1692	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1194	return $self->_error ($!, 1);	1693	return $self->_error ($!, 1);
1195	}	1694	}
1196	});	1695	};
1197	}	1696	}
1198	}	1697	}
1199		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.
1200	sub _dotls {	1727	sub _dotls {
1201	my ($self) = @_;	1728	my ($self) = @_;
1202		1729
1203	my $buf;	1730	my $tmp;
1204		1731
1205	if (length $self->{_tls_wbuf}) {	1732	if (length $self->{_tls_wbuf}) {
1206	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1733	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1207	substr $self->{_tls_wbuf}, 0, $len, "";	1734	substr $self->{_tls_wbuf}, 0, $tmp, "";
1208	}	1735	}
1209	}
1210		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
		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
1211	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1769	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1212	$self->{wbuf} .= $buf;	1770	$self->{wbuf} .= $tmp;
1213	$self->_drain_wbuf;	1771	$self->_drain_wbuf;
1214	}	1772	}
1215		1773
1216	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1774	$self->{_on_starttls}
1217	if (length $buf) {	1775	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1218	$self->{rbuf} .= $buf;	1776	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1219	$self->_drain_rbuf unless $self->{_in_drain};
1220	} else {
1221	# let's treat SSL-eof as we treat normal EOF
1222	$self->{_eof} = 1;
1223	$self->_shutdown;
1224	return;
1225	}
1226	}
1227
1228	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1229
1230	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1231	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1232	return $self->_error ($!, 1);
1233	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1234	return $self->_error (&Errno::EIO, 1);
1235	}
1236
1237	# all others are fine for our purposes
1238	}
1239	}	1777	}
1240		1778
1241	=item $handle->starttls ($tls[, $tls_ctx])	1779	=item $handle->starttls ($tls[, $tls_ctx])
1242		1780
1243	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1781	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1244	object is created, you can also do that at a later time by calling	1782	object is created, you can also do that at a later time by calling
1245	C<starttls>.	1783	C<starttls>.
1246		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
1247	The first argument is the same as the C<tls> constructor argument (either	1789	The first argument is the same as the C<tls> constructor argument (either
1248	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1790	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1249		1791
1250	The second argument is the optional C<Net::SSLeay::CTX> object that is	1792	The second argument is the optional C<AnyEvent::TLS> object that is used
1251	used when AnyEvent::Handle has to create its own TLS connection object.	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.
1252		1796
1253	The TLS connection object will end up in C<< $handle->{tls} >> after this	1797	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1254	call and can be used or changed to your liking. Note that the handshake	1798	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1255	might have already started when this function returns.	1799	changed to your liking. Note that the handshake might have already started
		1800	when this function returns.
1256		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
1257	=cut	1806	=cut
		1807
		1808	our %TLS_CACHE; #TODO not yet documented, should we?
1258		1809
1259	sub starttls {	1810	sub starttls {
1260	my ($self, $ssl, $ctx) = @_;	1811	my ($self, $tls, $ctx) = @_;
1261		1812
1262	$self->stoptls;	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};
1263		1815
1264	if ($ssl eq "accept") {	1816	$self->{tls} = $tls;
1265	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1817	$self->{tls_ctx} = $ctx if @_ > 2;
1266	Net::SSLeay::set_accept_state ($ssl);	1818
1267	} elsif ($ssl eq "connect") {	1819	return unless $self->{fh};
1268	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1820
1269	Net::SSLeay::set_connect_state ($ssl);	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;
		1837	} else {
		1838	$ctx = new AnyEvent::TLS %$ctx;
		1839	}
		1840	}
1270	}	1841
1271		1842	$self->{tls_ctx} = $ctx || TLS_CTX ();
1272	$self->{tls} = $ssl;	1843	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1273		1844
1274	# 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)
1275	# but the openssl maintainers basically said: "trust us, it just works".	1846	# but the openssl maintainers basically said: "trust us, it just works".
1276	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1847	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1277	# and mismaintained ssleay-module doesn't even offer them).	1848	# and mismaintained ssleay-module doesn't even offer them).
1278	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	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.
1279	Net::SSLeay::CTX_set_mode ($self->{tls},	1857	# Net::SSLeay::CTX_set_mode ($ssl,
1280	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1858	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1281	| (eval { local $SIG{__DIE__}; 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);
1282		1861
1283	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1862	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1284	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1863	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1285		1864
		1865	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1866
1286	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1867	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1287		1868
1288	$self->{filter_w} = sub {	1869	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1289	$_[0]{_tls_wbuf} .= ${$_[1]};	1870	if $self->{on_starttls};
1290	&_dotls;	1871
1291	};	1872	&_dotls; # need to trigger the initial handshake
1292	$self->{filter_r} = sub {	1873	$self->start_read; # make sure we actually do read
1293	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1294	&_dotls;
1295	};
1296	}	1874	}
1297		1875
1298	=item $handle->stoptls	1876	=item $handle->stoptls
1299		1877
1300	Destroys the SSL connection, if any. Partial read or write data will be	1878	Shuts down the SSL connection - this makes a proper EOF handshake by
1301	lost.	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.
1302		1882
1303	=cut	1883	=cut
1304		1884
1305	sub stoptls {	1885	sub stoptls {
1306	my ($self) = @_;	1886	my ($self) = @_;
1307		1887
1308	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1888	if ($self->{tls}) {
		1889	Net::SSLeay::shutdown ($self->{tls});
1309		1890
1310	delete $self->{_rbio};	1891	&_dotls;
1311	delete $self->{_wbio};	1892
1312	delete $self->{_tls_wbuf};	1893	# # we don't give a shit. no, we do, but we can't. no...#d#
1313	delete $self->{filter_r};	1894	# # we, we... have to use openssl :/#d#
1314	delete $self->{filter_w};	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)};
1315	}	1908	}
1316		1909
1317	sub DESTROY {	1910	sub DESTROY {
1318	my $self = shift;	1911	my ($self) = @_;
1319		1912
1320	$self->stoptls;	1913	&_freetls;
1321		1914
1322	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1915	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1323		1916
1324	if ($linger && length $self->{wbuf}) {	1917	if ($linger && length $self->{wbuf} && $self->{fh}) {
1325	my $fh = delete $self->{fh};	1918	my $fh = delete $self->{fh};
1326	my $wbuf = delete $self->{wbuf};	1919	my $wbuf = delete $self->{wbuf};
1327		1920
1328	my @linger;	1921	my @linger;
1329		1922
1330	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1923	push @linger, AE::io $fh, 1, sub {
1331	my $len = syswrite $fh, $wbuf, length $wbuf;	1924	my $len = syswrite $fh, $wbuf, length $wbuf;
1332		1925
1333	if ($len > 0) {	1926	if ($len > 0) {
1334	substr $wbuf, 0, $len, "";	1927	substr $wbuf, 0, $len, "";
1335	} else {	1928	} else {
1336	@linger = (); # end	1929	@linger = (); # end
1337	}	1930	}
1338	});	1931	};
1339	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1932	push @linger, AE::timer $linger, 0, sub {
1340	@linger = ();	1933	@linger = ();
1341	});	1934	};
1342	}	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
1343	}	1973	}
1344		1974
1345	=item AnyEvent::Handle::TLS_CTX	1975	=item AnyEvent::Handle::TLS_CTX
1346		1976
1347	This function creates and returns the Net::SSLeay::CTX object used by	1977	This function creates and returns the AnyEvent::TLS object used by default
1348	default for TLS mode.	1978	for TLS mode.
1349		1979
1350	The context is created like this:	1980	The context is created by calling L<AnyEvent::TLS> without any arguments.
1351
1352	Net::SSLeay::load_error_strings;
1353	Net::SSLeay::SSLeay_add_ssl_algorithms;
1354	Net::SSLeay::randomize;
1355
1356	my $CTX = Net::SSLeay::CTX_new;
1357
1358	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1359		1981
1360	=cut	1982	=cut
1361		1983
1362	our $TLS_CTX;	1984	our $TLS_CTX;
1363		1985
1364	sub TLS_CTX() {	1986	sub TLS_CTX() {
1365	$TLS_CTX || do {	1987	$TLS_CTX ||= do {
1366	require Net::SSLeay;	1988	require AnyEvent::TLS;
1367		1989
1368	Net::SSLeay::load_error_strings ();	1990	new AnyEvent::TLS
1369	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1370	Net::SSLeay::randomize ();
1371
1372	$TLS_CTX = Net::SSLeay::CTX_new ();
1373
1374	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1375
1376	$TLS_CTX
1377	}	1991	}
1378	}	1992	}
1379		1993
1380	=back	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 (...);
		2082	};
		2083
		2084	=item I want to contact a TLS/SSL server, I do care about security.
		2085
		2086	Then you should additionally enable certificate verification, including
		2087	peername verification, if the protocol you use supports it (see
		2088	L<AnyEvent::TLS>, C<verify_peername>).
		2089
		2090	E.g. for HTTPS:
		2091
		2092	tcp_connect $host, $port, sub {
		2093	my ($fh) = @_;
		2094
		2095	my $handle = new AnyEvent::Handle
		2096	fh => $fh,
		2097	peername => $host,
		2098	tls => "connect",
		2099	tls_ctx => { verify => 1, verify_peername => "https" },
		2100	...
		2101
		2102	Note that you must specify the hostname you connected to (or whatever
		2103	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2104	peername verification will be done.
		2105
		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>:
		2109
		2110	tls_ctx => {
		2111	verify => 1,
		2112	verify_peername => "https",
		2113	ca_file => "my-ca-cert.pem",
		2114	},
		2115
		2116	=item I want to create a TLS/SSL server, how do I do that?
		2117
		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).
		2123
		2124	Then create a file with your private key (in PEM format, see
		2125	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2126	file should then look like this:
		2127
		2128	-----BEGIN RSA PRIVATE KEY-----
		2129	...header data
		2130	... lots of base64'y-stuff
		2131	-----END RSA PRIVATE KEY-----
		2132
		2133	-----BEGIN CERTIFICATE-----
		2134	... lots of base64'y-stuff
		2135	-----END CERTIFICATE-----
		2136
		2137	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2138	specify this file as C<cert_file>:
		2139
		2140	tcp_server undef, $port, sub {
		2141	my ($fh) = @_;
		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>.
		2151
		2152	=back
		2153
1381		2154
1382	=head1 SUBCLASSING AnyEvent::Handle	2155	=head1 SUBCLASSING AnyEvent::Handle
1383		2156
1384	In many cases, you might want to subclass AnyEvent::Handle.	2157	In many cases, you might want to subclass AnyEvent::Handle.
1385		2158
…		…
1389	=over 4	2162	=over 4
1390		2163
1391	=item * all constructor arguments become object members.	2164	=item * all constructor arguments become object members.
1392		2165
1393	At least initially, when you pass a C<tls>-argument to the constructor it	2166	At least initially, when you pass a C<tls>-argument to the constructor it
1394	will end up in C<< $handle->{tls} >>. Those members might be changes or	2167	will end up in C<< $handle->{tls} >>. Those members might be changed or
1395	mutated later on (for example C<tls> will hold the TLS connection object).	2168	mutated later on (for example C<tls> will hold the TLS connection object).
1396		2169
1397	=item * other object member names are prefixed with an C<_>.	2170	=item * other object member names are prefixed with an C<_>.
1398		2171
1399	All object members not explicitly documented (internal use) are prefixed	2172	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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