F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Svc::DeframingProtocolInterface Class Referenceabstract

interface supplied to the deframing protocol More...

#include <Svc/FramingProtocol/DeframingProtocolInterface.hpp>

Inheritance diagram for Svc::DeframingProtocolInterface:
Svc::Deframer

Public Member Functions

virtual ~DeframingProtocolInterface ()
 
virtual Fw::Buffer allocate (const U32 size)=0
 called to allocate memory, typically delegating to an allocate port call More...
 
virtual void route (Fw::Buffer &data)=0
 send deframed data into the system More...
 

Detailed Description

interface supplied to the deframing protocol

In order to supply necessary fprime actions to deframing implementations this class provides the necessary functions. Typically the DeframerComponentImpl is the concrete implementor of this interface.

Definition at line 29 of file DeframingProtocolInterface.hpp.

Constructor & Destructor Documentation

◆ ~DeframingProtocolInterface()

virtual Svc::DeframingProtocolInterface::~DeframingProtocolInterface ( )
inlinevirtual

Definition at line 31 of file DeframingProtocolInterface.hpp.

Member Function Documentation

◆ allocate()

virtual Fw::Buffer Svc::DeframingProtocolInterface::allocate ( const U32  size)
pure virtual

called to allocate memory, typically delegating to an allocate port call

Parameters
sizesize of the allocation request
Returns
Fw::Buffer wrapping allocated memory

◆ route()

virtual void Svc::DeframingProtocolInterface::route ( Fw::Buffer data)
pure virtual

send deframed data into the system

Parameters
datadeframed buffer

The documentation for this class was generated from the following file: