FrtosQueue Struct Reference

Collaboration diagram for FrtosQueue:

Public Member Functions
	FrtosQueue (uint32_t cap, uint32_t msg_size, const char *name, uint8_t *ext_buf)
	FrtosQueue (uint32_t cap, uint32_t msg_size, const char *name)
	~FrtosQueue ()

Static Public Member Functions
static uint8_t *	AllocBuffer (uint32_t cap, uint32_t msg_size)

Public Attributes
stk::sync::MessageQueue	m_mq
bool	m_buf_owned
bool	m_cb_owned
FrtosQueueSet *	m_set
	non-owning ptr to the queue set this member belongs to (nullptr if none)

Detailed Description

Definition at line 511 of file freertos_stk.cpp.

Constructor & Destructor Documentation

FrtosQueue() [1/2]

FrtosQueue::FrtosQueue ( uint32_t cap, uint32_t msg_size, const char * name, uint8_t * ext_buf )

inlineexplicit

Definition at line 514 of file freertos_stk.cpp.

        : m_mq(ext_buf, static_cast<size_t>(cap), static_cast<size_t>(msg_size)),
          m_buf_owned(false), m_cb_owned(true)
    #if configUSE_QUEUE_SETS
          , m_set(nullptr)
    #endif
    {
        m_mq.SetTraceName(name);
    }

References configUSE_QUEUE_SETS, m_buf_owned, m_cb_owned, m_mq, and m_set.

FrtosQueue() [2/2]

FrtosQueue::FrtosQueue ( uint32_t cap, uint32_t msg_size, const char * name )

inlineexplicit

Definition at line 526 of file freertos_stk.cpp.

        : m_mq(AllocBuffer(cap, msg_size),
                static_cast<size_t>(cap),
                static_cast<size_t>(msg_size)),
          m_buf_owned(m_mq.IsStorageValid()), m_cb_owned(true)
    #if configUSE_QUEUE_SETS
          , m_set(nullptr)
    #endif
    {
        m_mq.SetTraceName(name);
    }

References AllocBuffer(), configUSE_QUEUE_SETS, m_buf_owned, m_cb_owned, m_mq, and m_set.

Here is the call graph for this function:

~FrtosQueue()

FrtosQueue::~FrtosQueue ( )

inline

Definition at line 538 of file freertos_stk.cpp.

    {
        if (m_buf_owned)
            ObjFreeArray(m_mq.GetBuffer());
    }

References m_buf_owned, m_mq, and ObjFreeArray().

Here is the call graph for this function:

Member Function Documentation

AllocBuffer()

uint8_t * FrtosQueue::AllocBuffer ( uint32_t cap, uint32_t msg_size )

inlinestatic

Definition at line 544 of file freertos_stk.cpp.

    {
        return ObjAllocArray<uint8_t>(static_cast<size_t>(cap) * msg_size);
    }

References ObjAllocArray().

Referenced by FrtosQueue().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_buf_owned

bool FrtosQueue::m_buf_owned

Definition at line 551 of file freertos_stk.cpp.

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

m_cb_owned

bool FrtosQueue::m_cb_owned

Definition at line 552 of file freertos_stk.cpp.

Referenced by FrtosQueue(), FrtosQueue(), and xQueueCreateStatic().

m_mq

stk::sync::MessageQueue FrtosQueue::m_mq

Definition at line 550 of file freertos_stk.cpp.

Referenced by FrtosQueue(), FrtosQueue(), uxQueueMessagesWaiting(), uxQueueMessagesWaitingFromISR(), uxQueueSpacesAvailable(), xQueueAddToSet(), xQueueCreate(), xQueueOverwrite(), xQueueOverwriteFromISR(), xQueueRemoveFromSet(), xQueueSend(), xQueueSendFromISR(), xQueueSendToFront(), xQueueSendToFrontFromISR(), and ~FrtosQueue().

m_set

FrtosQueueSet* FrtosQueue::m_set

non-owning ptr to the queue set this member belongs to (nullptr if none)

Definition at line 554 of file freertos_stk.cpp.

Referenced by FrtosQueue(), FrtosQueue(), xQueueAddToSet(), and xQueueRemoveFromSet().

---

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

• freertos_stk.cpp