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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.132 by elmex, Thu Jul 2 22:25:13 2009 UTC vs.
Revision 1.151 by root, Thu Jul 16 04:20:23 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.45;	19	our $VERSION = 4.82;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
25		25
26	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
27		27
28	my $handle =	28	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	29	fh => \*STDIN,
31	on_eof => sub {	30	on_error => sub {
		31	my ($hdl, $fatal, $msg) = @_;
		32	warn "got error $msg\n";
		33	$hdl->destroy;
32	$cv->send;	34	$cv->send;
33	},
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
…		…
81		82
82	=item on_eof => $cb->($handle)	83	=item on_eof => $cb->($handle)
83		84
84	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,
85	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
86	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).
87		90
88	For sockets, this just means that the other side has stopped sending data,	91	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	92	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	93	callback and continue writing data, as only the read part has been shut
91	down.	94	down.
92		95
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	96	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>.	97	set, then a fatal error will be raised with C<$!> set to <0>.
99		98
100	=item on_error => $cb->($handle, $fatal)	99	=item on_error => $cb->($handle, $fatal, $message)
101		100
102	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
103	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
104	connect or a read error.	103	connect or a read error.
105		104
106	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
107	fatal errors the handle object will be shut down and will not be usable	106	fatal errors the handle object will be destroyed (by a call to C<< ->
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal	107	destroy >>) after invoking the error callback (which means you are free to
109	errors are an EOF condition with active (but unsatisifable) read watchers	108	examine the handle object). Examples of fatal errors are an EOF condition
110	(C<EPIPE>) or I/O errors.	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<"$!">).
111		115
112	Non-fatal errors can be retried by simply returning, but it is recommended	116	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	117	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts	118	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	119	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116		120
117	On callback entrance, the value of C<$!> contains the operating system	121	On callback entrance, the value of C<$!> contains the operating system
118	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>).
119		124
120	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
121	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
122	C<croak>.	127	C<croak>.
123		128
…		…
127	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
128	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
129	read buffer).	134	read buffer).
130		135
131	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 >>
132	method or access the C<$handle->{rbuf}> member directly. Note that you	137	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	138	must not enlarge or modify the read buffer, you can only remove data at
134	the beginning from it.	139	the beginning from it.
135		140
136	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
137	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
138	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
139	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.
140		150
141	=item on_drain => $cb->($handle)	151	=item on_drain => $cb->($handle)
142		152
143	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
144	(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).
…		…
237		247
238	This will not work for partial TLS data that could not be encoded	248	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	249	yet. This data will be lost. Calling the C<stoptls> method in time might
240	help.	250	help.
241		251
242	=item common_name => $string	252	=item peername => $string
243		253
244	The common name used by some verification methods (most notably SSL/TLS)	254	A string used to identify the remote site - usually the DNS hostname
245	associated with this connection. Usually this is the remote hostname used	255	(I<not> IDN!) used to create the connection, rarely the IP address.
246	to connect, but can be almost anything.	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>.
247		261
248	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	262	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
249		263
250	When this parameter is given, it enables TLS (SSL) mode, that means	264	When this parameter is given, it enables TLS (SSL) mode, that means
251	AnyEvent will start a TLS handshake as soon as the conenction has been	265	AnyEvent will start a TLS handshake as soon as the conenction has been
252	established and will transparently encrypt/decrypt data afterwards.	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.
253		270
254	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
255	automatically when you try to create a TLS handle): this module doesn't	272	automatically when you try to create a TLS handle): this module doesn't
256	have a dependency on that module, so if your module requires it, you have	273	have a dependency on that module, so if your module requires it, you have
257	to add the dependency yourself.	274	to add the dependency yourself.
…		…
285		302
286	Instead of an object, you can also specify a hash reference with C<< key	303	Instead of an object, you can also specify a hash reference with C<< key
287	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	304	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
288	new TLS context object.	305	new TLS context object.
289		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
290	=item json => JSON or JSON::XS object	339	=item json => JSON or JSON::XS object
291		340
292	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.
293		342
294	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
…		…
316	$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};
317		366
318	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	367	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
319	if $self->{tls};	368	if $self->{tls};
320		369
321	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	370	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
322		371
323	$self->start_read	372	$self->start_read
324	if $self->{on_read};	373	if $self->{on_read};
325		374
326	$self->{fh} && $self	375	$self->{fh} && $self
327	}	376	}
328		377
329	sub _shutdown {	378	#sub _shutdown {
330	my ($self) = @_;	379	# my ($self) = @_;
331		380	#
332	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};	381	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
333	$self->{_eof} = 1; # tell starttls et. al to stop trying	382	# $self->{_eof} = 1; # tell starttls et. al to stop trying
334		383	#
335	&_freetls;	384	# &_freetls;
336	}	385	#}
337		386
338	sub _error {	387	sub _error {
339	my ($self, $errno, $fatal) = @_;	388	my ($self, $errno, $fatal, $message) = @_;
340
341	$self->_shutdown
342	if $fatal;
343		389
344	$! = $errno;	390	$! = $errno;
		391	$message \|\|= "$!";
345		392
346	if ($self->{on_error}) {	393	if ($self->{on_error}) {
347	$self->{on_error}($self, $fatal);	394	$self->{on_error}($self, $fatal, $message);
		395	$self->destroy if $fatal;
348	} elsif ($self->{fh}) {	396	} elsif ($self->{fh}) {
		397	$self->destroy;
349	Carp::croak "AnyEvent::Handle uncaught error: $!";	398	Carp::croak "AnyEvent::Handle uncaught error: $message";
350	}	399	}
351	}	400	}
352		401
353	=item $fh = $handle->fh	402	=item $fh = $handle->fh
354		403
…		…
415	local $SIG{__DIE__};	464	local $SIG{__DIE__};
416	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	465	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
417	};	466	};
418	}	467	}
419		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
420	#############################################################################	489	#############################################################################
421		490
422	=item $handle->timeout ($seconds)	491	=item $handle->timeout ($seconds)
423		492
424	Configures (or disables) the inactivity timeout.	493	Configures (or disables) the inactivity timeout.
…		…
448	$self->{_activity} = $NOW;	517	$self->{_activity} = $NOW;
449		518
450	if ($self->{on_timeout}) {	519	if ($self->{on_timeout}) {
451	$self->{on_timeout}($self);	520	$self->{on_timeout}($self);
452	} else {	521	} else {
453	$self->_error (&Errno::ETIMEDOUT);	522	$self->_error (Errno::ETIMEDOUT);
454	}	523	}
455		524
456	# callback could have changed timeout value, optimise	525	# callback could have changed timeout value, optimise
457	return unless $self->{timeout};	526	return unless $self->{timeout};
458		527
…		…
521	Scalar::Util::weaken $self;	590	Scalar::Util::weaken $self;
522		591
523	my $cb = sub {	592	my $cb = sub {
524	my $len = syswrite $self->{fh}, $self->{wbuf};	593	my $len = syswrite $self->{fh}, $self->{wbuf};
525		594
526	if ($len >= 0) {	595	if (defined $len) {
527	substr $self->{wbuf}, 0, $len, "";	596	substr $self->{wbuf}, 0, $len, "";
528		597
529	$self->{_activity} = AnyEvent->now;	598	$self->{_activity} = AnyEvent->now;
530		599
531	$self->{on_drain}($self)	600	$self->{on_drain}($self)
…		…
666		735
667	pack "w/a*", Storable::nfreeze ($ref)	736	pack "w/a*", Storable::nfreeze ($ref)
668	};	737	};
669		738
670	=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	}
671		765
672	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	766	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
673		767
674	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>.
675	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
…		…
775		869
776	if (	870	if (
777	defined $self->{rbuf_max}	871	defined $self->{rbuf_max}
778	&& $self->{rbuf_max} < length $self->{rbuf}	872	&& $self->{rbuf_max} < length $self->{rbuf}
779	) {	873	) {
780	$self->_error (&Errno::ENOSPC, 1), return;	874	$self->_error (Errno::ENOSPC, 1), return;
781	}	875	}
782		876
783	while () {	877	while () {
784	# we need to use a separate tls read buffer, as we must not receive data while	878	# we need to use a separate tls read buffer, as we must not receive data while
785	# we are draining the buffer, and this can only happen with TLS.	879	# we are draining the buffer, and this can only happen with TLS.
…		…
789		883
790	if (my $cb = shift @{ $self->{_queue} }) {	884	if (my $cb = shift @{ $self->{_queue} }) {
791	unless ($cb->($self)) {	885	unless ($cb->($self)) {
792	if ($self->{_eof}) {	886	if ($self->{_eof}) {
793	# 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)
794	$self->_error (&Errno::EPIPE, 1), return;	888	$self->_error (Errno::EPIPE, 1), return;
795	}	889	}
796		890
797	unshift @{ $self->{_queue} }, $cb;	891	unshift @{ $self->{_queue} }, $cb;
798	last;	892	last;
799	}	893	}
…		…
807	&& !@{ $self->{_queue} } # and the queue is still empty	901	&& !@{ $self->{_queue} } # and the queue is still empty
808	&& $self->{on_read} # but we still have on_read	902	&& $self->{on_read} # but we still have on_read
809	) {	903	) {
810	# no further data will arrive	904	# no further data will arrive
811	# so no progress can be made	905	# so no progress can be made
812	$self->_error (&Errno::EPIPE, 1), return	906	$self->_error (Errno::EPIPE, 1), return
813	if $self->{_eof};	907	if $self->{_eof};
814		908
815	last; # more data might arrive	909	last; # more data might arrive
816	}	910	}
817	} else {	911	} else {
…		…
823		917
824	if ($self->{_eof}) {	918	if ($self->{_eof}) {
825	if ($self->{on_eof}) {	919	if ($self->{on_eof}) {
826	$self->{on_eof}($self)	920	$self->{on_eof}($self)
827	} else {	921	} else {
828	$self->_error (0, 1);	922	$self->_error (0, 1, "Unexpected end-of-file");
829	}	923	}
830	}	924	}
831		925
832	# may need to restart read watcher	926	# may need to restart read watcher
833	unless ($self->{_rw}) {	927	unless ($self->{_rw}) {
…		…
1067	return 1;	1161	return 1;
1068	}	1162	}
1069		1163
1070	# reject	1164	# reject
1071	if ($reject && $$rbuf =~ $reject) {	1165	if ($reject && $$rbuf =~ $reject) {
1072	$self->_error (&Errno::EBADMSG);	1166	$self->_error (Errno::EBADMSG);
1073	}	1167	}
1074		1168
1075	# skip	1169	# skip
1076	if ($skip && $$rbuf =~ $skip) {	1170	if ($skip && $$rbuf =~ $skip) {
1077	$data .= substr $$rbuf, 0, $+[0], "";	1171	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1093	my ($self, $cb) = @_;	1187	my ($self, $cb) = @_;
1094		1188
1095	sub {	1189	sub {
1096	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1190	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1097	if ($_[0]{rbuf} =~ /[^0-9]/) {	1191	if ($_[0]{rbuf} =~ /[^0-9]/) {
1098	$self->_error (&Errno::EBADMSG);	1192	$self->_error (Errno::EBADMSG);
1099	}	1193	}
1100	return;	1194	return;
1101	}	1195	}
1102		1196
1103	my $len = $1;	1197	my $len = $1;
…		…
1106	my $string = $_[1];	1200	my $string = $_[1];
1107	$_[0]->unshift_read (chunk => 1, sub {	1201	$_[0]->unshift_read (chunk => 1, sub {
1108	if ($_[1] eq ",") {	1202	if ($_[1] eq ",") {
1109	$cb->($_[0], $string);	1203	$cb->($_[0], $string);
1110	} else {	1204	} else {
1111	$self->_error (&Errno::EBADMSG);	1205	$self->_error (Errno::EBADMSG);
1112	}	1206	}
1113	});	1207	});
1114	});	1208	});
1115		1209
1116	1	1210	1
…		…
1183	=cut	1277	=cut
1184		1278
1185	register_read_type json => sub {	1279	register_read_type json => sub {
1186	my ($self, $cb) = @_;	1280	my ($self, $cb) = @_;
1187		1281
1188	require JSON;	1282	my $json = $self->{json} \|\|=
		1283	eval { require JSON::XS; JSON::XS->new->utf8 }
		1284	\|\| do { require JSON; JSON->new->utf8 };
1189		1285
1190	my $data;	1286	my $data;
1191	my $rbuf = \$self->{rbuf};	1287	my $rbuf = \$self->{rbuf};
1192
1193	my $json = $self->{json} \|\|= JSON->new->utf8;
1194		1288
1195	sub {	1289	sub {
1196	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1290	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1197		1291
1198	if ($ref) {	1292	if ($ref) {
…		…
1206	$json->incr_skip;	1300	$json->incr_skip;
1207		1301
1208	$self->{rbuf} = $json->incr_text;	1302	$self->{rbuf} = $json->incr_text;
1209	$json->incr_text = "";	1303	$json->incr_text = "";
1210		1304
1211	$self->_error (&Errno::EBADMSG);	1305	$self->_error (Errno::EBADMSG);
1212		1306
1213	()	1307	()
1214	} else {	1308	} else {
1215	$self->{rbuf} = "";	1309	$self->{rbuf} = "";
1216		1310
…		…
1253	# read remaining chunk	1347	# read remaining chunk
1254	$_[0]->unshift_read (chunk => $len, sub {	1348	$_[0]->unshift_read (chunk => $len, sub {
1255	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1349	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1256	$cb->($_[0], $ref);	1350	$cb->($_[0], $ref);
1257	} else {	1351	} else {
1258	$self->_error (&Errno::EBADMSG);	1352	$self->_error (Errno::EBADMSG);
1259	}	1353	}
1260	});	1354	});
1261	}	1355	}
1262		1356
1263	1	1357	1
…		…
1342	}	1436	}
1343	});	1437	});
1344	}	1438	}
1345	}	1439	}
1346		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
1347	# poll the write BIO and send the data if applicable	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.
1348	sub _dotls {	1469	sub _dotls {
1349	my ($self) = @_;	1470	my ($self) = @_;
1350		1471
1351	my $tmp;	1472	my $tmp;
1352		1473
1353	if (length $self->{_tls_wbuf}) {	1474	if (length $self->{_tls_wbuf}) {
1354	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1475	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1355	substr $self->{_tls_wbuf}, 0, $tmp, "";	1476	substr $self->{_tls_wbuf}, 0, $tmp, "";
1356	}	1477	}
		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 \|\| $!);
1357	}	1483	}
1358		1484
1359	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1485	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1360	unless (length $tmp) {	1486	unless (length $tmp) {
1361	# let's treat SSL-eof as we treat normal EOF	1487	$self->{_on_starttls}
1362	delete $self->{_rw};	1488	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1363	$self->{_eof} = 1;
1364	&_freetls;	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	}
1365	}	1499	}
1366		1500
1367	$self->{_tls_rbuf} .= $tmp;	1501	$self->{_tls_rbuf} .= $tmp;
1368	$self->_drain_rbuf unless $self->{_in_drain};	1502	$self->_drain_rbuf unless $self->{_in_drain};
1369	$self->{tls} or return; # tls session might have gone away in callback	1503	$self->{tls} or return; # tls session might have gone away in callback
1370	}	1504	}
1371		1505
1372	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1506	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1373
1374	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1375	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1376	return $self->_error ($!, 1);	1507	return $self->_tls_error ($tmp)
1377	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1508	if $tmp != $ERROR_WANT_READ
1378	return $self->_error (&Errno::EIO, 1);	1509	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1379	}
1380
1381	# all other errors are fine for our purposes
1382	}
1383		1510
1384	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1511	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1385	$self->{wbuf} .= $tmp;	1512	$self->{wbuf} .= $tmp;
1386	$self->_drain_wbuf;	1513	$self->_drain_wbuf;
1387	}	1514	}
		1515
		1516	$self->{_on_starttls}
		1517	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1518	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1388	}	1519	}
