net.openhft.chronicle.bytes

Interface RandomDataOutput<R extends RandomDataOutput<R>>

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 RandomDataOutput<R extends RandomDataOutput<R>>

Method Summary

Modifier and Type	Method and Description
long	address(long offset) Obtain the underlying address.
default R	append(long offset, long value, int digits)
default ByteOrder	byteOrder()
Bytes	bytesForRead()
Bytes	bytesForWrite()
default long	capacity()
void	nativeWrite(long address, long position, long size) expert level method to copy data from native memory into the BytesStore
default long	readLimit()
default long	readPosition()
default long	readRemaining()
default long	start()
default R	write(long offsetInRDO, byte[] bytes)
R	write(long offsetInRDO, byte[] bytes, int offset, int length)
void	write(long offsetInRDO, ByteBuffer bytes, int offset, int length)
default R	write(long offsetInRDO, Bytes bytes)
R	write(long offsetInRDO, RandomDataInput bytes, long offset, long length)
default R	writeBoolean(long offset, boolean flag)
R	writeByte(long offset, byte i8)
default R	writeByte(long offset, int i)
R	writeDouble(long offset, double d)
R	writeFloat(long offset, float d)
R	writeInt(long offset, int i)
default long	writeLimit()
R	writeLong(long offset, long i)
R	writeOrderedInt(long offset, int i)
R	writeOrderedLong(long offset, long i)
default long	writePosition()
default long	writeRemaining()
R	writeShort(long offset, short i)
default R	writeUnsignedByte(long offset, int i)
default R	writeUnsignedInt(long offset, long i)
default R	writeUnsignedShort(long offset, int i)
R	zeroOut(long start, long end)

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

close, refCount, release, releaseAll, reserve, tryReserve

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

closeQuietly

Method Detail

writeByte

default R writeByte(long offset,
                    int i)

writeUnsignedByte

default R writeUnsignedByte(long offset,
                            int i)

writeBoolean

default R writeBoolean(long offset,
                       boolean flag)

writeUnsignedShort

default R writeUnsignedShort(long offset,
                             int i)

writeUnsignedInt

default R writeUnsignedInt(long offset,
                           long i)

writeByte

R writeByte(long offset,
            byte i8)

writeShort

R writeShort(long offset,
             short i)

writeInt

R writeInt(long offset,
           int i)

writeOrderedInt

R writeOrderedInt(long offset,
                  int i)

writeLong

R writeLong(long offset,
            long i)

writeOrderedLong

R writeOrderedLong(long offset,
                   long i)

writeFloat

R writeFloat(long offset,
             float d)

writeDouble

R writeDouble(long offset,
              double d)

write

default R write(long offsetInRDO,
                byte[] bytes)

write

R write(long offsetInRDO,
        byte[] bytes,
        int offset,
        int length)

write

void write(long offsetInRDO,
           ByteBuffer bytes,
           int offset,
           int length)

write

default R write(long offsetInRDO,
                Bytes bytes)

write

R write(long offsetInRDO,
        RandomDataInput bytes,
        long offset,
        long length)

zeroOut

R zeroOut(long start,
          long end)

append

default R append(long offset,
                 long value,
                 int digits)

nativeWrite

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

expert level method to copy data from native memory into the BytesStore

Parameters:

address - in native memory to copy from

position - in BytesStore to copy to

size - in bytes

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.