net.openhft.chronicle.bytes

Interface BytesRingBuffer

All Superinterfaces:

AutoCloseable, BytesConsumer, BytesRingBufferStats, Closeable, net.openhft.chronicle.core.io.QueryCloseable

All Known Subinterfaces:

MultiReaderBytesRingBuffer

public interface BytesRingBuffer
extends BytesRingBufferStats, BytesConsumer, net.openhft.chronicle.core.io.Closeable

Represents a ring buffer for Bytes data, intended for high-throughput, low-latency messaging between threads or services. It combines statistics (BytesRingBufferStats), byte consumption (BytesConsumer) and resource management (Closeable). Direct user implementation is discouraged and some functionality may require commercial libraries.

Method Summary

Modifier and Type	Method and Description
BytesStore<?,?>	bytesStore() Retrieves the BytesStore that backs this buffer.
static @NotNull Class<MultiReaderBytesRingBuffer>	clazz()
void	clear() Clears the buffer, typically by advancing reader positions to the current write position.
boolean	isEmpty()
static @NotNull BytesRingBuffer	newInstance(@NotNull BytesStore<?,Void> bytesStore) Factory method to create a new ring buffer.
static @NotNull MultiReaderBytesRingBuffer	newInstance(@NotNull BytesStore<?,Void> bytesStore, int numReaders) Factory method to create a ring buffer with multiple readers.
boolean	offer(@NotNull BytesStore<?,?> bytes0) Attempts to write the content of bytes0 as a single message.
boolean	read(@NotNull BytesOut<?> using) Reads the next available message into using.
long	readRemaining() Number of bytes currently available for reading from the default reader perspective.
static long	sizeFor(long capacity) Calculates the total byte size required for a ring buffer of the given capacity.
static long	sizeFor(long capacity, int numReaders) Calculates the total byte size required for a ring buffer with the given capacity and number of readers.

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

capacity, getAndClearContentionCount, getAndClearMissedWriteCount, getAndClearWriteCount, minNumberOfWriteBytesRemaining, readers

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

close, closeQuietly, closeQuietly

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

isClosed, isClosing

Method Detail

newInstance

@NotNull
static @NotNull BytesRingBuffer newInstance(@NotNull
                                                     @NotNull BytesStore<?,Void> bytesStore)

Factory method to create a new ring buffer.

Parameters:

bytesStore - backing store

Returns:

new ring buffer instance

newInstance

@NotNull
static @NotNull MultiReaderBytesRingBuffer newInstance(@NotNull
                                                                @NotNull BytesStore<?,Void> bytesStore,
                                                                int numReaders)

Factory method to create a ring buffer with multiple readers.

Parameters:

bytesStore - backing store

numReaders - number of readers

Returns:

new MultiReaderBytesRingBuffer

clazz

@NotNull
static @NotNull Class<MultiReaderBytesRingBuffer> clazz()
                                                          throws ClassNotFoundException

Returns:

the Class for the commercial implementation of MultiReaderBytesRingBuffer

Throws:

ClassNotFoundException - if the implementation class is not present

sizeFor

static long sizeFor(long capacity)

Calculates the total byte size required for a ring buffer of the given capacity.

sizeFor

static long sizeFor(long capacity,
                    int numReaders)

Calculates the total byte size required for a ring buffer with the given capacity and number of readers.

clear

void clear()

Clears the buffer, typically by advancing reader positions to the current write position.

offer

boolean offer(@NotNull
              @NotNull BytesStore<?,?> bytes0)

Attempts to write the content of bytes0 as a single message.

Parameters:

bytes0 - bytes to write

Returns:

true if the message was written, false if the buffer lacks space

read

boolean read(@NotNull
             @NotNull BytesOut<?> using)

Reads the next available message into using.

Specified by:

read in interface BytesConsumer

Parameters:

using - destination buffer

Returns:

true if a message was read, false if none were available

Throws:

BufferOverflowException - if using is too small

readRemaining

long readRemaining()

Number of bytes currently available for reading from the default reader perspective.

isEmpty

boolean isEmpty()

Returns:

true if no readable messages are present for the default reader

bytesStore

BytesStore<?,?> bytesStore()

Retrieves the BytesStore that backs this buffer. The returned BytesStore provides access to the bytes contained within the buffer, allowing them to be read or written.

Returns:

the BytesStore backing this buffer