net.openhft.chronicle.bytes

Interface RandomDataInput

All Known Subinterfaces:

Bytes<Underlying>, BytesStore<B,Underlying>

All Known Implementing Classes:

AbstractBytes, ExpectedBytesStore, HeapBytesStore, MappedBytes, MappedBytesStore, NativeBytes, NativeBytesStore, NoBytesStore, PointerBytesStore, UncheckedBytes, VanillaBytes

public interface RandomDataInput

This allows random access to the underling bytes. This instance can be used across threads as it is stateless. The thread safety of the underlying data depends on how the methods are used.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	charToString

Method Summary

Modifier and Type	Method and Description
long	address(long offset) Obtain the underlying address.
default ByteOrder	byteOrder()
default boolean	bytesEqual(long offset, RandomDataInput second, long secondOffset, long len) Deprecated. use BytesUtil.bytesEqual(net.openhft.chronicle.bytes.RandomDataInput, long, net.openhft.chronicle.bytes.RandomDataInput, long, long)
Bytes	bytesForRead()
Bytes	bytesForWrite()
default long	capacity()
default void	copyTo(byte[] bytes)
static String[]	createCharToString()
void	nativeRead(long position, long address, long size) expert level method for copying data to native memory.
default long	parseLong(long offset)
default String	printable(long offset)
default boolean	readBoolean(long offset)
byte	readByte(long offset)
double	readDouble(long offset)
float	readFloat(long offset)
default long	readIncompleteLong(long offset)
int	readInt(long offset)
default long	readLimit()
long	readLong(long offset)
default long	readPosition()
default long	readRemaining()
short	readShort(long offset)
default int	readUnsignedByte(long offset)
default long	readUnsignedInt(long offset)
default int	readUnsignedShort(long offset)
default int	readVolatileInt(long offset)
default long	readVolatileLong(long offset)
long	realCapacity()
default long	start()
default long	writeLimit()
default long	writePosition()
default long	writeRemaining()

Methods inherited from interface net.openhft.chronicle.core.ReferenceCounted

close, refCount, release, release, releaseAll, reserve, tryReserve

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

closeQuietly

Field Detail

charToString

static final String[] charToString

Method Detail

createCharToString

@NotNull
static String[] createCharToString()

readBoolean

default boolean readBoolean(long offset)

readByte

byte readByte(long offset)

readUnsignedByte

default int readUnsignedByte(long offset)

readShort

short readShort(long offset)

readUnsignedShort

default int readUnsignedShort(long offset)

readInt

int readInt(long offset)

readUnsignedInt

default long readUnsignedInt(long offset)

readLong

long readLong(long offset)

readFloat

float readFloat(long offset)

readDouble

double readDouble(long offset)

printable

default String printable(long offset)

readVolatileInt

default int readVolatileInt(long offset)

readVolatileLong

default long readVolatileLong(long offset)

parseLong

default long parseLong(long offset)

nativeRead

void nativeRead(long position,
                long address,
                long size)

expert level method for copying data to native memory.

Parameters:

position - within the ByteStore to copy.

address - in native memory

size - in bytes

bytesEqual

@Deprecated
default boolean bytesEqual(long offset,
                                       @NotNull
                                       RandomDataInput second,
                                       long secondOffset,
                                       long len)

Deprecated. use BytesUtil.bytesEqual(net.openhft.chronicle.bytes.RandomDataInput, long, net.openhft.chronicle.bytes.RandomDataInput, long, long)

copyTo

default void copyTo(@NotNull
                    byte[] bytes)

readIncompleteLong

default long readIncompleteLong(long offset)

realCapacity

long realCapacity()

start

default long start()

Returns:

The smallest position allowed in this buffer.

capacity

default long capacity()

Returns:

the highest limit allowed for this buffer.

readPosition

default long readPosition()

writePosition

default long writePosition()

readRemaining

default long readRemaining()

writeRemaining

default long writeRemaining()

readLimit

default long readLimit()

Returns:

the highest offset or position allowed for this buffer.

writeLimit

default long writeLimit()

address

long address(long offset)
      throws UnsupportedOperationException

Obtain the underlying address. This is for expert users only.

Parameters:

offset - within this buffer. address(start()) is the actual address of the first byte.

Returns:

the underlying address of the buffer

Throws:

UnsupportedOperationException - if the underlying buffer is on the heap

byteOrder

default ByteOrder byteOrder()

bytesForRead

Bytes bytesForRead()

Returns:

the streaming bytes for reading.

bytesForWrite

Bytes bytesForWrite()

Returns:

the streaming bytes for writing.