F´ Flight Software - C/C++ Documentation  NASA-v2.0.0
A framework for building embedded system applications to NASA flight quality standards.
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
FramingProtocolInterface Class Referenceabstract

interface supplied to the framing protocol More...

#include <Svc/FramingProtocol/FramingProtocolInterface.hpp>

Inheritance diagram for FramingProtocolInterface:
Svc::FramerComponentImpl

Public Member Functions

virtual Fw::Buffer allocate (const U32 size)=0
 allocation callback to allocate memory when framing More...
 
virtual void send (Fw::Buffer &outgoing)=0
 send framed data out of the framer More...
 

Detailed Description

interface supplied to the framing protocol

In order to supply necessary fprime actions to framing implementations this allows the framing implementation to call the functions to delegate the actions. Typically the FramerComponentImpl is the concrete implementor of this interface.

Definition at line 26 of file FramingProtocolInterface.hpp.

Member Function Documentation

◆ allocate()

virtual Fw::Buffer FramingProtocolInterface::allocate ( const U32  size)
pure virtual

allocation callback to allocate memory when framing

Parameters
sizesize of the allocation request
Returns
buffer wrapping allocated memory

Implemented in Svc::FramerComponentImpl.

◆ send()

virtual void FramingProtocolInterface::send ( Fw::Buffer &  outgoing)
pure virtual

send framed data out of the framer

Parameters
outgoingframed data wrapped in an Fw::Buffer
The documentation for this class was generated from the following file: