daisy::RingBuffer< T, 0 >

Module: LIBDAISY / UTILITY

More...

#include <ringbuffer.h>

Public Functions

	Name
	RingBuffer()
void	Init()
size_t	capacity() const
size_t	writable() const
size_t	readable() const
void	Write(T v)
void	Overwrite(T v)
T	Read()
T	ImmediateRead()
void	Flush()
void	ImmediateRead(T * destination, size_t num_elements)
void	Overwrite(const T * source, size_t num_elements)

Detailed Description

template <typename T >
class daisy::RingBuffer< T, 0 >;

Utility Ring Buffer imported from pichenettes/stmlib

Public Functions Documentation

function RingBuffer

inline RingBuffer()

---

function Init

inline void Init()

Initialize ringbuffer

---

function capacity

inline size_t capacity() const

Return: 0

---

function writable

inline size_t writable() const

Return: 0

---

function readable

inline size_t readable() const

Return: 0

---

function Write

inline void Write(
    T v
)

Parameters:

• v Value to write

---

function Overwrite

inline void Overwrite(
    T v
)

Parameters:

• v Value to overwrite

---

function Read

inline T Read()

Return: Read value

---

function ImmediateRead

inline T ImmediateRead()

Return: Read value

---

function Flush

inline void Flush()

Flush the buffer

---

function ImmediateRead

inline void ImmediateRead(
    T * destination,
    size_t num_elements
)

Parameters:

• destination &
• num_elements &

---

function Overwrite

inline void Overwrite(
    const T * source,
    size_t num_elements
)

Parameters:

• source 3
• num_elements &

---

Updated on 2024-01-03 at 19:41:01 +0000