[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.80 by root, Sun Jul 27 08:43:32 2008 UTC vs.
Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.80 by root, Sun Jul 27 08:43:32 2008 UTC vs. Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.80 by root, Sun Jul 27 08:43:32 2008 UTC vs.
Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC