software.amazon.awssdk.crt

Class CrtResource

java.lang.Object

software.amazon.awssdk.crt.CrtResource

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ClientBootstrap, CrtBufferPool, CrtByteBuffer, EventLoopGroup, HostResolver, HttpClientConnection, HttpClientConnectionManager, HttpStream, MqttClient, MqttClientConnection, SocketOptions, TlsContext, TlsContextOptions

public abstract class CrtResource
extends Object
implements AutoCloseable

This wraps a native pointer to an AWS Common Runtime resource. It also ensures that the first time a resource is referenced, the CRT will be loaded and bound.

Constructor Summary

Constructors

Constructor and Description
CrtResource()

Method Summary

Modifier and Type	Method and Description
protected void	acquireNativeHandle(long handle) Takes ownership of a native object where the native pointer is tracked as a long.
<T extends CrtResource> T	addReferenceTo(T resource) Marks a resource as referenced by this resource.
protected abstract boolean	canReleaseReferencesImmediately() Override that determines whether a resource releases its dependencies at the same time the native handle is released or if it waits.
void	close() Decrements the reference count to this resource.
static void	collectNativeResources(java.util.function.Consumer<String> fn)
long	getNativeHandle() returns the native handle associated with this CRTResource.
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)?
boolean	isNull() Checks if this resource's native handle is NULL.
static void	logNativeResources() Debug method to log all of the currently un-closed CRTResource objects.
protected abstract void	releaseNativeHandle() Required override method that must begin the release process of the acquired native handle
protected void	releaseReferences() Decrements the ref counts for all resources referenced by this resource.
static void	waitForNoResources() Debug/test method to wait for the CRTResource count to drop to zero.

Methods inherited from class java.lang.Object

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

Constructor Detail

CrtResource

public CrtResource()

Method Detail

addReferenceTo

public <T extends CrtResource> T addReferenceTo(T resource)

Marks a resource as referenced by this resource. It is not safe to change the resource dependency graph after resource construction.

Parameters:

resource - The referenced subresource

Returns:

The original resource.

acquireNativeHandle

protected void acquireNativeHandle(long handle)

Takes ownership of a native object where the native pointer is tracked as a long.

Parameters:

handle - pointer to the native object being acquired

getNativeHandle

public long getNativeHandle()

returns the native handle associated with this CRTResource.

releaseNativeHandle

protected abstract void releaseNativeHandle()

Required override method that must begin the release process of the acquired native handle

canReleaseReferencesImmediately

protected abstract boolean canReleaseReferencesImmediately()

Override that determines whether a resource releases its dependencies at the same time the native handle is released or if it waits. Resources with asynchronous shutdown processes should override this with false, and establish a callback from native code that invokes releaseReferences() when the asynchronous shutdown process has completed. See HttpClientConnectionManager for an example.

isNull

public boolean isNull()

Checks if this resource's native handle is NULL. For always-null resources this is always true. For all other resources it means it has already been cleaned up or was not properly constructed.

isNativeResource

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)?

close

public void close()

Decrements the reference count to this resource. If zero is reached, begins (and possibly completes) the resource's cleanup process.

Specified by:

close in interface AutoCloseable

releaseReferences

protected void releaseReferences()

Decrements the ref counts for all resources referenced by this resource. Most resources will have this called from their close() function, but resources with asynchronous shutdown processes must have it called from a shutdown completion callback.

collectNativeResources

public static void collectNativeResources(java.util.function.Consumer<String> fn)

logNativeResources

public static void logNativeResources()

Debug method to log all of the currently un-closed CRTResource objects.

waitForNoResources

public static void waitForNoResources()

Debug/test method to wait for the CRTResource count to drop to zero. Times out with an exception after a period of waiting.