Class CachedSubchannelPool

java.lang.Object

io.grpc.grpclb.CachedSubchannelPool

All Implemented Interfaces:

SubchannelPool

final class CachedSubchannelPool
extends Object
implements SubchannelPool

A SubchannelPool that keeps returned LoadBalancer.Subchannels for a given time before it's shut down by the pool.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	CachedSubchannelPool.CacheEntry
(package private) final class	CachedSubchannelPool.ShutdownSubchannelTask

Nested classes/interfaces inherited from interface SubchannelPool

SubchannelPool.PooledSubchannelStateListener

Field Summary

Fields

Modifier and Type	Field	Description
private final HashMap<EquivalentAddressGroup, CachedSubchannelPool.CacheEntry>	cache
private final LoadBalancer.Helper	helper
private SubchannelPool.PooledSubchannelStateListener	listener
(package private) static final long	SHUTDOWN_TIMEOUT_MS

Constructor Summary

Constructors

Constructor	Description
CachedSubchannelPool(LoadBalancer.Helper helper)

Method Summary

Modifier and Type	Method	Description
void	clear()	Shuts down all subchannels in the pool immediately.
void	registerListener(SubchannelPool.PooledSubchannelStateListener listener)	Registers a listener to received Subchannel status updates.
void	returnSubchannel(LoadBalancer.Subchannel subchannel, ConnectivityStateInfo lastKnownState)	Puts a LoadBalancer.Subchannel back to the pool.
LoadBalancer.Subchannel	takeOrCreateSubchannel(EquivalentAddressGroup eag, Attributes defaultAttributes)	Takes a LoadBalancer.Subchannel from the pool for the given eag if there is one available.
private void	updateCachedSubchannelState(LoadBalancer.Subchannel subchannel, ConnectivityStateInfo newStateInfo)

Methods inherited from class Object

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

Field Details

cache

private final HashMap<EquivalentAddressGroup, CachedSubchannelPool.CacheEntry> cache

helper

private final LoadBalancer.Helper helper

listener

private SubchannelPool.PooledSubchannelStateListener listener

SHUTDOWN_TIMEOUT_MS

static final long SHUTDOWN_TIMEOUT_MS

See Also:

• Constant Field Values

Constructor Details

CachedSubchannelPool

public CachedSubchannelPool(LoadBalancer.Helper helper)

Method Details

registerListener

public void registerListener(SubchannelPool.PooledSubchannelStateListener listener)

Description copied from interface: SubchannelPool

Registers a listener to received Subchannel status updates.

Specified by:

registerListener in interface SubchannelPool

takeOrCreateSubchannel

public LoadBalancer.Subchannel takeOrCreateSubchannel(EquivalentAddressGroup eag,
 Attributes defaultAttributes)

Description copied from interface: SubchannelPool

Takes a LoadBalancer.Subchannel from the pool for the given eag if there is one available. Otherwise, creates and returns a new Subchannel with the given eag and defaultAttributes.

Specified by:

takeOrCreateSubchannel in interface SubchannelPool

updateCachedSubchannelState

private void updateCachedSubchannelState(LoadBalancer.Subchannel subchannel,
 ConnectivityStateInfo newStateInfo)

returnSubchannel

public void returnSubchannel(LoadBalancer.Subchannel subchannel,
 ConnectivityStateInfo lastKnownState)

Description copied from interface: SubchannelPool

Puts a LoadBalancer.Subchannel back to the pool. From this point the Subchannel is owned by the pool, and the caller should stop referencing to this Subchannel.

Specified by:

returnSubchannel in interface SubchannelPool

clear

public void clear()

Description copied from interface: SubchannelPool

Shuts down all subchannels in the pool immediately.

Specified by:

clear in interface SubchannelPool