[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.150 by root, Thu Jul 16 04:16:25 2009 UTC

…		…
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = 4.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	warn "got error $_[2]\n";
32	$cv->send;	32	$cv->send;
33	},
34	);	33	);
35		34
36	# send some request line	35	# send some request line
37	$handle->push_write ("getinfo\015\012");	36	$hdl->push_write ("getinfo\015\012");
38		37
39	# read the response line	38	# read the response line
40	$handle->push_read (line => sub {	39	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	40	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	41	warn "got line <$line>\n";
43	$cv->send;	42	$cv->send;
44	});	43	});
45		44
46	$cv->recv;	45	$cv->recv;
47		46
…		…
81		80
82	=item on_eof => $cb->($handle)	81	=item on_eof => $cb->($handle)
83		82
84	Set the callback to be called when an end-of-file condition is detected,	83	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	84	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	85	connection cleanly, and there are no outstanding read requests in the
		86	queue (if there are read requests, then an EOF counts as an unexpected
		87	connection close and will be flagged as an error).
87		88
88	For sockets, this just means that the other side has stopped sending data,	89	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	90	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	91	callback and continue writing data, as only the read part has been shut
91	down.	92	down.
92		93
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	94	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>.	95	set, then a fatal error will be raised with C<$!> set to <0>.
99		96
100	=item on_error => $cb->($handle, $fatal, $message)	97	=item on_error => $cb->($handle, $fatal, $message)
101		98
102	This is the error callback, which is called when, well, some error	99	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to	100	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.	101	connect or a read error.
105		102
106	Some errors are fatal (which is indicated by C<$fatal> being true). On	103	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable	104	fatal errors the handle object will be destroyed (by a call to C<< ->
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal	105	destroy >>) after invoking the error callback (which means you are free to
109	errors are an EOF condition with active (but unsatisifable) read watchers	106	examine the handle object). Examples of fatal errors are an EOF condition
110	(C<EPIPE>) or I/O errors.	107	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
111		108
112	AnyEvent::Handle tries to find an appropriate error code for you to check	109	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	110	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	111	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).	112	error messages (it's usually the same as C<"$!">).
…		…
133	and no read request is in the queue (unlike read queue callbacks, this	130	and no read request is in the queue (unlike read queue callbacks, this
134	callback will only be called when at least one octet of data is in the	131	callback will only be called when at least one octet of data is in the
135	read buffer).	132	read buffer).
136		133
137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	134	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
138	method or access the C<$handle->{rbuf}> member directly. Note that you	135	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	136	must not enlarge or modify the read buffer, you can only remove data at
140	the beginning from it.	137	the beginning from it.
141		138
142	When an EOF condition is detected then AnyEvent::Handle will first try to	139	When an EOF condition is detected then AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before	140	feed all the remaining data to the queued callbacks and C<on_read> before
144	calling the C<on_eof> callback. If no progress can be made, then a fatal	141	calling the C<on_eof> callback. If no progress can be made, then a fatal
145	error will be raised (with C<$!> set to C<EPIPE>).	142	error will be raised (with C<$!> set to C<EPIPE>).
		143
		144	Note that, unlike requests in the read queue, an C<on_read> callback
		145	doesn't mean you I<require> some data: if there is an EOF and there
		146	are outstanding read requests then an error will be flagged. With an
		147	C<on_read> callback, the C<on_eof> callback will be invoked.
146		148
147	=item on_drain => $cb->($handle)	149	=item on_drain => $cb->($handle)
148		150
149	This sets the callback that is called when the write buffer becomes empty	151	This sets the callback that is called when the write buffer becomes empty
150	(or when the callback is set and the buffer is empty already).	152	(or when the callback is set and the buffer is empty already).
…		…
249		251
250	A string used to identify the remote site - usually the DNS hostname	252	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.	253	(I<not> IDN!) used to create the connection, rarely the IP address.
252		254
253	Apart from being useful in error messages, this string is also used in TLS	255	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>).	256	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		257	verification will be skipped when C<peername> is not specified or
		258	C<undef>.
255		259
256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	260	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
257		261
258	When this parameter is given, it enables TLS (SSL) mode, that means	262	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	263	AnyEvent will start a TLS handshake as soon as the conenction has been
…		…
296		300
297	Instead of an object, you can also specify a hash reference with C<< key	301	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	302	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
299	new TLS context object.	303	new TLS context object.
300		304
		305	=item on_starttls => $cb->($handle, $success[, $error_message])
		306
		307	This callback will be invoked when the TLS/SSL handshake has finished. If
		308	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		309	(C<on_stoptls> will not be called in this case).
		310
		311	The session in C<< $handle->{tls} >> can still be examined in this
		312	callback, even when the handshake was not successful.
		313
		314	TLS handshake failures will not cause C<on_error> to be invoked when this
		315	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		316
		317	Without this callback, handshake failures lead to C<on_error> being
		318	called, as normal.
		319
		320	Note that you cannot call C<starttls> right again in this callback. If you
		321	need to do that, start an zero-second timer instead whose callback can
		322	then call C<< ->starttls >> again.
		323
		324	=item on_stoptls => $cb->($handle)
		325
		326	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		327	set, then it will be invoked after freeing the TLS session. If it is not,
		328	then a TLS shutdown condition will be treated like a normal EOF condition
		329	on the handle.
		330
		331	The session in C<< $handle->{tls} >> can still be examined in this
		332	callback.
		333
		334	This callback will only be called on TLS shutdowns, not when the
		335	underlying handle signals EOF.
		336
301	=item json => JSON or JSON::XS object	337	=item json => JSON or JSON::XS object
302		338
303	This is the json coder object used by the C<json> read and write types.	339	This is the json coder object used by the C<json> read and write types.
304		340
305	If you don't supply it, then AnyEvent::Handle will create and use a	341	If you don't supply it, then AnyEvent::Handle will create and use a
…		…
327	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	363	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
328		364
329	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	365	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
330	if $self->{tls};	366	if $self->{tls};
331		367
332	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	368	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
333		369
334	$self->start_read	370	$self->start_read
335	if $self->{on_read};	371	if $self->{on_read};
336		372
337	$self->{fh} && $self	373	$self->{fh} && $self
338	}	374	}
339		375
340	sub _shutdown {	376	#sub _shutdown {
341	my ($self) = @_;	377	# my ($self) = @_;
342		378	#
343	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};	379	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
344	$self->{_eof} = 1; # tell starttls et. al to stop trying	380	# $self->{_eof} = 1; # tell starttls et. al to stop trying
345		381	#
346	&_freetls;	382	# &_freetls;
347	}	383	#}
348		384
349	sub _error {	385	sub _error {
350	my ($self, $errno, $fatal, $message) = @_;	386	my ($self, $errno, $fatal, $message) = @_;
351		387
352	$self->_shutdown
353	if $fatal;
354
355	$! = $errno;	388	$! = $errno;
356	$message \|\|= "$!";	389	$message \|\|= "$!";
357		390
358	if ($self->{on_error}) {	391	if ($self->{on_error}) {
359	$self->{on_error}($self, $fatal, $message);	392	$self->{on_error}($self, $fatal, $message);
		393	$self->destroy;
360	} elsif ($self->{fh}) {	394	} elsif ($self->{fh}) {
		395	$self->destroy;
361	Carp::croak "AnyEvent::Handle uncaught error: $message";	396	Carp::croak "AnyEvent::Handle uncaught error: $message";
362	}	397	}
363	}	398	}
364		399
365	=item $fh = $handle->fh	400	=item $fh = $handle->fh
…		…
427	local $SIG{__DIE__};	462	local $SIG{__DIE__};
428	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	463	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
429	};	464	};
430	}	465	}
431		466
		467	=item $handle->on_starttls ($cb)
		468
		469	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		470
		471	=cut
		472
		473	sub on_starttls {
		474	$_[0]{on_starttls} = $_[1];
		475	}
		476
		477	=item $handle->on_stoptls ($cb)
		478
		479	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		480
		481	=cut
		482
		483	sub on_starttls {
		484	$_[0]{on_stoptls} = $_[1];
		485	}
		486
