io.grpc

Class LoadBalancerProvider

java.lang.Object

io.grpc.LoadBalancer.Factory

io.grpc.LoadBalancerProvider

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1771")
public abstract class LoadBalancerProvider
extends LoadBalancer.Factory

Provider of LoadBalancers. Each provider is bounded to a load-balancing policy name.

Since:

1.17.0

Constructor Summary

Constructors

Constructor and Description
LoadBalancerProvider()

Method Summary

Modifier and Type	Method and Description
abstract String	getPolicyName() Returns the load-balancing policy name associated with this provider, which makes it selectable via LoadBalancerRegistry.getProvider(java.lang.String).
abstract int	getPriority() A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration.
abstract boolean	isAvailable() Whether this provider is available for use, taking the current environment into consideration.
String	toString()

Methods inherited from class io.grpc.LoadBalancer.Factory

newLoadBalancer

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadBalancerProvider

public LoadBalancerProvider()

Method Detail

isAvailable

public abstract boolean isAvailable()

Whether this provider is available for use, taking the current environment into consideration. If false, LoadBalancer.Factory.newLoadBalancer(io.grpc.LoadBalancer.Helper) is not safe to be called.

getPriority

public abstract int getPriority()

A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration. 5 should be considered the default, and then tweaked based on environment detection. A priority of 0 does not imply that the provider wouldn't work; just that it should be last in line.

getPolicyName

public abstract String getPolicyName()

Returns the load-balancing policy name associated with this provider, which makes it selectable via LoadBalancerRegistry.getProvider(java.lang.String). This is called only when the class is loaded. It shouldn't change, and there is no point doing so.

The policy name should consist of only lower case letters letters, underscore and digits, and can only start with letters.

toString

public final String toString()

Overrides:

toString in class Object