F´ Flight Software - C/C++ Documentation  NASA-v2.0.1
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FramingProtocol.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title FramingProtocol.hpp
3 // \author mstarch
4 // \brief hpp file for FramingProtocol class
5 //
6 // \copyright
7 // Copyright 2009-2021, by the California Institute of Technology.
8 // ALL RIGHTS RESERVED. United States Government Sponsorship
9 // acknowledged.
10 //
11 // ======================================================================
12 
14 #include "Fw/Com/ComPacket.hpp"
15 
16 #ifndef FRAMING_PROTOCOL_HPP
17 #define FRAMING_PROTOCOL_HPP
18 
19 namespace Svc {
32  public:
36 
39  void setup(FramingProtocolInterface& interface);
40 
45  virtual void frame(const U8* const data, const U32 size, Fw::ComPacket::ComPacketType packet_type) = 0;
46 
47  PROTECTED:
49 };
50 };
51 #endif // OWLS_PROTOCOL_HPP
Svc::FramingProtocol::m_interface
FramingProtocolInterface * m_interface
Definition: FramingProtocol.hpp:48
U8
uint8_t U8
8-bit unsigned integer
Definition: BasicTypes.hpp:76
FramingProtocolInterface.hpp
FramingProtocolInterface
interface supplied to the framing protocol
Definition: FramingProtocolInterface.hpp:26
Svc::FramingProtocol::FramingProtocol
FramingProtocol()
constructor
Definition: FramingProtocol.cpp:19
Svc::FramingProtocol::frame
virtual void frame(const U8 *const data, const U32 size, Fw::ComPacket::ComPacketType packet_type)=0
frame a given set of bytes
Svc::FramingProtocol::setup
void setup(FramingProtocolInterface &interface)
setup function called to supply the interface used for allocation and sending
Definition: FramingProtocol.cpp:21
Svc::FramingProtocol
abstract class representing a framing protocol
Definition: FramingProtocol.hpp:31
Svc
Definition: ActiveRateGroupImplCfg.hpp:18
Fw::ComPacket::ComPacketType
ComPacketType
Definition: ComPacket.hpp:21
ComPacket.hpp