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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.83 by root, Thu Aug 21 19:11:37 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.232;	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
…		…
78		80
79	=item on_eof => $cb->($handle)	81	=item on_eof => $cb->($handle)
80		82
81	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,
82	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
83	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).
84		88
85	For sockets, this just means that the other side has stopped sending data,	89	For sockets, this just means that the other side has stopped sending data,
86	you can still try to write data, and, in fact, one can return from the eof	90	you can still try to write data, and, in fact, one can return from the EOF
87	callback and continue writing data, as only the read part has been shut	91	callback and continue writing data, as only the read part has been shut
88	down.	92	down.
89		93
90	While not mandatory, it is I<highly> recommended to set an eof callback,
91	otherwise you might end up with a closed socket while you are still
92	waiting for data.
93
94	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
95	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>.
96		96
97	=item on_error => $cb->($handle, $fatal)	97	=item on_error => $cb->($handle, $fatal, $message)
98		98
99	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
100	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
101	connect or a read error.	101	connect or a read error.
102		102
103	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
104	fatal errors the handle object will be shut down and will not be usable	104	fatal errors the handle object will be destroyed (by a call to C<< ->
105	(but you are free to look at the current C< ->rbuf >). Examples of fatal	105	destroy >>) after invoking the error callback (which means you are free to
106	errors are an EOF condition with active (but unsatisifable) read watchers	106	examine the handle object). Examples of fatal errors are an EOF condition
107	(C<EPIPE>) or I/O errors.	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<"$!">).
108		113
109	Non-fatal errors can be retried by simply returning, but it is recommended	114	Non-fatal errors can be retried by simply returning, but it is recommended
110	to simply ignore this parameter and instead abondon the handle object	115	to simply ignore this parameter and instead abondon the handle object
111	when this callback is invoked. Examples of non-fatal errors are timeouts	116	when this callback is invoked. Examples of non-fatal errors are timeouts
112	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	117	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
113		118
114	On callback entrance, the value of C<$!> contains the operating system	119	On callback entrance, the value of C<$!> contains the operating system
115	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>).
116		122
117	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
118	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
119	C<croak>.	125	C<croak>.
120		126
…		…
124	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
125	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
126	read buffer).	132	read buffer).
127		133
128	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 >>
129	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.
130		138
131	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
132	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
133	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
134	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.
135		148
136	=item on_drain => $cb->($handle)	149	=item on_drain => $cb->($handle)
137		150
138	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
139	(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).
…		…
149	=item timeout => $fractional_seconds	162	=item timeout => $fractional_seconds
150		163
151	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
152	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
153	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
154	missing, an C<ETIMEDOUT> error will be raised).	167	missing, a non-fatal C<ETIMEDOUT> error will be raised).
155		168
156	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
157	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
158	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
159	in the C<on_timeout> callback.	172	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		173	restart the timeout.
160		174
161	Zero (the default) disables this timeout.	175	Zero (the default) disables this timeout.
162		176
163	=item on_timeout => $cb->($handle)	177	=item on_timeout => $cb->($handle)
164		178
…		…
168		182
169	=item rbuf_max => <bytes>	183	=item rbuf_max => <bytes>
170		184
171	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>)
172	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
173	avoid denial-of-service attacks.	187	avoid some forms of denial-of-service attacks.
174		188
175	For example, a server accepting connections from untrusted sources should	189	For example, a server accepting connections from untrusted sources should
176	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
177	(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
178	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
179	isn't finished).	193	isn't finished).
180		194
181	=item autocork => <boolean>	195	=item autocork => <boolean>
182		196
183	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
184	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
185	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
186	inefficient if you write multiple small chunks (this disadvantage is	200	be inefficient if you write multiple small chunks (on the wire, this
187	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).
188		203
189	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
190	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,
191	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.
192		208
193	=item no_delay => <boolean>	209	=item no_delay => <boolean>
194		210
195	When doing small writes on sockets, your operating system kernel might	211	When doing small writes on sockets, your operating system kernel might
196	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
197	the Nagle algorithm, and usually it is beneficial.	213	the Nagle algorithm, and usually it is beneficial.
198		214
199	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
200	accomplishd by setting this option to true.	216	accomplishd by setting this option to a true value.
201		217
202	The default is your opertaing system's default behaviour, this option	218	The default is your opertaing system's default behaviour (most likely
203	explicitly enables or disables it, if possible.	219	enabled), this option explicitly enables or disables it, if possible.
204		220
205	=item read_size => <bytes>	221	=item read_size => <bytes>
206		222
207	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
208	during each (loop iteration). Default: C<8192>.	224	try to read during each loop iteration, which affects memory
		225	requirements). Default: C<8192>.
