Collaboration diagram for FrtosMessageBuffer:

Classes
struct	MsgEnvelope

Public Member Functions
	FrtosMessageBuffer (size_t max_msg_size, size_t msg_count, StreamBufferCallbackFunction_t pSendCb=nullptr, StreamBufferCallbackFunction_t pRecvCb=nullptr)
	FrtosMessageBuffer (size_t max_msg_size, size_t msg_count, uint8_t *storage, size_t storage_size, StreamBufferCallbackFunction_t pSendCb=nullptr, StreamBufferCallbackFunction_t pRecvCb=nullptr)
	~FrtosMessageBuffer ()

Public Attributes
stk::memory::BlockMemoryPool	m_pool
	payload block allocator
stk::sync::MessageQueue	m_eq
	envelope FIFO {len, blk}
size_t	m_max_msg_size
	max payload bytes per message
bool	m_eq_buf_owned
	true -> envelope buffer heap-allocated
bool	m_cb_owned
	true -> struct heap-allocated
StreamBufferCallbackFunction_t	m_send_cb
	optional callback fired after a successful Send
StreamBufferCallbackFunction_t	m_recv_cb
	optional callback fired after a successful Receive

Static Public Attributes
static constexpr size_t	ENVELOPE_SIZE = sizeof(MsgEnvelope)

Detailed Description

Definition at line 979 of file freertos_stk.cpp.

Constructor & Destructor Documentation

◆ FrtosMessageBuffer() [1/2]

FrtosMessageBuffer::FrtosMessageBuffer	(	size_t	max_msg_size,
		size_t	msg_count,
		StreamBufferCallbackFunction_t	pSendCb = nullptr,
		StreamBufferCallbackFunction_t	pRecvCb = nullptr )

inlineexplicit

Definition at line 992 of file freertos_stk.cpp.

        : m_pool(msg_count,
                 stk::memory::BlockMemoryPool::AlignBlockSize(max_msg_size)),
          m_eq(ObjAllocArray<uint8_t>(msg_count * ENVELOPE_SIZE),
               msg_count, ENVELOPE_SIZE),
          m_max_msg_size(max_msg_size),
          m_eq_buf_owned(true),
          m_cb_owned(true),
          m_send_cb(pSendCb),
          m_recv_cb(pRecvCb)
    {}

References ENVELOPE_SIZE, m_cb_owned, m_eq, m_eq_buf_owned, m_max_msg_size, m_pool, m_recv_cb, m_send_cb, and ObjAllocArray().

Here is the call graph for this function:

◆ FrtosMessageBuffer() [2/2]

FrtosMessageBuffer::FrtosMessageBuffer	(	size_t	max_msg_size,
		size_t	msg_count,
		uint8_t *	storage,
		size_t	storage_size,
		StreamBufferCallbackFunction_t	pSendCb = nullptr,
		StreamBufferCallbackFunction_t	pRecvCb = nullptr )

inlineexplicit

Definition at line 1009 of file freertos_stk.cpp.

        : m_pool(msg_count,
                 stk::memory::BlockMemoryPool::AlignBlockSize(max_msg_size),
                 storage,
                 msg_count * stk::memory::BlockMemoryPool::AlignBlockSize(max_msg_size)),
          m_eq(storage + msg_count * stk::memory::BlockMemoryPool::AlignBlockSize(max_msg_size),
               msg_count, ENVELOPE_SIZE),
          m_max_msg_size(max_msg_size),
          m_eq_buf_owned(false),
          m_cb_owned(false),
          m_send_cb(pSendCb),
          m_recv_cb(pRecvCb)
    {
        STK_UNUSED(storage_size);
    }

References ENVELOPE_SIZE, m_cb_owned, m_eq, m_eq_buf_owned, m_max_msg_size, m_pool, m_recv_cb, m_send_cb, and STK_UNUSED.

◆ ~FrtosMessageBuffer()

FrtosMessageBuffer::~FrtosMessageBuffer ( )

inline

Definition at line 1030 of file freertos_stk.cpp.

    {
        if (m_eq_buf_owned)
            ObjFreeArray(static_cast<uint8_t *>(m_eq.GetBuffer()));
    }

References m_eq, m_eq_buf_owned, and ObjFreeArray().

Here is the call graph for this function:

Member Data Documentation

◆ ENVELOPE_SIZE

size_t FrtosMessageBuffer::ENVELOPE_SIZE = sizeof(MsgEnvelope)

staticconstexpr

Definition at line 987 of file freertos_stk.cpp.

Referenced by FrtosMessageBuffer(), FrtosMessageBuffer(), MsgBufSlotCount(), xMessageBufferCreateStatic(), xMessageBufferCreateStaticWithCallback(), and xMessageBufferCreateWithCallback().

◆ m_cb_owned

bool FrtosMessageBuffer::m_cb_owned

true -> struct heap-allocated

Definition at line 1041 of file freertos_stk.cpp.

Referenced by FrtosMessageBuffer(), and FrtosMessageBuffer().

◆ m_eq

stk::sync::MessageQueue FrtosMessageBuffer::m_eq

envelope FIFO {len, blk}

Definition at line 1038 of file freertos_stk.cpp.

Referenced by FrtosMessageBuffer(), FrtosMessageBuffer(), xMessageBufferCreate(), xMessageBufferCreateWithCallback(), xMessageBufferNextLengthBytes(), xMessageBufferReceive(), xMessageBufferReceiveFromISR(), xMessageBufferReset(), xMessageBufferResetFromISR(), xMessageBufferSend(), xMessageBufferSendFromISR(), and ~FrtosMessageBuffer().

◆ m_eq_buf_owned

bool FrtosMessageBuffer::m_eq_buf_owned

true -> envelope buffer heap-allocated

Definition at line 1040 of file freertos_stk.cpp.

Referenced by FrtosMessageBuffer(), FrtosMessageBuffer(), and ~FrtosMessageBuffer().

◆ m_max_msg_size

size_t FrtosMessageBuffer::m_max_msg_size

max payload bytes per message

Definition at line 1039 of file freertos_stk.cpp.

Referenced by FrtosMessageBuffer(), FrtosMessageBuffer(), xMessageBufferSend(), and xMessageBufferSendFromISR().

◆ m_pool

stk::memory::BlockMemoryPool FrtosMessageBuffer::m_pool

payload block allocator

Definition at line 1037 of file freertos_stk.cpp.

Referenced by FrtosMessageBuffer(), FrtosMessageBuffer(), xMessageBufferCreate(), xMessageBufferReceive(), xMessageBufferReceiveFromISR(), xMessageBufferReset(), xMessageBufferResetFromISR(), xMessageBufferSend(), and xMessageBufferSendFromISR().

◆ m_recv_cb

StreamBufferCallbackFunction_t FrtosMessageBuffer::m_recv_cb

optional callback fired after a successful Receive

Definition at line 1043 of file freertos_stk.cpp.

Referenced by FrtosMessageBuffer(), FrtosMessageBuffer(), xMessageBufferReceive(), and xMessageBufferReceiveFromISR().

◆ m_send_cb

StreamBufferCallbackFunction_t FrtosMessageBuffer::m_send_cb

optional callback fired after a successful Send

Definition at line 1042 of file freertos_stk.cpp.