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.48 by root, Thu May 29 00:27:06 2008 UTC vs.
Revision 1.151 by root, Thu Jul 16 04:20:23 2009 UTC

1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict qw(subs vars);
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
…		…
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = '0.04';	19	our $VERSION = 4.82;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
25		25
26	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
27		27
28	my $handle =	28	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	29	fh => \*STDIN,
31	on_eof => sub {	30	on_error => sub {
32	$cv->broadcast;	31	my ($hdl, $fatal, $msg) = @_;
33	},	32	warn "got error $msg\n";
		33	$hdl->destroy;
		34	$cv->send;
34	);	35	);
35		36
36	# send some request line	37	# send some request line
37	$handle->push_write ("getinfo\015\012");	38	$hdl->push_write ("getinfo\015\012");
38		39
39	# read the response line	40	# read the response line
40	$handle->push_read (line => sub {	41	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	42	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	43	warn "got line <$line>\n";
43	$cv->send;	44	$cv->send;
44	});	45	});
45		46
46	$cv->recv;	47	$cv->recv;
47		48
…		…
49		50
50	This module is a helper module to make it easier to do event-based I/O on	51	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	52	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	53	on sockets see L<AnyEvent::Util>.
53		54
		55	The L<AnyEvent::Intro> tutorial contains some well-documented
		56	AnyEvent::Handle examples.
		57
54	In the following, when the documentation refers to of "bytes" then this	58	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	59	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	60	treatment of characters applies to this module as well.
57		61
58	All callbacks will be invoked with the handle object as their first	62	All callbacks will be invoked with the handle object as their first
…		…
60		64
61	=head1 METHODS	65	=head1 METHODS
62		66
63	=over 4	67	=over 4
64		68
65	=item B<new (%args)>	69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
66		70
67	The constructor supports these arguments (all as key => value pairs).	71	The constructor supports these arguments (all as C<< key => value >> pairs).
68		72
69	=over 4	73	=over 4
70		74
71	=item fh => $filehandle [MANDATORY]	75	=item fh => $filehandle [MANDATORY]
72		76
73	The filehandle this L<AnyEvent::Handle> object will operate on.	77	The filehandle this L<AnyEvent::Handle> object will operate on.
74		78
75	NOTE: The filehandle will be set to non-blocking (using	79	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	80	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		81	that mode.
77		82
78	=item on_eof => $cb->($handle)	83	=item on_eof => $cb->($handle)
79		84
80	Set the callback to be called on EOF.	85	Set the callback to be called when an end-of-file condition is detected,
		86	i.e. in the case of a socket, when the other side has closed the
		87	connection cleanly, and there are no outstanding read requests in the
		88	queue (if there are read requests, then an EOF counts as an unexpected
		89	connection close and will be flagged as an error).
81		90
82	While not mandatory, it is highly recommended to set an eof callback,	91	For sockets, this just means that the other side has stopped sending data,
83	otherwise you might end up with a closed socket while you are still	92	you can still try to write data, and, in fact, one can return from the EOF
84	waiting for data.	93	callback and continue writing data, as only the read part has been shut
		94	down.
85		95
		96	If an EOF condition has been detected but no C<on_eof> callback has been
		97	set, then a fatal error will be raised with C<$!> set to <0>.
		98
86	=item on_error => $cb->($handle)	99	=item on_error => $cb->($handle, $fatal, $message)
87		100
88	This is the fatal error callback, that is called when, well, a fatal error	101	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	102	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	103	connect or a read error.
91		104
92	The object will not be in a usable state when this callback has been	105	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	106	fatal errors the handle object will be destroyed (by a call to C<< ->
		107	destroy >>) after invoking the error callback (which means you are free to
		108	examine the handle object). Examples of fatal errors are an EOF condition
		109	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
		110
		111	AnyEvent::Handle tries to find an appropriate error code for you to check
		112	against, but in some cases (TLS errors), this does not work well. It is
		113	recommended to always output the C<$message> argument in human-readable
		114	error messages (it's usually the same as C<"$!">).
		115
		116	Non-fatal errors can be retried by simply returning, but it is recommended
		117	to simply ignore this parameter and instead abondon the handle object
		118	when this callback is invoked. Examples of non-fatal errors are timeouts
		119	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
94		120
95	On callback entrance, the value of C<$!> contains the operating system	121	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	122	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
97		123	C<EPROTO>).
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100		124
101	While not mandatory, it is I<highly> recommended to set this callback, as	125	While not mandatory, it is I<highly> recommended to set this callback, as
102	you will not be notified of errors otherwise. The default simply calls	126	you will not be notified of errors otherwise. The default simply calls
103	die.	127	C<croak>.
104		128
105	=item on_read => $cb->($handle)	129	=item on_read => $cb->($handle)
106		130
107	This sets the default read callback, which is called when data arrives	131	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	132	and no read request is in the queue (unlike read queue callbacks, this
		133	callback will only be called when at least one octet of data is in the
		134	read buffer).
109		135
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	136	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$handle->{rbuf}> member directly.	137	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		138	must not enlarge or modify the read buffer, you can only remove data at
		139	the beginning from it.
112		140
113	When an EOF condition is detected then AnyEvent::Handle will first try to	141	When an EOF condition is detected then AnyEvent::Handle will first try to
114	feed all the remaining data to the queued callbacks and C<on_read> before	142	feed all the remaining data to the queued callbacks and C<on_read> before
115	calling the C<on_eof> callback. If no progress can be made, then a fatal	143	calling the C<on_eof> callback. If no progress can be made, then a fatal
116	error will be raised (with C<$!> set to C<EPIPE>).	144	error will be raised (with C<$!> set to C<EPIPE>).
117		145
		146	Note that, unlike requests in the read queue, an C<on_read> callback
		147	doesn't mean you I<require> some data: if there is an EOF and there
		148	are outstanding read requests then an error will be flagged. With an
		149	C<on_read> callback, the C<on_eof> callback will be invoked.
		150
118	=item on_drain => $cb->($handle)	151	=item on_drain => $cb->($handle)
119		152
120	This sets the callback that is called when the write buffer becomes empty	153	This sets the callback that is called when the write buffer becomes empty
121	(or when the callback is set and the buffer is empty already).	154	(or when the callback is set and the buffer is empty already).
122		155
123	To append to the write buffer, use the C<< ->push_write >> method.	156	To append to the write buffer, use the C<< ->push_write >> method.
		157
		158	This callback is useful when you don't want to put all of your write data
		159	into the queue at once, for example, when you want to write the contents
		160	of some file to the socket you might not want to read the whole file into
		161	memory and push it into the queue, but instead only read more data from
		162	the file when the write queue becomes empty.
124		163
125	=item timeout => $fractional_seconds	164	=item timeout => $fractional_seconds
126		165
127	If non-zero, then this enables an "inactivity" timeout: whenever this many	166	If non-zero, then this enables an "inactivity" timeout: whenever this many
128	seconds pass without a successful read or write on the underlying file	167	seconds pass without a successful read or write on the underlying file
129	handle, the C<on_timeout> callback will be invoked (and if that one is	168	handle, the C<on_timeout> callback will be invoked (and if that one is
130	missing, an C<ETIMEDOUT> error will be raised).	169	missing, a non-fatal C<ETIMEDOUT> error will be raised).
131		170
132	Note that timeout processing is also active when you currently do not have	171	Note that timeout processing is also active when you currently do not have
133	any outstanding read or write requests: If you plan to keep the connection	172	any outstanding read or write requests: If you plan to keep the connection
134	idle then you should disable the timout temporarily or ignore the timeout	173	idle then you should disable the timout temporarily or ignore the timeout
135	in the C<on_timeout> callback.	174	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		175	restart the timeout.
136		176
137	Zero (the default) disables this timeout.	177	Zero (the default) disables this timeout.
138		178
139	=item on_timeout => $cb->($handle)	179	=item on_timeout => $cb->($handle)
140		180
…		…
144		184
145	=item rbuf_max => <bytes>	185	=item rbuf_max => <bytes>
146		186
147	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	187	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
148	when the read buffer ever (strictly) exceeds this size. This is useful to	188	when the read buffer ever (strictly) exceeds this size. This is useful to
149	avoid denial-of-service attacks.	189	avoid some forms of denial-of-service attacks.
150		190
151	For example, a server accepting connections from untrusted sources should	191	For example, a server accepting connections from untrusted sources should
152	be configured to accept only so-and-so much data that it cannot act on	192	be configured to accept only so-and-so much data that it cannot act on
153	(for example, when expecting a line, an attacker could send an unlimited	193	(for example, when expecting a line, an attacker could send an unlimited
154	amount of data without a callback ever being called as long as the line	194	amount of data without a callback ever being called as long as the line
155	isn't finished).	195	isn't finished).
156		196
		197	=item autocork => <boolean>
		198
		199	When disabled (the default), then C<push_write> will try to immediately
		200	write the data to the handle, if possible. This avoids having to register
		201	a write watcher and wait for the next event loop iteration, but can
		202	be inefficient if you write multiple small chunks (on the wire, this
		203	disadvantage is usually avoided by your kernel's nagle algorithm, see
		204	C<no_delay>, but this option can save costly syscalls).
		205
		206	When enabled, then writes will always be queued till the next event loop
		207	iteration. This is efficient when you do many small writes per iteration,
		208	but less efficient when you do a single write only per iteration (or when
		209	the write buffer often is full). It also increases write latency.
		210
		211	=item no_delay => <boolean>
		212
		213	When doing small writes on sockets, your operating system kernel might
		214	wait a bit for more data before actually sending it out. This is called
		215	the Nagle algorithm, and usually it is beneficial.
		216
		217	In some situations you want as low a delay as possible, which can be
		218	accomplishd by setting this option to a true value.
		219
		220	The default is your opertaing system's default behaviour (most likely
		221	enabled), this option explicitly enables or disables it, if possible.
		222
157	=item read_size => <bytes>	223	=item read_size => <bytes>
158		224
159	The default read block size (the amount of bytes this module will try to read	225	The default read block size (the amount of bytes this module will
160	during each (loop iteration). Default: C<8192>.	226	try to read during each loop iteration, which affects memory
		227	requirements). Default: C<8192>.
161		228
162	=item low_water_mark => <bytes>	229	=item low_water_mark => <bytes>
163		230
164	Sets the amount of bytes (default: C<0>) that make up an "empty" write	231	Sets the amount of bytes (default: C<0>) that make up an "empty" write
165	buffer: If the write reaches this size or gets even samller it is	232	buffer: If the write reaches this size or gets even samller it is
166	considered empty.	233	considered empty.
167		234
		235	Sometimes it can be beneficial (for performance reasons) to add data to
		236	the write buffer before it is fully drained, but this is a rare case, as
		237	the operating system kernel usually buffers data as well, so the default
		238	is good in almost all cases.
		239
		240	=item linger => <seconds>
		241
		242	If non-zero (default: C<3600>), then the destructor of the
		243	AnyEvent::Handle object will check whether there is still outstanding
		244	write data and will install a watcher that will write this data to the
		245	socket. No errors will be reported (this mostly matches how the operating
		246	system treats outstanding data at socket close time).
		247
		248	This will not work for partial TLS data that could not be encoded
		249	yet. This data will be lost. Calling the C<stoptls> method in time might
		250	help.
		251
		252	=item peername => $string
		253
		254	A string used to identify the remote site - usually the DNS hostname
		255	(I<not> IDN!) used to create the connection, rarely the IP address.
		256
		257	Apart from being useful in error messages, this string is also used in TLS
		258	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		259	verification will be skipped when C<peername> is not specified or
		260	C<undef>.
		261
168	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	262	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
169		263
170	When this parameter is given, it enables TLS (SSL) mode, that means it	264	When this parameter is given, it enables TLS (SSL) mode, that means
171	will start making tls handshake and will transparently encrypt/decrypt	265	AnyEvent will start a TLS handshake as soon as the conenction has been
172	data.	266	established and will transparently encrypt/decrypt data afterwards.
		267
		268	All TLS protocol errors will be signalled as C<EPROTO>, with an
		269	appropriate error message.
173		270
174	TLS mode requires Net::SSLeay to be installed (it will be loaded	271	TLS mode requires Net::SSLeay to be installed (it will be loaded
175	automatically when you try to create a TLS handle).	272	automatically when you try to create a TLS handle): this module doesn't
		273	have a dependency on that module, so if your module requires it, you have
		274	to add the dependency yourself.
176		275
177	For the TLS server side, use C<accept>, and for the TLS client side of a	276	Unlike TCP, TLS has a server and client side: for the TLS server side, use
178	connection, use C<connect> mode.	277	C<accept>, and for the TLS client side of a connection, use C<connect>
		278	mode.
179		279
180	You can also provide your own TLS connection object, but you have	280	You can also provide your own TLS connection object, but you have
181	to make sure that you call either C<Net::SSLeay::set_connect_state>	281	to make sure that you call either C<Net::SSLeay::set_connect_state>
182	or C<Net::SSLeay::set_accept_state> on it before you pass it to	282	or C<Net::SSLeay::set_accept_state> on it before you pass it to
183	AnyEvent::Handle.	283	AnyEvent::Handle. Also, this module will take ownership of this connection
		284	object.
184		285
		286	At some future point, AnyEvent::Handle might switch to another TLS
		287	implementation, then the option to use your own session object will go
		288	away.
		289
		290	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		291	passing in the wrong integer will lead to certain crash. This most often
		292	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		293	segmentation fault.
		294
185	See the C<starttls> method if you need to start TLs negotiation later.	295	See the C<< ->starttls >> method for when need to start TLS negotiation later.
186		296
187	=item tls_ctx => $ssl_ctx	297	=item tls_ctx => $anyevent_tls
188		298
189	Use the given Net::SSLeay::CTX object to create the new TLS connection	299	Use the given C<AnyEvent::TLS> object to create the new TLS connection
190	(unless a connection object was specified directly). If this parameter is	300	(unless a connection object was specified directly). If this parameter is
191	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	301	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
192		302
		303	Instead of an object, you can also specify a hash reference with C<< key
		304	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		305	new TLS context object.
		306
		307	=item on_starttls => $cb->($handle, $success[, $error_message])
		308
		309	This callback will be invoked when the TLS/SSL handshake has finished. If
		310	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		311	(C<on_stoptls> will not be called in this case).
		312
		313	The session in C<< $handle->{tls} >> can still be examined in this
		314	callback, even when the handshake was not successful.
		315
		316	TLS handshake failures will not cause C<on_error> to be invoked when this
		317	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		318
		319	Without this callback, handshake failures lead to C<on_error> being
		320	called, as normal.
		321
		322	Note that you cannot call C<starttls> right again in this callback. If you
		323	need to do that, start an zero-second timer instead whose callback can
		324	then call C<< ->starttls >> again.
		325
		326	=item on_stoptls => $cb->($handle)
		327
		328	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		329	set, then it will be invoked after freeing the TLS session. If it is not,
		330	then a TLS shutdown condition will be treated like a normal EOF condition
		331	on the handle.
		332
		333	The session in C<< $handle->{tls} >> can still be examined in this
		334	callback.
		335
		336	This callback will only be called on TLS shutdowns, not when the
		337	underlying handle signals EOF.
		338
193	=item json => JSON or JSON::XS object	339	=item json => JSON or JSON::XS object
194		340
195	This is the json coder object used by the C<json> read and write types.	341	This is the json coder object used by the C<json> read and write types.
196		342
197	If you don't supply it, then AnyEvent::Handle will create and use a	343	If you don't supply it, then AnyEvent::Handle will create and use a
198	suitable one, which will write and expect UTF-8 encoded JSON texts.	344	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		345	texts.
199		346
200	Note that you are responsible to depend on the JSON module if you want to	347	Note that you are responsible to depend on the JSON module if you want to
201	use this functionality, as AnyEvent does not have a dependency itself.	348	use this functionality, as AnyEvent does not have a dependency itself.
202		349
203	=item filter_r => $cb
204
205	=item filter_w => $cb
206
207	These exist, but are undocumented at this time.
208
209	=back	350	=back
210		351
211	=cut	352	=cut
212		353
213	sub new {	354	sub new {
214	my $class = shift;	355	my $class = shift;
215
216	my $self = bless { @_ }, $class;	356	my $self = bless { @_ }, $class;
217		357
218	$self->{fh} or Carp::croak "mandatory argument fh is missing";	358	$self->{fh} or Carp::croak "mandatory argument fh is missing";
219		359
220	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	360	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
221
222	if ($self->{tls}) {
223	require Net::SSLeay;
224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
225	}
226
227	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
228	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
229	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
230	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
231		361
232	$self->{_activity} = AnyEvent->now;	362	$self->{_activity} = AnyEvent->now;
233	$self->_timeout;	363	$self->_timeout;
234		364
		365	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		366
		367	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		368	if $self->{tls};
		369
		370	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
		371
235	$self->start_read;	372	$self->start_read
		373	if $self->{on_read};
236		374
237	$self	375	$self->{fh} && $self
238	}	376	}
239		377
240	sub _shutdown {	378	#sub _shutdown {
241	my ($self) = @_;	379	# my ($self) = @_;
		380	#
		381	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
		382	# $self->{_eof} = 1; # tell starttls et. al to stop trying
		383	#
		384	# &_freetls;
		385	#}
242		386
243	delete $self->{_tw};
244	delete $self->{_rw};
245	delete $self->{_ww};
246	delete $self->{fh};
247	}
248
249	sub error {	387	sub _error {
250	my ($self) = @_;	388	my ($self, $errno, $fatal, $message) = @_;
251		389
252	{	390	$! = $errno;
253	local $!;	391	$message ||= "$!";
254	$self->_shutdown;
255	}
256		392
257	$self->{on_error}($self)
258	if $self->{on_error};	393	if ($self->{on_error}) {
259		394	$self->{on_error}($self, $fatal, $message);
		395	$self->destroy if $fatal;
		396	} elsif ($self->{fh}) {
		397	$self->destroy;
260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	398	Carp::croak "AnyEvent::Handle uncaught error: $message";
		399	}
261	}	400	}
262		401
263	=item $fh = $handle->fh	402	=item $fh = $handle->fh
264		403
265	This method returns the file handle of the L<AnyEvent::Handle> object.	404	This method returns the file handle used to create the L<AnyEvent::Handle> object.
266		405
267	=cut	406	=cut
268		407
269	sub fh { $_[0]{fh} }	408	sub fh { $_[0]{fh} }
270		409
…		…
288	$_[0]{on_eof} = $_[1];	427	$_[0]{on_eof} = $_[1];
289	}	428	}
290		429
291	=item $handle->on_timeout ($cb)	430	=item $handle->on_timeout ($cb)
292		431
293	Replace the current C<on_timeout> callback, or disables the callback	432	Replace the current C<on_timeout> callback, or disables the callback (but
294	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	433	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
295	argument.	434	argument and method.
296		435
297	=cut	436	=cut
298		437
299	sub on_timeout {	438	sub on_timeout {
300	$_[0]{on_timeout} = $_[1];	439	$_[0]{on_timeout} = $_[1];
		440	}
		441
		442	=item $handle->autocork ($boolean)
		443
		444	Enables or disables the current autocork behaviour (see C<autocork>
		445	constructor argument). Changes will only take effect on the next write.
		446
		447	=cut
		448
		449	sub autocork {
		450	$_[0]{autocork} = $_[1];
		451	}
		452
		453	=item $handle->no_delay ($boolean)
		454
		455	Enables or disables the C<no_delay> setting (see constructor argument of
		456	the same name for details).
		457
		458	=cut
		459
		460	sub no_delay {
		461	$_[0]{no_delay} = $_[1];
		462
		463	eval {
		464	local $SIG{__DIE__};
		465	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		466	};
		467	}
		468
		469	=item $handle->on_starttls ($cb)
		470
		471	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		472
		473	=cut
		474
		475	sub on_starttls {
		476	$_[0]{on_starttls} = $_[1];
		477	}
		478
		479	=item $handle->on_stoptls ($cb)
		480
		481	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		482
		483	=cut
		484
		485	sub on_starttls {
		486	$_[0]{on_stoptls} = $_[1];
301	}	487	}
302		488
303	#############################################################################	489	#############################################################################
304		490
305	=item $handle->timeout ($seconds)	491	=item $handle->timeout ($seconds)
…		…
331	$self->{_activity} = $NOW;	517	$self->{_activity} = $NOW;
332		518
333	if ($self->{on_timeout}) {	519	if ($self->{on_timeout}) {
334	$self->{on_timeout}($self);	520	$self->{on_timeout}($self);
335	} else {	521	} else {
336	$! = Errno::ETIMEDOUT;	522	$self->_error (Errno::ETIMEDOUT);
337	$self->error;
338	}	523	}
339		524
340	# callbakx could have changed timeout value, optimise	525	# callback could have changed timeout value, optimise
341	return unless $self->{timeout};	526	return unless $self->{timeout};
342		527
343	# calculate new after	528	# calculate new after
344	$after = $self->{timeout};	529	$after = $self->{timeout};
345	}	530	}
346		531
347	Scalar::Util::weaken $self;	532	Scalar::Util::weaken $self;
		533	return unless $self; # ->error could have destroyed $self
348		534
349	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {	535	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
350	delete $self->{_tw};	536	delete $self->{_tw};
351	$self->_timeout;	537	$self->_timeout;
352	});	538	});
…		…
383	my ($self, $cb) = @_;	569	my ($self, $cb) = @_;
384		570
385	$self->{on_drain} = $cb;	571	$self->{on_drain} = $cb;
386		572
387	$cb->($self)	573	$cb->($self)
388	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	574	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
389	}	575	}
390		576
391	=item $handle->push_write ($data)	577	=item $handle->push_write ($data)
392		578
393	Queues the given scalar to be written. You can push as much data as you	579	Queues the given scalar to be written. You can push as much data as you
…		…
404	Scalar::Util::weaken $self;	590	Scalar::Util::weaken $self;
405		591
406	my $cb = sub {	592	my $cb = sub {
407	my $len = syswrite $self->{fh}, $self->{wbuf};	593	my $len = syswrite $self->{fh}, $self->{wbuf};
408		594
409	if ($len >= 0) {	595	if (defined $len) {
410	substr $self->{wbuf}, 0, $len, "";	596	substr $self->{wbuf}, 0, $len, "";
411		597
412	$self->{_activity} = AnyEvent->now;	598	$self->{_activity} = AnyEvent->now;
413		599
414	$self->{on_drain}($self)	600	$self->{on_drain}($self)
415	if $self->{low_water_mark} >= length $self->{wbuf}	601	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
416	&& $self->{on_drain};	602	&& $self->{on_drain};
417		603
418	delete $self->{_ww} unless length $self->{wbuf};	604	delete $self->{_ww} unless length $self->{wbuf};
419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	605	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
420	$self->error;	606	$self->_error ($!, 1);
421	}	607	}
422	};	608	};
423		609
424	# try to write data immediately	610	# try to write data immediately
425	$cb->();	611	$cb->() unless $self->{autocork};
426		612
427	# if still data left in wbuf, we need to poll	613	# if still data left in wbuf, we need to poll
428	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	614	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
429	if length $self->{wbuf};	615	if length $self->{wbuf};
430	};	616	};
…		…
444		630
445	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	631	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
446	->($self, @_);	632	->($self, @_);
447	}	633	}
448		634
449	if ($self->{filter_w}) {	635	if ($self->{tls}) {
450	$self->{filter_w}($self, \$_[0]);	636	$self->{_tls_wbuf} .= $_[0];
		637
		638	&_dotls ($self);
451	} else {	639	} else {
452	$self->{wbuf} .= $_[0];	640	$self->{wbuf} .= $_[0];
453	$self->_drain_wbuf;	641	$self->_drain_wbuf;
454	}	642	}
455	}	643	}
456		644
457	=item $handle->push_write (type => @args)	645	=item $handle->push_write (type => @args)
458		646
459	=item $handle->unshift_write (type => @args)
460
461	Instead of formatting your data yourself, you can also let this module do	647	Instead of formatting your data yourself, you can also let this module do
462	the job by specifying a type and type-specific arguments.	648	the job by specifying a type and type-specific arguments.
463		649
464	Predefined types are (if you have ideas for additional types, feel free to	650	Predefined types are (if you have ideas for additional types, feel free to
465	drop by and tell us):	651	drop by and tell us):
…		…
469	=item netstring => $string	655	=item netstring => $string
470		656
471	Formats the given value as netstring	657	Formats the given value as netstring
472	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	658	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
473		659
474	=back
475
476	=cut	660	=cut
477		661
478	register_write_type netstring => sub {	662	register_write_type netstring => sub {
479	my ($self, $string) = @_;	663	my ($self, $string) = @_;
480		664
481	sprintf "%d:%s,", (length $string), $string	665	(length $string) . ":$string,"
		666	};
		667
		668	=item packstring => $format, $data
		669
		670	An octet string prefixed with an encoded length. The encoding C<$format>
		671	uses the same format as a Perl C<pack> format, but must specify a single
		672	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		673	optional C<!>, C<< < >> or C<< > >> modifier).
		674
		675	=cut
		676
		677	register_write_type packstring => sub {
		678	my ($self, $format, $string) = @_;
		679
		680	pack "$format/a*", $string
482	};	681	};
483		682
484	=item json => $array_or_hashref	683	=item json => $array_or_hashref
485		684
486	Encodes the given hash or array reference into a JSON object. Unless you	685	Encodes the given hash or array reference into a JSON object. Unless you
…		…
520		719
521	$self->{json} ? $self->{json}->encode ($ref)	720	$self->{json} ? $self->{json}->encode ($ref)
522	: JSON::encode_json ($ref)	721	: JSON::encode_json ($ref)
523	};	722	};
524		723
		724	=item storable => $reference
		725
		726	Freezes the given reference using L<Storable> and writes it to the
		727	handle. Uses the C<nfreeze> format.
		728
		729	=cut
		730
		731	register_write_type storable => sub {
		732	my ($self, $ref) = @_;
		733
		734	require Storable;
		735
		736	pack "w/a*", Storable::nfreeze ($ref)
		737	};
		738
		739	=back
		740
		741	=item $handle->push_shutdown
		742
		743	Sometimes you know you want to close the socket after writing your data
		744	before it was actually written. One way to do that is to replace your
		745	C<on_drain> handler by a callback that shuts down the socket (and set
		746	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		747	replaces the C<on_drain> callback with:
		748
		749	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		750
		751	This simply shuts down the write side and signals an EOF condition to the
		752	the peer.
		753
		754	You can rely on the normal read queue and C<on_eof> handling
		755	afterwards. This is the cleanest way to close a connection.
		756
		757	=cut
		758
		759	sub push_shutdown {
		760	my ($self) = @_;
		761
		762	delete $self->{low_water_mark};
		763	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		764	}
		765
525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	766	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
526		767
527	This function (not method) lets you add your own types to C<push_write>.	768	This function (not method) lets you add your own types to C<push_write>.
528	Whenever the given C<type> is used, C<push_write> will invoke the code	769	Whenever the given C<type> is used, C<push_write> will invoke the code
529	reference with the handle object and the remaining arguments.	770	reference with the handle object and the remaining arguments.
…		…
549	ways, the "simple" way, using only C<on_read> and the "complex" way, using	790	ways, the "simple" way, using only C<on_read> and the "complex" way, using
550	a queue.	791	a queue.
551		792
552	In the simple case, you just install an C<on_read> callback and whenever	793	In the simple case, you just install an C<on_read> callback and whenever
553	new data arrives, it will be called. You can then remove some data (if	794	new data arrives, it will be called. You can then remove some data (if
554	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	795	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
555	or not.	796	leave the data there if you want to accumulate more (e.g. when only a
		797	partial message has been received so far).
556		798
557	In the more complex case, you want to queue multiple callbacks. In this	799	In the more complex case, you want to queue multiple callbacks. In this
558	case, AnyEvent::Handle will call the first queued callback each time new	800	case, AnyEvent::Handle will call the first queued callback each time new
559	data arrives and removes it when it has done its job (see C<push_read>,	801	data arrives (also the first time it is queued) and removes it when it has
560	below).	802	done its job (see C<push_read>, below).
561		803
562	This way you can, for example, push three line-reads, followed by reading	804	This way you can, for example, push three line-reads, followed by reading
563	a chunk of data, and AnyEvent::Handle will execute them in order.	805	a chunk of data, and AnyEvent::Handle will execute them in order.
564		806
565	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	807	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
566	the specified number of bytes which give an XML datagram.	808	the specified number of bytes which give an XML datagram.
567		809
568	# in the default state, expect some header bytes	810	# in the default state, expect some header bytes
569	$handle->on_read (sub {	811	$handle->on_read (sub {
570	# some data is here, now queue the length-header-read (4 octets)	812	# some data is here, now queue the length-header-read (4 octets)
571	shift->unshift_read_chunk (4, sub {	813	shift->unshift_read (chunk => 4, sub {
572	# header arrived, decode	814	# header arrived, decode
573	my $len = unpack "N", $_[1];	815	my $len = unpack "N", $_[1];
574		816
575	# now read the payload	817	# now read the payload
576	shift->unshift_read_chunk ($len, sub {	818	shift->unshift_read (chunk => $len, sub {
577	my $xml = $_[1];	819	my $xml = $_[1];
578	# handle xml	820	# handle xml
579	});	821	});
580	});	822	});
581	});	823	});
582		824
583	Example 2: Implement a client for a protocol that replies either with	825	Example 2: Implement a client for a protocol that replies either with "OK"
584	"OK" and another line or "ERROR" for one request, and 64 bytes for the	826	and another line or "ERROR" for the first request that is sent, and 64
585	second request. Due tot he availability of a full queue, we can just	827	bytes for the second request. Due to the availability of a queue, we can
586	pipeline sending both requests and manipulate the queue as necessary in	828	just pipeline sending both requests and manipulate the queue as necessary
587	the callbacks:	829	in the callbacks.
588		830
589	# request one	831	When the first callback is called and sees an "OK" response, it will
		832	C<unshift> another line-read. This line-read will be queued I<before> the
		833	64-byte chunk callback.
		834
		835	# request one, returns either "OK + extra line" or "ERROR"
590	$handle->push_write ("request 1\015\012");	836	$handle->push_write ("request 1\015\012");
591		837
592	# we expect "ERROR" or "OK" as response, so push a line read	838	# we expect "ERROR" or "OK" as response, so push a line read
593	$handle->push_read_line (sub {	839	$handle->push_read (line => sub {
594	# if we got an "OK", we have to _prepend_ another line,	840	# if we got an "OK", we have to _prepend_ another line,
595	# so it will be read before the second request reads its 64 bytes	841	# so it will be read before the second request reads its 64 bytes
596	# which are already in the queue when this callback is called	842	# which are already in the queue when this callback is called
597	# we don't do this in case we got an error	843	# we don't do this in case we got an error
598	if ($_[1] eq "OK") {	844	if ($_[1] eq "OK") {
599	$_[0]->unshift_read_line (sub {	845	$_[0]->unshift_read (line => sub {
600	my $response = $_[1];	846	my $response = $_[1];
601	...	847	...
602	});	848	});
603	}	849	}
604	});	850	});
605		851
606	# request two	852	# request two, simply returns 64 octets
607	$handle->push_write ("request 2\015\012");	853	$handle->push_write ("request 2\015\012");
608		854
609	# simply read 64 bytes, always	855	# simply read 64 bytes, always
610	$handle->push_read_chunk (64, sub {	856	$handle->push_read (chunk => 64, sub {
611	my $response = $_[1];	857	my $response = $_[1];
612	...	858	...
613	});	859	});
614		860
615	=over 4	861	=over 4
616		862
617	=cut	863	=cut
618		864
619	sub _drain_rbuf {	865	sub _drain_rbuf {
620	my ($self) = @_;	866	my ($self) = @_;
		867
		868	local $self->{_in_drain} = 1;
621		869
622	if (	870	if (
623	defined $self->{rbuf_max}	871	defined $self->{rbuf_max}
624	&& $self->{rbuf_max} < length $self->{rbuf}	872	&& $self->{rbuf_max} < length $self->{rbuf}
625	) {	873	) {
626	$! = &Errno::ENOSPC;	874	$self->_error (Errno::ENOSPC, 1), return;
627	$self->error;
628	}	875	}
629		876
630	return if $self->{in_drain};	877	while () {
631	local $self->{in_drain} = 1;	878	# we need to use a separate tls read buffer, as we must not receive data while
		879	# we are draining the buffer, and this can only happen with TLS.
		880	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
632		881
633	while (my $len = length $self->{rbuf}) {	882	my $len = length $self->{rbuf};
634	no strict 'refs';	883
635	if (my $cb = shift @{ $self->{_queue} }) {	884	if (my $cb = shift @{ $self->{_queue} }) {
636	unless ($cb->($self)) {	885	unless ($cb->($self)) {
637	if ($self->{_eof}) {	886	if ($self->{_eof}) {
638	# no progress can be made (not enough data and no data forthcoming)	887	# no progress can be made (not enough data and no data forthcoming)
639	$! = &Errno::EPIPE;	888	$self->_error (Errno::EPIPE, 1), return;
640	$self->error;
641	}	889	}
642		890
643	unshift @{ $self->{_queue} }, $cb;	891	unshift @{ $self->{_queue} }, $cb;
644	return;	892	last;
645	}	893	}
646	} elsif ($self->{on_read}) {	894	} elsif ($self->{on_read}) {
		895	last unless $len;
		896
647	$self->{on_read}($self);	897	$self->{on_read}($self);
648		898
649	if (	899	if (
650	$self->{_eof} # if no further data will arrive
651	&& $len == length $self->{rbuf} # and no data has been consumed	900	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	901	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # and we still want to read data	902	&& $self->{on_read} # but we still have on_read
654	) {	903	) {
		904	# no further data will arrive
655	# then no progress can be made	905	# so no progress can be made
656	$! = &Errno::EPIPE;	906	$self->_error (Errno::EPIPE, 1), return
657	$self->error;	907	if $self->{_eof};
		908
		909	last; # more data might arrive
658	}	910	}
659	} else {	911	} else {
660	# read side becomes idle	912	# read side becomes idle
661	delete $self->{_rw};	913	delete $self->{_rw} unless $self->{tls};
662	return;	914	last;
663	}	915	}
664	}	916	}
665		917
		918	if ($self->{_eof}) {
		919	if ($self->{on_eof}) {
666	$self->{on_eof}($self)	920	$self->{on_eof}($self)
667	if $self->{_eof} && $self->{on_eof};	921	} else {
		922	$self->_error (0, 1, "Unexpected end-of-file");
		923	}
		924	}
		925
		926	# may need to restart read watcher
		927	unless ($self->{_rw}) {
		928	$self->start_read
		929	if $self->{on_read} || @{ $self->{_queue} };
		930	}
668	}	931	}
669		932
670	=item $handle->on_read ($cb)	933	=item $handle->on_read ($cb)
671		934
672	This replaces the currently set C<on_read> callback, or clears it (when	935	This replaces the currently set C<on_read> callback, or clears it (when
…		…
677		940
678	sub on_read {	941	sub on_read {
679	my ($self, $cb) = @_;	942	my ($self, $cb) = @_;
680		943
681	$self->{on_read} = $cb;	944	$self->{on_read} = $cb;
		945	$self->_drain_rbuf if $cb && !$self->{_in_drain};
682	}	946	}
683		947
684	=item $handle->rbuf	948	=item $handle->rbuf
685		949
686	Returns the read buffer (as a modifiable lvalue).	950	Returns the read buffer (as a modifiable lvalue).
687		951
688	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	952	You can access the read buffer directly as the C<< ->{rbuf} >>
689	you want.	953	member, if you want. However, the only operation allowed on the
		954	read buffer (apart from looking at it) is removing data from its
		955	beginning. Otherwise modifying or appending to it is not allowed and will
		956	lead to hard-to-track-down bugs.
690		957
691	NOTE: The read buffer should only be used or modified if the C<on_read>,	958	NOTE: The read buffer should only be used or modified if the C<on_read>,
692	C<push_read> or C<unshift_read> methods are used. The other read methods	959	C<push_read> or C<unshift_read> methods are used. The other read methods
693	automatically manage the read buffer.	960	automatically manage the read buffer.
694		961
…		…
735	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1002	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
736	->($self, $cb, @_);	1003	->($self, $cb, @_);
737	}	1004	}
738		1005
739	push @{ $self->{_queue} }, $cb;	1006	push @{ $self->{_queue} }, $cb;
740	$self->_drain_rbuf;	1007	$self->_drain_rbuf unless $self->{_in_drain};
741	}	1008	}
742		1009
743	sub unshift_read {	1010	sub unshift_read {
744	my $self = shift;	1011	my $self = shift;
745	my $cb = pop;	1012	my $cb = pop;
…		…
751	->($self, $cb, @_);	1018	->($self, $cb, @_);
752	}	1019	}
753		1020
754		1021
755	unshift @{ $self->{_queue} }, $cb;	1022	unshift @{ $self->{_queue} }, $cb;
756	$self->_drain_rbuf;	1023	$self->_drain_rbuf unless $self->{_in_drain};
757	}	1024	}
758		1025
759	=item $handle->push_read (type => @args, $cb)	1026	=item $handle->push_read (type => @args, $cb)
760		1027
761	=item $handle->unshift_read (type => @args, $cb)	1028	=item $handle->unshift_read (type => @args, $cb)
…		…
791	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1058	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
792	1	1059	1
793	}	1060	}
794	};	1061	};
795		1062
796	# compatibility with older API
797	sub push_read_chunk {
798	$_[0]->push_read (chunk => $_[1], $_[2]);
799	}
800
801	sub unshift_read_chunk {
802	$_[0]->unshift_read (chunk => $_[1], $_[2]);
803	}
804
805	=item line => [$eol, ]$cb->($handle, $line, $eol)	1063	=item line => [$eol, ]$cb->($handle, $line, $eol)
806		1064
807	The callback will be called only once a full line (including the end of	1065	The callback will be called only once a full line (including the end of
808	line marker, C<$eol>) has been read. This line (excluding the end of line	1066	line marker, C<$eol>) has been read. This line (excluding the end of line
809	marker) will be passed to the callback as second argument (C<$line>), and	1067	marker) will be passed to the callback as second argument (C<$line>), and
…		…
824	=cut	1082	=cut
825		1083
826	register_read_type line => sub {	1084	register_read_type line => sub {
827	my ($self, $cb, $eol) = @_;	1085	my ($self, $cb, $eol) = @_;
828		1086
829	$eol = qr|(\015?\012)| if @_ < 3;	1087	if (@_ < 3) {
830	$eol = quotemeta $eol unless ref $eol;	1088	# this is more than twice as fast as the generic code below
831	$eol = qr|^(.*?)($eol)|s;
832
833	sub {	1089	sub {
834	$_[0]{rbuf} =~ s/$eol// or return;	1090	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
835		1091
836	$cb->($_[0], $1, $2);	1092	$cb->($_[0], $1, $2);
837	1
838	}
839	};
840
841	# compatibility with older API
842	sub push_read_line {
843	my $self = shift;
844	$self->push_read (line => @_);
845	}
846
847	sub unshift_read_line {
848	my $self = shift;
849	$self->unshift_read (line => @_);
850	}
851
852	=item netstring => $cb->($handle, $string)
853
854	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
855
856	Throws an error with C<$!> set to EBADMSG on format violations.
857
858	=cut
859
860	register_read_type netstring => sub {
861	my ($self, $cb) = @_;
862
863	sub {
864	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
865	if ($_[0]{rbuf} =~ /[^0-9]/) {
866	$! = &Errno::EBADMSG;
867	$self->error;
868	}	1093	1
869	return;
870	}	1094	}
		1095	} else {
		1096	$eol = quotemeta $eol unless ref $eol;
		1097	$eol = qr|^(.*?)($eol)|s;
871		1098
872	my $len = $1;	1099	sub {
		1100	$_[0]{rbuf} =~ s/$eol// or return;
873		1101
874	$self->unshift_read (chunk => $len, sub {	1102	$cb->($_[0], $1, $2);
875	my $string = $_[1];
876	$_[0]->unshift_read (chunk => 1, sub {
877	if ($_[1] eq ",") {
878	$cb->($_[0], $string);
879	} else {
880	$! = &Errno::EBADMSG;
881	$self->error;
882	}
883	});	1103	1
884	});	1104	}
885
886	1
887	}	1105	}
888	};	1106	};
889		1107
890	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1108	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
891		1109
…		…
943	return 1;	1161	return 1;
944	}	1162	}
945		1163
946	# reject	1164	# reject
947	if ($reject && $$rbuf =~ $reject) {	1165	if ($reject && $$rbuf =~ $reject) {
948	$! = &Errno::EBADMSG;	1166	$self->_error (Errno::EBADMSG);
949	$self->error;
950	}	1167	}
951		1168
952	# skip	1169	# skip
953	if ($skip && $$rbuf =~ $skip) {	1170	if ($skip && $$rbuf =~ $skip) {
954	$data .= substr $$rbuf, 0, $+[0], "";	1171	$data .= substr $$rbuf, 0, $+[0], "";
…		…
956		1173
957	()	1174	()
958	}	1175	}
959	};	1176	};
960		1177
		1178	=item netstring => $cb->($handle, $string)
		1179
		1180	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1181
		1182	Throws an error with C<$!> set to EBADMSG on format violations.
		1183
		1184	=cut
		1185
		1186	register_read_type netstring => sub {
		1187	my ($self, $cb) = @_;
		1188
		1189	sub {
		1190	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
		1191	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1192	$self->_error (Errno::EBADMSG);
		1193	}
		1194	return;
		1195	}
		1196
		1197	my $len = $1;
		1198
		1199	$self->unshift_read (chunk => $len, sub {
		1200	my $string = $_[1];
		1201	$_[0]->unshift_read (chunk => 1, sub {
		1202	if ($_[1] eq ",") {
		1203	$cb->($_[0], $string);
		1204	} else {
		1205	$self->_error (Errno::EBADMSG);
		1206	}
		1207	});
		1208	});
		1209
		1210	1
		1211	}
		1212	};
		1213
		1214	=item packstring => $format, $cb->($handle, $string)
		1215
		1216	An octet string prefixed with an encoded length. The encoding C<$format>
		1217	uses the same format as a Perl C<pack> format, but must specify a single
		1218	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1219	optional C<!>, C<< < >> or C<< > >> modifier).
		1220
		1221	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1222	EPP uses a prefix of C<N> (4 octtes).
		1223
		1224	Example: read a block of data prefixed by its length in BER-encoded
		1225	format (very efficient).
		1226
		1227	$handle->push_read (packstring => "w", sub {
		1228	my ($handle, $data) = @_;
		1229	});
		1230
		1231	=cut
		1232
		1233	register_read_type packstring => sub {
		1234	my ($self, $cb, $format) = @_;
		1235
		1236	sub {
		1237	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1238	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1239	or return;
		1240
		1241	$format = length pack $format, $len;
		1242
		1243	# bypass unshift if we already have the remaining chunk
		1244	if ($format + $len <= length $_[0]{rbuf}) {
		1245	my $data = substr $_[0]{rbuf}, $format, $len;
		1246	substr $_[0]{rbuf}, 0, $format + $len, "";
		1247	$cb->($_[0], $data);
		1248	} else {
		1249	# remove prefix
		1250	substr $_[0]{rbuf}, 0, $format, "";
		1251
		1252	# read remaining chunk
		1253	$_[0]->unshift_read (chunk => $len, $cb);
		1254	}
		1255
		1256	1
		1257	}
		1258	};
		1259
961	=item json => $cb->($handle, $hash_or_arrayref)	1260	=item json => $cb->($handle, $hash_or_arrayref)
962		1261
963	Reads a JSON object or array, decodes it and passes it to the callback.	1262	Reads a JSON object or array, decodes it and passes it to the
		1263	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
964		1264
965	If a C<json> object was passed to the constructor, then that will be used	1265	If a C<json> object was passed to the constructor, then that will be used
966	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1266	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
967		1267
968	This read type uses the incremental parser available with JSON version	1268	This read type uses the incremental parser available with JSON version
…		…
975	the C<json> write type description, above, for an actual example.	1275	the C<json> write type description, above, for an actual example.
976		1276
977	=cut	1277	=cut
978		1278
979	register_read_type json => sub {	1279	register_read_type json => sub {
980	my ($self, $cb, $accept, $reject, $skip) = @_;	1280	my ($self, $cb) = @_;
981		1281
982	require JSON;	1282	my $json = $self->{json} ||=
		1283	eval { require JSON::XS; JSON::XS->new->utf8 }
		1284	|| do { require JSON; JSON->new->utf8 };
983		1285
984	my $data;	1286	my $data;
985	my $rbuf = \$self->{rbuf};	1287	my $rbuf = \$self->{rbuf};
986		1288
987	my $json = $self->{json} ||= JSON->new->utf8;
988
989	sub {	1289	sub {
990	my $ref = $json->incr_parse ($self->{rbuf});	1290	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
991		1291
992	if ($ref) {	1292	if ($ref) {
993	$self->{rbuf} = $json->incr_text;	1293	$self->{rbuf} = $json->incr_text;
994	$json->incr_text = "";	1294	$json->incr_text = "";
995	$cb->($self, $ref);	1295	$cb->($self, $ref);
996		1296
997	1	1297	1
		1298	} elsif ($@) {
		1299	# error case
		1300	$json->incr_skip;
		1301
		1302	$self->{rbuf} = $json->incr_text;
		1303	$json->incr_text = "";
		1304
		1305	$self->_error (Errno::EBADMSG);
		1306
		1307	()
998	} else {	1308	} else {
999	$self->{rbuf} = "";	1309	$self->{rbuf} = "";
		1310
1000	()	1311	()
1001	}	1312	}
		1313	}
		1314	};
		1315
		1316	=item storable => $cb->($handle, $ref)
		1317
		1318	Deserialises a L<Storable> frozen representation as written by the
		1319	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1320	data).
		1321
		1322	Raises C<EBADMSG> error if the data could not be decoded.
		1323
		1324	=cut
		1325
		1326	register_read_type storable => sub {
		1327	my ($self, $cb) = @_;
		1328
		1329	require Storable;
		1330
		1331	sub {
		1332	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1333	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1334	or return;
		1335
		1336	my $format = length pack "w", $len;
		1337
		1338	# bypass unshift if we already have the remaining chunk
		1339	if ($format + $len <= length $_[0]{rbuf}) {
		1340	my $data = substr $_[0]{rbuf}, $format, $len;
		1341	substr $_[0]{rbuf}, 0, $format + $len, "";
		1342	$cb->($_[0], Storable::thaw ($data));
		1343	} else {
		1344	# remove prefix
		1345	substr $_[0]{rbuf}, 0, $format, "";
		1346
		1347	# read remaining chunk
		1348	$_[0]->unshift_read (chunk => $len, sub {
		1349	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1350	$cb->($_[0], $ref);
		1351	} else {
		1352	$self->_error (Errno::EBADMSG);
		1353	}
		1354	});
		1355	}
		1356
		1357	1
1002	}	1358	}
1003	};	1359	};
1004		1360
1005	=back	1361	=back
1006		1362
…		…
1027	=item $handle->stop_read	1383	=item $handle->stop_read
1028		1384
1029	=item $handle->start_read	1385	=item $handle->start_read
1030		1386
1031	In rare cases you actually do not want to read anything from the	1387	In rare cases you actually do not want to read anything from the
1032	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1388	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1033	any queued callbacks will be executed then. To start reading again, call	1389	any queued callbacks will be executed then. To start reading again, call
1034	C<start_read>.	1390	C<start_read>.
1035		1391
		1392	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1393	you change the C<on_read> callback or push/unshift a read callback, and it
		1394	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1395	there are any read requests in the queue.
		1396
		1397	These methods will have no effect when in TLS mode (as TLS doesn't support
		1398	half-duplex connections).
		1399
1036	=cut	1400	=cut
1037		1401
1038	sub stop_read {	1402	sub stop_read {
1039	my ($self) = @_;	1403	my ($self) = @_;
1040		1404
1041	delete $self->{_rw};	1405	delete $self->{_rw} unless $self->{tls};
1042	}	1406	}
1043		1407
1044	sub start_read {	1408	sub start_read {
1045	my ($self) = @_;	1409	my ($self) = @_;
1046		1410
1047	unless ($self->{_rw} || $self->{_eof}) {	1411	unless ($self->{_rw} || $self->{_eof}) {
1048	Scalar::Util::weaken $self;	1412	Scalar::Util::weaken $self;
1049		1413
1050	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1414	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1051	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1415	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1052	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1416	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1053		1417
1054	if ($len > 0) {	1418	if ($len > 0) {
1055	$self->{_activity} = AnyEvent->now;	1419	$self->{_activity} = AnyEvent->now;
1056		1420
1057	$self->{filter_r}	1421	if ($self->{tls}) {
1058	? $self->{filter_r}($self, $rbuf)	1422	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1059	: $self->_drain_rbuf;	1423
		1424	&_dotls ($self);
		1425	} else {
		1426	$self->_drain_rbuf unless $self->{_in_drain};
		1427	}
1060		1428
1061	} elsif (defined $len) {	1429	} elsif (defined $len) {
1062	delete $self->{_rw};	1430	delete $self->{_rw};
1063	$self->{_eof} = 1;	1431	$self->{_eof} = 1;
1064	$self->_drain_rbuf;	1432	$self->_drain_rbuf unless $self->{_in_drain};
1065		1433
1066	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1434	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1067	return $self->error;	1435	return $self->_error ($!, 1);
1068	}	1436	}
1069	});	1437	});
1070	}	1438	}
1071	}	1439	}
1072		1440
		1441	our $ERROR_SYSCALL;
		1442	our $ERROR_WANT_READ;
		1443
		1444	sub _tls_error {
		1445	my ($self, $err) = @_;
		1446
		1447	return $self->_error ($!, 1)
		1448	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1449
		1450	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1451
		1452	# reduce error string to look less scary
		1453	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1454
		1455	if ($self->{_on_starttls}) {
		1456	(delete $self->{_on_starttls})->($self, undef, $err);
		1457	&_freetls;
		1458	} else {
		1459	&_freetls;
		1460	$self->_error (Errno::EPROTO, 1, $err);
		1461	}
		1462	}
		1463
		1464	# poll the write BIO and send the data if applicable
		1465	# also decode read data if possible
		1466	# this is basiclaly our TLS state machine
		1467	# more efficient implementations are possible with openssl,
		1468	# but not with the buggy and incomplete Net::SSLeay.
1073	sub _dotls {	1469	sub _dotls {
1074	my ($self) = @_;	1470	my ($self) = @_;
1075		1471
		1472	my $tmp;
		1473
1076	if (length $self->{_tls_wbuf}) {	1474	if (length $self->{_tls_wbuf}) {
1077	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1475	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1078	substr $self->{_tls_wbuf}, 0, $len, "";	1476	substr $self->{_tls_wbuf}, 0, $tmp, "";
1079	}	1477	}
1080	}
1081		1478
		1479	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1480	return $self->_tls_error ($tmp)
		1481	if $tmp != $ERROR_WANT_READ
		1482	&& ($tmp != $ERROR_SYSCALL || $!);
		1483	}
		1484
		1485	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1486	unless (length $tmp) {
		1487	$self->{_on_starttls}
		1488	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1489	&_freetls;
		1490
		1491	if ($self->{on_stoptls}) {
		1492	$self->{on_stoptls}($self);
		1493	return;
		1494	} else {
		1495	# let's treat SSL-eof as we treat normal EOF
		1496	delete $self->{_rw};
		1497	$self->{_eof} = 1;
		1498	}
		1499	}
		1500
		1501	$self->{_tls_rbuf} .= $tmp;
		1502	$self->_drain_rbuf unless $self->{_in_drain};
		1503	$self->{tls} or return; # tls session might have gone away in callback
		1504	}
		1505
		1506	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1507	return $self->_tls_error ($tmp)
		1508	if $tmp != $ERROR_WANT_READ
		1509	&& ($tmp != $ERROR_SYSCALL || $!);
		1510
