net.openhft.chronicle.bytes.ref

Class BinaryLongArrayReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.bytes.ref.AbstractReference

net.openhft.chronicle.bytes.ref.BinaryLongArrayReference

All Implemented Interfaces:

Closeable, AutoCloseable, Byteable, BytesMarshallable, CommonMarshallable, DynamicallySized, ReadBytesMarshallable, ByteableLongArrayValues, WriteBytesMarshallable, 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.LongArrayValues

public class BinaryLongArrayReference
extends AbstractReference
implements ByteableLongArrayValues, BytesMarshallable

Array of 64-bit values stored as [capacity][used][values...] in little-endian order. The value region starts at offset VALUES and each entry is shifted by SHIFT bytes.

Example usage:

 BytesStore bytesStore = BytesStore.nativeStoreWithFixedCapacity(32);
 BinaryLongArrayReference ref = new BinaryLongArrayReference(4); // Creates an array with 4 longs
 ref.bytesStore(bytesStore, 0, ref.maxSize());
 ref.setValueAt(0, 1234567890L);
 long value = ref.getValueAt(0);
 

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

See Also:

BytesStore, BinaryLongReference

Field Summary

Fields

Modifier and Type	Field and Description
static long	MAX_CAPACITY
static int	SHIFT

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

bytesStore, offset

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
BinaryLongArrayReference() Constructs a BinaryLongArrayReference with a default capacity of 0.
BinaryLongArrayReference(long defaultCapacity) Constructs a BinaryLongArrayReference with the specified default capacity.

Method Summary

Modifier and Type	Method and Description
protected void	acceptNewBytesStore(@NotNull BytesStore<?,?> bytes) Updates the BytesStore for this reference, releasing any previous BytesStore
void	bindValueAt(long index, @NotNull net.openhft.chronicle.core.values.LongValue value)
@Nullable BytesStore<?,?>	bytesStore() Returns the BytesStore that backs this reference, or null if none is set.
void	bytesStore(@NotNull BytesStore bytes, long offset, long length) Sets the underlying BytesStore together with the offset and length.
ByteableLongArrayValues	capacity(long arrayLength) Sets the capacity of the array as a count of elements, not bytes.
boolean	compareAndSet(long index, long expected, long value)
static void	forceAllToNotCompleteState() Sets all values in the BinaryLongArrayReference instances to the "not complete" state.
long	getCapacity()
long	getUsed()
long	getValueAt(long index)
long	getVolatileValueAt(long index)
boolean	isNull()
static void	lazyWrite(@NotNull Bytes<?> bytes, long capacity) Lazily writes to the provided Bytes object with the given capacity.
long	maxSize()
long	offset() Returns the byte offset relative to the start of the associated store.
static long	peakLength(@NotNull BytesStore<?,?> bytes, long offset) Returns the capacity from the BytesStore object and adding the fixed values size to get a length.
static long	peakLength(@NotNull BytesStore<?,?> bytes, long offset, long capacityHint) Returns the capacity from the BytesStore object, adding the fixed values size to get a length If the read capacity is 0, the method writes the capacityHint at the offset and updates the capacity with the capacityHint.
void	readMarshallable(BytesIn<?> bytes) Reads data from the provided BytesIn object.
void	reset()
void	setMaxUsed(long usedAtLeast)
void	setOrderedValueAt(long index, long value)
void	setUsed(long used)
void	setValueAt(long index, long value)
long	sizeInBytes(long capacity) Calculates the byte size required to hold the provided element capacity.
static void	startCollecting() Enables collection of BinaryLongArrayReference instances.
@NotNull String	toString()
static void	write(@NotNull Bytes<?> bytes, long capacity) Writes to the provided Bytes object with the given capacity.
void	writeMarshallable(BytesOut<?> bytes) Writes this object's state to bytes using a custom binary format.

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

address, lock, performClose, tryLock, unmonitor

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, 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.io.Closeable

close, closeQuietly, closeQuietly

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

isClosed, isClosing

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

address, lock, tryLock

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

$toString, usesSelfDescribingMessage

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

referenceName, temporary

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

unmonitor

Field Detail

SHIFT

public static final int SHIFT

See Also:

Constant Field Values

MAX_CAPACITY

public static final long MAX_CAPACITY

See Also:

Constant Field Values

Constructor Detail

BinaryLongArrayReference

public BinaryLongArrayReference()

Constructs a BinaryLongArrayReference with a default capacity of 0.

BinaryLongArrayReference

public BinaryLongArrayReference(long defaultCapacity)

Constructs a BinaryLongArrayReference with the specified default capacity.

Parameters:

defaultCapacity - the initial capacity of the long array in number of elements.

Method Detail

startCollecting

public static void startCollecting()

Enables collection of BinaryLongArrayReference instances.

This method is used for debugging and monitoring. It should not be used in production environments.

forceAllToNotCompleteState

public static void forceAllToNotCompleteState()
                                       throws IllegalStateException,
                                              BufferOverflowException

Sets all values in the BinaryLongArrayReference instances to the "not complete" state.

This method is used for debugging and monitoring. It should not be used in production environments.

Throws:

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

acceptNewBytesStore

protected void acceptNewBytesStore(@NotNull
                                   @NotNull BytesStore<?,?> bytes)
                            throws IllegalStateException

Description copied from class: AbstractReference

Updates the BytesStore for this reference, releasing any previous BytesStore

Overrides:

acceptNewBytesStore in class AbstractReference

Parameters:

bytes - the new BytesStore

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

write

public static void write(@NotNull
                         @NotNull Bytes<?> bytes,
                         long capacity)
                  throws BufferOverflowException,
                         IllegalArgumentException,
                         IllegalStateException

Writes to the provided Bytes object with the given capacity. The method asserts that the write position is correctly aligned, then writes the capacity, followed by a long value of 0 (representing the "used" space), and finally zeros out the subsequent space defined by the capacity.

Parameters:

bytes - the Bytes object to write to.

capacity - the capacity to be written and used for subsequent zeroing.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

IllegalArgumentException - If arguments violate precondition constraints.

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

lazyWrite

public static void lazyWrite(@NotNull
                             @NotNull Bytes<?> bytes,
                             long capacity)
                      throws BufferOverflowException,
                             IllegalStateException

Lazily writes to the provided Bytes object with the given capacity. Unlike the write method, this method does not zero out the subsequent space. It just updates the write position after writing the capacity and "used" space.

Parameters:

bytes - the Bytes object to write to.

capacity - the capacity to be written.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

peakLength

public static long peakLength(@NotNull
                              @NotNull BytesStore<?,?> bytes,
                              long offset)
                       throws BufferUnderflowException,
                              IllegalStateException

Returns the capacity from the BytesStore object and adding the fixed values size to get a length. It asserts that the capacity is greater than 0.

Parameters:

bytes - the BytesStore object to read from.

offset - the offset at which to start reading.

Returns:

the calculated peak length.

Throws:

BufferUnderflowException - If there is not enough remaining data.

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

peakLength

public static long peakLength(@NotNull
                              @NotNull BytesStore<?,?> bytes,
                              long offset,
                              long capacityHint)
                       throws BufferUnderflowException,
                              IllegalStateException

Returns the capacity from the BytesStore object, adding the fixed values size to get a length If the read capacity is 0, the method writes the capacityHint at the offset and updates the capacity with the capacityHint. It asserts that the capacity is greater than 0.

Parameters:

bytes - the BytesStore object to read from.

offset - the offset at which to start reading.

capacityHint - the capacity to be used if the initial capacity is 0.

Returns:

the calculated peak length.

Throws:

BufferUnderflowException - If there is not enough remaining data.

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

getCapacity

public long getCapacity()
                 throws IllegalStateException

Specified by:

getCapacity in interface net.openhft.chronicle.core.values.LongArrayValues

Throws:

IllegalStateException

getUsed

public long getUsed()
             throws IllegalStateException,
                    BufferUnderflowException

Specified by:

getUsed in interface net.openhft.chronicle.core.values.LongArrayValues

Throws:

IllegalStateException

BufferUnderflowException

setMaxUsed

public void setMaxUsed(long usedAtLeast)
                throws IllegalStateException,
                       BufferUnderflowException

Specified by:

setMaxUsed in interface net.openhft.chronicle.core.values.LongArrayValues

Throws:

IllegalStateException

BufferUnderflowException

setUsed

public void setUsed(long used)
             throws IllegalStateException,
                    BufferUnderflowException

Specified by:

setUsed in interface net.openhft.chronicle.core.values.LongArrayValues

Throws:

IllegalStateException

BufferUnderflowException

getValueAt

public long getValueAt(long index)
                throws BufferUnderflowException,
                       IllegalStateException

Specified by:

getValueAt in interface net.openhft.chronicle.core.values.LongArrayValues

Throws:

BufferUnderflowException

IllegalStateException

setValueAt

public void setValueAt(long index,
                       long value)
                throws BufferOverflowException,
                       IllegalStateException

Specified by:

setValueAt in interface net.openhft.chronicle.core.values.LongArrayValues

Throws:

BufferOverflowException

IllegalStateException

getVolatileValueAt

public long getVolatileValueAt(long index)
                        throws BufferUnderflowException,
                               IllegalStateException

Specified by:

getVolatileValueAt in interface net.openhft.chronicle.core.values.LongArrayValues

Throws:

BufferUnderflowException

IllegalStateException

bindValueAt

public void bindValueAt(long index,
                        @NotNull
                        @NotNull net.openhft.chronicle.core.values.LongValue value)
                 throws IllegalStateException,
                        BufferOverflowException

Specified by:

bindValueAt in interface net.openhft.chronicle.core.values.LongArrayValues

Throws:

IllegalStateException

BufferOverflowException

setOrderedValueAt

public void setOrderedValueAt(long index,
                              long value)
                       throws BufferOverflowException,
                              IllegalStateException

Specified by:

setOrderedValueAt in interface net.openhft.chronicle.core.values.LongArrayValues

Throws:

BufferOverflowException

IllegalStateException

bytesStore

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

Description copied from class: AbstractReference

Sets the underlying BytesStore together with the offset and length.

Specified by:

bytesStore in interface Byteable

Overrides:

bytesStore in class AbstractReference

Parameters:

bytes - the BytesStore providing the backing memory

offset - the non-negative offset within the store

length - the number of bytes this reference spans

Throws:

IllegalArgumentException - if length does not match Byteable.maxSize()

net.openhft.chronicle.core.io.ClosedIllegalStateException - if the store is closed

net.openhft.chronicle.core.io.ThreadingIllegalStateException - if accessed from the wrong thread

BufferOverflowException - if the region exceeds the store capacity

IllegalStateException

readMarshallable

public void readMarshallable(BytesIn<?> bytes)
                      throws net.openhft.chronicle.core.io.IORuntimeException,
                             IllegalStateException,
                             BufferUnderflowException

Description copied from interface: BytesMarshallable

Reads data from the provided BytesIn object. Implementations of this method are responsible for handling their own data reading logic based on the structure of the data they expect to read.

Note: Implementations are also responsible for calling Validatable.validate() when necessary.

Specified by:

readMarshallable in interface BytesMarshallable

Specified by:

readMarshallable in interface ReadBytesMarshallable

Parameters:

bytes - The BytesIn instance to read data from.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If an I/O error occurs during reading.

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

BufferUnderflowException - If there is not enough data in the buffer to read.

IllegalStateException

writeMarshallable

public void writeMarshallable(BytesOut<?> bytes)
                       throws IllegalStateException,
                              BufferOverflowException,
                              BufferUnderflowException

Description copied from interface: BytesMarshallable

Writes this object's state to bytes using a custom binary format. Implementations may validate their state prior to writing and throw InvalidMarshallableException if invalid.

Specified by:

writeMarshallable in interface BytesMarshallable

Specified by:

writeMarshallable in interface WriteBytesMarshallable

Parameters:

bytes - the target stream

Throws:

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

net.openhft.chronicle.core.io.ThreadingIllegalStateException - if accessed by multiple threads in an unsafe way

BufferOverflowException - if there is insufficient space in the buffer

IllegalStateException

BufferUnderflowException

isNull

public boolean isNull()
               throws IllegalStateException

Specified by:

isNull in interface net.openhft.chronicle.core.values.LongArrayValues

Throws:

IllegalStateException

reset

public void reset()
           throws IllegalStateException

Specified by:

reset in interface net.openhft.chronicle.core.values.LongArrayValues

Throws:

IllegalStateException

bytesStore

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

Description copied from class: AbstractReference

Returns the BytesStore that backs this reference, or null if none is set.

Specified by:

bytesStore in interface Byteable

Overrides:

bytesStore in class AbstractReference

Returns:

current backing BytesStore or null if unmapped

offset

public long offset()

Description copied from class: AbstractReference

Returns the byte offset relative to the start of the associated store.

Specified by:

offset in interface Byteable

Overrides:

offset in class AbstractReference

Returns:

offset within the current BytesStore

maxSize

public long maxSize()

Specified by:

maxSize in interface Byteable

Returns:

fixed byte size represented by this object

toString

@NotNull
public @NotNull String toString()

Overrides:

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

sizeInBytes

public long sizeInBytes(long capacity)
                 throws IllegalStateException

Description copied from interface: ByteableLongArrayValues

Calculates the byte size required to hold the provided element capacity.

Specified by:

sizeInBytes in interface ByteableLongArrayValues

Specified by:

sizeInBytes in interface net.openhft.chronicle.core.values.LongArrayValues

Parameters:

capacity - the number of elements

Returns:

total bytes needed for this capacity

Throws:

IllegalStateException

capacity

public ByteableLongArrayValues capacity(long arrayLength)
                                 throws IllegalStateException

Description copied from interface: ByteableLongArrayValues

Sets the capacity of the array as a count of elements, not bytes.

Specified by:

capacity in interface ByteableLongArrayValues

Parameters:

arrayLength - the desired element count

Returns:

this instance for chaining

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

compareAndSet

public boolean compareAndSet(long index,
                             long expected,
                             long value)
                      throws BufferOverflowException,
                             IllegalStateException

Specified by:

compareAndSet in interface net.openhft.chronicle.core.values.LongArrayValues

Throws:

BufferOverflowException

IllegalStateException