432	#############################################################################	487	#############################################################################
433		488
434	=item $handle->timeout ($seconds)	489	=item $handle->timeout ($seconds)
435		490
436	Configures (or disables) the inactivity timeout.	491	Configures (or disables) the inactivity timeout.
…		…
460	$self->{_activity} = $NOW;	515	$self->{_activity} = $NOW;
461		516
462	if ($self->{on_timeout}) {	517	if ($self->{on_timeout}) {
463	$self->{on_timeout}($self);	518	$self->{on_timeout}($self);
464	} else {	519	} else {
465	$self->_error (&Errno::ETIMEDOUT);	520	$self->_error (Errno::ETIMEDOUT);
466	}	521	}
467		522
468	# callback could have changed timeout value, optimise	523	# callback could have changed timeout value, optimise
469	return unless $self->{timeout};	524	return unless $self->{timeout};
470		525
…		…
533	Scalar::Util::weaken $self;	588	Scalar::Util::weaken $self;
534		589
535	my $cb = sub {	590	my $cb = sub {
536	my $len = syswrite $self->{fh}, $self->{wbuf};	591	my $len = syswrite $self->{fh}, $self->{wbuf};
537		592
538	if ($len >= 0) {	593	if (defined $len) {
539	substr $self->{wbuf}, 0, $len, "";	594	substr $self->{wbuf}, 0, $len, "";
540		595
541	$self->{_activity} = AnyEvent->now;	596	$self->{_activity} = AnyEvent->now;
542		597
543	$self->{on_drain}($self)	598	$self->{on_drain}($self)
…		…
683		738
684	=item $handle->push_shutdown	739	=item $handle->push_shutdown
685		740
686	Sometimes you know you want to close the socket after writing your data	741	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	742	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	743	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:	744	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		745	replaces the C<on_drain> callback with:
690		746
691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	747	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
692		748
693	This simply shuts down the write side and signals an EOF condition to the	749	This simply shuts down the write side and signals an EOF condition to the
694	the peer.	750	the peer.
…		…
697	afterwards. This is the cleanest way to close a connection.	753	afterwards. This is the cleanest way to close a connection.
698		754
699	=cut	755	=cut
700		756
701	sub push_shutdown {	757	sub push_shutdown {
		758	my ($self) = @_;
		759
		760	delete $self->{low_water_mark};
702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };	761	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
703	}	762	}
704		763
705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	764	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
706		765
707	This function (not method) lets you add your own types to C<push_write>.	766	This function (not method) lets you add your own types to C<push_write>.
…		…
808		867
809	if (	868	if (
810	defined $self->{rbuf_max}	869	defined $self->{rbuf_max}
811	&& $self->{rbuf_max} < length $self->{rbuf}	870	&& $self->{rbuf_max} < length $self->{rbuf}
812	) {	871	) {
813	$self->_error (&Errno::ENOSPC, 1), return;	872	$self->_error (Errno::ENOSPC, 1), return;
814	}	873	}
815		874
816	while () {	875	while () {
817	# we need to use a separate tls read buffer, as we must not receive data while	876	# 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.	877	# we are draining the buffer, and this can only happen with TLS.
…		…
822		881
823	if (my $cb = shift @{ $self->{_queue} }) {	882	if (my $cb = shift @{ $self->{_queue} }) {
824	unless ($cb->($self)) {	883	unless ($cb->($self)) {
825	if ($self->{_eof}) {	884	if ($self->{_eof}) {
826	# no progress can be made (not enough data and no data forthcoming)	885	# no progress can be made (not enough data and no data forthcoming)
827	$self->_error (&Errno::EPIPE, 1), return;	886	$self->_error (Errno::EPIPE, 1), return;
828	}	887	}
829		888
830	unshift @{ $self->{_queue} }, $cb;	889	unshift @{ $self->{_queue} }, $cb;
831	last;	890	last;
832	}	891	}
…		…
840	&& !@{ $self->{_queue} } # and the queue is still empty	899	&& !@{ $self->{_queue} } # and the queue is still empty
841	&& $self->{on_read} # but we still have on_read	900	&& $self->{on_read} # but we still have on_read
842	) {	901	) {
843	# no further data will arrive	902	# no further data will arrive
844	# so no progress can be made	903	# so no progress can be made
845	$self->_error (&Errno::EPIPE, 1), return	904	$self->_error (Errno::EPIPE, 1), return
846	if $self->{_eof};	905	if $self->{_eof};
847		906
848	last; # more data might arrive	907	last; # more data might arrive
849	}	908	}
850	} else {	909	} else {
…		…
856		915
857	if ($self->{_eof}) {	916	if ($self->{_eof}) {
858	if ($self->{on_eof}) {	917	if ($self->{on_eof}) {
859	$self->{on_eof}($self)	918	$self->{on_eof}($self)
860	} else {	919	} else {
861	$self->_error (0, 1);	920	$self->_error (0, 1, "Unexpected end-of-file");
862	}	921	}
863	}	922	}
864		923
865	# may need to restart read watcher	924	# may need to restart read watcher
866	unless ($self->{_rw}) {	925	unless ($self->{_rw}) {
…		…
1100	return 1;	1159	return 1;
1101	}	1160	}
1102		1161
1103	# reject	1162	# reject
1104	if ($reject && $$rbuf =~ $reject) {	1163	if ($reject && $$rbuf =~ $reject) {
1105	$self->_error (&Errno::EBADMSG);	1164	$self->_error (Errno::EBADMSG);
1106	}	1165	}
1107		1166
1108	# skip	1167	# skip
1109	if ($skip && $$rbuf =~ $skip) {	1168	if ($skip && $$rbuf =~ $skip) {
1110	$data .= substr $$rbuf, 0, $+[0], "";	1169	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1126	my ($self, $cb) = @_;	1185	my ($self, $cb) = @_;
1127		1186
1128	sub {	1187	sub {
1129	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1188	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1130	if ($_[0]{rbuf} =~ /[^0-9]/) {	1189	if ($_[0]{rbuf} =~ /[^0-9]/) {
1131	$self->_error (&Errno::EBADMSG);	1190	$self->_error (Errno::EBADMSG);
1132	}	1191	}
1133	return;	1192	return;
1134	}	1193	}
1135		1194
1136	my $len = $1;	1195	my $len = $1;
…		…
1139	my $string = $_[1];	1198	my $string = $_[1];
1140	$_[0]->unshift_read (chunk => 1, sub {	1199	$_[0]->unshift_read (chunk => 1, sub {
1141	if ($_[1] eq ",") {	1200	if ($_[1] eq ",") {
1142	$cb->($_[0], $string);	1201	$cb->($_[0], $string);
1143	} else {	1202	} else {
1144	$self->_error (&Errno::EBADMSG);	1203	$self->_error (Errno::EBADMSG);
1145	}	1204	}
1146	});	1205	});
1147	});	1206	});
1148		1207
1149	1	1208	1
…		…
1216	=cut	1275	=cut
1217		1276
1218	register_read_type json => sub {	1277	register_read_type json => sub {
1219	my ($self, $cb) = @_;	1278	my ($self, $cb) = @_;
1220		1279
1221	require JSON;	1280	my $json = $self->{json} \|\|=
		1281	eval { require JSON::XS; JSON::XS->new->utf8 }
		1282	\|\| do { require JSON; JSON->new->utf8 };
1222		1283
1223	my $data;	1284	my $data;
1224	my $rbuf = \$self->{rbuf};	1285	my $rbuf = \$self->{rbuf};
1225
1226	my $json = $self->{json} \|\|= JSON->new->utf8;
1227		1286
1228	sub {	1287	sub {
1229	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1288	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1230		1289
1231	if ($ref) {	1290	if ($ref) {
…		…
1239	$json->incr_skip;	1298	$json->incr_skip;
1240		1299
1241	$self->{rbuf} = $json->incr_text;	1300	$self->{rbuf} = $json->incr_text;
1242	$json->incr_text = "";	1301	$json->incr_text = "";
1243		1302
1244	$self->_error (&Errno::EBADMSG);	1303	$self->_error (Errno::EBADMSG);
1245		1304
1246	()	1305	()
1247	} else {	1306	} else {
1248	$self->{rbuf} = "";	1307	$self->{rbuf} = "";
1249		1308
…		…
1286	# read remaining chunk	1345	# read remaining chunk
1287	$_[0]->unshift_read (chunk => $len, sub {	1346	$_[0]->unshift_read (chunk => $len, sub {
1288	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1347	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1289	$cb->($_[0], $ref);	1348	$cb->($_[0], $ref);
1290	} else {	1349	} else {
1291	$self->_error (&Errno::EBADMSG);	1350	$self->_error (Errno::EBADMSG);
1292	}	1351	}
1293	});	1352	});
1294	}	1353	}
1295		1354
1296	1	1355	1
…		…
1377	}	1436	}
1378	}	1437	}
1379		1438
1380	our $ERROR_SYSCALL;	1439	our $ERROR_SYSCALL;
1381	our $ERROR_WANT_READ;	1440	our $ERROR_WANT_READ;
1382	our $ERROR_ZERO_RETURN;
1383		1441
1384	sub _tls_error {	1442	sub _tls_error {
1385	my ($self, $err) = @_;	1443	my ($self, $err) = @_;
1386	warn "$err,$!\n";#d#
1387		1444
1388	return $self->_error ($!, 1)	1445	return $self->_error ($!, 1)
1389	if $err == Net::SSLeay::ERROR_SYSCALL ();	1446	if $err == Net::SSLeay::ERROR_SYSCALL ();
1390		1447
		1448	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1449
		1450	# reduce error string to look less scary
		1451	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1452
		1453	if ($self->{_on_starttls}) {
		1454	(delete $self->{_on_starttls})->($self, undef, $err);
		1455	&_freetls;
		1456	} else {
		1457	&_freetls;
1391	$self->_error (&Errno::EPROTO, 1,	1458	$self->_error (Errno::EPROTO, 1, $err);
1392	Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()));	1459	}
1393	}	1460	}
1394		1461
1395	# poll the write BIO and send the data if applicable	1462	# poll the write BIO and send the data if applicable
1396	# also decode read data if possible	1463	# also decode read data if possible
1397	# this is basiclaly our TLS state machine	1464	# this is basiclaly our TLS state machine
…		…
1408	}	1475	}
1409		1476
1410	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	1477	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1411	return $self->_tls_error ($tmp)	1478	return $self->_tls_error ($tmp)
1412	if $tmp != $ERROR_WANT_READ	1479	if $tmp != $ERROR_WANT_READ
1413	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1480	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1414	&& $tmp != $ERROR_ZERO_RETURN;
1415	}	1481	}
1416		1482
1417	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1483	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1418	unless (length $tmp) {	1484	unless (length $tmp) {
1419	# let's treat SSL-eof as we treat normal EOF	1485	$self->{_on_starttls}
1420	delete $self->{_rw};	1486	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1421	$self->{_eof} = 1;
1422	&_freetls;	1487	&_freetls;
		1488
		1489	if ($self->{on_stoptls}) {
		1490	$self->{on_stoptls}($self);
		1491	return;
		1492	} else {
		1493	# let's treat SSL-eof as we treat normal EOF
		1494	delete $self->{_rw};
		1495	$self->{_eof} = 1;
		1496	}
1423	}	1497	}
1424		1498
1425	$self->{_tls_rbuf} .= $tmp;	1499	$self->{_tls_rbuf} .= $tmp;
1426	$self->_drain_rbuf unless $self->{_in_drain};	1500	$self->_drain_rbuf unless $self->{_in_drain};
1427	$self->{tls} or return; # tls session might have gone away in callback	1501	$self->{tls} or return; # tls session might have gone away in callback
1428	}	1502	}
1429		1503
1430	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1504	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1431	return $self->_tls_error ($tmp)	1505	return $self->_tls_error ($tmp)
1432	if $tmp != $ERROR_WANT_READ	1506	if $tmp != $ERROR_WANT_READ
1433	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1507	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1434	&& $tmp != $ERROR_ZERO_RETURN;
1435		1508
1436	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1509	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1437	$self->{wbuf} .= $tmp;	1510	$self->{wbuf} .= $tmp;
1438	$self->_drain_wbuf;	1511	$self->_drain_wbuf;
1439	}	1512	}
		1513
		1514	$self->{_on_starttls}
		1515	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1516	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1440	}	1517	}
