Package io.grpc.protobuf.services

Class HealthCheckingLoadBalancerFactory.HealthCheckState

java.lang.Object

io.grpc.protobuf.services.HealthCheckingLoadBalancerFactory.HealthCheckState

All Implemented Interfaces:

LoadBalancer.SubchannelStateListener

Enclosing class:

HealthCheckingLoadBalancerFactory

private final class HealthCheckingLoadBalancerFactory.HealthCheckState
extends java.lang.Object
implements LoadBalancer.SubchannelStateListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	HealthCheckingLoadBalancerFactory.HealthCheckState.HcStream

Field Summary

Fields

Modifier and Type	Field	Description
private HealthCheckingLoadBalancerFactory.HealthCheckState.HcStream	activeRpc
private BackoffPolicy	backoffPolicy
private ConnectivityStateInfo	concludedState
private boolean	disabled
private HealthCheckingLoadBalancerFactory.HelperImpl	helperImpl
private ConnectivityStateInfo	rawState
private java.lang.Runnable	retryTask
private SynchronizationContext.ScheduledHandle	retryTimer
private boolean	running
private java.lang.String	serviceName
private LoadBalancer.SubchannelStateListener	stateListener
private LoadBalancer.Subchannel	subchannel
private ChannelLogger	subchannelLogger
private SynchronizationContext	syncContext
private java.util.concurrent.ScheduledExecutorService	timerService

Constructor Summary

Constructors

Constructor	Description
HealthCheckState(HealthCheckingLoadBalancerFactory.HelperImpl helperImpl, SynchronizationContext syncContext, java.util.concurrent.ScheduledExecutorService timerService, LoadBalancer.SubchannelStateListener healthListener)

Method Summary

Modifier and Type	Method	Description
private void	adjustHealthCheck()
private void	gotoState(ConnectivityStateInfo newState)
(package private) void	init(LoadBalancer.SubchannelStateListener listener)
private boolean	isRetryTimerPending()
void	onSubchannelState(ConnectivityStateInfo rawState)	Handles a state change on a Subchannel.
(package private) void	setServiceName(java.lang.String newServiceName)
(package private) void	setSubchannel(LoadBalancer.Subchannel subchannel)
private void	startRpc()
private void	stopRpc(java.lang.String msg)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

retryTask

private final java.lang.Runnable retryTask

syncContext

private final SynchronizationContext syncContext

timerService

private final java.util.concurrent.ScheduledExecutorService timerService

helperImpl

private final HealthCheckingLoadBalancerFactory.HelperImpl helperImpl

subchannel

private LoadBalancer.Subchannel subchannel

subchannelLogger

private ChannelLogger subchannelLogger

stateListener

private LoadBalancer.SubchannelStateListener stateListener

activeRpc

@Nullable
private HealthCheckingLoadBalancerFactory.HealthCheckState.HcStream activeRpc

serviceName

private java.lang.String serviceName

backoffPolicy

private BackoffPolicy backoffPolicy

rawState

private ConnectivityStateInfo rawState

concludedState

private ConnectivityStateInfo concludedState

running

private boolean running

disabled

private boolean disabled

retryTimer

private SynchronizationContext.ScheduledHandle retryTimer

Constructor Detail

HealthCheckState

HealthCheckState(HealthCheckingLoadBalancerFactory.HelperImpl helperImpl,
                 SynchronizationContext syncContext,
                 java.util.concurrent.ScheduledExecutorService timerService,
                 @Nullable
                 LoadBalancer.SubchannelStateListener healthListener)

Method Detail

setSubchannel

void setSubchannel(LoadBalancer.Subchannel subchannel)

init

void init(LoadBalancer.SubchannelStateListener listener)

setServiceName

void setServiceName(@Nullable
                    java.lang.String newServiceName)

onSubchannelState

public void onSubchannelState(ConnectivityStateInfo rawState)

Description copied from interface: LoadBalancer.SubchannelStateListener

Handles a state change on a Subchannel.

The initial state of a Subchannel is IDLE. You won't get a notification for the initial IDLE state.

If the new state is not SHUTDOWN, this method should create a new picker and call Helper.updateBalancingState(). Failing to do so may result in unnecessary delays of RPCs. Please refer to PickResult.withSubchannel()'s javadoc for more information.

When a subchannel's state is IDLE or TRANSIENT_FAILURE and the address for the subchannel was received in LoadBalancer.handleResolvedAddresses(io.grpc.LoadBalancer.ResolvedAddresses), load balancers should call LoadBalancer.Helper.refreshNameResolution() to inform polling name resolvers that it is an appropriate time to refresh the addresses. Without the refresh, changes to the addresses may never be detected.

SHUTDOWN can only happen in two cases. One is that LoadBalancer called LoadBalancer.Subchannel.shutdown() earlier, thus it should have already discarded this Subchannel. The other is that Channel is doing a forced shutdown or has already terminated, thus there won't be further requests to LoadBalancer. Therefore, the LoadBalancer usually don't need to react to a SHUTDOWN state.

Specified by:

onSubchannelState in interface LoadBalancer.SubchannelStateListener

Parameters:

rawState - the new state

isRetryTimerPending

private boolean isRetryTimerPending()

adjustHealthCheck

private void adjustHealthCheck()

startRpc

private void startRpc()

stopRpc

private void stopRpc(java.lang.String msg)

gotoState

private void gotoState(ConnectivityStateInfo newState)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object