@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/5999") @NotThreadSafe public final class GracefulSwitchLoadBalancer extends ForwardingLoadBalancer
The balancer must switch to
a policy prior to handling resolved addresses
for the
first time.
LoadBalancer.CreateSubchannelArgs, LoadBalancer.Factory, LoadBalancer.Helper, LoadBalancer.PickResult, LoadBalancer.PickSubchannelArgs, LoadBalancer.ResolvedAddresses, LoadBalancer.Subchannel, LoadBalancer.SubchannelPicker, LoadBalancer.SubchannelStateListener
ATTR_HEALTH_CHECKING_CONFIG
Constructor and Description |
---|
GracefulSwitchLoadBalancer(LoadBalancer.Helper helper) |
Modifier and Type | Method and Description |
---|---|
protected LoadBalancer |
delegate()
Returns the underlying balancer.
|
void |
handleSubchannelState(LoadBalancer.Subchannel subchannel,
ConnectivityStateInfo stateInfo)
Deprecated.
|
void |
shutdown()
The channel asks the load-balancer to shutdown.
|
void |
switchTo(LoadBalancer.Factory newBalancerFactory)
Gracefully switch to a new policy defined by the given factory, if the given factory isn't
equal to the current one.
|
canHandleEmptyAddressListFromNameResolution, handleNameResolutionError, handleResolvedAddresses, requestConnection, toString
acceptResolvedAddresses
public GracefulSwitchLoadBalancer(LoadBalancer.Helper helper)
public void switchTo(LoadBalancer.Factory newBalancerFactory)
protected LoadBalancer delegate()
ForwardingLoadBalancer
delegate
in class ForwardingLoadBalancer
@Deprecated public void handleSubchannelState(LoadBalancer.Subchannel subchannel, ConnectivityStateInfo stateInfo)
LoadBalancer
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.
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.
handleSubchannelState
in class ForwardingLoadBalancer
subchannel
- the involved SubchannelstateInfo
- the new statepublic void shutdown()
LoadBalancer
shutdown
in class ForwardingLoadBalancer