net.openhft.chronicle.bytes

Interface BytesRingBuffer

All Superinterfaces:

AutoCloseable, BytesConsumer, BytesRingBufferStats, Closeable

All Known Subinterfaces:

MultiReaderBytesRingBuffer

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

Author:

Rob Austin.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method and Description
static Class<MultiReaderBytesRingBuffer>	clazz()
void	clear() clears the ring buffer but moving the read position to the write position
boolean	isEmpty()
static BytesRingBuffer	newInstance(NativeBytesStore<Void> bytesStore)
static MultiReaderBytesRingBuffer	newInstance(NativeBytesStore<Void> bytesStore, int numReaders)
boolean	offer(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	offer(Consumer<Bytes> consumer)
boolean	read(BytesOut using) Retrieves and removes the head of this queue, or returns null if this queue is empty.
long	readRemaining()
static long	sizeFor(long capacity)
static long	sizeFor(long capacity, int numReaders)

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

capacity, getAndClearContentionCount, getAndClearMissedWriteCount, getAndClearWriteCount, maxCopyTimeNs, minNumberOfWriteBytesRemaining, readers

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

close, closeQuietly, closeQuietly, isClosed, notifyClosing

Field Detail

LOG

static final org.slf4j.Logger LOG

Method Detail

newInstance

@NotNull
static BytesRingBuffer newInstance(@NotNull
                                            NativeBytesStore<Void> bytesStore)

newInstance

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

clazz

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

Throws:

ClassNotFoundException

sizeFor

static long sizeFor(long capacity)

sizeFor

static long sizeFor(long capacity,
                    int numReaders)

clear

void clear()

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

offer

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,

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.

offer

boolean offer(@NotNull
              Consumer<Bytes> consumer)

Parameters:

consumer - a bytes consumer, when you accept this message you will write directly into the ring buffer, you don't have to worry about wrapping the ring buffer this is handled for you.

Returns:

true if you where able to write the bytes to the ring bufer, else false indicates nothing was written.

read

boolean read(@NotNull
             BytesOut using)
      throws BufferOverflowException

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

isEmpty

boolean isEmpty()