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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.124 by root, Sun Apr 26 18:12:53 2009 UTC vs.
Revision 1.174 by root, Sat Aug 8 20:52:06 2009 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	3	use Scalar::Util ();
9	use Carp ();	4	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);	5	use Errno qw(EAGAIN EINTR);
12		6
		7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		9
13	=head1 NAME	10	=head1 NAME
14		11
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		13
17	=cut	14	=cut
18		15
19	our $VERSION = 4.4;	16	our $VERSION = 4.91;
20		17
21	=head1 SYNOPSIS	18	=head1 SYNOPSIS
22		19
23	use AnyEvent;	20	use AnyEvent;
24	use AnyEvent::Handle;	21	use AnyEvent::Handle;
25		22
26	my $cv = AnyEvent->condvar;	23	my $cv = AnyEvent->condvar;
27		24
28	my $handle =	25	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	26	fh => \*STDIN,
31	on_eof => sub {	27	on_error => sub {
		28	my ($hdl, $fatal, $msg) = @_;
		29	warn "got error $msg\n";
		30	$hdl->destroy;
32	$cv->send;	31	$cv->send;
33	},
34	);	32	);
35		33
36	# send some request line	34	# send some request line
37	$handle->push_write ("getinfo\015\012");	35	$hdl->push_write ("getinfo\015\012");
38		36
39	# read the response line	37	# read the response line
40	$handle->push_read (line => sub {	38	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	39	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	40	warn "got line <$line>\n";
43	$cv->send;	41	$cv->send;
44	});	42	});
45		43
46	$cv->recv;	44	$cv->recv;
47		45
48	=head1 DESCRIPTION	46	=head1 DESCRIPTION
49		47
50	This module is a helper module to make it easier to do event-based I/O on	48	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	49	filehandles.
52	on sockets see L<AnyEvent::Util>.
53		50
54	The L<AnyEvent::Intro> tutorial contains some well-documented	51	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	52	AnyEvent::Handle examples.
56		53
57	In the following, when the documentation refers to of "bytes" then this	54	In the following, when the documentation refers to of "bytes" then this
58	means characters. As sysread and syswrite are used for all I/O, their	55	means characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
60		57
		58	At the very minimum, you should specify C<fh> or C<connect>, and the
		59	C<on_error> callback.
		60
61	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
62	argument.	62	argument.
63		63
64	=head1 METHODS	64	=head1 METHODS
65		65
66	=over 4	66	=over 4
67		67
68	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		69
70	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
71		71
72	=over 4	72	=over 4
73		73
74	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		75
76	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	77	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	79	that mode.
81		80
		81	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		82
		83	Try to connect to the specified host and service (port), using
		84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		85	default C<peername>.
		86
		87	You have to specify either this parameter, or C<fh>, above.
		88
		89	It is possible to push requests on the read and write queues, and modify
		90	properties of the stream, even while AnyEvent::Handle is connecting.
		91
		92	When this parameter is specified, then the C<on_prepare>,
		93	C<on_connect_error> and C<on_connect> callbacks will be called under the
		94	appropriate circumstances:
		95
		96	=over 4
		97
		98	=item on_prepare => $cb->($handle)
		99
		100	This (rarely used) callback is called before a new connection is
		101	attempted, but after the file handle has been created. It could be used to
		102	prepare the file handle with parameters required for the actual connect
		103	(as opposed to settings that can be changed when the connection is already
		104	established).
		105
		106	The return value of this callback should be the connect timeout value in
		107	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		108	timeout is to be used).
		109
		110	=item on_connect => $cb->($handle, $host, $port, $retry->())
		111
		112	This callback is called when a connection has been successfully established.
		113
		114	The actual numeric host and port (the socket peername) are passed as
		115	parameters, together with a retry callback.
		116
		117	When, for some reason, the handle is not acceptable, then calling
		118	C<$retry> will continue with the next conenction target (in case of
		119	multi-homed hosts or SRV records there can be multiple connection
		120	endpoints). When it is called then the read and write queues, eof status,
		121	tls status and similar properties of the handle are being reset.
		122
		123	In most cases, ignoring the C<$retry> parameter is the way to go.
		124
		125	=item on_connect_error => $cb->($handle, $message)
		126
		127	This callback is called when the conenction could not be
		128	established. C<$!> will contain the relevant error code, and C<$message> a
		129	message describing it (usually the same as C<"$!">).
		130
		131	If this callback isn't specified, then C<on_error> will be called with a
		132	fatal error instead.
		133
		134	=back
		135
		136	=item on_error => $cb->($handle, $fatal, $message)
		137
		138	This is the error callback, which is called when, well, some error
		139	occured, such as not being able to resolve the hostname, failure to
		140	connect or a read error.
		141
		142	Some errors are fatal (which is indicated by C<$fatal> being true). On
		143	fatal errors the handle object will be destroyed (by a call to C<< ->
		144	destroy >>) after invoking the error callback (which means you are free to
		145	examine the handle object). Examples of fatal errors are an EOF condition
		146	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		147	cases where the other side can close the connection at their will it is
		148	often easiest to not report C<EPIPE> errors in this callback.
		149
		150	AnyEvent::Handle tries to find an appropriate error code for you to check
		151	against, but in some cases (TLS errors), this does not work well. It is
		152	recommended to always output the C<$message> argument in human-readable
		153	error messages (it's usually the same as C<"$!">).
		154
		155	Non-fatal errors can be retried by simply returning, but it is recommended
		156	to simply ignore this parameter and instead abondon the handle object
		157	when this callback is invoked. Examples of non-fatal errors are timeouts
		158	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		159
		160	On callback entrance, the value of C<$!> contains the operating system
		161	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		162	C<EPROTO>).
		163
		164	While not mandatory, it is I<highly> recommended to set this callback, as
		165	you will not be notified of errors otherwise. The default simply calls
		166	C<croak>.
		167
		168	=item on_read => $cb->($handle)
		169
		170	This sets the default read callback, which is called when data arrives
		171	and no read request is in the queue (unlike read queue callbacks, this
		172	callback will only be called when at least one octet of data is in the
		173	read buffer).
		174
		175	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		176	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		177	must not enlarge or modify the read buffer, you can only remove data at
		178	the beginning from it.
		179
		180	When an EOF condition is detected then AnyEvent::Handle will first try to
		181	feed all the remaining data to the queued callbacks and C<on_read> before
		182	calling the C<on_eof> callback. If no progress can be made, then a fatal
		183	error will be raised (with C<$!> set to C<EPIPE>).
		184
		185	Note that, unlike requests in the read queue, an C<on_read> callback
		186	doesn't mean you I<require> some data: if there is an EOF and there
		187	are outstanding read requests then an error will be flagged. With an
		188	C<on_read> callback, the C<on_eof> callback will be invoked.
		189