1389		1520
1390	=item $handle->starttls ($tls[, $tls_ctx])	1521	=item $handle->starttls ($tls[, $tls_ctx])
1391		1522
1392	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1523	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1409	If it an error to start a TLS handshake more than once per	1540	If it an error to start a TLS handshake more than once per
1410	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1541	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1411		1542
1412	=cut	1543	=cut
1413		1544
		1545	our %TLS_CACHE; #TODO not yet documented, should we?
		1546
1414	sub starttls {	1547	sub starttls {
1415	my ($self, $ssl, $ctx) = @_;	1548	my ($self, $ssl, $ctx) = @_;
1416		1549
1417	require Net::SSLeay;	1550	require Net::SSLeay;
1418		1551
1419	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1552	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1420	if $self->{tls};	1553	if $self->{tls};
1421		1554
		1555	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1556	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1557
1422	$ctx \|\|= $self->{tls_ctx};	1558	$ctx \|\|= $self->{tls_ctx};
1423		1559
1424	if ("HASH" eq ref $ctx) {	1560	if ("HASH" eq ref $ctx) {
1425	require AnyEvent::TLS;	1561	require AnyEvent::TLS;
1426		1562
1427	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context	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 {
1428	$ctx = new AnyEvent::TLS %$ctx;	1569	$ctx = new AnyEvent::TLS %$ctx;
		1570	}
1429	}	1571	}
1430		1572
1431	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1573	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1432	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self);	1574	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1433		1575
1434	# 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)
1435	# but the openssl maintainers basically said: "trust us, it just works".	1577	# but the openssl maintainers basically said: "trust us, it just works".
1436	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1578	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1437	# and mismaintained ssleay-module doesn't even offer them).	1579	# and mismaintained ssleay-module doesn't even offer them).
…		…
1451	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1593	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1452	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1594	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1453		1595
1454	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1596	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1455		1597
		1598	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1599	if $self->{on_starttls};
		1600
1456	&_dotls; # need to trigger the initial handshake	1601	&_dotls; # need to trigger the initial handshake
1457	$self->start_read; # make sure we actually do read	1602	$self->start_read; # make sure we actually do read
1458	}	1603	}
1459		1604
1460	=item $handle->stoptls	1605	=item $handle->stoptls
…		…
1472	if ($self->{tls}) {	1617	if ($self->{tls}) {
1473	Net::SSLeay::shutdown ($self->{tls});	1618	Net::SSLeay::shutdown ($self->{tls});
1474		1619
1475	&_dotls;	1620	&_dotls;
1476		1621
1477	# we don't give a shit. no, we do, but we can't. no...	1622	# # we don't give a shit. no, we do, but we can't. no...#d#
1478	# we, we... have to use openssl :/	1623	# # we, we... have to use openssl :/#d#
1479	&_freetls;	1624	# &_freetls;#d#
1480	}	1625	}
1481	}	1626	}
1482		1627
1483	sub _freetls {	1628	sub _freetls {
1484	my ($self) = @_;	1629	my ($self) = @_;
1485		1630
1486	return unless $self->{tls};	1631	return unless $self->{tls};
1487		1632
1488	$self->{tls_ctx}->_put_session (delete $self->{tls});	1633	$self->{tls_ctx}->_put_session (delete $self->{tls});
1489		1634
1490	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1635	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1491	}	1636	}
1492		1637
1493	sub DESTROY {	1638	sub DESTROY {
1494	my ($self) = @_;	1639	my ($self) = @_;
1495		1640
…		…
1519	}	1664	}
1520		1665
1521	=item $handle->destroy	1666	=item $handle->destroy
1522		1667
1523	Shuts down the handle object as much as possible - this call ensures that	1668	Shuts down the handle object as much as possible - this call ensures that
1524	no further callbacks will be invoked and resources will be freed as much	1669	no further callbacks will be invoked and as many resources as possible
1525	as possible. You must not call any methods on the object afterwards.	1670	will be freed. You must not call any methods on the object afterwards.
1526		1671
1527	Normally, you can just "forget" any references to an AnyEvent::Handle	1672	Normally, you can just "forget" any references to an AnyEvent::Handle
1528	object and it will simply shut down. This works in fatal error and EOF	1673	object and it will simply shut down. This works in fatal error and EOF
1529	callbacks, as well as code outside. It does I<NOT> work in a read or write	1674	callbacks, as well as code outside. It does I<NOT> work in a read or write
1530	callback, so when you want to destroy the AnyEvent::Handle object from	1675	callback, so when you want to destroy the AnyEvent::Handle object from
1531	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1676	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1532	that case.	1677	that case.
1533		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
1534	The handle might still linger in the background and write out remaining	1684	The handle might still linger in the background and write out remaining
1535	data, as specified by the C<linger> option, however.	1685	data, as specified by the C<linger> option, however.
1536		1686
1537	=cut	1687	=cut
1538		1688
…		…
1605		1755
1606	$handle->on_read (sub { });	1756	$handle->on_read (sub { });
1607	$handle->on_eof (undef);	1757	$handle->on_eof (undef);
1608	$handle->on_error (sub {	1758	$handle->on_error (sub {
1609	my $data = delete $_[0]{rbuf};	1759	my $data = delete $_[0]{rbuf};
1610	undef $handle;
1611	});	1760	});
1612		1761
1613	The reason to use C<on_error> is that TCP connections, due to latencies	1762	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	1763	and packets loss, might get closed quite violently with an error, when in
1615	fact, all data has been received.	1764	fact, all data has been received.
…		…
1631	$handle->on_drain (sub {	1780	$handle->on_drain (sub {
1632	warn "all data submitted to the kernel\n";	1781	warn "all data submitted to the kernel\n";
1633	undef $handle;	1782	undef $handle;
1634	});	1783	});
1635		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
1636	=back	1873	=back
1637		1874
1638		1875
1639	=head1 SUBCLASSING AnyEvent::Handle	1876	=head1 SUBCLASSING AnyEvent::Handle
1640		1877

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.132 by elmex, Thu Jul 2 22:25:13 2009 UTC vs. Revision 1.151 by root, Thu Jul 16 04:20:23 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.132 by elmex, Thu Jul 2 22:25:13 2009 UTC vs.
Revision 1.151 by root, Thu Jul 16 04:20:23 2009 UTC