Modifier and Type	Class and Description
private static class	ManagedChannelRegistry.ManagedChannelPriorityAccessor
public static class	ManagedChannelRegistry.ProviderNotFoundException Thrown when no suitable `ManagedChannelProvider` objects can be found.

Field Summary

Modifier and Type	Field and Description
private final LinkedHashSet<ManagedChannelProvider>	allProviders
private List<ManagedChannelProvider>	effectiveProviders Immutable, sorted version of `allProviders`.
private static ManagedChannelRegistry	instance
private static final Logger	logger

Access	Constructor and Description
public	ManagedChannelRegistry()

Method Summary

Modifier and Type	Method and Description
private synchronized void	addProvider(ManagedChannelProvider provider)
public synchronized void	deregister(ManagedChannelProvider the provider that was added to the register via `register`. provider) Deregisters a provider.
public static synchronized ManagedChannelRegistry	getDefaultRegistry() Returns the default registry that loads providers via the Java service loader mechanism.
pack-priv static List<Class<?>>	getHardCodedClasses()
pack-priv ManagedChannelBuilder<?>	newChannelBuilder(String target, ChannelCredentials creds)
pack-priv ManagedChannelBuilder<?>	newChannelBuilder(NameResolverRegistry nameResolverRegistry, String target, ChannelCredentials creds)
pack-priv ManagedChannelProvider	provider()
pack-priv synchronized List<ManagedChannelProvider>	providers() Returns effective providers, in priority order.
private synchronized void	refreshProviders()
public synchronized void	register(ManagedChannelProvider provider) Register a provider.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allProviders	back to summary
private final LinkedHashSet<ManagedChannelProvider> allProviders Annotations @GuardedBy:this

effectiveProviders	back to summary
private List<ManagedChannelProvider> effectiveProviders Immutable, sorted version of `allProviders`. Is replaced instead of mutating. Annotations @GuardedBy:this

instance	back to summary
private static ManagedChannelRegistry instance

logger	back to summary
private static final Logger logger

ManagedChannelRegistry	back to summary
public ManagedChannelRegistry()

Method Detail

addProvider	back to summary
private synchronized void addProvider(ManagedChannelProvider provider)

deregister back to summary

deregister	back to summary
public synchronized void deregister(ManagedChannelProvider provider) Deregisters a provider. No-op if the provider is not in the registry. Parameters provider:ManagedChannelProvider the provider that was added to the register via `register`.

public synchronized void deregister(ManagedChannelProvider provider)

Deregisters a provider. No-op if the provider is not in the registry.

Parameters

provider:ManagedChannelProvider: the provider that was added to the register via register.

getDefaultRegistry	back to summary
public static synchronized ManagedChannelRegistry getDefaultRegistry() Returns the default registry that loads providers via the Java service loader mechanism.

getHardCodedClasses	back to summary
pack-priv static List<Class<?>> getHardCodedClasses() Annotations @VisibleForTesting

newChannelBuilder	back to summary
pack-priv ManagedChannelBuilder<?> newChannelBuilder(String target, ChannelCredentials creds)

newChannelBuilder	back to summary
pack-priv ManagedChannelBuilder<?> newChannelBuilder(NameResolverRegistry nameResolverRegistry, String target, ChannelCredentials creds) Annotations @VisibleForTesting

provider	back to summary
pack-priv ManagedChannelProvider provider()

providers	back to summary
pack-priv synchronized List<ManagedChannelProvider> providers() Returns effective providers, in priority order. Annotations @VisibleForTesting

providers

back to summary

pack-priv synchronized List<ManagedChannelProvider> providers()

Returns effective providers, in priority order.

Annotations

@VisibleForTesting

refreshProviders	back to summary
private synchronized void refreshProviders()

register	back to summary
public synchronized void register(ManagedChannelProvider provider) Register a provider. If the provider's `isAvailable()` returns `false`, this method will throw `IllegalArgumentException`. Providers will be used in priority order. In case of ties, providers are used in registration order.

public synchronized void register(ManagedChannelProvider provider)

If the provider's isAvailable() returns false, this method will throw IllegalArgumentException.

Providers will be used in priority order. In case of ties, providers are used in registration order.

io.grpc back to summary

private final Class ManagedChannelRegistry.ManagedChannelPriorityAccessor

Class Inheritance

extends Object
implements ServiceProviders.PriorityAccessor<ManagedChannelProvider>

java.lang.Object
io.grpc.ManagedChannelRegistry.ManagedChannelPriorityAccessor

All Implemented Interfaces

io.grpc.ServiceProviders.PriorityAccessor

Constructor Summary

Access	Constructor and Description
private	ManagedChannelPriorityAccessor()

Method Summary

Modifier and Type	Method and Description
public int	getPriority(ManagedChannelProvider provider) Implements io.grpc.ServiceProviders.PriorityAccessor.getPriority. A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration.
public boolean	isAvailable(ManagedChannelProvider provider) Implements io.grpc.ServiceProviders.PriorityAccessor.isAvailable. Checks this provider is available for use, taking the current environment into consideration.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

ManagedChannelPriorityAccessor	back to summary
private ManagedChannelPriorityAccessor()

Method Detail

getPriority	back to summary
public int getPriority(ManagedChannelProvider provider) Implements io.grpc.ServiceProviders.PriorityAccessor.getPriority. Doc from io.grpc.ServiceProviders.PriorityAccessor.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. Annotations @Override

getPriority

back to summary

public int getPriority(ManagedChannelProvider provider)

Implements io.grpc.ServiceProviders.PriorityAccessor.getPriority.

Doc from io.grpc.ServiceProviders.PriorityAccessor.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.

Annotations

@Override

isAvailable back to summary

isAvailable	back to summary
public boolean isAvailable(ManagedChannelProvider provider) Implements io.grpc.ServiceProviders.PriorityAccessor.isAvailable. Doc from io.grpc.ServiceProviders.PriorityAccessor.isAvailable. Checks this provider is available for use, taking the current environment into consideration. If `false`, no other methods are safe to be called. Annotations @Override

public boolean isAvailable(ManagedChannelProvider provider)

Implements io.grpc.ServiceProviders.PriorityAccessor.isAvailable.

Doc from io.grpc.ServiceProviders.PriorityAccessor.isAvailable.

Checks this provider is available for use, taking the current environment into consideration. If false, no other methods are safe to be called.

Annotations