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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC vs.
Revision 1.160 by root, Fri Jul 24 22:47:04 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.82;	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;
26	my $cv = AnyEvent->condvar;	23	my $cv = AnyEvent->condvar;
27		24
28	my $hdl; $hdl = new AnyEvent::Handle	25	my $hdl; $hdl = new AnyEvent::Handle
29	fh => \*STDIN,	26	fh => \*STDIN,
30	on_error => sub {	27	on_error => sub {
		28	my ($hdl, $fatal, $msg) = @_;
31	warn "got error $_[2]\n";	29	warn "got error $msg\n";
		30	$hdl->destroy;
32	$cv->send;	31	$cv->send;
33	);	32	);
34		33
35	# send some request line	34	# send some request line
36	$hdl->push_write ("getinfo\015\012");	35	$hdl->push_write ("getinfo\015\012");
…		…
45	$cv->recv;	44	$cv->recv;
46		45
47	=head1 DESCRIPTION	46	=head1 DESCRIPTION
48		47
49	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
50	filehandles. For utility functions for doing non-blocking connects and accepts	49	filehandles.
51	on sockets see L<AnyEvent::Util>.
52		50
53	The L<AnyEvent::Intro> tutorial contains some well-documented	51	The L<AnyEvent::Intro> tutorial contains some well-documented
54	AnyEvent::Handle examples.	52	AnyEvent::Handle examples.
55		53
56	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
57	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
58	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
59		57
		58	At the very minimum, you should specify C<fh> or C<connect>, and the
		59	C<on_error> callback.
		60
