Implements a typed Ringbuffer. More...

#include <Buffers.h>

Inheritance diagram for RingBuffer< T >:

Public Member Functions
	RingBuffer (int size)

virtual T *	address ()
	returns the address of the start of the physical read buffer

virtual int	available ()
	provides the number of entries that are available to read

virtual int	availableForWrite ()
	provides the number of entries that are available to write

void	clear ()
	same as reset

virtual int	clearArray (int len)
	Removes the next len entries.

bool	isEmpty ()

virtual bool	isFull ()
	checks if the buffer is full

virtual float	levelPercent ()
	Returns the level of the buffer in %.

virtual T	peek ()
	peeks the actual entry from the buffer

virtual int	peekArray (T *data, int n)

virtual T	read ()
	reads a single value

virtual int	readArray (T data[], int len)
	reads multiple values

int	readFrames (T data[][2], int len)
	reads multiple values for array of 2 dimensional frames

template<int rows, int channels>
int	readFrames (T(&data)[rows][channels])

virtual void	reset ()
	clears the buffer

virtual void	resize (int len)

virtual size_t	size ()
	Returns the maximum capacity of the buffer.

virtual bool	write (T data)
	write add an entry to the buffer

virtual int	writeArray (const T data[], int len)
	Fills the buffer data.

virtual int	writeArrayOverwrite (const T data[], int len)
	Fills the buffer data and overwrites the oldest data if the buffer is full.

Detailed Description

Implements a typed Ringbuffer.

Template Parameters

T

The documentation for this class was generated from the following file:

Public Member Functions