QueuedComponentBase.hpp

Go to the documentation of this file.

/*
 * ActiveComponentBase.hpp
 *
 *  Created on: Aug 14, 2012
 *      Author: tcanham
 */

/*
 * Description:
 */
#ifndef FW_QUEUED_COMPONENT_BASE_HPP
#define FW_QUEUED_COMPONENT_BASE_HPP

#include <Fw/Comp/PassiveComponentBase.hpp>
#include <Fw/FPrimeBasicTypes.hpp>
#include <Os/Queue.hpp>
#include <Os/Task.hpp>

namespace Fw {
class QueuedComponentBase : public PassiveComponentBase {
  public:
    // Note: Had to make MsgDispatchStatus public for LLVM.
    typedef enum {
        MSG_DISPATCH_OK,     
        MSG_DISPATCH_EMPTY,  
        MSG_DISPATCH_ERROR,  
        MSG_DISPATCH_EXIT    
    } MsgDispatchStatus;
    void deinit() override;  

  protected:
    QueuedComponentBase(const char* name);  
    virtual ~QueuedComponentBase();         
    void init(FwEnumStoreType instance);    
    Os::Queue m_queue;                      
    Os::Queue::Status createQueue(FwSizeType depth, FwSizeType msgSize);
    virtual MsgDispatchStatus doDispatch() = 0;  

    MsgDispatchStatus dispatchAvailableMessages();
#if FW_OBJECT_TO_STRING == 1
    const char* getToStringFormatString() override;  
#endif
    FwSizeType getNumMsgsDropped();  
    void incNumMsgDropped();         
  private:
    FwSizeType m_msgsDropped;  
};

}  // namespace Fw
#endif