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

Allows a Java object to view a slice of a BytesStore. Implementations may be remapped to different offsets to avoid copying.

Method Summary

Modifier and Type	Method and Description
default long	address()
@Nullable BytesStore<?,?>	bytesStore()
void	bytesStore(@NotNull BytesStore bytesStore, long offset, long length) Map this object onto a region of bytesStore.
default FileLock	lock(boolean shared) Locks the underlying file.
long	maxSize()
long	offset()
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

Map this object onto a region of bytesStore.

Parameters:

bytesStore - backing store

offset - non-negative offset

length - non-negative length which should match maxSize()

Throws:

IllegalArgumentException - if parameters are out of range

BufferOverflowException - if the region would extend past the end of the store

BufferUnderflowException - if the region would start before 0

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

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

bytesStore

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

Returns:

current backing BytesStore or null if unmapped

offset

long offset()

Returns:

offset within the current BytesStore

address

default long address()
              throws UnsupportedOperationException

Returns:

absolute address of the mapped data if supported

Throws:

UnsupportedOperationException - if not backed by native memory

maxSize

long maxSize()

Returns:

fixed byte size represented by this object

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