net.openhft.chronicle.bytes

Interface BytesOut<Underlying>

All Superinterfaces:

Appendable, BytesComment<BytesOut<Underlying>>, BytesPrepender<Bytes<Underlying>>, ByteStringAppender<Bytes<Underlying>>, StreamingCommon<Bytes<Underlying>>, StreamingDataOutput<Bytes<Underlying>>

All Known Subinterfaces:

Bytes<Underlying>

All Known Implementing Classes:

AbstractBytes, EnbeddedBytes, GuardedNativeBytes, HexDumpBytes, MappedBytes, NativeBytes, NativeBytes.NativeSubBytes, OnHeapBytes, SubBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes

public interface BytesOut<Underlying>
extends StreamingDataOutput<Bytes<Underlying>>, ByteStringAppender<Bytes<Underlying>>, BytesPrepender<Bytes<Underlying>>, BytesComment<BytesOut<Underlying>>

Field Summary

Fields inherited from interface net.openhft.chronicle.bytes.StreamingDataOutput

JAVA9_STRING_CODER_LATIN, JAVA9_STRING_CODER_UTF16

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT

Method Summary

Modifier and Type	Method and Description
long	addressForRead(long offset) Obtain the underlying addressForRead.
default long	addressForRead(long offset, int buffer)
long	addressForWrite(long offset) Obtain the underlying addressForRead.
long	addressForWritePosition()
default ByteOrder	byteOrder()
@NotNull Bytes	bytesForRead()
@NotNull Bytes	bytesForWrite()
default <T> T	bytesMethodWriter(@NotNull Class<T> tClass, Class... additional) Proxy an interface so each message called is written to a file for replay.
default long	capacity()
default boolean	compareAndSwapDouble(long offset, double expected, double value) Perform a 64-bit double CAS at a given offset.
default boolean	compareAndSwapFloat(long offset, float expected, float value) Perform a 32-bit float CAS at a given offset.
boolean	compareAndSwapInt(long offset, int expected, int value) Perform a 32-bit CAS at a given offset.
boolean	compareAndSwapLong(long offset, long expected, long value) Perform a 64-bit CAS at a given offset.
boolean	isDirectMemory()
default long	readLimit()
default long	readPosition() The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()
default long	readRemaining()
default long	realReadRemaining()
default long	realWriteRemaining()
boolean	sharedMemory()
default long	start()
void	testAndSetInt(long offset, int expected, int value)
default long	writeLimit()
void	writeMarshallableLength16(WriteBytesMarshallable marshallable)
default void	writeObject(Class componentType, Object obj) Write a limit set of writeObject types.
default long	writePosition() The write position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
default long	writeRemaining()

Methods inherited from interface net.openhft.chronicle.bytes.ByteStringAppender

append, append, append, append, append, append, append, append, append, append, append8bit, append8bit, append8bit, append8bit, append8bit, appendBase, appendBase16, appendBase16, appendDateMillis, appendDecimal, appendTimeMillis, writer

Methods inherited from interface net.openhft.chronicle.bytes.StreamingDataOutput

alignBy, appendUtf8, appendUtf8, appendUtf8, appendUtf8, appendUtf8, appendUtf8, canWriteDirect, copyFrom, outputStream, rawWriteByte, rawWriteInt, rawWriteLong, realCapacity, unsafeWrite, unsafeWriteObject, unsafeWriteObject, write, write, write, write, write, write, write, write, write8bit, write8bit, write8bit, write8bit, write8bit, writeBigDecimal, writeBigInteger, writeBoolean, writeByte, writeChar, writeDouble, writeDoubleAndInt, writeEnum, writeFloat, writeHistogram, writeInt, writeInt24, writeIntAdv, writeLimit, writeLong, writeLongAdv, writeOrderedInt, writeOrderedLong, writePosition, writePositionForHeader, writePositionRemaining, writeShort, writeSkip, writeSome, writeSome, writeStopBit, writeStopBit, writeStopBit, writeStopBitDecimal, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt24, writeUnsignedShort, writeUtf8, writeUtf8, writeUTFΔ, writeWithLength

Methods inherited from interface net.openhft.chronicle.bytes.StreamingCommon

clear

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

refCount, release, releaseLast, releaseLast, reserve, reservedBy, reserveTransfer, tryReserve

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

referenceId, referenceName, temporary

Methods inherited from interface net.openhft.chronicle.bytes.BytesPrepender

clearAndPad, prepend, prewrite, prewrite, prewriteByte, prewriteInt, prewriteLong, prewriteShort

Methods inherited from interface net.openhft.chronicle.bytes.BytesComment

comment, indent, retainsComments

Method Detail

bytesMethodWriter

@NotNull
default <T> T bytesMethodWriter(@NotNull
                                         @NotNull Class<T> tClass,
                                         Class... additional)
                                  throws IllegalArgumentException

Proxy an interface so each message called is written to a file for replay.

Parameters:

tClass - primary interface

additional - any additional interfaces

Returns:

a proxy which implements the primary interface (additional interfaces have to be cast)

Throws:

IllegalArgumentException

writeMarshallableLength16

void writeMarshallableLength16(WriteBytesMarshallable marshallable)
                        throws IllegalArgumentException,
                               BufferOverflowException,
                               IllegalStateException,
                               BufferUnderflowException

Throws:

IllegalArgumentException

BufferOverflowException

IllegalStateException

BufferUnderflowException

writeObject

default void writeObject(Class componentType,
                         Object obj)
                  throws IllegalArgumentException,
                         BufferOverflowException,
                         ArithmeticException,
                         IllegalStateException,
                         BufferUnderflowException

Write a limit set of writeObject types.

Parameters:

componentType - expected.

obj - of componentType

Throws:

IllegalArgumentException

BufferOverflowException

ArithmeticException

IllegalStateException

BufferUnderflowException

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()

The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()

Returns:

position to read from.

writePosition

default long writePosition()

The write position must be readPosition() <= writePosition() && writePosition() <= writeLimit()

Returns:

position to write to.

readRemaining

default long readRemaining()

Returns:

How many more bytes can we read.

realReadRemaining

default long realReadRemaining()

Returns:

how much can be safely read directly.

writeRemaining

default long writeRemaining()

Returns:

How many more bytes can we written.

realWriteRemaining

default long realWriteRemaining()

Returns:

writeRemaining with resize

readLimit

default long readLimit()

Returns:

the highest offset or position allowed for this buffer.

writeLimit

default long writeLimit()

addressForRead

long addressForRead(long offset)
             throws UnsupportedOperationException,
                    BufferUnderflowException,
                    IllegalStateException

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

Parameters:

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

Returns:

the underlying addressForRead of the buffer

Throws:

UnsupportedOperationException - if the underlying buffer is on the heap

BufferUnderflowException - if the offset is before the start() or the after the capacity()

IllegalStateException

addressForRead

default long addressForRead(long offset,
                            int buffer)
                     throws UnsupportedOperationException,
                            BufferUnderflowException,
                            IllegalStateException

Throws:

UnsupportedOperationException

BufferUnderflowException

IllegalStateException

addressForWrite

long addressForWrite(long offset)
              throws UnsupportedOperationException,
                     BufferOverflowException,
                     IllegalStateException

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

Parameters:

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

Returns:

the underlying addressForRead of the buffer

Throws:

UnsupportedOperationException - if the underlying buffer is on the heap

BufferOverflowException - if the offset is before the start() or the after the capacity()

IllegalStateException

addressForWritePosition

long addressForWritePosition()
                      throws UnsupportedOperationException,
                             BufferOverflowException,
                             IllegalStateException

Throws:

UnsupportedOperationException

BufferOverflowException

IllegalStateException

byteOrder

default ByteOrder byteOrder()

bytesForRead

@NotNull
@NotNull Bytes bytesForRead()
                              throws IllegalStateException

Returns:

the streaming bytes for reading.

Throws:

IllegalStateException

bytesForWrite

@NotNull
@NotNull Bytes bytesForWrite()
                               throws IllegalStateException

Returns:

the streaming bytes for writing.

Throws:

IllegalStateException

compareAndSwapInt

boolean compareAndSwapInt(long offset,
                          int expected,
                          int value)
                   throws BufferOverflowException,
                          IllegalStateException

Perform a 32-bit CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

BufferOverflowException

IllegalStateException

testAndSetInt

void testAndSetInt(long offset,
                   int expected,
                   int value)
            throws BufferOverflowException,
                   IllegalStateException

Throws:

BufferOverflowException

IllegalStateException

compareAndSwapLong

boolean compareAndSwapLong(long offset,
                           long expected,
                           long value)
                    throws BufferOverflowException,
                           IllegalStateException

Perform a 64-bit CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

BufferOverflowException

IllegalStateException

compareAndSwapFloat

default boolean compareAndSwapFloat(long offset,
                                    float expected,
                                    float value)
                             throws BufferOverflowException,
                                    IllegalStateException

Perform a 32-bit float CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

BufferOverflowException

IllegalStateException

compareAndSwapDouble

default boolean compareAndSwapDouble(long offset,
                                     double expected,
                                     double value)
                              throws BufferOverflowException,
                                     IllegalStateException

Perform a 64-bit double CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

BufferOverflowException

IllegalStateException

sharedMemory

boolean sharedMemory()

Returns:

true if these Bytes use shared memory.

isDirectMemory

boolean isDirectMemory()