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::FramerComponentBase
void	init (NATIVE_INT_TYPE instance=0)
	Initialize FramerComponentBase object.
Fw::InputBufferSendPort *	get_bufferIn_InputPort (NATIVE_INT_TYPE portNum)
Fw::InputComPort *	get_comIn_InputPort (NATIVE_INT_TYPE portNum)
Fw::InputSuccessConditionPort *	get_comStatusIn_InputPort (NATIVE_INT_TYPE portNum)
void	set_bufferDeallocate_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
	Connect port to bufferDeallocate[portNum].
void	set_comStatusOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputSuccessConditionPort *port)
	Connect port to comStatusOut[portNum].
void	set_framedAllocate_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferGetPort *port)
	Connect port to framedAllocate[portNum].
void	set_framedOut_OutputPort (NATIVE_INT_TYPE portNum, Drv::InputByteStreamSendPort *port)
	Connect port to framedOut[portNum].
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base.
U32	getIdBase () const
Public Member Functions inherited from Svc::FramingProtocolInterface
virtual	~FramingProtocolInterface ()

Additional Inherited Members
Protected Types inherited from Svc::FramerComponentBase
enum	{ NUM_BUFFERIN_INPUT_PORTS = 1 , NUM_COMIN_INPUT_PORTS = 1 , NUM_COMSTATUSIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...
enum	{ NUM_BUFFERDEALLOCATE_OUTPUT_PORTS = 1 , NUM_COMSTATUSOUT_OUTPUT_PORTS = 1 , NUM_FRAMEDALLOCATE_OUTPUT_PORTS = 1 , NUM_FRAMEDOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...
Protected Member Functions inherited from Svc::FramerComponentBase
	FramerComponentBase (const char *compName="")
	Construct FramerComponentBase object.
virtual	~FramerComponentBase ()
	Destroy FramerComponentBase object.
NATIVE_INT_TYPE	getNum_bufferIn_InputPorts () const
NATIVE_INT_TYPE	getNum_comIn_InputPorts () const
NATIVE_INT_TYPE	getNum_comStatusIn_InputPorts () const
NATIVE_INT_TYPE	getNum_bufferDeallocate_OutputPorts () const
NATIVE_INT_TYPE	getNum_comStatusOut_OutputPorts () const
NATIVE_INT_TYPE	getNum_framedAllocate_OutputPorts () const
NATIVE_INT_TYPE	getNum_framedOut_OutputPorts () const
bool	isConnected_bufferDeallocate_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_comStatusOut_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_framedAllocate_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_framedOut_OutputPort (NATIVE_INT_TYPE portNum)
void	bufferIn_handlerBase (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Handler base-class function for input port bufferIn.
void	comIn_handlerBase (NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)
	Handler base-class function for input port comIn.
void	comStatusIn_handlerBase (NATIVE_INT_TYPE portNum, Fw::Success &condition)
	Handler base-class function for input port comStatusIn.
void	bufferDeallocate_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Invoke output port bufferDeallocate.
void	comStatusOut_out (NATIVE_INT_TYPE portNum, Fw::Success &condition)
	Invoke output port comStatusOut.
Fw::Buffer	framedAllocate_out (NATIVE_INT_TYPE portNum, U32 size)
	Invoke output port framedAllocate.
Drv::SendStatus	framedOut_out (NATIVE_INT_TYPE portNum, Fw::Buffer &sendBuffer)
	Invoke output port framedOut.
virtual void	lock ()
	Lock the guarded mutex.
virtual void	unLock ()
	Unlock the guarded mutex.
Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor.
virtual	~PassiveComponentBase ()
	Destructor.
void	init (NATIVE_INT_TYPE instance)
	Initialization function.
NATIVE_INT_TYPE	getInstance () const
Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor.
virtual	~ObjBase ()
	Destructor.
void	init ()
	Object initializer.

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