alluxio.client.block.stream

Class BlockWorkerClientPool

java.lang.Object

alluxio.resource.DynamicResourcePool<BlockWorkerClient>

alluxio.client.block.stream.BlockWorkerClientPool

All Implemented Interfaces:

Pool<BlockWorkerClient>, Closeable, AutoCloseable

@ThreadSafe
public final class BlockWorkerClientPool
extends DynamicResourcePool<BlockWorkerClient>

Class for managing block worker clients. After obtaining a client with DynamicResourcePool.acquire(), DynamicResourcePool.release(Object) must be called when the thread is done using the client.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.resource.DynamicResourcePool

DynamicResourcePool.Options, DynamicResourcePool.ResourceInternal<R>

Field Summary

Fields inherited from class alluxio.resource.DynamicResourcePool

mClock

Constructor Summary

Constructors

Constructor and Description
BlockWorkerClientPool(Subject subject, GrpcServerAddress address, int maxCapacity, AlluxioConfiguration alluxioConf, io.netty.channel.EventLoopGroup workerGroup) Creates a new block master client pool.

Method Summary

Modifier and Type	Method and Description
protected void	closeResource(BlockWorkerClient client) Closes the resource.
protected BlockWorkerClient	createNewResource() Creates a new resource.
protected boolean	isHealthy(BlockWorkerClient client) Checks whether a client is healthy.
protected boolean	shouldGc(DynamicResourcePool.ResourceInternal<BlockWorkerClient> clientResourceInternal)

Methods inherited from class alluxio.resource.DynamicResourcePool

acquire, acquire, close, release, size

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockWorkerClientPool

public BlockWorkerClientPool(Subject subject,
                             GrpcServerAddress address,
                             int maxCapacity,
                             AlluxioConfiguration alluxioConf,
                             io.netty.channel.EventLoopGroup workerGroup)

Creates a new block master client pool.

Parameters:

subject - the parent subject

address - address of the worker

maxCapacity - the maximum capacity of the pool

alluxioConf - Alluxio configuration

workerGroup - netty event loop group to create clients with is above the minimum capacity(1), it is closed and removed from the pool.

Method Detail

closeResource

protected void closeResource(BlockWorkerClient client)
                      throws IOException

Description copied from class: DynamicResourcePool

Closes the resource. After this, the resource should not be used. It is not guaranteed that the resource is closed after the function returns.

Specified by:

closeResource in class DynamicResourcePool<BlockWorkerClient>

Parameters:

client - the resource to close

Throws:

IOException

createNewResource

protected BlockWorkerClient createNewResource()
                                       throws IOException

Description copied from class: DynamicResourcePool

Creates a new resource.

Specified by:

createNewResource in class DynamicResourcePool<BlockWorkerClient>

Returns:

the newly created resource

Throws:

IOException

isHealthy

protected boolean isHealthy(BlockWorkerClient client)

Checks whether a client is healthy.

Specified by:

isHealthy in class DynamicResourcePool<BlockWorkerClient>

Parameters:

client - the client to check

Returns:

true if the client is active (i.e. connected)

shouldGc

protected boolean shouldGc(DynamicResourcePool.ResourceInternal<BlockWorkerClient> clientResourceInternal)

Specified by:

shouldGc in class DynamicResourcePool<BlockWorkerClient>

Parameters:

clientResourceInternal - the resource to check

Returns:

true if the resource should be garbage collected