Routing table for HWMP – 802.11s routing protocol. More...

#include "hwmp-rtable.h"

Inheritance diagram for ns3::dot11s::HwmpRtable:

Collaboration diagram for ns3::dot11s::HwmpRtable:

Classes
struct	LookupResult
	Route lookup result, return type of LookupXXX methods. More...

struct	Precursor
	Route found in reactive mode. More...

struct	ProactiveRoute
	Route found in proactive mode. More...

struct	ReactiveRoute
	Route found in reactive mode. More...

Public Types
typedef std::vector< std::pair< uint32_t, Mac48Address > >	PrecursorList
	Path precursor = {MAC, interface ID}. More...

Public Member Functions
	HwmpRtable ()

	~HwmpRtable () override

void	DoDispose () override
	Destructor implementation. More...

std::vector< HwmpProtocol::FailedDestination >	GetUnreachableDestinations (Mac48Address peerAddress)
	When peer link with a given MAC-address fails - it returns list of unreachable destination addresses. More...

Add/delete paths
void	AddReactivePath (Mac48Address destination, Mac48Address retransmitter, uint32_t interface, uint32_t metric, Time lifetime, uint32_t seqnum)
	Add a reactive path. More...

void	AddProactivePath (uint32_t metric, Mac48Address root, Mac48Address retransmitter, uint32_t interface, Time lifetime, uint32_t seqnum)
	Add a proactive path. More...

void	AddPrecursor (Mac48Address destination, uint32_t precursorInterface, Mac48Address precursorAddress, Time lifetime)
	Add a precursor. More...

PrecursorList	GetPrecursors (Mac48Address destination)
	Get the precursors list. More...

void	DeleteProactivePath ()
	Delete all the proactive paths. More...

void	DeleteProactivePath (Mac48Address root)
	Delete all the proactive paths from a given root. More...

void	DeleteReactivePath (Mac48Address destination)
	Delete the reactive paths toward a destination. More...

Lookup
LookupResult	LookupReactive (Mac48Address destination)
	Lookup path to destination. More...

LookupResult	LookupReactiveExpired (Mac48Address destination)
	Return all reactive paths, including expired. More...

LookupResult	LookupProactive ()
	Find proactive path to tree root. More...

LookupResult	LookupProactiveExpired ()
	Return all proactive paths, including expired. More...

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

	~Object () override
	Destructor. More...

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

void	Dispose ()
	Dispose of this Object. More...

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

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

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

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

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

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

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

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

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

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

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

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () const
	Decrement the reference count. More...

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

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

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

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

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

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

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

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

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

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID. More...

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

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

Static Public Attributes
static const uint32_t	INTERFACE_ANY = 0xffffffff
	Means all interfaces. More...

static const uint32_t	MAX_METRIC = 0xffffffff
	Maximum (the best?) path metric. More...

Private Attributes
ProactiveRoute	m_root
	Path to proactive tree root MP. More...

std::map< Mac48Address, ReactiveRoute >	m_routes
	List of routes. More...

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

virtual void	DoInitialize ()
	Initialize() implementation. More...

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

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

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

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

Detailed Description

Routing table for HWMP – 802.11s routing protocol.

Definition at line 39 of file hwmp-rtable.h.

Member Typedef Documentation

◆ PrecursorList

typedef std::vector<std::pair<uint32_t, Mac48Address> > ns3::dot11s::HwmpRtable::PrecursorList

Path precursor = {MAC, interface ID}.

Definition at line 82 of file hwmp-rtable.h.

Constructor & Destructor Documentation

◆ HwmpRtable()

ns3::dot11s::HwmpRtable::HwmpRtable ( )

Definition at line 48 of file hwmp-rtable.cc.

References DeleteProactivePath().

Here is the call graph for this function:

◆ ~HwmpRtable()

ns3::dot11s::HwmpRtable::~HwmpRtable ( )

override

Definition at line 53 of file hwmp-rtable.cc.

Member Function Documentation

◆ AddPrecursor()

void ns3::dot11s::HwmpRtable::AddPrecursor	(	Mac48Address	destination,
		uint32_t	precursorInterface,
		Mac48Address	precursorAddress,
		Time	lifetime
	)

Add a precursor.

Parameters

destination	the destination address
precursorInterface	the precursor interface
precursorAddress	the address of the precursor
lifetime	the lifetime

Definition at line 106 of file hwmp-rtable.cc.

References ns3::dot11s::HwmpRtable::Precursor::address, ns3::dot11s::HwmpRtable::Precursor::interface, m_routes, ns3::Simulator::Now(), NS_LOG_FUNCTION, and ns3::dot11s::HwmpRtable::Precursor::whenExpire.

