net.openhft.chronicle.core.io

Interface ReferenceCountedTracer

All Superinterfaces:

ReferenceCounted, ReferenceOwner

All Known Subinterfaces:

MonitorReferenceCounted

All Known Implementing Classes:

AbstractCloseableReferenceCounted, AbstractReferenceCounted, TracingReferenceCounted, VanillaReferenceCounted

public interface ReferenceCountedTracer
extends ReferenceCounted

Extends ReferenceCounted with tracing utilities. Implementations record which ReferenceOwner reserved or released a resource and can report where an unexpected release occurred. Tracing is useful when diagnosing ClosedIllegalStateException or ThreadingIllegalStateException thrown by misused resources.

Field Summary

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

INIT, TMP

Method Summary

Modifier and Type	Method and Description
StackTrace	createdHere() Retrieves the stack trace of the point where the object was created.
static @NotNull ReferenceCountedTracer	onReleased(Runnable onRelease, Supplier<String> uniqueId, Class<?> type) Factory method that creates a new instance of .
void	throwExceptionIfNotReleased() Throws an exception if the object has not been released.
default void	throwExceptionIfReleased() Throws an exception if the object has been released.
void	warnAndReleaseIfNotReleased() Releases any remaining references and logs a warning if there were any references to release.

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

addReferenceChangeListener, refCount, release, releaseLast, releaseLast, removeReferenceChangeListener, reserve, reserveTransfer, tryReserve

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

referenceId, referenceName, temporary

Method Detail

onReleased

@NotNull
static @NotNull ReferenceCountedTracer onReleased(Runnable onRelease,
                                                           Supplier<String> uniqueId,
                                                           Class<?> type)

Factory method that creates a new instance of . The instance returned is based on the resource tracing configuration of the JVM.

Parameters:

onRelease - The Runnable that will be executed when the object is released.

uniqueId - A Supplier of unique identifiers for the object. It should provide a unique string identifier for each invocation.

type - The Class representing the type of the object being reference counted.

Returns:

A new instance of .

throwExceptionIfReleased

default void throwExceptionIfReleased()
                               throws ClosedIllegalStateException

Throws an exception if the object has been released.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

warnAndReleaseIfNotReleased

void warnAndReleaseIfNotReleased()
                          throws ClosedIllegalStateException

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.

Throws:

ClosedIllegalStateException - If the object has not been released.

throwExceptionIfNotReleased

void throwExceptionIfNotReleased()
                          throws IllegalStateException

Throws an exception if the object has not been released.

Throws:

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

createdHere

StackTrace createdHere()

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.

Returns:

The stack trace where the object was created.