net.openhft.chronicle.core.io

Class TracingReferenceCounted

java.lang.Object

net.openhft.chronicle.core.io.TracingReferenceCounted

All Implemented Interfaces:

MonitorReferenceCounted, ReferenceCounted, ReferenceCountedTracer, ReferenceOwner

public final class TracingReferenceCounted
extends Object
implements MonitorReferenceCounted

Field Summary

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

INIT, TMP

Method Summary

Modifier and Type	Method and Description
void	addReferenceChangeListener(ReferenceChangeListener referenceChangeListener) Adds a ReferenceChangeListener that will be notified whenever the reference count changes.
StackTrace	createdHere() Retrieves the stack trace of the point where the object was created.
int	refCount() Returns the current reference count of the resource.
@NotNull List<String>	referencesAsString()
void	release(ReferenceOwner id) Releases the resource by decrementing its reference count by one.
void	releaseLast(ReferenceOwner id) Releases the resource and ensures that this release is the last usage of the resource.
void	removeReferenceChangeListener(ReferenceChangeListener referenceChangeListener) Removes a ReferenceChangeListener previously added via ReferenceCounted.addReferenceChangeListener(ReferenceChangeListener).
void	reserve(ReferenceOwner id) Reserves the resource by incrementing its reference count by one.
void	reserveTransfer(ReferenceOwner from, ReferenceOwner to) Atomically transfers a reservation from one owner to another by incrementing the reference count for the new owner and decrementing it for the old owner.
void	throwExceptionIfNotReleased() Throws an exception if the object has not been released.
void	throwExceptionIfReleased() Throws an exception if the object has been released.
@NotNull String	toString()
boolean	tryReserve(ReferenceOwner id) Attempts to reserve the resource and returns true if successful.
boolean	unmonitored()
void	unmonitored(boolean unmonitored) Sets the monitored state of the object.
void	warnAndReleaseIfNotReleased() Releases any remaining references and logs 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

referenceId, referenceName, temporary

Method Detail

createdHere

public StackTrace createdHere()

Description copied from interface: ReferenceCountedTracer

Retrieves the stack trace of the point where the object was created. This can be useful for debugging and tracking down the origin of the object.

Specified by:

createdHere in interface ReferenceCountedTracer

Returns:

The stack trace where the object was created.

addReferenceChangeListener

public void addReferenceChangeListener(ReferenceChangeListener referenceChangeListener)

Description copied from interface: ReferenceCounted

Adds a ReferenceChangeListener that will be notified whenever the reference count changes. This can be used to monitor the usage of the resource and execute code when certain conditions are met.

Specified by:

addReferenceChangeListener in interface ReferenceCounted

Parameters:

referenceChangeListener - The listener that will receive notifications of reference count changes.

removeReferenceChangeListener

public void removeReferenceChangeListener(ReferenceChangeListener referenceChangeListener)

Description copied from interface: ReferenceCounted

Removes a ReferenceChangeListener previously added via ReferenceCounted.addReferenceChangeListener(ReferenceChangeListener).

Note: Object equality is used to determine which listener to remove, so be cautious if the listener implements the equals method in a non-standard way.

Specified by:

removeReferenceChangeListener in interface ReferenceCounted

Parameters:

referenceChangeListener - The listener to remove.

reserve

public void reserve(ReferenceOwner id)
             throws ClosedIllegalStateException

Description copied from interface: ReferenceCounted

Reserves the resource by incrementing its reference count by one.

It is required to reserve a resource before using it to prevent it from being freed.

Specified by:

reserve in interface ReferenceCounted

Parameters:

id - The unique identifier representing the owner reserving the resource.

Throws:

ClosedIllegalStateException - If the resource has been released or closed. I.e. its reference counter has as some point reached zero.

tryReserve

public boolean tryReserve(ReferenceOwner id)
                   throws ClosedIllegalStateException,
                          IllegalArgumentException

Description copied from interface: ReferenceCounted

Attempts to reserve the resource and returns true if successful. Unlike ReferenceCounted.reserve(ReferenceOwner), this method will not throw an exception if the resource is already freed.

Specified by:

tryReserve in interface ReferenceCounted

Parameters:

id - The unique identifier representing the owner attempting to reserve the resource.

Returns:

true if the resource was successfully reserved, false otherwise.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

IllegalArgumentException - If the reference owner is invalid.

release

public void release(ReferenceOwner id)
             throws ClosedIllegalStateException

Description copied from interface: ReferenceCounted

Releases the resource by decrementing its reference count by one. When the reference count reaches zero, the resource is freed.

Specified by:

release in interface ReferenceCounted

Parameters:

id - The unique identifier representing the owner releasing the resource.

Throws:

ClosedIllegalStateException - If the resource has been released or closed. I.e. its reference counter has as some point reached zero.

reserveTransfer

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

Description copied from interface: ReferenceCounted

Atomically transfers a reservation from one owner to another by incrementing the reference count for the new owner and decrementing it for the old owner.

Specified by:

reserveTransfer in interface ReferenceCounted

Parameters:

from - The unique identifier representing the owner releasing the reservation.

to - The unique identifier representing the owner acquiring the reservation.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

referencesAsString

@NotNull
public @NotNull List<String> referencesAsString()

releaseLast

public void releaseLast(ReferenceOwner id)
                 throws IllegalStateException

Description copied from interface: ReferenceCounted

Releases the resource and ensures that this release is the last usage of the resource. The reference count is decremented and checked to be zero after this release.

Specified by:

releaseLast in interface ReferenceCounted

Parameters:

id - The unique identifier representing the owner releasing the resource.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

refCount

public int refCount()

Description copied from interface: ReferenceCounted

Returns the current reference count of the resource. The reference count indicates the number of owners currently holding reservations to the resource.

Specified by:

refCount in interface ReferenceCounted

Returns:

The current reference count of the resource.

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

throwExceptionIfNotReleased

public void throwExceptionIfNotReleased()
                                 throws IllegalStateException

Description copied from interface: ReferenceCountedTracer

Throws an exception if the object has not been released.

Specified by:

throwExceptionIfNotReleased in interface ReferenceCountedTracer

Throws:

IllegalStateException - If the object has not been released (i.e., its reference count is greater than 0).

throwExceptionIfReleased

public void throwExceptionIfReleased()
                              throws ClosedIllegalStateException

Description copied from interface: ReferenceCountedTracer

Throws an exception if the object has been released.

Specified by:

throwExceptionIfReleased in interface ReferenceCountedTracer

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

warnAndReleaseIfNotReleased

public void warnAndReleaseIfNotReleased()

Description copied from interface: ReferenceCountedTracer

Releases any remaining references and logs a warning if there were any references to release.

This method is intended to be called by a finalizer or in a test to confirm that references are being released correctly.

Note: This method will not trigger any ReferenceChangeListeners as it is mainly used for sanity checks.

Specified by:

warnAndReleaseIfNotReleased in interface ReferenceCountedTracer

unmonitored

public void unmonitored(boolean unmonitored)

Description copied from interface: MonitorReferenceCounted

Sets the monitored state of the object.

Specified by:

unmonitored in interface MonitorReferenceCounted

Parameters:

unmonitored - true to set the object as unmonitored, false to set it as monitored.

unmonitored

public boolean unmonitored()

Specified by:

unmonitored in interface MonitorReferenceCounted

Returns:

true if the object is unmonitored, false if it is monitored.