QueuedComponentBase.cpp

Go to the documentation of this file.

#include <Fw/Comp/QueuedComponentBase.hpp>
#include <Fw/FPrimeBasicTypes.hpp>
#include <Fw/Types/Assert.hpp>
#include <Os/QueueString.hpp>

#include <cstdio>

namespace Fw {

QueuedComponentBase::QueuedComponentBase(const char* name) : PassiveComponentBase(name), m_msgsDropped(0) {}

QueuedComponentBase::~QueuedComponentBase() {}

void QueuedComponentBase::init(FwEnumStoreType instance) {
    PassiveComponentBase::init(instance);
}

void QueuedComponentBase::deinit() {
    this->m_queue.teardown();
}

#if FW_OBJECT_TO_STRING == 1
const char* QueuedComponentBase::getToStringFormatString() {
    return "QueueComp: %s";
}
#endif

Os::Queue::Queue::Status QueuedComponentBase::createQueue(FwSizeType depth, FwSizeType msgSize) {
    Os::QueueString queueName;
#if FW_OBJECT_NAMES == 1
    queueName = this->m_objName;
#else
    // Truncation of a queue name is benign
    (void)queueName.format("CompQ_%" PRI_FwSizeType, Os::Queue::getNumQueues());
#endif
    return this->m_queue.create(this->getInstance(), queueName, depth, msgSize);
}

FwSizeType QueuedComponentBase::getNumMsgsDropped() {
    return this->m_msgsDropped;
}

void QueuedComponentBase::incNumMsgDropped() {
    this->m_msgsDropped++;
}

Fw::QueuedComponentBase::MsgDispatchStatus QueuedComponentBase::dispatchAvailableMessages() {
    MsgDispatchStatus status = MSG_DISPATCH_OK;
    const FwSizeType num_messages = this->m_queue.getMessagesAvailable();
    for (FwSizeType i = 0; i < num_messages; i++) {
        status = this->doDispatch();
        if (status != MSG_DISPATCH_OK) {
            break;
        }
    }
    return status;
}
}  // namespace Fw