F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
FramingProtocolInterface.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title FramingProtocolInterface.hpp
3 // \author mstarch
4 // \brief hpp file for framing protocol interface
5 //
6 // \copyright
7 // Copyright 2009-2022, by the California Institute of Technology.
8 // ALL RIGHTS RESERVED. United States Government Sponsorship
9 // acknowledged.
10 //
11 // ======================================================================
12 
13 #ifndef SVC_FRAMING_PROTOCOL_INTERFACE_HPP
14 #define SVC_FRAMING_PROTOCOL_INTERFACE_HPP
15 
16 #include <Fw/Buffer/Buffer.hpp>
17 #include <Fw/Time/Time.hpp>
18 
19 namespace Svc {
20 
28 class FramingProtocolInterface {
29  public:
30  virtual ~FramingProtocolInterface(){};
34  virtual Fw::Buffer allocate(const U32 size) = 0;
35 
38  virtual void send(Fw::Buffer& outgoing) = 0;
39 
40 };
41 
42 }
43 #endif // SVC_FRAMING_PROTOCOL_INTERFACE_HPP
44 
Time.hpp
Svc::FramingProtocolInterface::send
virtual void send(Fw::Buffer &outgoing)=0
send framed data out of the framer
Svc
RateGroupDivider component implementation.
Definition: ActiveRateGroupCfg.hpp:18
Svc::FramingProtocolInterface
interface supplied to the framing protocol
Definition: FramingProtocolInterface.hpp:28
Buffer.hpp
Svc::FramingProtocolInterface::allocate
virtual Fw::Buffer allocate(const U32 size)=0
allocation callback to allocate memory when framing