1441		1518
1442	=item $handle->starttls ($tls[, $tls_ctx])	1519	=item $handle->starttls ($tls[, $tls_ctx])
1443		1520
1444	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1521	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1461	If it an error to start a TLS handshake more than once per	1538	If it an error to start a TLS handshake more than once per
1462	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1539	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1463		1540
1464	=cut	1541	=cut
1465		1542
		1543	our %TLS_CACHE; #TODO not yet documented, should we?
		1544
1466	sub starttls {	1545	sub starttls {
1467	my ($self, $ssl, $ctx) = @_;	1546	my ($self, $ssl, $ctx) = @_;
1468		1547
1469	require Net::SSLeay;	1548	require Net::SSLeay;
1470		1549
1471	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1550	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1472	if $self->{tls};	1551	if $self->{tls};
1473		1552
1474	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1553	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1475	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1554	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1476	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
1477		1555
1478	$ctx \|\|= $self->{tls_ctx};	1556	$ctx \|\|= $self->{tls_ctx};
1479		1557
1480	if ("HASH" eq ref $ctx) {	1558	if ("HASH" eq ref $ctx) {
1481	require AnyEvent::TLS;	1559	require AnyEvent::TLS;
1482		1560
1483	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context	1561	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1562
		1563	if ($ctx->{cache}) {
		1564	my $key = $ctx+0;
		1565	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1566	} else {
1484	$ctx = new AnyEvent::TLS %$ctx;	1567	$ctx = new AnyEvent::TLS %$ctx;
		1568	}
1485	}	1569	}
1486		1570
1487	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1571	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1488	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1572	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1489		1573
…		…
1507	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1591	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1508	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1592	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1509		1593
1510	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1594	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1511		1595
		1596	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1597	if $self->{on_starttls};
		1598
1512	&_dotls; # need to trigger the initial handshake	1599	&_dotls; # need to trigger the initial handshake
1513	$self->start_read; # make sure we actually do read	1600	$self->start_read; # make sure we actually do read
1514	}	1601	}
1515		1602
1516	=item $handle->stoptls	1603	=item $handle->stoptls
…		…
1528	if ($self->{tls}) {	1615	if ($self->{tls}) {
1529	Net::SSLeay::shutdown ($self->{tls});	1616	Net::SSLeay::shutdown ($self->{tls});
1530		1617
1531	&_dotls;	1618	&_dotls;
1532		1619
1533	# we don't give a shit. no, we do, but we can't. no...	1620	# # we don't give a shit. no, we do, but we can't. no...#d#
1534	# we, we... have to use openssl :/	1621	# # we, we... have to use openssl :/#d#
1535	&_freetls;	1622	# &_freetls;#d#
1536	}	1623	}
1537	}	1624	}
1538		1625
1539	sub _freetls {	1626	sub _freetls {
1540	my ($self) = @_;	1627	my ($self) = @_;
1541		1628
1542	return unless $self->{tls};	1629	return unless $self->{tls};
1543		1630
1544	$self->{tls_ctx}->_put_session (delete $self->{tls});	1631	$self->{tls_ctx}->_put_session (delete $self->{tls});
1545		1632
1546	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1633	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1547	}	1634	}
1548		1635
1549	sub DESTROY {	1636	sub DESTROY {
1550	my ($self) = @_;	1637	my ($self) = @_;
1551		1638
…		…
1575	}	1662	}
1576		1663
1577	=item $handle->destroy	1664	=item $handle->destroy
1578		1665
1579	Shuts down the handle object as much as possible - this call ensures that	1666	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	1667	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.	1668	will be freed. You must not call any methods on the object afterwards.
1582		1669
1583	Normally, you can just "forget" any references to an AnyEvent::Handle	1670	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	1671	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	1672	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	1673	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	1674	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1588	that case.	1675	that case.
1589		1676
		1677	Destroying the handle object in this way has the advantage that callbacks
		1678	will be removed as well, so if those are the only reference holders (as
		1679	is common), then one doesn't need to do anything special to break any
		1680	reference cycles.
		1681
