DSR route request queue Since DSR is an on demand routing we queue requests while looking for route. More...

#include "dsr-rcache.h"

Inheritance diagram for ns3::dsr::DsrRouteCache:

Collaboration diagram for ns3::dsr::DsrRouteCache:

Classes
struct	Neighbor
	The following code handles link-layer acks. More...

Public Types
typedef std::list< DsrRouteCacheEntry::IP_VECTOR >	routeVector
	Define the vector of route entries. More...

Public Member Functions
	DsrRouteCache ()

virtual	~DsrRouteCache ()

void	AddArpCache (Ptr< ArpCache >)
	Add ARP cache to be used to allow layer 2 notifications processing. More...

void	AddNeighbor (std::vector< Ipv4Address > nodeList, Ipv4Address ownAddress, Time expire)
	Add to the neighbor list. More...

bool	AddRoute (DsrRouteCacheEntry &rt)
	Add route cache entry if it doesn't yet exist in route cache. More...

bool	AddRoute_Link (DsrRouteCacheEntry::IP_VECTOR nodelist, Ipv4Address node)

uint16_t	CheckUniqueAckId (Ipv4Address nextHop)
	Check for duplicate ids and save new entries if the id is not present in the table. More...

void	Clear ()
	Delete all entries from routing table. More...

void	ClearMac ()
	Remove all entries. More...

void	DelArpCache (Ptr< ArpCache >)
	Don't use given ARP cache any more (interface is down) More...

void	DeleteAllRoutesIncludeLink (Ipv4Address errorSrc, Ipv4Address unreachNode, Ipv4Address node)
	Delete all the routes which includes the link from next hop address that has just been notified as unreachable. More...

bool	DeleteRoute (Ipv4Address dst)
	Delete the route with certain destination address. More...

bool	FindSameRoute (DsrRouteCacheEntry &rt, std::list< DsrRouteCacheEntry > &rtVector)
	Find the same route in the route cache. More...

uint16_t	GetAckSize ()
	Get the ack table size. More...

Time	GetBadLinkLifetime () const

Time	GetCacheTimeout () const

Callback< void, Ipv4Address, uint8_t >	GetCallback () const
	Handle link failure callback. More...

Time	GetExpireTime (Ipv4Address addr)
	Return expire time for neighbor node with address addr, if exists, else return 0. More...

Time	GetInitStability () const

uint32_t	GetMaxCacheLen () const

uint32_t	GetMaxEntriesEachDst () const

Time	GetMinLifeTime () const

uint64_t	GetStabilityDecrFactor () const

uint64_t	GetStabilityIncrFactor () const

bool	GetSubRoute () const

Callback< void, WifiMacHeader const & >	GetTxErrorCallback () const
	Get callback to ProcessTxError, this callback is trying to use the wifi mac tx error header to notify a link layer drop event, however, it is not fully supported yet. More...

Time	GetUseExtends () const

bool	IsLinkCache ()

bool	IsNeighbor (Ipv4Address addr)
	Check that node with address addr is neighbor. More...

Mac48Address	LookupMacAddress (Ipv4Address)
	Find MAC address by IP using list of ARP caches. More...

bool	LookupRoute (Ipv4Address id, DsrRouteCacheEntry &rt)
	Lookup route cache entry with destination address dst. More...

void	Print (std::ostream &os)
	Print route cache. More...

void	PrintRouteVector (std::list< DsrRouteCacheEntry > route)
	Print all the route vector elements from the route list. More...

void	PrintVector (std::vector< Ipv4Address > &vec)
	Print the route vector elements. More...

void	ProcessTxError (WifiMacHeader const &)
	Process layer 2 TX error notification. More...

void	Purge ()
	Delete all outdated entries and invalidate valid entry if Lifetime is expired. More...

void	PurgeLinkNode ()

void	PurgeMac ()
	Remove all expired mac entries. More...

void	RebuildBestRouteTable (Ipv4Address source)
	USE MAXWEIGHT TO REPRESENT MAX; USE BROADCAST ADDRESS TO REPRESENT NULL PRECEEDING ADDRESS. More...

void	RemoveLastEntry (std::list< DsrRouteCacheEntry > &rtVector)
	Remove the aged route cache entries when the route cache is full. More...

void	ScheduleTimer ()
	Schedule m_ntimer. More...

void	SetBadLinkLifetime (Time t)

void	SetCacheTimeout (Time t)

void	SetCacheType (std::string type)
	Dijsktra algorithm to get the best route from m_netGraph and update the m_bestRoutesTable_link when current graph information has changed. More...

void	SetCallback (Callback< void, Ipv4Address, uint8_t > cb)
	Handle link failure callback. More...

void	SetInitStability (Time initStability)

void	SetMaxCacheLen (uint32_t len)

void	SetMaxEntriesEachDst (uint32_t entries)

