net.openhft.chronicle.core.io

Interface ReferenceCounted

All Superinterfaces:

ReferenceOwner

All Known Subinterfaces:

MonitorReferenceCounted, ReferenceCountedTracer

All Known Implementing Classes:

AbstractCloseableReferenceCounted, AbstractReferenceCounted, DualReferenceCounted, TracingReferenceCounted, VanillaReferenceCounted

public interface ReferenceCounted
extends ReferenceOwner

A resource which is reference counted and freed when the refCount drop to 0.

Field Summary

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

INIT

Method Summary

Modifier and Type	Method and Description
int	refCount() Returns the reference count for this resource.
void	release(ReferenceOwner id) Releases a resource.
default void	releaseLast()
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.
boolean	reservedBy(ReferenceOwner owner) Best effort check the owner has reserved it.
default void	reserveTransfer(ReferenceOwner from, ReferenceOwner to)
boolean	tryReserve(ReferenceOwner id) Tries to reserve a resource and returns if the resource could be successfully reserved.

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

referenceId, referenceName, temporary

Method Detail

reserve

void reserve(ReferenceOwner id)
      throws IllegalStateException

Reserves a resource or throws an Exception.

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

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

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

Throws:

IllegalStateException

tryReserve

boolean tryReserve(ReferenceOwner id)
            throws IllegalStateException

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.

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.

reservedBy

boolean reservedBy(ReferenceOwner owner)

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

Parameters:

owner - to check

Returns:

false if the owner definitely doesn't own it.

release

void release(ReferenceOwner id)
      throws IllegalStateException

Releases a resource.

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

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

void releaseLast(ReferenceOwner id)
          throws IllegalStateException

Releases a resource and checks this is the last usage.

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

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

default void releaseLast()
                  throws IllegalStateException

Throws:

IllegalStateException

refCount

int refCount()

Returns the reference count for this resource.

Returns:

the reference count for this resource