Svc::Framer Class Reference

Generic framing component using FramingProtocol implementation for actual framing. More...

#include <Svc/Framer/Framer.hpp>

Inheritance diagram for Svc::Framer:

Public Member Functions
	Framer (const char *const compName)
void	init (const NATIVE_INT_TYPE instance=0)
void	setup (FramingProtocol &protocol)
	Setup this component with a supplied framing protocol.
	~Framer ()
Public Member Functions inherited from Svc::FramingProtocolInterface
virtual	~FramingProtocolInterface ()
virtual Fw::Buffer	allocate (const U32 size)=0
	allocation callback to allocate memory when framing
virtual void	send (Fw::Buffer &outgoing)=0
	send framed data out of the framer

Detailed Description

Generic framing component using FramingProtocol implementation for actual framing.

Framing component used to take Com and File packets and frame serialize them using a framing protocol specified in a FramingProtocol instance. The instance must be supplied using the setup method.

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

Definition at line 31 of file Framer.hpp.

Constructor & Destructor Documentation

Framer()

Svc::Framer::Framer

(

const char *const

compName

)

Construct object Framer

Parameters

compName

The component name

Definition at line 24 of file Framer.cpp.

~Framer()

Svc::Framer::~Framer

(

)

Destroy object Framer

Definition at line 31 of file Framer.cpp.

Member Function Documentation

init()

void Svc::Framer::init

(

const NATIVE_INT_TYPE

instance = 0

)

Initialize object Framer

Parameters

instance

The instance number

Definition at line 27 of file Framer.cpp.

setup()

void Svc::Framer::setup

(

FramingProtocol &

protocol

)

Setup this component with a supplied framing protocol.

Parameters

protocol

Protocol used in framing

Definition at line 33 of file Framer.cpp.

---

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

• Svc/Framer/Framer.hpp
• Svc/Framer/Framer.cpp