net.openhft.chronicle.bytes.ref

Class BinaryLongReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.bytes.ref.AbstractReference

net.openhft.chronicle.bytes.ref.BinaryLongReference

All Implemented Interfaces:

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

Direct Known Subclasses:

BinaryTwoLongReference

public class BinaryLongReference
extends AbstractReference
implements LongReference

Represents a 64-bit long integer in binary form, backed by a BytesStore.

This class provides various operations to access and manipulate a single long integer in binary form. The long integer is stored in a BytesStore, and this class provides methods for atomic operations, reading/writing the value, and managing its state.

The class also supports volatile reads, ordered writes, and compare-and-swap operations. The maximum size of the backing storage is 8 bytes, corresponding to a 64-bit long integer.

Example usage:

 BytesStore bytesStore = BytesStore.nativeStoreWithFixedCapacity(32);
 try (BinaryLongReference ref = new BinaryLongReference()) {
     ref.bytesStore(bytesStore, 16, 8);
     ref.setValue(1234567890L);
     long value = ref.getVolatileValue();
 }
 

Note: This class is not thread-safe. External synchronization may be necessary if instances are shared between threads.

See Also:

BytesStore, LongReference

Field Summary

Fields

Modifier and Type	Field and Description
static long	LONG_NOT_COMPLETE

Fields inherited from class net.openhft.chronicle.bytes.ref.AbstractReference

bytes, offset

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

closedHere, DISABLE_DISCARD_WARNING, DISABLE_THREAD_SAFETY, STRICT_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
BinaryLongReference()

Method Summary

Modifier and Type	Method and Description
long	addAtomicValue(long delta) Adds a delta to the current 64-bit long value atomically and returns the result.
long	addValue(long delta) Adds a delta to the current 64-bit long value and returns the result.
void	bytesStore(@NotNull BytesStore bytes, long offset, long length) Stores bytes from the given BytesStore into this BinaryLongReference.
boolean	compareAndSwapValue(long expected, long value) Atomically sets the 64-bit long value to the given updated value if the current value is equal to the expected value.
long	getValue() Retrieves the 64-bit long value from the BytesStore.
long	getVolatileValue() Retrieves the 64-bit long value using volatile memory semantics.
long	maxSize() Returns the maximum size of this reference in bytes (8 bytes for a 64-bit long).
void	setOrderedValue(long value) Sets the 64-bit long value using ordered or lazy set memory semantics.
void	setValue(long value) Sets the 64-bit long value in the BytesStore.
void	setVolatileValue(long value) Sets the 64-bit long value using volatile memory semantics.
@NotNull String	toString() Returns a string representation of this BinaryLongReference.

Methods inherited from class net.openhft.chronicle.bytes.ref.AbstractReference

acceptNewBytesStore, address, bytesStore, lock, offset, performClose, tryLock

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

assertCloseable, assertCloseablesClosed, clearUsedByThread, close, createdHere, disableCloseableTracing, disableThreadSafetyCheck, disableThreadSafetyCheck, enableCloseableTracing, gcAndWaitForCloseablesToClose, isClosed, isClosing, isInUserThread, referenceId, resetUsedByThread, 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, getVolatileValue, 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, bytesStore, lock, offset, tryLock

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

referenceName, temporary

Field Detail

LONG_NOT_COMPLETE

public static final long LONG_NOT_COMPLETE

See Also:

Constant Field Values

Constructor Detail

BinaryLongReference

public BinaryLongReference()

Method Detail

bytesStore

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

Stores bytes from the given BytesStore into this BinaryLongReference.

Specified by:

bytesStore in interface Byteable

Overrides:

bytesStore in class AbstractReference

Parameters:

bytes - The BytesStore from which bytes will be stored.

offset - The starting point in bytes from where the value will be stored.

length - The number of bytes that should be stored.

Throws:

IllegalArgumentException - If the length provided is not equal to 8.

BufferOverflowException - If the bytes cannot be written.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

maxSize

public long maxSize()

Returns the maximum size of this reference in bytes (8 bytes for a 64-bit long).

Specified by:

maxSize in interface Byteable

Returns:

the maximum size in bytes

toString

@NotNull
public @NotNull String toString()

Returns a string representation of this BinaryLongReference.

Overrides:

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

Returns:

a string representation

getValue

public long getValue()
              throws IllegalStateException

Retrieves the 64-bit long value from the BytesStore.

Specified by:

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

Returns:

the 64-bit long value

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setValue

public void setValue(long value)
              throws IllegalStateException

Sets the 64-bit long value in the BytesStore.

Specified by:

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

Parameters:

value - the 64-bit long value to set

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

getVolatileValue

public long getVolatileValue()
                      throws IllegalStateException

Retrieves the 64-bit long value using volatile memory semantics.

Specified by:

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

Returns:

the 64-bit long value

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setVolatileValue

public void setVolatileValue(long value)
                      throws IllegalStateException

Sets the 64-bit long value using volatile memory semantics.

Specified by:

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

Parameters:

value - the 64-bit long value to set

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setOrderedValue

public void setOrderedValue(long value)
                     throws IllegalStateException

Sets the 64-bit long value using ordered or lazy set memory semantics.

Specified by:

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

Parameters:

value - the 64-bit long value to set

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

addValue

public long addValue(long delta)
              throws IllegalStateException

Adds a delta to the current 64-bit long value and returns the result.

Specified by:

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

Parameters:

delta - the value to add

Returns:

the resulting 64-bit long value

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

addAtomicValue

public long addAtomicValue(long delta)
                    throws IllegalStateException

Adds a delta to the current 64-bit long value atomically and returns the result.

Specified by:

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

Parameters:

delta - the value to add

Returns:

the resulting 64-bit long value

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

compareAndSwapValue

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

Atomically sets the 64-bit long value to the given updated value if the current value is equal to the expected value.

Specified by:

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

Parameters:

expected - the expected 64-bit long value

value - the new 64-bit long value

Returns:

true if successful, false otherwise

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException