Deframer.hpp

Go to the documentation of this file.

// ======================================================================
// \title  Deframer.hpp
// \author mstarch, bocchino
// \brief  hpp file for Deframer component implementation class
//
// \copyright
// Copyright 2009-2022, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================

#ifndef Svc_Deframer_HPP
#define Svc_Deframer_HPP

#include <DeframerCfg.hpp>

#include "Svc/Deframer/DeframerComponentAc.hpp"
#include "Svc/FramingProtocol/DeframingProtocol.hpp"
#include "Svc/FramingProtocol/DeframingProtocolInterface.hpp"
#include "Utils/Types/CircularBuffer.hpp"

namespace Svc {

class Deframer :
  public DeframerComponentBase,
  public DeframingProtocolInterface
{
  public:

    // ----------------------------------------------------------------------
    // Construction, initialization, and destruction
    // ----------------------------------------------------------------------

    Deframer(
        const char* const compName 
    );

    ~Deframer();

    void setup(
        DeframingProtocol& protocol 
    );

  PRIVATE:

    // ----------------------------------------------------------------------
    // Handler implementations for user-defined typed input ports
    // ----------------------------------------------------------------------

    void cmdResponseIn_handler(
        NATIVE_INT_TYPE portNum, 
        FwOpcodeType opcode, 
        U32 cmdSeq, 
        const Fw::CmdResponse& response 
    );

    void framedIn_handler(
        const NATIVE_INT_TYPE portNum, 
        Fw::Buffer& recvBuffer, 
        const Drv::RecvStatus& recvStatus 
    );

    void schedIn_handler(
        const NATIVE_INT_TYPE portNum, 
        U32 context 
    );

    // ----------------------------------------------------------------------
    // Implementation of DeframingProtocolInterface
    // ----------------------------------------------------------------------

    void route(
        Fw::Buffer& packetBuffer 
    );

    Fw::Buffer allocate(
        const U32 size 
    );

    // ----------------------------------------------------------------------
    // Helper methods
    // ----------------------------------------------------------------------

    void processBuffer(
        Fw::Buffer& buffer 
    );

    void processRing();

    // ----------------------------------------------------------------------
    // Member variables
    // ----------------------------------------------------------------------

    DeframingProtocol* m_protocol;

    Types::CircularBuffer m_inRing;

    U8 m_ringBuffer[DeframerCfg::RING_BUFFER_SIZE];

    U8 m_pollBuffer[DeframerCfg::POLL_BUFFER_SIZE];

};

}  // end namespace Svc

#endif