QCenController is a centralized controller used for re-routing. More...

#include "qcen-control.h"

Inheritance diagram for ns3::QCenController:

Collaboration diagram for ns3::QCenController:

Public Member Functions
	QCenController ()

	QCenController (std::vector< Ptr< QKDControl > > controllers)

	~QCenController () override

std::vector< std::pair< uint32_t, uint32_t > >	DijkstraSP (std::vector< std::vector< std::pair< uint32_t, uint32_t > > > adjList, uint32_t start)

uint32_t	GetColumn (uint32_t nodeId)

void	LinkDown (uint32_t source, uint32_t destination)

void	LinkUp (uint32_t source, uint32_t destination)

void	PopulateRoutingTables ()

void	RegisterDControllers (std::vector< Ptr< QKDControl > > controllers)

uint32_t	ReverseColumn (uint32_t position)

void	SetNode (Ptr< Node > node)

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
std::vector< std::vector< std::pair< uint32_t, uint32_t > > >	m_adjList

std::vector< Ptr< QKDControl > >	m_controllerList
	List of all controllers.

std::map< uint32_t, Ptr< QKDControl > >	m_controllers

Ptr< Node >	m_node

Ptr< QKDLocationRegister >	m_routingTable
	Routing Table.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

QCenController is a centralized controller used for re-routing.

Note: Distributed QControllers in every QKD node inform QCenController about the state of QKD Links. If the QKD Link is EMPTY, a notification is sent, and QCenController updates routing tables for every QController. It has two routing tables, one default, starting and one working table.

Definition at line 45 of file qcen-control.h.

Constructor & Destructor Documentation

◆ QCenController() [1/2]

ns3::QCenController::QCenController ( )

Definition at line 44 of file qcen-control.cc.

References NS_LOG_FUNCTION.

◆ QCenController() [2/2]

ns3::QCenController::QCenController ( std::vector< Ptr< QKDControl > > controllers )

Definition at line 49 of file qcen-control.cc.

References ns3::Create(), m_adjList, m_controllerList, m_controllers, NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ ~QCenController()

ns3::QCenController::~QCenController ( )

override

Definition at line 72 of file qcen-control.cc.

Member Function Documentation

◆ DijkstraSP()

std::vector< std::pair< uint32_t, uint32_t > > ns3::QCenController::DijkstraSP	(	std::vector< std::vector< std::pair< uint32_t, uint32_t > > >	adjList,
		uint32_t	start
	)

Definition at line 195 of file qcen-control.cc.

References ns3::Create().

Referenced by PopulateRoutingTables().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetColumn()

uint32_t ns3::QCenController::GetColumn ( uint32_t nodeId )

Definition at line 128 of file qcen-control.cc.

References ns3::Create(), and m_controllers.

Referenced by LinkDown(), LinkUp(), PopulateRoutingTables(), and RegisterDControllers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::QCenController::GetTypeId ( )

static

Definition at line 35 of file qcen-control.cc.

References ns3::Create(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ LinkDown()

void ns3::QCenController::LinkDown	(	uint32_t	source,
		uint32_t	destination
	)

Definition at line 152 of file qcen-control.cc.

References ns3::Create(), GetColumn(), m_adjList, NS_LOG_FUNCTION, and PopulateRoutingTables().

Here is the call graph for this function:

◆ LinkUp()

void ns3::QCenController::LinkUp	(	uint32_t	source,
		uint32_t	destination
	)

Definition at line 173 of file qcen-control.cc.

References ns3::Create(), GetColumn(), m_adjList, NS_LOG_FUNCTION, and PopulateRoutingTables().

Here is the call graph for this function:

◆ PopulateRoutingTables()

void ns3::QCenController::PopulateRoutingTables ( )

Definition at line 249 of file qcen-control.cc.

References ns3::Create(), DijkstraSP(), GetColumn(), m_adjList, m_controllers, NS_LOG_FUNCTION, and ReverseColumn().

Referenced by LinkDown(), LinkUp(), and RegisterDControllers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegisterDControllers()

void ns3::QCenController::RegisterDControllers ( std::vector< Ptr< QKDControl > > controllers )

Definition at line 78 of file qcen-control.cc.

References ns3::Create(), GetColumn(), m_adjList, m_controllerList, m_controllers, NS_ASSERT, NS_LOG_FUNCTION, and PopulateRoutingTables().

Here is the call graph for this function:

◆ ReverseColumn()

uint32_t ns3::QCenController::ReverseColumn ( uint32_t position )

Definition at line 142 of file qcen-control.cc.

References ns3::Create(), m_controllers, and NS_LOG_ERROR.

Referenced by PopulateRoutingTables().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetNode()

void ns3::QCenController::SetNode ( Ptr< Node > node )

Definition at line 122 of file qcen-control.cc.

References m_node.

Member Data Documentation

◆ m_adjList

std::vector< std::vector<std::pair<uint32_t, uint32_t> > > ns3::QCenController::m_adjList

private

Definition at line 76 of file qcen-control.h.

Referenced by QCenController(), LinkDown(), LinkUp(), PopulateRoutingTables(), and RegisterDControllers().

◆ m_controllerList

std::vector<Ptr<QKDControl> > ns3::QCenController::m_controllerList

private

List of all controllers.

Definition at line 78 of file qcen-control.h.

Referenced by QCenController(), and RegisterDControllers().

◆ m_controllers

std::map<uint32_t, Ptr<QKDControl> > ns3::QCenController::m_controllers

private

Definition at line 74 of file qcen-control.h.

Referenced by QCenController(), GetColumn(), PopulateRoutingTables(), RegisterDControllers(), and ReverseColumn().

◆ m_node

Ptr<Node> ns3::QCenController::m_node

private

Definition at line 82 of file qcen-control.h.

Referenced by SetNode().

◆ m_routingTable

Ptr<QKDLocationRegister> ns3::QCenController::m_routingTable

private

Routing Table.

Definition at line 80 of file qcen-control.h.

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

src/qkd/model/qcen-control.h
src/qkd/model/qcen-control.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QCenController() [1/2]

◆ QCenController() [2/2]

◆ ~QCenController()

Member Function Documentation

◆ DijkstraSP()

◆ GetColumn()

◆ GetTypeId()

◆ LinkDown()

◆ LinkUp()

◆ PopulateRoutingTables()

◆ RegisterDControllers()

◆ ReverseColumn()

◆ SetNode()

Member Data Documentation

◆ m_adjList

◆ m_controllerList

◆ m_controllers

◆ m_node

◆ m_routingTable