Routing table for FLAME. More...

#include "flame-rtable.h"

Inheritance diagram for ns3::flame::FlameRtable:

Collaboration diagram for ns3::flame::FlameRtable:

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

struct	Route
	Routing table entry. More...

Public Member Functions
	FlameRtable ()

	FlameRtable (const FlameRtable &)=delete

	~FlameRtable () override

void	AddPath (const Mac48Address destination, const Mac48Address retransmitter, const uint32_t interface, const uint8_t cost, const uint16_t seqnum)
	Add path. More...

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

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

FlameRtable &	operator= (const FlameRtable &)=delete

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_COST = 0xff
	Maximum (the best?) path cost. More...

Private Attributes
Time	m_lifetime
	Lifetime parameter. More...

std::map< Mac48Address, Route >	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 FLAME.

Definition at line 38 of file flame-rtable.h.

Constructor & Destructor Documentation

◆ FlameRtable() [1/2]

ns3::flame::FlameRtable::FlameRtable ( )

Definition at line 51 of file flame-rtable.cc.

◆ ~FlameRtable()

ns3::flame::FlameRtable::~FlameRtable ( )

override

Definition at line 56 of file flame-rtable.cc.

◆ FlameRtable() [2/2]

ns3::flame::FlameRtable::FlameRtable ( const FlameRtable & )

delete

Member Function Documentation

◆ AddPath()

void ns3::flame::FlameRtable::AddPath	(	const Mac48Address	destination,
		const Mac48Address	retransmitter,
		const uint32_t	interface,
		const uint8_t	cost,
		const uint16_t	seqnum
	)

Add path.

Parameters

destination	the destination address
retransmitter	the retransmitter address
interface	the interface
cost	the cost
seqnum	the sequence number

Definition at line 67 of file flame-rtable.cc.

References ns3::flame::FlameRtable::Route::cost, ns3::flame::FlameRtable::Route::interface, m_lifetime, m_routes, ns3::Simulator::Now(), NS_ASSERT, ns3::flame::FlameRtable::Route::retransmitter, ns3::flame::FlameRtable::Route::seqnum, and ns3::flame::FlameRtable::Route::whenExpire.

Referenced by ns3::flame::FlameProtocol::HandleDataFrame(), FlameRtableTest::TestAddPath(), and FlameRtableTest::TestLookup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDispose()

void ns3::flame::FlameRtable::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 61 of file flame-rtable.cc.

References m_routes.

◆ GetTypeId()

TypeId ns3::flame::FlameRtable::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 37 of file flame-rtable.cc.

References m_lifetime, ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Lookup()

FlameRtable::LookupResult ns3::flame::FlameRtable::Lookup ( Mac48Address destination )

Lookup path to destination.

Parameters

destination

Returns: Broadcast if not found

Definition at line 94 of file flame-rtable.cc.

References m_routes, ns3::Simulator::Now(), and NS_LOG_DEBUG.

Referenced by ns3::flame::FlameProtocol::HandleDataFrame(), ns3::flame::FlameProtocol::RequestRoute(), FlameRtableTest::TestExpire(), and FlameRtableTest::TestLookup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

FlameRtable& ns3::flame::FlameRtable::operator= ( const FlameRtable & )

delete

Member Data Documentation

◆ INTERFACE_ANY

const uint32_t ns3::flame::FlameRtable::INTERFACE_ANY = 0xffffffff

static

Means all interfaces.

Definition at line 42 of file flame-rtable.h.

Referenced by ns3::flame::FlameRtable::LookupResult::IsValid(), and ns3::flame::FlameProtocol::RequestRoute().

◆ m_lifetime

Time ns3::flame::FlameRtable::m_lifetime

private

Lifetime parameter.

Definition at line 135 of file flame-rtable.h.

Referenced by AddPath(), and GetTypeId().

◆ m_routes

std::map<Mac48Address, Route> ns3::flame::FlameRtable::m_routes

private

List of routes.

Definition at line 137 of file flame-rtable.h.

Referenced by AddPath(), DoDispose(), and Lookup().

◆ MAX_COST

const uint32_t ns3::flame::FlameRtable::MAX_COST = 0xff

static

Maximum (the best?) path cost.

Definition at line 44 of file flame-rtable.h.

Referenced by ns3::flame::FlameRtable::LookupResult::IsValid().

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

src/mesh/model/flame/flame-rtable.h
src/mesh/model/flame/flame-rtable.cc

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FlameRtable() [1/2]

◆ ~FlameRtable()

◆ FlameRtable() [2/2]

Member Function Documentation

◆ AddPath()

◆ DoDispose()

◆ GetTypeId()

◆ Lookup()

◆ operator=()

Member Data Documentation

◆ INTERFACE_ANY

◆ m_lifetime

◆ m_routes

◆ MAX_COST