Queue management interface used by BaseModel More...

#include <queuemanager.h>

Inheritance diagram for EMANE::Models::TDMA::QueueManager:

Public Member Functions
virtual	~QueueManager ()

virtual size_t	enqueue (std::uint8_t u8QueueIndex, DownstreamPacket &&pkt)=0

virtual std::tuple< EMANE::Models::TDMA::MessageComponents, size_t >	dequeue (std::uint8_t u8QueueIndex, size_t length, NEMId destination)=0

virtual QueueInfos	getPacketQueueInfo () const =0

virtual void	initialize (Registrar &registrar)=0

virtual void	configure (const ConfigurationUpdate &update)=0

virtual void	start ()=0

virtual void	postStart ()

virtual void	stop ()=0

virtual void	destroy ()=0 throw ()

virtual void	processConfiguration (const ConfigurationUpdate &update)

void	setPacketStatusPublisher (PacketStatusPublisher *pPacketStatusPublisher)

Protected Member Functions
	QueueManager (NEMId id, PlatformServiceProvider *pPlatformServiceProvider)

Protected Attributes
NEMId	id_

PlatformServiceProvider *	pPlatformService_

PacketStatusPublisher *	pPacketStatusPublisher_

Detailed Description

Queue management interface used by BaseModel

Definition at line 57 of file queuemanager.h.

Constructor & Destructor Documentation

◆ ~QueueManager()

virtual EMANE::Models::TDMA::QueueManager::~QueueManager ( )

inlinevirtual

Destroys an instance.

Definition at line 66 of file queuemanager.h.

◆ QueueManager()

EMANE::Models::TDMA::QueueManager::QueueManager	(	NEMId	id,
		PlatformServiceProvider *	pPlatformServiceProvider
	)

inlineprotected

Creates an instance.

Definition at line 120 of file queuemanager.h.

Member Function Documentation

◆ configure()

virtual void EMANE::Component::configure ( const ConfigurationUpdate & update )

pure virtualinherited

Configure the component.

Parameters

update Configuration update values

Exceptions

ConfigureException thrown when a unexpected configuration item is encountered or there is a problem with the specified item value

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::Transports::Virtual::VirtualTransport, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::FrameworkPHY, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportAdapterImpl, EMANE::MACLayer, EMANE::PHYLayer, EMANE::ShimLayer, EMANE::Application::TransportManagerImpl, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

◆ dequeue()

virtual std::tuple<EMANE::Models::TDMA::MessageComponents, size_t> EMANE::Models::TDMA::QueueManager::dequeue	(	std::uint8_t	u8QueueIndex,
		size_t	length,
		NEMId	destination
	)

pure virtual

Dequeues a specified number of bytes from a specified queue.

Parameters

u8QueueIndex	Queue index of target queue
length	length to dequeue in bytes
destination	NEM destination to dequeue, 0 indicates any NEM.

Returns: A tuple containing a list of MessageComponent entries and the the total size in bytes across all entries.

Note: Unless restricted by configuration, the dequeue operation will search multiple queues (highest priority first) in order to return the specified number of bytes. If fragmentation is disabled, all packets in the initially specified queue that are larger than the requested size will be discarded.

Implemented in EMANE::Models::TDMA::BasicQueueManager.

◆ destroy()

virtual void EMANE::Component::destroy	(	)
throw	(
	)

pure virtualinherited

Destroy the component.

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Transports::Virtual::VirtualTransport, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::Models::TDMA::EventScheduler, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::BaseModel, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::FrameworkPHY, EMANE::Application::TransportAdapterImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::MACLayer, EMANE::PHYLayer, EMANE::ShimLayer, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportManagerImpl, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

◆ enqueue()

virtual size_t EMANE::Models::TDMA::QueueManager::enqueue	(	std::uint8_t	u8QueueIndex,
		DownstreamPacket &&	pkt
	)

pure virtual

Enqueues a packet in to a specified queue.

Parameters

u8QueueIndex	Queue index of target queue
pkt	Packet to enqueue

Returns: The number of packets dropped as a result of this enqueue. This value would be non-zero in the case of overflow.

Implemented in EMANE::Models::TDMA::BasicQueueManager.

◆ getPacketQueueInfo()

virtual QueueInfos EMANE::Models::TDMA::QueueManager::getPacketQueueInfo ( ) const

pure virtual

Gets queue status.

Returns: A list of QueueInfo entries.

Implemented in EMANE::Models::TDMA::BasicQueueManager.

◆ initialize()

virtual void EMANE::Component::initialize ( Registrar & registrar )

pure virtualinherited

Initialize the component.

Exceptions

InitializeException thrown when an error is encountered during initialization

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::Transports::Virtual::VirtualTransport, EMANE::NEMQueuedLayer, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::FrameworkPHY, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportAdapterImpl, EMANE::MACLayer, EMANE::PHYLayer, EMANE::ShimLayer, EMANE::Application::TransportManagerImpl, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

◆ postStart()

virtual void EMANE::Component::postStart ( )

inlinevirtualinherited

Hook to run any post start functionaililty. Called after all the components have been started.

Reimplemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Transports::Virtual::VirtualTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::ShimLayer, EMANE::Application::TransportAdapterImpl, EMANE::MACLayer, EMANE::PHYLayer, EMANE::TransportLayer, EMANE::Application::TransportManagerImpl, and EMANE::Models::TDMA::BasicQueueManager.

Definition at line 119 of file component.h.

◆ processConfiguration()

virtual void EMANE::RunningStateMutable::processConfiguration ( const ConfigurationUpdate & update )

inlinevirtualinherited

Process dynamic running-state configuration updates

Parameters

update Configuration update

Note: Running state configuration errors are indicated using a validator. Validators can be registered using the ConfigurationRegistrar.

Reimplemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::TDMA::BaseModel, EMANE::NEMStatefulLayer, EMANE::NEMQueuedLayer, and EMANE::FrameworkPHY.

Definition at line 63 of file runningstatemutable.h.

◆ setPacketStatusPublisher()

void EMANE::Models::TDMA::PacketStatusPublisherUser::setPacketStatusPublisher ( PacketStatusPublisher * pPacketStatusPublisher )

inlineinherited

Sets the PacketStatusPublisher

Parameters

pPacketStatusPublisher PacketStatusPublisher reference

Definition at line 64 of file packetstatuspublisheruser.h.

◆ start()

virtual void EMANE::Component::start ( )

pure virtualinherited

Start the component.

Exceptions

StartException thrown when an error is encountered during start.

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::Transports::Virtual::VirtualTransport, EMANE::NEMQueuedLayer, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::FrameworkPHY, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportAdapterImpl, EMANE::Application::TransportManagerImpl, EMANE::MACLayer, EMANE::PHYLayer, EMANE::ShimLayer, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

◆ stop()

virtual void EMANE::Component::stop ( )

pure virtualinherited

Stop the component.

Exceptions

StopException thrown when an error is encountered during stop

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Transports::Virtual::VirtualTransport, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::NEMQueuedLayer, EMANE::Models::TDMA::EventScheduler, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::BaseModel, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::FrameworkPHY, EMANE::Application::TransportAdapterImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::MACLayer, EMANE::PHYLayer, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportManagerImpl, EMANE::ShimLayer, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

Member Data Documentation

◆ id_

NEMId EMANE::Models::TDMA::QueueManager::id_

protected

Definition at line 115 of file queuemanager.h.

◆ pPacketStatusPublisher_

PacketStatusPublisher* EMANE::Models::TDMA::PacketStatusPublisherUser::pPacketStatusPublisher_

protectedinherited

Definition at line 70 of file packetstatuspublisheruser.h.

◆ pPlatformService_

PlatformServiceProvider* EMANE::PlatformServiceUser::pPlatformService_

protectedinherited

Definition at line 64 of file platformserviceuser.h.

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

queuemanager.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~QueueManager()

◆ QueueManager()

Member Function Documentation

◆ configure()

◆ dequeue()

◆ destroy()

◆ enqueue()

◆ getPacketQueueInfo()

◆ initialize()

◆ postStart()

◆ processConfiguration()

◆ setPacketStatusPublisher()

◆ start()

◆ stop()

Member Data Documentation

◆ id_

◆ pPacketStatusPublisher_

◆ pPlatformService_