82	=item on_eof => $cb->($handle)	190	=item on_eof => $cb->($handle)
83		191
84	Set the callback to be called when an end-of-file condition is detected,	192	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	193	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	194	connection cleanly, and there are no outstanding read requests in the
		195	queue (if there are read requests, then an EOF counts as an unexpected
		196	connection close and will be flagged as an error).
87		197
88	For sockets, this just means that the other side has stopped sending data,	198	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	199	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	200	callback and continue writing data, as only the read part has been shut
91	down.	201	down.
92		202
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	203	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	204	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal)
101
102	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.
105
106	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.
111
112	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116
117	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
119
120	While not mandatory, it is I<highly> recommended to set this callback, as
121	you will not be notified of errors otherwise. The default simply calls
122	C<croak>.
123
124	=item on_read => $cb->($handle)
125
126	This sets the default read callback, which is called when data arrives
127	and no read request is in the queue (unlike read queue callbacks, this
128	callback will only be called when at least one octet of data is in the
129	read buffer).
130
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly. Note that you
133	must not enlarge or modify the read buffer, you can only remove data at
134	the beginning from it.
135
136	When an EOF condition is detected then AnyEvent::Handle will first try to
137	feed all the remaining data to the queued callbacks and C<on_read> before
138	calling the C<on_eof> callback. If no progress can be made, then a fatal
139	error will be raised (with C<$!> set to C<EPIPE>).
140		205
141	=item on_drain => $cb->($handle)	206	=item on_drain => $cb->($handle)
142		207
143	This sets the callback that is called when the write buffer becomes empty	208	This sets the callback that is called when the write buffer becomes empty
144	(or when the callback is set and the buffer is empty already).	209	(or when the callback is set and the buffer is empty already).
237		302
238	This will not work for partial TLS data that could not be encoded	303	This will not work for partial TLS data that could not be encoded
239	yet. This data will be lost. Calling the C<stoptls> method in time might	304	yet. This data will be lost. Calling the C<stoptls> method in time might
240	help.	305	help.
241		306
		307	=item peername => $string
		308
		309	A string used to identify the remote site - usually the DNS hostname
		310	(I<not> IDN!) used to create the connection, rarely the IP address.
		311
		312	Apart from being useful in error messages, this string is also used in TLS
		313	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		314	verification will be skipped when C<peername> is not specified or
		315	C<undef>.
		316
242	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	317	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
243		318
244	When this parameter is given, it enables TLS (SSL) mode, that means	319	When this parameter is given, it enables TLS (SSL) mode, that means
245	AnyEvent will start a TLS handshake as soon as the conenction has been	320	AnyEvent will start a TLS handshake as soon as the conenction has been
246	established and will transparently encrypt/decrypt data afterwards.	321	established and will transparently encrypt/decrypt data afterwards.
		322
		323	All TLS protocol errors will be signalled as C<EPROTO>, with an
		324	appropriate error message.