60	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
61	argument.	62	argument.
62		63
63	=head1 METHODS	64	=head1 METHODS
64		65
…		…
68		69
69	The constructor supports these arguments (all as C<< key => value >> pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
70		71
71	=over 4	72	=over 4
72		73
73	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
74		75
75	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
76
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
		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	=item on_connect => $cb->($handle, $host, $port, $retry->())
		107
		108	This callback is called when a connection has been successfully established.
		109
		110	The actual numeric host and port (the socket peername) are passed as
		111	parameters, together with a retry callback.
		112
		113	When, for some reason, the handle is not acceptable, then calling
		114	C<$retry> will continue with the next conenction target (in case of
		115	multi-homed hosts or SRV records there can be multiple connection
		116	endpoints). When it is called then the read and write queues, eof status,
		117	tls status and similar properties of the handle are being reset.
		118
		119	In most cases, ignoring the C<$retry> parameter is the way to go.
		120
		121	=item on_connect_error => $cb->($handle, $message)
		122
		123	This callback is called when the conenction could not be
		124	established. C<$!> will contain the relevant error code, and C<$message> a
		125	message describing it (usually the same as C<"$!">).
		126
		127	If this callback isn't specified, then C<on_error> will be called with a
		128	fatal error instead.
		129
		130	=back
		131
		132	=item on_error => $cb->($handle, $fatal, $message)
		133
		134	This is the error callback, which is called when, well, some error
		135	occured, such as not being able to resolve the hostname, failure to
		136	connect or a read error.
		137
		138	Some errors are fatal (which is indicated by C<$fatal> being true). On
		139	fatal errors the handle object will be destroyed (by a call to C<< ->
		140	destroy >>) after invoking the error callback (which means you are free to
		141	examine the handle object). Examples of fatal errors are an EOF condition
		142	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		143	cases where the other side can close the connection at their will it is
		144	often easiest to not report C<EPIPE> errors in this callback.
		145
		146	AnyEvent::Handle tries to find an appropriate error code for you to check
		147	against, but in some cases (TLS errors), this does not work well. It is
		148	recommended to always output the C<$message> argument in human-readable
		149	error messages (it's usually the same as C<"$!">).
		150
		151	Non-fatal errors can be retried by simply returning, but it is recommended
		152	to simply ignore this parameter and instead abondon the handle object
		153	when this callback is invoked. Examples of non-fatal errors are timeouts
		154	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		155
		156	On callback entrance, the value of C<$!> contains the operating system
		157	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		158	C<EPROTO>).
		159
		160	While not mandatory, it is I<highly> recommended to set this callback, as
		161	you will not be notified of errors otherwise. The default simply calls
		162	C<croak>.
		163
		164	=item on_read => $cb->($handle)
		165
		166	This sets the default read callback, which is called when data arrives
		167	and no read request is in the queue (unlike read queue callbacks, this
		168	callback will only be called when at least one octet of data is in the
		169	read buffer).
		170
		171	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		172	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		173	must not enlarge or modify the read buffer, you can only remove data at
		174	the beginning from it.
		175
		176	When an EOF condition is detected then AnyEvent::Handle will first try to
		177	feed all the remaining data to the queued callbacks and C<on_read> before
		178	calling the C<on_eof> callback. If no progress can be made, then a fatal
		179	error will be raised (with C<$!> set to C<EPIPE>).
		180
		181	Note that, unlike requests in the read queue, an C<on_read> callback
		182	doesn't mean you I<require> some data: if there is an EOF and there
		183	are outstanding read requests then an error will be flagged. With an
		184	C<on_read> callback, the C<on_eof> callback will be invoked.
80		185
81	=item on_eof => $cb->($handle)	186	=item on_eof => $cb->($handle)
82		187
83	Set the callback to be called when an end-of-file condition is detected,	188	Set the callback to be called when an end-of-file condition is detected,
84	i.e. in the case of a socket, when the other side has closed the	189	i.e. in the case of a socket, when the other side has closed the
…		…
91	callback and continue writing data, as only the read part has been shut	196	callback and continue writing data, as only the read part has been shut
92	down.	197	down.
93		198
94	If an EOF condition has been detected but no C<on_eof> callback has been	199	If an EOF condition has been detected but no C<on_eof> callback has been
95	set, then a fatal error will be raised with C<$!> set to <0>.	200	set, then a fatal error will be raised with C<$!> set to <0>.
96
97	=item on_error => $cb->($handle, $fatal, $message)
98
99	This is the error callback, which is called when, well, some error
100	occured, such as not being able to resolve the hostname, failure to
101	connect or a read error.
102
103	Some errors are fatal (which is indicated by C<$fatal> being true). On
104	fatal errors the handle object will be destroyed (by a call to C<< ->
105	destroy >>) after invoking the error callback (which means you are free to
106	examine the handle object). Examples of fatal errors are an EOF condition
107	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
108
109	AnyEvent::Handle tries to find an appropriate error code for you to check
110	against, but in some cases (TLS errors), this does not work well. It is
111	recommended to always output the C<$message> argument in human-readable
112	error messages (it's usually the same as C<"$!">).
113
114	Non-fatal errors can be retried by simply returning, but it is recommended
115	to simply ignore this parameter and instead abondon the handle object
116	when this callback is invoked. Examples of non-fatal errors are timeouts
117	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
118
119	On callback entrance, the value of C<$!> contains the operating system
120	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
121	C<EPROTO>).
122
123	While not mandatory, it is I<highly> recommended to set this callback, as
124	you will not be notified of errors otherwise. The default simply calls
125	C<croak>.
126
127	=item on_read => $cb->($handle)
128
129	This sets the default read callback, which is called when data arrives
130	and no read request is in the queue (unlike read queue callbacks, this
131	callback will only be called when at least one octet of data is in the
132	read buffer).
133
134	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
135	method or access the C<< $handle->{rbuf} >> member directly. Note that you
136	must not enlarge or modify the read buffer, you can only remove data at
137	the beginning from it.
138
139	When an EOF condition is detected then AnyEvent::Handle will first try to
140	feed all the remaining data to the queued callbacks and C<on_read> before
141	calling the C<on_eof> callback. If no progress can be made, then a fatal
142	error will be raised (with C<$!> set to C<EPIPE>).
143
144	Note that, unlike requests in the read queue, an C<on_read> callback
145	doesn't mean you I<require> some data: if there is an EOF and there
146	are outstanding read requests then an error will be flagged. With an
147	C<on_read> callback, the C<on_eof> callback will be invoked.
148		201
149	=item on_drain => $cb->($handle)	202	=item on_drain => $cb->($handle)
150		203
151	This sets the callback that is called when the write buffer becomes empty	204	This sets the callback that is called when the write buffer becomes empty
152	(or when the callback is set and the buffer is empty already).	205	(or when the callback is set and the buffer is empty already).
…		…
351		404
352	sub new {	405	sub new {
353	my $class = shift;	406	my $class = shift;
354	my $self = bless { @_ }, $class;	407	my $self = bless { @_ }, $class;
355		408
356	$self->{fh} or Carp::croak "mandatory argument fh is missing";	409	if ($self->{fh}) {
		410	$self->_start;
		411	return unless $self->{fh}; # could be gone by now
		412
		413	} elsif ($self->{connect}) {
		414	require AnyEvent::Socket;
		415
		416	$self->{peername} = $self->{connect}[0]
		417	unless exists $self->{peername};
		418
		419	$self->{_skip_drain_rbuf} = 1;
		420
		421	{
		422	Scalar::Util::weaken (my $self = $self);
		423
		424	$self->{_connect} =
		425	AnyEvent::Socket::tcp_connect (
		426	$self->{connect}[0],
		427	$self->{connect}[1],
		428	sub {
		429	my ($fh, $host, $port, $retry) = @_;
		430
		431	if ($fh) {
		432	$self->{fh} = $fh;
		433
		434	delete $self->{_skip_drain_rbuf};
		435	$self->_start;
		436
		437	$self->{on_connect}
		438	and $self->{on_connect}($self, $host, $port, sub {
		439	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		440	$self->{_skip_drain_rbuf} = 1;
		441	&$retry;
		442	});
		443
		444	} else {
		445	if ($self->{on_connect_error}) {
		446	$self->{on_connect_error}($self, "$!");
		447	$self->destroy;
		448	} else {
		449	$self->fatal ($!, 1);
		450	}
		451	}
		452	},
		453	sub {
		454	local $self->{fh} = $_[0];
		455
		456	$self->{on_prepare}->($self)
		457	if $self->{on_prepare};
		458	}
		459	);
		460	}
		461
		462	} else {
		463	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		464	}
		465
		466	$self
		467	}
		468
		469	sub _start {
		470	my ($self) = @_;
357		471
358	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	472	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
359		473
360	$self->{_activity} = AnyEvent->now;	474	$self->{_activity} = AnyEvent->now;
361	$self->_timeout;	475	$self->_timeout;
…		…
366	if $self->{tls};	480	if $self->{tls};
367		481
368	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	482	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
369		483
370	$self->start_read	484	$self->start_read
371	if $self->{on_read};	485	if $self->{on_read} \|\| @{ $self->{_queue} };
372		486
373	$self->{fh} && $self	487	$self->_drain_wbuf;
374	}	488	}
375		489
376	#sub _shutdown {	490	#sub _shutdown {
377	# my ($self) = @_;	491	# my ($self) = @_;
378	#	492	#
…		…
388	$! = $errno;	502	$! = $errno;
389	$message \|\|= "$!";	503	$message \|\|= "$!";
390		504
391	if ($self->{on_error}) {	505	if ($self->{on_error}) {
392	$self->{on_error}($self, $fatal, $message);	506	$self->{on_error}($self, $fatal, $message);
393	$self->destroy;	507	$self->destroy if $fatal;
394	} elsif ($self->{fh}) {	508	} elsif ($self->{fh}) {
395	$self->destroy;	509	$self->destroy;
396	Carp::croak "AnyEvent::Handle uncaught error: $message";	510	Carp::croak "AnyEvent::Handle uncaught error: $message";
397	}	511	}
398	}	512	}
…		…
458	sub no_delay {	572	sub no_delay {
459	$_[0]{no_delay} = $_[1];	573	$_[0]{no_delay} = $_[1];
460		574
461	eval {	575	eval {
462	local $SIG{__DIE__};	576	local $SIG{__DIE__};
463	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	577	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		578	if $_[0]{fh};
464	};	579	};
465	}	580	}
466		581
467	=item $handle->on_starttls ($cb)	582	=item $handle->on_starttls ($cb)
468		583
…		…
502	# reset the timeout watcher, as neccessary	617	# reset the timeout watcher, as neccessary
503	# also check for time-outs	618	# also check for time-outs
504	sub _timeout {	619	sub _timeout {
505	my ($self) = @_;	620	my ($self) = @_;
506		621
507	if ($self->{timeout}) {	622	if ($self->{timeout} && $self->{fh}) {
508	my $NOW = AnyEvent->now;	623	my $NOW = AnyEvent->now;
509		624
510	# when would the timeout trigger?	625	# when would the timeout trigger?
511	my $after = $self->{_activity} + $self->{timeout} - $NOW;	626	my $after = $self->{_activity} + $self->{timeout} - $NOW;
512		627
…		…
630	->($self, @_);	745	->($self, @_);
631	}	746	}
632		747
633	if ($self->{tls}) {	748	if ($self->{tls}) {
634	$self->{_tls_wbuf} .= $_[0];	749	$self->{_tls_wbuf} .= $_[0];
635		750	&_dotls ($self) if $self->{fh};
636	&_dotls ($self);
637	} else {	751	} else {
638	$self->{wbuf} .= $_[0];	752	$self->{wbuf} .= $_[0];
639	$self->_drain_wbuf;	753	$self->_drain_wbuf if $self->{fh};
640	}	754	}
641	}	755	}
642		756
643	=item $handle->push_write (type => @args)	757	=item $handle->push_write (type => @args)
644		758
…		…
861	=cut	975	=cut
862		976
863	sub _drain_rbuf {	977	sub _drain_rbuf {
864	my ($self) = @_;	978	my ($self) = @_;
865		979
		980	# avoid recursion
		981	return if exists $self->{_skip_drain_rbuf};
866	local $self->{_in_drain} = 1;	982	local $self->{_skip_drain_rbuf} = 1;
867		983
868	if (	984	if (
869	defined $self->{rbuf_max}	985	defined $self->{rbuf_max}
870	&& $self->{rbuf_max} < length $self->{rbuf}	986	&& $self->{rbuf_max} < length $self->{rbuf}
871	) {	987	) {
…		…
938		1054
939	sub on_read {	1055	sub on_read {
940	my ($self, $cb) = @_;	1056	my ($self, $cb) = @_;
941		1057
942	$self->{on_read} = $cb;	1058	$self->{on_read} = $cb;
943	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1059	$self->_drain_rbuf if $cb;
944	}	1060	}
945		1061
946	=item $handle->rbuf	1062	=item $handle->rbuf
947		1063
948	Returns the read buffer (as a modifiable lvalue).	1064	Returns the read buffer (as a modifiable lvalue).
…		…
1000	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1116	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
1001	->($self, $cb, @_);	1117	->($self, $cb, @_);
1002	}	1118	}
1003		1119
1004	push @{ $self->{_queue} }, $cb;	1120	push @{ $self->{_queue} }, $cb;
1005	$self->_drain_rbuf unless $self->{_in_drain};	1121	$self->_drain_rbuf;
1006	}	1122	}
1007		1123
1008	sub unshift_read {	1124	sub unshift_read {
1009	my $self = shift;	1125	my $self = shift;
1010	my $cb = pop;	1126	my $cb = pop;
…		…
1016	->($self, $cb, @_);	1132	->($self, $cb, @_);
1017	}	1133	}
1018		1134
1019		1135
1020	unshift @{ $self->{_queue} }, $cb;	1136	unshift @{ $self->{_queue} }, $cb;
1021	$self->_drain_rbuf unless $self->{_in_drain};	1137	$self->_drain_rbuf;
1022	}	1138	}
1023		1139
1024	=item $handle->push_read (type => @args, $cb)	1140	=item $handle->push_read (type => @args, $cb)
1025		1141
1026	=item $handle->unshift_read (type => @args, $cb)	1142	=item $handle->unshift_read (type => @args, $cb)
…		…
1419	if ($self->{tls}) {	1535	if ($self->{tls}) {
1420	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1536	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1421		1537
1422	&_dotls ($self);	1538	&_dotls ($self);
1423	} else {	1539	} else {
1424	$self->_drain_rbuf unless $self->{_in_drain};	1540	$self->_drain_rbuf;
1425	}	1541	}
1426		1542
1427	} elsif (defined $len) {	1543	} elsif (defined $len) {
1428	delete $self->{_rw};	1544	delete $self->{_rw};
1429	$self->{_eof} = 1;	1545	$self->{_eof} = 1;
1430	$self->_drain_rbuf unless $self->{_in_drain};	1546	$self->_drain_rbuf;
1431		1547
1432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1548	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1433	return $self->_error ($!, 1);	1549	return $self->_error ($!, 1);
1434	}	1550	}
1435	});	1551	});
…		…
1495	$self->{_eof} = 1;	1611	$self->{_eof} = 1;
1496	}	1612	}
1497	}	1613	}
1498		1614
1499	$self->{_tls_rbuf} .= $tmp;	1615	$self->{_tls_rbuf} .= $tmp;
1500	$self->_drain_rbuf unless $self->{_in_drain};	1616	$self->_drain_rbuf;
1501	$self->{tls} or return; # tls session might have gone away in callback	1617	$self->{tls} or return; # tls session might have gone away in callback
1502	}	1618	}
1503		1619
1504	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1620	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1505	return $self->_tls_error ($tmp)	1621	return $self->_tls_error ($tmp)
…		…
1520		1636
1521	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1637	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1522	object is created, you can also do that at a later time by calling	1638	object is created, you can also do that at a later time by calling
1523	C<starttls>.	1639	C<starttls>.
1524		1640
		1641	Starting TLS is currently an asynchronous operation - when you push some
		1642	write data and then call C<< ->starttls >> then TLS negotiation will start
		1643	immediately, after which the queued write data is then sent.
		1644
