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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.139 by root, Sun Jul 5 23:39:48 2009 UTC vs.
Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	3	use Scalar::Util ();
9	use Carp ();	4	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);	5	use Errno qw(EAGAIN EINTR);
12		6
		7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		9
13	=head1 NAME	10	=head1 NAME
14		11
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		13
17	=cut	14	=cut
18		15
19	our $VERSION = 4.452;	16	our $VERSION = 4.86;
20		17
21	=head1 SYNOPSIS	18	=head1 SYNOPSIS
22		19
23	use AnyEvent;	20	use AnyEvent;
24	use AnyEvent::Handle;	21	use AnyEvent::Handle;
25		22
26	my $cv = AnyEvent->condvar;	23	my $cv = AnyEvent->condvar;
27		24
28	my $handle =	25	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	26	fh => \*STDIN,
31	on_eof => sub {	27	on_error => sub {
		28	my ($hdl, $fatal, $msg) = @_;
		29	warn "got error $msg\n";
		30	$hdl->destroy;
32	$cv->send;	31	$cv->send;
33	},
34	);	32	);
35		33
36	# send some request line	34	# send some request line
37	$handle->push_write ("getinfo\015\012");	35	$hdl->push_write ("getinfo\015\012");
38		36
39	# read the response line	37	# read the response line
40	$handle->push_read (line => sub {	38	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	39	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	40	warn "got line <$line>\n";
43	$cv->send;	41	$cv->send;
44	});	42	});
45		43
46	$cv->recv;	44	$cv->recv;
47		45
71		69
72	=over 4	70	=over 4
73		71
74	=item fh => $filehandle [MANDATORY]	72	=item fh => $filehandle [MANDATORY]
75		73
		74	#=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
		75
76	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	77	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	79	that mode.
81		80
		81	#=item connect => [$host, $service]
		82	#
		83	# You have to specify either this parameter, or C<connect>, below.
		84	#Try to connect to the specified host and service (port), using
		85	#C<AnyEvent::Socket::tcp_connect>.
		86	#
		87	#When this
		88
82	=item on_eof => $cb->($handle)	89	=item on_eof => $cb->($handle)
83		90
84	Set the callback to be called when an end-of-file condition is detected,	91	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	92	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	93	connection cleanly, and there are no outstanding read requests in the
		94	queue (if there are read requests, then an EOF counts as an unexpected
		95	connection close and will be flagged as an error).
87		96
88	For sockets, this just means that the other side has stopped sending data,	97	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	98	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	99	callback and continue writing data, as only the read part has been shut
91	down.	100	down.
92		101
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	102	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>.	103	set, then a fatal error will be raised with C<$!> set to <0>.
99		104
100	=item on_error => $cb->($handle, $fatal, $message)	105	=item on_error => $cb->($handle, $fatal, $message)
101		106
102	This is the error callback, which is called when, well, some error	107	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	108	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.	109	connect or a read error.
105		110
106	Some errors are fatal (which is indicated by C<$fatal> being true). On	111	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	112	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	113	destroy >>) after invoking the error callback (which means you are free to
109	errors are an EOF condition with active (but unsatisifable) read watchers	114	examine the handle object). Examples of fatal errors are an EOF condition
110	(C<EPIPE>) or I/O errors.	115	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
111		116
112	AnyEvent::Handle tries to find an appropriate error code for you to check	117	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	118	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	119	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).	120	error messages (it's usually the same as C<"$!">).
…		…
141		146
142	When an EOF condition is detected then AnyEvent::Handle will first try to	147	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	148	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	149	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>).	150	error will be raised (with C<$!> set to C<EPIPE>).
		151
		152	Note that, unlike requests in the read queue, an C<on_read> callback
		153	doesn't mean you I<require> some data: if there is an EOF and there
		154	are outstanding read requests then an error will be flagged. With an
		155	C<on_read> callback, the C<on_eof> callback will be invoked.
146		156
147	=item on_drain => $cb->($handle)	157	=item on_drain => $cb->($handle)
148		158
149	This sets the callback that is called when the write buffer becomes empty	159	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).	160	(or when the callback is set and the buffer is empty already).
…		…
249		259
250	A string used to identify the remote site - usually the DNS hostname	260	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.	261	(I<not> IDN!) used to create the connection, rarely the IP address.
252		262
253	Apart from being useful in error messages, this string is also used in TLS	263	Apart from being useful in error messages, this string is also used in TLS
254	peername verification (see C<verify_peername> in L<AnyEvent::TLS>).	264	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		265	verification will be skipped when C<peername> is not specified or
		266	C<undef>.
255		267
256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	268	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
257		269
258	When this parameter is given, it enables TLS (SSL) mode, that means	270	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	271	AnyEvent will start a TLS handshake as soon as the conenction has been
…		…
296		308
297	Instead of an object, you can also specify a hash reference with C<< key	309	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	310	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
299	new TLS context object.	311	new TLS context object.
300		312
		313	=item on_starttls => $cb->($handle, $success[, $error_message])
		314
		315	This callback will be invoked when the TLS/SSL handshake has finished. If
		316	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		317	(C<on_stoptls> will not be called in this case).
		318
		319	The session in C<< $handle->{tls} >> can still be examined in this
		320	callback, even when the handshake was not successful.
		321
		322	TLS handshake failures will not cause C<on_error> to be invoked when this
		323	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		324
		325	Without this callback, handshake failures lead to C<on_error> being
		326	called, as normal.
		327
		328	Note that you cannot call C<starttls> right again in this callback. If you
		329	need to do that, start an zero-second timer instead whose callback can
		330	then call C<< ->starttls >> again.
		331
		332	=item on_stoptls => $cb->($handle)
		333
		334	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		335	set, then it will be invoked after freeing the TLS session. If it is not,
		336	then a TLS shutdown condition will be treated like a normal EOF condition
		337	on the handle.
		338
		339	The session in C<< $handle->{tls} >> can still be examined in this
		340	callback.
		341
		342	This callback will only be called on TLS shutdowns, not when the
		343	underlying handle signals EOF.
		344
301	=item json => JSON or JSON::XS object	345	=item json => JSON or JSON::XS object
302		346
303	This is the json coder object used by the C<json> read and write types.	347	This is the json coder object used by the C<json> read and write types.
304		348
305	If you don't supply it, then AnyEvent::Handle will create and use a	349	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};	371	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
328		372
329	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	373	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
330	if $self->{tls};	374	if $self->{tls};
331		375
332	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	376	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
333		377
334	$self->start_read	378	$self->start_read
335	if $self->{on_read};	379	if $self->{on_read};
336		380
337	$self->{fh} && $self	381	$self->{fh} && $self
338	}	382	}
339		383
340	sub _shutdown {	384	#sub _shutdown {
341	my ($self) = @_;	385	# my ($self) = @_;
342		386	#
343	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};	387	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
344	$self->{_eof} = 1; # tell starttls et. al to stop trying	388	# $self->{_eof} = 1; # tell starttls et. al to stop trying
345		389	#
346	&_freetls;	390	# &_freetls;
347	}	391	#}
348		392
349	sub _error {	393	sub _error {
350	my ($self, $errno, $fatal, $message) = @_;	394	my ($self, $errno, $fatal, $message) = @_;
351		395
352	$self->_shutdown
353	if $fatal;
354
355	$! = $errno;	396	$! = $errno;
356	$message \|\|= "$!";	397	$message \|\|= "$!";
357		398
358	if ($self->{on_error}) {	399	if ($self->{on_error}) {
359	$self->{on_error}($self, $fatal, $message);	400	$self->{on_error}($self, $fatal, $message);
		401	$self->destroy if $fatal;
360	} elsif ($self->{fh}) {	402	} elsif ($self->{fh}) {
		403	$self->destroy;
361	Carp::croak "AnyEvent::Handle uncaught error: $message";	404	Carp::croak "AnyEvent::Handle uncaught error: $message";
362	}	405	}
363	}	406	}
364		407
365	=item $fh = $handle->fh	408	=item $fh = $handle->fh
…		…
427	local $SIG{__DIE__};	470	local $SIG{__DIE__};
428	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	471	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
429	};	472	};
430	}	473	}
431		474
		475	=item $handle->on_starttls ($cb)
		476
		477	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		478
		479	=cut
		480
		481	sub on_starttls {
		482	$_[0]{on_starttls} = $_[1];
		483	}
		484
		485	=item $handle->on_stoptls ($cb)
		486
		487	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		488
		489	=cut
		490
		491	sub on_starttls {
		492	$_[0]{on_stoptls} = $_[1];
		493	}
		494
432	#############################################################################	495	#############################################################################
433		496
434	=item $handle->timeout ($seconds)	497	=item $handle->timeout ($seconds)
435		498
436	Configures (or disables) the inactivity timeout.	499	Configures (or disables) the inactivity timeout.
…		…
460	$self->{_activity} = $NOW;	523	$self->{_activity} = $NOW;
461		524
462	if ($self->{on_timeout}) {	525	if ($self->{on_timeout}) {
463	$self->{on_timeout}($self);	526	$self->{on_timeout}($self);
464	} else {	527	} else {
465	$self->_error (&Errno::ETIMEDOUT);	528	$self->_error (Errno::ETIMEDOUT);
466	}	529	}
467		530
468	# callback could have changed timeout value, optimise	531	# callback could have changed timeout value, optimise
469	return unless $self->{timeout};	532	return unless $self->{timeout};
470		533
…		…
533	Scalar::Util::weaken $self;	596	Scalar::Util::weaken $self;
534		597
535	my $cb = sub {	598	my $cb = sub {
536	my $len = syswrite $self->{fh}, $self->{wbuf};	599	my $len = syswrite $self->{fh}, $self->{wbuf};
537		600
538	if ($len >= 0) {	601	if (defined $len) {
539	substr $self->{wbuf}, 0, $len, "";	602	substr $self->{wbuf}, 0, $len, "";
540		603
541	$self->{_activity} = AnyEvent->now;	604	$self->{_activity} = AnyEvent->now;
542		605
543	$self->{on_drain}($self)	606	$self->{on_drain}($self)
…		…
683		746
684	=item $handle->push_shutdown	747	=item $handle->push_shutdown
685		748
686	Sometimes you know you want to close the socket after writing your data	749	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	750	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	751	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:	752	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		753	replaces the C<on_drain> callback with:
690		754
691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	755	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
692		756
693	This simply shuts down the write side and signals an EOF condition to the	757	This simply shuts down the write side and signals an EOF condition to the
694	the peer.	758	the peer.
…		…
697	afterwards. This is the cleanest way to close a connection.	761	afterwards. This is the cleanest way to close a connection.
698		762
699	=cut	763	=cut
700		764
701	sub push_shutdown {	765	sub push_shutdown {
		766	my ($self) = @_;
		767
		768	delete $self->{low_water_mark};
702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };	769	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
703	}	770	}
704		771
705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	772	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
706		773
707	This function (not method) lets you add your own types to C<push_write>.	774	This function (not method) lets you add your own types to C<push_write>.
…		…
808		875
809	if (	876	if (
810	defined $self->{rbuf_max}	877	defined $self->{rbuf_max}
811	&& $self->{rbuf_max} < length $self->{rbuf}	878	&& $self->{rbuf_max} < length $self->{rbuf}
812	) {	879	) {
813	$self->_error (&Errno::ENOSPC, 1), return;	880	$self->_error (Errno::ENOSPC, 1), return;
814	}	881	}
815		882
816	while () {	883	while () {
817	# we need to use a separate tls read buffer, as we must not receive data while	884	# 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.	885	# we are draining the buffer, and this can only happen with TLS.
…		…
822		889
823	if (my $cb = shift @{ $self->{_queue} }) {	890	if (my $cb = shift @{ $self->{_queue} }) {
824	unless ($cb->($self)) {	891	unless ($cb->($self)) {
825	if ($self->{_eof}) {	892	if ($self->{_eof}) {
826	# no progress can be made (not enough data and no data forthcoming)	893	# no progress can be made (not enough data and no data forthcoming)
827	$self->_error (&Errno::EPIPE, 1), return;	894	$self->_error (Errno::EPIPE, 1), return;
828	}	895	}
829		896
830	unshift @{ $self->{_queue} }, $cb;	897	unshift @{ $self->{_queue} }, $cb;
831	last;	898	last;
832	}	899	}
…		…
840	&& !@{ $self->{_queue} } # and the queue is still empty	907	&& !@{ $self->{_queue} } # and the queue is still empty
841	&& $self->{on_read} # but we still have on_read	908	&& $self->{on_read} # but we still have on_read
842	) {	909	) {
843	# no further data will arrive	910	# no further data will arrive
844	# so no progress can be made	911	# so no progress can be made
845	$self->_error (&Errno::EPIPE, 1), return	912	$self->_error (Errno::EPIPE, 1), return
846	if $self->{_eof};	913	if $self->{_eof};
847		914
848	last; # more data might arrive	915	last; # more data might arrive
849	}	916	}
850	} else {	917	} else {
…		…
856		923
857	if ($self->{_eof}) {	924	if ($self->{_eof}) {
858	if ($self->{on_eof}) {	925	if ($self->{on_eof}) {
859	$self->{on_eof}($self)	926	$self->{on_eof}($self)
860	} else {	927	} else {
861	$self->_error (0, 1);	928	$self->_error (0, 1, "Unexpected end-of-file");
862	}	929	}
863	}	930	}
864		931
865	# may need to restart read watcher	932	# may need to restart read watcher
866	unless ($self->{_rw}) {	933	unless ($self->{_rw}) {
…		…
1100	return 1;	1167	return 1;
1101	}	1168	}
1102		1169
1103	# reject	1170	# reject
1104	if ($reject && $$rbuf =~ $reject) {	1171	if ($reject && $$rbuf =~ $reject) {
1105	$self->_error (&Errno::EBADMSG);	1172	$self->_error (Errno::EBADMSG);
1106	}	1173	}
1107		1174
1108	# skip	1175	# skip
1109	if ($skip && $$rbuf =~ $skip) {	1176	if ($skip && $$rbuf =~ $skip) {
1110	$data .= substr $$rbuf, 0, $+[0], "";	1177	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1126	my ($self, $cb) = @_;	1193	my ($self, $cb) = @_;
1127		1194
1128	sub {	1195	sub {
1129	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1196	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1130	if ($_[0]{rbuf} =~ /[^0-9]/) {	1197	if ($_[0]{rbuf} =~ /[^0-9]/) {
1131	$self->_error (&Errno::EBADMSG);	1198	$self->_error (Errno::EBADMSG);
1132	}	1199	}
1133	return;	1200	return;
1134	}	1201	}
1135		1202
1136	my $len = $1;	1203	my $len = $1;
…		…
1139	my $string = $_[1];	1206	my $string = $_[1];
1140	$_[0]->unshift_read (chunk => 1, sub {	1207	$_[0]->unshift_read (chunk => 1, sub {
1141	if ($_[1] eq ",") {	1208	if ($_[1] eq ",") {
1142	$cb->($_[0], $string);	1209	$cb->($_[0], $string);
1143	} else {	1210	} else {
1144	$self->_error (&Errno::EBADMSG);	1211	$self->_error (Errno::EBADMSG);
1145	}	1212	}
1146	});	1213	});
1147	});	1214	});
1148		1215
1149	1	1216	1
…		…
1239	$json->incr_skip;	1306	$json->incr_skip;
1240		1307
1241	$self->{rbuf} = $json->incr_text;	1308	$self->{rbuf} = $json->incr_text;
1242	$json->incr_text = "";	1309	$json->incr_text = "";
1243		1310
1244	$self->_error (&Errno::EBADMSG);	1311	$self->_error (Errno::EBADMSG);
1245		1312
1246	()	1313	()
1247	} else {	1314	} else {
1248	$self->{rbuf} = "";	1315	$self->{rbuf} = "";
1249		1316
…		…
1286	# read remaining chunk	1353	# read remaining chunk
1287	$_[0]->unshift_read (chunk => $len, sub {	1354	$_[0]->unshift_read (chunk => $len, sub {
1288	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1355	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1289	$cb->($_[0], $ref);	1356	$cb->($_[0], $ref);
1290	} else {	1357	} else {
1291	$self->_error (&Errno::EBADMSG);	1358	$self->_error (Errno::EBADMSG);
1292	}	1359	}
1293	});	1360	});
1294	}	1361	}
1295		1362
1296	1	1363	1
…		…
1377	}	1444	}
1378	}	1445	}
1379		1446
1380	our $ERROR_SYSCALL;	1447	our $ERROR_SYSCALL;
1381	our $ERROR_WANT_READ;	1448	our $ERROR_WANT_READ;
1382	our $ERROR_ZERO_RETURN;
1383		1449
1384	sub _tls_error {	1450	sub _tls_error {
1385	my ($self, $err) = @_;	1451	my ($self, $err) = @_;
1386		1452
1387	return $self->_error ($!, 1)	1453	return $self->_error ($!, 1)
…		…
1390	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	1456	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1391		1457
1392	# reduce error string to look less scary	1458	# reduce error string to look less scary
1393	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	1459	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1394		1460
		1461	if ($self->{_on_starttls}) {
		1462	(delete $self->{_on_starttls})->($self, undef, $err);
		1463	&_freetls;
		1464	} else {
		1465	&_freetls;
1395	$self->_error (&Errno::EPROTO, 1, $err);	1466	$self->_error (Errno::EPROTO, 1, $err);
		1467	}
1396	}	1468	}
1397		1469
1398	# poll the write BIO and send the data if applicable	1470	# poll the write BIO and send the data if applicable
1399	# also decode read data if possible	1471	# also decode read data if possible
1400	# this is basiclaly our TLS state machine	1472	# this is basiclaly our TLS state machine
…		…
1411	}	1483	}
1412		1484
1413	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	1485	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1414	return $self->_tls_error ($tmp)	1486	return $self->_tls_error ($tmp)
1415	if $tmp != $ERROR_WANT_READ	1487	if $tmp != $ERROR_WANT_READ
1416	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1488	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1417	&& $tmp != $ERROR_ZERO_RETURN;
1418	}	1489	}
1419		1490
1420	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1491	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1421	unless (length $tmp) {	1492	unless (length $tmp) {
1422	# let's treat SSL-eof as we treat normal EOF	1493	$self->{_on_starttls}
1423	delete $self->{_rw};	1494	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1424	$self->{_eof} = 1;
1425	&_freetls;	1495	&_freetls;
		1496
		1497	if ($self->{on_stoptls}) {
		1498	$self->{on_stoptls}($self);
		1499	return;
		1500	} else {
		1501	# let's treat SSL-eof as we treat normal EOF
		1502	delete $self->{_rw};
		1503	$self->{_eof} = 1;
		1504	}
1426	}	1505	}
1427		1506
1428	$self->{_tls_rbuf} .= $tmp;	1507	$self->{_tls_rbuf} .= $tmp;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1508	$self->_drain_rbuf unless $self->{_in_drain};
1430	$self->{tls} or return; # tls session might have gone away in callback	1509	$self->{tls} or return; # tls session might have gone away in callback
1431	}	1510	}
1432		1511
1433	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1512	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1434	return $self->_tls_error ($tmp)	1513	return $self->_tls_error ($tmp)
1435	if $tmp != $ERROR_WANT_READ	1514	if $tmp != $ERROR_WANT_READ
1436	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1515	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1437	&& $tmp != $ERROR_ZERO_RETURN;
1438		1516
1439	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1517	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1440	$self->{wbuf} .= $tmp;	1518	$self->{wbuf} .= $tmp;
1441	$self->_drain_wbuf;	1519	$self->_drain_wbuf;
1442	}	1520	}
		1521
		1522	$self->{_on_starttls}
		1523	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1524	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1443	}	1525	}
1444		1526
1445	=item $handle->starttls ($tls[, $tls_ctx])	1527	=item $handle->starttls ($tls[, $tls_ctx])
1446		1528
1447	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1529	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1448	object is created, you can also do that at a later time by calling	1530	object is created, you can also do that at a later time by calling
1449	C<starttls>.	1531	C<starttls>.
		1532
		1533	Starting TLS is currently an asynchronous operation - when you push some
		1534	write data and then call C<< ->starttls >> then TLS negotiation will start
		1535	immediately, after which the queued write data is then sent.
1450		1536
1451	The first argument is the same as the C<tls> constructor argument (either	1537	The first argument is the same as the C<tls> constructor argument (either
1452	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1538	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1453		1539
1454	The second argument is the optional C<AnyEvent::TLS> object that is used	1540	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1474	require Net::SSLeay;	1560	require Net::SSLeay;
1475		1561
1476	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1562	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1477	if $self->{tls};	1563	if $self->{tls};
1478		1564
1479	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1565	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1480	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1566	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1481	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
1482		1567
1483	$ctx \|\|= $self->{tls_ctx};	1568	$ctx \|\|= $self->{tls_ctx};
		1569
		1570	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1484		1571
1485	if ("HASH" eq ref $ctx) {	1572	if ("HASH" eq ref $ctx) {
1486	require AnyEvent::TLS;	1573	require AnyEvent::TLS;
1487
1488	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1489		1574
1490	if ($ctx->{cache}) {	1575	if ($ctx->{cache}) {
1491	my $key = $ctx+0;	1576	my $key = $ctx+0;
1492	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1577	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1493	} else {	1578	} else {
…		…
1518	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1603	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1519	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1604	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1520		1605
1521	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1606	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1522		1607
		1608	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1609	if $self->{on_starttls};
		1610
1523	&_dotls; # need to trigger the initial handshake	1611	&_dotls; # need to trigger the initial handshake
1524	$self->start_read; # make sure we actually do read	1612	$self->start_read; # make sure we actually do read
1525	}	1613	}
1526		1614
1527	=item $handle->stoptls	1615	=item $handle->stoptls
…		…
1539	if ($self->{tls}) {	1627	if ($self->{tls}) {
1540	Net::SSLeay::shutdown ($self->{tls});	1628	Net::SSLeay::shutdown ($self->{tls});
1541		1629
1542	&_dotls;	1630	&_dotls;
1543		1631
1544	# we don't give a shit. no, we do, but we can't. no...	1632	# # we don't give a shit. no, we do, but we can't. no...#d#
1545	# we, we... have to use openssl :/	1633	# # we, we... have to use openssl :/#d#
1546	&_freetls;	1634	# &_freetls;#d#
1547	}	1635	}
1548	}	1636	}
1549		1637
1550	sub _freetls {	1638	sub _freetls {
1551	my ($self) = @_;	1639	my ($self) = @_;
1552		1640
1553	return unless $self->{tls};	1641	return unless $self->{tls};
1554		1642
1555	$self->{tls_ctx}->_put_session (delete $self->{tls});	1643	$self->{tls_ctx}->_put_session (delete $self->{tls});
1556		1644
1557	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1645	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1558	}	1646	}
1559		1647
1560	sub DESTROY {	1648	sub DESTROY {
1561	my ($self) = @_;	1649	my ($self) = @_;
1562		1650
1563	&_freetls;	1651	&_freetls;
1564		1652
1565	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1653	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1566		1654
1567	if ($linger && length $self->{wbuf}) {	1655	if ($linger && length $self->{wbuf} && $self->{fh}) {
1568	my $fh = delete $self->{fh};	1656	my $fh = delete $self->{fh};
1569	my $wbuf = delete $self->{wbuf};	1657	my $wbuf = delete $self->{wbuf};
1570		1658
1571	my @linger;	1659	my @linger;
1572		1660
…		…
1586	}	1674	}
1587		1675
1588	=item $handle->destroy	1676	=item $handle->destroy
1589		1677
1590	Shuts down the handle object as much as possible - this call ensures that	1678	Shuts down the handle object as much as possible - this call ensures that
1591	no further callbacks will be invoked and resources will be freed as much	1679	no further callbacks will be invoked and as many resources as possible
1592	as possible. You must not call any methods on the object afterwards.	1680	will be freed. You must not call any methods on the object afterwards.
1593		1681
1594	Normally, you can just "forget" any references to an AnyEvent::Handle	1682	Normally, you can just "forget" any references to an AnyEvent::Handle
1595	object and it will simply shut down. This works in fatal error and EOF	1683	object and it will simply shut down. This works in fatal error and EOF
1596	callbacks, as well as code outside. It does I<NOT> work in a read or write	1684	callbacks, as well as code outside. It does I<NOT> work in a read or write
1597	callback, so when you want to destroy the AnyEvent::Handle object from	1685	callback, so when you want to destroy the AnyEvent::Handle object from
1598	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1686	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1599	that case.	1687	that case.
1600		1688
		1689	Destroying the handle object in this way has the advantage that callbacks
		1690	will be removed as well, so if those are the only reference holders (as
		1691	is common), then one doesn't need to do anything special to break any
		1692	reference cycles.
		1693
1601	The handle might still linger in the background and write out remaining	1694	The handle might still linger in the background and write out remaining
1602	data, as specified by the C<linger> option, however.	1695	data, as specified by the C<linger> option, however.
1603		1696
1604	=cut	1697	=cut
1605		1698
…		…
1672		1765
1673	$handle->on_read (sub { });	1766	$handle->on_read (sub { });
1674	$handle->on_eof (undef);	1767	$handle->on_eof (undef);
1675	$handle->on_error (sub {	1768	$handle->on_error (sub {
1676	my $data = delete $_[0]{rbuf};	1769	my $data = delete $_[0]{rbuf};
1677	undef $handle;
1678	});	1770	});
1679		1771
1680	The reason to use C<on_error> is that TCP connections, due to latencies	1772	The reason to use C<on_error> is that TCP connections, due to latencies
1681	and packets loss, might get closed quite violently with an error, when in	1773	and packets loss, might get closed quite violently with an error, when in
1682	fact, all data has been received.	1774	fact, all data has been received.
…		…
1698	$handle->on_drain (sub {	1790	$handle->on_drain (sub {
1699	warn "all data submitted to the kernel\n";	1791	warn "all data submitted to the kernel\n";
1700	undef $handle;	1792	undef $handle;
1701	});	1793	});
1702		1794
		1795	If you just want to queue some data and then signal EOF to the other side,
		1796	consider using C<< ->push_shutdown >> instead.
		1797
		1798	=item I want to contact a TLS/SSL server, I don't care about security.
		1799
		1800	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1801	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1802	parameter:
		1803
		1804	tcp_connect $host, $port, sub {
		1805	my ($fh) = @_;
		1806
		1807	my $handle = new AnyEvent::Handle
		1808	fh => $fh,
		1809	tls => "connect",
		1810	on_error => sub { ... };
		1811
		1812	$handle->push_write (...);
		1813	};
		1814
		1815	=item I want to contact a TLS/SSL server, I do care about security.
		1816
		1817	Then you should additionally enable certificate verification, including
		1818	peername verification, if the protocol you use supports it (see
		1819	L<AnyEvent::TLS>, C<verify_peername>).
		1820
		1821	E.g. for HTTPS:
		1822
		1823	tcp_connect $host, $port, sub {
		1824	my ($fh) = @_;
		1825
		1826	my $handle = new AnyEvent::Handle
		1827	fh => $fh,
		1828	peername => $host,
		1829	tls => "connect",
		1830	tls_ctx => { verify => 1, verify_peername => "https" },
		1831	...
		1832
		1833	Note that you must specify the hostname you connected to (or whatever
		1834	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1835	peername verification will be done.
		1836
		1837	The above will use the system-dependent default set of trusted CA
		1838	certificates. If you want to check against a specific CA, add the
		1839	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1840
		1841	tls_ctx => {
		1842	verify => 1,
		1843	verify_peername => "https",
		1844	ca_file => "my-ca-cert.pem",
		1845	},
		1846
		1847	=item I want to create a TLS/SSL server, how do I do that?
		1848
		1849	Well, you first need to get a server certificate and key. You have
		1850	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1851	self-signed certificate (cheap. check the search engine of your choice,
		1852	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1853	nice program for that purpose).
		1854
		1855	Then create a file with your private key (in PEM format, see
		1856	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1857	file should then look like this:
		1858
		1859	-----BEGIN RSA PRIVATE KEY-----
		1860	...header data
		1861	... lots of base64'y-stuff
		1862	-----END RSA PRIVATE KEY-----
		1863
		1864	-----BEGIN CERTIFICATE-----
		1865	... lots of base64'y-stuff
		1866	-----END CERTIFICATE-----
		1867
		1868	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1869	specify this file as C<cert_file>:
		1870
		1871	tcp_server undef, $port, sub {
		1872	my ($fh) = @_;
		1873
		1874	my $handle = new AnyEvent::Handle
		1875	fh => $fh,
		1876	tls => "accept",
		1877	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1878	...
		1879
		1880	When you have intermediate CA certificates that your clients might not
		1881	know about, just append them to the C<cert_file>.
		1882
1703	=back	1883	=back
1704		1884
1705		1885
1706	=head1 SUBCLASSING AnyEvent::Handle	1886	=head1 SUBCLASSING AnyEvent::Handle
1707		1887

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.139 by root, Sun Jul 5 23:39:48 2009 UTC vs. Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.139 by root, Sun Jul 5 23:39:48 2009 UTC vs.
Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC