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.85 by root, Thu Aug 21 19:53:19 2008 UTC vs.
Revision 1.177 by root, Sun Aug 9 00:24:35 2009 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
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.232;
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>.
53		37
54	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
56		40
57	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
58	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
59	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
60		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
61	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
62	argument.	49	argument.
63		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
64	=head1 METHODS	65	=head1 METHODS
65		66
66	=over 4	67	=over 4
67		68
68	=item B<new (%args)>	69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		70
70	The constructor supports these arguments (all as key => value pairs).	71	The constructor supports these arguments (all as C<< key => value >> pairs).
71		72
72	=over 4	73	=over 4
73		74
74	=item fh => $filehandle [MANDATORY]	75	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		76
76	The filehandle this L<AnyEvent::Handle> object will operate on.	77	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	78	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	80	that mode.
81		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
82	=item on_eof => $cb->($handle)	99	=item on_prepare => $cb->($handle)
83		100
84	Set the callback to be called when an end-of-file condition is detected,	101	This (rarely used) callback is called before a new connection is
85	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
86	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).
87		106
88	For sockets, this just means that the other side has stopped sending data,	107	The return value of this callback should be the connect timeout value in
89	you can still try to write data, and, in fact, one can return from the eof	108	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
90	callback and continue writing data, as only the read part has been shut	109	timeout is to be used).
91	down.
92		110
93	While not mandatory, it is I<highly> recommended to set an eof callback,	111	=item on_connect => $cb->($handle, $host, $port, $retry->())
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96		112
97	If an EOF condition has been detected but no C<on_eof> callback has been	113	This callback is called when a connection has been successfully established.
98	set, then a fatal error will be raised with C<$!> set to <0>.
99		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
100	=item on_error => $cb->($handle, $fatal)	137	=item on_error => $cb->($handle, $fatal, $message)
101		138
102	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
103	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
104	connect or a read error.	141	connect or a read error.
105		142
106	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
107	fatal errors the handle object will be shut down and will not be usable	144	fatal errors the handle object will be destroyed (by a call to C<< ->
108	(but you are free to look at the current C< ->rbuf >). Examples of fatal	145	destroy >>) after invoking the error callback (which means you are free to
109	errors are an EOF condition with active (but unsatisifable) read watchers	146	examine the handle object). Examples of fatal errors are an EOF condition
110	(C<EPIPE>) or I/O errors.	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<"$!">).
111		155
112	Non-fatal errors can be retried by simply returning, but it is recommended	156	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object	157	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts	158	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	159	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116		160
117	On callback entrance, the value of C<$!> contains the operating system	161	On callback entrance, the value of C<$!> contains the operating system
118	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>).
119		164
120	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
121	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
122	C<croak>.	167	C<croak>.
123		168
…		…
127	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
128	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
129	read buffer).	174	read buffer).
130		175
131	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 >>
132	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.
133		180
134	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
135	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
136	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
137	error will be raised (with C<$!> set to C<EPIPE>).	184	error will be raised (with C<$!> set to C<EPIPE>).
		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>.
138		206
139	=item on_drain => $cb->($handle)	207	=item on_drain => $cb->($handle)
140		208
141	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
142	(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).
…		…
149	memory and push it into the queue, but instead only read more data from	217	memory and push it into the queue, but instead only read more data from
150	the file when the write queue becomes empty.	218	the file when the write queue becomes empty.
151		219
152	=item timeout => $fractional_seconds	220	=item timeout => $fractional_seconds
153		221
		222	=item rtimeout => $fractional_seconds
		223
		224	=item wtimeout => $fractional_seconds
		225
154	If non-zero, then this enables an "inactivity" timeout: whenever this many	226	If non-zero, then these enables an "inactivity" timeout: whenever this
155	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
156	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
157	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>.
158		237
159	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
160	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
161	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
162	in the C<on_timeout> callback.	241	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		242	restart the timeout.
163		243
164	Zero (the default) disables this timeout.	244	Zero (the default) disables this timeout.
165		245
166	=item on_timeout => $cb->($handle)	246	=item on_timeout => $cb->($handle)
167		247
…		…
171		251
172	=item rbuf_max => <bytes>	252	=item rbuf_max => <bytes>
173		253
174	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>)
175	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
176	avoid denial-of-service attacks.	256	avoid some forms of denial-of-service attacks.
177		257
178	For example, a server accepting connections from untrusted sources should	258	For example, a server accepting connections from untrusted sources should
179	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
180	(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
181	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
182	isn't finished).	262	isn't finished).
183		263
184	=item autocork => <boolean>	264	=item autocork => <boolean>
185		265
186	When disabled (the default), then C<push_write> will try to immediately	266	When disabled (the default), then C<push_write> will try to immediately
187	write the data to the handle if possible. This avoids having to register	267	write the data to the handle, if possible. This avoids having to register
188	a write watcher and wait for the next event loop iteration, but can be	268	a write watcher and wait for the next event loop iteration, but can
189	inefficient if you write multiple small chunks (this disadvantage is	269	be inefficient if you write multiple small chunks (on the wire, this
190	usually avoided by your kernel's nagle algorithm, see C<low_delay>).	270	disadvantage is usually avoided by your kernel's nagle algorithm, see
		271	C<no_delay>, but this option can save costly syscalls).
191		272
192	When enabled, then writes will always be queued till the next event loop	273	When enabled, then writes will always be queued till the next event loop
193	iteration. This is efficient when you do many small writes per iteration,	274	iteration. This is efficient when you do many small writes per iteration,
194	but less efficient when you do a single write only.	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.
195		277
196	=item no_delay => <boolean>	278	=item no_delay => <boolean>
197		279
198	When doing small writes on sockets, your operating system kernel might	280	When doing small writes on sockets, your operating system kernel might
199	wait a bit for more data before actually sending it out. This is called	281	wait a bit for more data before actually sending it out. This is called
200	the Nagle algorithm, and usually it is beneficial.	282	the Nagle algorithm, and usually it is beneficial.
201		283
202	In some situations you want as low a delay as possible, which cna be	284	In some situations you want as low a delay as possible, which can be
203	accomplishd by setting this option to true.	285	accomplishd by setting this option to a true value.
204		286
205	The default is your opertaing system's default behaviour, this option	287	The default is your opertaing system's default behaviour (most likely
206	explicitly enables or disables it, if possible.	288	enabled), this option explicitly enables or disables it, if possible.
207		289
208	=item read_size => <bytes>	290	=item read_size => <bytes>
209		291
210	The default read block size (the amount of bytes this module will try to read	292	The default read block size (the amount of bytes this module will
211	during each (loop iteration). Default: C<8192>.	293	try to read during each loop iteration, which affects memory
		294	requirements). Default: C<8192>.
212		295
213	=item low_water_mark => <bytes>	296	=item low_water_mark => <bytes>
214		297
215	Sets the amount of bytes (default: C<0>) that make up an "empty" write	298	Sets the amount of bytes (default: C<0>) that make up an "empty" write
216	buffer: If the write reaches this size or gets even samller it is	299	buffer: If the write reaches this size or gets even samller it is
217	considered empty.	300	considered empty.
218		301
		302	Sometimes it can be beneficial (for performance reasons) to add data to
		303	the write buffer before it is fully drained, but this is a rare case, as
		304	the operating system kernel usually buffers data as well, so the default
		305	is good in almost all cases.
		306
219	=item linger => <seconds>	307	=item linger => <seconds>
220		308
221	If non-zero (default: C<3600>), then the destructor of the	309	If non-zero (default: C<3600>), then the destructor of the
222	AnyEvent::Handle object will check wether there is still outstanding write	310	AnyEvent::Handle object will check whether there is still outstanding
223	data and will install a watcher that will write out this data. No errors	311	write data and will install a watcher that will write this data to the
224	will be reported (this mostly matches how the operating system treats	312	socket. No errors will be reported (this mostly matches how the operating
225	outstanding data at socket close time).	313	system treats outstanding data at socket close time).
226		314
227	This will not work for partial TLS data that could not yet been	315	This will not work for partial TLS data that could not be encoded
228	encoded. This data will be lost.	316	yet. This data will be lost. Calling the C<stoptls> method in time might
		317	help.
		318
		319	=item peername => $string
		320
		321	A string used to identify the remote site - usually the DNS hostname
		322	(I<not> IDN!) used to create the connection, rarely the IP address.
		323
		324	Apart from being useful in error messages, this string is also used in TLS
		325	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		326	verification will be skipped when C<peername> is not specified or
		327	C<undef>.
229		328
230	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	329	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
231		330
232	When this parameter is given, it enables TLS (SSL) mode, that means	331	When this parameter is given, it enables TLS (SSL) mode, that means
233	AnyEvent will start a TLS handshake and will transparently encrypt/decrypt	332	AnyEvent will start a TLS handshake as soon as the conenction has been
234	data.	333	established and will transparently encrypt/decrypt data afterwards.
		334
		335	All TLS protocol errors will be signalled as C<EPROTO>, with an
		336	appropriate error message.
235		337
236	TLS mode requires Net::SSLeay to be installed (it will be loaded	338	TLS mode requires Net::SSLeay to be installed (it will be loaded
237	automatically when you try to create a TLS handle).	339	automatically when you try to create a TLS handle): this module doesn't
		340	have a dependency on that module, so if your module requires it, you have
		341	to add the dependency yourself.
238		342
239	Unlike TCP, TLS has a server and client side: for the TLS server side, use	343	Unlike TCP, TLS has a server and client side: for the TLS server side, use
240	C<accept>, and for the TLS client side of a connection, use C<connect>	344	C<accept>, and for the TLS client side of a connection, use C<connect>
241	mode.	345	mode.
242		346
243	You can also provide your own TLS connection object, but you have	347	You can also provide your own TLS connection object, but you have
244	to make sure that you call either C<Net::SSLeay::set_connect_state>	348	to make sure that you call either C<Net::SSLeay::set_connect_state>
245	or C<Net::SSLeay::set_accept_state> on it before you pass it to	349	or C<Net::SSLeay::set_accept_state> on it before you pass it to
246	AnyEvent::Handle.	350	AnyEvent::Handle. Also, this module will take ownership of this connection
		351	object.
247		352
		353	At some future point, AnyEvent::Handle might switch to another TLS
		354	implementation, then the option to use your own session object will go
		355	away.
		356
		357	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		358	passing in the wrong integer will lead to certain crash. This most often
		359	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		360	segmentation fault.
		361
248	See the C<starttls> method for when need to start TLS negotiation later.	362	See the C<< ->starttls >> method for when need to start TLS negotiation later.
249		363
250	=item tls_ctx => $ssl_ctx	364	=item tls_ctx => $anyevent_tls
251		365
252	Use the given Net::SSLeay::CTX object to create the new TLS connection	366	Use the given C<AnyEvent::TLS> object to create the new TLS connection
253	(unless a connection object was specified directly). If this parameter is	367	(unless a connection object was specified directly). If this parameter is
254	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	368	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
255		369
		370	Instead of an object, you can also specify a hash reference with C<< key
		371	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		372	new TLS context object.
		373
		374	=item on_starttls => $cb->($handle, $success[, $error_message])
		375
		376	This callback will be invoked when the TLS/SSL handshake has finished. If
		377	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		378	(C<on_stoptls> will not be called in this case).
		379
		380	The session in C<< $handle->{tls} >> can still be examined in this
		381	callback, even when the handshake was not successful.
		382
		383	TLS handshake failures will not cause C<on_error> to be invoked when this
		384	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		385
		386	Without this callback, handshake failures lead to C<on_error> being
		387	called, as normal.
		388
		389	Note that you cannot call C<starttls> right again in this callback. If you
		390	need to do that, start an zero-second timer instead whose callback can
		391	then call C<< ->starttls >> again.
		392
		393	=item on_stoptls => $cb->($handle)
		394
		395	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		396	set, then it will be invoked after freeing the TLS session. If it is not,
		397	then a TLS shutdown condition will be treated like a normal EOF condition
		398	on the handle.
		399
		400	The session in C<< $handle->{tls} >> can still be examined in this
		401	callback.
		402
		403	This callback will only be called on TLS shutdowns, not when the
		404	underlying handle signals EOF.
		405
256	=item json => JSON or JSON::XS object	406	=item json => JSON or JSON::XS object
257		407
258	This is the json coder object used by the C<json> read and write types.	408	This is the json coder object used by the C<json> read and write types.
259		409
260	If you don't supply it, then AnyEvent::Handle will create and use a	410	If you don't supply it, then AnyEvent::Handle will create and use a
261	suitable one, which will write and expect UTF-8 encoded JSON texts.	411	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		412	texts.
262		413
263	Note that you are responsible to depend on the JSON module if you want to	414	Note that you are responsible to depend on the JSON module if you want to
264	use this functionality, as AnyEvent does not have a dependency itself.	415	use this functionality, as AnyEvent does not have a dependency itself.
265		416
266	=item filter_r => $cb
267
268	=item filter_w => $cb
269
270	These exist, but are undocumented at this time.
271
272	=back	417	=back
273		418
274	=cut	419	=cut
275		420
276	sub new {	421	sub new {
277	my $class = shift;	422	my $class = shift;
278
279	my $self = bless { @_ }, $class;	423	my $self = bless { @_ }, $class;
280		424
281	$self->{fh} or Carp::croak "mandatory argument fh is missing";	425	if ($self->{fh}) {
		426	$self->_start;
		427	return unless $self->{fh}; # could be gone by now
		428
		429	} elsif ($self->{connect}) {
		430	require AnyEvent::Socket;
		431
		432	$self->{peername} = $self->{connect}[0]
		433	unless exists $self->{peername};
		434
		435	$self->{_skip_drain_rbuf} = 1;
		436
		437	{
		438	Scalar::Util::weaken (my $self = $self);
		439
		440	$self->{_connect} =
		441	AnyEvent::Socket::tcp_connect (
		442	$self->{connect}[0],
		443	$self->{connect}[1],
		444	sub {
		445	my ($fh, $host, $port, $retry) = @_;
		446
		447	if ($fh) {
		448	$self->{fh} = $fh;
		449
		450	delete $self->{_skip_drain_rbuf};
		451	$self->_start;
		452
		453	$self->{on_connect}
		454	and $self->{on_connect}($self, $host, $port, sub {
		455	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		456	$self->{_skip_drain_rbuf} = 1;
		457	&$retry;
		458	});
		459
		460	} else {
		461	if ($self->{on_connect_error}) {
		462	$self->{on_connect_error}($self, "$!");
		463	$self->destroy;
		464	} else {
		465	$self->_error ($!, 1);
		466	}
		467	}
		468	},
		469	sub {
		470	local $self->{fh} = $_[0];
		471
		472	$self->{on_prepare}
		473	? $self->{on_prepare}->($self)
		474	: ()
		475	}
		476	);
		477	}
		478
		479	} else {
		480	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		481	}
		482
		483	$self
		484	}
		485
		486	sub _start {
		487	my ($self) = @_;
282		488
283	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	489	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
284		490
285	if ($self->{tls}) {	491	$self->{_activity} =
286	require Net::SSLeay;	492	$self->{_ractivity} =
287	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
288	}
289
290	$self->{_activity} = AnyEvent->now;	493	$self->{_wactivity} = AE::now;
291	$self->_timeout;
292		494
293	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	495	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		496	$self->rtimeout (delete $self->{rtimeout}) if $self->{rtimeout};
		497	$self->wtimeout (delete $self->{wtimeout}) if $self->{wtimeout};
		498
294	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	499	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
295		500
		501	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		502	if $self->{tls};
		503
		504	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
		505
296	$self->start_read	506	$self->start_read
297	if $self->{on_read};	507	if $self->{on_read} || @{ $self->{_queue} };
298		508
299	$self	509	$self->_drain_wbuf;
300	}	510	}
301		511
302	sub _shutdown {	512	#sub _shutdown {
303	my ($self) = @_;	513	# my ($self) = @_;
304		514	#
305	delete $self->{_tw};	515	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
306	delete $self->{_rw};	516	# $self->{_eof} = 1; # tell starttls et. al to stop trying
307	delete $self->{_ww};	517	#
308	delete $self->{fh};	518	# &_freetls;
309		519	#}
310	$self->stoptls;
311
312	delete $self->{on_read};
313	delete $self->{_queue};
314	}
315		520
316	sub _error {	521	sub _error {
317	my ($self, $errno, $fatal) = @_;	522	my ($self, $errno, $fatal, $message) = @_;
318
319	$self->_shutdown
320	if $fatal;
321		523
322	$! = $errno;	524	$! = $errno;
		525	$message ||= "$!";
323		526
324	if ($self->{on_error}) {	527	if ($self->{on_error}) {
325	$self->{on_error}($self, $fatal);	528	$self->{on_error}($self, $fatal, $message);
326	} else {	529	$self->destroy if $fatal;
		530	} elsif ($self->{fh}) {
		531	$self->destroy;
327	Carp::croak "AnyEvent::Handle uncaught error: $!";	532	Carp::croak "AnyEvent::Handle uncaught error: $message";
328	}	533	}
329	}	534	}
330		535
331	=item $fh = $handle->fh	536	=item $fh = $handle->fh
332		537
333	This method returns the file handle of the L<AnyEvent::Handle> object.	538	This method returns the file handle used to create the L<AnyEvent::Handle> object.
334		539
335	=cut	540	=cut
336		541
337	sub fh { $_[0]{fh} }	542	sub fh { $_[0]{fh} }
338		543
…		…
356	$_[0]{on_eof} = $_[1];	561	$_[0]{on_eof} = $_[1];
357	}	562	}
358		563
359	=item $handle->on_timeout ($cb)	564	=item $handle->on_timeout ($cb)
360		565
361	Replace the current C<on_timeout> callback, or disables the callback	566	=item $handle->on_rtimeout ($cb)
362	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
363	argument.
364		567
365	=cut	568	=item $handle->on_wtimeout ($cb)
366		569
367	sub on_timeout {	570	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
368	$_[0]{on_timeout} = $_[1];	571	callback, or disables the callback (but not the timeout) if C<$cb> =
369	}	572	C<undef>. See the C<timeout> constructor argument and method.
		573
		574	=cut
		575
		576	# see below
370		577
371	=item $handle->autocork ($boolean)	578	=item $handle->autocork ($boolean)
372		579
373	Enables or disables the current autocork behaviour (see C<autocork>	580	Enables or disables the current autocork behaviour (see C<autocork>
374	constructor argument).	581	constructor argument). Changes will only take effect on the next write.
375		582
376	=cut	583	=cut
		584
		585	sub autocork {
		586	$_[0]{autocork} = $_[1];
		587	}
377		588
378	=item $handle->no_delay ($boolean)	589	=item $handle->no_delay ($boolean)
379		590
380	Enables or disables the C<no_delay> setting (see constructor argument of	591	Enables or disables the C<no_delay> setting (see constructor argument of
381	the same name for details).	592	the same name for details).
…		…
385	sub no_delay {	596	sub no_delay {
386	$_[0]{no_delay} = $_[1];	597	$_[0]{no_delay} = $_[1];
387		598
388	eval {	599	eval {
389	local $SIG{__DIE__};	600	local $SIG{__DIE__};
390	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	601	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		602	if $_[0]{fh};
391	};	603	};
392	}	604	}
393		605
		606	=item $handle->on_starttls ($cb)
		607
		608	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		609
		610	=cut
		611
		612	sub on_starttls {
		613	$_[0]{on_starttls} = $_[1];
		614	}
		615
		616	=item $handle->on_stoptls ($cb)
		617
		618	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		619
		620	=cut
		621
		622	sub on_starttls {
		623	$_[0]{on_stoptls} = $_[1];
		624	}
		625
		626	=item $handle->rbuf_max ($max_octets)
		627
		628	Configures the C<rbuf_max> setting (C<undef> disables it).
		629
		630	=cut
		631
		632	sub rbuf_max {
		633	$_[0]{rbuf_max} = $_[1];
		634	}
		635
394	#############################################################################	636	#############################################################################
395		637
396	=item $handle->timeout ($seconds)	638	=item $handle->timeout ($seconds)
397		639
		640	=item $handle->rtimeout ($seconds)
		641
		642	=item $handle->wtimeout ($seconds)
		643
398	Configures (or disables) the inactivity timeout.	644	Configures (or disables) the inactivity timeout.
399		645
400	=cut	646	=item $handle->timeout_reset
401		647
402	sub timeout {	648	=item $handle->rtimeout_reset
		649
		650	=item $handle->wtimeout_reset
		651
		652	Reset the activity timeout, as if data was received or sent.
		653
		654	These methods are cheap to call.
		655
		656	=cut
		657
		658	for my $dir ("", "r", "w") {
		659	my $timeout = "${dir}timeout";
		660	my $tw = "_${dir}tw";
		661	my $on_timeout = "on_${dir}timeout";
		662	my $activity = "_${dir}activity";
		663	my $cb;
		664
		665	*$on_timeout = sub {
		666	$_[0]{$on_timeout} = $_[1];
		667	};
		668
		669	*$timeout = sub {
403	my ($self, $timeout) = @_;	670	my ($self, $new_value) = @_;
404		671
405	$self->{timeout} = $timeout;	672	$self->{$timeout} = $new_value;
406	$self->_timeout;	673	delete $self->{$tw}; &$cb;
407	}	674	};
408		675
		676	*{"${dir}timeout_reset"} = sub {
		677	$_[0]{$activity} = AE::now;
		678	};
		679
		680	# main workhorse:
409	# reset the timeout watcher, as neccessary	681	# reset the timeout watcher, as neccessary
410	# also check for time-outs	682	# also check for time-outs
411	sub _timeout {	683	$cb = sub {
412	my ($self) = @_;	684	my ($self) = @_;
413		685
414	if ($self->{timeout}) {	686	if ($self->{$timeout} && $self->{fh}) {
415	my $NOW = AnyEvent->now;	687	my $NOW = AE::now;
416		688
417	# when would the timeout trigger?	689	# when would the timeout trigger?
418	my $after = $self->{_activity} + $self->{timeout} - $NOW;	690	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
419		691
420	# now or in the past already?	692	# now or in the past already?
421	if ($after <= 0) {	693	if ($after <= 0) {
422	$self->{_activity} = $NOW;	694	$self->{$activity} = $NOW;
423		695
424	if ($self->{on_timeout}) {	696	if ($self->{$on_timeout}) {
425	$self->{on_timeout}($self);	697	$self->{$on_timeout}($self);
426	} else {	698	} else {
427	$self->_error (&Errno::ETIMEDOUT);	699	$self->_error (Errno::ETIMEDOUT);
		700	}
		701
		702	# callback could have changed timeout value, optimise
		703	return unless $self->{$timeout};
		704
		705	# calculate new after
		706	$after = $self->{$timeout};
428	}	707	}
429		708
430	# callback could have changed timeout value, optimise	709	Scalar::Util::weaken $self;
431	return unless $self->{timeout};	710	return unless $self; # ->error could have destroyed $self
432		711
433	# calculate new after	712	$self->{$tw} ||= AE::timer $after, 0, sub {
434	$after = $self->{timeout};	713	delete $self->{$tw};
		714	$cb->($self);
		715	};
		716	} else {
		717	delete $self->{$tw};
435	}	718	}
436
437	Scalar::Util::weaken $self;
438	return unless $self; # ->error could have destroyed $self
439
440	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
441	delete $self->{_tw};
442	$self->_timeout;
443	});
444	} else {
445	delete $self->{_tw};
446	}	719	}
447	}	720	}
448		721
449	#############################################################################	722	#############################################################################
450		723
…		…
474	my ($self, $cb) = @_;	747	my ($self, $cb) = @_;
475		748
476	$self->{on_drain} = $cb;	749	$self->{on_drain} = $cb;
477		750
478	$cb->($self)	751	$cb->($self)
479	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	752	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
480	}	753	}
481		754
482	=item $handle->push_write ($data)	755	=item $handle->push_write ($data)
483		756
484	Queues the given scalar to be written. You can push as much data as you	757	Queues the given scalar to be written. You can push as much data as you
…		…
495	Scalar::Util::weaken $self;	768	Scalar::Util::weaken $self;
496		769
497	my $cb = sub {	770	my $cb = sub {
498	my $len = syswrite $self->{fh}, $self->{wbuf};	771	my $len = syswrite $self->{fh}, $self->{wbuf};
499		772
500	if ($len >= 0) {	773	if (defined $len) {
501	substr $self->{wbuf}, 0, $len, "";	774	substr $self->{wbuf}, 0, $len, "";
502		775
503	$self->{_activity} = AnyEvent->now;	776	$self->{_activity} = $self->{_wactivity} = AE::now;
504		777
505	$self->{on_drain}($self)	778	$self->{on_drain}($self)
506	if $self->{low_water_mark} >= length $self->{wbuf}	779	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
507	&& $self->{on_drain};	780	&& $self->{on_drain};
508		781
509	delete $self->{_ww} unless length $self->{wbuf};	782	delete $self->{_ww} unless length $self->{wbuf};
510	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	783	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
511	$self->_error ($!, 1);	784	$self->_error ($!, 1);
…		…
514		787
515	# try to write data immediately	788	# try to write data immediately
516	$cb->() unless $self->{autocork};	789	$cb->() unless $self->{autocork};
517		790
518	# if still data left in wbuf, we need to poll	791	# if still data left in wbuf, we need to poll
519	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	792	$self->{_ww} = AE::io $self->{fh}, 1, $cb
520	if length $self->{wbuf};	793	if length $self->{wbuf};
521	};	794	};
522	}	795	}
523		796
524	our %WH;	797	our %WH;
…		…
535		808
536	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	809	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
537	->($self, @_);	810	->($self, @_);
538	}	811	}
539		812
540	if ($self->{filter_w}) {	813	if ($self->{tls}) {
541	$self->{filter_w}($self, \$_[0]);	814	$self->{_tls_wbuf} .= $_[0];
		815	&_dotls ($self) if $self->{fh};
542	} else {	816	} else {
543	$self->{wbuf} .= $_[0];	817	$self->{wbuf} .= $_[0];
544	$self->_drain_wbuf;	818	$self->_drain_wbuf if $self->{fh};
545	}	819	}
546	}	820	}
547		821
548	=item $handle->push_write (type => @args)	822	=item $handle->push_write (type => @args)
549		823
…		…
563	=cut	837	=cut
564		838
565	register_write_type netstring => sub {	839	register_write_type netstring => sub {
566	my ($self, $string) = @_;	840	my ($self, $string) = @_;
567		841
568	sprintf "%d:%s,", (length $string), $string	842	(length $string) . ":$string,"
569	};	843	};
570		844
571	=item packstring => $format, $data	845	=item packstring => $format, $data
572		846
573	An octet string prefixed with an encoded length. The encoding C<$format>	847	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
638		912
639	pack "w/a*", Storable::nfreeze ($ref)	913	pack "w/a*", Storable::nfreeze ($ref)
640	};	914	};
641		915
642	=back	916	=back
		917
		918	=item $handle->push_shutdown
		919
		920	Sometimes you know you want to close the socket after writing your data
		921	before it was actually written. One way to do that is to replace your
		922	C<on_drain> handler by a callback that shuts down the socket (and set
		923	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		924	replaces the C<on_drain> callback with:
		925
		926	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		927
		928	This simply shuts down the write side and signals an EOF condition to the
		929	the peer.
		930
		931	You can rely on the normal read queue and C<on_eof> handling
		932	afterwards. This is the cleanest way to close a connection.
		933
		934	=cut
		935
		936	sub push_shutdown {
		937	my ($self) = @_;
		938
		939	delete $self->{low_water_mark};
		940	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		941	}
643		942
644	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	943	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
645		944
646	This function (not method) lets you add your own types to C<push_write>.	945	This function (not method) lets you add your own types to C<push_write>.
647	Whenever the given C<type> is used, C<push_write> will invoke the code	946	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
741	=cut	1040	=cut
742		1041
743	sub _drain_rbuf {	1042	sub _drain_rbuf {
744	my ($self) = @_;	1043	my ($self) = @_;
745		1044
		1045	# avoid recursion
		1046	return if $self->{_skip_drain_rbuf};
746	local $self->{_in_drain} = 1;	1047	local $self->{_skip_drain_rbuf} = 1;
747
748	if (
749	defined $self->{rbuf_max}
750	&& $self->{rbuf_max} < length $self->{rbuf}
751	) {
752	$self->_error (&Errno::ENOSPC, 1), return;
753	}
754		1048
755	while () {	1049	while () {
		1050	# we need to use a separate tls read buffer, as we must not receive data while
		1051	# we are draining the buffer, and this can only happen with TLS.
		1052	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1053	if exists $self->{_tls_rbuf};
		1054
756	my $len = length $self->{rbuf};	1055	my $len = length $self->{rbuf};
757		1056
758	if (my $cb = shift @{ $self->{_queue} }) {	1057	if (my $cb = shift @{ $self->{_queue} }) {
759	unless ($cb->($self)) {	1058	unless ($cb->($self)) {
760	if ($self->{_eof}) {	1059	# no progress can be made
761	# no progress can be made (not enough data and no data forthcoming)	1060	# (not enough data and no data forthcoming)
762	$self->_error (&Errno::EPIPE, 1), return;	1061	$self->_error (Errno::EPIPE, 1), return
763	}	1062	if $self->{_eof};
764		1063
765	unshift @{ $self->{_queue} }, $cb;	1064	unshift @{ $self->{_queue} }, $cb;
766	last;	1065	last;
767	}	1066	}
768	} elsif ($self->{on_read}) {	1067	} elsif ($self->{on_read}) {
…		…
775	&& !@{ $self->{_queue} } # and the queue is still empty	1074	&& !@{ $self->{_queue} } # and the queue is still empty
776	&& $self->{on_read} # but we still have on_read	1075	&& $self->{on_read} # but we still have on_read
777	) {	1076	) {
778	# no further data will arrive	1077	# no further data will arrive
779	# so no progress can be made	1078	# so no progress can be made
780	$self->_error (&Errno::EPIPE, 1), return	1079	$self->_error (Errno::EPIPE, 1), return
781	if $self->{_eof};	1080	if $self->{_eof};
782		1081
783	last; # more data might arrive	1082	last; # more data might arrive
784	}	1083	}
785	} else {	1084	} else {
786	# read side becomes idle	1085	# read side becomes idle
787	delete $self->{_rw};	1086	delete $self->{_rw} unless $self->{tls};
788	last;	1087	last;
789	}	1088	}
790	}	1089	}
791		1090
792	if ($self->{_eof}) {	1091	if ($self->{_eof}) {
793	if ($self->{on_eof}) {	1092	$self->{on_eof}
794	$self->{on_eof}($self)	1093	? $self->{on_eof}($self)
795	} else {	1094	: $self->_error (0, 1, "Unexpected end-of-file");
796	$self->_error (0, 1);	1095
797	}	1096	return;
		1097	}
		1098
		1099	if (
		1100	defined $self->{rbuf_max}
		1101	&& $self->{rbuf_max} < length $self->{rbuf}
		1102	) {
		1103	$self->_error (Errno::ENOSPC, 1), return;
798	}	1104	}
799		1105
800	# may need to restart read watcher	1106	# may need to restart read watcher
801	unless ($self->{_rw}) {	1107	unless ($self->{_rw}) {
802	$self->start_read	1108	$self->start_read
…		…
814		1120
815	sub on_read {	1121	sub on_read {
816	my ($self, $cb) = @_;	1122	my ($self, $cb) = @_;
817		1123
818	$self->{on_read} = $cb;	1124	$self->{on_read} = $cb;
819	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1125	$self->_drain_rbuf if $cb;
820	}	1126	}
821		1127
822	=item $handle->rbuf	1128	=item $handle->rbuf
823		1129
824	Returns the read buffer (as a modifiable lvalue).	1130	Returns the read buffer (as a modifiable lvalue).
825		1131
826	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1132	You can access the read buffer directly as the C<< ->{rbuf} >>
827	you want.	1133	member, if you want. However, the only operation allowed on the
		1134	read buffer (apart from looking at it) is removing data from its
		1135	beginning. Otherwise modifying or appending to it is not allowed and will
		1136	lead to hard-to-track-down bugs.
828		1137
829	NOTE: The read buffer should only be used or modified if the C<on_read>,	1138	NOTE: The read buffer should only be used or modified if the C<on_read>,
830	C<push_read> or C<unshift_read> methods are used. The other read methods	1139	C<push_read> or C<unshift_read> methods are used. The other read methods
831	automatically manage the read buffer.	1140	automatically manage the read buffer.
832		1141
…		…
873	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1182	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
874	->($self, $cb, @_);	1183	->($self, $cb, @_);
875	}	1184	}
876		1185
877	push @{ $self->{_queue} }, $cb;	1186	push @{ $self->{_queue} }, $cb;
878	$self->_drain_rbuf unless $self->{_in_drain};	1187	$self->_drain_rbuf;
879	}	1188	}
880		1189
881	sub unshift_read {	1190	sub unshift_read {
882	my $self = shift;	1191	my $self = shift;
883	my $cb = pop;	1192	my $cb = pop;
…		…
889	->($self, $cb, @_);	1198	->($self, $cb, @_);
890	}	1199	}
891		1200
892		1201
893	unshift @{ $self->{_queue} }, $cb;	1202	unshift @{ $self->{_queue} }, $cb;
894	$self->_drain_rbuf unless $self->{_in_drain};	1203	$self->_drain_rbuf;
895	}	1204	}
896		1205
897	=item $handle->push_read (type => @args, $cb)	1206	=item $handle->push_read (type => @args, $cb)
898		1207
899	=item $handle->unshift_read (type => @args, $cb)	1208	=item $handle->unshift_read (type => @args, $cb)
…		…
1032	return 1;	1341	return 1;
1033	}	1342	}
1034		1343
1035	# reject	1344	# reject
1036	if ($reject && $$rbuf =~ $reject) {	1345	if ($reject && $$rbuf =~ $reject) {
1037	$self->_error (&Errno::EBADMSG);	1346	$self->_error (Errno::EBADMSG);
1038	}	1347	}
1039		1348
1040	# skip	1349	# skip
1041	if ($skip && $$rbuf =~ $skip) {	1350	if ($skip && $$rbuf =~ $skip) {
1042	$data .= substr $$rbuf, 0, $+[0], "";	1351	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1058	my ($self, $cb) = @_;	1367	my ($self, $cb) = @_;
1059		1368
1060	sub {	1369	sub {
1061	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1370	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1062	if ($_[0]{rbuf} =~ /[^0-9]/) {	1371	if ($_[0]{rbuf} =~ /[^0-9]/) {
1063	$self->_error (&Errno::EBADMSG);	1372	$self->_error (Errno::EBADMSG);
1064	}	1373	}
1065	return;	1374	return;
1066	}	1375	}
1067		1376
1068	my $len = $1;	1377	my $len = $1;
…		…
1071	my $string = $_[1];	1380	my $string = $_[1];
1072	$_[0]->unshift_read (chunk => 1, sub {	1381	$_[0]->unshift_read (chunk => 1, sub {
1073	if ($_[1] eq ",") {	1382	if ($_[1] eq ",") {
1074	$cb->($_[0], $string);	1383	$cb->($_[0], $string);
1075	} else {	1384	} else {
1076	$self->_error (&Errno::EBADMSG);	1385	$self->_error (Errno::EBADMSG);
1077	}	1386	}
1078	});	1387	});
1079	});	1388	});
1080		1389
1081	1	1390	1
…		…
1087	An octet string prefixed with an encoded length. The encoding C<$format>	1396	An octet string prefixed with an encoded length. The encoding C<$format>
1088	uses the same format as a Perl C<pack> format, but must specify a single	1397	uses the same format as a Perl C<pack> format, but must specify a single
1089	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1398	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1090	optional C<!>, C<< < >> or C<< > >> modifier).	1399	optional C<!>, C<< < >> or C<< > >> modifier).
1091		1400
1092	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1401	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1402	EPP uses a prefix of C<N> (4 octtes).
1093		1403
1094	Example: read a block of data prefixed by its length in BER-encoded	1404	Example: read a block of data prefixed by its length in BER-encoded
1095	format (very efficient).	1405	format (very efficient).
1096		1406
1097	$handle->push_read (packstring => "w", sub {	1407	$handle->push_read (packstring => "w", sub {
…		…
1127	}	1437	}
1128	};	1438	};
1129		1439
1130	=item json => $cb->($handle, $hash_or_arrayref)	1440	=item json => $cb->($handle, $hash_or_arrayref)
1131		1441
1132	Reads a JSON object or array, decodes it and passes it to the callback.	1442	Reads a JSON object or array, decodes it and passes it to the
		1443	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1133		1444
1134	If a C<json> object was passed to the constructor, then that will be used	1445	If a C<json> object was passed to the constructor, then that will be used
1135	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1446	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1136		1447
1137	This read type uses the incremental parser available with JSON version	1448	This read type uses the incremental parser available with JSON version
…		…
1146	=cut	1457	=cut
1147		1458
1148	register_read_type json => sub {	1459	register_read_type json => sub {
1149	my ($self, $cb) = @_;	1460	my ($self, $cb) = @_;
1150		1461
1151	require JSON;	1462	my $json = $self->{json} ||=
		1463	eval { require JSON::XS; JSON::XS->new->utf8 }
		1464	|| do { require JSON; JSON->new->utf8 };
1152		1465
1153	my $data;	1466	my $data;
1154	my $rbuf = \$self->{rbuf};	1467	my $rbuf = \$self->{rbuf};
1155		1468
1156	my $json = $self->{json} ||= JSON->new->utf8;
1157
1158	sub {	1469	sub {
1159	my $ref = $json->incr_parse ($self->{rbuf});	1470	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1160		1471
1161	if ($ref) {	1472	if ($ref) {
1162	$self->{rbuf} = $json->incr_text;	1473	$self->{rbuf} = $json->incr_text;
1163	$json->incr_text = "";	1474	$json->incr_text = "";
1164	$cb->($self, $ref);	1475	$cb->($self, $ref);
1165		1476
1166	1	1477	1
		1478	} elsif ($@) {
		1479	# error case
		1480	$json->incr_skip;
		1481
		1482	$self->{rbuf} = $json->incr_text;
		1483	$json->incr_text = "";
		1484
		1485	$self->_error (Errno::EBADMSG);
		1486
		1487	()
1167	} else {	1488	} else {
1168	$self->{rbuf} = "";	1489	$self->{rbuf} = "";
		1490
1169	()	1491	()
1170	}	1492	}
1171	}	1493	}
1172	};	1494	};
1173		1495
…		…
1205	# read remaining chunk	1527	# read remaining chunk
1206	$_[0]->unshift_read (chunk => $len, sub {	1528	$_[0]->unshift_read (chunk => $len, sub {
1207	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1529	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1208	$cb->($_[0], $ref);	1530	$cb->($_[0], $ref);
1209	} else {	1531	} else {
1210	$self->_error (&Errno::EBADMSG);	1532	$self->_error (Errno::EBADMSG);
1211	}	1533	}
1212	});	1534	});
1213	}	1535	}
1214		1536
1215	1	1537	1
…		…
1250	Note that AnyEvent::Handle will automatically C<start_read> for you when	1572	Note that AnyEvent::Handle will automatically C<start_read> for you when
1251	you change the C<on_read> callback or push/unshift a read callback, and it	1573	you change the C<on_read> callback or push/unshift a read callback, and it
1252	will automatically C<stop_read> for you when neither C<on_read> is set nor	1574	will automatically C<stop_read> for you when neither C<on_read> is set nor
1253	there are any read requests in the queue.	1575	there are any read requests in the queue.
1254		1576
		1577	These methods will have no effect when in TLS mode (as TLS doesn't support
		1578	half-duplex connections).
		1579
