fsb::CircularBuffer< BufferType, BufferSize > Class Template Reference

Detailed Description

template<typename BufferType, size_t BufferSize>
class fsb::CircularBuffer< BufferType, BufferSize >

Circular Buffer.

#include <fsb_circular_buffer.h>

Collaboration diagram for fsb::CircularBuffer< BufferType, BufferSize >:

Public Member Functions
CircularBufferStatus	push (BufferType push_value)
	Add value to the buffer if there is space available.
CircularBufferStatus	force_push (BufferType push_value)
	Add value to buffer and overwrite oldest value if buffer is full.
CircularBufferStatus	pop (BufferType &popped_value)
	Get oldest value from buffer.
CircularBufferStatus	pop_all (std::array< BufferType, BufferSize > &popped_values, size_t &num_popped)
	Get oldest value from buffer.
void	Reset ()
	Reset buffer to empty state.
size_t	GetFilled () const
	Get number of filled buffer positions.
size_t	GetRemaining () const
	Get number of remaining buffer positions.
size_t	GetSize () const
	Get total buffer size.

---

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

• fsb-core/include/fsb_circular_buffer.h