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

This interface represents a ring buffer data structure capable of reading and writing Bytes (binary data). The BytesRingBuffer interface extends BytesRingBufferStats, BytesConsumer, and Closeable to provide statistics about the ring buffer, consume bytes from the buffer and close the buffer when it's no longer needed.

This interface also includes methods for creating instances of ring buffer, determining the size, checking for emptiness, and offering or reading bytes to/from the buffer.

Note that some methods in this interface are expected to be implemented in commercial versions and would need unlocking for use.

This interface is not meant to be implemented by user code.

Method Summary

Modifier and Type	Method and Description
BytesStore	bytesStore() Retrieves the BytesStore that backs this buffer.
static @NotNull Class<MultiReaderBytesRingBuffer>	clazz() Returns the Class object for MultiReaderBytesRingBuffer.
void	clear() clears the ring buffer but moving the read position to the write position
boolean	isEmpty() Checks if the buffer is empty.
static @NotNull BytesRingBuffer	newInstance(@NotNull BytesStore<?,Void> bytesStore) Constructs a new instance with the provided BytesStore.
static @NotNull MultiReaderBytesRingBuffer	newInstance(@NotNull BytesStore<?,Void> bytesStore, int numReaders) Constructs a new MultiReaderBytesRingBuffer instance with the provided BytesStore and a given number of readers.
boolean	offer(@NotNull BytesStore bytes0) Inserts the specified element at the tail of this queue if it is possible to do so immediately without exceeding the queue's capacity,
boolean	read(@NotNull BytesOut<?> using) Retrieves and removes the head of this queue, or returns null if this queue is empty.
long	readRemaining() Retrieves the number of bytes that can be read from this buffer.
static long	sizeFor(long capacity) Calculates the required size for the ring buffer with a given capacity.
static long	sizeFor(long capacity, int numReaders) Calculates the required size for the ring buffer with a given capacity and a specific 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)

Constructs a new instance with the provided BytesStore.

Parameters:

bytesStore - the BytesStore to be used for the ring buffer.

Returns:

a new instance of .

newInstance

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

Constructs a new MultiReaderBytesRingBuffer instance with the provided BytesStore and a given number of readers.

Parameters:

bytesStore - the BytesStore to be used for the ring buffer.

numReaders - the number of readers for the ring buffer.

Returns:

a new instance of MultiReaderBytesRingBuffer.

clazz

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

Returns the Class object for MultiReaderBytesRingBuffer.

Returns:

the Class object for MultiReaderBytesRingBuffer.

Throws:

ClassNotFoundException - if the class "software.chronicle.enterprise.ring.EnterpriseRingBuffer" is not found.

sizeFor

static long sizeFor(long capacity)

Calculates the required size for the ring buffer with a given capacity.

Parameters:

capacity - the capacity of the ring buffer.

Returns:

the required size for the ring buffer.

sizeFor

static long sizeFor(long capacity,
                    int numReaders)

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

Parameters:

capacity - the capacity of the ring buffer.

numReaders - the number of readers for the ring buffer.

Returns:

the required size for the ring buffer.

clear

void clear()

clears the ring buffer but moving the read position to the write position

offer

boolean offer(@NotNull
              @NotNull BytesStore bytes0)

Inserts the specified element at the tail of this queue if it is possible to do so immediately without exceeding the queue's capacity,

Parameters:

bytes0 - the bytes0 that you wish to add to the ring buffer

Returns:

returning true upon success and false if this queue is full.

read

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

Retrieves and removes the head of this queue, or returns null if this queue is empty.

Specified by:

read in interface BytesConsumer

Parameters:

using - Bytes to read into.

Returns:

false if this queue is empty, or a populated buffer if the element was retried

Throws:

BufferOverflowException - is the using buffer is not large enough

readRemaining

long readRemaining()

Retrieves the number of bytes that can be read from this buffer.

Returns:

the number of bytes that can be read

isEmpty

boolean isEmpty()

Checks if the buffer is empty. A buffer is considered empty if there are no readable bytes.

Returns:

true if the buffer is empty, false otherwise

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