CircleBuf< T > Class Template Reference

Circular buffer backed by a vector. More...

#include <circlebuf.hh>

Public Types
using	value_type = T

Public Member Functions
	CircleBuf (size_t size)
bool	empty () const
size_t	size () const
size_t	capacity () const
void	flush ()
	Throw away any data in the buffer. More...
template<class OutputIterator >
void	peek (OutputIterator out, size_t len) const
	Copy buffer contents without advancing the read pointer. More...
template<class OutputIterator >
void	peek (OutputIterator out, off_t offset, size_t len) const
	Copy buffer contents without advancing the read pointer. More...
template<class OutputIterator >
void	read (OutputIterator out, size_t len)
	Copy buffer contents and advance the read pointer. More...
template<class InputIterator >
void	write (InputIterator in, size_t len)
	Add elements to the end of the ring buffers and advance. More...

Private Attributes
std::vector< T >	buffer
size_t	start = 0
size_t	used = 0
size_t	maxSize

Detailed Description

template<typename T>
class CircleBuf< T >

Circular buffer backed by a vector.

The data in the cricular buffer is stored in a standard vector.

Definition at line 55 of file circlebuf.hh.

Member Typedef Documentation

value_type

template<typename T >

using CircleBuf< T >::value_type = T

Definition at line 64 of file circlebuf.hh.

Constructor & Destructor Documentation

CircleBuf()

template<typename T >

CircleBuf< T >::CircleBuf ( size_t  size )

inlineexplicit

Definition at line 66 of file circlebuf.hh.

Member Function Documentation

capacity()

template<typename T >

size_t CircleBuf< T >::capacity ( ) const

inline

Definition at line 70 of file circlebuf.hh.

Referenced by Fifo< uint8_t >::capacity().

empty()

template<typename T >

bool CircleBuf< T >::empty ( ) const

inline

Definition at line 68 of file circlebuf.hh.

Referenced by Terminal::console_in(), Terminal::dataAvailable(), Fifo< uint8_t >::empty(), Terminal::readData(), and TEST().

flush()

template<typename T >

void CircleBuf< T >::flush ( )

inline

Throw away any data in the buffer.

Definition at line 76 of file circlebuf.hh.

Referenced by arrayParamIn(), Fifo< uint8_t >::flush(), and CircleBuf< char >::write().

peek() [1/2]

template<typename T >

template<class OutputIterator >

void CircleBuf< T >::peek ( OutputIterator  out, off_t  offset, size_t  len  ) const

inline

Copy buffer contents without advancing the read pointer.

Parameters

out	Output iterator/pointer
offset	Offset into the ring buffer
len	Number of elements to copy

Definition at line 104 of file circlebuf.hh.

peek() [2/2]

template<typename T >

template<class OutputIterator >

void CircleBuf< T >::peek ( OutputIterator  out, size_t  len  ) const

inline

Copy buffer contents without advancing the read pointer.

Parameters

out	Output iterator/pointer
len	Number of elements to copy

Definition at line 90 of file circlebuf.hh.

Referenced by Terminal::accept(), arrayParamOut(), CircleBuf< char >::peek(), Fifo< uint8_t >::peek(), CircleBuf< char >::read(), and TEST().

read()

template<typename T >

template<class OutputIterator >

void CircleBuf< T >::read ( OutputIterator  out, size_t  len  )

inline

Copy buffer contents and advance the read pointer.

Parameters

out	Output iterator/pointer
len	Number of elements to read

Definition at line 137 of file circlebuf.hh.

Referenced by Fifo< uint8_t >::read(), Terminal::readData(), and TEST().

size()

template<typename T >

size_t CircleBuf< T >::size ( ) const

inline

Definition at line 69 of file circlebuf.hh.

Referenced by Terminal::accept(), arrayParamOut(), Fifo< uint8_t >::size(), and TEST().

write()

template<typename T >

template<class InputIterator >

void CircleBuf< T >::write ( InputIterator  in, size_t  len  )

inline

Add elements to the end of the ring buffers and advance.

Writes which would exceed the capacity of the queue fill the avaialble space, and then continue overwriting the head of the queue. The head advances as if that data had been read out.

Parameters

in	Input iterator/pointer
len	Number of elements to read

Definition at line 155 of file circlebuf.hh.

Referenced by arrayParamIn(), Terminal::data(), TEST(), Fifo< uint8_t >::write(), and Terminal::writeData().

Member Data Documentation

buffer

template<typename T >

std::vector<T> CircleBuf< T >::buffer

private

Definition at line 58 of file circlebuf.hh.

Referenced by CircleBuf< char >::peek(), and CircleBuf< char >::write().

maxSize

template<typename T >

size_t CircleBuf< T >::maxSize

private

Definition at line 61 of file circlebuf.hh.

Referenced by CircleBuf< char >::capacity(), CircleBuf< char >::peek(), and CircleBuf< char >::write().

start

template<typename T >

size_t CircleBuf< T >::start = 0

private

Definition at line 59 of file circlebuf.hh.

Referenced by CircleBuf< char >::flush(), CircleBuf< char >::peek(), CircleBuf< char >::read(), and CircleBuf< char >::write().

used

template<typename T >

size_t CircleBuf< T >::used = 0

private

Definition at line 60 of file circlebuf.hh.

Referenced by CircleBuf< char >::empty(), CircleBuf< char >::flush(), CircleBuf< char >::peek(), CircleBuf< char >::read(), CircleBuf< char >::size(), and CircleBuf< char >::write().

---

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

• base/circlebuf.hh