net.openhft.chronicle.bytes.ref

Class UncheckedLongReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.core.io.UnsafeCloseable

net.openhft.chronicle.bytes.ref.UncheckedLongReference

All Implemented Interfaces:

Closeable, AutoCloseable, Byteable, LongReference, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.Monitorable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.io.SingleThreadedChecked, net.openhft.chronicle.core.values.LongValue

public class UncheckedLongReference
extends net.openhft.chronicle.core.io.UnsafeCloseable
implements LongReference, net.openhft.chronicle.core.io.ReferenceOwner

A class for managing references to long values stored in a BytesStore without performing bounds checking. This class is optimized for high performance in scenarios involving off-heap memory or memory-mapped files where bounds checks could impair performance.

This class is thread-safe provided that external synchronization is applied. It uses different implementations based on the JVM's debug status: in debug mode, it uses BinaryLongReference for safety checks; otherwise, it uses UncheckedLongReference for better performance.

See Also:

LongReference, ReferenceOwner, UnsafeCloseable, BytesStore, BinaryLongReference

Field Summary

Fields inherited from class net.openhft.chronicle.core.io.UnsafeCloseable

address, unsafe

Fields inherited from class net.openhft.chronicle.core.io.AbstractCloseable

closedHere, DISABLE_DISCARD_WARNING, 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

Constructor and Description
UncheckedLongReference()

Method Summary

Modifier and Type	Method and Description
long	addAtomicValue(long delta)
long	addValue(long delta)
@NotNull BytesStore<?,?>	bytesStore() Returns the ByteStore to which this object currently points.
void	bytesStore(@NotNull BytesStore bytes, long offset, long length) Associates this UncheckedLongReference with a BytesStore, specifying where the long value is stored and its length.
boolean	compareAndSwapValue(long expected, long value)
static @NotNull LongReference	create(@NotNull BytesStore<?,?> bytesStore, long offset, int size) Factory method to create a UncheckedLongReference or BinaryLongReference based on the JVM's debug status.
long	getValue()
long	getVolatileValue()
long	getVolatileValue(long closedValue)
long	maxSize() Returns the maximum size in bytes that this reference can point to.
long	offset() Returns the offset within the ByteStore to which this object currently points.
protected void	performClose()
void	setOrderedValue(long value)
void	setValue(long value)
void	setVolatileValue(long value)
@NotNull String	toString()

Methods inherited from class net.openhft.chronicle.core.io.UnsafeCloseable

addAtomicLong, addLong, address, compareAndSwapLong, getLong, getVolatileLong, getVolatileLong, setLong, setOrderedLong, setVolatileLong

Methods inherited from class net.openhft.chronicle.core.io.AbstractCloseable

assertCloseable, assertCloseablesClosed, close, createdHere, disableCloseableTracing, enableCloseableTracing, gcAndWaitForCloseablesToClose, isClosed, isClosing, isInUserThread, referenceId, shouldPerformCloseInBackground, shouldWaitForClosed, singleThreadedCheckDisabled, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfClosed, throwExceptionIfClosedInSetter, unmonitor, waitForCloseablesToClose, waitForClosed, warnAndCloseIfNotClosed

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

close, isClosed, setMaxValue, setMinValue

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

closeQuietly, closeQuietly

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

isClosing

Methods inherited from interface net.openhft.chronicle.bytes.Byteable

address, lock, tryLock

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

referenceId, referenceName, temporary

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

unmonitor

Constructor Detail

UncheckedLongReference

public UncheckedLongReference()

Method Detail

create

@NotNull
public static @NotNull LongReference create(@NotNull
                                                     @NotNull BytesStore<?,?> bytesStore,
                                                     long offset,
                                                     int size)
                                              throws IllegalArgumentException,
                                                     BufferOverflowException,
                                                     BufferUnderflowException,
                                                     IllegalStateException

Factory method to create a UncheckedLongReference or BinaryLongReference based on the JVM's debug status. This method initializes the reference with a specific BytesStore, offset, and size.

Parameters:

bytesStore - The BytesStore used to store the long value.

offset - The offset within the BytesStore where the long value starts.

size - The size in bytes of the long value (expected to be 8 for a long).

Returns:

a new LongReference instance appropriate for the JVM debug status.

Throws:

IllegalArgumentException - If the provided size does not match the expected size of a long.

BufferOverflowException - If the offset and size exceed the bounds of the BytesStore.

BufferUnderflowException - If the offset is negative or not within the bounds of the BytesStore.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the BytesStore has already been closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this method is called from multiple threads without proper synchronization.

IllegalStateException

bytesStore

public void bytesStore(@NotNull
                       @NotNull BytesStore bytes,
                       long offset,
                       long length)
                throws IllegalStateException,
                       IllegalArgumentException,
                       BufferUnderflowException

Associates this UncheckedLongReference with a BytesStore, specifying where the long value is stored and its length.

Specified by:

bytesStore in interface Byteable

Parameters:

bytes - the BytesStore containing the long value.

offset - the offset within the BytesStore where the long value starts.

length - the length in bytes of the long value (expected to be 8).

Throws:

IllegalArgumentException - If the specified length does not match the expected size of a long.

BufferUnderflowException - If the specified length and offset are out of the bounds of the BytesStore.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If this reference or the BytesStore has been closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this method is accessed by multiple threads without proper synchronization.

IllegalStateException

bytesStore

@NotNull
public @NotNull BytesStore<?,?> bytesStore()

Description copied from interface: Byteable

Returns the ByteStore to which this object currently points.

Specified by:

bytesStore in interface Byteable

Returns:

the ByteStore or null if it's not set

offset

public long offset()

Description copied from interface: Byteable

Returns the offset within the ByteStore to which this object currently points.

Specified by:

offset in interface Byteable

Returns:

the offset within the ByteStore (not the physical memory address)

maxSize

public long maxSize()

Description copied from interface: Byteable

Returns the maximum size in bytes that this reference can point to.

Specified by:

maxSize in interface Byteable

Returns:

the maximum size in bytes for this reference

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class net.openhft.chronicle.core.io.AbstractCloseable

getValue

public long getValue()
              throws IllegalStateException

Specified by:

getValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

setValue

public void setValue(long value)
              throws IllegalStateException

Specified by:

setValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

getVolatileValue

public long getVolatileValue()
                      throws IllegalStateException

Specified by:

getVolatileValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

setVolatileValue

public void setVolatileValue(long value)
                      throws IllegalStateException

Specified by:

setVolatileValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

getVolatileValue

public long getVolatileValue(long closedValue)

Specified by:

getVolatileValue in interface net.openhft.chronicle.core.values.LongValue

setOrderedValue

public void setOrderedValue(long value)
                     throws IllegalStateException

Specified by:

setOrderedValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

addValue

public long addValue(long delta)
              throws IllegalStateException

Specified by:

addValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

addAtomicValue

public long addAtomicValue(long delta)
                    throws IllegalStateException

Specified by:

addAtomicValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

compareAndSwapValue

public boolean compareAndSwapValue(long expected,
                                   long value)
                            throws IllegalStateException

Specified by:

compareAndSwapValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

performClose

protected void performClose()
                     throws IllegalStateException

Overrides:

performClose in class net.openhft.chronicle.core.io.UnsafeCloseable

Throws:

IllegalStateException