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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC vs.
Revision 1.172 by root, Wed Aug 5 20:50:27 2009 UTC

…		…
11		11
12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
13		13
14	=cut	14	=cut
15		15
16	our $VERSION = 4.86;	16	our $VERSION = 4.901;
17		17
18	=head1 SYNOPSIS	18	=head1 SYNOPSIS
19		19
20	use AnyEvent;	20	use AnyEvent;
21	use AnyEvent::Handle;	21	use AnyEvent::Handle;
…		…
44	$cv->recv;	44	$cv->recv;
45		45
46	=head1 DESCRIPTION	46	=head1 DESCRIPTION
47		47
48	This module is a helper module to make it easier to do event-based I/O on	48	This module is a helper module to make it easier to do event-based I/O on
49	filehandles. For utility functions for doing non-blocking connects and accepts	49	filehandles.
50	on sockets see L<AnyEvent::Util>.
51		50
52	The L<AnyEvent::Intro> tutorial contains some well-documented	51	The L<AnyEvent::Intro> tutorial contains some well-documented
53	AnyEvent::Handle examples.	52	AnyEvent::Handle examples.
54		53
55	In the following, when the documentation refers to of "bytes" then this	54	In the following, when the documentation refers to of "bytes" then this
56	means characters. As sysread and syswrite are used for all I/O, their	55	means characters. As sysread and syswrite are used for all I/O, their
57	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
58		57
		58	At the very minimum, you should specify C<fh> or C<connect>, and the
		59	C<on_error> callback.
		60
59	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
60	argument.	62	argument.
61		63
62	=head1 METHODS	64	=head1 METHODS
63		65
…		…
67		69
68	The constructor supports these arguments (all as C<< key => value >> pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
69		71
70	=over 4	72	=over 4
71		73
72	=item fh => $filehandle [MANDATORY]
73
74	#=item fh => $filehandle [C<fh> or C<connect> MANDATORY]	74	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		75
76	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
77	NOTE: The filehandle will be set to non-blocking mode (using	77	NOTE: The filehandle will be set to non-blocking mode (using
78	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
79	that mode.	79	that mode.
80		80
81	#=item connect => [$host, $service]	81	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
82	#	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	83	Try to connect to the specified host and service (port), using
85	#C<AnyEvent::Socket::tcp_connect>.	84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
86	#	85	default C<peername>.
87	#When this	86
		87	You have to specify either this parameter, or C<fh>, above.
		88
		89	It is possible to push requests on the read and write queues, and modify
		90	properties of the stream, even while AnyEvent::Handle is connecting.
		91
		92	When this parameter is specified, then the C<on_prepare>,
		93	C<on_connect_error> and C<on_connect> callbacks will be called under the
		94	appropriate circumstances:
		95
		96	=over 4
		97
		98	=item on_prepare => $cb->($handle)
		99
		100	This (rarely used) callback is called before a new connection is
		101	attempted, but after the file handle has been created. It could be used to
		102	prepare the file handle with parameters required for the actual connect
		103	(as opposed to settings that can be changed when the connection is already
		104	established).
		105
		106	The return value of this callback should be the connect timeout value in
		107	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		108	timeout is to be used).
		109
		110	=item on_connect => $cb->($handle, $host, $port, $retry->())
		111
		112	This callback is called when a connection has been successfully established.
		113
		114	The actual numeric host and port (the socket peername) are passed as
		115	parameters, together with a retry callback.
		116
		117	When, for some reason, the handle is not acceptable, then calling
		118	C<$retry> will continue with the next conenction target (in case of
		119	multi-homed hosts or SRV records there can be multiple connection
		120	endpoints). When it is called then the read and write queues, eof status,
		121	tls status and similar properties of the handle are being reset.
		122
		123	In most cases, ignoring the C<$retry> parameter is the way to go.
		124
		125	=item on_connect_error => $cb->($handle, $message)
		126
		127	This callback is called when the conenction could not be
		128	established. C<$!> will contain the relevant error code, and C<$message> a
		129	message describing it (usually the same as C<"$!">).
		130
		131	If this callback isn't specified, then C<on_error> will be called with a
		132	fatal error instead.
		133
		134	=back
		135
		136	=item on_error => $cb->($handle, $fatal, $message)
		137
		138	This is the error callback, which is called when, well, some error
		139	occured, such as not being able to resolve the hostname, failure to
		140	connect or a read error.
		141
		142	Some errors are fatal (which is indicated by C<$fatal> being true). On
		143	fatal errors the handle object will be destroyed (by a call to C<< ->
		144	destroy >>) after invoking the error callback (which means you are free to
		145	examine the handle object). Examples of fatal errors are an EOF condition
		146	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		147	cases where the other side can close the connection at their will it is
		148	often easiest to not report C<EPIPE> errors in this callback.
		149
		150	AnyEvent::Handle tries to find an appropriate error code for you to check
		151	against, but in some cases (TLS errors), this does not work well. It is
		152	recommended to always output the C<$message> argument in human-readable
		153	error messages (it's usually the same as C<"$!">).
		154
		155	Non-fatal errors can be retried by simply returning, but it is recommended
		156	to simply ignore this parameter and instead abondon the handle object
		157	when this callback is invoked. Examples of non-fatal errors are timeouts
		158	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		159
		160	On callback entrance, the value of C<$!> contains the operating system
		161	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		162	C<EPROTO>).
		163
		164	While not mandatory, it is I<highly> recommended to set this callback, as
		165	you will not be notified of errors otherwise. The default simply calls
		166	C<croak>.
		167
		168	=item on_read => $cb->($handle)
		169
		170	This sets the default read callback, which is called when data arrives
		171	and no read request is in the queue (unlike read queue callbacks, this
		172	callback will only be called when at least one octet of data is in the
		173	read buffer).
		174
		175	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		176	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		177	must not enlarge or modify the read buffer, you can only remove data at
		178	the beginning from it.
		179
		180	When an EOF condition is detected then AnyEvent::Handle will first try to
		181	feed all the remaining data to the queued callbacks and C<on_read> before
		182	calling the C<on_eof> callback. If no progress can be made, then a fatal
		183	error will be raised (with C<$!> set to C<EPIPE>).
		184
		185	Note that, unlike requests in the read queue, an C<on_read> callback
		186	doesn't mean you I<require> some data: if there is an EOF and there
		187	are outstanding read requests then an error will be flagged. With an
		188	C<on_read> callback, the C<on_eof> callback will be invoked.
88		189
89	=item on_eof => $cb->($handle)	190	=item on_eof => $cb->($handle)
90		191
91	Set the callback to be called when an end-of-file condition is detected,	192	Set the callback to be called when an end-of-file condition is detected,
92	i.e. in the case of a socket, when the other side has closed the	193	i.e. in the case of a socket, when the other side has closed the
…		…
99	callback and continue writing data, as only the read part has been shut	200	callback and continue writing data, as only the read part has been shut
100	down.	201	down.
101		202
102	If an EOF condition has been detected but no C<on_eof> callback has been	203	If an EOF condition has been detected but no C<on_eof> callback has been
103	set, then a fatal error will be raised with C<$!> set to <0>.	204	set, then a fatal error will be raised with C<$!> set to <0>.
104
105	=item on_error => $cb->($handle, $fatal, $message)
106
107	This is the error callback, which is called when, well, some error
108	occured, such as not being able to resolve the hostname, failure to
109	connect or a read error.
110
111	Some errors are fatal (which is indicated by C<$fatal> being true). On
112	fatal errors the handle object will be destroyed (by a call to C<< ->
113	destroy >>) after invoking the error callback (which means you are free to
114	examine the handle object). Examples of fatal errors are an EOF condition
115	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
116
117	AnyEvent::Handle tries to find an appropriate error code for you to check
118	against, but in some cases (TLS errors), this does not work well. It is
119	recommended to always output the C<$message> argument in human-readable
120	error messages (it's usually the same as C<"$!">).
121
122	Non-fatal errors can be retried by simply returning, but it is recommended
123	to simply ignore this parameter and instead abondon the handle object
124	when this callback is invoked. Examples of non-fatal errors are timeouts
125	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
126
127	On callback entrance, the value of C<$!> contains the operating system
128	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
129	C<EPROTO>).
130
131	While not mandatory, it is I<highly> recommended to set this callback, as
132	you will not be notified of errors otherwise. The default simply calls
133	C<croak>.
134
135	=item on_read => $cb->($handle)
136
137	This sets the default read callback, which is called when data arrives
138	and no read request is in the queue (unlike read queue callbacks, this
139	callback will only be called when at least one octet of data is in the
140	read buffer).
141
142	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
143	method or access the C<< $handle->{rbuf} >> member directly. Note that you
144	must not enlarge or modify the read buffer, you can only remove data at
145	the beginning from it.
146
147	When an EOF condition is detected then AnyEvent::Handle will first try to
148	feed all the remaining data to the queued callbacks and C<on_read> before
149	calling the C<on_eof> callback. If no progress can be made, then a fatal
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.
156		205
157	=item on_drain => $cb->($handle)	206	=item on_drain => $cb->($handle)
158		207
159	This sets the callback that is called when the write buffer becomes empty	208	This sets the callback that is called when the write buffer becomes empty
160	(or when the callback is set and the buffer is empty already).	209	(or when the callback is set and the buffer is empty already).
…		…
359		408
360	sub new {	409	sub new {
361	my $class = shift;	410	my $class = shift;
362	my $self = bless { @_ }, $class;	411	my $self = bless { @_ }, $class;
363		412
364	$self->{fh} or Carp::croak "mandatory argument fh is missing";	413	if ($self->{fh}) {
		414	$self->_start;
		415	return unless $self->{fh}; # could be gone by now
		416
		417	} elsif ($self->{connect}) {
		418	require AnyEvent::Socket;
		419
		420	$self->{peername} = $self->{connect}[0]
		421	unless exists $self->{peername};
		422
		423	$self->{_skip_drain_rbuf} = 1;
		424
		425	{
		426	Scalar::Util::weaken (my $self = $self);
		427
		428	$self->{_connect} =
		429	AnyEvent::Socket::tcp_connect (
		430	$self->{connect}[0],
		431	$self->{connect}[1],
		432	sub {
		433	my ($fh, $host, $port, $retry) = @_;
		434
		435	if ($fh) {
		436	$self->{fh} = $fh;
		437
		438	delete $self->{_skip_drain_rbuf};
		439	$self->_start;
		440
		441	$self->{on_connect}
		442	and $self->{on_connect}($self, $host, $port, sub {
		443	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		444	$self->{_skip_drain_rbuf} = 1;
		445	&$retry;
		446	});
		447
		448	} else {
		449	if ($self->{on_connect_error}) {
		450	$self->{on_connect_error}($self, "$!");
		451	$self->destroy;
		452	} else {
		453	$self->_error ($!, 1);
		454	}
		455	}
		456	},
		457	sub {
		458	local $self->{fh} = $_[0];
		459
		460	$self->{on_prepare}
		461	? $self->{on_prepare}->($self)
		462	: ()
		463	}
		464	);
		465	}
		466
		467	} else {
		468	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		469	}
		470
		471	$self
		472	}
		473
		474	sub _start {
		475	my ($self) = @_;
365		476
366	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
367		478
368	$self->{_activity} = AnyEvent->now;	479	$self->{_activity} = AnyEvent->now;
369	$self->_timeout;	480	$self->_timeout;
…		…
374	if $self->{tls};	485	if $self->{tls};
375		486
376	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
377		488
378	$self->start_read	489	$self->start_read
379	if $self->{on_read};	490	if $self->{on_read} \|\| @{ $self->{_queue} };
380		491
381	$self->{fh} && $self	492	$self->_drain_wbuf;
382	}	493	}
383		494
384	#sub _shutdown {	495	#sub _shutdown {
385	# my ($self) = @_;	496	# my ($self) = @_;
386	#	497	#
…		…
466	sub no_delay {	577	sub no_delay {
467	$_[0]{no_delay} = $_[1];	578	$_[0]{no_delay} = $_[1];
468		579
469	eval {	580	eval {
470	local $SIG{__DIE__};	581	local $SIG{__DIE__};
471	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	582	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		583	if $_[0]{fh};
472	};	584	};
473	}	585	}
474		586
475	=item $handle->on_starttls ($cb)	587	=item $handle->on_starttls ($cb)
476		588
…		…
488		600
489	=cut	601	=cut
490		602
491	sub on_starttls {	603	sub on_starttls {
492	$_[0]{on_stoptls} = $_[1];	604	$_[0]{on_stoptls} = $_[1];
		605	}
		606
		607	=item $handle->rbuf_max ($max_octets)
		608
		609	Configures the C<rbuf_max> setting (C<undef> disables it).
		610
		611	=cut
		612
		613	sub rbuf_max {
		614	$_[0]{rbuf_max} = $_[1];
493	}	615	}
494		616
495	#############################################################################	617	#############################################################################
496		618
497	=item $handle->timeout ($seconds)	619	=item $handle->timeout ($seconds)
…		…
510	# reset the timeout watcher, as neccessary	632	# reset the timeout watcher, as neccessary
511	# also check for time-outs	633	# also check for time-outs
512	sub _timeout {	634	sub _timeout {
513	my ($self) = @_;	635	my ($self) = @_;
514		636
515	if ($self->{timeout}) {	637	if ($self->{timeout} && $self->{fh}) {
516	my $NOW = AnyEvent->now;	638	my $NOW = AnyEvent->now;
517		639
518	# when would the timeout trigger?	640	# when would the timeout trigger?
519	my $after = $self->{_activity} + $self->{timeout} - $NOW;	641	my $after = $self->{_activity} + $self->{timeout} - $NOW;
520		642
…		…
638	->($self, @_);	760	->($self, @_);
639	}	761	}
640		762
641	if ($self->{tls}) {	763	if ($self->{tls}) {
642	$self->{_tls_wbuf} .= $_[0];	764	$self->{_tls_wbuf} .= $_[0];
643		765	&_dotls ($self) if $self->{fh};
644	&_dotls ($self);
645	} else {	766	} else {
646	$self->{wbuf} .= $_[0];	767	$self->{wbuf} .= $_[0];
647	$self->_drain_wbuf;	768	$self->_drain_wbuf if $self->{fh};
648	}	769	}
649	}	770	}
650		771
651	=item $handle->push_write (type => @args)	772	=item $handle->push_write (type => @args)
652		773
…		…
869	=cut	990	=cut
870		991
871	sub _drain_rbuf {	992	sub _drain_rbuf {
872	my ($self) = @_;	993	my ($self) = @_;
873		994
		995	# avoid recursion
		996	return if $self->{_skip_drain_rbuf};
874	local $self->{_in_drain} = 1;	997	local $self->{_skip_drain_rbuf} = 1;
875
876	if (
877	defined $self->{rbuf_max}
878	&& $self->{rbuf_max} < length $self->{rbuf}
879	) {
880	$self->_error (Errno::ENOSPC, 1), return;
881	}
882		998
883	while () {	999	while () {
884	# we need to use a separate tls read buffer, as we must not receive data while	1000	# we need to use a separate tls read buffer, as we must not receive data while
885	# we are draining the buffer, and this can only happen with TLS.	1001	# we are draining the buffer, and this can only happen with TLS.
886	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1002	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1003	if exists $self->{_tls_rbuf};
887		1004
888	my $len = length $self->{rbuf};	1005	my $len = length $self->{rbuf};
889		1006
890	if (my $cb = shift @{ $self->{_queue} }) {	1007	if (my $cb = shift @{ $self->{_queue} }) {
891	unless ($cb->($self)) {	1008	unless ($cb->($self)) {
892	if ($self->{_eof}) {	1009	# no progress can be made
893	# no progress can be made (not enough data and no data forthcoming)	1010	# (not enough data and no data forthcoming)
894	$self->_error (Errno::EPIPE, 1), return;	1011	$self->_error (Errno::EPIPE, 1), return
895	}	1012	if $self->{_eof};
896		1013
897	unshift @{ $self->{_queue} }, $cb;	1014	unshift @{ $self->{_queue} }, $cb;
898	last;	1015	last;
899	}	1016	}
900	} elsif ($self->{on_read}) {	1017	} elsif ($self->{on_read}) {
…		…
920	last;	1037	last;
921	}	1038	}
922	}	1039	}
923		1040
924	if ($self->{_eof}) {	1041	if ($self->{_eof}) {
925	if ($self->{on_eof}) {	1042	$self->{on_eof}
926	$self->{on_eof}($self)	1043	? $self->{on_eof}($self)
927	} else {
928	$self->_error (0, 1, "Unexpected end-of-file");	1044	: $self->_error (0, 1, "Unexpected end-of-file");
929	}	1045
		1046	return;
		1047	}
		1048
		1049	if (
		1050	defined $self->{rbuf_max}
		1051	&& $self->{rbuf_max} < length $self->{rbuf}
		1052	) {
		1053	$self->_error (Errno::ENOSPC, 1), return;
930	}	1054	}
931		1055
932	# may need to restart read watcher	1056	# may need to restart read watcher
933	unless ($self->{_rw}) {	1057	unless ($self->{_rw}) {
934	$self->start_read	1058	$self->start_read
…		…
946		1070
947	sub on_read {	1071	sub on_read {
948	my ($self, $cb) = @_;	1072	my ($self, $cb) = @_;
949		1073
950	$self->{on_read} = $cb;	1074	$self->{on_read} = $cb;
951	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1075	$self->_drain_rbuf if $cb;
952	}	1076	}
953		1077
954	=item $handle->rbuf	1078	=item $handle->rbuf
955		1079
956	Returns the read buffer (as a modifiable lvalue).	1080	Returns the read buffer (as a modifiable lvalue).
…		…
1008	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1132	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
1009	->($self, $cb, @_);	1133	->($self, $cb, @_);
1010	}	1134	}
1011		1135
1012	push @{ $self->{_queue} }, $cb;	1136	push @{ $self->{_queue} }, $cb;
1013	$self->_drain_rbuf unless $self->{_in_drain};	1137	$self->_drain_rbuf;
1014	}	1138	}
1015		1139
1016	sub unshift_read {	1140	sub unshift_read {
1017	my $self = shift;	1141	my $self = shift;
1018	my $cb = pop;	1142	my $cb = pop;
…		…
1024	->($self, $cb, @_);	1148	->($self, $cb, @_);
1025	}	1149	}
1026		1150
1027		1151
1028	unshift @{ $self->{_queue} }, $cb;	1152	unshift @{ $self->{_queue} }, $cb;
1029	$self->_drain_rbuf unless $self->{_in_drain};	1153	$self->_drain_rbuf;
1030	}	1154	}
1031		1155
1032	=item $handle->push_read (type => @args, $cb)	1156	=item $handle->push_read (type => @args, $cb)
1033		1157
1034	=item $handle->unshift_read (type => @args, $cb)	1158	=item $handle->unshift_read (type => @args, $cb)
…		…
1427	if ($self->{tls}) {	1551	if ($self->{tls}) {
1428	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1552	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1429		1553
1430	&_dotls ($self);	1554	&_dotls ($self);
1431	} else {	1555	} else {
1432	$self->_drain_rbuf unless $self->{_in_drain};	1556	$self->_drain_rbuf;
1433	}	1557	}
1434		1558
1435	} elsif (defined $len) {	1559	} elsif (defined $len) {
1436	delete $self->{_rw};	1560	delete $self->{_rw};
1437	$self->{_eof} = 1;	1561	$self->{_eof} = 1;
1438	$self->_drain_rbuf unless $self->{_in_drain};	1562	$self->_drain_rbuf;
1439		1563
1440	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1564	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1441	return $self->_error ($!, 1);	1565	return $self->_error ($!, 1);
1442	}	1566	}
1443	});	1567	});
…		…
1503	$self->{_eof} = 1;	1627	$self->{_eof} = 1;
1504	}	1628	}
1505	}	1629	}
1506		1630
1507	$self->{_tls_rbuf} .= $tmp;	1631	$self->{_tls_rbuf} .= $tmp;
1508	$self->_drain_rbuf unless $self->{_in_drain};	1632	$self->_drain_rbuf;
1509	$self->{tls} or return; # tls session might have gone away in callback	1633	$self->{tls} or return; # tls session might have gone away in callback
1510	}	1634	}
1511		1635
1512	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1636	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1513	return $self->_tls_error ($tmp)	1637	return $self->_tls_error ($tmp)
…		…
1545	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1669	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1546	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1670	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1547	changed to your liking. Note that the handshake might have already started	1671	changed to your liking. Note that the handshake might have already started
1548	when this function returns.	1672	when this function returns.
1549		1673
1550	If it an error to start a TLS handshake more than once per	1674	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1551	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1675	handshakes on the same stream. Best do not attempt to use the stream after
		1676	stopping TLS.
1552		1677
1553	=cut	1678	=cut
1554		1679
1555	our %TLS_CACHE; #TODO not yet documented, should we?	1680	our %TLS_CACHE; #TODO not yet documented, should we?
1556		1681
1557	sub starttls {	1682	sub starttls {
1558	my ($self, $ssl, $ctx) = @_;	1683	my ($self, $tls, $ctx) = @_;
		1684
		1685	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1686	if $self->{tls};
		1687
		1688	$self->{tls} = $tls;
		1689	$self->{tls_ctx} = $ctx if @_ > 2;
		1690
		1691	return unless $self->{fh};
1559		1692
1560	require Net::SSLeay;	1693	require Net::SSLeay;
1561
1562	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1563	if $self->{tls};
1564		1694
1565	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1695	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1566	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1696	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1567		1697
		1698	$tls = $self->{tls};
1568	$ctx \|\|= $self->{tls_ctx};	1699	$ctx = $self->{tls_ctx};
1569		1700
1570	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1701	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1571		1702
1572	if ("HASH" eq ref $ctx) {	1703	if ("HASH" eq ref $ctx) {
1573	require AnyEvent::TLS;	1704	require AnyEvent::TLS;
…		…
1579	$ctx = new AnyEvent::TLS %$ctx;	1710	$ctx = new AnyEvent::TLS %$ctx;
1580	}	1711	}
1581	}	1712	}
1582		1713
1583	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1714	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1584	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1715	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1585		1716
1586	# basically, this is deep magic (because SSL_read should have the same issues)	1717	# basically, this is deep magic (because SSL_read should have the same issues)
1587	# but the openssl maintainers basically said: "trust us, it just works".	1718	# but the openssl maintainers basically said: "trust us, it just works".
1588	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1719	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1589	# and mismaintained ssleay-module doesn't even offer them).	1720	# and mismaintained ssleay-module doesn't even offer them).
…		…
1596	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1727	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1597	# have identity issues in that area.	1728	# have identity issues in that area.
1598	# Net::SSLeay::CTX_set_mode ($ssl,	1729	# Net::SSLeay::CTX_set_mode ($ssl,
1599	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1730	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1600	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1731	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1601	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1732	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1602		1733
1603	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1734	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1604	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1735	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1605		1736
		1737	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1738
1606	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1739	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1607		1740
1608	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1741	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1609	if $self->{on_starttls};	1742	if $self->{on_starttls};
1610		1743
1611	&_dotls; # need to trigger the initial handshake	1744	&_dotls; # need to trigger the initial handshake
…		…
1614		1747
1615	=item $handle->stoptls	1748	=item $handle->stoptls
1616		1749
1617	Shuts down the SSL connection - this makes a proper EOF handshake by	1750	Shuts down the SSL connection - this makes a proper EOF handshake by
1618	sending a close notify to the other side, but since OpenSSL doesn't	1751	sending a close notify to the other side, but since OpenSSL doesn't
1619	support non-blocking shut downs, it is not possible to re-use the stream	1752	support non-blocking shut downs, it is not guarenteed that you can re-use
1620	afterwards.	1753	the stream afterwards.
1621		1754
1622	=cut	1755	=cut
1623		1756
1624	sub stoptls {	1757	sub stoptls {
1625	my ($self) = @_;	1758	my ($self) = @_;
…		…
1638	sub _freetls {	1771	sub _freetls {
1639	my ($self) = @_;	1772	my ($self) = @_;
1640		1773
1641	return unless $self->{tls};	1774	return unless $self->{tls};
1642		1775
1643	$self->{tls_ctx}->_put_session (delete $self->{tls});	1776	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1777	if $self->{tls} > 0;
1644		1778
1645	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1779	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1646	}	1780	}
1647		1781
1648	sub DESTROY {	1782	sub DESTROY {
…		…
1675		1809
1676	=item $handle->destroy	1810	=item $handle->destroy
1677		1811
1678	Shuts down the handle object as much as possible - this call ensures that	1812	Shuts down the handle object as much as possible - this call ensures that
1679	no further callbacks will be invoked and as many resources as possible	1813	no further callbacks will be invoked and as many resources as possible
1680	will be freed. You must not call any methods on the object afterwards.	1814	will be freed. Any method you will call on the handle object after
		1815	destroying it in this way will be silently ignored (and it will return the
		1816	empty list).
1681		1817
1682	Normally, you can just "forget" any references to an AnyEvent::Handle	1818	Normally, you can just "forget" any references to an AnyEvent::Handle
1683	object and it will simply shut down. This works in fatal error and EOF	1819	object and it will simply shut down. This works in fatal error and EOF
1684	callbacks, as well as code outside. It does I<NOT> work in a read or write	1820	callbacks, as well as code outside. It does I<NOT> work in a read or write
1685	callback, so when you want to destroy the AnyEvent::Handle object from	1821	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1699	sub destroy {	1835	sub destroy {
1700	my ($self) = @_;	1836	my ($self) = @_;
1701		1837
1702	$self->DESTROY;	1838	$self->DESTROY;
1703	%$self = ();	1839	%$self = ();
		1840	bless $self, "AnyEvent::Handle::destroyed";
		1841	}
		1842
		1843	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1844	#nop
1704	}	1845	}
1705		1846
1706	=item AnyEvent::Handle::TLS_CTX	1847	=item AnyEvent::Handle::TLS_CTX
1707		1848
1708	This function creates and returns the AnyEvent::TLS object used by default	1849	This function creates and returns the AnyEvent::TLS object used by default

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC vs. Revision 1.172 by root, Wed Aug 5 20:50:27 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC vs.
Revision 1.172 by root, Wed Aug 5 20:50:27 2009 UTC