void	SetMinLifeTime (Time minLifeTime)

void	SetStabilityDecrFactor (uint64_t decrFactor)

void	SetStabilityIncrFactor (uint64_t incrFactor)

void	SetSubRoute (bool subRoute)

void	SetUseExtends (Time useExtends)

void	UpdateNeighbor (std::vector< Ipv4Address > nodeList, Time expire)
	Update expire time for entry with address addr, if it exists, else add new entry. More...

void	UpdateNetGraph ()
	Update the Net Graph for the link and node cache has changed. More...

bool	UpdateRouteEntry (Ipv4Address dst)
	Update route cache entry if it has been recently used and successfully delivered the data packet. More...

void	UseExtends (DsrRouteCacheEntry::IP_VECTOR rt)
	When a link from the Route Cache is used in routing a packet originated or salvaged by that node, the stability metric for each of the two endpoint nodes of that link is incremented by the amount of time since that link was last used. More...

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

virtual	~Object ()
	Destructor. More...

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

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

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

virtual TypeId	GetInstanceTypeId (void) const
	Implement the GetInstanceTypeId method defined in ObjectBase. More...

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

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

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

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

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

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

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

void	Unref (void) 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 erros. 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 ()

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

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

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

Public Attributes
std::vector< Ptr< ArpCache > >	m_arp
	list of ARP cached to be used for layer 2 notifications processing More...

Time	m_delay
	This timeout deals with the passive ack. More...

Callback< void, Ipv4Address, uint8_t >	m_handleLinkFailure
	The following code handles link-layer acks. More...

std::vector< Neighbor >	m_nb
	vector of entries More...

Timer	m_ntimer
	Timer for neighbor's list. Schedule Purge(). More...

Callback< void, WifiMacHeader const & >	m_txErrorCallback
	TX error callback. More...

Private Types
typedef std::list< DsrRouteCacheEntry >	routeEntryVector
	Define the route cache data structure. More...

Private Member Functions
bool	DecStability (Ipv4Address node)
	decrease the stability of the node More...

bool	IncStability (Ipv4Address node)
	increase the stability of the node More...

bool	LookupRoute_Link (Ipv4Address id, DsrRouteCacheEntry &rt)
	used by LookupRoute when LinkCache More...

DsrRouteCache &	operator= (DsrRouteCache const &)

Private Attributes
std::map< Ipv4Address, uint16_t >	m_ackIdCache
	The id cache to ensure all the ids are unique. More...

Time	m_badLinkLifetime
	The time for which the neighboring node is put into the blacklist. More...

std::map< Ipv4Address, DsrRouteCacheEntry::IP_VECTOR >	m_bestRoutesTable_link
	for link route cache More...

Time	m_initStability

bool	m_isLinkCache
	Check if the route is using path cache or link cache. More...

std::map< Link, DsrLinkStab >	m_linkCache
	The data structure to store link info. More...

uint32_t	m_maxCacheLen
	The maximum number of packets that we allow a routing protocol to buffer. More...

uint32_t	m_maxEntriesEachDst
	number of entries for each destination More...

Time	m_minLifeTime

std::map< Ipv4Address, std::map< Ipv4Address, uint32_t > >	m_netGraph
	Current network graph state for this node, double is weight, which is calculated by the node information and link information, any time some changes of link cache and node cache change the weight and then recompute the best choice for each node. More...

std::map< Ipv4Address, DsrNodeStab >	m_nodeCache
	The data structure to store node info. More...

routeEntryVector	m_routeEntryVector
	Define the route vector. More...

std::map< Ipv4Address, routeEntryVector >	m_sortedRoutes
	Map the ipv4Address to route entry vector. More...

uint32_t	m_stabilityDecrFactor
	Define the parameters for link cache type. More...

uint32_t	m_stabilityIncrFactor

bool	m_subRoute
	Check if save the sub route entries or not. More...

Time	m_useExtends

DsrRouteCacheEntry::IP_VECTOR	m_vector
	The route vector to save the ip addresses for intermediate nodes. More...

Time	RouteCacheTimeout
	The maximum period of time that dsr is allowed to for an unused route. More...

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

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

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

virtual void	NotifyNewAggregate (void)
	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 (void)
	Notifier called once the ObjectBase is fully constructed. More...

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

Detailed Description

DSR route request queue Since DSR is an on demand routing we queue requests while looking for route.

Config Paths

ns3::dsr::DsrRouteCache is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/$ns3::dsr::DsrRouting/RouteCache"

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 560 bytes (on a 64-bit architecture).

Definition at line 285 of file dsr-rcache.h.

Member Typedef Documentation

typedef std::list<DsrRouteCacheEntry> ns3::dsr::DsrRouteCache::routeEntryVector

private

Define the route cache data structure.

Definition at line 552 of file dsr-rcache.h.

typedef std::list<DsrRouteCacheEntry::IP_VECTOR> ns3::dsr::DsrRouteCache::routeVector

Define the vector of route entries.

Definition at line 301 of file dsr-rcache.h.

Constructor & Destructor Documentation

ns3::dsr::DsrRouteCache::DsrRouteCache ( )

Definition at line 147 of file dsr-rcache.cc.

References m_delay, m_ntimer, m_txErrorCallback, ns3::MakeCallback(), ProcessTxError(), PurgeMac(), ns3::Timer::SetDelay(), and ns3::Timer::SetFunction().

Here is the call graph for this function:

ns3::dsr::DsrRouteCache::~DsrRouteCache ( )

virtual

Definition at line 162 of file dsr-rcache.cc.

References m_sortedRoutes, and NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

void ns3::dsr::DsrRouteCache::AddArpCache ( Ptr< ArpCache > a )

Add ARP cache to be used to allow layer 2 notifications processing.

Definition at line 1206 of file dsr-rcache.cc.

References m_arp.

void ns3::dsr::DsrRouteCache::AddNeighbor	(	std::vector< Ipv4Address >	nodeList,
		Ipv4Address	ownAddress,
		Time	expire
	)

Add to the neighbor list.

Definition at line 1143 of file dsr-rcache.cc.

References LookupMacAddress(), m_nb, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_LOGIC, and PurgeMac().

Here is the call graph for this function:

bool ns3::dsr::DsrRouteCache::AddRoute ( DsrRouteCacheEntry & rt )

Add route cache entry if it doesn't yet exist in route cache.

Parameters

rt	route cache entry

Returns: true in success

Save the new route cache along with the destination address in map

Drop the most aged packet when buffer reaches to max

Save the new route cache along with the destination address in map

Definition at line 657 of file dsr-rcache.cc.

References ns3::dsr::CompareRoutesExpire(), FindSameRoute(), ns3::dsr::DsrRouteCacheEntry::GetDestination(), ns3::dsr::DsrRouteCacheEntry::GetExpireTime(), ns3::dsr::DsrRouteCacheEntry::GetVector(), m_maxEntriesEachDst, m_sortedRoutes, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, Purge(), and RemoveLastEntry().

Referenced by DsrCacheEntryTest::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::dsr::DsrRouteCache::AddRoute_Link	(	DsrRouteCacheEntry::IP_VECTOR	nodelist,
		Ipv4Address	node
	)

Purge the link node cache first

This is the node stability

Link represent the one link for the route

Link stability

Set the link stability as the smallest node stability

Set the link stability as the m)minLifeTime, default is 1 second

Definition at line 562 of file dsr-rcache.cc.

References ns3::dsr::DsrLinkStab::GetLinkStability(), ns3::Time::GetSeconds(), m_initStability, m_linkCache, m_minLifeTime, m_nodeCache, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::dsr::Link::Print(), ns3::dsr::DsrLinkStab::Print(), PurgeLinkNode(), RebuildBestRouteTable(), ns3::dsr::DsrLinkStab::SetLinkStability(), ns3::dsr::DsrNodeStab::SetNodeStability(), and UpdateNetGraph().

Here is the call graph for this function:

uint16_t ns3::dsr::DsrRouteCache::CheckUniqueAckId ( Ipv4Address nextHop )

Check for duplicate ids and save new entries if the id is not present in the table.

This part of code maintains an Acknowledgment id cache for next hop and remove duplicate ids.

Definition at line 1051 of file dsr-rcache.cc.

References m_ackIdCache, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

void ns3::dsr::DsrRouteCache::Clear ( void )

inline

Delete all entries from routing table.

Definition at line 435 of file dsr-rcache.h.

References m_routeEntryVector.

void ns3::dsr::DsrRouteCache::ClearMac ( )

inline

Remove all entries.

Definition at line 503 of file dsr-rcache.h.

References m_nb.

bool ns3::dsr::DsrRouteCache::DecStability ( Ipv4Address node )

private

decrease the stability of the node

Parameters

node	the ip address of the node we want to decrease stability

Todo:: remove it here

Definition at line 539 of file dsr-rcache.cc.

References m_initStability, m_nodeCache, m_stabilityDecrFactor, NS_LOG_FUNCTION, and NS_LOG_INFO.

Referenced by DeleteAllRoutesIncludeLink().

Here is the caller graph for this function:

void ns3::dsr::DsrRouteCache::DelArpCache ( Ptr< ArpCache > a )

Don't use given ARP cache any more (interface is down)

Definition at line 1212 of file dsr-rcache.cc.

References m_arp.

void ns3::dsr::DsrRouteCache::DeleteAllRoutesIncludeLink	(	Ipv4Address	errorSrc,
		Ipv4Address	unreachNode,
		Ipv4Address	node
	)