1255	=cut	1580	=cut
1256		1581
1257	sub stop_read {	1582	sub stop_read {
1258	my ($self) = @_;	1583	my ($self) = @_;
1259		1584
1260	delete $self->{_rw};	1585	delete $self->{_rw} unless $self->{tls};
1261	}	1586	}
1262		1587
1263	sub start_read {	1588	sub start_read {
1264	my ($self) = @_;	1589	my ($self) = @_;
1265		1590
1266	unless ($self->{_rw} || $self->{_eof}) {	1591	unless ($self->{_rw} || $self->{_eof}) {
1267	Scalar::Util::weaken $self;	1592	Scalar::Util::weaken $self;
1268		1593
1269	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1594	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1270	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1595	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1271	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1596	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1272		1597
1273	if ($len > 0) {	1598	if ($len > 0) {
1274	$self->{_activity} = AnyEvent->now;	1599	$self->{_activity} = $self->{_ractivity} = AE::now;
1275		1600
1276	$self->{filter_r}	1601	if ($self->{tls}) {
1277	? $self->{filter_r}($self, $rbuf)	1602	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1278	: $self->{_in_drain} || $self->_drain_rbuf;	1603
		1604	&_dotls ($self);
		1605	} else {
		1606	$self->_drain_rbuf;
		1607	}
1279		1608
1280	} elsif (defined $len) {	1609	} elsif (defined $len) {
1281	delete $self->{_rw};	1610	delete $self->{_rw};
1282	$self->{_eof} = 1;	1611	$self->{_eof} = 1;
1283	$self->_drain_rbuf unless $self->{_in_drain};	1612	$self->_drain_rbuf;
1284		1613
1285	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1614	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1286	return $self->_error ($!, 1);	1615	return $self->_error ($!, 1);
1287	}	1616	}
1288	});	1617	};
1289	}	1618	}
1290	}	1619	}
1291		1620
		1621	our $ERROR_SYSCALL;
		1622	our $ERROR_WANT_READ;
		1623
		1624	sub _tls_error {
		1625	my ($self, $err) = @_;
		1626
		1627	return $self->_error ($!, 1)
		1628	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1629
		1630	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1631
		1632	# reduce error string to look less scary
		1633	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1634
		1635	if ($self->{_on_starttls}) {
		1636	(delete $self->{_on_starttls})->($self, undef, $err);
		1637	&_freetls;
		1638	} else {
		1639	&_freetls;
		1640	$self->_error (Errno::EPROTO, 1, $err);
		1641	}
		1642	}
		1643
		1644	# poll the write BIO and send the data if applicable
		1645	# also decode read data if possible
		1646	# this is basiclaly our TLS state machine
		1647	# more efficient implementations are possible with openssl,
		1648	# but not with the buggy and incomplete Net::SSLeay.
1292	sub _dotls {	1649	sub _dotls {
1293	my ($self) = @_;	1650	my ($self) = @_;
1294		1651
1295	my $buf;	1652	my $tmp;
1296		1653
1297	if (length $self->{_tls_wbuf}) {	1654	if (length $self->{_tls_wbuf}) {
1298	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1655	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1299	substr $self->{_tls_wbuf}, 0, $len, "";	1656	substr $self->{_tls_wbuf}, 0, $tmp, "";
1300	}	1657	}
1301	}
1302		1658
		1659	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1660	return $self->_tls_error ($tmp)
		1661	if $tmp != $ERROR_WANT_READ
		1662	&& ($tmp != $ERROR_SYSCALL || $!);
		1663	}
		1664
		1665	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1666	unless (length $tmp) {
		1667	$self->{_on_starttls}
		1668	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1669	&_freetls;
		1670
		1671	if ($self->{on_stoptls}) {
		1672	$self->{on_stoptls}($self);
		1673	return;
		1674	} else {
		1675	# let's treat SSL-eof as we treat normal EOF
		1676	delete $self->{_rw};
		1677	$self->{_eof} = 1;
		1678	}
		1679	}
		1680
		1681	$self->{_tls_rbuf} .= $tmp;
		1682	$self->_drain_rbuf;
		1683	$self->{tls} or return; # tls session might have gone away in callback
		1684	}
		1685
		1686	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1687	return $self->_tls_error ($tmp)
		1688	if $tmp != $ERROR_WANT_READ
		1689	&& ($tmp != $ERROR_SYSCALL || $!);
		1690
1303	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1691	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1304	$self->{wbuf} .= $buf;	1692	$self->{wbuf} .= $tmp;
1305	$self->_drain_wbuf;	1693	$self->_drain_wbuf;
1306	}	1694	}
1307		1695
1308	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1696	$self->{_on_starttls}
1309	if (length $buf) {	1697	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1310	$self->{rbuf} .= $buf;	1698	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1311	$self->_drain_rbuf unless $self->{_in_drain};
1312	} else {
1313	# let's treat SSL-eof as we treat normal EOF
1314	$self->{_eof} = 1;
1315	$self->_shutdown;
1316	return;
1317	}
1318	}
1319
1320	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1321
1322	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1323	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1324	return $self->_error ($!, 1);
1325	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1326	return $self->_error (&Errno::EIO, 1);
1327	}
1328
1329	# all others are fine for our purposes
1330	}
1331	}	1699	}
1332		1700
1333	=item $handle->starttls ($tls[, $tls_ctx])	1701	=item $handle->starttls ($tls[, $tls_ctx])
1334		1702
1335	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1703	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1336	object is created, you can also do that at a later time by calling	1704	object is created, you can also do that at a later time by calling
1337	C<starttls>.	1705	C<starttls>.
1338		1706
		1707	Starting TLS is currently an asynchronous operation - when you push some
		1708	write data and then call C<< ->starttls >> then TLS negotiation will start
		1709	immediately, after which the queued write data is then sent.
		1710
1339	The first argument is the same as the C<tls> constructor argument (either	1711	The first argument is the same as the C<tls> constructor argument (either
1340	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1712	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1341		1713
1342	The second argument is the optional C<Net::SSLeay::CTX> object that is	1714	The second argument is the optional C<AnyEvent::TLS> object that is used
1343	used when AnyEvent::Handle has to create its own TLS connection object.	1715	when AnyEvent::Handle has to create its own TLS connection object, or
		1716	a hash reference with C<< key => value >> pairs that will be used to
		1717	construct a new context.
1344		1718
1345	The TLS connection object will end up in C<< $handle->{tls} >> after this	1719	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1346	call and can be used or changed to your liking. Note that the handshake	1720	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1347	might have already started when this function returns.	1721	changed to your liking. Note that the handshake might have already started
		1722	when this function returns.
1348		1723
		1724	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		1725	handshakes on the same stream. Best do not attempt to use the stream after
		1726	stopping TLS.
		1727
1349	=cut	1728	=cut
		1729
		1730	our %TLS_CACHE; #TODO not yet documented, should we?
1350		1731
1351	sub starttls {	1732	sub starttls {
1352	my ($self, $ssl, $ctx) = @_;	1733	my ($self, $tls, $ctx) = @_;
1353		1734
1354	$self->stoptls;	1735	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1736	if $self->{tls};
1355		1737
1356	if ($ssl eq "accept") {	1738	$self->{tls} = $tls;
1357	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1739	$self->{tls_ctx} = $ctx if @_ > 2;
1358	Net::SSLeay::set_accept_state ($ssl);	1740
1359	} elsif ($ssl eq "connect") {	1741	return unless $self->{fh};
1360	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1742
1361	Net::SSLeay::set_connect_state ($ssl);	1743	require Net::SSLeay;
		1744
		1745	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1746	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1747
		1748	$tls = $self->{tls};
		1749	$ctx = $self->{tls_ctx};
		1750
		1751	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1752
		1753	if ("HASH" eq ref $ctx) {
		1754	require AnyEvent::TLS;
		1755
		1756	if ($ctx->{cache}) {
		1757	my $key = $ctx+0;
		1758	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1759	} else {
		1760	$ctx = new AnyEvent::TLS %$ctx;
		1761	}
		1762	}
1362	}	1763
1363		1764	$self->{tls_ctx} = $ctx || TLS_CTX ();
1364	$self->{tls} = $ssl;	1765	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1365		1766
1366	# basically, this is deep magic (because SSL_read should have the same issues)	1767	# basically, this is deep magic (because SSL_read should have the same issues)
1367	# but the openssl maintainers basically said: "trust us, it just works".	1768	# but the openssl maintainers basically said: "trust us, it just works".
1368	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1769	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1369	# and mismaintained ssleay-module doesn't even offer them).	1770	# and mismaintained ssleay-module doesn't even offer them).
1370	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1771	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1772	#
		1773	# in short: this is a mess.
		1774	#
		1775	# note that we do not try to keep the length constant between writes as we are required to do.
		1776	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1777	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1778	# have identity issues in that area.
1371	Net::SSLeay::CTX_set_mode ($self->{tls},	1779	# Net::SSLeay::CTX_set_mode ($ssl,
1372	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1780	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1373	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1781	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1782	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1374		1783
1375	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1784	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1376	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1785	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1377		1786
		1787	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1788
1378	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1789	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1379		1790
1380	$self->{filter_w} = sub {	1791	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1381	$_[0]{_tls_wbuf} .= ${$_[1]};	1792	if $self->{on_starttls};
1382	&_dotls;	1793
1383	};	1794	&_dotls; # need to trigger the initial handshake
1384	$self->{filter_r} = sub {	1795	$self->start_read; # make sure we actually do read
1385	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1386	&_dotls;
1387	};
1388	}	1796	}
1389		1797
1390	=item $handle->stoptls	1798	=item $handle->stoptls
1391		1799
1392	Destroys the SSL connection, if any. Partial read or write data will be	1800	Shuts down the SSL connection - this makes a proper EOF handshake by
1393	lost.	1801	sending a close notify to the other side, but since OpenSSL doesn't
		1802	support non-blocking shut downs, it is not guarenteed that you can re-use
		1803	the stream afterwards.
1394		1804
1395	=cut	1805	=cut
1396		1806
1397	sub stoptls {	1807	sub stoptls {
1398	my ($self) = @_;	1808	my ($self) = @_;
1399		1809
1400	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1810	if ($self->{tls}) {
		1811	Net::SSLeay::shutdown ($self->{tls});
1401		1812
1402	delete $self->{_rbio};	1813	&_dotls;
1403	delete $self->{_wbio};	1814
1404	delete $self->{_tls_wbuf};	1815	# # we don't give a shit. no, we do, but we can't. no...#d#
1405	delete $self->{filter_r};	1816	# # we, we... have to use openssl :/#d#
1406	delete $self->{filter_w};	1817	# &_freetls;#d#
		1818	}
		1819	}
		1820
		1821	sub _freetls {
		1822	my ($self) = @_;
		1823
		1824	return unless $self->{tls};
		1825
		1826	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1827	if $self->{tls} > 0;
		1828
		1829	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1407	}	1830	}
1408		1831
1409	sub DESTROY {	1832	sub DESTROY {
1410	my $self = shift;	1833	my ($self) = @_;
1411		1834
1412	$self->stoptls;	1835	&_freetls;
1413		1836
1414	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1837	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1415		1838
1416	if ($linger && length $self->{wbuf}) {	1839	if ($linger && length $self->{wbuf} && $self->{fh}) {
1417	my $fh = delete $self->{fh};	1840	my $fh = delete $self->{fh};
1418	my $wbuf = delete $self->{wbuf};	1841	my $wbuf = delete $self->{wbuf};
1419		1842
1420	my @linger;	1843	my @linger;
1421		1844
1422	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1845	push @linger, AE::io $fh, 1, sub {
1423	my $len = syswrite $fh, $wbuf, length $wbuf;	1846	my $len = syswrite $fh, $wbuf, length $wbuf;
1424		1847
1425	if ($len > 0) {	1848	if ($len > 0) {
1426	substr $wbuf, 0, $len, "";	1849	substr $wbuf, 0, $len, "";
1427	} else {	1850	} else {
1428	@linger = (); # end	1851	@linger = (); # end
1429	}	1852	}
1430	});	1853	};
1431	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1854	push @linger, AE::timer $linger, 0, sub {
1432	@linger = ();	1855	@linger = ();
1433	});	1856	};
1434	}	1857	}
		1858	}
		1859
		1860	=item $handle->destroy
		1861
		1862	Shuts down the handle object as much as possible - this call ensures that
		1863	no further callbacks will be invoked and as many resources as possible
		1864	will be freed. Any method you will call on the handle object after
		1865	destroying it in this way will be silently ignored (and it will return the
		1866	empty list).
		1867
		1868	Normally, you can just "forget" any references to an AnyEvent::Handle
		1869	object and it will simply shut down. This works in fatal error and EOF
		1870	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1871	callback, so when you want to destroy the AnyEvent::Handle object from
		1872	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1873	that case.
		1874
		1875	Destroying the handle object in this way has the advantage that callbacks
		1876	will be removed as well, so if those are the only reference holders (as
		1877	is common), then one doesn't need to do anything special to break any
		1878	reference cycles.
		1879
		1880	The handle might still linger in the background and write out remaining
		1881	data, as specified by the C<linger> option, however.
		1882
		1883	=cut
		1884
		1885	sub destroy {
		1886	my ($self) = @_;
		1887
		1888	$self->DESTROY;
		1889	%$self = ();
		1890	bless $self, "AnyEvent::Handle::destroyed";
		1891	}
		1892
		1893	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1894	#nop
