net.openhft.chronicle.core.io

Class AbstractReferenceCounted

java.lang.Object

net.openhft.chronicle.core.io.AbstractReferenceCounted

All Implemented Interfaces:

ReferenceCounted, ReferenceCountedTracer, ReferenceOwner, SingleThreadedChecked

Direct Known Subclasses:

AbstractCloseableReferenceCounted

public abstract class AbstractReferenceCounted
extends Object
implements ReferenceCountedTracer, ReferenceOwner, SingleThreadedChecked

Field Summary

Fields

Modifier and Type	Field and Description
protected MonitorReferenceCounted	referenceCounted
protected static int	WARN_COUNT
protected static long	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	AbstractReferenceCounted()
protected	AbstractReferenceCounted(boolean monitored)

Method Summary

Modifier and Type	Method and Description
void	addReferenceChangeListener(ReferenceChangeListener referenceChangeListener) Add a ReferenceChangeListener that will be notified whenever the set of references changes
static void	assertReferencesReleased()
protected void	backgroundPerformRelease()
protected boolean	canReleaseInBackground()
void	clearUsedByThread() Deprecated. Use singleThreadedCheckReset() instead
StackTrace	createdHere()
static void	disableReferenceTracing()
static void	enableReferenceTracing()
protected abstract void	performRelease()
int	refCount() Returns the reference count for this resource.
int	referenceId()
void	release(ReferenceOwner id) Releases a resource.
void	releaseLast(ReferenceOwner id) Releases a resource and checks this is the last usage.
void	removeReferenceChangeListener(ReferenceChangeListener referenceChangeListener) Remove a ReferenceChangeListener
void	reserve(ReferenceOwner id) Reserves a resource or throws an Exception.
boolean	reservedBy(ReferenceOwner owner) Deprecated.
void	reserveTransfer(ReferenceOwner from, ReferenceOwner to)
void	singleThreadedCheckDisabled(boolean singleThreadedCheckDisabled) When set to true this resource can be shared between thread provided you ensure they used in a thread safe manner.
void	singleThreadedCheckReset() Forget about previous accesses and only check from now on.
protected boolean	threadSafetyCheck(boolean isUsed)
void	throwExceptionIfNotReleased()
void	throwExceptionIfReleased()
@NotNull String	toString()
boolean	tryReserve(ReferenceOwner id) Tries to reserve a resource and returns if the resource could be successfully reserved.
static void	unmonitor(ReferenceCounted counted)
void	warnAndReleaseIfNotReleased() Release any remaining references, and log a warning if there were any references to release.

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.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

Field Detail

WARN_NS

protected static final long WARN_NS

WARN_COUNT

protected static final int WARN_COUNT

referenceCounted

protected final transient MonitorReferenceCounted referenceCounted

Constructor Detail

AbstractReferenceCounted

protected AbstractReferenceCounted()

AbstractReferenceCounted

protected AbstractReferenceCounted(boolean monitored)

Method Detail

enableReferenceTracing

public static void enableReferenceTracing()

disableReferenceTracing

public static void disableReferenceTracing()

assertReferencesReleased

public static void assertReferencesReleased()

unmonitor

public static void unmonitor(ReferenceCounted counted)

referenceId

public int referenceId()

Specified by:

referenceId in interface ReferenceOwner

createdHere

public StackTrace createdHere()

Specified by:

createdHere in interface ReferenceCountedTracer

throwExceptionIfNotReleased

public void throwExceptionIfNotReleased()
                                 throws IllegalStateException

Specified by:

throwExceptionIfNotReleased in interface ReferenceCountedTracer

Throws:

IllegalStateException

backgroundPerformRelease

protected void backgroundPerformRelease()

canReleaseInBackground

protected boolean canReleaseInBackground()

performRelease

protected abstract void performRelease()
                                throws IllegalStateException

Throws:

IllegalStateException

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

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.

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

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

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

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

reserveTransfer

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

Specified by:

reserveTransfer in interface ReferenceCounted

Throws:

IllegalStateException

refCount

public int refCount()

Description copied from interface: ReferenceCounted

Returns the reference count for this resource.

Specified by:

refCount in interface ReferenceCounted

Returns:

the reference count for this resource

throwExceptionIfReleased

public void throwExceptionIfReleased()
                              throws ClosedIllegalStateException

Specified by:

throwExceptionIfReleased in interface ReferenceCountedTracer

Throws:

ClosedIllegalStateException

warnAndReleaseIfNotReleased

public void warnAndReleaseIfNotReleased()
                                 throws ClosedIllegalStateException

Description copied from interface: ReferenceCountedTracer

Release any remaining references, and log a warning if there were any references to release.

Intended to be called by a finalizer or in a test, to confirm that references are being released correctly

Note: This will not cause any ReferenceChangeListeners to fire as it's really just a sanity check

Specified by:

warnAndReleaseIfNotReleased in interface ReferenceCountedTracer

Throws:

ClosedIllegalStateException

reservedBy

@Deprecated
public boolean reservedBy(ReferenceOwner owner)
                               throws IllegalStateException

Deprecated.

Description copied from interface: ReferenceCounted

Best effort check the owner has reserved it. Returns true if not sure.

Specified by:

reservedBy in interface ReferenceCounted

Parameters:

owner - to check

Returns:

false if the owner definitely doesn't own it.

Throws:

IllegalStateException

singleThreadedCheckDisabled

public void singleThreadedCheckDisabled(boolean singleThreadedCheckDisabled)

Description copied from interface: SingleThreadedChecked

When set to true this resource can be shared between thread provided you ensure they used in a thread safe manner.

Specified by:

singleThreadedCheckDisabled in interface SingleThreadedChecked

Parameters:

singleThreadedCheckDisabled - true to turn off the thread safety check

addReferenceChangeListener

public void addReferenceChangeListener(ReferenceChangeListener referenceChangeListener)

Description copied from interface: ReferenceCounted

Add a ReferenceChangeListener that will be notified whenever the set of references changes

Specified by:

addReferenceChangeListener in interface ReferenceCounted

Parameters:

referenceChangeListener - The listener to add

removeReferenceChangeListener

public void removeReferenceChangeListener(ReferenceChangeListener referenceChangeListener)

Description copied from interface: ReferenceCounted

Remove a ReferenceChangeListener

Uses object equality to determine which to remove so be careful if the listener implements equals

Specified by:

removeReferenceChangeListener in interface ReferenceCounted

Parameters:

referenceChangeListener - The listener to remove

threadSafetyCheck

protected boolean threadSafetyCheck(boolean isUsed)
                             throws IllegalStateException

Throws:

IllegalStateException

singleThreadedCheckReset

public void singleThreadedCheckReset()

Description copied from interface: SingleThreadedChecked

Forget about previous accesses and only check from now on.

Specified by:

singleThreadedCheckReset in interface SingleThreadedChecked

clearUsedByThread

@Deprecated
public void clearUsedByThread()

Deprecated. Use singleThreadedCheckReset() instead

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object