Svc::BufferRepeater Class Reference

#include <Svc/BufferRepeater/BufferRepeater.hpp>

Inheritance diagram for Svc::BufferRepeater:

Public Types
enum	BufferRepeaterFailureOption { NO_RESPONSE_ON_OUT_OF_MEMORY , WARNING_ON_OUT_OF_MEMORY , FATAL_ON_OUT_OF_MEMORY , NUM_BUFFER_REPEATER_FAILURE_OPTIONS }

Public Member Functions
	BufferRepeater (const char *const compName)
void	init (const NATIVE_INT_TYPE instance=0)
	~BufferRepeater ()
void	configure (BufferRepeaterFailureOption allocation_failure_response)
Public Member Functions inherited from Svc::BufferRepeaterComponentBase
void	init (NATIVE_INT_TYPE instance=0)
	Initialize BufferRepeaterComponentBase object. More...
Fw::InputBufferSendPort *	get_portIn_InputPort (NATIVE_INT_TYPE portNum)
void	set_Log_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)
	Connect port to Log[portNum]. More...
void	set_Time_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)
	Connect port to Time[portNum]. More...
void	set_allocate_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferGetPort *port)
	Connect port to allocate[portNum]. More...
void	set_deallocate_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
	Connect port to deallocate[portNum]. More...
void	set_portOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
	Connect port to portOut[portNum]. More...
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base. More...
U32	getIdBase () const

Additional Inherited Members
Protected Types inherited from Svc::BufferRepeaterComponentBase
enum	{ NUM_PORTIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...
enum	{ NUM_LOG_OUTPUT_PORTS = 1 , NUM_LOGTEXT_OUTPUT_PORTS = 1 , NUM_TIME_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...
enum	{ NUM_ALLOCATE_OUTPUT_PORTS = 1 , NUM_DEALLOCATE_OUTPUT_PORTS = 1 , NUM_PORTOUT_OUTPUT_PORTS = 10 }
	Enumerations for numbers of typed output ports. More...
enum	{ EVENTID_ALLOCATIONSOFTFAILURE = 0x0 , EVENTID_ALLOCATIONHARDFAILURE = 0x1 }
	Event IDs. More...
Protected Member Functions inherited from Svc::BufferRepeaterComponentBase
	BufferRepeaterComponentBase (const char *compName="")
	Construct BufferRepeaterComponentBase object. More...
virtual	~BufferRepeaterComponentBase ()
	Destroy BufferRepeaterComponentBase object. More...
NATIVE_INT_TYPE	getNum_portIn_InputPorts () const
NATIVE_INT_TYPE	getNum_Log_OutputPorts () const
NATIVE_INT_TYPE	getNum_Time_OutputPorts () const
NATIVE_INT_TYPE	getNum_allocate_OutputPorts () const
NATIVE_INT_TYPE	getNum_deallocate_OutputPorts () const
NATIVE_INT_TYPE	getNum_portOut_OutputPorts () const
bool	isConnected_Log_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_Time_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_allocate_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_deallocate_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_portOut_OutputPort (NATIVE_INT_TYPE portNum)
void	portIn_handlerBase (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Handler base-class function for input port portIn. More...
Fw::Buffer	allocate_out (NATIVE_INT_TYPE portNum, U32 size)
	Invoke output port allocate. More...
void	deallocate_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Invoke output port deallocate. More...
void	portOut_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Invoke output port portOut. More...
void	log_WARNING_HI_AllocationSoftFailure (I32 port, U32 size)
void	log_FATAL_AllocationHardFailure (I32 port, U32 size)
Fw::Time	getTime ()
Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor. More...
virtual	~PassiveComponentBase ()
	Destructor. More...
void	init (NATIVE_INT_TYPE instance)
	Initialization function. More...
NATIVE_INT_TYPE	getInstance () const
Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor. More...
virtual	~ObjBase ()
	Destructor. More...
void	init ()
	Object initializer. More...

Detailed Description

Definition at line 20 of file BufferRepeater.hpp.

Member Enumeration Documentation

BufferRepeaterFailureOption

enum Svc::BufferRepeater::BufferRepeaterFailureOption

Set of responses to failures to allocate a buffer when requested

Enumerator
NO_RESPONSE_ON_OUT_OF_MEMORY	The component will continue regardless of allocation failures
WARNING_ON_OUT_OF_MEMORY	The component will produce a warning on allocation failures
FATAL_ON_OUT_OF_MEMORY	The component will produce a FATAL on allocation failures
NUM_BUFFER_REPEATER_FAILURE_OPTIONS	Maximum value of this setting. Used to mark as uninitialized.

Definition at line 25 of file BufferRepeater.hpp.

Constructor & Destructor Documentation

BufferRepeater()

Svc::BufferRepeater::BufferRepeater

(

const char *const

compName

)

Construct object BufferRepeater

Parameters

compName

The component name

Definition at line 22 of file BufferRepeater.cpp.

~BufferRepeater()

Svc::BufferRepeater::~BufferRepeater

(

)

Destroy object BufferRepeater

Definition at line 30 of file BufferRepeater.cpp.

Member Function Documentation

configure()

void Svc::BufferRepeater::configure

(

BufferRepeater::BufferRepeaterFailureOption

allocation_failure_response

)

Set the response used when an allocation request fails to produce a buffer. By default this will assert.

Parameters

allocation_failure_response

set response

Definition at line 32 of file BufferRepeater.cpp.

init()

void Svc::BufferRepeater::init

(

const NATIVE_INT_TYPE

instance = 0

)

Initialize object BufferRepeater

Parameters

instance

The instance number

Definition at line 26 of file BufferRepeater.cpp.

---

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

• Svc/BufferRepeater/BufferRepeater.hpp
• Svc/BufferRepeater/BufferRepeater.cpp