1435	}	1895	}
1436		1896
1437	=item AnyEvent::Handle::TLS_CTX	1897	=item AnyEvent::Handle::TLS_CTX
1438		1898
1439	This function creates and returns the Net::SSLeay::CTX object used by	1899	This function creates and returns the AnyEvent::TLS object used by default
1440	default for TLS mode.	1900	for TLS mode.
1441		1901
1442	The context is created like this:	1902	The context is created by calling L<AnyEvent::TLS> without any arguments.
1443
1444	Net::SSLeay::load_error_strings;
1445	Net::SSLeay::SSLeay_add_ssl_algorithms;
1446	Net::SSLeay::randomize;
1447
1448	my $CTX = Net::SSLeay::CTX_new;
1449
1450	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1451		1903
1452	=cut	1904	=cut
1453		1905
1454	our $TLS_CTX;	1906	our $TLS_CTX;
1455		1907
1456	sub TLS_CTX() {	1908	sub TLS_CTX() {
1457	$TLS_CTX || do {	1909	$TLS_CTX ||= do {
1458	require Net::SSLeay;	1910	require AnyEvent::TLS;
1459		1911
1460	Net::SSLeay::load_error_strings ();	1912	new AnyEvent::TLS
1461	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1462	Net::SSLeay::randomize ();
1463
1464	$TLS_CTX = Net::SSLeay::CTX_new ();
1465
1466	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1467
1468	$TLS_CTX
1469	}	1913	}
1470	}	1914	}
1471		1915
1472	=back	1916	=back
		1917
		1918
		1919	=head1 NONFREQUENTLY ASKED QUESTIONS
		1920
		1921	=over 4
		1922
		1923	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1924	still get further invocations!
		1925
		1926	That's because AnyEvent::Handle keeps a reference to itself when handling
		1927	read or write callbacks.
		1928
		1929	It is only safe to "forget" the reference inside EOF or error callbacks,
		1930	from within all other callbacks, you need to explicitly call the C<<
		1931	->destroy >> method.
		1932
		1933	=item I get different callback invocations in TLS mode/Why can't I pause
		1934	reading?
		1935
		1936	Unlike, say, TCP, TLS connections do not consist of two independent
		1937	communication channels, one for each direction. Or put differently. The
		1938	read and write directions are not independent of each other: you cannot
		1939	write data unless you are also prepared to read, and vice versa.
		1940
		1941	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1942	callback invocations when you are not expecting any read data - the reason
		1943	is that AnyEvent::Handle always reads in TLS mode.
		1944
		1945	During the connection, you have to make sure that you always have a
		1946	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1947	connection (or when you no longer want to use it) you can call the
		1948	C<destroy> method.
		1949
		1950	=item How do I read data until the other side closes the connection?
		1951
		1952	If you just want to read your data into a perl scalar, the easiest way
		1953	to achieve this is by setting an C<on_read> callback that does nothing,
		1954	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1955	will be in C<$_[0]{rbuf}>:
		1956
		1957	$handle->on_read (sub { });
		1958	$handle->on_eof (undef);
		1959	$handle->on_error (sub {
		1960	my $data = delete $_[0]{rbuf};
		1961	});
		1962
		1963	The reason to use C<on_error> is that TCP connections, due to latencies
		1964	and packets loss, might get closed quite violently with an error, when in
		1965	fact, all data has been received.
		1966
		1967	It is usually better to use acknowledgements when transferring data,
		1968	to make sure the other side hasn't just died and you got the data
		1969	intact. This is also one reason why so many internet protocols have an
		1970	explicit QUIT command.
		1971
		1972	=item I don't want to destroy the handle too early - how do I wait until
		1973	all data has been written?
		1974
		1975	After writing your last bits of data, set the C<on_drain> callback
		1976	and destroy the handle in there - with the default setting of
		1977	C<low_water_mark> this will be called precisely when all data has been
		1978	written to the socket:
		1979
		1980	$handle->push_write (...);
		1981	$handle->on_drain (sub {
		1982	warn "all data submitted to the kernel\n";
		1983	undef $handle;
		1984	});
		1985
		1986	If you just want to queue some data and then signal EOF to the other side,
		1987	consider using C<< ->push_shutdown >> instead.
		1988
		1989	=item I want to contact a TLS/SSL server, I don't care about security.
		1990
		1991	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1992	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1993	parameter:
		1994
		1995	tcp_connect $host, $port, sub {
		1996	my ($fh) = @_;
		1997
		1998	my $handle = new AnyEvent::Handle
		1999	fh => $fh,
		2000	tls => "connect",
		2001	on_error => sub { ... };
		2002
		2003	$handle->push_write (...);
		2004	};
		2005
		2006	=item I want to contact a TLS/SSL server, I do care about security.
		2007
		2008	Then you should additionally enable certificate verification, including
		2009	peername verification, if the protocol you use supports it (see
		2010	L<AnyEvent::TLS>, C<verify_peername>).
		2011
		2012	E.g. for HTTPS:
		2013
		2014	tcp_connect $host, $port, sub {
		2015	my ($fh) = @_;
		2016
		2017	my $handle = new AnyEvent::Handle
		2018	fh => $fh,
		2019	peername => $host,
		2020	tls => "connect",
		2021	tls_ctx => { verify => 1, verify_peername => "https" },
		2022	...
		2023
		2024	Note that you must specify the hostname you connected to (or whatever
		2025	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2026	peername verification will be done.
		2027
		2028	The above will use the system-dependent default set of trusted CA
		2029	certificates. If you want to check against a specific CA, add the
		2030	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2031
		2032	tls_ctx => {
		2033	verify => 1,
		2034	verify_peername => "https",
		2035	ca_file => "my-ca-cert.pem",
		2036	},
		2037
		2038	=item I want to create a TLS/SSL server, how do I do that?
		2039
		2040	Well, you first need to get a server certificate and key. You have
		2041	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2042	self-signed certificate (cheap. check the search engine of your choice,
		2043	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2044	nice program for that purpose).
		2045
		2046	Then create a file with your private key (in PEM format, see
		2047	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2048	file should then look like this:
		2049
		2050	-----BEGIN RSA PRIVATE KEY-----
		2051	...header data
		2052	... lots of base64'y-stuff
		2053	-----END RSA PRIVATE KEY-----
		2054
		2055	-----BEGIN CERTIFICATE-----
		2056	... lots of base64'y-stuff
		2057	-----END CERTIFICATE-----
		2058
		2059	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2060	specify this file as C<cert_file>:
		2061
		2062	tcp_server undef, $port, sub {
		2063	my ($fh) = @_;
		2064
		2065	my $handle = new AnyEvent::Handle
		2066	fh => $fh,
		2067	tls => "accept",
		2068	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2069	...
		2070
		2071	When you have intermediate CA certificates that your clients might not
		2072	know about, just append them to the C<cert_file>.
		2073
		2074	=back
		2075
1473		2076
1474	=head1 SUBCLASSING AnyEvent::Handle	2077	=head1 SUBCLASSING AnyEvent::Handle
1475		2078
1476	In many cases, you might want to subclass AnyEvent::Handle.	2079	In many cases, you might want to subclass AnyEvent::Handle.
1477		2080

Diff Legend

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