DeframingProtocol.hpp

Go to the documentation of this file.

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

#include "Fw/Com/ComPacket.hpp"
#include "Svc/FramingProtocol/DeframingProtocolInterface.hpp"
#include "Utils/Types/CircularBuffer.hpp"

#ifndef SVC_DEFRAMING_PROTOCOL_HPP
#define SVC_DEFRAMING_PROTOCOL_HPP

namespace Svc {

class DeframingProtocol {
  public:
    virtual ~DeframingProtocol() {};
    enum DeframingStatus {
        DEFRAMING_STATUS_SUCCESS,   
        DEFRAMING_INVALID_SIZE,     
        DEFRAMING_INVALID_CHECKSUM, 
        DEFRAMING_MORE_NEEDED,      
        DEFRAMING_INVALID_FORMAT,   
        DEFRAMING_MAX_STATUS        
    };
    DeframingProtocol();

    void setup(DeframingProtocolInterface& interface 
    );

    virtual DeframingStatus deframe(Types::CircularBuffer& buffer, 
                                    U32& needed                    
                                    ) = 0;

  protected:
    DeframingProtocolInterface* m_interface;
};
}  // namespace Svc
#endif  // SVC_DEFRAMING_PROTOCOL_HPP