net.openhft.chronicle.bytes

Interface StreamingCommon<S extends StreamingCommon<S>>

All Known Subinterfaces:

Bytes<U>, BytesIn<U>, BytesOut<U>, ByteStringAppender<B>, ByteStringParser<B>, StreamingDataInput<S>, StreamingDataOutput<S>

All Known Implementing Classes:

AbstractBytes, ChunkedMappedBytes, CommonMappedBytes, EmbeddedBytes, GuardedNativeBytes, HexDumpBytes, MappedBytes, NativeBytes, OnHeapBytes, SingleMappedBytes, SubBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes

public interface StreamingCommon<S extends StreamingCommon<S>>

Field Summary

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

INIT, TMP

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 long	capacity()
S	clear() Set the readPosition= writePosition = start, writeLimit = capacity
boolean	isDirectMemory()
default long	lengthWritten(long startPosition) Typically this calculates the difference however for HexDumpBytes it's not as simple.
default long	readLimit() If the resource is closed, the returned value is unspecified.
default long	readPosition() Returns the read position.
default long	readRemaining() Returns the remaining bytes that can be read.
default long	realCapacity()
default long	realReadRemaining() If the resource is closed, the returned value is unspecified.
default long	realWriteRemaining() If the resource is closed, the returned value is unspecified.
boolean	sharedMemory()
default long	start()
default long	writeLimit() Returns the write limit.
default long	writePosition() Returns the write position.
default long	writeRemaining() If the resource is closed, the returned value is unspecified.

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

Method Detail

clear

@NotNull
S clear()
          throws IllegalStateException

Set the readPosition= writePosition = start, writeLimit = capacity

Returns:

this

Throws:

IllegalStateException - if this resource has been previously released

start

default long start()

Returns:

The smallest position allowed in this buffer.

capacity

default long capacity()

Returns:

the highest limit allowed for this buffer.

realCapacity

default long realCapacity()

Returns:

the limit for this buffer without resizing

readPosition

default long readPosition()

Returns the read position.

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

If the resource is closed, the returned value is unspecified.

Returns:

position to read from.

writePosition

default long writePosition()

Returns the write position. The write position is readPosition() <= writePosition() && writePosition() <= writeLimit()

If the resource is closed, the returned value is unspecified.

Returns:

position to write to.

lengthWritten

default long lengthWritten(long startPosition)

Typically this calculates the difference however for HexDumpBytes it's not as simple.

If the resource is closed, the returned value is unspecified.

Parameters:

startPosition - to compare against

Returns:

the length from the startPosition

readRemaining

default long readRemaining()

Returns the remaining bytes that can be read.

If the resource is closed, the returned value is unspecified.

Returns:

How many more bytes can we read.

realReadRemaining

default long realReadRemaining()

If the resource is closed, the returned value is unspecified.

Returns:

how much can be safely read directly.

writeRemaining

default long writeRemaining()

If the resource is closed, the returned value is unspecified.

Returns:

How many more bytes can we written.

realWriteRemaining

default long realWriteRemaining()

If the resource is closed, the returned value is unspecified.

Returns:

writeRemaining with resize

readLimit

default long readLimit()

If the resource is closed, the returned value is unspecified.

Returns:

the highest offset or position allowed for this buffer.

writeLimit

default long writeLimit()

Returns the write limit.

If the resource is closed, the returned value is unspecified.

Returns:

the write limit

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

sharedMemory

boolean sharedMemory()

Returns:

true if these Bytes use shared memory.

isDirectMemory

boolean isDirectMemory()