Class StreamBufferWrapper

template <size_t SizeInBytes>

Public Functions

Type	Name
	StreamBufferWrapper ()
size_t	available () const
void	create (size_t xTriggerLevelBytes=1)
size_t	freeSpace () const
StreamBufferHandle_t	handle () const
size_t	read (uint8_t * dst, size_t maxLen, TickType_t ticks_to_wait, BaseType_t * pxHigherPriorityTaskWoken=nullptr)
bool	reset ()
size_t	write (const uint8_t const data, size_t len, TickType_t ticks_to_wait, BaseType_t pxHigherPriorityTaskWoken=nullptr)
	~StreamBufferWrapper ()

Public Functions Documentation

function StreamBufferWrapper

inline StreamBufferWrapper::StreamBufferWrapper ()

function available

inline size_t StreamBufferWrapper::available () const

function create

inline void StreamBufferWrapper::create (
    size_t xTriggerLevelBytes=1
)

function freeSpace

inline size_t StreamBufferWrapper::freeSpace () const

function handle

inline StreamBufferHandle_t StreamBufferWrapper::handle () const

function read

inline size_t StreamBufferWrapper::read (
    uint8_t * dst,
    size_t maxLen,
    TickType_t ticks_to_wait,
    BaseType_t * pxHigherPriorityTaskWoken=nullptr
)

function reset

inline bool StreamBufferWrapper::reset ()

function write

inline size_t StreamBufferWrapper::write (
    const uint8_t *const data,
    size_t len,
    TickType_t ticks_to_wait,
    BaseType_t * pxHigherPriorityTaskWoken=nullptr
)

function ~StreamBufferWrapper

inline StreamBufferWrapper::~StreamBufferWrapper ()

The documentation for this class was generated from the following file fw/rbcx-coprocessor/include/utils/StreamBufferWrapper.hpp