Templated Circular buffer class. More...

Public Member Functions
void	push (const T &data)
	Push the transaction to the buffer. More...

bool	pop (T &data)
	Pop the transaction from the buffer. More...

bool	empty () const
	Check if the buffer is empty. More...

bool	full () const
	Check if the buffer is full. More...

void	reset ()
	Reset the buffer. More...

CounterType	size () const
	Get the number of elements currently stored in the circular_buffer. More...

bool	peek (T &data) const
	Peek into circular buffer without popping. More...

Detailed Description

Templated Circular buffer class.

Note: Synchronization level: Interrupt safe; CounterType must be unsigned and consistent with BufferSize

Definition at line 67 of file CircularBuffer.h.

Member Function Documentation

bool empty ( ) const

Check if the buffer is empty.

Definition at line 136 of file CircularBuffer.h.

bool full ( ) const

Check if the buffer is full.

Definition at line 148 of file CircularBuffer.h.

bool peek ( T & data ) const

Peek into circular buffer without popping.

Parameters

data	Data to be peeked from the buffer

Returns: True if the buffer is not empty and data contains a transaction, false otherwise

Definition at line 191 of file CircularBuffer.h.

bool pop ( T & data )

Pop the transaction from the buffer.

Parameters

data	Data to be popped from the buffer

Returns: True if the buffer is not empty and data contains a transaction, false otherwise

Definition at line 116 of file CircularBuffer.h.

void push ( const T & data )

Push the transaction to the buffer.

This overwrites the buffer if it's full

Parameters

data	Data to be pushed to the buffer

Definition at line 92 of file CircularBuffer.h.

void reset ( void )

Reset the buffer.

Definition at line 159 of file CircularBuffer.h.

CounterType size ( ) const

Get the number of elements currently stored in the circular_buffer.

Definition at line 169 of file CircularBuffer.h.