209		226
210	=item low_water_mark => <bytes>	227	=item low_water_mark => <bytes>
211		228
212	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
213	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
214	considered empty.	231	considered empty.
215		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
216	=item linger => <seconds>	238	=item linger => <seconds>
217		239
218	If non-zero (default: C<3600>), then the destructor of the	240	If non-zero (default: C<3600>), then the destructor of the
219	AnyEvent::Handle object will check wether there is still outstanding write	241	AnyEvent::Handle object will check whether there is still outstanding
220	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
221	will be reported (this mostly matches how the operating system treats	243	socket. No errors will be reported (this mostly matches how the operating
222	outstanding data at socket close time).	244	system treats outstanding data at socket close time).
223		245
224	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
225	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>.
226		259
227	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	260	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
228		261
229	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
230	will start making tls handshake and will transparently encrypt/decrypt	263	AnyEvent will start a TLS handshake as soon as the conenction has been
231	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.
232		268
233	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
234	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.
235		273
236	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
237	connection, use C<connect> mode.	275	C<accept>, and for the TLS client side of a connection, use C<connect>
		276	mode.
238		277
239	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
240	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>
241	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
242	AnyEvent::Handle.	281	AnyEvent::Handle. Also, this module will take ownership of this connection
		282	object.
243		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
244	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.
245		294
246	=item tls_ctx => $ssl_ctx	295	=item tls_ctx => $anyevent_tls
247		296
248	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
249	(unless a connection object was specified directly). If this parameter is	298	(unless a connection object was specified directly). If this parameter is
250	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	299	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
251		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
252	=item json => JSON or JSON::XS object	337	=item json => JSON or JSON::XS object
253		338
254	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.
255		340
256	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
257	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.
258		344
259	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
260	use this functionality, as AnyEvent does not have a dependency itself.	346	use this functionality, as AnyEvent does not have a dependency itself.
261		347
262	=item filter_r => $cb
263
264	=item filter_w => $cb
265
266	These exist, but are undocumented at this time.
267
268	=back	348	=back
269		349
270	=cut	350	=cut
271		351
272	sub new {	352	sub new {
273	my $class = shift;	353	my $class = shift;
274
275	my $self = bless { @_ }, $class;	354	my $self = bless { @_ }, $class;
276		355
277	$self->{fh} or Carp::croak "mandatory argument fh is missing";	356	$self->{fh} or Carp::croak "mandatory argument fh is missing";
278		357
279	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	358	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
280
281	if ($self->{tls}) {
282	require Net::SSLeay;
283	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
284	}
285		359
286	$self->{_activity} = AnyEvent->now;	360	$self->{_activity} = AnyEvent->now;
287	$self->_timeout;	361	$self->_timeout;
288		362
289	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
290	$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};
291		369
292	$self->start_read	370	$self->start_read
293	if $self->{on_read};	371	if $self->{on_read};
294		372
295	$self	373	$self->{fh} && $self
296	}	374	}
297		375
298	sub _shutdown {	376	#sub _shutdown {
299	my ($self) = @_;	377	# my ($self) = @_;
300		378	#
301	delete $self->{_tw};	379	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
302	delete $self->{_rw};	380	# $self->{_eof} = 1; # tell starttls et. al to stop trying
303	delete $self->{_ww};	381	#
304	delete $self->{fh};	382	# &_freetls;
305		383	#}
306	$self->stoptls;
307
308	delete $self->{on_read};
309	delete $self->{_queue};
310	}
311		384
312	sub _error {	385	sub _error {
313	my ($self, $errno, $fatal) = @_;	386	my ($self, $errno, $fatal, $message) = @_;
314
315	$self->_shutdown
316	if $fatal;
317		387
318	$! = $errno;	388	$! = $errno;
		389	$message \|\|= "$!";
319		390
320	if ($self->{on_error}) {	391	if ($self->{on_error}) {
321	$self->{on_error}($self, $fatal);	392	$self->{on_error}($self, $fatal, $message);
322	} else {	393	$self->destroy;
		394	} elsif ($self->{fh}) {
		395	$self->destroy;
323	Carp::croak "AnyEvent::Handle uncaught error: $!";	396	Carp::croak "AnyEvent::Handle uncaught error: $message";
324	}	397	}
325	}	398	}
326		399
327	=item $fh = $handle->fh	400	=item $fh = $handle->fh
328		401
329	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.
330		403
331	=cut	404	=cut
332		405
333	sub fh { $_[0]{fh} }	406	sub fh { $_[0]{fh} }
334		407
…		…
352	$_[0]{on_eof} = $_[1];	425	$_[0]{on_eof} = $_[1];
353	}	426	}
354		427
355	=item $handle->on_timeout ($cb)	428	=item $handle->on_timeout ($cb)
356		429
357	Replace the current C<on_timeout> callback, or disables the callback	430	Replace the current C<on_timeout> callback, or disables the callback (but
358	(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
359	argument.	432	argument and method.
360		433
361	=cut	434	=cut
362		435
363	sub on_timeout {	436	sub on_timeout {
364	$_[0]{on_timeout} = $_[1];	437	$_[0]{on_timeout} = $_[1];
365	}	438	}
366		439
367	=item $handle->autocork ($boolean)	440	=item $handle->autocork ($boolean)
368		441
369	Enables or disables the current autocork behaviour (see C<autocork>	442	Enables or disables the current autocork behaviour (see C<autocork>
370	constructor argument).	443	constructor argument). Changes will only take effect on the next write.
371		444
372	=cut	445	=cut
		446
		447	sub autocork {
		448	$_[0]{autocork} = $_[1];
		449	}
373		450
374	=item $handle->no_delay ($boolean)	451	=item $handle->no_delay ($boolean)
375		452
376	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
377	the same name for details).	454	the same name for details).
…		…
385	local $SIG{__DIE__};	462	local $SIG{__DIE__};
386	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	463	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
387	};	464	};
388	}	465	}
389		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
390	#############################################################################	487	#############################################################################
391		488
392	=item $handle->timeout ($seconds)	489	=item $handle->timeout ($seconds)
393		490
394	Configures (or disables) the inactivity timeout.	491	Configures (or disables) the inactivity timeout.
…		…
418	$self->{_activity} = $NOW;	515	$self->{_activity} = $NOW;
419		516
420	if ($self->{on_timeout}) {	517	if ($self->{on_timeout}) {
421	$self->{on_timeout}($self);	518	$self->{on_timeout}($self);
422	} else {	519	} else {
423	$self->_error (&Errno::ETIMEDOUT);	520	$self->_error (Errno::ETIMEDOUT);
424	}	521	}
425		522
426	# callback could have changed timeout value, optimise	523	# callback could have changed timeout value, optimise
427	return unless $self->{timeout};	524	return unless $self->{timeout};
428		525
…		…
470	my ($self, $cb) = @_;	567	my ($self, $cb) = @_;
471		568
472	$self->{on_drain} = $cb;	569	$self->{on_drain} = $cb;
473		570
474	$cb->($self)	571	$cb->($self)
475	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	572	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
476	}	573	}
477		574
478	=item $handle->push_write ($data)	575	=item $handle->push_write ($data)
479		576
480	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
…		…
491	Scalar::Util::weaken $self;	588	Scalar::Util::weaken $self;
492		589
493	my $cb = sub {	590	my $cb = sub {
494	my $len = syswrite $self->{fh}, $self->{wbuf};	591	my $len = syswrite $self->{fh}, $self->{wbuf};
495		592
496	if ($len >= 0) {	593	if (defined $len) {
497	substr $self->{wbuf}, 0, $len, "";	594	substr $self->{wbuf}, 0, $len, "";
498		595
499	$self->{_activity} = AnyEvent->now;	596	$self->{_activity} = AnyEvent->now;
500		597
501	$self->{on_drain}($self)	598	$self->{on_drain}($self)
502	if $self->{low_water_mark} >= length $self->{wbuf}	599	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
503	&& $self->{on_drain};	600	&& $self->{on_drain};
504		601
505	delete $self->{_ww} unless length $self->{wbuf};	602	delete $self->{_ww} unless length $self->{wbuf};
506	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	603	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
507	$self->_error ($!, 1);	604	$self->_error ($!, 1);
…		…
531		628
532	@_ = ($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")
533	->($self, @_);	630	->($self, @_);
534	}	631	}
535		632
536	if ($self->{filter_w}) {	633	if ($self->{tls}) {
537	$self->{filter_w}($self, \$_[0]);	634	$self->{_tls_wbuf} .= $_[0];
		635
		636	&_dotls ($self);
538	} else {	637	} else {
539	$self->{wbuf} .= $_[0];	638	$self->{wbuf} .= $_[0];
540	$self->_drain_wbuf;	639	$self->_drain_wbuf;
541	}	640	}
542	}	641	}
…		…
559	=cut	658	=cut
560		659
561	register_write_type netstring => sub {	660	register_write_type netstring => sub {
562	my ($self, $string) = @_;	661	my ($self, $string) = @_;
563		662
564	sprintf "%d:%s,", (length $string), $string	663	(length $string) . ":$string,"
565	};	664	};
566		665
567	=item packstring => $format, $data	666	=item packstring => $format, $data
568		667
569	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>
…		…
634		733
635	pack "w/a*", Storable::nfreeze ($ref)	734	pack "w/a*", Storable::nfreeze ($ref)
636	};	735	};
637		736
638	=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	}
639		763
640	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	764	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
641		765
642	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>.
643	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
…		…
743		867
744	if (	868	if (
745	defined $self->{rbuf_max}	869	defined $self->{rbuf_max}
746	&& $self->{rbuf_max} < length $self->{rbuf}	870	&& $self->{rbuf_max} < length $self->{rbuf}
747	) {	871	) {
748	$self->_error (&Errno::ENOSPC, 1), return;	872	$self->_error (Errno::ENOSPC, 1), return;
749	}	873	}
750		874
751	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
752	my $len = length $self->{rbuf};	880	my $len = length $self->{rbuf};
753		881
754	if (my $cb = shift @{ $self->{_queue} }) {	882	if (my $cb = shift @{ $self->{_queue} }) {
755	unless ($cb->($self)) {	883	unless ($cb->($self)) {
756	if ($self->{_eof}) {	884	if ($self->{_eof}) {
757	# 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)
758	$self->_error (&Errno::EPIPE, 1), return;	886	$self->_error (Errno::EPIPE, 1), return;
759	}	887	}
760		888
761	unshift @{ $self->{_queue} }, $cb;	889	unshift @{ $self->{_queue} }, $cb;
762	last;	890	last;
763	}	891	}
…		…
771	&& !@{ $self->{_queue} } # and the queue is still empty	899	&& !@{ $self->{_queue} } # and the queue is still empty
772	&& $self->{on_read} # but we still have on_read	900	&& $self->{on_read} # but we still have on_read
773	) {	901	) {
774	# no further data will arrive	902	# no further data will arrive
775	# so no progress can be made	903	# so no progress can be made
776	$self->_error (&Errno::EPIPE, 1), return	904	$self->_error (Errno::EPIPE, 1), return
777	if $self->{_eof};	905	if $self->{_eof};
778		906
779	last; # more data might arrive	907	last; # more data might arrive
780	}	908	}
781	} else {	909	} else {
782	# read side becomes idle	910	# read side becomes idle
783	delete $self->{_rw};	911	delete $self->{_rw} unless $self->{tls};
784	last;	912	last;
785	}	913	}
786	}	914	}
787		915
788	if ($self->{_eof}) {	916	if ($self->{_eof}) {
789	if ($self->{on_eof}) {	917	if ($self->{on_eof}) {
790	$self->{on_eof}($self)	918	$self->{on_eof}($self)
791	} else {	919	} else {
792	$self->_error (0, 1);	920	$self->_error (0, 1, "Unexpected end-of-file");
793	}	921	}
794	}	922	}
795		923
796	# may need to restart read watcher	924	# may need to restart read watcher
797	unless ($self->{_rw}) {	925	unless ($self->{_rw}) {
…		…
817		945
818	=item $handle->rbuf	946	=item $handle->rbuf
819		947
820	Returns the read buffer (as a modifiable lvalue).	948	Returns the read buffer (as a modifiable lvalue).
821		949
822	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} >>
823	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.
824		955
825	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>,
826	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
827	automatically manage the read buffer.	958	automatically manage the read buffer.
828		959
…		…
1028	return 1;	1159	return 1;
1029	}	1160	}
1030		1161
1031	# reject	1162	# reject
1032	if ($reject && $$rbuf =~ $reject) {	1163	if ($reject && $$rbuf =~ $reject) {
1033	$self->_error (&Errno::EBADMSG);	1164	$self->_error (Errno::EBADMSG);
1034	}	1165	}
1035		1166
1036	# skip	1167	# skip
1037	if ($skip && $$rbuf =~ $skip) {	1168	if ($skip && $$rbuf =~ $skip) {
1038	$data .= substr $$rbuf, 0, $+[0], "";	1169	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1054	my ($self, $cb) = @_;	1185	my ($self, $cb) = @_;
1055		1186
1056	sub {	1187	sub {
1057	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1188	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1058	if ($_[0]{rbuf} =~ /[^0-9]/) {	1189	if ($_[0]{rbuf} =~ /[^0-9]/) {
1059	$self->_error (&Errno::EBADMSG);	1190	$self->_error (Errno::EBADMSG);
1060	}	1191	}
1061	return;	1192	return;
1062	}	1193	}
1063		1194
1064	my $len = $1;	1195	my $len = $1;
…		…
1067	my $string = $_[1];	1198	my $string = $_[1];
1068	$_[0]->unshift_read (chunk => 1, sub {	1199	$_[0]->unshift_read (chunk => 1, sub {
1069	if ($_[1] eq ",") {	1200	if ($_[1] eq ",") {
1070	$cb->($_[0], $string);	1201	$cb->($_[0], $string);
1071	} else {	1202	} else {
1072	$self->_error (&Errno::EBADMSG);	1203	$self->_error (Errno::EBADMSG);
1073	}	1204	}
1074	});	1205	});
1075	});	1206	});
1076		1207
1077	1	1208	1
…		…
1083	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>
1084	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
1085	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1216	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1086	optional C<!>, C<< < >> or C<< > >> modifier).	1217	optional C<!>, C<< < >> or C<< > >> modifier).
1087		1218
1088	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).
1089		1221
1090	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
1091	format (very efficient).	1223	format (very efficient).
1092		1224
1093	$handle->push_read (packstring => "w", sub {	1225	$handle->push_read (packstring => "w", sub {
…		…
1123	}	1255	}
1124	};	1256	};
1125		1257
1126	=item json => $cb->($handle, $hash_or_arrayref)	1258	=item json => $cb->($handle, $hash_or_arrayref)
1127		1259
1128	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.
1129		1262
1130	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
1131	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.
1132		1265
1133	This read type uses the incremental parser available with JSON version	1266	This read type uses the incremental parser available with JSON version
…		…
1142	=cut	1275	=cut
1143		1276
1144	register_read_type json => sub {	1277	register_read_type json => sub {
1145	my ($self, $cb) = @_;	1278	my ($self, $cb) = @_;
1146		1279
1147	require JSON;	1280	my $json = $self->{json} \|\|=
		1281	eval { require JSON::XS; JSON::XS->new->utf8 }
		1282	\|\| do { require JSON; JSON->new->utf8 };
1148		1283
1149	my $data;	1284	my $data;
1150	my $rbuf = \$self->{rbuf};	1285	my $rbuf = \$self->{rbuf};
1151		1286
1152	my $json = $self->{json} \|\|= JSON->new->utf8;
1153
1154	sub {	1287	sub {
1155	my $ref = $json->incr_parse ($self->{rbuf});	1288	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1156		1289
1157	if ($ref) {	1290	if ($ref) {
1158	$self->{rbuf} = $json->incr_text;	1291	$self->{rbuf} = $json->incr_text;
1159	$json->incr_text = "";	1292	$json->incr_text = "";
1160	$cb->($self, $ref);	1293	$cb->($self, $ref);
1161		1294
1162	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	()
1163	} else {	1306	} else {
1164	$self->{rbuf} = "";	1307	$self->{rbuf} = "";
		1308
1165	()	1309	()
1166	}	1310	}
1167	}	1311	}
1168	};	1312	};
1169		1313
…		…
1201	# read remaining chunk	1345	# read remaining chunk
1202	$_[0]->unshift_read (chunk => $len, sub {	1346	$_[0]->unshift_read (chunk => $len, sub {
1203	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1347	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1204	$cb->($_[0], $ref);	1348	$cb->($_[0], $ref);
1205	} else {	1349	} else {
1206	$self->_error (&Errno::EBADMSG);	1350	$self->_error (Errno::EBADMSG);
1207	}	1351	}
1208	});	1352	});
1209	}	1353	}
1210		1354
1211	1	1355	1
…		…
1246	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
1247	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
1248	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
1249	there are any read requests in the queue.	1393	there are any read requests in the queue.
1250		1394
		1395	These methods will have no effect when in TLS mode (as TLS doesn't support
		1396	half-duplex connections).
		1397