1590	The handle might still linger in the background and write out remaining	1682	The handle might still linger in the background and write out remaining
1591	data, as specified by the C<linger> option, however.	1683	data, as specified by the C<linger> option, however.
1592		1684
1593	=cut	1685	=cut
1594		1686
…		…
1661		1753
1662	$handle->on_read (sub { });	1754	$handle->on_read (sub { });
1663	$handle->on_eof (undef);	1755	$handle->on_eof (undef);
1664	$handle->on_error (sub {	1756	$handle->on_error (sub {
1665	my $data = delete $_[0]{rbuf};	1757	my $data = delete $_[0]{rbuf};
1666	undef $handle;
1667	});	1758	});
1668		1759
1669	The reason to use C<on_error> is that TCP connections, due to latencies	1760	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	1761	and packets loss, might get closed quite violently with an error, when in
1671	fact, all data has been received.	1762	fact, all data has been received.
…		…
1687	$handle->on_drain (sub {	1778	$handle->on_drain (sub {
1688	warn "all data submitted to the kernel\n";	1779	warn "all data submitted to the kernel\n";
1689	undef $handle;	1780	undef $handle;
1690	});	1781	});
1691		1782
		1783	If you just want to queue some data and then signal EOF to the other side,
		1784	consider using C<< ->push_shutdown >> instead.
		1785
		1786	=item I want to contact a TLS/SSL server, I don't care about security.
		1787
		1788	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1789	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1790	parameter:
		1791
		1792	tcp_connect $host, $port, sub {
		1793	my ($fh) = @_;
		1794
		1795	my $handle = new AnyEvent::Handle
		1796	fh => $fh,
		1797	tls => "connect",
		1798	on_error => sub { ... };
		1799
		1800	$handle->push_write (...);
		1801	};
		1802
		1803	=item I want to contact a TLS/SSL server, I do care about security.
		1804
		1805	Then you should additionally enable certificate verification, including
		1806	peername verification, if the protocol you use supports it (see
		1807	L<AnyEvent::TLS>, C<verify_peername>).
		1808
		1809	E.g. for HTTPS:
		1810
		1811	tcp_connect $host, $port, sub {
		1812	my ($fh) = @_;
		1813
		1814	my $handle = new AnyEvent::Handle
		1815	fh => $fh,
		1816	peername => $host,
		1817	tls => "connect",
		1818	tls_ctx => { verify => 1, verify_peername => "https" },
		1819	...
		1820
		1821	Note that you must specify the hostname you connected to (or whatever
		1822	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1823	peername verification will be done.
		1824
		1825	The above will use the system-dependent default set of trusted CA
		1826	certificates. If you want to check against a specific CA, add the
		1827	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1828
		1829	tls_ctx => {
		1830	verify => 1,
		1831	verify_peername => "https",
		1832	ca_file => "my-ca-cert.pem",
		1833	},
		1834
		1835	=item I want to create a TLS/SSL server, how do I do that?
		1836
		1837	Well, you first need to get a server certificate and key. You have
		1838	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1839	self-signed certificate (cheap. check the search engine of your choice,
		1840	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1841	nice program for that purpose).
		1842
		1843	Then create a file with your private key (in PEM format, see
		1844	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1845	file should then look like this:
		1846
		1847	-----BEGIN RSA PRIVATE KEY-----
		1848	...header data
		1849	... lots of base64'y-stuff
		1850	-----END RSA PRIVATE KEY-----
		1851
		1852	-----BEGIN CERTIFICATE-----
		1853	... lots of base64'y-stuff
		1854	-----END CERTIFICATE-----
		1855
		1856	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1857	specify this file as C<cert_file>:
		1858
		1859	tcp_server undef, $port, sub {
		1860	my ($fh) = @_;
		1861
		1862	my $handle = new AnyEvent::Handle
		1863	fh => $fh,
		1864	tls => "accept",
		1865	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1866	...
		1867
		1868	When you have intermediate CA certificates that your clients might not
		1869	know about, just append them to the C<cert_file>.
		1870
1692	=back	1871	=back
1693		1872
1694		1873
1695	=head1 SUBCLASSING AnyEvent::Handle	1874	=head1 SUBCLASSING AnyEvent::Handle
1696		1875

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.150 by root, Thu Jul 16 04:16:25 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.150 by root, Thu Jul 16 04:16:25 2009 UTC