net.openhft.chronicle.core.io

Interface ReferenceOwner

All Known Subinterfaces:

MonitorReferenceCounted, ReferenceCounted, ReferenceCountedTracer

All Known Implementing Classes:

AbstractCloseable, AbstractCloseableReferenceCounted, AbstractReferenceCounted, SimpleCloseable, TracingReferenceCounted, UnsafeCloseable, VanillaReferenceCounted, VanillaReferenceOwner

public interface ReferenceOwner

Represents an entity that owns a reference, typically for resource management. This interface provides default methods for generating unique reference IDs and human-readable names for reference owners.

This can be useful, for example, in scenarios where it's necessary to track the owners of resources such as file handles, network sockets, or any other entities that need to be managed throughout their lifecycle.

Implementations of this interface can be used to associate owners with references, making it easier to monitor, debug, and manage resource ownership and ensure that resources are released properly.

Field Summary

Fields

Modifier and Type	Field and Description
static ReferenceOwner	INIT A predefined ReferenceOwner instance representing an initial reference.
static ReferenceOwner	TMP A predefined ReferenceOwner instance representing a temporary reference.

Method Summary

Modifier and Type	Method and Description
default int	referenceId() Returns a unique identifier (ID) for this reference owner.
default String	referenceName() Returns a human-readable name for this reference owner.
static ReferenceOwner	temporary(String name) Creates and returns a temporary with the given name.

Field Detail

INIT

static final ReferenceOwner INIT

A predefined ReferenceOwner instance representing an initial reference. This instance is intended to be used as the first owner when none is provided.

TMP

static final ReferenceOwner TMP

A predefined ReferenceOwner instance representing a temporary reference. This can be used as a placeholder owner for temporary references, typically those which do not have a clearly defined long-term owner.

Method Detail

temporary

static ReferenceOwner temporary(String name)

Creates and returns a temporary with the given name.

When resource tracing is enabled, a new VanillaReferenceOwner is created with the specified name. Otherwise, the predefined TMP instance is returned, regardless of the provided name.

Parameters:

name - The name to be assigned to the temporary reference owner, used for identification and debugging purposes.

Returns:

A temporary instance.

referenceId

default int referenceId()

Returns a unique identifier (ID) for this reference owner. The ID can be used for tracking and managing resources owned by this instance.

The default implementation uses the identity hash code of this reference owner instance as the ID.

Returns:

An integer representing the unique reference ID of this owner.

referenceName

default String referenceName()

Returns a human-readable name for this reference owner. This name can be used for identification, debugging, and logging purposes.

The default implementation generates a name using the simple class name of the reference owner, followed by '@', and then the reference ID encoded in base 36.

Returns:

A string representing the human-readable name of this reference owner.