io.grpc.util

Class RoundRobinLoadBalancer

java.lang.Object

io.grpc.LoadBalancer

io.grpc.util.RoundRobinLoadBalancer

@Internal
public class RoundRobinLoadBalancer
extends LoadBalancer

A LoadBalancer that provides round-robin load-balancing over the EquivalentAddressGroups from the NameResolver.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RoundRobinLoadBalancer.RoundRobinPicker

Nested classes/interfaces inherited from class io.grpc.LoadBalancer

LoadBalancer.CreateSubchannelArgs, LoadBalancer.Factory, LoadBalancer.Helper, LoadBalancer.PickResult, LoadBalancer.PickSubchannelArgs, LoadBalancer.ResolvedAddresses, LoadBalancer.Subchannel, LoadBalancer.SubchannelPicker, LoadBalancer.SubchannelStateListener

Field Summary

Fields

Modifier and Type	Field and Description
protected RoundRobinLoadBalancer.RoundRobinPicker	currentPicker

Fields inherited from class io.grpc.LoadBalancer

ATTR_HEALTH_CHECKING_CONFIG

Constructor Summary

Constructors

Constructor and Description
RoundRobinLoadBalancer(LoadBalancer.Helper helper)

Method Summary

Modifier and Type	Method and Description
boolean	acceptResolvedAddresses(LoadBalancer.ResolvedAddresses resolvedAddresses) Accepts newly resolved addresses from the name resolution system.
protected RoundRobinLoadBalancer.RoundRobinPicker	createReadyPicker(List<LoadBalancer.Subchannel> activeList)
protected Collection<LoadBalancer.Subchannel>	getSubchannels()
void	handleNameResolutionError(Status error) Handles an error from the name resolution system.
void	shutdown() The channel asks the load-balancer to shutdown.

Methods inherited from class io.grpc.LoadBalancer

canHandleEmptyAddressListFromNameResolution, handleResolvedAddresses, handleSubchannelState, requestConnection

Methods inherited from class java.lang.Object

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

Field Detail

currentPicker

protected RoundRobinLoadBalancer.RoundRobinPicker currentPicker

Constructor Detail

RoundRobinLoadBalancer

public RoundRobinLoadBalancer(LoadBalancer.Helper helper)

Method Detail

acceptResolvedAddresses

public boolean acceptResolvedAddresses(LoadBalancer.ResolvedAddresses resolvedAddresses)

Description copied from class: LoadBalancer

Accepts newly resolved addresses from the name resolution system. The EquivalentAddressGroup 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 class LoadBalancer

Parameters:

resolvedAddresses - the resolved server addresses, attributes, and config.

Returns:

true if the resolved addresses were accepted. false if rejected.

handleNameResolutionError

public void handleNameResolutionError(Status error)

Description copied from class: LoadBalancer

Handles an error from the name resolution system.

Specified by:

handleNameResolutionError in class LoadBalancer

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 class LoadBalancer

createReadyPicker

protected RoundRobinLoadBalancer.RoundRobinPicker createReadyPicker(List<LoadBalancer.Subchannel> activeList)

getSubchannels

protected Collection<LoadBalancer.Subchannel> getSubchannels()