1082	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1511	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1083	$self->{wbuf} .= $buf;	1512	$self->{wbuf} .= $tmp;
1084	$self->_drain_wbuf;	1513	$self->_drain_wbuf;
1085	}	1514	}
1086		1515
1087	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1516	$self->{_on_starttls}
1088	$self->{rbuf} .= $buf;	1517	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1089	$self->_drain_rbuf;	1518	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1090	}
1091
1092	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1093
1094	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1095	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1096	$self->error;
1097	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1098	$! = &Errno::EIO;
1099	$self->error;
1100	}
1101
1102	# all others are fine for our purposes
1103	}
1104	}	1519	}
1105		1520
1106	=item $handle->starttls ($tls[, $tls_ctx])	1521	=item $handle->starttls ($tls[, $tls_ctx])
1107		1522
1108	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1523	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1110	C<starttls>.	1525	C<starttls>.
1111		1526
1112	The first argument is the same as the C<tls> constructor argument (either	1527	The first argument is the same as the C<tls> constructor argument (either
1113	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1528	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1114		1529
1115	The second argument is the optional C<Net::SSLeay::CTX> object that is	1530	The second argument is the optional C<AnyEvent::TLS> object that is used
1116	used when AnyEvent::Handle has to create its own TLS connection object.	1531	when AnyEvent::Handle has to create its own TLS connection object, or
		1532	a hash reference with C<< key => value >> pairs that will be used to
		1533	construct a new context.
1117		1534
1118	The TLS connection object will end up in C<< $handle->{tls} >> after this	1535	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1119	call and can be used or changed to your liking. Note that the handshake	1536	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1120	might have already started when this function returns.	1537	changed to your liking. Note that the handshake might have already started
		1538	when this function returns.
1121		1539
1122	=cut	1540	If it an error to start a TLS handshake more than once per
		1541	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1123		1542
1124	# TODO: maybe document...	1543	=cut
		1544
		1545	our %TLS_CACHE; #TODO not yet documented, should we?
		1546
1125	sub starttls {	1547	sub starttls {
1126	my ($self, $ssl, $ctx) = @_;	1548	my ($self, $ssl, $ctx) = @_;
1127		1549
1128	$self->stoptls;	1550	require Net::SSLeay;
1129		1551
1130	if ($ssl eq "accept") {	1552	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1131	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1553	if $self->{tls};
1132	Net::SSLeay::set_accept_state ($ssl);	1554
1133	} elsif ($ssl eq "connect") {	1555	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1134	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1556	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1135	Net::SSLeay::set_connect_state ($ssl);	1557
		1558	$ctx ||= $self->{tls_ctx};
		1559
		1560	if ("HASH" eq ref $ctx) {
		1561	require AnyEvent::TLS;
		1562
		1563	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1564
		1565	if ($ctx->{cache}) {
		1566	my $key = $ctx+0;
		1567	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1568	} else {
		1569	$ctx = new AnyEvent::TLS %$ctx;
		1570	}
		1571	}
1136	}	1572
1137		1573	$self->{tls_ctx} = $ctx || TLS_CTX ();
1138	$self->{tls} = $ssl;	1574	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1139		1575
1140	# basically, this is deep magic (because SSL_read should have the same issues)	1576	# basically, this is deep magic (because SSL_read should have the same issues)
1141	# but the openssl maintainers basically said: "trust us, it just works".	1577	# but the openssl maintainers basically said: "trust us, it just works".
1142	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1578	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1143	# and mismaintained ssleay-module doesn't even offer them).	1579	# and mismaintained ssleay-module doesn't even offer them).
1144	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1580	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1581	#
		1582	# in short: this is a mess.
		1583	#
		1584	# note that we do not try to keep the length constant between writes as we are required to do.
		1585	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1586	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1587	# have identity issues in that area.
1145	Net::SSLeay::CTX_set_mode ($self->{tls},	1588	# Net::SSLeay::CTX_set_mode ($ssl,
1146	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1589	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1147	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1590	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1591	Net::SSLeay::CTX_set_mode ($ssl, 1|2);
1148		1592
1149	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1593	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1150	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1594	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1151		1595
1152	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1596	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1153		1597
1154	$self->{filter_w} = sub {	1598	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1155	$_[0]{_tls_wbuf} .= ${$_[1]};	1599	if $self->{on_starttls};
1156	&_dotls;	1600
1157	};	1601	&_dotls; # need to trigger the initial handshake
1158	$self->{filter_r} = sub {	1602	$self->start_read; # make sure we actually do read
1159	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1160	&_dotls;
1161	};
1162	}	1603	}
1163		1604
1164	=item $handle->stoptls	1605	=item $handle->stoptls
1165		1606
1166	Destroys the SSL connection, if any. Partial read or write data will be	1607	Shuts down the SSL connection - this makes a proper EOF handshake by
1167	lost.	1608	sending a close notify to the other side, but since OpenSSL doesn't
		1609	support non-blocking shut downs, it is not possible to re-use the stream
		1610	afterwards.
1168		1611
1169	=cut	1612	=cut
1170		1613
1171	sub stoptls {	1614	sub stoptls {
1172	my ($self) = @_;	1615	my ($self) = @_;
1173		1616
1174	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1617	if ($self->{tls}) {
		1618	Net::SSLeay::shutdown ($self->{tls});
1175		1619
1176	delete $self->{_rbio};	1620	&_dotls;
1177	delete $self->{_wbio};	1621
1178	delete $self->{_tls_wbuf};	1622	# # we don't give a shit. no, we do, but we can't. no...#d#
1179	delete $self->{filter_r};	1623	# # we, we... have to use openssl :/#d#
1180	delete $self->{filter_w};	1624	# &_freetls;#d#
		1625	}
		1626	}
		1627
		1628	sub _freetls {
		1629	my ($self) = @_;
		1630
		1631	return unless $self->{tls};
		1632
		1633	$self->{tls_ctx}->_put_session (delete $self->{tls});
		1634
		1635	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1181	}	1636	}
1182		1637
1183	sub DESTROY {	1638	sub DESTROY {
1184	my $self = shift;	1639	my ($self) = @_;
1185		1640
1186	$self->stoptls;	1641	&_freetls;
		1642
		1643	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1644
		1645	if ($linger && length $self->{wbuf}) {
		1646	my $fh = delete $self->{fh};
		1647	my $wbuf = delete $self->{wbuf};
		1648
		1649	my @linger;
		1650
		1651	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1652	my $len = syswrite $fh, $wbuf, length $wbuf;
		1653
		1654	if ($len > 0) {
		1655	substr $wbuf, 0, $len, "";
		1656	} else {
		1657	@linger = (); # end
		1658	}
		1659	});
		1660	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1661	@linger = ();
		1662	});
		1663	}
		1664	}
		1665
		1666	=item $handle->destroy
		1667
		1668	Shuts down the handle object as much as possible - this call ensures that
		1669	no further callbacks will be invoked and as many resources as possible
		1670	will be freed. You must not call any methods on the object afterwards.
		1671
		1672	Normally, you can just "forget" any references to an AnyEvent::Handle
		1673	object and it will simply shut down. This works in fatal error and EOF
		1674	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1675	callback, so when you want to destroy the AnyEvent::Handle object from
		1676	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1677	that case.
		1678
		1679	Destroying the handle object in this way has the advantage that callbacks
		1680	will be removed as well, so if those are the only reference holders (as
		1681	is common), then one doesn't need to do anything special to break any
		1682	reference cycles.
		1683
		1684	The handle might still linger in the background and write out remaining
		1685	data, as specified by the C<linger> option, however.
		1686
		1687	=cut
		1688
		1689	sub destroy {
		1690	my ($self) = @_;
		1691
		1692	$self->DESTROY;
		1693	%$self = ();
1187	}	1694	}
1188		1695
1189	=item AnyEvent::Handle::TLS_CTX	1696	=item AnyEvent::Handle::TLS_CTX
1190		1697
1191	This function creates and returns the Net::SSLeay::CTX object used by	1698	This function creates and returns the AnyEvent::TLS object used by default
1192	default for TLS mode.	1699	for TLS mode.
1193		1700
1194	The context is created like this:	1701	The context is created by calling L<AnyEvent::TLS> without any arguments.
1195
1196	Net::SSLeay::load_error_strings;
1197	Net::SSLeay::SSLeay_add_ssl_algorithms;
1198	Net::SSLeay::randomize;
1199
1200	my $CTX = Net::SSLeay::CTX_new;
1201
1202	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1203		1702
1204	=cut	1703	=cut
1205		1704
1206	our $TLS_CTX;	1705	our $TLS_CTX;
1207		1706
1208	sub TLS_CTX() {	1707	sub TLS_CTX() {
1209	$TLS_CTX || do {	1708	$TLS_CTX ||= do {
1210	require Net::SSLeay;	1709	require AnyEvent::TLS;
1211		1710
1212	Net::SSLeay::load_error_strings ();	1711	new AnyEvent::TLS
1213	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1214	Net::SSLeay::randomize ();
1215
1216	$TLS_CTX = Net::SSLeay::CTX_new ();
1217
1218	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1219
1220	$TLS_CTX
1221	}	1712	}
1222	}	1713	}
1223		1714
1224	=back	1715	=back
		1716
		1717
		1718	=head1 NONFREQUENTLY ASKED QUESTIONS
		1719
		1720	=over 4
		1721
		1722	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1723	still get further invocations!
		1724
		1725	That's because AnyEvent::Handle keeps a reference to itself when handling
		1726	read or write callbacks.
		1727
		1728	It is only safe to "forget" the reference inside EOF or error callbacks,
		1729	from within all other callbacks, you need to explicitly call the C<<
		1730	->destroy >> method.
		1731
		1732	=item I get different callback invocations in TLS mode/Why can't I pause
		1733	reading?
		1734
		1735	Unlike, say, TCP, TLS connections do not consist of two independent
		1736	communication channels, one for each direction. Or put differently. The
		1737	read and write directions are not independent of each other: you cannot
		1738	write data unless you are also prepared to read, and vice versa.
		1739
		1740	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1741	callback invocations when you are not expecting any read data - the reason
		1742	is that AnyEvent::Handle always reads in TLS mode.
		1743
		1744	During the connection, you have to make sure that you always have a
		1745	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1746	connection (or when you no longer want to use it) you can call the
		1747	C<destroy> method.
		1748
		1749	=item How do I read data until the other side closes the connection?
		1750
		1751	If you just want to read your data into a perl scalar, the easiest way
		1752	to achieve this is by setting an C<on_read> callback that does nothing,
		1753	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1754	will be in C<$_[0]{rbuf}>:
		1755
		1756	$handle->on_read (sub { });
		1757	$handle->on_eof (undef);
		1758	$handle->on_error (sub {
		1759	my $data = delete $_[0]{rbuf};
		1760	});
		1761
		1762	The reason to use C<on_error> is that TCP connections, due to latencies
		1763	and packets loss, might get closed quite violently with an error, when in
		1764	fact, all data has been received.
		1765
		1766	It is usually better to use acknowledgements when transferring data,
		1767	to make sure the other side hasn't just died and you got the data
		1768	intact. This is also one reason why so many internet protocols have an
		1769	explicit QUIT command.
		1770
		1771	=item I don't want to destroy the handle too early - how do I wait until
		1772	all data has been written?
		1773
		1774	After writing your last bits of data, set the C<on_drain> callback
		1775	and destroy the handle in there - with the default setting of
		1776	C<low_water_mark> this will be called precisely when all data has been
		1777	written to the socket:
		1778
		1779	$handle->push_write (...);
		1780	$handle->on_drain (sub {
		1781	warn "all data submitted to the kernel\n";
		1782	undef $handle;
		1783	});
		1784
		1785	If you just want to queue some data and then signal EOF to the other side,
		1786	consider using C<< ->push_shutdown >> instead.
		1787
		1788	=item I want to contact a TLS/SSL server, I don't care about security.
		1789
		1790	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1791	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1792	parameter:
		1793
		1794	tcp_connect $host, $port, sub {
		1795	my ($fh) = @_;
		1796
		1797	my $handle = new AnyEvent::Handle
		1798	fh => $fh,
		1799	tls => "connect",
		1800	on_error => sub { ... };
		1801
		1802	$handle->push_write (...);
		1803	};
		1804
		1805	=item I want to contact a TLS/SSL server, I do care about security.
		1806
		1807	Then you should additionally enable certificate verification, including
		1808	peername verification, if the protocol you use supports it (see
		1809	L<AnyEvent::TLS>, C<verify_peername>).
		1810
		1811	E.g. for HTTPS:
		1812
		1813	tcp_connect $host, $port, sub {
		1814	my ($fh) = @_;
		1815
		1816	my $handle = new AnyEvent::Handle
		1817	fh => $fh,
		1818	peername => $host,
		1819	tls => "connect",
		1820	tls_ctx => { verify => 1, verify_peername => "https" },
		1821	...
		1822
		1823	Note that you must specify the hostname you connected to (or whatever
		1824	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1825	peername verification will be done.
		1826
		1827	The above will use the system-dependent default set of trusted CA
		1828	certificates. If you want to check against a specific CA, add the
		1829	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1830
		1831	tls_ctx => {
		1832	verify => 1,
		1833	verify_peername => "https",
		1834	ca_file => "my-ca-cert.pem",
		1835	},
		1836
		1837	=item I want to create a TLS/SSL server, how do I do that?
		1838
		1839	Well, you first need to get a server certificate and key. You have
		1840	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1841	self-signed certificate (cheap. check the search engine of your choice,
		1842	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1843	nice program for that purpose).
		1844
		1845	Then create a file with your private key (in PEM format, see
		1846	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1847	file should then look like this:
		1848
		1849	-----BEGIN RSA PRIVATE KEY-----
		1850	...header data
		1851	... lots of base64'y-stuff
		1852	-----END RSA PRIVATE KEY-----
		1853
		1854	-----BEGIN CERTIFICATE-----
		1855	... lots of base64'y-stuff
		1856	-----END CERTIFICATE-----
		1857
		1858	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1859	specify this file as C<cert_file>:
		1860
		1861	tcp_server undef, $port, sub {
		1862	my ($fh) = @_;
		1863
		1864	my $handle = new AnyEvent::Handle
		1865	fh => $fh,
		1866	tls => "accept",
		1867	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1868	...
		1869
		1870	When you have intermediate CA certificates that your clients might not
		1871	know about, just append them to the C<cert_file>.
		1872
		1873	=back
		1874
1225		1875
1226	=head1 SUBCLASSING AnyEvent::Handle	1876	=head1 SUBCLASSING AnyEvent::Handle
1227		1877
1228	In many cases, you might want to subclass AnyEvent::Handle.	1878	In many cases, you might want to subclass AnyEvent::Handle.
1229		1879
…		…
1233	=over 4	1883	=over 4
1234		1884
1235	=item * all constructor arguments become object members.	1885	=item * all constructor arguments become object members.
1236		1886
1237	At least initially, when you pass a C<tls>-argument to the constructor it	1887	At least initially, when you pass a C<tls>-argument to the constructor it
1238	will end up in C<< $handle->{tls} >>. Those members might be changes or	1888	will end up in C<< $handle->{tls} >>. Those members might be changed or
1239	mutated later on (for example C<tls> will hold the TLS connection object).	1889	mutated later on (for example C<tls> will hold the TLS connection object).
1240		1890
1241	=item * other object member names are prefixed with an C<_>.	1891	=item * other object member names are prefixed with an C<_>.
1242		1892
1243	All object members not explicitly documented (internal use) are prefixed	1893	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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