net.openhft.chronicle.bytes

Interface StreamingCommon<S extends StreamingCommon<S>>

All Known Subinterfaces:

Bytes<Underlying>, BytesIn<Underlying>, BytesOut<Underlying>, ByteStringAppender<B>, net.openhft.chronicle.bytes.ByteStringParser<B>, StreamingDataInput<S>, StreamingDataOutput<S>

All Known Implementing Classes:

AbstractBytes, HexDumpBytes, MappedBytes, NativeBytes, SubBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes

public interface StreamingCommon<S extends StreamingCommon<S>>

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.
default ByteOrder	byteOrder()
Bytes	bytesForRead()
Bytes	bytesForWrite()
default long	capacity()
S	clear() Set the readPosition= writePosition = start, writeLimit = 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()
boolean	sharedMemory()
default long	start()
void	testAndSetInt(long offset, int expected, int value)
default long	writeLimit()
default long	writePosition() The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
default long	writeRemaining()

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

refCount, release, release, releaseAll, reserve, tryReserve

Method Detail

clear

@NotNull
S clear()

Set the readPosition= writePosition = start, writeLimit = capacity

Returns:

this

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 read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()

Returns:

position to write to.

readRemaining

default long readRemaining()

Returns:

How many more bytes can we read.

writeRemaining

default long writeRemaining()

Returns:

How many more bytes can we written.

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

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

addressForRead

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

Throws:

UnsupportedOperationException

BufferUnderflowException

addressForWrite

long addressForWrite(long offset)
              throws UnsupportedOperationException,
                     BufferOverflowException

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

byteOrder

default ByteOrder byteOrder()

bytesForRead

@NotNull
Bytes bytesForRead()
                     throws IllegalStateException

Returns:

the streaming bytes for reading.

Throws:

IllegalStateException

bytesForWrite

@NotNull
Bytes bytesForWrite()
                      throws IllegalStateException

Returns:

the streaming bytes for writing.

Throws:

IllegalStateException

compareAndSwapInt

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

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

testAndSetInt

void testAndSetInt(long offset,
                   int expected,
                   int value)

compareAndSwapLong

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

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

compareAndSwapFloat

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

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

compareAndSwapDouble

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

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

sharedMemory

boolean sharedMemory()

Returns:

true if these Bytes use shared memory.

isDirectMemory

boolean isDirectMemory()