Package io.grpc.xds.client

Class ControlPlaneClient

java.lang.Object

io.grpc.xds.client.ControlPlaneClient

final class ControlPlaneClient
extends Object

Common base type for XdsClient implementations, which encapsulates the layer abstraction of the xDS RPC stream.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	ControlPlaneClient.AdsStream
final class	ControlPlaneClient.RpcRetryTask

Field Summary

Fields

Modifier and Type	Field	Description
private ControlPlaneClient.AdsStream	adsStream
private final io.grpc.internal.BackoffPolicy.Provider	backoffPolicyProvider
private final EnvoyProtoData.Node	bootstrapNode
private final XdsLogger	logger
private final io.grpc.InternalLogId	logId
private MessagePrettyPrinter	messagePrinter
private final XdsClient.ResourceStore	resourceStore
private io.grpc.internal.BackoffPolicy	retryBackoffPolicy
private io.grpc.SynchronizationContext.ScheduledHandle	rpcRetryTimer
private final Bootstrapper.ServerInfo	serverInfo
private boolean	shutdown
private final com.google.common.base.Stopwatch	stopwatch
private final io.grpc.SynchronizationContext	syncContext
private final ScheduledExecutorService	timeService
private final Map<XdsResourceType<?>,String>	versions
private final XdsClient	xdsClient
private final XdsClient.XdsResponseHandler	xdsResponseHandler
private final XdsTransportFactory.XdsTransport	xdsTransport

Constructor Summary

Constructors

Constructor

Description

ControlPlaneClient(XdsTransportFactory.XdsTransport xdsTransport, Bootstrapper.ServerInfo serverInfo, EnvoyProtoData.Node bootstrapNode, XdsClient.XdsResponseHandler xdsResponseHandler, XdsClient.ResourceStore resourceStore, ScheduledExecutorService timeService, io.grpc.SynchronizationContext syncContext, io.grpc.internal.BackoffPolicy.Provider backoffPolicyProvider, com.google.common.base.Supplier<com.google.common.base.Stopwatch> stopwatchSupplier, XdsClient xdsClient, MessagePrettyPrinter messagePrinter)

An entity that manages ADS RPCs over a single channel.

Method Summary

Modifier and Type	Method	Description
(package private) void	ackResponse(XdsResourceType<?> type, String versionInfo, String nonce)	Accepts the update for the given resource type by updating the latest resource version and sends an ACK request to the management server.
(package private) void	adjustResourceSubscription(XdsResourceType<?> resourceType)	Updates the resource subscription for the given resource type.
(package private) XdsResourceType<?>	fromTypeUrl(String typeUrl)
(package private) boolean	isInBackoff()	Returns true if the resource discovery is currently in backoff.
(package private) boolean	isReady()
(package private) void	nackResponse(XdsResourceType<?> type, String nonce, String errorDetail)	Rejects the update for the given resource type and sends an NACK request (request with last accepted version) to the management server.
(package private) void	readyHandler()	Starts a timer for each requested resource that hasn't been responded to and has been waiting for the channel to get ready.
(package private) void	shutdown()
private void	startRpcStream()	Establishes the RPC connection by creating a new RPC stream on the given channel for xDS protocol communication.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

syncContext

private final io.grpc.SynchronizationContext syncContext

logId

private final io.grpc.InternalLogId logId

logger

private final XdsLogger logger

serverInfo

private final Bootstrapper.ServerInfo serverInfo

xdsTransport

private final XdsTransportFactory.XdsTransport xdsTransport

xdsResponseHandler

private final XdsClient.XdsResponseHandler xdsResponseHandler

resourceStore

private final XdsClient.ResourceStore resourceStore

timeService

private final ScheduledExecutorService timeService

backoffPolicyProvider

private final io.grpc.internal.BackoffPolicy.Provider backoffPolicyProvider

stopwatch

private final com.google.common.base.Stopwatch stopwatch

bootstrapNode

private final EnvoyProtoData.Node bootstrapNode

xdsClient

private final XdsClient xdsClient

versions

private final Map<XdsResourceType<?>,String> versions

shutdown

private boolean shutdown

adsStream

@Nullable
private ControlPlaneClient.AdsStream adsStream

retryBackoffPolicy

@Nullable
private io.grpc.internal.BackoffPolicy retryBackoffPolicy

rpcRetryTimer

@Nullable
private io.grpc.SynchronizationContext.ScheduledHandle rpcRetryTimer

messagePrinter

private MessagePrettyPrinter messagePrinter

Constructor Details

ControlPlaneClient

ControlPlaneClient(XdsTransportFactory.XdsTransport xdsTransport,
 Bootstrapper.ServerInfo serverInfo,
 EnvoyProtoData.Node bootstrapNode,
 XdsClient.XdsResponseHandler xdsResponseHandler,
 XdsClient.ResourceStore resourceStore,
 ScheduledExecutorService timeService,
 io.grpc.SynchronizationContext syncContext,
 io.grpc.internal.BackoffPolicy.Provider backoffPolicyProvider,
 com.google.common.base.Supplier<com.google.common.base.Stopwatch> stopwatchSupplier,
 XdsClient xdsClient,
 MessagePrettyPrinter messagePrinter)

An entity that manages ADS RPCs over a single channel.

Method Details

shutdown

void shutdown()

toString

public String toString()

Overrides:

toString in class Object

adjustResourceSubscription

void adjustResourceSubscription(XdsResourceType<?> resourceType)

Updates the resource subscription for the given resource type.

ackResponse

void ackResponse(XdsResourceType<?> type,
 String versionInfo,
 String nonce)

Accepts the update for the given resource type by updating the latest resource version and sends an ACK request to the management server.

nackResponse

void nackResponse(XdsResourceType<?> type,
 String nonce,
 String errorDetail)

Rejects the update for the given resource type and sends an NACK request (request with last accepted version) to the management server.

isInBackoff

boolean isInBackoff()

Returns true if the resource discovery is currently in backoff.

isReady

boolean isReady()

readyHandler

void readyHandler()

Starts a timer for each requested resource that hasn't been responded to and has been waiting for the channel to get ready.

startRpcStream

private void startRpcStream()

Establishes the RPC connection by creating a new RPC stream on the given channel for xDS protocol communication.

fromTypeUrl

@Nullable
XdsResourceType<?> fromTypeUrl(String typeUrl)