247		325
248	TLS mode requires Net::SSLeay to be installed (it will be loaded	326	TLS mode requires Net::SSLeay to be installed (it will be loaded
249	automatically when you try to create a TLS handle): this module doesn't	327	automatically when you try to create a TLS handle): this module doesn't
250	have a dependency on that module, so if your module requires it, you have	328	have a dependency on that module, so if your module requires it, you have
251	to add the dependency yourself.	329	to add the dependency yourself.
…		…
255	mode.	333	mode.
256		334
257	You can also provide your own TLS connection object, but you have	335	You can also provide your own TLS connection object, but you have
258	to make sure that you call either C<Net::SSLeay::set_connect_state>	336	to make sure that you call either C<Net::SSLeay::set_connect_state>
259	or C<Net::SSLeay::set_accept_state> on it before you pass it to	337	or C<Net::SSLeay::set_accept_state> on it before you pass it to
260	AnyEvent::Handle.	338	AnyEvent::Handle. Also, this module will take ownership of this connection
		339	object.
		340
		341	At some future point, AnyEvent::Handle might switch to another TLS
		342	implementation, then the option to use your own session object will go
		343	away.
261		344
262	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	345	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
263	passing in the wrong integer will lead to certain crash. This most often	346	passing in the wrong integer will lead to certain crash. This most often
264	happens when one uses a stylish C<< tls => 1 >> and is surprised about the	347	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
265	segmentation fault.	348	segmentation fault.
266		349
267	See the C<< ->starttls >> method for when need to start TLS negotiation later.	350	See the C<< ->starttls >> method for when need to start TLS negotiation later.
268		351
269	=item tls_ctx => $ssl_ctx	352	=item tls_ctx => $anyevent_tls
270		353
271	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	354	Use the given C<AnyEvent::TLS> object to create the new TLS connection
272	(unless a connection object was specified directly). If this parameter is	355	(unless a connection object was specified directly). If this parameter is
273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	356	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		357
		358	Instead of an object, you can also specify a hash reference with C<< key
		359	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		360	new TLS context object.
		361
		362	=item on_starttls => $cb->($handle, $success[, $error_message])
		363
		364	This callback will be invoked when the TLS/SSL handshake has finished. If
		365	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		366	(C<on_stoptls> will not be called in this case).
		367
		368	The session in C<< $handle->{tls} >> can still be examined in this
		369	callback, even when the handshake was not successful.
		370
		371	TLS handshake failures will not cause C<on_error> to be invoked when this
		372	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		373
		374	Without this callback, handshake failures lead to C<on_error> being
		375	called, as normal.
		376
		377	Note that you cannot call C<starttls> right again in this callback. If you
		378	need to do that, start an zero-second timer instead whose callback can
		379	then call C<< ->starttls >> again.
		380
		381	=item on_stoptls => $cb->($handle)
		382
		383	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		384	set, then it will be invoked after freeing the TLS session. If it is not,
		385	then a TLS shutdown condition will be treated like a normal EOF condition
		386	on the handle.
		387
		388	The session in C<< $handle->{tls} >> can still be examined in this
		389	callback.
		390
		391	This callback will only be called on TLS shutdowns, not when the
		392	underlying handle signals EOF.
274		393
275	=item json => JSON or JSON::XS object	394	=item json => JSON or JSON::XS object
276		395
277	This is the json coder object used by the C<json> read and write types.	396	This is the json coder object used by the C<json> read and write types.
278		397
…		…
287		406
288	=cut	407	=cut
289		408
290	sub new {	409	sub new {
291	my $class = shift;	410	my $class = shift;
292
293	my $self = bless { @_ }, $class;	411	my $self = bless { @_ }, $class;
294		412
295	$self->{fh} or Carp::croak "mandatory argument fh is missing";	413	if ($self->{fh}) {
		414	$self->_start;
		415	return unless $self->{fh}; # could be gone by now
		416
		417	} elsif ($self->{connect}) {
		418	require AnyEvent::Socket;
		419
		420	$self->{peername} = $self->{connect}[0]
		421	unless exists $self->{peername};
		422
		423	$self->{_skip_drain_rbuf} = 1;
		424
		425	{
		426	Scalar::Util::weaken (my $self = $self);
		427
		428	$self->{_connect} =
		429	AnyEvent::Socket::tcp_connect (
		430	$self->{connect}[0],
		431	$self->{connect}[1],
		432	sub {
		433	my ($fh, $host, $port, $retry) = @_;
		434
		435	if ($fh) {
		436	$self->{fh} = $fh;
		437
		438	delete $self->{_skip_drain_rbuf};
		439	$self->_start;
		440
		441	$self->{on_connect}
		442	and $self->{on_connect}($self, $host, $port, sub {
		443	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		444	$self->{_skip_drain_rbuf} = 1;
		445	&$retry;
		446	});
		447
		448	} else {
		449	if ($self->{on_connect_error}) {
		450	$self->{on_connect_error}($self, "$!");
		451	$self->destroy;
		452	} else {
		453	$self->_error ($!, 1);
		454	}
		455	}
		456	},
		457	sub {
		458	local $self->{fh} = $_[0];
		459
		460	$self->{on_prepare}
		461	? $self->{on_prepare}->($self)
		462	: ()
		463	}
		464	);
		465	}
		466
		467	} else {
		468	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		469	}
		470
		471	$self
		472	}
		473
		474	sub _start {
		475	my ($self) = @_;
296		476
297	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
		478
		479	$self->{_activity} = AnyEvent->now;
		480	$self->_timeout;
		481
		482	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
298		483
299	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	484	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
300	if $self->{tls};	485	if $self->{tls};
301		486
302	$self->{_activity} = AnyEvent->now;
303	$self->_timeout;
304
305	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
306	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
307		488
308	$self->start_read	489	$self->start_read
309	if $self->{on_read};	490	if $self->{on_read} \|\| @{ $self->{_queue} };
310		491
311	$self	492	$self->_drain_wbuf;
312	}	493	}
313		494
314	sub _shutdown {	495	#sub _shutdown {
315	my ($self) = @_;	496	# my ($self) = @_;
316		497	#
317	delete $self->{_tw};	498	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
318	delete $self->{_rw};	499	# $self->{_eof} = 1; # tell starttls et. al to stop trying
319	delete $self->{_ww};	500	#
320	delete $self->{fh};
321
322	&_freetls;	501	# &_freetls;
323		502	#}
324	delete $self->{on_read};
325	delete $self->{_queue};
326	}
327		503
328	sub _error {	504	sub _error {
329	my ($self, $errno, $fatal) = @_;	505	my ($self, $errno, $fatal, $message) = @_;
330
331	$self->_shutdown
332	if $fatal;
333		506
334	$! = $errno;	507	$! = $errno;
		508	$message \|\|= "$!";
335		509
336	if ($self->{on_error}) {	510	if ($self->{on_error}) {
337	$self->{on_error}($self, $fatal);	511	$self->{on_error}($self, $fatal, $message);
		512	$self->destroy if $fatal;
338	} elsif ($self->{fh}) {	513	} elsif ($self->{fh}) {
		514	$self->destroy;
339	Carp::croak "AnyEvent::Handle uncaught error: $!";	515	Carp::croak "AnyEvent::Handle uncaught error: $message";
340	}	516	}
341	}	517	}
342		518
343	=item $fh = $handle->fh	519	=item $fh = $handle->fh
344		520
…		…
401	sub no_delay {	577	sub no_delay {
402	$_[0]{no_delay} = $_[1];	578	$_[0]{no_delay} = $_[1];
403		579
404	eval {	580	eval {
405	local $SIG{__DIE__};	581	local $SIG{__DIE__};
406	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	582	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		583	if $_[0]{fh};
407	};	584	};
		585	}
		586
		587	=item $handle->on_starttls ($cb)
		588
		589	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		590
		591	=cut
		592
		593	sub on_starttls {
		594	$_[0]{on_starttls} = $_[1];
		595	}
		596
		597	=item $handle->on_stoptls ($cb)
		598
		599	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		600
		601	=cut
		602
		603	sub on_starttls {
		604	$_[0]{on_stoptls} = $_[1];
		605	}
		606
		607	=item $handle->rbuf_max ($max_octets)
		608
		609	Configures the C<rbuf_max> setting (C<undef> disables it).
		610
		611	=cut
		612
		613	sub rbuf_max {
		614	$_[0]{rbuf_max} = $_[1];
408	}	615	}
409		616
410	#############################################################################	617	#############################################################################
411		618
412	=item $handle->timeout ($seconds)	619	=item $handle->timeout ($seconds)
…		…
417		624
418	sub timeout {	625	sub timeout {
419	my ($self, $timeout) = @_;	626	my ($self, $timeout) = @_;
420		627
421	$self->{timeout} = $timeout;	628	$self->{timeout} = $timeout;
		629	delete $self->{_tw};
422	$self->_timeout;	630	$self->_timeout;
423	}	631	}
424		632
425	# reset the timeout watcher, as neccessary	633	# reset the timeout watcher, as neccessary
426	# also check for time-outs	634	# also check for time-outs
427	sub _timeout {	635	sub _timeout {
428	my ($self) = @_;	636	my ($self) = @_;
429		637
430	if ($self->{timeout}) {	638	if ($self->{timeout} && $self->{fh}) {
431	my $NOW = AnyEvent->now;	639	my $NOW = AnyEvent->now;
432		640
433	# when would the timeout trigger?	641	# when would the timeout trigger?
434	my $after = $self->{_activity} + $self->{timeout} - $NOW;	642	my $after = $self->{_activity} + $self->{timeout} - $NOW;
435		643
…		…
438	$self->{_activity} = $NOW;	646	$self->{_activity} = $NOW;
439		647
440	if ($self->{on_timeout}) {	648	if ($self->{on_timeout}) {
441	$self->{on_timeout}($self);	649	$self->{on_timeout}($self);
442	} else {	650	} else {
443	$self->_error (&Errno::ETIMEDOUT);	651	$self->_error (Errno::ETIMEDOUT);
444	}	652	}
445		653
446	# callback could have changed timeout value, optimise	654	# callback could have changed timeout value, optimise
447	return unless $self->{timeout};	655	return unless $self->{timeout};
448		656
…		…
511	Scalar::Util::weaken $self;	719	Scalar::Util::weaken $self;
512		720
513	my $cb = sub {	721	my $cb = sub {
514	my $len = syswrite $self->{fh}, $self->{wbuf};	722	my $len = syswrite $self->{fh}, $self->{wbuf};
515		723
516	if ($len >= 0) {	724	if (defined $len) {
517	substr $self->{wbuf}, 0, $len, "";	725	substr $self->{wbuf}, 0, $len, "";
518		726
519	$self->{_activity} = AnyEvent->now;	727	$self->{_activity} = AnyEvent->now;
520		728
521	$self->{on_drain}($self)	729	$self->{on_drain}($self)
…		…
553	->($self, @_);	761	->($self, @_);
554	}	762	}
555		763
556	if ($self->{tls}) {	764	if ($self->{tls}) {
557	$self->{_tls_wbuf} .= $_[0];	765	$self->{_tls_wbuf} .= $_[0];
558		766	&_dotls ($self) if $self->{fh};
559	&_dotls ($self);
560	} else {	767	} else {
561	$self->{wbuf} .= $_[0];	768	$self->{wbuf} .= $_[0];
562	$self->_drain_wbuf;	769	$self->_drain_wbuf if $self->{fh};
563	}	770	}
564	}	771	}
565		772
566	=item $handle->push_write (type => @args)	773	=item $handle->push_write (type => @args)
567		774
…		…
656		863
657	pack "w/a*", Storable::nfreeze ($ref)	864	pack "w/a*", Storable::nfreeze ($ref)
658	};	865	};
659		866
660	=back	867	=back
		868
		869	=item $handle->push_shutdown
		870
		871	Sometimes you know you want to close the socket after writing your data
		872	before it was actually written. One way to do that is to replace your
		873	C<on_drain> handler by a callback that shuts down the socket (and set
		874	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		875	replaces the C<on_drain> callback with:
		876
		877	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		878
		879	This simply shuts down the write side and signals an EOF condition to the
		880	the peer.
		881
		882	You can rely on the normal read queue and C<on_eof> handling
		883	afterwards. This is the cleanest way to close a connection.
		884
		885	=cut
		886
		887	sub push_shutdown {
		888	my ($self) = @_;
		889
		890	delete $self->{low_water_mark};
		891	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		892	}
661		893
662	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	894	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
663		895
664	This function (not method) lets you add your own types to C<push_write>.	896	This function (not method) lets you add your own types to C<push_write>.
665	Whenever the given C<type> is used, C<push_write> will invoke the code	897	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
759	=cut	991	=cut
760		992
761	sub _drain_rbuf {	993	sub _drain_rbuf {
762	my ($self) = @_;	994	my ($self) = @_;
763		995
		996	# avoid recursion
		997	return if $self->{_skip_drain_rbuf};
764	local $self->{_in_drain} = 1;	998	local $self->{_skip_drain_rbuf} = 1;
765
766	if (
767	defined $self->{rbuf_max}
768	&& $self->{rbuf_max} < length $self->{rbuf}
769	) {
770	$self->_error (&Errno::ENOSPC, 1), return;
771	}
772		999
773	while () {	1000	while () {
774	# we need to use a separate tls read buffer, as we must not receive data while	1001	# we need to use a separate tls read buffer, as we must not receive data while
775	# we are draining the buffer, and this can only happen with TLS.	1002	# we are draining the buffer, and this can only happen with TLS.
776	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1003	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1004	if exists $self->{_tls_rbuf};
777		1005
778	my $len = length $self->{rbuf};	1006	my $len = length $self->{rbuf};
779		1007
780	if (my $cb = shift @{ $self->{_queue} }) {	1008	if (my $cb = shift @{ $self->{_queue} }) {
781	unless ($cb->($self)) {	1009	unless ($cb->($self)) {
782	if ($self->{_eof}) {	1010	# no progress can be made
783	# no progress can be made (not enough data and no data forthcoming)	1011	# (not enough data and no data forthcoming)
784	$self->_error (&Errno::EPIPE, 1), return;	1012	$self->_error (Errno::EPIPE, 1), return
785	}	1013	if $self->{_eof};
786		1014
787	unshift @{ $self->{_queue} }, $cb;	1015	unshift @{ $self->{_queue} }, $cb;
788	last;	1016	last;
789	}	1017	}
790	} elsif ($self->{on_read}) {	1018	} elsif ($self->{on_read}) {
…		…
797	&& !@{ $self->{_queue} } # and the queue is still empty	1025	&& !@{ $self->{_queue} } # and the queue is still empty
798	&& $self->{on_read} # but we still have on_read	1026	&& $self->{on_read} # but we still have on_read
799	) {	1027	) {
800	# no further data will arrive	1028	# no further data will arrive
801	# so no progress can be made	1029	# so no progress can be made
802	$self->_error (&Errno::EPIPE, 1), return	1030	$self->_error (Errno::EPIPE, 1), return
803	if $self->{_eof};	1031	if $self->{_eof};
804		1032
805	last; # more data might arrive	1033	last; # more data might arrive
806	}	1034	}
807	} else {	1035	} else {
…		…
810	last;	1038	last;
811	}	1039	}
812	}	1040	}
813		1041
814	if ($self->{_eof}) {	1042	if ($self->{_eof}) {
815	if ($self->{on_eof}) {	1043	$self->{on_eof}
816	$self->{on_eof}($self)	1044	? $self->{on_eof}($self)
817	} else {	1045	: $self->_error (0, 1, "Unexpected end-of-file");
818	$self->_error (0, 1);	1046
819	}	1047	return;
		1048	}
		1049
		1050	if (
		1051	defined $self->{rbuf_max}
		1052	&& $self->{rbuf_max} < length $self->{rbuf}
		1053	) {
		1054	$self->_error (Errno::ENOSPC, 1), return;
820	}	1055	}
821		1056
822	# may need to restart read watcher	1057	# may need to restart read watcher
823	unless ($self->{_rw}) {	1058	unless ($self->{_rw}) {
824	$self->start_read	1059	$self->start_read
…		…
836		1071
837	sub on_read {	1072	sub on_read {
838	my ($self, $cb) = @_;	1073	my ($self, $cb) = @_;
839		1074
840	$self->{on_read} = $cb;	1075	$self->{on_read} = $cb;
841	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1076	$self->_drain_rbuf if $cb;
842	}	1077	}
843		1078
844	=item $handle->rbuf	1079	=item $handle->rbuf
845		1080
846	Returns the read buffer (as a modifiable lvalue).	1081	Returns the read buffer (as a modifiable lvalue).
…		…
898	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1133	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
899	->($self, $cb, @_);	1134	->($self, $cb, @_);
900	}	1135	}
901		1136
902	push @{ $self->{_queue} }, $cb;	1137	push @{ $self->{_queue} }, $cb;
903	$self->_drain_rbuf unless $self->{_in_drain};	1138	$self->_drain_rbuf;
904	}	1139	}
905		1140
906	sub unshift_read {	1141	sub unshift_read {
907	my $self = shift;	1142	my $self = shift;
908	my $cb = pop;	1143	my $cb = pop;
…		…
914	->($self, $cb, @_);	1149	->($self, $cb, @_);
915	}	1150	}
916		1151
917		1152
918	unshift @{ $self->{_queue} }, $cb;	1153	unshift @{ $self->{_queue} }, $cb;
919	$self->_drain_rbuf unless $self->{_in_drain};	1154	$self->_drain_rbuf;
920	}	1155	}
921		1156
922	=item $handle->push_read (type => @args, $cb)	1157	=item $handle->push_read (type => @args, $cb)
923		1158
924	=item $handle->unshift_read (type => @args, $cb)	1159	=item $handle->unshift_read (type => @args, $cb)
…		…
1057	return 1;	1292	return 1;
1058	}	1293	}
1059		1294
1060	# reject	1295	# reject
1061	if ($reject && $$rbuf =~ $reject) {	1296	if ($reject && $$rbuf =~ $reject) {
1062	$self->_error (&Errno::EBADMSG);	1297	$self->_error (Errno::EBADMSG);
1063	}	1298	}
1064		1299
1065	# skip	1300	# skip
1066	if ($skip && $$rbuf =~ $skip) {	1301	if ($skip && $$rbuf =~ $skip) {
1067	$data .= substr $$rbuf, 0, $+[0], "";	1302	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1083	my ($self, $cb) = @_;	1318	my ($self, $cb) = @_;
1084		1319
1085	sub {	1320	sub {
1086	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1321	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1087	if ($_[0]{rbuf} =~ /[^0-9]/) {	1322	if ($_[0]{rbuf} =~ /[^0-9]/) {
1088	$self->_error (&Errno::EBADMSG);	1323	$self->_error (Errno::EBADMSG);
1089	}	1324	}
1090	return;	1325	return;
1091	}	1326	}
1092		1327
1093	my $len = $1;	1328	my $len = $1;
…		…
1096	my $string = $_[1];	1331	my $string = $_[1];
1097	$_[0]->unshift_read (chunk => 1, sub {	1332	$_[0]->unshift_read (chunk => 1, sub {
1098	if ($_[1] eq ",") {	1333	if ($_[1] eq ",") {
1099	$cb->($_[0], $string);	1334	$cb->($_[0], $string);
1100	} else {	1335	} else {
1101	$self->_error (&Errno::EBADMSG);	1336	$self->_error (Errno::EBADMSG);
1102	}	1337	}
1103	});	1338	});
1104	});	1339	});
1105		1340
1106	1	1341	1
…		…
1173	=cut	1408	=cut
1174		1409
1175	register_read_type json => sub {	1410	register_read_type json => sub {
1176	my ($self, $cb) = @_;	1411	my ($self, $cb) = @_;
1177		1412
1178	require JSON;	1413	my $json = $self->{json} \|\|=
		1414	eval { require JSON::XS; JSON::XS->new->utf8 }
		1415	\|\| do { require JSON; JSON->new->utf8 };
1179		1416
1180	my $data;	1417	my $data;
1181	my $rbuf = \$self->{rbuf};	1418	my $rbuf = \$self->{rbuf};
1182
1183	my $json = $self->{json} \|\|= JSON->new->utf8;
1184		1419
1185	sub {	1420	sub {
1186	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1421	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1187		1422
1188	if ($ref) {	1423	if ($ref) {
…		…
1196	$json->incr_skip;	1431	$json->incr_skip;
1197		1432
1198	$self->{rbuf} = $json->incr_text;	1433	$self->{rbuf} = $json->incr_text;
1199	$json->incr_text = "";	1434	$json->incr_text = "";
1200		1435
1201	$self->_error (&Errno::EBADMSG);	1436	$self->_error (Errno::EBADMSG);
1202		1437
1203	()	1438	()
1204	} else {	1439	} else {
1205	$self->{rbuf} = "";	1440	$self->{rbuf} = "";
1206		1441
…		…
1243	# read remaining chunk	1478	# read remaining chunk
1244	$_[0]->unshift_read (chunk => $len, sub {	1479	$_[0]->unshift_read (chunk => $len, sub {
1245	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1480	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1246	$cb->($_[0], $ref);	1481	$cb->($_[0], $ref);
1247	} else {	1482	} else {
1248	$self->_error (&Errno::EBADMSG);	1483	$self->_error (Errno::EBADMSG);
1249	}	1484	}
1250	});	1485	});
1251	}	1486	}
1252		1487
1253	1	1488	1
…		…
1317	if ($self->{tls}) {	1552	if ($self->{tls}) {
1318	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1553	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1319		1554
1320	&_dotls ($self);	1555	&_dotls ($self);
1321	} else {	1556	} else {
1322	$self->_drain_rbuf unless $self->{_in_drain};	1557	$self->_drain_rbuf;
1323	}	1558	}
1324		1559
1325	} elsif (defined $len) {	1560	} elsif (defined $len) {
1326	delete $self->{_rw};	1561	delete $self->{_rw};
1327	$self->{_eof} = 1;	1562	$self->{_eof} = 1;
1328	$self->_drain_rbuf unless $self->{_in_drain};	1563	$self->_drain_rbuf;
1329		1564
1330	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1565	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1331	return $self->_error ($!, 1);	1566	return $self->_error ($!, 1);
1332	}	1567	}
1333	});	1568	});
1334	}	1569	}
1335	}	1570	}
1336		1571
		1572	our $ERROR_SYSCALL;
		1573	our $ERROR_WANT_READ;
		1574
		1575	sub _tls_error {
		1576	my ($self, $err) = @_;
		1577
		1578	return $self->_error ($!, 1)
		1579	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1580
		1581	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1582
		1583	# reduce error string to look less scary
		1584	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1585
		1586	if ($self->{_on_starttls}) {
		1587	(delete $self->{_on_starttls})->($self, undef, $err);
		1588	&_freetls;
		1589	} else {
		1590	&_freetls;
		1591	$self->_error (Errno::EPROTO, 1, $err);
		1592	}
		1593	}
		1594
