Package io.grpc

Class ManagedChannelRegistry

java.lang.Object

io.grpc.ManagedChannelRegistry

@Internal
@ThreadSafe
public final class ManagedChannelRegistry
extends Object

Registry of ManagedChannelProviders. The default instance loads providers at runtime through the Java service provider mechanism.

Since:

1.32.0

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ManagedChannelRegistry()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final Logger logger

instance

private static ManagedChannelRegistry instance

allProviders

private final LinkedHashSet<ManagedChannelProvider> allProviders

effectiveProviders

private List<ManagedChannelProvider> effectiveProviders

Immutable, sorted version of allProviders. Is replaced instead of mutating.

Constructor Details

ManagedChannelRegistry

public ManagedChannelRegistry()

Method Details

register

public 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.

addProvider

private void addProvider(ManagedChannelProvider provider)

deregister

public void deregister(ManagedChannelProvider provider)

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

Parameters:

provider - the provider that was added to the register via register(io.grpc.ManagedChannelProvider).

refreshProviders

private void refreshProviders()

getDefaultRegistry

public static ManagedChannelRegistry getDefaultRegistry()

Returns the default registry that loads providers via the Java service loader mechanism.

providers

List<ManagedChannelProvider> providers()

Returns effective providers, in priority order.

provider

ManagedChannelProvider provider()

getHardCodedClasses

static List<Class<?>> getHardCodedClasses()

newChannelBuilder

ManagedChannelBuilder<?> newChannelBuilder(String target,
 ChannelCredentials creds)

newChannelBuilder

ManagedChannelBuilder<?> newChannelBuilder(NameResolverRegistry nameResolverRegistry,
 String target,
 ChannelCredentials creds)