com.hubject.aws.s3.io

Class SimpleByteBufferPool

com.hubject.aws.s3.io.SimpleByteBufferPool

All Implemented Interfaces:

ByteBufferPool

public class SimpleByteBufferPool
implements ByteBufferPool

A pool for byte buffers, similar to connection pools. Avoids frequent re-allocation.

Example:

    // obtain a buffer
    val buffer = bufferPool.get(1024 * 50 /* 50 KiB */)

    // use the buffer
    buffer.write(someData)
    writeData(buffer)

    // return it
    bufferPool.put(buffer)

Nested Class Summary

Nested classes/interfaces inherited from interface com.hubject.aws.s3.io.ByteBufferPool

ByteBufferPool.Companion

Field Summary

Fields inherited from interface com.hubject.aws.s3.io.ByteBufferPool

Companion

Constructor Summary

Constructors

Constructor and Description
SimpleByteBufferPool(boolean allocateDirect, int maxSpareBuffers) A pool for byte buffers, similar to connection pools. Avoids frequent re-allocation.
SimpleByteBufferPool(boolean allocateDirect) A pool for byte buffers, similar to connection pools. Avoids frequent re-allocation.
SimpleByteBufferPool() A pool for byte buffers, similar to connection pools. Avoids frequent re-allocation.

Method Summary

Modifier and Type	Method and Description
void	free(java.nio.ByteBuffer buffer) Returns this buffer to the pool. User code must not hold any references to the given buffer after this method returns.
boolean	getAllocateDirect() Whether to allocate memory off-heap.
int	getMaxSpareBuffers() Maximum number of spare buffers
java.nio.ByteBuffer	pop(int minSize) Returns a buffer that has at least the given amount of bytes of available space. If no such buffer is currently free, one will be allocated.

Methods inherited from interface com.hubject.aws.s3.io.ByteBufferPool

free, pop

Constructor Detail

SimpleByteBufferPool

public SimpleByteBufferPool(boolean allocateDirect,
                            int maxSpareBuffers)

A pool for byte buffers, similar to connection pools. Avoids frequent re-allocation.

Example:

    // obtain a buffer
    val buffer = bufferPool.get(1024 * 50 /* 50 KiB */)

    // use the buffer
    buffer.write(someData)
    writeData(buffer)

    // return it
    bufferPool.put(buffer)

Parameters:

allocateDirect - Whether to allocate memory off-heap.

maxSpareBuffers - Maximum number of spare buffers

SimpleByteBufferPool

public SimpleByteBufferPool(boolean allocateDirect)

A pool for byte buffers, similar to connection pools. Avoids frequent re-allocation.

Example:

    // obtain a buffer
    val buffer = bufferPool.get(1024 * 50 /* 50 KiB */)

    // use the buffer
    buffer.write(someData)
    writeData(buffer)

    // return it
    bufferPool.put(buffer)

Parameters:

allocateDirect - Whether to allocate memory off-heap.

SimpleByteBufferPool

public SimpleByteBufferPool()

A pool for byte buffers, similar to connection pools. Avoids frequent re-allocation.

Example:

    // obtain a buffer
    val buffer = bufferPool.get(1024 * 50 /* 50 KiB */)

    // use the buffer
    buffer.write(someData)
    writeData(buffer)

    // return it
    bufferPool.put(buffer)

Method Detail

pop

public java.nio.ByteBuffer pop(int minSize)

Returns a buffer that has at least the given amount of bytes of available space. If no such buffer is currently free, one will be allocated.

free

public void free(java.nio.ByteBuffer buffer)

Returns this buffer to the pool. User code must not hold any references to the given buffer after this method returns.

getAllocateDirect

public boolean getAllocateDirect()

Whether to allocate memory off-heap.

See Also:

ByteBuffer.allocateDirect

getMaxSpareBuffers

public int getMaxSpareBuffers()

Maximum number of spare buffers