Referenced by ns3::dot11s::HwmpProtocol::ReceivePrep(), ns3::dot11s::HwmpProtocol::ReceivePreq(), and HwmpRtableTest::TestPrecursorAdd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddProactivePath()

void ns3::dot11s::HwmpRtable::AddProactivePath	(	uint32_t	metric,
		Mac48Address	root,
		Mac48Address	retransmitter,
		uint32_t	interface,
		Time	lifetime,
		uint32_t	seqnum
	)

Add a proactive path.

Parameters

metric	the metric
root	the address of the root
retransmitter	the retransmitter address
interface	the interface
lifetime	the lifetime
seqnum	the sequence number

Definition at line 89 of file hwmp-rtable.cc.

References ns3::dot11s::HwmpRtable::ProactiveRoute::interface, m_root, ns3::dot11s::HwmpRtable::ProactiveRoute::metric, ns3::Simulator::Now(), NS_LOG_FUNCTION, ns3::dot11s::HwmpRtable::ProactiveRoute::retransmitter, ns3::dot11s::HwmpRtable::ProactiveRoute::root, ns3::dot11s::HwmpRtable::ProactiveRoute::seqnum, and ns3::dot11s::HwmpRtable::ProactiveRoute::whenExpire.

Referenced by ns3::dot11s::HwmpProtocol::ReceivePreq(), HwmpRtableTest::TestAddPath(), and HwmpRtableTest::TestLookup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddReactivePath()

void ns3::dot11s::HwmpRtable::AddReactivePath	(	Mac48Address	destination,
		Mac48Address	retransmitter,
		uint32_t	interface,
		uint32_t	metric,
		Time	lifetime,
		uint32_t	seqnum
	)

Add a reactive path.

Parameters

destination	the destination address
retransmitter	the retransmitter address
interface	the interface
metric	the metric
lifetime	the lifetime
seqnum	the sequence number

Definition at line 64 of file hwmp-rtable.cc.

References ns3::Time::GetSeconds(), m_routes, ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::dot11s::HwmpProtocol::ReceivePrep(), ns3::dot11s::HwmpProtocol::ReceivePreq(), HwmpRtableTest::TestAddPath(), and HwmpRtableTest::TestLookup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DeleteProactivePath() [1/2]

void ns3::dot11s::HwmpRtable::DeleteProactivePath ( )

Delete all the proactive paths.

Definition at line 139 of file hwmp-rtable.cc.

References ns3::Mac48Address::GetBroadcast(), ns3::dot11s::HwmpRtable::ProactiveRoute::interface, INTERFACE_ANY, m_root, MAX_METRIC, ns3::dot11s::HwmpRtable::ProactiveRoute::metric, ns3::Simulator::Now(), NS_LOG_FUNCTION, ns3::dot11s::HwmpRtable::ProactiveRoute::precursors, ns3::dot11s::HwmpRtable::ProactiveRoute::retransmitter, ns3::dot11s::HwmpRtable::ProactiveRoute::seqnum, and ns3::dot11s::HwmpRtable::ProactiveRoute::whenExpire.

Referenced by HwmpRtable(), DeleteProactivePath(), ns3::dot11s::HwmpProtocol::GetPerrReceivers(), LookupProactive(), and HwmpRtableTest::TestLookup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DeleteProactivePath() [2/2]

void ns3::dot11s::HwmpRtable::DeleteProactivePath ( Mac48Address root )

Delete all the proactive paths from a given root.

Parameters

root	the address of the root

Definition at line 151 of file hwmp-rtable.cc.

References DeleteProactivePath(), m_root, NS_LOG_FUNCTION, and ns3::dot11s::HwmpRtable::ProactiveRoute::root.

Here is the call graph for this function:

◆ DeleteReactivePath()

void ns3::dot11s::HwmpRtable::DeleteReactivePath ( Mac48Address destination )

Delete the reactive paths toward a destination.

Parameters

destination the destination

Definition at line 161 of file hwmp-rtable.cc.

References m_routes, and NS_LOG_FUNCTION.

Referenced by ns3::dot11s::HwmpProtocol::GetPerrReceivers(), ns3::dot11s::HwmpProtocol::MakePathError(), and HwmpRtableTest::TestLookup().

Here is the caller graph for this function:

◆ DoDispose()

void ns3::dot11s::HwmpRtable::DoDispose ( void )

overridevirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 58 of file hwmp-rtable.cc.

References m_routes.