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

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

Method Summary

Modifier and Type	Method and Description
protected void	backgroundPerformRelease()
void	close() Closes this resource, potentially preventing parts of it from being used again and potentially relinquishing resources held.
boolean	isClosed() Is this object closed
void	release(ReferenceOwner id) Releases a resource.
void	releaseLast(ReferenceOwner id) Releases a resource and checks this is the last usage.
void	reserve(ReferenceOwner id) Reserves a resource or throws an Exception.
void	reserveTransfer(ReferenceOwner from, ReferenceOwner to)
protected void	setClosed() When actually closed.
protected void	setClosing() Set closing in case it is being released in the background.
void	throwExceptionIfClosed()
protected void	throwExceptionIfClosedInSetter()
boolean	tryReserve(ReferenceOwner id) Tries to reserve a resource and returns if the resource could be successfully reserved.

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

addReferenceChangeListener, assertReferencesReleased, canReleaseInBackground, clearUsedByThread, createdHere, disableReferenceTracing, enableReferenceTracing, performRelease, refCount, 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()

Method Detail

reserve

public void reserve(ReferenceOwner id)
             throws IllegalStateException

Description copied from interface: ReferenceCounted

Reserves a resource or throws an Exception.

Each invocation of this method increases the reference count by one.

Specified by:

reserve in interface ReferenceCounted

Overrides:

reserve in class AbstractReferenceCounted

Parameters:

id - unique id for this reserve

Throws:

IllegalStateException - if the resource has already been freed. I.e. its reference counter has as some point reached zero.

reserveTransfer

public void reserveTransfer(ReferenceOwner from,
                            ReferenceOwner to)
                     throws IllegalStateException

Specified by:

reserveTransfer in interface ReferenceCounted

Overrides:

reserveTransfer in class AbstractReferenceCounted

Throws:

IllegalStateException

release

public void release(ReferenceOwner id)
             throws IllegalStateException

Description copied from interface: ReferenceCounted

Releases a resource.

Each invocation of this method decreases the reference count by one.

Specified by:

release in interface ReferenceCounted

Overrides:

release in class AbstractReferenceCounted

Parameters:

id - unique id for the reserve to be released

Throws:

IllegalStateException - if the resource has already been freed. I.e. its reference counter has as some point reached zero.

releaseLast

public void releaseLast(ReferenceOwner id)
                 throws IllegalStateException

Description copied from interface: ReferenceCounted

Releases a resource and checks this is the last usage.

Each invocation of this method decreases the reference count by one.

Specified by:

releaseLast in interface ReferenceCounted

Overrides:

releaseLast in class AbstractReferenceCounted

Parameters:

id - unique id for the reserve to be released

Throws:

IllegalStateException - if the resource has already been freed. I.e. its reference counter has as some point reached zero.

tryReserve

public boolean tryReserve(ReferenceOwner id)
                   throws IllegalStateException,
                          IllegalArgumentException

Description copied from interface: ReferenceCounted

Tries to reserve a resource and returns if the resource could be successfully reserved.

Each invocation of this method increases the reference count by one.

Specified by:

tryReserve in interface ReferenceCounted

Overrides:

tryReserve in class AbstractReferenceCounted

Parameters:

id - unique id for this reserve

Throws:

IllegalStateException - if the resource has already been freed. I.e. its reference counter has as some point reached zero.

IllegalArgumentException

close

public void close()

Description copied from interface: Closeable

Closes this resource, potentially preventing parts of it from being used again and potentially relinquishing resources held.

This method is idem-potent.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

backgroundPerformRelease

protected void backgroundPerformRelease()

Overrides:

backgroundPerformRelease in class AbstractReferenceCounted

setClosing

protected void setClosing()

Set closing in case it is being released in the background.

setClosed

protected void setClosed()

When actually closed.

throwExceptionIfClosed

public void throwExceptionIfClosed()
                            throws IllegalStateException

Specified by:

throwExceptionIfClosed in interface ManagedCloseable

Throws:

IllegalStateException

throwExceptionIfClosedInSetter

protected void throwExceptionIfClosedInSetter()
                                       throws IllegalStateException

Throws:

IllegalStateException

isClosed

public boolean isClosed()

Description copied from interface: QueryCloseable

Is this object closed

Specified by:

isClosed in interface QueryCloseable

Returns:

true if close() has completed