Framer.hpp

Go to the documentation of this file.

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

#ifndef Svc_Framer_HPP
#define Svc_Framer_HPP

#include "Svc/Framer/FramerComponentAc.hpp"
#include "Svc/FramingProtocol/FramingProtocol.hpp"
#include "Svc/FramingProtocol/FramingProtocolInterface.hpp"

namespace Svc {
class Framer : public FramerComponentBase, public FramingProtocolInterface {
  public:
    // ----------------------------------------------------------------------
    // Construction, initialization, and destruction
    // ----------------------------------------------------------------------

    Framer(const char* const compName 
    );

    void setup(FramingProtocol& protocol );

    ~Framer();

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

    void comIn_handler(const NATIVE_INT_TYPE portNum, 
                       Fw::ComBuffer& data,           
                       U32 context                    
    );

    void bufferIn_handler(const NATIVE_INT_TYPE portNum, 
                          Fw::Buffer& fwBuffer           
    );

    void comStatusIn_handler(const NATIVE_INT_TYPE portNum, 
                             Fw::Success& condition );

    // ----------------------------------------------------------------------
    // Implementation of FramingProtocolInterface
    // ----------------------------------------------------------------------

    Fw::Buffer allocate(const U32 size);

    void send(Fw::Buffer& outgoing  
    );

    // ----------------------------------------------------------------------
    // Helper functions
    // ----------------------------------------------------------------------

    void handle_framing(const U8* const data, const U32 size, Fw::ComPacket::ComPacketType packet_type);

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

    FramingProtocol* m_protocol;

    bool m_frame_sent;
};

}  // end namespace Svc

#endif