net.openhft.chronicle.bytes

Interface RingBufferReaderStats

All Known Subinterfaces:

RingBufferReader

public interface RingBufferReaderStats

An interface to provide statistics about a RingBufferReader's reading operations. This includes the number of successful reads, missed reads and how far behind the reader is.

Method Summary

Modifier and Type	Method and Description
long	behind() Calculates how far behind the RingBufferReader is relative to the write position in the Ring Buffer.
long	getAndClearMissedReadCount() Retrieves and resets the count of missed read operations performed by the RingBufferReader.
long	getAndClearReadCount() Retrieves and resets the count of successful read operations performed by the RingBufferReader.

Method Detail

getAndClearReadCount

long getAndClearReadCount()

Retrieves and resets the count of successful read operations performed by the RingBufferReader. Calling this method resets the number.

Returns:

The number of successful read operations since the last call to this method.

getAndClearMissedReadCount

long getAndClearMissedReadCount()

Retrieves and resets the count of missed read operations performed by the RingBufferReader. Missed reads occur if there was no new data to be read. Calling this method resets the number.

Returns:

The number of missed read operations since the last call to this method.

behind

long behind()

Calculates how far behind the RingBufferReader is relative to the write position in the Ring Buffer. This provides an indication of how much unread data remains in the buffer for this reader.

Returns:

The number of bytes yet to be read by the RingBufferReader.