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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.134 by root, Fri Jul 3 00:09:04 2009 UTC vs.
Revision 1.152 by root, Fri Jul 17 14:57:03 2009 UTC

…		…
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = 4.45;	19	our $VERSION = 4.83;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
25		25
26	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
27		27
28	my $handle =	28	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	29	fh => \*STDIN,
31	on_eof => sub {	30	on_error => sub {
		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, $message)	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.
111		110
112	AnyEvent::Handle tries to find an appropriate error code for you to check	111	AnyEvent::Handle tries to find an appropriate error code for you to check
113	against, but in some cases (TLS errors), this does not work well. It is	112	against, but in some cases (TLS errors), this does not work well. It is
114	recommended to always output the C<$message> argument in human-readable	113	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).	114	error messages (it's usually the same as C<"$!">).
…		…
133	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
134	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
135	read buffer).	134	read buffer).
136		135
137	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 >>
138	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
139	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
140	the beginning from it.	139	the beginning from it.
141		140
142	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
143	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
144	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
145	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.
146		150
147	=item on_drain => $cb->($handle)	151	=item on_drain => $cb->($handle)
148		152
149	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
150	(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).
…		…
249		253
250	A string used to identify the remote site - usually the DNS hostname	254	A string used to identify the remote site - usually the DNS hostname
251	(I<not> IDN!) used to create the connection, rarely the IP address.	255	(I<not> IDN!) used to create the connection, rarely the IP address.
252		256
253	Apart from being useful in error messages, this string is also used in TLS	257	Apart from being useful in error messages, this string is also used in TLS
254	common name verification (see C<verify_cn> in L<AnyEvent::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>.
255		261
256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	262	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
257		263
258	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
259	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
…		…
296		302
297	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
298	=> 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
299	new TLS context object.	305	new TLS context object.
300		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
301	=item json => JSON or JSON::XS object	339	=item json => JSON or JSON::XS object
302		340
303	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.
304		342
305	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
…		…
327	$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};
328		366
329	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	367	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
330	if $self->{tls};	368	if $self->{tls};
331		369
332	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	370	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
333		371
334	$self->start_read	372	$self->start_read
335	if $self->{on_read};	373	if $self->{on_read};
336		374
337	$self->{fh} && $self	375	$self->{fh} && $self
338	}	376	}
339		377
340	sub _shutdown {	378	#sub _shutdown {
341	my ($self) = @_;	379	# my ($self) = @_;
342		380	#
343	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};	381	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
344	$self->{_eof} = 1; # tell starttls et. al to stop trying	382	# $self->{_eof} = 1; # tell starttls et. al to stop trying
345		383	#
346	&_freetls;	384	# &_freetls;
347	}	385	#}
348		386
349	sub _error {	387	sub _error {
350	my ($self, $errno, $fatal, $message) = @_;	388	my ($self, $errno, $fatal, $message) = @_;
351		389
352	$self->_shutdown
353	if $fatal;
354
355	$! = $errno;	390	$! = $errno;
356	$message \|\|= "$!";	391	$message \|\|= "$!";
357		392
358	if ($self->{on_error}) {	393	if ($self->{on_error}) {
359	$self->{on_error}($self, $fatal, $message);	394	$self->{on_error}($self, $fatal, $message);
		395	$self->destroy if $fatal;
360	} elsif ($self->{fh}) {	396	} elsif ($self->{fh}) {
		397	$self->destroy;
361	Carp::croak "AnyEvent::Handle uncaught error: $message";	398	Carp::croak "AnyEvent::Handle uncaught error: $message";
362	}	399	}
363	}	400	}
364		401
365	=item $fh = $handle->fh	402	=item $fh = $handle->fh
…		…
427	local $SIG{__DIE__};	464	local $SIG{__DIE__};
428	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	465	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
429	};	466	};
430	}	467	}
431		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
432	#############################################################################	489	#############################################################################
433		490
434	=item $handle->timeout ($seconds)	491	=item $handle->timeout ($seconds)
435		492
436	Configures (or disables) the inactivity timeout.	493	Configures (or disables) the inactivity timeout.
…		…
460	$self->{_activity} = $NOW;	517	$self->{_activity} = $NOW;
461		518
462	if ($self->{on_timeout}) {	519	if ($self->{on_timeout}) {
463	$self->{on_timeout}($self);	520	$self->{on_timeout}($self);
464	} else {	521	} else {
465	$self->_error (&Errno::ETIMEDOUT);	522	$self->_error (Errno::ETIMEDOUT);
466	}	523	}
467		524
468	# callback could have changed timeout value, optimise	525	# callback could have changed timeout value, optimise
469	return unless $self->{timeout};	526	return unless $self->{timeout};
470		527
…		…
533	Scalar::Util::weaken $self;	590	Scalar::Util::weaken $self;
534		591
535	my $cb = sub {	592	my $cb = sub {
536	my $len = syswrite $self->{fh}, $self->{wbuf};	593	my $len = syswrite $self->{fh}, $self->{wbuf};
537		594
538	if ($len >= 0) {	595	if (defined $len) {
539	substr $self->{wbuf}, 0, $len, "";	596	substr $self->{wbuf}, 0, $len, "";
540		597
541	$self->{_activity} = AnyEvent->now;	598	$self->{_activity} = AnyEvent->now;
542		599
543	$self->{on_drain}($self)	600	$self->{on_drain}($self)
…		…
683		740
684	=item $handle->push_shutdown	741	=item $handle->push_shutdown
685		742
686	Sometimes you know you want to close the socket after writing your data	743	Sometimes you know you want to close the socket after writing your data
687	before it was actually written. One way to do that is to replace your	744	before it was actually written. One way to do that is to replace your
688	C<on_drain> handler by a callback that shuts down the socket. This method	745	C<on_drain> handler by a callback that shuts down the socket (and set
689	is a shorthand for just that, and replaces the C<on_drain> callback with:	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:
690		748
691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	749	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
692		750
693	This simply shuts down the write side and signals an EOF condition to the	751	This simply shuts down the write side and signals an EOF condition to the
694	the peer.	752	the peer.
…		…
697	afterwards. This is the cleanest way to close a connection.	755	afterwards. This is the cleanest way to close a connection.
698		756
699	=cut	757	=cut
700		758
701	sub push_shutdown {	759	sub push_shutdown {
		760	my ($self) = @_;
		761
		762	delete $self->{low_water_mark};
702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };	763	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
703	}	764	}
704		765
705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	766	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
706		767
707	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>.
…		…
808		869
809	if (	870	if (
810	defined $self->{rbuf_max}	871	defined $self->{rbuf_max}
811	&& $self->{rbuf_max} < length $self->{rbuf}	872	&& $self->{rbuf_max} < length $self->{rbuf}
812	) {	873	) {
813	$self->_error (&Errno::ENOSPC, 1), return;	874	$self->_error (Errno::ENOSPC, 1), return;
814	}	875	}
815		876
816	while () {	877	while () {
817	# 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
818	# 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.
…		…
822		883
823	if (my $cb = shift @{ $self->{_queue} }) {	884	if (my $cb = shift @{ $self->{_queue} }) {
824	unless ($cb->($self)) {	885	unless ($cb->($self)) {
825	if ($self->{_eof}) {	886	if ($self->{_eof}) {
826	# 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)
827	$self->_error (&Errno::EPIPE, 1), return;	888	$self->_error (Errno::EPIPE, 1), return;
828	}	889	}
829		890
830	unshift @{ $self->{_queue} }, $cb;	891	unshift @{ $self->{_queue} }, $cb;
831	last;	892	last;
832	}	893	}
…		…
840	&& !@{ $self->{_queue} } # and the queue is still empty	901	&& !@{ $self->{_queue} } # and the queue is still empty
841	&& $self->{on_read} # but we still have on_read	902	&& $self->{on_read} # but we still have on_read
842	) {	903	) {
843	# no further data will arrive	904	# no further data will arrive
844	# so no progress can be made	905	# so no progress can be made
845	$self->_error (&Errno::EPIPE, 1), return	906	$self->_error (Errno::EPIPE, 1), return
846	if $self->{_eof};	907	if $self->{_eof};
847		908
848	last; # more data might arrive	909	last; # more data might arrive
849	}	910	}
850	} else {	911	} else {
…		…
856		917
857	if ($self->{_eof}) {	918	if ($self->{_eof}) {
858	if ($self->{on_eof}) {	919	if ($self->{on_eof}) {
859	$self->{on_eof}($self)	920	$self->{on_eof}($self)
860	} else {	921	} else {
861	$self->_error (0, 1);	922	$self->_error (0, 1, "Unexpected end-of-file");
862	}	923	}
863	}	924	}
864		925
865	# may need to restart read watcher	926	# may need to restart read watcher
866	unless ($self->{_rw}) {	927	unless ($self->{_rw}) {
…		…
1100	return 1;	1161	return 1;
1101	}	1162	}
1102		1163
1103	# reject	1164	# reject
1104	if ($reject && $$rbuf =~ $reject) {	1165	if ($reject && $$rbuf =~ $reject) {
1105	$self->_error (&Errno::EBADMSG);	1166	$self->_error (Errno::EBADMSG);
1106	}	1167	}
1107		1168
1108	# skip	1169	# skip
1109	if ($skip && $$rbuf =~ $skip) {	1170	if ($skip && $$rbuf =~ $skip) {
1110	$data .= substr $$rbuf, 0, $+[0], "";	1171	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1126	my ($self, $cb) = @_;	1187	my ($self, $cb) = @_;
1127		1188
1128	sub {	1189	sub {
1129	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1190	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1130	if ($_[0]{rbuf} =~ /[^0-9]/) {	1191	if ($_[0]{rbuf} =~ /[^0-9]/) {
1131	$self->_error (&Errno::EBADMSG);	1192	$self->_error (Errno::EBADMSG);
1132	}	1193	}
1133	return;	1194	return;
1134	}	1195	}
1135		1196
1136	my $len = $1;	1197	my $len = $1;
…		…
1139	my $string = $_[1];	1200	my $string = $_[1];
1140	$_[0]->unshift_read (chunk => 1, sub {	1201	$_[0]->unshift_read (chunk => 1, sub {
1141	if ($_[1] eq ",") {	1202	if ($_[1] eq ",") {
1142	$cb->($_[0], $string);	1203	$cb->($_[0], $string);
1143	} else {	1204	} else {
1144	$self->_error (&Errno::EBADMSG);	1205	$self->_error (Errno::EBADMSG);
1145	}	1206	}
1146	});	1207	});
1147	});	1208	});
1148		1209
1149	1	1210	1
…		…
1216	=cut	1277	=cut
1217		1278
1218	register_read_type json => sub {	1279	register_read_type json => sub {
1219	my ($self, $cb) = @_;	1280	my ($self, $cb) = @_;
1220		1281
1221	require JSON;	1282	my $json = $self->{json} \|\|=
		1283	eval { require JSON::XS; JSON::XS->new->utf8 }
		1284	\|\| do { require JSON; JSON->new->utf8 };
1222		1285
1223	my $data;	1286	my $data;
1224	my $rbuf = \$self->{rbuf};	1287	my $rbuf = \$self->{rbuf};
1225
1226	my $json = $self->{json} \|\|= JSON->new->utf8;
1227		1288
1228	sub {	1289	sub {
1229	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1290	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1230		1291
1231	if ($ref) {	1292	if ($ref) {
…		…
1239	$json->incr_skip;	1300	$json->incr_skip;
1240		1301
1241	$self->{rbuf} = $json->incr_text;	1302	$self->{rbuf} = $json->incr_text;
1242	$json->incr_text = "";	1303	$json->incr_text = "";
1243		1304
1244	$self->_error (&Errno::EBADMSG);	1305	$self->_error (Errno::EBADMSG);
1245		1306
1246	()	1307	()
1247	} else {	1308	} else {
1248	$self->{rbuf} = "";	1309	$self->{rbuf} = "";
1249		1310
…		…
1286	# read remaining chunk	1347	# read remaining chunk
1287	$_[0]->unshift_read (chunk => $len, sub {	1348	$_[0]->unshift_read (chunk => $len, sub {
1288	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1349	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1289	$cb->($_[0], $ref);	1350	$cb->($_[0], $ref);
1290	} else {	1351	} else {
1291	$self->_error (&Errno::EBADMSG);	1352	$self->_error (Errno::EBADMSG);
1292	}	1353	}
1293	});	1354	});
1294	}	1355	}
1295		1356
1296	1	1357	1
…		…
1377	}	1438	}
1378	}	1439	}
1379		1440
1380	our $ERROR_SYSCALL;	1441	our $ERROR_SYSCALL;
1381	our $ERROR_WANT_READ;	1442	our $ERROR_WANT_READ;
1382	our $ERROR_ZERO_RETURN;
1383		1443
1384	sub _tls_error {	1444	sub _tls_error {
1385	my ($self, $err) = @_;	1445	my ($self, $err) = @_;
1386	warn "$err,$!\n";#d#
1387		1446
1388	return $self->_error ($!, 1)	1447	return $self->_error ($!, 1)
1389	if $err == Net::SSLeay::ERROR_SYSCALL ();	1448	if $err == Net::SSLeay::ERROR_SYSCALL ();
1390		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;
1391	$self->_error (&Errno::EPROTO, 1,	1460	$self->_error (Errno::EPROTO, 1, $err);
1392	Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()));	1461	}
1393	}	1462	}
1394		1463
1395	# poll the write BIO and send the data if applicable	1464	# poll the write BIO and send the data if applicable
1396	# also decode read data if possible	1465	# also decode read data if possible
1397	# this is basiclaly our TLS state machine	1466	# this is basiclaly our TLS state machine
…		…
1408	}	1477	}
1409		1478
1410	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	1479	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1411	return $self->_tls_error ($tmp)	1480	return $self->_tls_error ($tmp)
1412	if $tmp != $ERROR_WANT_READ	1481	if $tmp != $ERROR_WANT_READ
1413	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1482	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1414	&& $tmp != $ERROR_ZERO_RETURN;
1415	}	1483	}
1416		1484
1417	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1485	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1418	unless (length $tmp) {	1486	unless (length $tmp) {
1419	# let's treat SSL-eof as we treat normal EOF	1487	$self->{_on_starttls}
1420	delete $self->{_rw};	1488	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1421	$self->{_eof} = 1;
1422	&_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	}
1423	}	1499	}
1424		1500
1425	$self->{_tls_rbuf} .= $tmp;	1501	$self->{_tls_rbuf} .= $tmp;
1426	$self->_drain_rbuf unless $self->{_in_drain};	1502	$self->_drain_rbuf unless $self->{_in_drain};
1427	$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
1428	}	1504	}
1429		1505
1430	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1506	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1431	return $self->_tls_error ($tmp)	1507	return $self->_tls_error ($tmp)
1432	if $tmp != $ERROR_WANT_READ	1508	if $tmp != $ERROR_WANT_READ
1433	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1509	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1434	&& $tmp != $ERROR_ZERO_RETURN;
1435		1510
1436	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1511	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1437	$self->{wbuf} .= $tmp;	1512	$self->{wbuf} .= $tmp;
1438	$self->_drain_wbuf;	1513	$self->_drain_wbuf;
1439	}	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");
1440	}	1519	}
1441		1520
1442	=item $handle->starttls ($tls[, $tls_ctx])	1521	=item $handle->starttls ($tls[, $tls_ctx])
1443		1522
1444	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1523	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1461	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
1462	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1541	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1463		1542
1464	=cut	1543	=cut
1465		1544
		1545	our %TLS_CACHE; #TODO not yet documented, should we?
		1546
1466	sub starttls {	1547	sub starttls {
1467	my ($self, $ssl, $ctx) = @_;	1548	my ($self, $ssl, $ctx) = @_;
1468		1549
1469	require Net::SSLeay;	1550	require Net::SSLeay;
1470		1551
1471	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"
1472	if $self->{tls};	1553	if $self->{tls};
1473		1554
1474	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1555	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1475	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1556	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1476	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
1477		1557
1478	$ctx \|\|= $self->{tls_ctx};	1558	$ctx \|\|= $self->{tls_ctx};
1479		1559
1480	if ("HASH" eq ref $ctx) {	1560	if ("HASH" eq ref $ctx) {
1481	require AnyEvent::TLS;	1561	require AnyEvent::TLS;
1482		1562
1483	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 {
1484	$ctx = new AnyEvent::TLS %$ctx;	1569	$ctx = new AnyEvent::TLS %$ctx;
		1570	}
1485	}	1571	}
1486		1572
1487	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1573	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1488	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1574	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1489		1575
…		…
1507	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1593	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1508	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1594	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1509		1595
1510	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1596	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1511		1597
		1598	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1599	if $self->{on_starttls};
		1600
1512	&_dotls; # need to trigger the initial handshake	1601	&_dotls; # need to trigger the initial handshake
1513	$self->start_read; # make sure we actually do read	1602	$self->start_read; # make sure we actually do read
1514	}	1603	}
1515		1604
1516	=item $handle->stoptls	1605	=item $handle->stoptls
…		…
1528	if ($self->{tls}) {	1617	if ($self->{tls}) {
1529	Net::SSLeay::shutdown ($self->{tls});	1618	Net::SSLeay::shutdown ($self->{tls});
1530		1619
1531	&_dotls;	1620	&_dotls;
1532		1621
1533	# 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#
1534	# we, we... have to use openssl :/	1623	# # we, we... have to use openssl :/#d#
1535	&_freetls;	1624	# &_freetls;#d#
1536	}	1625	}
1537	}	1626	}
1538		1627
1539	sub _freetls {	1628	sub _freetls {
1540	my ($self) = @_;	1629	my ($self) = @_;
1541		1630
1542	return unless $self->{tls};	1631	return unless $self->{tls};
1543		1632
1544	$self->{tls_ctx}->_put_session (delete $self->{tls});	1633	$self->{tls_ctx}->_put_session (delete $self->{tls});
1545		1634
1546	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1635	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1547	}	1636	}
1548		1637
1549	sub DESTROY {	1638	sub DESTROY {
1550	my ($self) = @_;	1639	my ($self) = @_;
1551		1640
…		…
1575	}	1664	}
1576		1665
1577	=item $handle->destroy	1666	=item $handle->destroy
1578		1667
1579	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
1580	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
1581	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.
1582		1671
1583	Normally, you can just "forget" any references to an AnyEvent::Handle	1672	Normally, you can just "forget" any references to an AnyEvent::Handle
1584	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
1585	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
1586	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
1587	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
1588	that case.	1677	that case.
1589		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
1590	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
1591	data, as specified by the C<linger> option, however.	1685	data, as specified by the C<linger> option, however.
1592		1686
1593	=cut	1687	=cut
1594		1688
…		…
1661		1755
1662	$handle->on_read (sub { });	1756	$handle->on_read (sub { });
1663	$handle->on_eof (undef);	1757	$handle->on_eof (undef);
1664	$handle->on_error (sub {	1758	$handle->on_error (sub {
1665	my $data = delete $_[0]{rbuf};	1759	my $data = delete $_[0]{rbuf};
1666	undef $handle;
1667	});	1760	});
1668		1761
1669	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
1670	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
1671	fact, all data has been received.	1764	fact, all data has been received.
…		…
1687	$handle->on_drain (sub {	1780	$handle->on_drain (sub {
1688	warn "all data submitted to the kernel\n";	1781	warn "all data submitted to the kernel\n";
1689	undef $handle;	1782	undef $handle;
1690	});	1783	});
1691		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
1692	=back	1873	=back
1693		1874
1694		1875
1695	=head1 SUBCLASSING AnyEvent::Handle	1876	=head1 SUBCLASSING AnyEvent::Handle
1696		1877

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.134 by root, Fri Jul 3 00:09:04 2009 UTC vs. Revision 1.152 by root, Fri Jul 17 14:57:03 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.134 by root, Fri Jul 3 00:09:04 2009 UTC vs.
Revision 1.152 by root, Fri Jul 17 14:57:03 2009 UTC