BufferRP2040T< T > Class Template Reference

Buffer implementation which is based on a RP2040 queue. This class is intended to be used to exchange data between the 2 different cores. Multi-core and IRQ safe queue implementation! More...

#include <BufferRP2040.h>

Inheritance diagram for BufferRP2040T< T >:

Collaboration diagram for BufferRP2040T< T >:

Public Member Functions
	BufferRP2040T (int bufferCount)
	BufferRP2040T (size_t bufferSize, int bufferCount)
bool	resize (size_t size)
	Re-Allocats the memory and the queue (size is in entries)
bool	read (T &data)
	reads a single value
bool	peek (T &result) override
	peeks the actual entry from the buffer
int	readArray (T data[], int len) override
	reads multiple values
int	writeArray (const T data[], int len) override
	Fills the buffer data.
bool	isFull () override
	checks if the buffer is full
bool	isEmpty ()
bool	write (T data) override
	write add an entry to the buffer
void	reset () override
	clears the buffer
int	available () override
	provides the number of entries that are available to read
int	availableForWrite () override
	provides the number of entries that are available to write
T *	address () override
	returns the address of the start of the physical read buffer
size_t	size ()
void	setBlockingWrite (bool flag)
	When we use a non blocking write, the write size must be identical with the buffer size.
void	setBlockingRead (bool flag)
	When we use a blockingread, the we wait for the data to be available.
Public Member Functions inherited from BaseBuffer< T >
	BaseBuffer (BaseBuffer &)=default
BaseBuffer &	operator= (BaseBuffer &)=default
virtual bool	read (T &result)=0
	reads a single value
virtual int	readArray (T data[], int len)
	reads multiple values
virtual int	clearArray (int len)
	Removes the next len entries.
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.
virtual bool	peek (T &result)=0
	peeks the actual entry from the buffer
virtual bool	isFull ()
	checks if the buffer is full
bool	isEmpty ()
virtual bool	write (T data)=0
	write add an entry to the buffer
virtual void	reset ()=0
	clears the buffer
void	clear ()
	same as reset
virtual int	available ()=0
	provides the number of entries that are available to read
virtual int	availableForWrite ()=0
	provides the number of entries that are available to write
virtual T *	address ()=0
	returns the address of the start of the physical read buffer
virtual size_t	size ()=0
virtual float	levelPercent ()
	Returns the level of the buffer in %.
virtual bool	resize (int bytes)
	Resizes the buffer if supported: returns false if not supported.

Protected Member Functions
int	writeBlocking (const T data[], int len)
int	writeNonBlocking (const T data[], int len)

Protected Attributes
queue_t	queue
int	buffer_size_alloc_bytes = 0
int	buffer_size_req_bytes = 0
int	buffer_size_bytes = 0
int	buffer_size = 0
SingleBuffer< T >	write_buffer {0}
audio_tools::RingBuffer< T >	read_buffer {0}
bool	is_blocking_write = true
bool	is_blocking_read = false

Detailed Description

template<typename T>
class tinyrobotics::BufferRP2040T< T >

Buffer implementation which is based on a RP2040 queue. This class is intended to be used to exchange data between the 2 different cores. Multi-core and IRQ safe queue implementation!

In order to increase the efficiency we to not enqueue individual items but write them into a temporary buffer of bufferSize and write this array to the queue when it is full.

Author

Phil Schatzmann

Template Parameters

T

Member Function Documentation

address()

T * address ( )

inlineoverridevirtual

returns the address of the start of the physical read buffer

Implements BaseBuffer< T >.

available()

int available ( )

inlineoverridevirtual

provides the number of entries that are available to read

Implements BaseBuffer< T >.

availableForWrite()

int availableForWrite ( )

inlineoverridevirtual

provides the number of entries that are available to write

Implements BaseBuffer< T >.

isFull()

bool isFull ( )

inlineoverridevirtual

checks if the buffer is full

Reimplemented from BaseBuffer< T >.

peek()

bool peek ( T &  result )

inlineoverridevirtual

peeks the actual entry from the buffer

Implements BaseBuffer< T >.

read()

bool read ( T &  result )

inlinevirtual

reads a single value

Implements BaseBuffer< T >.

readArray()

int readArray ( T  data[], int  len  )

inlineoverridevirtual

reads multiple values

Reimplemented from BaseBuffer< T >.

reset()

void reset ( )

inlineoverridevirtual

clears the buffer

Implements BaseBuffer< T >.

size()

size_t size ( )

inlinevirtual

Implements BaseBuffer< T >.

write()

bool write ( T  data )

inlineoverridevirtual

write add an entry to the buffer

Implements BaseBuffer< T >.

writeArray()

int writeArray ( const T  data[], int  len  )

inlineoverridevirtual

Fills the buffer data.

Reimplemented from BaseBuffer< T >.

---

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

• src/TinyRobotics/concurrency/RP2040/BufferRP2040.h