1337	# poll the write BIO and send the data if applicable	1595	# poll the write BIO and send the data if applicable
		1596	# also decode read data if possible
		1597	# this is basiclaly our TLS state machine
		1598	# more efficient implementations are possible with openssl,
		1599	# but not with the buggy and incomplete Net::SSLeay.
1338	sub _dotls {	1600	sub _dotls {
1339	my ($self) = @_;	1601	my ($self) = @_;
1340		1602
1341	my $tmp;	1603	my $tmp;
1342		1604
1343	if (length $self->{_tls_wbuf}) {	1605	if (length $self->{_tls_wbuf}) {
1344	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1606	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1345	substr $self->{_tls_wbuf}, 0, $tmp, "";	1607	substr $self->{_tls_wbuf}, 0, $tmp, "";
1346	}	1608	}
		1609
		1610	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1611	return $self->_tls_error ($tmp)
		1612	if $tmp != $ERROR_WANT_READ
		1613	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1347	}	1614	}
1348		1615
1349	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1616	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1350	unless (length $tmp) {	1617	unless (length $tmp) {
1351	# let's treat SSL-eof as we treat normal EOF	1618	$self->{_on_starttls}
1352	delete $self->{_rw};	1619	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1353	$self->{_eof} = 1;
1354	&_freetls;	1620	&_freetls;
		1621
		1622	if ($self->{on_stoptls}) {
		1623	$self->{on_stoptls}($self);
		1624	return;
		1625	} else {
		1626	# let's treat SSL-eof as we treat normal EOF
		1627	delete $self->{_rw};
		1628	$self->{_eof} = 1;
		1629	}
1355	}	1630	}
1356		1631
1357	$self->{_tls_rbuf} .= $tmp;	1632	$self->{_tls_rbuf} .= $tmp;
1358	$self->_drain_rbuf unless $self->{_in_drain};	1633	$self->_drain_rbuf;
1359	$self->{tls} or return; # tls session might have gone away in callback	1634	$self->{tls} or return; # tls session might have gone away in callback
1360	}	1635	}
1361		1636
1362	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1637	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1363
1364	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1365	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1366	return $self->_error ($!, 1);	1638	return $self->_tls_error ($tmp)
1367	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1639	if $tmp != $ERROR_WANT_READ
1368	return $self->_error (&Errno::EIO, 1);	1640	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1369	}
1370
1371	# all other errors are fine for our purposes
1372	}
1373		1641
1374	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1642	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1375	$self->{wbuf} .= $tmp;	1643	$self->{wbuf} .= $tmp;
1376	$self->_drain_wbuf;	1644	$self->_drain_wbuf;
1377	}	1645	}
		1646
		1647	$self->{_on_starttls}
		1648	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1649	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1378	}	1650	}
1379		1651
1380	=item $handle->starttls ($tls[, $tls_ctx])	1652	=item $handle->starttls ($tls[, $tls_ctx])
1381		1653
1382	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1654	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1383	object is created, you can also do that at a later time by calling	1655	object is created, you can also do that at a later time by calling
1384	C<starttls>.	1656	C<starttls>.
1385		1657
		1658	Starting TLS is currently an asynchronous operation - when you push some
		1659	write data and then call C<< ->starttls >> then TLS negotiation will start
		1660	immediately, after which the queued write data is then sent.
		1661
1386	The first argument is the same as the C<tls> constructor argument (either	1662	The first argument is the same as the C<tls> constructor argument (either
1387	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1663	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1388		1664
1389	The second argument is the optional C<Net::SSLeay::CTX> object that is	1665	The second argument is the optional C<AnyEvent::TLS> object that is used
1390	used when AnyEvent::Handle has to create its own TLS connection object.	1666	when AnyEvent::Handle has to create its own TLS connection object, or
		1667	a hash reference with C<< key => value >> pairs that will be used to
		1668	construct a new context.
1391		1669
1392	The TLS connection object will end up in C<< $handle->{tls} >> after this	1670	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1393	call and can be used or changed to your liking. Note that the handshake	1671	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1394	might have already started when this function returns.	1672	changed to your liking. Note that the handshake might have already started
		1673	when this function returns.
1395		1674
1396	If it an error to start a TLS handshake more than once per	1675	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1397	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1676	handshakes on the same stream. Best do not attempt to use the stream after
		1677	stopping TLS.
1398		1678
1399	=cut	1679	=cut
		1680
		1681	our %TLS_CACHE; #TODO not yet documented, should we?
1400		1682
1401	sub starttls {	1683	sub starttls {
1402	my ($self, $ssl, $ctx) = @_;	1684	my ($self, $tls, $ctx) = @_;
		1685
		1686	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1687	if $self->{tls};
		1688
		1689	$self->{tls} = $tls;
		1690	$self->{tls_ctx} = $ctx if @_ > 2;
		1691
		1692	return unless $self->{fh};
1403		1693
1404	require Net::SSLeay;	1694	require Net::SSLeay;
1405		1695
1406	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1696	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1697	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1698
1407	if $self->{tls};	1699	$tls = $self->{tls};
		1700	$ctx = $self->{tls_ctx};
		1701
		1702	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1703
		1704	if ("HASH" eq ref $ctx) {
		1705	require AnyEvent::TLS;
		1706
		1707	if ($ctx->{cache}) {
		1708	my $key = $ctx+0;
		1709	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1710	} else {
		1711	$ctx = new AnyEvent::TLS %$ctx;
		1712	}
		1713	}
1408		1714
1409	if ($ssl eq "accept") {	1715	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1410	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1716	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1411	Net::SSLeay::set_accept_state ($ssl);
1412	} elsif ($ssl eq "connect") {
1413	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1414	Net::SSLeay::set_connect_state ($ssl);
1415	}
1416
1417	$self->{tls} = $ssl;
1418		1717
1419	# basically, this is deep magic (because SSL_read should have the same issues)	1718	# basically, this is deep magic (because SSL_read should have the same issues)
1420	# but the openssl maintainers basically said: "trust us, it just works".	1719	# but the openssl maintainers basically said: "trust us, it just works".
1421	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1720	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1422	# and mismaintained ssleay-module doesn't even offer them).	1721	# and mismaintained ssleay-module doesn't even offer them).
…		…
1426	#	1725	#
1427	# note that we do not try to keep the length constant between writes as we are required to do.	1726	# note that we do not try to keep the length constant between writes as we are required to do.
1428	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1727	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1429	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1728	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1430	# have identity issues in that area.	1729	# have identity issues in that area.
1431	Net::SSLeay::CTX_set_mode ($self->{tls},	1730	# Net::SSLeay::CTX_set_mode ($ssl,
1432	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1731	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1433	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1732	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1733	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1434		1734
1435	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1735	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1436	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1736	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1437		1737
		1738	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1739
1438	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1740	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1741
		1742	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1743	if $self->{on_starttls};
1439		1744
1440	&_dotls; # need to trigger the initial handshake	1745	&_dotls; # need to trigger the initial handshake
1441	$self->start_read; # make sure we actually do read	1746	$self->start_read; # make sure we actually do read
1442	}	1747	}
1443		1748
1444	=item $handle->stoptls	1749	=item $handle->stoptls
1445		1750
1446	Shuts down the SSL connection - this makes a proper EOF handshake by	1751	Shuts down the SSL connection - this makes a proper EOF handshake by
1447	sending a close notify to the other side, but since OpenSSL doesn't	1752	sending a close notify to the other side, but since OpenSSL doesn't
1448	support non-blocking shut downs, it is not possible to re-use the stream	1753	support non-blocking shut downs, it is not guarenteed that you can re-use
1449	afterwards.	1754	the stream afterwards.
1450		1755
1451	=cut	1756	=cut
1452		1757
1453	sub stoptls {	1758	sub stoptls {
1454	my ($self) = @_;	1759	my ($self) = @_;
…		…
1456	if ($self->{tls}) {	1761	if ($self->{tls}) {
1457	Net::SSLeay::shutdown ($self->{tls});	1762	Net::SSLeay::shutdown ($self->{tls});
1458		1763
1459	&_dotls;	1764	&_dotls;
1460		1765
1461	# we don't give a shit. no, we do, but we can't. no...	1766	# # we don't give a shit. no, we do, but we can't. no...#d#
1462	# we, we... have to use openssl :/	1767	# # we, we... have to use openssl :/#d#
1463	&_freetls;	1768	# &_freetls;#d#
1464	}	1769	}
1465	}	1770	}
1466		1771
1467	sub _freetls {	1772	sub _freetls {
1468	my ($self) = @_;	1773	my ($self) = @_;
1469		1774
1470	return unless $self->{tls};	1775	return unless $self->{tls};
1471		1776
1472	Net::SSLeay::free (delete $self->{tls});	1777	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1778	if $self->{tls} > 0;
1473		1779
1474	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1780	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1475	}	1781	}
1476		1782
1477	sub DESTROY {	1783	sub DESTROY {
1478	my ($self) = @_;	1784	my ($self) = @_;
1479		1785
1480	&_freetls;	1786	&_freetls;
1481		1787
1482	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1788	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1483		1789
1484	if ($linger && length $self->{wbuf}) {	1790	if ($linger && length $self->{wbuf} && $self->{fh}) {
1485	my $fh = delete $self->{fh};	1791	my $fh = delete $self->{fh};
1486	my $wbuf = delete $self->{wbuf};	1792	my $wbuf = delete $self->{wbuf};
1487		1793
1488	my @linger;	1794	my @linger;
1489		1795
…		…
1503	}	1809	}
1504		1810
1505	=item $handle->destroy	1811	=item $handle->destroy
1506		1812
1507	Shuts down the handle object as much as possible - this call ensures that	1813	Shuts down the handle object as much as possible - this call ensures that
1508	no further callbacks will be invoked and resources will be freed as much	1814	no further callbacks will be invoked and as many resources as possible
1509	as possible. You must not call any methods on the object afterwards.	1815	will be freed. Any method you will call on the handle object after
		1816	destroying it in this way will be silently ignored (and it will return the
		1817	empty list).
1510		1818
1511	Normally, you can just "forget" any references to an AnyEvent::Handle	1819	Normally, you can just "forget" any references to an AnyEvent::Handle
1512	object and it will simply shut down. This works in fatal error and EOF	1820	object and it will simply shut down. This works in fatal error and EOF
1513	callbacks, as well as code outside. It does I<NOT> work in a read or write	1821	callbacks, as well as code outside. It does I<NOT> work in a read or write
1514	callback, so when you want to destroy the AnyEvent::Handle object from	1822	callback, so when you want to destroy the AnyEvent::Handle object from
1515	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1823	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1516	that case.	1824	that case.
1517		1825
		1826	Destroying the handle object in this way has the advantage that callbacks
		1827	will be removed as well, so if those are the only reference holders (as
		1828	is common), then one doesn't need to do anything special to break any
		1829	reference cycles.
		1830
1518	The handle might still linger in the background and write out remaining	1831	The handle might still linger in the background and write out remaining
1519	data, as specified by the C<linger> option, however.	1832	data, as specified by the C<linger> option, however.
1520		1833
1521	=cut	1834	=cut
1522		1835
1523	sub destroy {	1836	sub destroy {
1524	my ($self) = @_;	1837	my ($self) = @_;
1525		1838
1526	$self->DESTROY;	1839	$self->DESTROY;
1527	%$self = ();	1840	%$self = ();
		1841	bless $self, "AnyEvent::Handle::destroyed";
		1842	}
		1843
		1844	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1845	#nop
1528	}	1846	}
1529		1847
1530	=item AnyEvent::Handle::TLS_CTX	1848	=item AnyEvent::Handle::TLS_CTX
1531		1849
1532	This function creates and returns the Net::SSLeay::CTX object used by	1850	This function creates and returns the AnyEvent::TLS object used by default
1533	default for TLS mode.	1851	for TLS mode.
1534		1852
1535	The context is created like this:	1853	The context is created by calling L<AnyEvent::TLS> without any arguments.
1536
1537	Net::SSLeay::load_error_strings;
1538	Net::SSLeay::SSLeay_add_ssl_algorithms;
1539	Net::SSLeay::randomize;
1540
1541	my $CTX = Net::SSLeay::CTX_new;
1542
1543	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1544		1854
1545	=cut	1855	=cut
1546		1856
1547	our $TLS_CTX;	1857	our $TLS_CTX;
1548		1858
1549	sub TLS_CTX() {	1859	sub TLS_CTX() {
1550	$TLS_CTX \|\| do {	1860	$TLS_CTX \|\|= do {
1551	require Net::SSLeay;	1861	require AnyEvent::TLS;
1552		1862
1553	Net::SSLeay::load_error_strings ();	1863	new AnyEvent::TLS
1554	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1555	Net::SSLeay::randomize ();
1556
1557	$TLS_CTX = Net::SSLeay::CTX_new ();
1558
1559	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1560
1561	$TLS_CTX
1562	}	1864	}
1563	}	1865	}
1564		1866
1565	=back	1867	=back
1566		1868
…		…
1605		1907
1606	$handle->on_read (sub { });	1908	$handle->on_read (sub { });
1607	$handle->on_eof (undef);	1909	$handle->on_eof (undef);
1608	$handle->on_error (sub {	1910	$handle->on_error (sub {
1609	my $data = delete $_[0]{rbuf};	1911	my $data = delete $_[0]{rbuf};
1610	undef $handle;
1611	});	1912	});
1612		1913
1613	The reason to use C<on_error> is that TCP connections, due to latencies	1914	The reason to use C<on_error> is that TCP connections, due to latencies
1614	and packets loss, might get closed quite violently with an error, when in	1915	and packets loss, might get closed quite violently with an error, when in
1615	fact, all data has been received.	1916	fact, all data has been received.
…		…
1631	$handle->on_drain (sub {	1932	$handle->on_drain (sub {
1632	warn "all data submitted to the kernel\n";	1933	warn "all data submitted to the kernel\n";
1633	undef $handle;	1934	undef $handle;
1634	});	1935	});
1635		1936
		1937	If you just want to queue some data and then signal EOF to the other side,
		1938	consider using C<< ->push_shutdown >> instead.
		1939
		1940	=item I want to contact a TLS/SSL server, I don't care about security.
		1941
		1942	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1943	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1944	parameter:
		1945
		1946	tcp_connect $host, $port, sub {
		1947	my ($fh) = @_;
		1948
		1949	my $handle = new AnyEvent::Handle
		1950	fh => $fh,
		1951	tls => "connect",
		1952	on_error => sub { ... };
		1953
		1954	$handle->push_write (...);
		1955	};
		1956
		1957	=item I want to contact a TLS/SSL server, I do care about security.
		1958
		1959	Then you should additionally enable certificate verification, including
		1960	peername verification, if the protocol you use supports it (see
		1961	L<AnyEvent::TLS>, C<verify_peername>).
		1962
		1963	E.g. for HTTPS:
		1964
		1965	tcp_connect $host, $port, sub {
		1966	my ($fh) = @_;
		1967
		1968	my $handle = new AnyEvent::Handle
		1969	fh => $fh,
		1970	peername => $host,
		1971	tls => "connect",
		1972	tls_ctx => { verify => 1, verify_peername => "https" },
		1973	...
		1974
		1975	Note that you must specify the hostname you connected to (or whatever
		1976	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1977	peername verification will be done.
		1978
		1979	The above will use the system-dependent default set of trusted CA
		1980	certificates. If you want to check against a specific CA, add the
		1981	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1982
		1983	tls_ctx => {
		1984	verify => 1,
		1985	verify_peername => "https",
		1986	ca_file => "my-ca-cert.pem",
		1987	},
		1988
		1989	=item I want to create a TLS/SSL server, how do I do that?
		1990
		1991	Well, you first need to get a server certificate and key. You have
		1992	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1993	self-signed certificate (cheap. check the search engine of your choice,
		1994	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1995	nice program for that purpose).
		1996
		1997	Then create a file with your private key (in PEM format, see
		1998	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1999	file should then look like this:
		2000
		2001	-----BEGIN RSA PRIVATE KEY-----
		2002	...header data
		2003	... lots of base64'y-stuff
		2004	-----END RSA PRIVATE KEY-----
		2005
		2006	-----BEGIN CERTIFICATE-----
		2007	... lots of base64'y-stuff
		2008	-----END CERTIFICATE-----
		2009
		2010	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2011	specify this file as C<cert_file>:
		2012
		2013	tcp_server undef, $port, sub {
		2014	my ($fh) = @_;
		2015
		2016	my $handle = new AnyEvent::Handle
		2017	fh => $fh,
		2018	tls => "accept",
		2019	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2020	...
		2021
		2022	When you have intermediate CA certificates that your clients might not
		2023	know about, just append them to the C<cert_file>.
		2024
1636	=back	2025	=back
1637		2026
1638		2027
1639	=head1 SUBCLASSING AnyEvent::Handle	2028	=head1 SUBCLASSING AnyEvent::Handle
1640		2029

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.124 by root, Sun Apr 26 18:12:53 2009 UTC vs. Revision 1.174 by root, Sat Aug 8 20:52:06 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.124 by root, Sun Apr 26 18:12:53 2009 UTC vs.
Revision 1.174 by root, Sat Aug 8 20:52:06 2009 UTC