1251	=cut	1398	=cut
1252		1399
1253	sub stop_read {	1400	sub stop_read {
1254	my ($self) = @_;	1401	my ($self) = @_;
1255		1402
1256	delete $self->{_rw};	1403	delete $self->{_rw} unless $self->{tls};
1257	}	1404	}
1258		1405
1259	sub start_read {	1406	sub start_read {
1260	my ($self) = @_;	1407	my ($self) = @_;
1261		1408
1262	unless ($self->{_rw} \|\| $self->{_eof}) {	1409	unless ($self->{_rw} \|\| $self->{_eof}) {
1263	Scalar::Util::weaken $self;	1410	Scalar::Util::weaken $self;
1264		1411
1265	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1412	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1266	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1413	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1267	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;
1268		1415
1269	if ($len > 0) {	1416	if ($len > 0) {
1270	$self->{_activity} = AnyEvent->now;	1417	$self->{_activity} = AnyEvent->now;
1271		1418
1272	$self->{filter_r}	1419	if ($self->{tls}) {
1273	? $self->{filter_r}($self, $rbuf)	1420	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1274	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1421
		1422	&_dotls ($self);
		1423	} else {
		1424	$self->_drain_rbuf unless $self->{_in_drain};
		1425	}
1275		1426
1276	} elsif (defined $len) {	1427	} elsif (defined $len) {
1277	delete $self->{_rw};	1428	delete $self->{_rw};
1278	$self->{_eof} = 1;	1429	$self->{_eof} = 1;
1279	$self->_drain_rbuf unless $self->{_in_drain};	1430	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1283	}	1434	}
1284	});	1435	});
1285	}	1436	}
1286	}	1437	}
1287		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.
1288	sub _dotls {	1467	sub _dotls {
1289	my ($self) = @_;	1468	my ($self) = @_;
1290		1469
1291	my $buf;	1470	my $tmp;
1292		1471
1293	if (length $self->{_tls_wbuf}) {	1472	if (length $self->{_tls_wbuf}) {
1294	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1473	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1295	substr $self->{_tls_wbuf}, 0, $len, "";	1474	substr $self->{_tls_wbuf}, 0, $tmp, "";
1296	}	1475	}
1297	}
1298		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
1299	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1509	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1300	$self->{wbuf} .= $buf;	1510	$self->{wbuf} .= $tmp;
1301	$self->_drain_wbuf;	1511	$self->_drain_wbuf;
1302	}	1512	}
1303		1513
1304	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1514	$self->{_on_starttls}
1305	if (length $buf) {	1515	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1306	$self->{rbuf} .= $buf;	1516	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1307	$self->_drain_rbuf unless $self->{_in_drain};
1308	} else {
1309	# let's treat SSL-eof as we treat normal EOF
1310	$self->{_eof} = 1;
1311	$self->_shutdown;
1312	return;
1313	}
1314	}
1315
1316	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1317
1318	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1319	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1320	return $self->_error ($!, 1);
1321	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1322	return $self->_error (&Errno::EIO, 1);
1323	}
1324
1325	# all others are fine for our purposes
1326	}
1327	}	1517	}
1328		1518
1329	=item $handle->starttls ($tls[, $tls_ctx])	1519	=item $handle->starttls ($tls[, $tls_ctx])
1330		1520
1331	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1521	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1333	C<starttls>.	1523	C<starttls>.
1334		1524
1335	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
1336	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1526	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1337		1527
1338	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
1339	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.
1340		1532
1341	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
1342	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
1343	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.
1344		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
1345	=cut	1541	=cut
		1542
		1543	our %TLS_CACHE; #TODO not yet documented, should we?
