net.openhft.chronicle.bytes

Interface Byteable<B extends BytesStore<B,U>,U>

Type Parameters:

B - Bytes type

U - Underlying type

All Known Subinterfaces:

ByteableIntArrayValues, ByteableLongArrayValues, LongReference, TwoLongReference

All Known Implementing Classes:

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

public interface Byteable<B extends BytesStore<B,U>,U>

This Interface allows a reference to off heap memory to be reassigned.

A reference to off heap memory is a proxy for some memory which sits outside the heap.

Method Summary

Modifier and Type	Method and Description
default long	address()
@Nullable BytesStore<B,U>	bytesStore()
void	bytesStore(@NotNull BytesStore<B,U> bytesStore, long offset, long length) This setter for a data type which points to an underlying ByteStore.
default FileLock	lock(boolean shared) Calls lock on the underlying file
long	maxSize()
long	offset()
default FileLock	tryLock(boolean shared) Calls lock on the underlying file

Method Detail

bytesStore

void bytesStore(@NotNull
                @NotNull BytesStore<B,U> bytesStore,
                long offset,
                long length)
         throws IllegalStateException,
                IllegalArgumentException,
                BufferOverflowException,
                BufferUnderflowException

This setter for a data type which points to an underlying ByteStore.

Parameters:

bytesStore - the fix point ByteStore

offset - the offset within the ByteStore

length - the length in the ByteStore

Throws:

IllegalStateException

IllegalArgumentException

BufferOverflowException

BufferUnderflowException

bytesStore

@Nullable
@Nullable BytesStore<B,U> bytesStore()

offset

long offset()

Returns:

The offset within the BytesStore (not the address)

address

default long address()
              throws UnsupportedOperationException

Returns:

The absolute address

Throws:

UnsupportedOperationException - if not set ot the underlying byteStore isn't native.

maxSize

long maxSize()

Returns:

the maximum size in byte for this reference.

lock

default FileLock lock(boolean shared)
               throws IOException

Calls lock on the underlying file

Parameters:

shared - if the lock is shared or not.

Returns:

the FileLock

Throws:

IOException

tryLock

default FileLock tryLock(boolean shared)
                  throws IOException

Calls lock on the underlying file

Parameters:

shared - if the lock is shared or not.

Returns:

the FileLock

Throws:

IOException