net.openhft.chronicle.bytes

Interface Byteable

All Known Subinterfaces:

ByteableIntArrayValues, ByteableLongArrayValues, LongReference, TwoLongReference

All Known Implementing Classes:

AbstractReference, BinaryBooleanReference, BinaryIntArrayReference, BinaryIntReference, BinaryLongArrayReference, BinaryLongReference, BinaryTwoLongReference, GuardedNativeBytes, NativeBytes, OnHeapBytes, SubBytes, TextBooleanReference, TextIntArrayReference, TextIntReference, TextLongArrayReference, TextLongReference, UncheckedLongReference, VanillaBytes

public interface Byteable

An interface for a reference to off-heap memory, acting as a proxy for memory residing outside the heap. This allows the reference to be reassigned, facilitating dynamic memory management.

Method Summary

Modifier and Type	Method and Description
default long	address() Returns the absolute address in the memory to which this object currently points.
@Nullable BytesStore<?,?>	bytesStore() Returns the ByteStore to which this object currently points.
void	bytesStore(@NotNull BytesStore bytesStore, long offset, long length) Sets the reference to a data type that points to the underlying ByteStore.
default FileLock	lock(boolean shared) Locks the underlying file.
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.
default FileLock	tryLock(boolean shared) Attempts to lock the underlying file without blocking.

Method Detail

bytesStore

void bytesStore(@NotNull
                @NotNull BytesStore bytesStore,
                long offset,
                long length)
         throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                IllegalArgumentException,
                BufferOverflowException,
                BufferUnderflowException,
                net.openhft.chronicle.core.io.ThreadingIllegalStateException

Sets the reference to a data type that points to the underlying ByteStore.

Parameters:

bytesStore - the fixed-point ByteStore

offset - the offset within the ByteStore, indicating the starting point of the memory section

length - the length of the memory section within the ByteStore

Throws:

IllegalArgumentException - If the provided arguments are invalid

BufferOverflowException - If the new memory section extends beyond the end of the ByteStore

BufferUnderflowException - If the new memory section starts before the start of the ByteStore

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

bytesStore

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

Returns the ByteStore to which this object currently points.

Returns:

the ByteStore or null if it's not set

offset

long offset()

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

Returns:

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

address

default long address()
              throws UnsupportedOperationException

Returns the absolute address in the memory to which this object currently points.

Returns:

the absolute address in the memory

Throws:

UnsupportedOperationException - If the address is not set or the underlying ByteStore isn't native

maxSize

long maxSize()

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

Returns:

the maximum size in bytes for this reference

lock

default FileLock lock(boolean shared)
               throws IOException

Locks the underlying file.

Parameters:

shared - true if the lock is shared, false if it's exclusive

Returns:

the FileLock object representing the lock

Throws:

IOException - If an error occurs while locking the file

UnsupportedOperationException - If the underlying implementation does not support file locking

tryLock

default FileLock tryLock(boolean shared)
                  throws IOException

Attempts to lock the underlying file without blocking.

Parameters:

shared - true if the lock is shared, false if it's exclusive

Returns:

the FileLock object if the lock was acquired successfully; null otherwise

Throws:

IOException - If an error occurs while trying to lock the file

UnsupportedOperationException - If the underlying implementation does not support file locking