alluxio.resource

Interface Pool<T>

Type Parameters:

T - the type of resource this pool manages

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

BlockMasterClientPool, BlockMasterClientPool, BlockWorkerClientPool, ByteBufferResourcePool, DynamicResourcePool, FileSystemMasterClientPool, JobMasterClientPool, NettyChannelPool, ResourcePool

public interface Pool<T>
extends Closeable

Interface representing a pool of resources to be temporarily used and returned.

Method Summary

Modifier and Type	Method and Description
T	acquire() Acquires a resource from the pool.
T	acquire(long time, TimeUnit unit) Acquires a resource from the pool.
default PooledResource<T>	acquireCloseable() Acquires a resource wrapped inside a PooledResource, which will release the resource to this pool when it's closed.
default PooledResource<T>	acquireCloseable(long time, TimeUnit unit) Acquires a resource wrapped inside a PooledResource, which will release the resource to this pool when it's closed.
void	release(T resource) Releases the resource to the pool.
int	size()

Methods inherited from interface java.io.Closeable

close

Method Detail

acquire

T acquire()
   throws IOException

Acquires a resource from the pool.

Returns:

the acquired resource which should not be null

Throws:

IOException

acquire

T acquire(long time,
          TimeUnit unit)
   throws TimeoutException,
          IOException

Acquires a resource from the pool.

Parameters:

time - time it takes before timeout if no resource is available

unit - the unit of the time

Returns:

the acquired resource which should not be null

Throws:

TimeoutException

IOException

acquireCloseable

default PooledResource<T> acquireCloseable()
                                    throws IOException

Acquires a resource wrapped inside a PooledResource, which will release the resource to this pool when it's closed.

Returns:

pooled resource

Throws:

IOException

acquireCloseable

default PooledResource<T> acquireCloseable(long time,
                                           TimeUnit unit)
                                    throws TimeoutException,
                                           IOException

Acquires a resource wrapped inside a PooledResource, which will release the resource to this pool when it's closed.

Parameters:

time - time it takes before timeout if no resource is available

unit - the unit of the time

Returns:

pooled resource

Throws:

TimeoutException

IOException

release

void release(T resource)

Releases the resource to the pool.

Parameters:

resource - the resource to release

size

int size()

Returns:

the current pool size