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

Diff Legend

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