Delete all the routes which includes the link from next hop address that has just been notified as unreachable.

Parameters

errorSrc	The error source address
unreachNode	The unreachable node
node	This node's ip address

Todo:: get rid of this one

Definition at line 774 of file dsr-rcache.cc.

References first::address, ns3::dsr::CompareRoutesExpire(), DecStability(), IsLinkCache(), m_linkCache, m_nodeCache, m_sortedRoutes, m_subRoute, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, Purge(), PurgeLinkNode(), RebuildBestRouteTable(), ns3::dsr::DsrRouteCacheEntry::SetDestination(), ns3::dsr::DsrRouteCacheEntry::SetExpireTime(), ns3::dsr::DsrRouteCacheEntry::SetVector(), and UpdateNetGraph().

Here is the call graph for this function:

bool ns3::dsr::DsrRouteCache::DeleteRoute ( Ipv4Address dst )

Delete the route with certain destination address.

Parameters

dst	the destination address of the routes that should be deleted

Definition at line 760 of file dsr-rcache.cc.

References m_sortedRoutes, NS_LOG_FUNCTION, NS_LOG_LOGIC, and Purge().

Referenced by DsrCacheEntryTest::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::dsr::DsrRouteCache::FindSameRoute	(	DsrRouteCacheEntry &	rt,
		std::list< DsrRouteCacheEntry > &	rtVector
	)

Find the same route in the route cache.

Parameters

rt	entry with destination address dst, if exists
rtVector	the route vector

Definition at line 727 of file dsr-rcache.cc.

References ns3::dsr::CompareRoutesExpire(), ns3::dsr::DsrRouteCacheEntry::GetDestination(), ns3::dsr::DsrRouteCacheEntry::GetExpireTime(), ns3::Time::GetSeconds(), ns3::dsr::DsrRouteCacheEntry::GetVector(), m_sortedRoutes, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by AddRoute().

Here is the call graph for this function:

Here is the caller graph for this function:

uint16_t ns3::dsr::DsrRouteCache::GetAckSize ( )

Get the ack table size.

Definition at line 1073 of file dsr-rcache.cc.

References m_ackIdCache.

Time ns3::dsr::DsrRouteCache::GetBadLinkLifetime ( ) const

inline

Definition at line 336 of file dsr-rcache.h.

References m_badLinkLifetime.

Time ns3::dsr::DsrRouteCache::GetCacheTimeout ( ) const

inline

Definition at line 320 of file dsr-rcache.h.

References RouteCacheTimeout.

Callback<void, Ipv4Address, uint8_t > ns3::dsr::DsrRouteCache::GetCallback ( ) const

inline

Handle link failure callback.

Definition at line 530 of file dsr-rcache.h.

References m_handleLinkFailure.

Time ns3::dsr::DsrRouteCache::GetExpireTime ( Ipv4Address addr )

Return expire time for neighbor node with address addr, if exists, else return 0.

Definition at line 1099 of file dsr-rcache.cc.

References m_nb, ns3::Simulator::Now(), NS_LOG_FUNCTION, PurgeMac(), and ns3::Seconds().

Here is the call graph for this function:

Time ns3::dsr::DsrRouteCache::GetInitStability ( ) const

inline

Definition at line 360 of file dsr-rcache.h.

References m_initStability.

uint32_t ns3::dsr::DsrRouteCache::GetMaxCacheLen ( ) const

inline

Definition at line 312 of file dsr-rcache.h.

References m_maxCacheLen.

uint32_t ns3::dsr::DsrRouteCache::GetMaxEntriesEachDst ( ) const

inline

Definition at line 328 of file dsr-rcache.h.

References m_maxEntriesEachDst.

Time ns3::dsr::DsrRouteCache::GetMinLifeTime ( ) const

inline

Definition at line 368 of file dsr-rcache.h.

References m_minLifeTime.

uint64_t ns3::dsr::DsrRouteCache::GetStabilityDecrFactor ( ) const

inline

Definition at line 344 of file dsr-rcache.h.

References m_stabilityDecrFactor.

uint64_t ns3::dsr::DsrRouteCache::GetStabilityIncrFactor ( ) const

inline

Definition at line 352 of file dsr-rcache.h.

References m_stabilityIncrFactor.

bool ns3::dsr::DsrRouteCache::GetSubRoute ( ) const

inline

Definition at line 304 of file dsr-rcache.h.

References m_subRoute.

Callback<void, WifiMacHeader const &> ns3::dsr::DsrRouteCache::GetTxErrorCallback ( ) const

inline

Get callback to ProcessTxError, this callback is trying to use the wifi mac tx error header to notify a link layer drop event, however, it is not fully supported yet.

Definition at line 519 of file dsr-rcache.h.

References m_txErrorCallback.

TypeId ns3::dsr::DsrRouteCache::GetTypeId ( void )

static

Definition at line 137 of file dsr-rcache.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

Time ns3::dsr::DsrRouteCache::GetUseExtends ( ) const

inline

Definition at line 376 of file dsr-rcache.h.

References m_useExtends.

bool ns3::dsr::DsrRouteCache::IncStability ( Ipv4Address node )

private

increase the stability of the node

Parameters

node	the ip address of the node we want to increase stability

Todo:: get rid of the debug here

Definition at line 515 of file dsr-rcache.cc.

References ns3::Time::GetSeconds(), m_initStability, m_nodeCache, m_stabilityIncrFactor, NS_LOG_FUNCTION, and NS_LOG_INFO.

Referenced by UseExtends().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::dsr::DsrRouteCache::IsLinkCache ( )

Definition at line 310 of file dsr-rcache.cc.

References m_isLinkCache, and NS_LOG_FUNCTION.

Referenced by DeleteAllRoutesIncludeLink(), and LookupRoute().

Here is the caller graph for this function:

bool ns3::dsr::DsrRouteCache::IsNeighbor ( Ipv4Address addr )

Check that node with address addr is neighbor.

This part maintains a neighbor list to handle unidirectional links and link-layer acks.

Definition at line 1083 of file dsr-rcache.cc.

References m_nb, NS_LOG_FUNCTION, and PurgeMac().

Here is the call graph for this function:

Mac48Address ns3::dsr::DsrRouteCache::LookupMacAddress ( Ipv4Address addr )

Find MAC address by IP using list of ARP caches.

Definition at line 1218 of file dsr-rcache.cc.

References ns3::Mac48Address::ConvertFrom(), ns3::ArpCache::Entry::GetMacAddress(), ns3::ArpCache::Entry::IsAlive(), ns3::ArpCache::Entry::IsExpired(), ns3::ArpCache::Entry::IsPermanent(), and m_arp.

Referenced by AddNeighbor(), and UpdateNeighbor().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::dsr::DsrRouteCache::LookupRoute	(	Ipv4Address	id,
		DsrRouteCacheEntry &	rt
	)

Lookup route cache entry with destination address dst.

Parameters

id	destination address
rt	entry with destination address id, if exists

Returns: true on success

Definition at line 208 of file dsr-rcache.cc.

References ns3::dsr::CompareRoutesExpire(), IsLinkCache(), LookupRoute_Link(), m_sortedRoutes, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, Purge(), ns3::dsr::DsrRouteCacheEntry::SetDestination(), ns3::dsr::DsrRouteCacheEntry::SetExpireTime(), and ns3::dsr::DsrRouteCacheEntry::SetVector().

Referenced by DsrCacheEntryTest::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::dsr::DsrRouteCache::LookupRoute_Link	(	Ipv4Address	id,
		DsrRouteCacheEntry &	rt
	)

private

used by LookupRoute when LinkCache

Parameters

id	the ip address we are looking for
rt	the route cache entry to store the found one

We need to purge the link node cache

Definition at line 433 of file dsr-rcache.cc.

References ns3::dsr::DsrRouteCacheEntry::GetVector(), m_bestRoutesTable_link, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, PrintVector(), PurgeLinkNode(), RouteCacheTimeout, ns3::dsr::DsrRouteCacheEntry::SetDestination(), ns3::dsr::DsrRouteCacheEntry::SetExpireTime(), and ns3::dsr::DsrRouteCacheEntry::SetVector().

Referenced by LookupRoute().

Here is the call graph for this function:

Here is the caller graph for this function:

DsrRouteCache& ns3::dsr::DsrRouteCache::operator= ( DsrRouteCache const & )

private

void ns3::dsr::DsrRouteCache::Print ( std::ostream & os )

Print route cache.

Definition at line 1032 of file dsr-rcache.cc.

References m_routeEntryVector, NS_LOG_FUNCTION, and Purge().

Here is the call graph for this function:

void ns3::dsr::DsrRouteCache::PrintRouteVector ( std::list< DsrRouteCacheEntry > route )

Print all the route vector elements from the route list.

Parameters

route the route list

Definition at line 953 of file dsr-rcache.cc.

References NS_LOG_FUNCTION, NS_LOG_INFO, and PrintVector().

Here is the call graph for this function:

void ns3::dsr::DsrRouteCache::PrintVector ( std::vector< Ipv4Address > & vec )

Print the route vector elements.

Parameters

vec	the route vector

Definition at line 932 of file dsr-rcache.cc.

References NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by LookupRoute_Link(), PrintRouteVector(), and RebuildBestRouteTable().

Here is the caller graph for this function:

void ns3::dsr::DsrRouteCache::ProcessTxError ( WifiMacHeader const & hdr )

Process layer 2 TX error notification.

Definition at line 1235 of file dsr-rcache.cc.

References ns3::WifiMacHeader::GetAddr1(), m_nb, and PurgeMac().

Referenced by DsrRouteCache().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::dsr::DsrRouteCache::Purge ( )

Delete all outdated entries and invalidate valid entry if Lifetime is expired.

Definition at line 965 of file dsr-rcache.cc.

References m_sortedRoutes, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Seconds().

Referenced by AddRoute(), DeleteAllRoutesIncludeLink(), DeleteRoute(), LookupRoute(), and Print().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::dsr::DsrRouteCache::PurgeLinkNode ( )

may need to remove them after verify

Definition at line 465 of file dsr-rcache.cc.

References m_linkCache, m_nodeCache, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Seconds().

Referenced by AddRoute_Link(), DeleteAllRoutesIncludeLink(), LookupRoute_Link(), and UseExtends().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::dsr::DsrRouteCache::PurgeMac ( )

Remove all expired mac entries.

Todo:: disable temporarily

Definition at line 1173 of file dsr-rcache.cc.

References ns3::Timer::Cancel(), m_handleLinkFailure, m_nb, m_ntimer, NS_LOG_LOGIC, and ns3::Timer::Schedule().

Referenced by AddNeighbor(), DsrRouteCache(), GetExpireTime(), IsNeighbor(), ProcessTxError(), and UpdateNeighbor().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::dsr::DsrRouteCache::RebuildBestRouteTable ( Ipv4Address source )

USE MAXWEIGHT TO REPRESENT MAX; USE BROADCAST ADDRESS TO REPRESENT NULL PRECEEDING ADDRESS.

Parameters

source The source address the routes based on

The followings are initialize-single-source

The followings are core of dijskra algorithm

Definition at line 317 of file dsr-rcache.cc.

References ns3::Ipv4Address::IsBroadcast(), m_bestRoutesTable_link, m_linkCache, m_netGraph, MAXWEIGHT, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, and PrintVector().

Referenced by AddRoute_Link(), and DeleteAllRoutesIncludeLink().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::dsr::DsrRouteCache::RemoveLastEntry ( std::list< DsrRouteCacheEntry > & rtVector )

Remove the aged route cache entries when the route cache is full.

Definition at line 170 of file dsr-rcache.cc.

References NS_LOG_FUNCTION.

Referenced by AddRoute().

Here is the caller graph for this function:

void ns3::dsr::DsrRouteCache::ScheduleTimer ( )

Schedule m_ntimer.

Definition at line 1199 of file dsr-rcache.cc.

References ns3::Timer::Cancel(), m_ntimer, and ns3::Timer::Schedule().

Here is the call graph for this function:

void ns3::dsr::DsrRouteCache::SetBadLinkLifetime ( Time t )

inline

Definition at line 340 of file dsr-rcache.h.

References m_badLinkLifetime.

void ns3::dsr::DsrRouteCache::SetCacheTimeout ( Time t )

inline

Definition at line 324 of file dsr-rcache.h.

References RouteCacheTimeout.

void ns3::dsr::DsrRouteCache::SetCacheType ( std::string type )

Dijsktra algorithm to get the best route from m_netGraph and update the m_bestRoutesTable_link when current graph information has changed.

Parameters

type	The type of the cache

Definition at line 291 of file dsr-rcache.cc.

References m_isLinkCache, NS_LOG_FUNCTION, and NS_LOG_INFO.

void ns3::dsr::DsrRouteCache::SetCallback ( Callback< void, Ipv4Address, uint8_t > cb )

inline

Handle link failure callback.

Definition at line 525 of file dsr-rcache.h.

References m_handleLinkFailure.

void ns3::dsr::DsrRouteCache::SetInitStability ( Time initStability )

inline

Definition at line 364 of file dsr-rcache.h.

References m_initStability.

void ns3::dsr::DsrRouteCache::SetMaxCacheLen ( uint32_t len )

inline

Definition at line 316 of file dsr-rcache.h.

References m_maxCacheLen.

void ns3::dsr::DsrRouteCache::SetMaxEntriesEachDst ( uint32_t entries )

inline

Definition at line 332 of file dsr-rcache.h.

References m_maxEntriesEachDst.

void ns3::dsr::DsrRouteCache::SetMinLifeTime ( Time minLifeTime )

inline

Definition at line 372 of file dsr-rcache.h.

References m_minLifeTime.

void ns3::dsr::DsrRouteCache::SetStabilityDecrFactor ( uint64_t decrFactor )

inline

Definition at line 348 of file dsr-rcache.h.

References m_stabilityDecrFactor.

void ns3::dsr::DsrRouteCache::SetStabilityIncrFactor ( uint64_t incrFactor )

inline

Definition at line 356 of file dsr-rcache.h.

References m_stabilityIncrFactor.

void ns3::dsr::DsrRouteCache::SetSubRoute ( bool subRoute )

inline

Definition at line 308 of file dsr-rcache.h.

References m_subRoute.

void ns3::dsr::DsrRouteCache::SetUseExtends ( Time useExtends )

inline

Definition at line 380 of file dsr-rcache.h.

References m_useExtends.

void ns3::dsr::DsrRouteCache::UpdateNeighbor	(	std::vector< Ipv4Address >	nodeList,
		Time	expire
	)

Update expire time for entry with address addr, if it exists, else add new entry.

Definition at line 1115 of file dsr-rcache.cc.

References LookupMacAddress(), m_nb, max, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and PurgeMac().

Here is the call graph for this function:

void ns3::dsr::DsrRouteCache::UpdateNetGraph ( )

Update the Net Graph for the link and node cache has changed.

Todo:: May need to set different weight for different link here later

Definition at line 500 of file dsr-rcache.cc.

References m_linkCache, m_netGraph, and NS_LOG_FUNCTION.

Referenced by AddRoute_Link(), and DeleteAllRoutesIncludeLink().

Here is the caller graph for this function:

bool ns3::dsr::DsrRouteCache::UpdateRouteEntry ( Ipv4Address dst )

Update route cache entry if it has been recently used and successfully delivered the data packet.

Parameters

dst	destination address of the route

Returns: true in success

Definition at line 178 of file dsr-rcache.cc.

References ns3::dsr::CompareRoutesExpire(), m_sortedRoutes, NS_LOG_FUNCTION, NS_LOG_LOGIC, RouteCacheTimeout, and ns3::dsr::DsrRouteCacheEntry::SetExpireTime().

Here is the call graph for this function:

void ns3::dsr::DsrRouteCache::UseExtends ( DsrRouteCacheEntry::IP_VECTOR rt )

When a link from the Route Cache is used in routing a packet originated or salvaged by that node, the stability metric for each of the two endpoint nodes of that link is incremented by the amount of time since that link was last used.

When a link is used in a route chosen for a packet originated or salvaged by this node, the link's lifetime is set to be at least UseExtends into the future

Purge the link node cache first

Todo:: remove after debug

Increase the stability of the node cache

Definition at line 611 of file dsr-rcache.cc.

References IncStability(), m_initStability, m_linkCache, m_nodeCache, m_useExtends, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, and PurgeLinkNode().

Here is the call graph for this function:

Member Data Documentation

std::map<Ipv4Address, uint16_t> ns3::dsr::DsrRouteCache::m_ackIdCache

private

The id cache to ensure all the ids are unique.

Definition at line 560 of file dsr-rcache.h.

Referenced by CheckUniqueAckId(), and GetAckSize().

std::vector<Ptr<ArpCache> > ns3::dsr::DsrRouteCache::m_arp

list of ARP cached to be used for layer 2 notifications processing

Definition at line 635 of file dsr-rcache.h.

Referenced by AddArpCache(), DelArpCache(), and LookupMacAddress().

Time ns3::dsr::DsrRouteCache::m_badLinkLifetime

private

The time for which the neighboring node is put into the blacklist.

Definition at line 540 of file dsr-rcache.h.

Referenced by GetBadLinkLifetime(), and SetBadLinkLifetime().

std::map<Ipv4Address, DsrRouteCacheEntry::IP_VECTOR> ns3::dsr::DsrRouteCache::m_bestRoutesTable_link

private

for link route cache

Definition at line 577 of file dsr-rcache.h.

Referenced by LookupRoute_Link(), and RebuildBestRouteTable().

Time ns3::dsr::DsrRouteCache::m_delay

This timeout deals with the passive ack.

Definition at line 637 of file dsr-rcache.h.

Referenced by DsrRouteCache().

Callback<void, Ipv4Address, uint8_t > ns3::dsr::DsrRouteCache::m_handleLinkFailure

The following code handles link-layer acks.

link failure callback

Definition at line 627 of file dsr-rcache.h.

Referenced by GetCallback(), PurgeMac(), and SetCallback().

Time ns3::dsr::DsrRouteCache::m_initStability

private

Definition at line 546 of file dsr-rcache.h.

Referenced by AddRoute_Link(), DecStability(), GetInitStability(), IncStability(), SetInitStability(), and UseExtends().

bool ns3::dsr::DsrRouteCache::m_isLinkCache

private

Check if the route is using path cache or link cache.

Definition at line 562 of file dsr-rcache.h.

Referenced by IsLinkCache(), and SetCacheType().

std::map<Link, DsrLinkStab> ns3::dsr::DsrRouteCache::m_linkCache

private

The data structure to store link info.

Definition at line 578 of file dsr-rcache.h.

Referenced by AddRoute_Link(), DeleteAllRoutesIncludeLink(), PurgeLinkNode(), RebuildBestRouteTable(), UpdateNetGraph(), and UseExtends().

uint32_t ns3::dsr::DsrRouteCache::m_maxCacheLen

private

The maximum number of packets that we allow a routing protocol to buffer.

Definition at line 538 of file dsr-rcache.h.

Referenced by GetMaxCacheLen(), and SetMaxCacheLen().

uint32_t ns3::dsr::DsrRouteCache::m_maxEntriesEachDst

private

number of entries for each destination

Definition at line 558 of file dsr-rcache.h.

Referenced by AddRoute(), GetMaxEntriesEachDst(), and SetMaxEntriesEachDst().

Time ns3::dsr::DsrRouteCache::m_minLifeTime

private

Definition at line 547 of file dsr-rcache.h.

Referenced by AddRoute_Link(), GetMinLifeTime(), and SetMinLifeTime().

std::vector<Neighbor> ns3::dsr::DsrRouteCache::m_nb

vector of entries

Definition at line 633 of file dsr-rcache.h.

Referenced by AddNeighbor(), ClearMac(), GetExpireTime(), IsNeighbor(), ProcessTxError(), PurgeMac(), and UpdateNeighbor().

std::map<Ipv4Address, std::map<Ipv4Address, uint32_t> > ns3::dsr::DsrRouteCache::m_netGraph

private

Current network graph state for this node, double is weight, which is calculated by the node information and link information, any time some changes of link cache and node cache change the weight and then recompute the best choice for each node.

Definition at line 575 of file dsr-rcache.h.

Referenced by RebuildBestRouteTable(), and UpdateNetGraph().

std::map<Ipv4Address, DsrNodeStab> ns3::dsr::DsrRouteCache::m_nodeCache

private

The data structure to store node info.

Definition at line 579 of file dsr-rcache.h.

Referenced by AddRoute_Link(), DecStability(), DeleteAllRoutesIncludeLink(), IncStability(), PurgeLinkNode(), and UseExtends().

Timer ns3::dsr::DsrRouteCache::m_ntimer

Timer for neighbor's list. Schedule Purge().

Definition at line 631 of file dsr-rcache.h.

Referenced by DsrRouteCache(), PurgeMac(), and ScheduleTimer().

routeEntryVector ns3::dsr::DsrRouteCache::m_routeEntryVector

private

Define the route vector.

Definition at line 556 of file dsr-rcache.h.

Referenced by Clear(), and Print().

std::map<Ipv4Address, routeEntryVector> ns3::dsr::DsrRouteCache::m_sortedRoutes

private

Map the ipv4Address to route entry vector.

Definition at line 554 of file dsr-rcache.h.

Referenced by AddRoute(), DeleteAllRoutesIncludeLink(), DeleteRoute(), FindSameRoute(), LookupRoute(), Purge(), UpdateRouteEntry(), and ~DsrRouteCache().

uint32_t ns3::dsr::DsrRouteCache::m_stabilityDecrFactor

private

Define the parameters for link cache type.

Definition at line 544 of file dsr-rcache.h.

Referenced by DecStability(), GetStabilityDecrFactor(), and SetStabilityDecrFactor().

uint32_t ns3::dsr::DsrRouteCache::m_stabilityIncrFactor

private

Definition at line 545 of file dsr-rcache.h.

Referenced by GetStabilityIncrFactor(), IncStability(), and SetStabilityIncrFactor().

bool ns3::dsr::DsrRouteCache::m_subRoute

private

Check if save the sub route entries or not.

Definition at line 564 of file dsr-rcache.h.

Referenced by DeleteAllRoutesIncludeLink(), GetSubRoute(), and SetSubRoute().

Callback<void, WifiMacHeader const &> ns3::dsr::DsrRouteCache::m_txErrorCallback

TX error callback.

Definition at line 629 of file dsr-rcache.h.

Referenced by DsrRouteCache(), and GetTxErrorCallback().

Time ns3::dsr::DsrRouteCache::m_useExtends

private

Definition at line 548 of file dsr-rcache.h.

Referenced by GetUseExtends(), SetUseExtends(), and UseExtends().

DsrRouteCacheEntry::IP_VECTOR ns3::dsr::DsrRouteCache::m_vector

private

The route vector to save the ip addresses for intermediate nodes.

Definition at line 537 of file dsr-rcache.h.

Time ns3::dsr::DsrRouteCache::RouteCacheTimeout

private

The maximum period of time that dsr is allowed to for an unused route.

Definition at line 539 of file dsr-rcache.h.

Referenced by GetCacheTimeout(), LookupRoute_Link(), SetCacheTimeout(), and UpdateRouteEntry().

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

src/dsr/model/dsr-rcache.h
src/dsr/model/dsr-rcache.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation