alluxio.underfs

Class ByteBufferResourcePool

java.lang.Object

alluxio.resource.ResourcePool<ByteBuffer>

alluxio.underfs.ByteBufferResourcePool

All Implemented Interfaces:

Pool<ByteBuffer>, Closeable, AutoCloseable

public class ByteBufferResourcePool
extends ResourcePool<ByteBuffer>

A simple byte buffer resource pool. Byte buffer can be replaced with netty ByteBuf in the future.

Field Summary

Fields inherited from class alluxio.resource.ResourcePool

mCurrentCapacity, mMaxCapacity, mResources

Constructor Summary

Constructors

Constructor and Description
ByteBufferResourcePool(int maxCapacity, int bufferSize) Creates an instance.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the resource pool.
ByteBuffer	createNewResource() Creates a new resource which will be added to the resource pool after the user is done using it.
void	release(ByteBuffer resource) Releases an object of type T, this must be called after the thread is done using a resource obtained by acquire.

Methods inherited from class alluxio.resource.ResourcePool

acquire, acquire, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.resource.Pool

acquireCloseable, acquireCloseable

Constructor Detail

ByteBufferResourcePool

public ByteBufferResourcePool(int maxCapacity,
                              int bufferSize)

Creates an instance.

Parameters:

maxCapacity - the max capacity

bufferSize - the buffer size

Method Detail

close

public void close()
           throws IOException

Description copied from class: ResourcePool

Closes the resource pool. After this call, the object should be discarded. Inheriting classes should clean up all their resources here.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class ResourcePool<ByteBuffer>

Throws:

IOException

release

public void release(ByteBuffer resource)

Description copied from class: ResourcePool

Releases an object of type T, this must be called after the thread is done using a resource obtained by acquire.

Specified by:

release in interface Pool<ByteBuffer>

Overrides:

release in class ResourcePool<ByteBuffer>

Parameters:

resource - the resource to be released, it should not be reused after calling this method

createNewResource

public ByteBuffer createNewResource()

Description copied from class: ResourcePool

Creates a new resource which will be added to the resource pool after the user is done using it. This method should only be called when the capacity of the pool has not been reached. If creating the resource will take a significant amount of time, the inheriting class should avoid calling this method and instead initialize all the resources in the constructor.

Specified by:

createNewResource in class ResourcePool<ByteBuffer>

Returns:

a resource which will be added to the pool of resources