net.openhft.chronicle.core.io

Class AbstractCloseableReferenceCounted

java.lang.Object

net.openhft.chronicle.core.io.AbstractReferenceCounted

net.openhft.chronicle.core.io.AbstractCloseableReferenceCounted

All Implemented Interfaces:

Closeable, AutoCloseable, ManagedCloseable, QueryCloseable, ReferenceCounted, ReferenceCountedTracer, ReferenceOwner, SingleThreadedChecked

public abstract class AbstractCloseableReferenceCounted
extends AbstractReferenceCounted
implements ManagedCloseable

Represents a closeable resource with reference counting capabilities.

This abstract class extends AbstractReferenceCounted and implements ManagedCloseable, and is designed to manage a resource that requires reference counting to ensure proper cleanup once it is no longer in use.

Reference counting allows multiple users to share a single resource and ensures that the resource is only closed when all references are released. Each user of the resource increments the reference count upon acquiring the resource and decrements it upon releasing.

This class integrates reference counting with the ability to close the resource. When the reference count reaches zero, or if an explicit call to close is made, the resource transitions to the closed state and cannot be used any further.

Field Summary

Fields inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted

referenceCounted, WARN_COUNT, WARN_NS

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Fields inherited from interface net.openhft.chronicle.core.io.SingleThreadedChecked

DISABLE_SINGLE_THREADED_CHECK

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCloseableReferenceCounted() Constructs a new AbstractCloseableReferenceCounted instance and adds the instance to the CloseableUtils set for tracking.

Method Summary

Modifier and Type	Method and Description
protected void	backgroundPerformRelease() Closes the resource in the background.
void	close() Closes the resource, ensuring it transitions to a closed state.
boolean	isClosed() Indicates whether the resource is in a closed state.
void	release(ReferenceOwner id) Releases the resource for the given id.
void	releaseLast(ReferenceOwner id) Releases the resource for the given id and checks the resource is now released.
void	reserve(ReferenceOwner id) Attempts to reserve the resource for the given unique id.
void	reserveTransfer(ReferenceOwner from, ReferenceOwner to) Reserves the resource for the given id.
protected void	setClosed() Sets the resource as closed.
protected void	setClosing() Sets the resource as closing in case it is being released in the background.
void	throwExceptionIfClosed() Throws an exception if the resource is closed.
protected void	throwExceptionIfClosedInSetter() Throws an exception if the resource is closed while in a setter method.
boolean	tryReserve(ReferenceOwner id) Tries to reserve the resource for the given id.

Methods inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted

addReferenceChangeListener, assertReferencesReleased, canReleaseInBackground, clearUsedByThread, createdHere, disableReferenceTracing, enableReferenceTracing, performRelease, refCount, referenceCountedUnmonitored, referenceId, removeReferenceChangeListener, reservedBy, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfNotReleased, throwExceptionIfReleased, toString, unmonitor, warnAndReleaseIfNotReleased

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.core.io.ManagedCloseable

createdHere, warnAndCloseIfNotClosed

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

closeQuietly, closeQuietly

Methods inherited from interface net.openhft.chronicle.core.io.QueryCloseable

isClosing

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceCountedTracer

onReleased

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceCounted

releaseLast

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

referenceName, temporary

Constructor Detail

AbstractCloseableReferenceCounted

protected AbstractCloseableReferenceCounted()

Constructs a new AbstractCloseableReferenceCounted instance and adds the instance to the CloseableUtils set for tracking.

Method Detail

reserve

public void reserve(ReferenceOwner id)
             throws ClosedIllegalStateException,
                    ThreadingIllegalStateException

Attempts to reserve the resource for the given unique id.

Specified by:

reserve in interface ReferenceCounted

Overrides:

reserve in class AbstractReferenceCounted

Parameters:

id - the unique identifier representing the owner of this reserve.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

reserveTransfer

public void reserveTransfer(ReferenceOwner from,
                            ReferenceOwner to)
                     throws ClosedIllegalStateException,
                            ThreadingIllegalStateException

Reserves the resource for the given id.

Specified by:

reserveTransfer in interface ReferenceCounted

Overrides:

reserveTransfer in class AbstractReferenceCounted

Parameters:

from - resource

to - resource

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If used in a non thread safe way

release

public void release(ReferenceOwner id)
             throws ClosedIllegalStateException

Releases the resource for the given id.

Specified by:

release in interface ReferenceCounted

Overrides:

release in class AbstractReferenceCounted

Parameters:

id - unique id for this release

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

releaseLast

public void releaseLast(ReferenceOwner id)
                 throws ClosedIllegalStateException

Releases the resource for the given id and checks the resource is now released.

Specified by:

releaseLast in interface ReferenceCounted

Overrides:

releaseLast in class AbstractReferenceCounted

Parameters:

id - unique id for this release

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

tryReserve

public boolean tryReserve(ReferenceOwner id)
                   throws ClosedIllegalStateException,
                          IllegalArgumentException

Tries to reserve the resource for the given id.

Specified by:

tryReserve in interface ReferenceCounted

Overrides:

tryReserve in class AbstractReferenceCounted

Parameters:

id - unique id for this reserve

Returns:

true if reserved

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

IllegalArgumentException - If the reference owner is not valid.

close

public void close()

Closes the resource, ensuring it transitions to a closed state. If the resource is being released in the background, it is marked as closing.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

See Also:

AbstractCloseable.performClose()

backgroundPerformRelease

protected void backgroundPerformRelease()

Closes the resource in the background.

Overrides:

backgroundPerformRelease in class AbstractReferenceCounted

setClosing

protected void setClosing()

Sets the resource as closing in case it is being released in the background.

setClosed

protected void setClosed()

Sets the resource as closed.

throwExceptionIfClosed

public void throwExceptionIfClosed()
                            throws ClosedIllegalStateException,
                                   ThreadingIllegalStateException

Throws an exception if the resource is closed.

Specified by:

throwExceptionIfClosed in interface ManagedCloseable

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If the thread safety check fails.

throwExceptionIfClosedInSetter

protected void throwExceptionIfClosedInSetter()
                                       throws ClosedIllegalStateException,
                                              ThreadingIllegalStateException

Throws an exception if the resource is closed while in a setter method.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException

isClosed

public boolean isClosed()

Indicates whether the resource is in a closed state.

Specified by:

isClosed in interface QueryCloseable

Returns:

true if the resource is closed; false otherwise.