Svc::ComQueue Class Reference

#include <Svc/ComQueue/ComQueue.hpp>

Inheritance diagram for Svc::ComQueue:

Classes
struct	QueueConfigurationEntry
	configuration data for each queue More...
struct	QueueConfigurationTable
	configuration table for each queue More...

Public Member Functions
	ComQueue (const char *const compName)
void	init (const NATIVE_INT_TYPE queueDepth, const NATIVE_INT_TYPE instance=0)
	~ComQueue ()
void	configure (QueueConfigurationTable queueConfig, NATIVE_UINT_TYPE allocationId, Fw::MemAllocator &allocator)
void	cleanup ()

Static Public Attributes
static const FwIndexType	COM_PORT_COUNT = ComQueueComponentBase::NUM_COMQUEUEIN_INPUT_PORTS
	< Count of Fw::Com input ports and thus Fw::Com queues
static const FwIndexType	BUFFER_PORT_COUNT = ComQueueComponentBase::NUM_BUFFQUEUEIN_INPUT_PORTS
	Total count of input buffer ports and thus total queues.
static const FwIndexType	TOTAL_PORT_COUNT = COM_PORT_COUNT + BUFFER_PORT_COUNT

Detailed Description

Definition at line 23 of file ComQueue.hpp.

Constructor & Destructor Documentation

ComQueue()

Svc::ComQueue::ComQueue

(

const char *const

compName

)

Construct object ComQueue

Parameters

compName

The component name

Definition at line 24 of file ComQueue.cpp.

~ComQueue()

Svc::ComQueue::~ComQueue

(

)

Destroy object ComQueue

Definition at line 36 of file ComQueue.cpp.

Member Function Documentation

cleanup()

void Svc::ComQueue::cleanup

(

)

Deallocate resources and cleanup ComQueue

Definition at line 42 of file ComQueue.cpp.

configure()

void Svc::ComQueue::configure	(	QueueConfigurationTable	queueConfig,
		NATIVE_UINT_TYPE	allocationId,
		Fw::MemAllocator &	allocator
	)

Configure the queue depths, priorities, and memory allocation for the component

Takes in the queue depth and priority per-port in order from Fw::Com through Fw::Buffer ports. Calculates the queue metadata stored m_prioritizedList and then sorts that list by priority.

Parameters

queueConfig	Table of the configuration properties for the component
allocationId	Identifier used when dealing with the Fw::MemAllocator
allocator	Fw::MemAllocator used to acquire memory

Definition at line 49 of file ComQueue.cpp.

init()

void Svc::ComQueue::init	(	const NATIVE_INT_TYPE	queueDepth,
		const NATIVE_INT_TYPE	instance = 0
	)

Initialize object ComQueue

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 38 of file ComQueue.cpp.

Member Data Documentation

BUFFER_PORT_COUNT

const FwIndexType Svc::ComQueue::BUFFER_PORT_COUNT = ComQueueComponentBase::NUM_BUFFQUEUEIN_INPUT_PORTS

static

Total count of input buffer ports and thus total queues.

Definition at line 29 of file ComQueue.hpp.

COM_PORT_COUNT

const FwIndexType Svc::ComQueue::COM_PORT_COUNT = ComQueueComponentBase::NUM_COMQUEUEIN_INPUT_PORTS

static

< Count of Fw::Com input ports and thus Fw::Com queues

Count of Fw::Buffer input ports and thus Fw::Buffer queues

Definition at line 26 of file ComQueue.hpp.

TOTAL_PORT_COUNT

const FwIndexType Svc::ComQueue::TOTAL_PORT_COUNT = COM_PORT_COUNT + BUFFER_PORT_COUNT

static

Definition at line 32 of file ComQueue.hpp.

---

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

• Svc/ComQueue/ComQueue.hpp
• Svc/ComQueue/ComQueue.cpp