RMMOutputQueues Class Reference

Class for managing and configuring output queues. More...

#include <RMMOutputQueues.h>

Collaboration diagram for RMMOutputQueues:

Public Member Functions
	RMMOutputQueues (RMMRegisterAccess &RMMRegs)
	Constructor of the RMMOutputQueues.
const OutputQueueMap &	getAllEntries () const
	Retrieves all output queue entries.
void	configOutputQueues ()
	Configures the output queues for data processing.
rmmStatus	getOutputQueueForRing (int ring, std::shared_ptr< OutputQueueBase > &result)
	Retrieves the output queue data for a specific ring.
void	fillOutputQueuefromJson (json &outputQueues)
	Fills output queue configurations from a JSON object.

Public Attributes
RMMLog	rmmLog
	Log handler for RMMOutputQueues messages.

Detailed Description

Class for managing and configuring output queues.

This class provides functionality to configure, retrieve, and update output queues for data processing.

Constructor & Destructor Documentation

RMMOutputQueues()

RMMOutputQueues::RMMOutputQueues

(

RMMRegisterAccess &

RMMRegs

)

Constructor of the RMMOutputQueues.

Parameters

RMMRegs

Reference to the RMMRegisterAccess instance used for register interaction.

Member Function Documentation

configOutputQueues()

void RMMOutputQueues::configOutputQueues

(

)

Configures the output queues for data processing.

This method sets up the output queues by writing appropriate values to hardware registers. It first disables all output queues and packet generators before applying configuration settings. The method then iterates through all available output queues, applying necessary configurations based on the OutputQueueData structure.

fillOutputQueuefromJson()

void RMMOutputQueues::fillOutputQueuefromJson

(

json &

outputQueues

)

Fills output queue configurations from a JSON object.

This method parses a JSON object and populates the outputQueue map with configuration data for each ring. If no specific configuration for a ring is provided, the default configuration is used.

Parameters

outputQueues

The JSON object containing the output queue configurations.

getAllEntries()

const OutputQueueMap & RMMOutputQueues::getAllEntries ( ) const

inline

Retrieves all output queue entries.

Returns

A constant reference to the OutputQueueMap, containing the output queue configurations.

getOutputQueueForRing()

rmmStatus RMMOutputQueues::getOutputQueueForRing	(	int	ring,
		std::shared_ptr< OutputQueueBase > &	result )

Retrieves the output queue data for a specific ring.

Parameters

[in]	ring	The ring identifier.
[out]	result	Pointer to store the output queue data.

Returns

rmmSuccess if the ring is found, rmmError otherwise.

---

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

• include/RMMOutputQueues.h
• src/RMMOutputQueues.cpp