net.openhft.chronicle.bytes

Interface BytesRingBufferStats

All Known Subinterfaces:

BytesRingBuffer, MultiReaderBytesRingBuffer

public interface BytesRingBufferStats

This interface provides statistics about a BytesRingBuffer.

Method Summary

Modifier and Type	Method and Description
long	capacity()
long	getAndClearContentionCount() Calling this method resets the number.
long	getAndClearMissedWriteCount() Calling this method resets the number.
long	getAndClearWriteCount() Calling this method resets the number.
long	minNumberOfWriteBytesRemaining() Each time the ring is read, the number of bytes remaining in the write buffer are recorded, and that number is returned by this method.
List<RingBufferReaderStats>	readers()

Method Detail

minNumberOfWriteBytesRemaining

long minNumberOfWriteBytesRemaining()

Each time the ring is read, the number of bytes remaining in the write buffer are recorded, and that number is returned by this method. Calling this method resets the number. If no read calls were made since the last call to this method, it returns Long.MAX_VALUE.

Returns:

the number of bytes remaining in the write buffer as at the last read or Long.MAX_VALUE if no reads were performed.

capacity

long capacity()

Returns:

the total capacity of the ring buffer in bytes.

getAndClearWriteCount

long getAndClearWriteCount()

Calling this method resets the number.

Returns:

the number of write operations performed since the last call to this method.

getAndClearMissedWriteCount

long getAndClearMissedWriteCount()

Calling this method resets the number.

Returns:

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

getAndClearContentionCount

long getAndClearContentionCount()

Calling this method resets the number.

Returns:

the number of contentions since the last call to this method.

readers

List<RingBufferReaderStats> readers()

Returns:

a list of RingBufferReaderStats objects, each representing the statistics for a reader of the ring buffer.