1346		1544
1347	sub starttls {	1545	sub starttls {
1348	my ($self, $ssl, $ctx) = @_;	1546	my ($self, $ssl, $ctx) = @_;
1349		1547
1350	$self->stoptls;	1548	require Net::SSLeay;
1351		1549
1352	if ($ssl eq "accept") {	1550	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1353	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1551	if $self->{tls};
1354	Net::SSLeay::set_accept_state ($ssl);	1552
1355	} elsif ($ssl eq "connect") {	1553	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1356	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1554	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1357	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	}
1358	}	1570
1359		1571	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1360	$self->{tls} = $ssl;	1572	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1361		1573
1362	# 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)
1363	# but the openssl maintainers basically said: "trust us, it just works".	1575	# but the openssl maintainers basically said: "trust us, it just works".
1364	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1576	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1365	# and mismaintained ssleay-module doesn't even offer them).	1577	# and mismaintained ssleay-module doesn't even offer them).
1366	# 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.
1367	Net::SSLeay::CTX_set_mode ($self->{tls},	1586	# Net::SSLeay::CTX_set_mode ($ssl,
1368	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1587	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1369	\| (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);
1370		1590
1371	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1591	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1372	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1592	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1373		1593
1374	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1594	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1375		1595
1376	$self->{filter_w} = sub {	1596	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1377	$_[0]{_tls_wbuf} .= ${$_[1]};	1597	if $self->{on_starttls};
1378	&_dotls;	1598
1379	};	1599	&_dotls; # need to trigger the initial handshake
1380	$self->{filter_r} = sub {	1600	$self->start_read; # make sure we actually do read
1381	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1382	&_dotls;
1383	};
1384	}	1601	}
1385		1602
1386	=item $handle->stoptls	1603	=item $handle->stoptls
1387		1604
1388	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
1389	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.
1390		1609
1391	=cut	1610	=cut
1392		1611
1393	sub stoptls {	1612	sub stoptls {
1394	my ($self) = @_;	1613	my ($self) = @_;
1395		1614
1396	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1615	if ($self->{tls}) {
		1616	Net::SSLeay::shutdown ($self->{tls});
1397		1617
1398	delete $self->{_rbio};	1618	&_dotls;
1399	delete $self->{_wbio};	1619
1400	delete $self->{_tls_wbuf};	1620	# # we don't give a shit. no, we do, but we can't. no...#d#
1401	delete $self->{filter_r};	1621	# # we, we... have to use openssl :/#d#
1402	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)};
1403	}	1634	}
1404		1635
1405	sub DESTROY {	1636	sub DESTROY {
1406	my $self = shift;	1637	my ($self) = @_;
1407		1638
1408	$self->stoptls;	1639	&_freetls;
1409		1640
1410	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1641	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1411		1642
1412	if ($linger && length $self->{wbuf}) {	1643	if ($linger && length $self->{wbuf}) {
1413	my $fh = delete $self->{fh};	1644	my $fh = delete $self->{fh};
…		…
1428	@linger = ();	1659	@linger = ();
1429	});	1660	});
1430	}	1661	}
1431	}	1662	}
1432		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
1433	=item AnyEvent::Handle::TLS_CTX	1694	=item AnyEvent::Handle::TLS_CTX
1434		1695
1435	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
1436	default for TLS mode.	1697	for TLS mode.
1437		1698
1438	The context is created like this:	1699	The context is created by calling L<AnyEvent::TLS> without any arguments.
1439
1440	Net::SSLeay::load_error_strings;
1441	Net::SSLeay::SSLeay_add_ssl_algorithms;
1442	Net::SSLeay::randomize;
1443
1444	my $CTX = Net::SSLeay::CTX_new;
1445
1446	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1447		1700
1448	=cut	1701	=cut
1449		1702
1450	our $TLS_CTX;	1703	our $TLS_CTX;
1451		1704
1452	sub TLS_CTX() {	1705	sub TLS_CTX() {
1453	$TLS_CTX \|\| do {	1706	$TLS_CTX \|\|= do {
1454	require Net::SSLeay;	1707	require AnyEvent::TLS;
1455		1708
1456	Net::SSLeay::load_error_strings ();	1709	new AnyEvent::TLS
1457	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1458	Net::SSLeay::randomize ();
1459
1460	$TLS_CTX = Net::SSLeay::CTX_new ();
1461
1462	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1463
1464	$TLS_CTX
1465	}	1710	}
1466	}	1711	}
1467		1712
1468	=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
1469		1873
1470	=head1 SUBCLASSING AnyEvent::Handle	1874	=head1 SUBCLASSING AnyEvent::Handle
1471		1875
1472	In many cases, you might want to subclass AnyEvent::Handle.	1876	In many cases, you might want to subclass AnyEvent::Handle.
1473		1877

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.83 by root, Thu Aug 21 19:11:37 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.83 by root, Thu Aug 21 19:11:37 2008 UTC vs.
Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC