BFifo< Type > Class Template Reference

A template first in first out data buffer to store any object types. More...

#include <BFifo.h>

Public Member Functions
	BFifo (BUInt size)
	~BFifo ()
void	clear ()
BUInt	size ()
	Returns fifo size.
BError	resize (BUInt size)
	Resize FIFO, clears it as well.
BError	rebase ()
	Rebases fifo so read pointer is at zero moving memory as needed.
BUInt	writeAvailable ()
	How many items that can be written.
BUInt	writeAvailableChunk ()
	How many items that can be written in a chunk.
BError	write (const Type v)
	Write a single item.
BError	write (const Type *data, BUInt num)
	Write a set of items. Can only write a maximum of writeAvailableChunk() to save going beyond end of FIFO buffer.
Type *	writeData ()
	Returns a pointer to the data.
Type *	writeData (BUInt &num)
	Returns a pointer to the data and how many can be written in a chunk.
void	writeDone (BUInt num)
	Indicates when write is complete.
void	writeBackup (BUInt num)
	Backup, remove num items at end of fifo. Careful, make sure read is not already happening.
BUInt	readAvailable ()
	How many items are available to read.
BUInt	readAvailableChunk ()
	How many items are available to read in a chunk.
Type	read ()
	Read one item.
BError	read (Type *data, BUInt num)
	Read a set of items.
Type *	readData ()
	Returns a pointer to the data.
Type *	readData (BUInt &num)
	Returns a pointer to the data and how many can be read in a chunk.
void	readDone (BUInt num)
Type	readPos (BUInt pos)
	Read item at given offset from current read position.
void	writePos (BUInt pos, const Type &v)
	Write item at given offset from current read position.
Type &	operator[] (int pos)
	Direct access to read samples in buffer.

Protected Attributes
BUInt	osize
	The size of the FIFO.
Type *	odata
	FIFO memory buffer.
volatile BUInt	owritePos
	The write pointer.
volatile BUInt	oreadPos
	The read pointer.

Detailed Description

template<class Type>
class BFifo< Type >

A template first in first out data buffer to store any object types.

This class stores data in a ring buffer. It can store up to (size - 1) items. It has separate read and write pointers. These are thread safe. Note the read and write routines do not bounds check the Fifo. You have to use readAvailable()/writeAvailable() functions to check how much can be read/written before performing the reads or writes.

Constructor & Destructor Documentation

BFifo()

template<class Type >

BFifo< Type >::BFifo

(

BUInt

size

)

~BFifo()

template<class Type >

BFifo< Type >::~BFifo

(

)

Member Function Documentation

clear()

template<class Type >

void BFifo< Type >::clear

(

)

size()

template<class Type >

BUInt BFifo< Type >::size

(

)

Returns fifo size.

resize()

template<class Type >

BError BFifo< Type >::resize

(

BUInt

size

)

Resize FIFO, clears it as well.

rebase()

template<class Type >

BError BFifo< Type >::rebase

(

)

Rebases fifo so read pointer is at zero moving memory as needed.

writeAvailable()

template<class Type >

BUInt BFifo< Type >::writeAvailable

(

)

How many items that can be written.

writeAvailableChunk()

template<class Type >

BUInt BFifo< Type >::writeAvailableChunk

(

)

How many items that can be written in a chunk.

write() [1/2]

template<class Type >

BError BFifo< Type >::write

(

const Type

v

)

Write a single item.

write() [2/2]

template<class Type >

BError BFifo< Type >::write	(	const Type *	data,
		BUInt	num
	)

Write a set of items. Can only write a maximum of writeAvailableChunk() to save going beyond end of FIFO buffer.

writeData() [1/2]

template<class Type >

Type * BFifo< Type >::writeData

(

)

Returns a pointer to the data.

writeData() [2/2]

template<class Type >

Type * BFifo< Type >::writeData

(

BUInt &

num

)

Returns a pointer to the data and how many can be written in a chunk.

writeDone()

template<class Type >

void BFifo< Type >::writeDone

(

BUInt

num

)

Indicates when write is complete.

writeBackup()

template<class Type >

void BFifo< Type >::writeBackup

(

BUInt

num

)

Backup, remove num items at end of fifo. Careful, make sure read is not already happening.

readAvailable()

template<class Type >

BUInt BFifo< Type >::readAvailable

(

)

How many items are available to read.

readAvailableChunk()

template<class Type >

BUInt BFifo< Type >::readAvailableChunk

(

)

How many items are available to read in a chunk.

read() [1/2]

template<class Type >

Type BFifo< Type >::read

(

)

Read one item.

read() [2/2]

template<class Type >

BError BFifo< Type >::read	(	Type *	data,
		BUInt	num
	)

Read a set of items.

readData() [1/2]

template<class Type >

Type * BFifo< Type >::readData

(

)

Returns a pointer to the data.

readData() [2/2]

template<class Type >

Type * BFifo< Type >::readData

(

BUInt &

num

)

Returns a pointer to the data and how many can be read in a chunk.

readDone()

template<class Type >

void BFifo< Type >::readDone

(

BUInt

num

)

readPos()

template<class Type >

Type BFifo< Type >::readPos

(

BUInt

pos

)

Read item at given offset from current read position.

writePos()

template<class Type >

void BFifo< Type >::writePos	(	BUInt	pos,
		const Type &	v
	)

Write item at given offset from current read position.

operator[]()

template<class Type >

Type & BFifo< Type >::operator[]

(

int

pos

)

Direct access to read samples in buffer.

Member Data Documentation

osize

template<class Type >

BUInt BFifo< Type >::osize

protected

The size of the FIFO.

odata

template<class Type >

Type* BFifo< Type >::odata

protected

FIFO memory buffer.

owritePos

template<class Type >

volatile BUInt BFifo< Type >::owritePos

protected

The write pointer.

oreadPos

template<class Type >

volatile BUInt BFifo< Type >::oreadPos

protected

The read pointer.

---

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

• BFifo.h