alluxio.grpc

Class GrpcManagedChannelPool

java.lang.Object

alluxio.grpc.GrpcManagedChannelPool

@ThreadSafe
public class GrpcManagedChannelPool
extends Object

Used to maintain singleton gRPC ManagedChannel instances per process. This class is used internally by GrpcChannelBuilder and GrpcChannel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GrpcManagedChannelPool.ChannelKey Used to identify a unique ManagedChannel in the pool.
static class	GrpcManagedChannelPool.PoolingStrategy Enumeration to determine the pooling strategy.

Field Summary

Fields

Modifier and Type	Field and Description
protected ScheduledExecutorService	mScheduler Scheduler for destruction of idle channels.

Constructor Summary

Constructors

Constructor and Description
GrpcManagedChannelPool() Creates a new GrpcManagedChannelPool.

Method Summary

Modifier and Type	Method and Description
io.grpc.ManagedChannel	acquireManagedChannel(GrpcManagedChannelPool.ChannelKey channelKey, long healthCheckTimeoutMs, long shutdownTimeoutMs) Acquires and increases the ref-count for the ManagedChannel.
static GrpcManagedChannelPool	INSTANCE()
void	releaseManagedChannel(GrpcManagedChannelPool.ChannelKey channelKey, long shutdownTimeoutMs) Decreases the ref-count of the ManagedChannel for the given address.

Methods inherited from class java.lang.Object

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

Field Detail

mScheduler

protected ScheduledExecutorService mScheduler

Scheduler for destruction of idle channels.

Constructor Detail

GrpcManagedChannelPool

public GrpcManagedChannelPool()

Creates a new GrpcManagedChannelPool.

Method Detail

INSTANCE

public static GrpcManagedChannelPool INSTANCE()

Returns:

the singleton pool instance

acquireManagedChannel

public io.grpc.ManagedChannel acquireManagedChannel(GrpcManagedChannelPool.ChannelKey channelKey,
                                                    long healthCheckTimeoutMs,
                                                    long shutdownTimeoutMs)

Acquires and increases the ref-count for the ManagedChannel.

Parameters:

channelKey - channel key

healthCheckTimeoutMs - health check timeout in milliseconds

shutdownTimeoutMs - shutdown timeout in milliseconds

Returns:

a ManagedChannel

releaseManagedChannel

public void releaseManagedChannel(GrpcManagedChannelPool.ChannelKey channelKey,
                                  long shutdownTimeoutMs)

Decreases the ref-count of the ManagedChannel for the given address. It shuts down and releases the ManagedChannel if reference count reaches zero.

Parameters:

channelKey - host address

shutdownTimeoutMs - shutdown timeout in milliseconds