A Discrete-Event Network Simulator
API
ns3::dsr::DsrGraReply Class Reference

maintain the gratuitous reply More...

#include "dsr-gratuitous-reply-table.h"

+ Inheritance diagram for ns3::dsr::DsrGraReply:
+ Collaboration diagram for ns3::dsr::DsrGraReply:

Classes

struct  IsExpired
 Check if the entry is expired or not. More...
 

Public Member Functions

 DsrGraReply ()
 
 ~DsrGraReply () override
 
bool AddEntry (GraReplyEntry &graTableEntry)
 Add a new gratuitous reply entry. More...
 
void Clear ()
 Remove all entries. More...
 
bool FindAndUpdate (Ipv4Address replyTo, Ipv4Address replyFrom, Time gratReplyHoldoff)
 Update the route entry if found. More...
 
uint32_t GetGraTableSize () const
 Get the gratuitous reply table size. More...
 
void Purge ()
 Remove all expired entries. More...
 
void SetGraTableSize (uint32_t g)
 Set the gratuitous reply table size. 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< ObjectGetObject () 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< ObjectGetObject (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...
 
SimpleRefCountoperator= (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...
 

Private Attributes

uint32_t GraReplyTableSize
 The max # of gratuitous reply entries to hold. More...
 
std::vector< GraReplyEntrym_graReply
 Vector of entries. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose ()
 Destructor implementation. 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...
 

Detailed Description

maintain the gratuitous reply

Definition at line 75 of file dsr-gratuitous-reply-table.h.

Constructor & Destructor Documentation

◆ DsrGraReply()

ns3::dsr::DsrGraReply::DsrGraReply ( )

Definition at line 57 of file dsr-gratuitous-reply-table.cc.

◆ ~DsrGraReply()

ns3::dsr::DsrGraReply::~DsrGraReply ( )
override

Definition at line 61 of file dsr-gratuitous-reply-table.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ AddEntry()

bool ns3::dsr::DsrGraReply::AddEntry ( GraReplyEntry graTableEntry)

Add a new gratuitous reply entry.

Parameters
graTableEntryThe gratuitous reply entry
Returns
true on success

Definition at line 84 of file dsr-gratuitous-reply-table.cc.

References m_graReply.

Referenced by ns3::dsr::DsrRouting::SendGratuitousReply().

+ Here is the caller graph for this function:

◆ Clear()

void ns3::dsr::DsrGraReply::Clear ( )
inline

Remove all entries.

Definition at line 115 of file dsr-gratuitous-reply-table.h.

References m_graReply.

◆ FindAndUpdate()

bool ns3::dsr::DsrGraReply::FindAndUpdate ( Ipv4Address  replyTo,
Ipv4Address  replyFrom,
Time  gratReplyHoldoff 
)

Update the route entry if found.

Parameters
replyToEntry directed to
replyFromEntry heard from
gratReplyHoldoffNew gratuitous reply holdoff time
Returns
true on success

Definition at line 67 of file dsr-gratuitous-reply-table.cc.

References m_graReply, max, ns3::Simulator::Now(), NS_LOG_DEBUG, and Purge().

Referenced by ns3::dsr::DsrRouting::SendGratuitousReply().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetGraTableSize()

uint32_t ns3::dsr::DsrGraReply::GetGraTableSize ( ) const
inline

Get the gratuitous reply table size.

Returns
The gratuitous reply table size

Definition at line 96 of file dsr-gratuitous-reply-table.h.

References GraReplyTableSize.

◆ GetTypeId()

TypeId ns3::dsr::DsrGraReply::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 48 of file dsr-gratuitous-reply-table.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Purge()

void ns3::dsr::DsrGraReply::Purge ( )

Remove all expired entries.

Definition at line 91 of file dsr-gratuitous-reply-table.cc.

References m_graReply.

Referenced by FindAndUpdate().

+ Here is the caller graph for this function:

◆ SetGraTableSize()

void ns3::dsr::DsrGraReply::SetGraTableSize ( uint32_t  g)
inline

Set the gratuitous reply table size.

Parameters
gThe gratuitous reply table size

Definition at line 89 of file dsr-gratuitous-reply-table.h.

References GraReplyTableSize.

Referenced by ns3::dsr::DsrRouting::Start().

+ Here is the caller graph for this function:

Member Data Documentation

◆ GraReplyTableSize

uint32_t ns3::dsr::DsrGraReply::GraReplyTableSize
private

The max # of gratuitous reply entries to hold.

Definition at line 124 of file dsr-gratuitous-reply-table.h.

Referenced by GetGraTableSize(), and SetGraTableSize().

◆ m_graReply

std::vector<GraReplyEntry> ns3::dsr::DsrGraReply::m_graReply
private

Vector of entries.

Definition at line 122 of file dsr-gratuitous-reply-table.h.

Referenced by AddEntry(), Clear(), FindAndUpdate(), and Purge().


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