net.openhft.chronicle.bytes

Interface StreamingCommon<S extends StreamingCommon<S>>

Type Parameters:

S - Type of the implementing class, extending StreamingCommon

All Known Subinterfaces:

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

All Known Implementing Classes:

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

public interface StreamingCommon<S extends StreamingCommon<S>>

Represents a streaming interface for handling streaming data with support for random access. The interface is used for managing reading and writing positions within the streaming data.

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) Retrieves the underlying memory address for reading.
default long	addressForRead(long offset, int buffer) Retrieves the underlying memory address for reading.
long	addressForWrite(long offset) Retrieves the underlying memory address for writing.
long	addressForWritePosition() Retrieves the underlying memory address for writing at the current write position.
default ByteOrder	byteOrder() Retrieves the byte order used by the buffer.
@NotNull Bytes<?>	bytesForRead() Retrieves a Bytes object for reading.
@NotNull Bytes<?>	bytesForWrite() Retrieves a Bytes object for writing.
default long	capacity()
S	clear() Resets the read and write positions to the start of the streaming buffer, and sets the write limit to the capacity of the buffer.
boolean	isDirectMemory() Checks if the buffer uses direct memory.
default long	lengthWritten(long startPosition) Calculates the length of data written from the given start position.
default long	readLimit() If the resource is closed, the returned value is unspecified.
default long	readPosition() Returns the read position.
default long	readRemaining() Calculates the number of bytes remaining that can be read from the current read position.
default long	realCapacity()
default long	realReadRemaining() Calculates the number of bytes that can be safely read directly.
default long	realWriteRemaining() Calculates the number of bytes remaining that can be written from the current write position with resizing.
boolean	sharedMemory() Checks if the Bytes use shared memory.
default long	start()
default long	writeLimit() Retrieves the maximum writable position within the buffer.
default long	writePosition() Returns the write position.
default long	writeRemaining() Calculates the number of bytes remaining that can be written from the current write position.

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

addReferenceChangeListener, refCount, release, releaseLast, releaseLast, removeReferenceChangeListener, reserve, reserveTransfer, tryReserve

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

referenceId, referenceName, temporary

Method Detail

clear

@NotNull
S clear()
          throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                 net.openhft.chronicle.core.io.ThreadingIllegalStateException

Resets the read and write positions to the start of the streaming buffer, and sets the write limit to the capacity of the buffer. This effectively clears any existing data in the buffer and prepares it for new data to be written.

This operation is similar to rewinding the tape to the beginning, and having it ready to record new data over anything that was there before.

Returns:

A reference to this object, allowing for method chaining.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

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)

Calculates the length of data written from the given start position.

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 - The position to calculate the length from.

Returns:

The length of data written from the given start position.

readRemaining

default long readRemaining()

Calculates the number of bytes remaining that can be read from the current read position.

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

Returns:

The number of bytes that can still be read.

realReadRemaining

default long realReadRemaining()

Calculates the number of bytes that can be safely read directly.

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

Returns:

The number of bytes that can be safely read directly.

writeRemaining

default long writeRemaining()

Calculates the number of bytes remaining that can be written from the current write position.

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

Returns:

The number of bytes that can still be written.

realWriteRemaining

default long realWriteRemaining()

Calculates the number of bytes remaining that can be written from the current write position with resizing.

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

Returns:

The number of bytes that can still be written with resizing.

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

Retrieves the maximum writable position within the buffer.

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

Returns:

the write limit

addressForRead

long addressForRead(long offset)
             throws UnsupportedOperationException,
                    BufferUnderflowException,
                    net.openhft.chronicle.core.io.ClosedIllegalStateException,
                    net.openhft.chronicle.core.io.ThreadingIllegalStateException

Retrieves the underlying memory address for reading. 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()

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

addressForRead

default long addressForRead(long offset,
                            int buffer)
                     throws UnsupportedOperationException,
                            BufferUnderflowException,
                            net.openhft.chronicle.core.io.ClosedIllegalStateException,
                            net.openhft.chronicle.core.io.ThreadingIllegalStateException

Retrieves the underlying memory address for reading. This is for expert users only.

Parameters:

offset - The offset within this buffer.

buffer - The buffer index.

Returns:

The underlying memory address for reading at the specified offset.

Throws:

UnsupportedOperationException - If the underlying buffer is on the heap.

BufferUnderflowException - If the offset is before the start or after the capacity.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

addressForWrite

long addressForWrite(long offset)
              throws UnsupportedOperationException,
                     BufferOverflowException,
                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Retrieves the underlying memory address for writing. 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()

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

addressForWritePosition

long addressForWritePosition()
                      throws UnsupportedOperationException,
                             BufferOverflowException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException

Retrieves the underlying memory address for writing at the current write position. This is for expert users only.

Returns:

The underlying memory address for writing at the current write position.

Throws:

UnsupportedOperationException - If the underlying buffer is on the heap.

BufferOverflowException - If the current write position is before the start or after the capacity.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

byteOrder

default ByteOrder byteOrder()

Retrieves the byte order used by the buffer.

Returns:

The byte order used by the buffer.

bytesForRead

@NotNull
@NotNull Bytes<?> bytesForRead()
                                 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                        net.openhft.chronicle.core.io.ThreadingIllegalStateException

Retrieves a Bytes object for reading.

Returns:

A Bytes object for reading.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

bytesForWrite

@NotNull
@NotNull Bytes<?> bytesForWrite()
                                  throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Retrieves a Bytes object for writing.

Returns:

A Bytes object for writing.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

sharedMemory

boolean sharedMemory()

Checks if the Bytes use shared memory.

Returns:

True if the Bytes use shared memory, false otherwise.

isDirectMemory

boolean isDirectMemory()

Checks if the buffer uses direct memory.

Returns:

True if the buffer uses direct memory, false otherwise.