Package io.grpc.xds.client

Class LoadReportClient

java.lang.Object

io.grpc.xds.client.LoadReportClient

@Internal
public final class LoadReportClient
extends Object

Client of xDS load reporting service based on LRS protocol, which reports load stats of gRPC client's perspective to a management server.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	LoadReportClient.LoadReportingTask
private class	LoadReportClient.LrsRpcRetryTask
private final class	LoadReportClient.LrsStream

Field Summary

Fields

Modifier and Type	Field	Description
private final io.grpc.internal.BackoffPolicy.Provider	backoffPolicyProvider
final LoadStatsManager2	loadStatsManager
private final XdsLogger	logger
private final io.grpc.InternalLogId	logId
private io.grpc.internal.BackoffPolicy	lrsRpcRetryPolicy
private io.grpc.SynchronizationContext.ScheduledHandle	lrsRpcRetryTimer
private LoadReportClient.LrsStream	lrsStream
private static final io.grpc.MethodDescriptor<LoadStatsRequest,LoadStatsResponse>	method
private final EnvoyProtoData.Node	node
private final com.google.common.base.Stopwatch	retryStopwatch
private boolean	started
private final io.grpc.SynchronizationContext	syncContext
private final ScheduledExecutorService	timerService
private final XdsTransportFactory.XdsTransport	xdsTransport

Constructor Summary

Constructors

Constructor	Description
LoadReportClient(LoadStatsManager2 loadStatsManager, XdsTransportFactory.XdsTransport xdsTransport, EnvoyProtoData.Node node, io.grpc.SynchronizationContext syncContext, ScheduledExecutorService scheduledExecutorService, io.grpc.internal.BackoffPolicy.Provider backoffPolicyProvider, com.google.common.base.Supplier<com.google.common.base.Stopwatch> stopwatchSupplier)

Method Summary

Modifier and Type	Method	Description
boolean	lrsStreamIsNull()
void	startLoadReporting()	Establishes load reporting communication and negotiates with traffic director to report load stats periodically.
private void	startLrsRpc()
void	stopLoadReporting()	Terminates load reporting.

Methods inherited from class java.lang.Object

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

Field Details

logId

private final io.grpc.InternalLogId logId

logger

private final XdsLogger logger

xdsTransport

private final XdsTransportFactory.XdsTransport xdsTransport

node

private final EnvoyProtoData.Node node

syncContext

private final io.grpc.SynchronizationContext syncContext

timerService

private final ScheduledExecutorService timerService

retryStopwatch

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

backoffPolicyProvider

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

loadStatsManager

public final LoadStatsManager2 loadStatsManager

started

private boolean started

lrsRpcRetryPolicy

@Nullable
private io.grpc.internal.BackoffPolicy lrsRpcRetryPolicy

lrsRpcRetryTimer

@Nullable
private io.grpc.SynchronizationContext.ScheduledHandle lrsRpcRetryTimer

lrsStream

@Nullable
private LoadReportClient.LrsStream lrsStream

method

private static final io.grpc.MethodDescriptor<LoadStatsRequest,LoadStatsResponse> method

Constructor Details

LoadReportClient

public LoadReportClient(LoadStatsManager2 loadStatsManager,
 XdsTransportFactory.XdsTransport xdsTransport,
 EnvoyProtoData.Node node,
 io.grpc.SynchronizationContext syncContext,
 ScheduledExecutorService scheduledExecutorService,
 io.grpc.internal.BackoffPolicy.Provider backoffPolicyProvider,
 com.google.common.base.Supplier<com.google.common.base.Stopwatch> stopwatchSupplier)

Method Details

lrsStreamIsNull

public boolean lrsStreamIsNull()

startLoadReporting

public void startLoadReporting()

Establishes load reporting communication and negotiates with traffic director to report load stats periodically. Calling this method on an already started LoadReportClient is no-op.

stopLoadReporting

public void stopLoadReporting()

Terminates load reporting. Calling this method on an already stopped LoadReportClient is no-op.

startLrsRpc

private void startLrsRpc()