org.michailov.async.io

Class ByteRingBuffer

java.lang.Object

org.michailov.async.io.RingBuffer

org.michailov.async.io.ByteRingBuffer

public class ByteRingBuffer
extends RingBuffer

This is a concrete implementation of RingBuffer of a byte[].

Constructor Summary

Constructors

Constructor and Description
ByteRingBuffer(byte[] buffer) Constructs a ring buffer over an existing byte[].
ByteRingBuffer(int capacity) Constructs a ring buffer over an implicitly allocated byte[].

Method Summary

Modifier and Type	Method and Description
byte[]	getBuffer() Gets the underlying byte[].
int	peek(int delta) Gets the byte at a given relative position ahead of the current virtual read position.
int	read() Reads the byte at the virtual read position, and advances the virtual read position by 1.
int	write(byte b) Writes a byte at the virtual write position, and advances the virtual write position by 1.

Methods inherited from class org.michailov.async.io.RingBuffer

advanceReadPosition, advanceWritePosition, getAvailableToRead, getAvailableToReadStraight, getAvailableToWrite, getAvailableToWriteStraight, getBufferLength, getReadPosition, getTotalReadCount, getTotalWriteCount, getWritePosition, isEOF, setEOF

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ByteRingBuffer

public ByteRingBuffer(int capacity)

Constructs a ring buffer over an implicitly allocated byte[].

Parameters:

capacity - Capacity of the implicit byte[].

ByteRingBuffer

public ByteRingBuffer(byte[] buffer)

Constructs a ring buffer over an existing byte[]. This overload is useful when the caller wants to reuse existing arrays to avoid unnecessary heap allocations.

Parameters:

buffer - An existing byte[].

Method Detail

getBuffer

public byte[] getBuffer()

Gets the underlying byte[]. This may be passed to buffer copying APIs along with RingBuffer.getAvailableToReadStraight() or RingBuffer.getAvailableToWriteStraight().

Returns:

The underlying byte[].

peek

public int peek(int delta)

Gets the byte at a given relative position ahead of the current virtual read position.

Parameters:

delta - A relative position ahead of the virtual read position to peek at.

Returns:

The value of the byte at the peek position or -1 if delta is greater than RingBuffer.getAvailableToRead().

read

public int read()

Reads the byte at the virtual read position, and advances the virtual read position by 1.

Returns:

The byte at the virtual read position or -1 if nothing is available to read.

write

public int write(byte b)

Writes a byte at the virtual write position, and advances the virtual write position by 1.

Parameters:

b - Byte to be written.

Returns:

The byte that was written or -1 if no space was available to write.