F´ Flight Software - C/C++ Documentation  NASA-v2.1.0
A framework for building embedded system applications to NASA flight quality standards.
Svc::DeframerComponentImpl Class Reference

Generic deframing component using DeframingProtocol implementation for actual deframing. More...

#include <Svc/Deframer/DeframerComponentImpl.hpp>

Inheritance diagram for Svc::DeframerComponentImpl:
DeframingProtocolInterface

Public Member Functions

 DeframerComponentImpl (const char *const compName)
 
void init (const NATIVE_INT_TYPE instance=0)
 
 ~DeframerComponentImpl (void)
 
void setup (DeframingProtocol &protocol)
 
- Public Member Functions inherited from DeframingProtocolInterface
virtual ~DeframingProtocolInterface ()
 

Detailed Description

Generic deframing component using DeframingProtocol implementation for actual deframing.

Deframing component used to take byte streams and expand them into Com/File buffers. This is done using a deframing protocol specified in a DeframingProtocol instance. The instance must be supplied using the setup method.

Using this component, projects can implement and supply a fresh DeframingProtocol implementation without changing the reference topology.

Implementation uses a circular buffer to store incoming data, which is drained one framed packet at a time into buffers dispatched to the rest of the system.

Definition at line 35 of file DeframerComponentImpl.hpp.

Constructor & Destructor Documentation

◆ DeframerComponentImpl()

Svc::DeframerComponentImpl::DeframerComponentImpl ( const char *const  compName)

Construct object Deframer

Parameters
compNameThe component name

Definition at line 24 of file DeframerComponentImpl.cpp.

◆ ~DeframerComponentImpl()

Svc::DeframerComponentImpl::~DeframerComponentImpl ( void  )

Destroy object Deframer

Definition at line 32 of file DeframerComponentImpl.cpp.

Member Function Documentation

◆ init()

void Svc::DeframerComponentImpl::init ( const NATIVE_INT_TYPE  instance = 0)

Initialize object Deframer

Parameters
instanceThe instance number

Definition at line 28 of file DeframerComponentImpl.cpp.

◆ setup()

void Svc::DeframerComponentImpl::setup ( DeframingProtocol protocol)

Setup the object

Parameters
protocolDeframing protocol instance

Definition at line 34 of file DeframerComponentImpl.cpp.


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