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

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.152 by root, Fri Jul 17 14:57:03 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.152 by root, Fri Jul 17 14:57:03 2009 UTC