1525	The first argument is the same as the C<tls> constructor argument (either	1645	The first argument is the same as the C<tls> constructor argument (either
1526	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1646	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1527		1647
1528	The second argument is the optional C<AnyEvent::TLS> object that is used	1648	The second argument is the optional C<AnyEvent::TLS> object that is used
1529	when AnyEvent::Handle has to create its own TLS connection object, or	1649	when AnyEvent::Handle has to create its own TLS connection object, or
…		…
1533	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1653	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1534	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1654	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1535	changed to your liking. Note that the handshake might have already started	1655	changed to your liking. Note that the handshake might have already started
1536	when this function returns.	1656	when this function returns.
1537		1657
1538	If it an error to start a TLS handshake more than once per	1658	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1539	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1659	handshakes on the same stream. Best do not attempt to use the stream after
		1660	stopping TLS.
1540		1661
1541	=cut	1662	=cut
1542		1663
1543	our %TLS_CACHE; #TODO not yet documented, should we?	1664	our %TLS_CACHE; #TODO not yet documented, should we?
1544		1665
1545	sub starttls {	1666	sub starttls {
1546	my ($self, $ssl, $ctx) = @_;	1667	my ($self, $tls, $ctx) = @_;
		1668
		1669	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1670	if $self->{tls};
		1671
		1672	$self->{tls} = $tls;
		1673	$self->{tls_ctx} = $ctx if @_ > 2;
		1674
		1675	return unless $self->{fh};
1547		1676
1548	require Net::SSLeay;	1677	require Net::SSLeay;
1549
1550	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1551	if $self->{tls};
1552		1678
1553	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1679	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1554	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1680	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1555		1681
		1682	$tls = $self->{tls};
1556	$ctx \|\|= $self->{tls_ctx};	1683	$ctx = $self->{tls_ctx};
		1684
		1685	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1557		1686
1558	if ("HASH" eq ref $ctx) {	1687	if ("HASH" eq ref $ctx) {
1559	require AnyEvent::TLS;	1688	require AnyEvent::TLS;
1560
1561	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1562		1689
1563	if ($ctx->{cache}) {	1690	if ($ctx->{cache}) {
1564	my $key = $ctx+0;	1691	my $key = $ctx+0;
1565	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1692	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1566	} else {	1693	} else {
1567	$ctx = new AnyEvent::TLS %$ctx;	1694	$ctx = new AnyEvent::TLS %$ctx;
1568	}	1695	}
1569	}	1696	}
1570		1697
1571	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1698	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1572	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1699	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1573		1700
1574	# basically, this is deep magic (because SSL_read should have the same issues)	1701	# basically, this is deep magic (because SSL_read should have the same issues)
1575	# but the openssl maintainers basically said: "trust us, it just works".	1702	# but the openssl maintainers basically said: "trust us, it just works".
1576	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1703	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1577	# and mismaintained ssleay-module doesn't even offer them).	1704	# and mismaintained ssleay-module doesn't even offer them).
…		…
1584	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1711	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1585	# have identity issues in that area.	1712	# have identity issues in that area.
1586	# Net::SSLeay::CTX_set_mode ($ssl,	1713	# Net::SSLeay::CTX_set_mode ($ssl,
1587	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1714	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1588	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1715	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1589	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1716	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1590		1717
1591	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1718	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1719	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1593		1720
1594	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1721	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1595		1722
1596	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1723	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1597	if $self->{on_starttls};	1724	if $self->{on_starttls};
1598		1725
1599	&_dotls; # need to trigger the initial handshake	1726	&_dotls; # need to trigger the initial handshake
…		…
1602		1729
1603	=item $handle->stoptls	1730	=item $handle->stoptls
1604		1731
1605	Shuts down the SSL connection - this makes a proper EOF handshake by	1732	Shuts down the SSL connection - this makes a proper EOF handshake by
1606	sending a close notify to the other side, but since OpenSSL doesn't	1733	sending a close notify to the other side, but since OpenSSL doesn't
1607	support non-blocking shut downs, it is not possible to re-use the stream	1734	support non-blocking shut downs, it is not guarenteed that you can re-use
1608	afterwards.	1735	the stream afterwards.
1609		1736
1610	=cut	1737	=cut
1611		1738
1612	sub stoptls {	1739	sub stoptls {
1613	my ($self) = @_;	1740	my ($self) = @_;
…		…
1626	sub _freetls {	1753	sub _freetls {
1627	my ($self) = @_;	1754	my ($self) = @_;
1628		1755
1629	return unless $self->{tls};	1756	return unless $self->{tls};
1630		1757
1631	$self->{tls_ctx}->_put_session (delete $self->{tls});	1758	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1759	if ref $self->{tls};
1632		1760
1633	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1761	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1634	}	1762	}
1635		1763
1636	sub DESTROY {	1764	sub DESTROY {
…		…
1638		1766
1639	&_freetls;	1767	&_freetls;
1640		1768
1641	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1769	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1642		1770
1643	if ($linger && length $self->{wbuf}) {	1771	if ($linger && length $self->{wbuf} && $self->{fh}) {
1644	my $fh = delete $self->{fh};	1772	my $fh = delete $self->{fh};
1645	my $wbuf = delete $self->{wbuf};	1773	my $wbuf = delete $self->{wbuf};
1646		1774
1647	my @linger;	1775	my @linger;
1648		1776

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC vs. Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC vs.
Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC