DSR passive buffer. More...

#include "dsr-passive-buff.h"

Inheritance diagram for ns3::dsr::DsrPassiveBuffer:

Collaboration diagram for ns3::dsr::DsrPassiveBuffer:

Public Member Functions
	DsrPassiveBuffer ()

virtual	~DsrPassiveBuffer ()

bool	AllEqual (DsrPassiveBuffEntry &entry)
	Check if all the entries in passive buffer entry is all equal or not. More...

bool	Dequeue (Ipv4Address dst, DsrPassiveBuffEntry &entry)
	Return first found (the earliest) entry for given destination. More...

bool	Enqueue (DsrPassiveBuffEntry &entry)
	Push entry in queue, if there is no entry with the same packet and destination address in queue. More...

bool	Find (Ipv4Address dst)
	Finds whether a packet with destination dst exists in the queue. More...

uint32_t	GetMaxQueueLen () const
	Get maximum queue length. More...

Time	GetPassiveBufferTimeout () const
	Get passive buffer timeout. More...

uint32_t	GetSize ()
	Number of entries. More...

void	SetMaxQueueLen (uint32_t len)
	Set maximum queue length. More...

void	SetPassiveBufferTimeout (Time t)
	Set passive buffer timeout. 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
	Get the most derived TypeId for this 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...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. 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 ()
	Default constructor. More...

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

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

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. 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 ()
	Get the type ID. More...

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

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

Private Member Functions
void	Drop (DsrPassiveBuffEntry en, std::string reason)
	Notify that packet is dropped from queue by timeout. More...

void	DropLink (DsrPassiveBuffEntry en, std::string reason)
	Notify that packet is dropped from queue by timeout. More...

void	Purge ()
	Remove all expired entries. More...

Static Private Member Functions
static bool	LinkEqual (DsrPassiveBuffEntry en, const std::vector< Ipv4Address > link)
	Check if the send buffer entry is the same or not. More...

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

std::vector< DsrPassiveBuffEntry >	m_passiveBuffer
	The send buffer to cache unsent packet. More...

Time	m_passiveBufferTimeout
	The maximum period of time that a routing protocol is allowed to buffer a packet for, seconds. 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 passive buffer.

Config Paths

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

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

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

Definition at line 258 of file dsr-passive-buff.h.

Constructor & Destructor Documentation

◆ DsrPassiveBuffer()

ns3::dsr::DsrPassiveBuffer::DsrPassiveBuffer ( )

Definition at line 57 of file dsr-passive-buff.cc.

◆ ~DsrPassiveBuffer()

ns3::dsr::DsrPassiveBuffer::~DsrPassiveBuffer ( )

virtual

Definition at line 61 of file dsr-passive-buff.cc.

Member Function Documentation

◆ AllEqual()

bool ns3::dsr::DsrPassiveBuffer::AllEqual ( DsrPassiveBuffEntry & entry )

Check if all the entries in passive buffer entry is all equal or not.

Note: For real this function checks if at most one entry is equal. If it is, that entry is removed. Further entries are NOT checked. This could be a bug.

Parameters

entry The Entry to check

Returns: true if an Entry was found and removed.

Definition at line 107 of file dsr-passive-buff.cc.

References ns3::dsr::DsrPassiveBuffEntry::GetDestination(), ns3::dsr::DsrPassiveBuffEntry::GetFragmentOffset(), ns3::dsr::DsrPassiveBuffEntry::GetIdentification(), ns3::dsr::DsrPassiveBuffEntry::GetNextHop(), ns3::dsr::DsrPassiveBuffEntry::GetPacket(), ns3::dsr::DsrPassiveBuffEntry::GetSegsLeft(), ns3::dsr::DsrPassiveBuffEntry::GetSource(), ns3::Packet::GetUid(), and m_passiveBuffer.

Here is the call graph for this function:

◆ Dequeue()

bool ns3::dsr::DsrPassiveBuffer::Dequeue	(	Ipv4Address	dst,
		DsrPassiveBuffEntry &	entry
	)

Return first found (the earliest) entry for given destination.

Parameters

[in]	dst	Entry destination
[out]	entry	The Entry found (if any).

Returns: true on success

Definition at line 129 of file dsr-passive-buff.cc.

References ns3::dsr::DsrPassiveBuffEntry::GetPacket(), ns3::Packet::GetSize(), m_passiveBuffer, NS_LOG_DEBUG, and Purge().

Here is the call graph for this function:

◆ Drop()

void ns3::dsr::DsrPassiveBuffer::Drop	(	DsrPassiveBuffEntry	en,
		std::string	reason
	)

private

Notify that packet is dropped from queue by timeout.

Parameters

en	BuffEntry Buffer entry
reason	Drop reason

Definition at line 204 of file dsr-passive-buff.cc.

References ns3::dsr::DsrPassiveBuffEntry::GetDestination(), ns3::dsr::DsrPassiveBuffEntry::GetPacket(), ns3::Packet::GetUid(), and NS_LOG_LOGIC.

Referenced by Enqueue(), and Purge().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DropLink()

void ns3::dsr::DsrPassiveBuffer::DropLink	(	DsrPassiveBuffEntry	en,
		std::string	reason
	)

private

Notify that packet is dropped from queue by timeout.

Parameters

en	BuffEntry Buffer entry
reason	Drop reason

Definition at line 213 of file dsr-passive-buff.cc.

References ns3::dsr::DsrPassiveBuffEntry::GetNextHop(), ns3::dsr::DsrPassiveBuffEntry::GetPacket(), ns3::dsr::DsrPassiveBuffEntry::GetSource(), ns3::Packet::GetUid(), and NS_LOG_LOGIC.

Here is the call graph for this function:

◆ Enqueue()

bool ns3::dsr::DsrPassiveBuffer::Enqueue ( DsrPassiveBuffEntry & entry )

Push entry in queue, if there is no entry with the same packet and destination address in queue.

Parameters

entry Buffer Entry

Returns: true on success adding the Entry.

Definition at line 73 of file dsr-passive-buff.cc.

References Drop(), ns3::dsr::DsrPassiveBuffEntry::GetDestination(), ns3::dsr::DsrPassiveBuffEntry::GetFragmentOffset(), ns3::dsr::DsrPassiveBuffEntry::GetIdentification(), ns3::dsr::DsrPassiveBuffEntry::GetNextHop(), ns3::dsr::DsrPassiveBuffEntry::GetPacket(), ns3::dsr::DsrPassiveBuffEntry::GetSegsLeft(), ns3::dsr::DsrPassiveBuffEntry::GetSource(), ns3::Packet::GetUid(), m_maxLen, m_passiveBuffer, m_passiveBufferTimeout, Purge(), and ns3::dsr::DsrPassiveBuffEntry::SetExpireTime().

Here is the call graph for this function:

◆ Find()

bool ns3::dsr::DsrPassiveBuffer::Find ( Ipv4Address dst )

Finds whether a packet with destination dst exists in the queue.

Parameters

dst	Destination.

Returns: true if there is a packet.

Definition at line 149 of file dsr-passive-buff.cc.

References m_passiveBuffer, and NS_LOG_DEBUG.

◆ GetMaxQueueLen()

uint32_t ns3::dsr::DsrPassiveBuffer::GetMaxQueueLen ( ) const

inline

Get maximum queue length.

Returns: the maximum queue length

Definition at line 298 of file dsr-passive-buff.h.

References m_maxLen.

◆ GetPassiveBufferTimeout()

Time ns3::dsr::DsrPassiveBuffer::GetPassiveBufferTimeout ( ) const

inline

Get passive buffer timeout.

Returns: the passive buffer timeout

Definition at line 314 of file dsr-passive-buff.h.

References m_passiveBufferTimeout.

◆ GetSize()

uint32_t ns3::dsr::DsrPassiveBuffer::GetSize ( void )

Number of entries.

Returns: The number of entries.

Definition at line 66 of file dsr-passive-buff.cc.

References m_passiveBuffer, and Purge().

Here is the call graph for this function:

◆ GetTypeId()

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

static

Get the type ID.

Returns: the object TypeId

Definition at line 47 of file dsr-passive-buff.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ LinkEqual()

static bool ns3::dsr::DsrPassiveBuffer::LinkEqual	(	DsrPassiveBuffEntry	en,
		const std::vector< Ipv4Address >	link
	)

inlinestaticprivate

Check if the send buffer entry is the same or not.

Parameters

en	The Entry to check
link	The link to check

Returns: true if an Entry source and Next hop are equal to the Link parameters

Definition at line 348 of file dsr-passive-buff.h.

References ns3::dsr::DsrPassiveBuffEntry::GetNextHop(), and ns3::dsr::DsrPassiveBuffEntry::GetSource().

Here is the call graph for this function:

◆ Purge()

void ns3::dsr::DsrPassiveBuffer::Purge ( )

private

Remove all expired entries.

Definition at line 183 of file dsr-passive-buff.cc.

References Drop(), m_passiveBuffer, and NS_LOG_DEBUG.

Referenced by Dequeue(), Enqueue(), and GetSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetMaxQueueLen()

void ns3::dsr::DsrPassiveBuffer::SetMaxQueueLen ( uint32_t len )

inline

Set maximum queue length.

Parameters

len	the maximum queue length

Definition at line 306 of file dsr-passive-buff.h.

References m_maxLen.

◆ SetPassiveBufferTimeout()

void ns3::dsr::DsrPassiveBuffer::SetPassiveBufferTimeout ( Time t )

inline

Set passive buffer timeout.

Parameters

t	the passive buffer timeout

Definition at line 322 of file dsr-passive-buff.h.

References m_passiveBufferTimeout.

Member Data Documentation

◆ m_maxLen

uint32_t ns3::dsr::DsrPassiveBuffer::m_maxLen

private

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

Definition at line 341 of file dsr-passive-buff.h.

Referenced by Enqueue(), GetMaxQueueLen(), and SetMaxQueueLen().

◆ m_passiveBuffer

std::vector<DsrPassiveBuffEntry> ns3::dsr::DsrPassiveBuffer::m_passiveBuffer

private

The send buffer to cache unsent packet.

Definition at line 329 of file dsr-passive-buff.h.

Referenced by AllEqual(), Dequeue(), Enqueue(), Find(), GetSize(), and Purge().

◆ m_passiveBufferTimeout

Time ns3::dsr::DsrPassiveBuffer::m_passiveBufferTimeout

private

The maximum period of time that a routing protocol is allowed to buffer a packet for, seconds.

Definition at line 343 of file dsr-passive-buff.h.

Referenced by Enqueue(), GetPassiveBufferTimeout(), and SetPassiveBufferTimeout().

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

src/dsr/model/dsr-passive-buff.h
src/dsr/model/dsr-passive-buff.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Constructor & Destructor Documentation

◆ DsrPassiveBuffer()

◆ ~DsrPassiveBuffer()

Member Function Documentation

◆ AllEqual()

◆ Dequeue()

◆ Drop()

◆ DropLink()

◆ Enqueue()

◆ Find()

◆ GetMaxQueueLen()

◆ GetPassiveBufferTimeout()

◆ GetSize()

◆ GetTypeId()

◆ LinkEqual()

◆ Purge()

◆ SetMaxQueueLen()

◆ SetPassiveBufferTimeout()

Member Data Documentation

◆ m_maxLen

◆ m_passiveBuffer

◆ m_passiveBufferTimeout