net.openhft.chronicle.bytes

Interface RingBufferReader

All Superinterfaces:

AutoCloseable, Closeable, net.openhft.chronicle.core.io.QueryCloseable, RingBufferReaderStats

public interface RingBufferReader
extends RingBufferReaderStats, net.openhft.chronicle.core.io.Closeable

Field Summary

Fields

Modifier and Type	Field and Description
static long	UNKNOWN_INDEX

Method Summary

Modifier and Type	Method and Description
void	afterRead(long next)
void	afterRead(long next, long payloadStart, long underlyingIndex)
long	beforeRead(Bytes bytes) the readPosition and readLimit will be adjusted so that the client can read the data
BytesStore	byteStore()
boolean	isEmpty()
boolean	isStopped()
boolean	read(BytesOut bytes) Convenience method calls both beforeRead(Bytes) and afterRead(long)
void	stop() stop the reader.
void	toEnd() Take reader to just past the end of the RB
long	underlyingIndex()

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

behind, getAndClearMissedReadCount, getAndClearReadCount

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

close, closeQuietly, closeQuietly, notifyClosing

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

isClosed, isClosing, throwExceptionIfClosed

Field Detail

UNKNOWN_INDEX

static final long UNKNOWN_INDEX

See Also:

Constant Field Values

Method Detail

isEmpty

boolean isEmpty()

isStopped

boolean isStopped()

stop

void stop()

stop the reader. After being stopped, the reader will not block writers. After being stopped the reader can be re-opened

beforeRead

long beforeRead(Bytes bytes)

the readPosition and readLimit will be adjusted so that the client can read the data

Parameters:

bytes - who's byteStore must be the ring buffer,

Returns:

nextReadPosition which should be passed to afterRead(long)

afterRead

void afterRead(long next)

afterRead

void afterRead(long next,
               long payloadStart,
               long underlyingIndex)

underlyingIndex

long underlyingIndex()

read

boolean read(BytesOut bytes)

Convenience method calls both beforeRead(Bytes) and afterRead(long)

Parameters:

bytes -

Returns:

whether read succeeded

byteStore

BytesStore byteStore()

Returns:

the byteStore which backs the ring buffer

toEnd

void toEnd()

Take reader to just past the end of the RB