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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.156 by root, Wed Jul 22 05:37:32 2009 UTC vs.
Revision 1.171 by root, Tue Aug 4 12:38:55 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.9;
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]	74	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
73		75
74	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
75
76	NOTE: The filehandle will be set to non-blocking mode (using	77	NOTE: The filehandle will be set to non-blocking mode (using
77	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
78	that mode.	79	that mode.
		80
		81	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		82
		83	Try to connect to the specified host and service (port), using
		84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		85	default C<peername>.
		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.
79		189
80	=item on_eof => $cb->($handle)	190	=item on_eof => $cb->($handle)
81		191
82	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,
83	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
…		…
90	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
91	down.	201	down.
92		202
93	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
94	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>.
95
96	=item on_error => $cb->($handle, $fatal, $message)
97
98	This is the error callback, which is called when, well, some error
99	occured, such as not being able to resolve the hostname, failure to
100	connect or a read error.
101
102	Some errors are fatal (which is indicated by C<$fatal> being true). On
103	fatal errors the handle object will be destroyed (by a call to C<< ->
104	destroy >>) after invoking the error callback (which means you are free to
105	examine the handle object). Examples of fatal errors are an EOF condition
106	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
107
108	AnyEvent::Handle tries to find an appropriate error code for you to check
109	against, but in some cases (TLS errors), this does not work well. It is
110	recommended to always output the C<$message> argument in human-readable
111	error messages (it's usually the same as C<"$!">).
112
113	Non-fatal errors can be retried by simply returning, but it is recommended
114	to simply ignore this parameter and instead abondon the handle object
115	when this callback is invoked. Examples of non-fatal errors are timeouts
116	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
117
118	On callback entrance, the value of C<$!> contains the operating system
119	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
120	C<EPROTO>).
121
122	While not mandatory, it is I<highly> recommended to set this callback, as
123	you will not be notified of errors otherwise. The default simply calls
124	C<croak>.
125
126	=item on_read => $cb->($handle)
127
128	This sets the default read callback, which is called when data arrives
129	and no read request is in the queue (unlike read queue callbacks, this
130	callback will only be called when at least one octet of data is in the
131	read buffer).
132
133	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
134	method or access the C<< $handle->{rbuf} >> member directly. Note that you
135	must not enlarge or modify the read buffer, you can only remove data at
136	the beginning from it.
137
138	When an EOF condition is detected then AnyEvent::Handle will first try to
139	feed all the remaining data to the queued callbacks and C<on_read> before
140	calling the C<on_eof> callback. If no progress can be made, then a fatal
141	error will be raised (with C<$!> set to C<EPIPE>).
142
143	Note that, unlike requests in the read queue, an C<on_read> callback
144	doesn't mean you I<require> some data: if there is an EOF and there
145	are outstanding read requests then an error will be flagged. With an
146	C<on_read> callback, the C<on_eof> callback will be invoked.
147		205
148	=item on_drain => $cb->($handle)	206	=item on_drain => $cb->($handle)
149		207
150	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
151	(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).
…		…
350		408
351	sub new {	409	sub new {
352	my $class = shift;	410	my $class = shift;
353	my $self = bless { @_ }, $class;	411	my $self = bless { @_ }, $class;
354		412
355	$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) = @_;
356		476
357	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
358		478
359	$self->{_activity} = AnyEvent->now;	479	$self->{_activity} = AnyEvent->now;
360	$self->_timeout;	480	$self->_timeout;
…		…
365	if $self->{tls};	485	if $self->{tls};
366		486
367	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
368		488
369	$self->start_read	489	$self->start_read
370	if $self->{on_read};	490	if $self->{on_read} \|\| @{ $self->{_queue} };
371		491
372	$self->{fh} && $self	492	$self->_drain_wbuf;
373	}	493	}
374		494
375	#sub _shutdown {	495	#sub _shutdown {
376	# my ($self) = @_;	496	# my ($self) = @_;
377	#	497	#
…		…
457	sub no_delay {	577	sub no_delay {
458	$_[0]{no_delay} = $_[1];	578	$_[0]{no_delay} = $_[1];
459		579
460	eval {	580	eval {
461	local $SIG{__DIE__};	581	local $SIG{__DIE__};
462	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};
463	};	584	};
464	}	585	}
465		586
466	=item $handle->on_starttls ($cb)	587	=item $handle->on_starttls ($cb)
467		588
…		…
479		600
480	=cut	601	=cut
481		602
482	sub on_starttls {	603	sub on_starttls {
483	$_[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];
484	}	615	}
485		616
486	#############################################################################	617	#############################################################################
487		618
488	=item $handle->timeout ($seconds)	619	=item $handle->timeout ($seconds)
…		…
501	# reset the timeout watcher, as neccessary	632	# reset the timeout watcher, as neccessary
502	# also check for time-outs	633	# also check for time-outs
503	sub _timeout {	634	sub _timeout {
504	my ($self) = @_;	635	my ($self) = @_;
505		636
506	if ($self->{timeout}) {	637	if ($self->{timeout} && $self->{fh}) {
507	my $NOW = AnyEvent->now;	638	my $NOW = AnyEvent->now;
508		639
509	# when would the timeout trigger?	640	# when would the timeout trigger?
510	my $after = $self->{_activity} + $self->{timeout} - $NOW;	641	my $after = $self->{_activity} + $self->{timeout} - $NOW;
511		642
…		…
629	->($self, @_);	760	->($self, @_);
630	}	761	}
631		762
632	if ($self->{tls}) {	763	if ($self->{tls}) {
633	$self->{_tls_wbuf} .= $_[0];	764	$self->{_tls_wbuf} .= $_[0];
634		765	&_dotls ($self) if $self->{fh};
635	&_dotls ($self);
636	} else {	766	} else {
637	$self->{wbuf} .= $_[0];	767	$self->{wbuf} .= $_[0];
638	$self->_drain_wbuf;	768	$self->_drain_wbuf if $self->{fh};
639	}	769	}
640	}	770	}
641		771
642	=item $handle->push_write (type => @args)	772	=item $handle->push_write (type => @args)
643		773
…		…
860	=cut	990	=cut
861		991
862	sub _drain_rbuf {	992	sub _drain_rbuf {
863	my ($self) = @_;	993	my ($self) = @_;
864		994
		995	# avoid recursion
		996	return if $self->{_skip_drain_rbuf};
865	local $self->{_in_drain} = 1;	997	local $self->{_skip_drain_rbuf} = 1;
866
867	if (
868	defined $self->{rbuf_max}
869	&& $self->{rbuf_max} < length $self->{rbuf}
870	) {
871	$self->_error (Errno::ENOSPC, 1), return;
872	}
873		998
874	while () {	999	while () {
875	# 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
876	# 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.
877	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1002	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1003	if exists $self->{_tls_rbuf};
878		1004
879	my $len = length $self->{rbuf};	1005	my $len = length $self->{rbuf};
880		1006
881	if (my $cb = shift @{ $self->{_queue} }) {	1007	if (my $cb = shift @{ $self->{_queue} }) {
882	unless ($cb->($self)) {	1008	unless ($cb->($self)) {
883	if ($self->{_eof}) {	1009	# no progress can be made
884	# no progress can be made (not enough data and no data forthcoming)	1010	# (not enough data and no data forthcoming)
885	$self->_error (Errno::EPIPE, 1), return;	1011	$self->_error (Errno::EPIPE, 1), return
886	}	1012	if $self->{_eof};
887		1013
888	unshift @{ $self->{_queue} }, $cb;	1014	unshift @{ $self->{_queue} }, $cb;
889	last;	1015	last;
890	}	1016	}
891	} elsif ($self->{on_read}) {	1017	} elsif ($self->{on_read}) {
…		…
911	last;	1037	last;
912	}	1038	}
913	}	1039	}
914		1040
915	if ($self->{_eof}) {	1041	if ($self->{_eof}) {
916	if ($self->{on_eof}) {	1042	$self->{on_eof}
917	$self->{on_eof}($self)	1043	? $self->{on_eof}($self)
918	} else {
919	$self->_error (0, 1, "Unexpected end-of-file");	1044	: $self->_error (0, 1, "Unexpected end-of-file");
920	}	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;
921	}	1054	}
922		1055
923	# may need to restart read watcher	1056	# may need to restart read watcher
924	unless ($self->{_rw}) {	1057	unless ($self->{_rw}) {
925	$self->start_read	1058	$self->start_read
…		…
937		1070
938	sub on_read {	1071	sub on_read {
939	my ($self, $cb) = @_;	1072	my ($self, $cb) = @_;
940		1073
941	$self->{on_read} = $cb;	1074	$self->{on_read} = $cb;
942	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1075	$self->_drain_rbuf if $cb;
943	}	1076	}
944		1077
945	=item $handle->rbuf	1078	=item $handle->rbuf
946		1079
947	Returns the read buffer (as a modifiable lvalue).	1080	Returns the read buffer (as a modifiable lvalue).
…		…
999	$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")
1000	->($self, $cb, @_);	1133	->($self, $cb, @_);
1001	}	1134	}
1002		1135
1003	push @{ $self->{_queue} }, $cb;	1136	push @{ $self->{_queue} }, $cb;
1004	$self->_drain_rbuf unless $self->{_in_drain};	1137	$self->_drain_rbuf;
1005	}	1138	}
1006		1139
1007	sub unshift_read {	1140	sub unshift_read {
1008	my $self = shift;	1141	my $self = shift;
1009	my $cb = pop;	1142	my $cb = pop;
…		…
1015	->($self, $cb, @_);	1148	->($self, $cb, @_);
1016	}	1149	}
1017		1150
1018		1151
1019	unshift @{ $self->{_queue} }, $cb;	1152	unshift @{ $self->{_queue} }, $cb;
1020	$self->_drain_rbuf unless $self->{_in_drain};	1153	$self->_drain_rbuf;
1021	}	1154	}
1022		1155
1023	=item $handle->push_read (type => @args, $cb)	1156	=item $handle->push_read (type => @args, $cb)
1024		1157
1025	=item $handle->unshift_read (type => @args, $cb)	1158	=item $handle->unshift_read (type => @args, $cb)
…		…
1418	if ($self->{tls}) {	1551	if ($self->{tls}) {
1419	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1552	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1420		1553
1421	&_dotls ($self);	1554	&_dotls ($self);
1422	} else {	1555	} else {
1423	$self->_drain_rbuf unless $self->{_in_drain};	1556	$self->_drain_rbuf;
1424	}	1557	}
1425		1558
1426	} elsif (defined $len) {	1559	} elsif (defined $len) {
1427	delete $self->{_rw};	1560	delete $self->{_rw};
1428	$self->{_eof} = 1;	1561	$self->{_eof} = 1;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1562	$self->_drain_rbuf;
1430		1563
1431	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1564	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1432	return $self->_error ($!, 1);	1565	return $self->_error ($!, 1);
1433	}	1566	}
1434	});	1567	});
…		…
1494	$self->{_eof} = 1;	1627	$self->{_eof} = 1;
1495	}	1628	}
1496	}	1629	}
1497		1630
1498	$self->{_tls_rbuf} .= $tmp;	1631	$self->{_tls_rbuf} .= $tmp;
1499	$self->_drain_rbuf unless $self->{_in_drain};	1632	$self->_drain_rbuf;
1500	$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
1501	}	1634	}
1502		1635
1503	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1636	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1504	return $self->_tls_error ($tmp)	1637	return $self->_tls_error ($tmp)
…		…
1519		1652
1520	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1653	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1521	object is created, you can also do that at a later time by calling	1654	object is created, you can also do that at a later time by calling
1522	C<starttls>.	1655	C<starttls>.
1523		1656
		1657	Starting TLS is currently an asynchronous operation - when you push some
		1658	write data and then call C<< ->starttls >> then TLS negotiation will start
		1659	immediately, after which the queued write data is then sent.
		1660
1524	The first argument is the same as the C<tls> constructor argument (either	1661	The first argument is the same as the C<tls> constructor argument (either
1525	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1662	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1526		1663
1527	The second argument is the optional C<AnyEvent::TLS> object that is used	1664	The second argument is the optional C<AnyEvent::TLS> object that is used
1528	when AnyEvent::Handle has to create its own TLS connection object, or	1665	when AnyEvent::Handle has to create its own TLS connection object, or
…		…
1532	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
1533	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
1534	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
1535	when this function returns.	1672	when this function returns.
1536		1673
1537	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
1538	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.
1539		1677
1540	=cut	1678	=cut
1541		1679
1542	our %TLS_CACHE; #TODO not yet documented, should we?	1680	our %TLS_CACHE; #TODO not yet documented, should we?
1543		1681
1544	sub starttls {	1682	sub starttls {
1545	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};
1546		1692
1547	require Net::SSLeay;	1693	require Net::SSLeay;
1548
1549	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1550	if $self->{tls};
1551		1694
1552	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1695	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1553	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1696	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1554		1697
		1698	$tls = $self->{tls};
1555	$ctx \|\|= $self->{tls_ctx};	1699	$ctx = $self->{tls_ctx};
		1700
		1701	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1556		1702
1557	if ("HASH" eq ref $ctx) {	1703	if ("HASH" eq ref $ctx) {
1558	require AnyEvent::TLS;	1704	require AnyEvent::TLS;
1559
1560	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1561		1705
1562	if ($ctx->{cache}) {	1706	if ($ctx->{cache}) {
1563	my $key = $ctx+0;	1707	my $key = $ctx+0;
1564	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1708	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1565	} else {	1709	} else {
1566	$ctx = new AnyEvent::TLS %$ctx;	1710	$ctx = new AnyEvent::TLS %$ctx;
1567	}	1711	}
1568	}	1712	}
1569		1713
1570	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1714	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1571	$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});
1572		1716
1573	# 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)
1574	# but the openssl maintainers basically said: "trust us, it just works".	1718	# but the openssl maintainers basically said: "trust us, it just works".
1575	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1719	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1576	# and mismaintained ssleay-module doesn't even offer them).	1720	# and mismaintained ssleay-module doesn't even offer them).
…		…
1583	# 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
1584	# have identity issues in that area.	1728	# have identity issues in that area.
1585	# Net::SSLeay::CTX_set_mode ($ssl,	1729	# Net::SSLeay::CTX_set_mode ($ssl,
1586	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1730	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1587	# \| (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));
1588	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1732	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1589		1733
1590	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1734	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1591	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1735	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592		1736
1593	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1737	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1594		1738
1595	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1739	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1596	if $self->{on_starttls};	1740	if $self->{on_starttls};
1597		1741
1598	&_dotls; # need to trigger the initial handshake	1742	&_dotls; # need to trigger the initial handshake
…		…
1601		1745
1602	=item $handle->stoptls	1746	=item $handle->stoptls
1603		1747
1604	Shuts down the SSL connection - this makes a proper EOF handshake by	1748	Shuts down the SSL connection - this makes a proper EOF handshake by
1605	sending a close notify to the other side, but since OpenSSL doesn't	1749	sending a close notify to the other side, but since OpenSSL doesn't
1606	support non-blocking shut downs, it is not possible to re-use the stream	1750	support non-blocking shut downs, it is not guarenteed that you can re-use
1607	afterwards.	1751	the stream afterwards.
1608		1752
1609	=cut	1753	=cut
1610		1754
1611	sub stoptls {	1755	sub stoptls {
1612	my ($self) = @_;	1756	my ($self) = @_;
…		…
1625	sub _freetls {	1769	sub _freetls {
1626	my ($self) = @_;	1770	my ($self) = @_;
1627		1771
1628	return unless $self->{tls};	1772	return unless $self->{tls};
1629		1773
1630	$self->{tls_ctx}->_put_session (delete $self->{tls});	1774	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1775	if $self->{tls} > 0;
1631		1776
1632	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1777	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1633	}	1778	}
1634		1779
1635	sub DESTROY {	1780	sub DESTROY {
…		…
1662		1807
1663	=item $handle->destroy	1808	=item $handle->destroy
1664		1809
1665	Shuts down the handle object as much as possible - this call ensures that	1810	Shuts down the handle object as much as possible - this call ensures that
1666	no further callbacks will be invoked and as many resources as possible	1811	no further callbacks will be invoked and as many resources as possible
1667	will be freed. You must not call any methods on the object afterwards.	1812	will be freed. Any method you will call on the handle object after
		1813	destroying it in this way will be silently ignored (and it will return the
		1814	empty list).
1668		1815
1669	Normally, you can just "forget" any references to an AnyEvent::Handle	1816	Normally, you can just "forget" any references to an AnyEvent::Handle
1670	object and it will simply shut down. This works in fatal error and EOF	1817	object and it will simply shut down. This works in fatal error and EOF
1671	callbacks, as well as code outside. It does I<NOT> work in a read or write	1818	callbacks, as well as code outside. It does I<NOT> work in a read or write
1672	callback, so when you want to destroy the AnyEvent::Handle object from	1819	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1686	sub destroy {	1833	sub destroy {
1687	my ($self) = @_;	1834	my ($self) = @_;
1688		1835
1689	$self->DESTROY;	1836	$self->DESTROY;
1690	%$self = ();	1837	%$self = ();
		1838	bless $self, "AnyEvent::Handle::destroyed";
		1839	}
		1840
		1841	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1842	#nop
1691	}	1843	}
1692		1844
1693	=item AnyEvent::Handle::TLS_CTX	1845	=item AnyEvent::Handle::TLS_CTX
1694		1846
1695	This function creates and returns the AnyEvent::TLS object used by default	1847	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.156 by root, Wed Jul 22 05:37:32 2009 UTC vs. Revision 1.171 by root, Tue Aug 4 12:38:55 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.156 by root, Wed Jul 22 05:37:32 2009 UTC vs.
Revision 1.171 by root, Tue Aug 4 12:38:55 2009 UTC