software.amazon.awssdk.crt.io

Class CrtBufferPool

java.lang.Object

software.amazon.awssdk.crt.CrtResource

software.amazon.awssdk.crt.io.CrtBufferPool

All Implemented Interfaces:

AutoCloseable

public class CrtBufferPool
extends CrtResource

A Pool of CrtByteBuffers

Constructor Summary

Constructors

Constructor and Description
CrtBufferPool(int numBuffers, int bufferSize)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<CrtByteBuffer>	acquireBuffer() Acquires a CrtByteBuffer from this Buffer Pool.
protected boolean	canReleaseReferencesImmediately() Determines whether a resource releases its dependencies at the same time the native handle is released or if it waits.
protected boolean	isNativeResource() Is this an actual native resource (true) or does it just track native resources and use the close/shutdown/referencing aspects (false)?
void	releaseBuffer(CrtByteBuffer idleBuffer)
protected void	releaseNativeHandle() Cleans up the buffer pool internal state by failing all pending acquisitions.

Methods inherited from class software.amazon.awssdk.crt.CrtResource

acquireNativeHandle, addReferenceTo, close, getNativeHandle, isNull, logNativeResources, releaseReferences, waitForNoResources

Methods inherited from class java.lang.Object

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

Constructor Detail

CrtBufferPool

public CrtBufferPool(int numBuffers,
                     int bufferSize)

Method Detail

acquireBuffer

public CompletableFuture<CrtByteBuffer> acquireBuffer()

Acquires a CrtByteBuffer from this Buffer Pool. When the object using this buffer is done with it, the buffer should be released back into this Pool.

Returns:

A Future for a CrtByteBuffer

releaseBuffer

public void releaseBuffer(CrtByteBuffer idleBuffer)

isNativeResource

protected boolean isNativeResource()

Description copied from class: CrtResource

Is this an actual native resource (true) or does it just track native resources and use the close/shutdown/referencing aspects (false)?

Overrides:

isNativeResource in class CrtResource

releaseNativeHandle

protected void releaseNativeHandle()

Cleans up the buffer pool internal state by failing all pending acquisitions.

Specified by:

releaseNativeHandle in class CrtResource

canReleaseReferencesImmediately

protected boolean canReleaseReferencesImmediately()

Determines whether a resource releases its dependencies at the same time the native handle is released or if it waits. Resources that wait are responsible for calling releaseReferences() manually.

Specified by:

canReleaseReferencesImmediately in class CrtResource