smc::internal::RingBuffer Class Reference

Collaboration diagram for smc::internal::RingBuffer:

Public Member Functions
	RingBuffer (std::size_t size)
std::size_t	write (const char *data, std::size_t sz)
	Write chars to buffer. More...
std::size_t	read (char *data, std::size_t sz)
	Read chars from buffer. More...
std::size_t	bytesFree () const
	Read number of free chars. More...
std::size_t	size () const
	Get size of the buffer. More...

Protected Attributes
std::vector< char >	m_buff
std::size_t	m_ridx
std::size_t	m_widx
bool	m_full

Detailed Description

Definition at line 38 of file RingBuffer.hpp.

Member Function Documentation

bytesFree()

std::size_t smc::internal::RingBuffer::bytesFree

(

)

const

Read number of free chars.

Returns

std::size_t Number of free chars

Definition at line 65 of file RingBuffer.cpp.

read()

std::size_t smc::internal::RingBuffer::read	(	char *	data,
		std::size_t	sz
	)

Read chars from buffer.

Parameters

data	Pointer to data buffer to read to
sz	Number of chars to read

Returns

std::size_t Number of chars actually read

Definition at line 52 of file RingBuffer.cpp.

size()

std::size_t smc::internal::RingBuffer::size ( ) const

inline

Get size of the buffer.

Returns

std::size_t Size of buffer

Definition at line 73 of file RingBuffer.hpp.

write()

std::size_t smc::internal::RingBuffer::write	(	const char *	data,
		std::size_t	sz
	)

Write chars to buffer.

Parameters

data	Pointer to data to write
sz	Number of chars to write

Returns

std::size_t Number of chars actually written

Definition at line 37 of file RingBuffer.cpp.

---

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

• /builds/mro/controls/sambuca/sambuca-motion-lib/src/util/RingBuffer.hpp
• /builds/mro/controls/sambuca/sambuca-motion-lib/src/util/RingBuffer.cpp