Package io.grpc.rls
Class RlsLoadBalancer
- java.lang.Object
-
- io.grpc.LoadBalancer
-
- io.grpc.rls.RlsLoadBalancer
-
final class RlsLoadBalancer extends LoadBalancer
Implementation ofLoadBalancer
backed by route lookup service.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static interface
RlsLoadBalancer.CachingRlsLbClientBuilderProvider
ProvidesCachingRlsLbClient.Builder
with default settings.(package private) static class
RlsLoadBalancer.DefaultCachingRlsLbClientBuilderProvider
-
Nested classes/interfaces inherited from class io.grpc.LoadBalancer
LoadBalancer.CreateSubchannelArgs, LoadBalancer.ErrorPicker, LoadBalancer.Factory, LoadBalancer.FixedResultPicker, LoadBalancer.Helper, LoadBalancer.PickDetailsConsumer, LoadBalancer.PickResult, LoadBalancer.PickSubchannelArgs, LoadBalancer.ResolvedAddresses, LoadBalancer.Subchannel, LoadBalancer.SubchannelPicker, LoadBalancer.SubchannelStateListener
-
-
Field Summary
Fields Modifier and Type Field Description (package private) RlsLoadBalancer.CachingRlsLbClientBuilderProvider
cachingRlsLbClientBuilderProvider
private LoadBalancer.Helper
helper
private LbPolicyConfiguration
lbPolicyConfiguration
private ChannelLogger
logger
private CachingRlsLbClient
routeLookupClient
-
Fields inherited from class io.grpc.LoadBalancer
ATTR_HEALTH_CHECKING_CONFIG, DISABLE_SUBCHANNEL_RECONNECT_KEY, EMPTY_PICKER, HAS_HEALTH_PRODUCER_LISTENER_KEY, HEALTH_CONSUMER_LISTENER_ARG_KEY, IS_PETIOLE_POLICY
-
-
Constructor Summary
Constructors Constructor Description RlsLoadBalancer(LoadBalancer.Helper helper)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Status
acceptResolvedAddresses(LoadBalancer.ResolvedAddresses resolvedAddresses)
Accepts newly resolved addresses from the name resolution system.void
handleNameResolutionError(Status error)
Handles an error from the name resolution system.void
requestConnection()
The channel asks the LoadBalancer to establish connections now (if applicable) so that the upcoming RPC may then just pick a ready connection without waiting for connections.void
shutdown()
The channel asks the load-balancer to shutdown.-
Methods inherited from class io.grpc.LoadBalancer
canHandleEmptyAddressListFromNameResolution, handleResolvedAddresses, handleSubchannelState
-
-
-
-
Field Detail
-
logger
private final ChannelLogger logger
-
helper
private final LoadBalancer.Helper helper
-
cachingRlsLbClientBuilderProvider
RlsLoadBalancer.CachingRlsLbClientBuilderProvider cachingRlsLbClientBuilderProvider
-
lbPolicyConfiguration
@Nullable private LbPolicyConfiguration lbPolicyConfiguration
-
routeLookupClient
@Nullable private CachingRlsLbClient routeLookupClient
-
-
Constructor Detail
-
RlsLoadBalancer
RlsLoadBalancer(LoadBalancer.Helper helper)
-
-
Method Detail
-
acceptResolvedAddresses
public Status acceptResolvedAddresses(LoadBalancer.ResolvedAddresses resolvedAddresses)
Description copied from class:LoadBalancer
Accepts newly resolved addresses from the name resolution system. TheEquivalentAddressGroup
addresses should be considered equivalent but may be flattened into a single list if needed.Implementations can choose to reject the given addresses by returning
false
.Implementations should not modify the given
addresses
.- Overrides:
acceptResolvedAddresses
in classLoadBalancer
- Parameters:
resolvedAddresses
- the resolved server addresses, attributes, and config.- Returns:
true
if the resolved addresses were accepted.false
if rejected.
-
requestConnection
public void requestConnection()
Description copied from class:LoadBalancer
The channel asks the LoadBalancer to establish connections now (if applicable) so that the upcoming RPC may then just pick a ready connection without waiting for connections. This is triggered byManagedChannel.getState(true)
.If LoadBalancer doesn't override it, this is no-op. If it infeasible to create connections given the current state, e.g. no Subchannel has been created yet, LoadBalancer can ignore this request.
- Overrides:
requestConnection
in classLoadBalancer
-
handleNameResolutionError
public void handleNameResolutionError(Status error)
Description copied from class:LoadBalancer
Handles an error from the name resolution system.- Specified by:
handleNameResolutionError
in classLoadBalancer
- Parameters:
error
- a non-OK status
-
shutdown
public void shutdown()
Description copied from class:LoadBalancer
The channel asks the load-balancer to shutdown. No more methods on this class will be called after this method. The implementation should shutdown all Subchannels and OOB channels, and do any other cleanup as necessary.- Specified by:
shutdown
in classLoadBalancer
-
-