IPv6 Neighbor Discovery cache. More...

#include "ndisc-cache.h"

Inheritance diagram for ns3::NdiscCache:

Collaboration diagram for ns3::NdiscCache:

Classes
class	Entry
	A record that holds information about a NdiscCache entry. More...

Public Types
typedef std::pair< Ptr< Packet >, Ipv6Header >	Ipv6PayloadHeaderPair
	Pair of a packet and an Ipv4 header.

Public Member Functions
	NdiscCache ()
	Constructor.
	NdiscCache (const NdiscCache &)=delete
	~NdiscCache () override
	Destructor.
virtual NdiscCache::Entry *	Add (Ipv6Address to)
	Add an entry.
void	Flush ()
	Clear the cache of all entries except auto-generated entries.
Ptr< NetDevice >	GetDevice () const
	Get the NetDevice associated with this cache.
Ptr< Ipv6Interface >	GetInterface () const
	Get the Ipv6Interface associated with this cache.
uint32_t	GetUnresQlen ()
	Get the max number of waiting packet.
virtual NdiscCache::Entry *	Lookup (Ipv6Address dst)
	Lookup in the cache.
std::list< NdiscCache::Entry * >	LookupInverse (Address dst)
	Lookup in the cache for a MAC address.
NdiscCache &	operator= (const NdiscCache &)=delete
void	PrintNdiscCache (Ptr< OutputStreamWrapper > stream)
	Print the NDISC cache entries.
void	Remove (NdiscCache::Entry *entry)
	Delete an entry.
void	RemoveAutoGeneratedEntries ()
	Clear the NDISC cache of all Auto-Generated entries.
void	SetDevice (Ptr< NetDevice > device, Ptr< Ipv6Interface > interface, Ptr< Icmpv6L4Protocol > icmpv6)
	Set the device and interface.
void	SetUnresQlen (uint32_t unresQlen)
	Set the max number of waiting packet.
Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.
	~Object () override
	Destructor.
void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.
void	Dispose ()
	Dispose of this Object.
AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.
TypeId	GetInstanceTypeId () const final
	Get the most derived TypeId for this Object.
template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.
template<typename T>
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.
template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.
template<typename T>
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.
void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.
bool	IsInitialized () const
	Check if the object has been initialized.
void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.
uint32_t	GetReferenceCount () const
	Get the reference count of the object.
SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.
void	Ref () const
	Increment the reference count.
void	Unref () const
	Decrement the reference count.
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.
void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.
bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.
void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

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

Static Public Attributes
static const uint32_t	DEFAULT_UNRES_QLEN = 3
	Default value for unres qlen.

Protected Types
typedef std::map< Ipv6Address, NdiscCache::Entry * >	Cache
	Neighbor Discovery Cache container.
typedef std::map< Ipv6Address, NdiscCache::Entry * >::iterator	CacheI
	Neighbor Discovery Cache container iterator.

Protected Member Functions
void	DoDispose () override
	Dispose this object.
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.
virtual void	DoInitialize ()
	Initialize() implementation.
virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.
virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Protected Attributes
Cache	m_ndCache
	A list of Entry.

Private Attributes
Ptr< NetDevice >	m_device
	The NetDevice.
Ptr< Icmpv6L4Protocol >	m_icmpv6
	the icmpv6 L4 protocol for this cache.
Ptr< Ipv6Interface >	m_interface
	the interface.
uint32_t	m_unresQlen
	Max number of packet stored in m_waiting.

Additional Inherited Members
Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

IPv6 Neighbor Discovery cache.

Introspection did not find any typical Config paths

Attributes

UnresolvedQueueSize: Size of the queue for packets pending an NA reply.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 3
- Flags: constructwriteread
- Support level: SUPPORTED

No TraceSources are defined for this type
Group: Internet
Size of this type is 136 bytes (on a 64-bit architecture).

Definition at line 37 of file ndisc-cache.h.

Member Typedef Documentation

◆ Cache

typedef std::map<Ipv6Address, NdiscCache::Entry*> ns3::NdiscCache::Cache

protected

Neighbor Discovery Cache container.

Definition at line 454 of file ndisc-cache.h.

◆ CacheI

typedef std::map<Ipv6Address,NdiscCache::Entry*>::iterator ns3::NdiscCache::CacheI

protected

Neighbor Discovery Cache container iterator.

Definition at line 458 of file ndisc-cache.h.

◆ Ipv6PayloadHeaderPair

typedef std::pair<Ptr<Packet>, Ipv6Header> ns3::NdiscCache::Ipv6PayloadHeaderPair

Pair of a packet and an Ipv4 header.

Definition at line 153 of file ndisc-cache.h.

Constructor & Destructor Documentation

◆ NdiscCache() [1/2]

ns3::NdiscCache::NdiscCache ( )

Constructor.

Definition at line 41 of file ndisc-cache.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::NdiscCache::Entry::Entry(), NdiscCache(), and operator=().

Here is the caller graph for this function:

◆ ~NdiscCache()

ns3::NdiscCache::~NdiscCache ( )

override

Destructor.

Definition at line 46 of file ndisc-cache.cc.

References Flush(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ NdiscCache() [2/2]

ns3::NdiscCache::NdiscCache ( const NdiscCache & )

delete

References NdiscCache().

Here is the call graph for this function:

Member Function Documentation

◆ Add()

NdiscCache::Entry * ns3::NdiscCache::Add ( Ipv6Address to )

virtual

Add an entry.

Parameters

to	address to add

Returns: an new Entry

Definition at line 127 of file ndisc-cache.cc.

References m_ndCache, NS_ASSERT, and NS_LOG_FUNCTION.

◆ DoDispose()

void ns3::NdiscCache::DoDispose ( )

overrideprotectedvirtual

Dispose this object.

Reimplemented from ns3::Object.

Definition at line 53 of file ndisc-cache.cc.

References ns3::Object::DoDispose(), m_device, m_icmpv6, m_interface, m_ndCache, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ Flush()

void ns3::NdiscCache::Flush ( )

Clear the cache of all entries except auto-generated entries.

If you wish to remove all entries, including auto-generated entries, call this method and then also call RemoveAutoGeneratedEntries().

See also: RemoveAutoGenerated

Definition at line 156 of file ndisc-cache.cc.

References m_ndCache, and NS_LOG_FUNCTION.

Referenced by ~NdiscCache(), ns3::Icmpv6L4Protocol::CreateCache(), and FlushTest::DoRun().

Here is the caller graph for this function:

◆ GetDevice()

Ptr< NetDevice > ns3::NdiscCache::GetDevice ( ) const

Get the NetDevice associated with this cache.

Returns: NetDevice

Definition at line 86 of file ndisc-cache.cc.

References m_device, and NS_LOG_FUNCTION.

◆ GetInterface()

Ptr< Ipv6Interface > ns3::NdiscCache::GetInterface ( ) const

Get the Ipv6Interface associated with this cache.

Returns: The Ipv6Interface.

Definition at line 79 of file ndisc-cache.cc.

References m_interface, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::NdiscCache::GetTypeId ( )

static

Get the type ID.

Returns: type ID

Definition at line 28 of file ndisc-cache.cc.

References ns3::Object::Object(), DEFAULT_UNRES_QLEN, m_unresQlen, ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ GetUnresQlen()

uint32_t ns3::NdiscCache::GetUnresQlen ( )

Get the max number of waiting packet.

Returns: max number

Definition at line 183 of file ndisc-cache.cc.

References m_unresQlen, and NS_LOG_FUNCTION.

◆ Lookup()

NdiscCache::Entry * ns3::NdiscCache::Lookup ( Ipv6Address dst )

virtual

Lookup in the cache.

Parameters

dst	destination address.

Returns: the entry if found, 0 otherwise.

Definition at line 93 of file ndisc-cache.cc.

References m_ndCache, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ LookupInverse()

std::list< NdiscCache::Entry * > ns3::NdiscCache::LookupInverse ( Address dst )

Lookup in the cache for a MAC address.

Parameters

dst	destination MAC address.

Returns: a list of matching entries.

Definition at line 109 of file ndisc-cache.cc.

References ns3::NdiscCache::Entry::GetMacAddress(), m_ndCache, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Here is the call graph for this function:

◆ operator=()

NdiscCache & ns3::NdiscCache::operator= ( const NdiscCache & )

delete

References NdiscCache().

Here is the call graph for this function:

◆ PrintNdiscCache()

void ns3::NdiscCache::PrintNdiscCache ( Ptr< OutputStreamWrapper > stream )

Print the NDISC cache entries.

Parameters

stream the ostream the NDISC cache entries is printed to

Definition at line 190 of file ndisc-cache.cc.

References ns3::Names::FindName(), m_device, m_ndCache, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ Remove()

void ns3::NdiscCache::Remove ( NdiscCache::Entry * entry )

Delete an entry.

Parameters

entry pointer to delete from the list.

Definition at line 139 of file ndisc-cache.cc.

References ns3::NdiscCache::Entry::ClearWaitingPacket(), m_ndCache, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ RemoveAutoGeneratedEntries()

void ns3::NdiscCache::RemoveAutoGeneratedEntries ( )

Clear the NDISC cache of all Auto-Generated entries.

Definition at line 717 of file ndisc-cache.cc.

References m_ndCache, and NS_LOG_FUNCTION.

◆ SetDevice()

void ns3::NdiscCache::SetDevice	(	Ptr< NetDevice >	device,
		Ptr< Ipv6Interface >	interface,
		Ptr< Icmpv6L4Protocol >	icmpv6 )

Set the device and interface.

Parameters

device	the device
interface	the IPv6 interface
icmpv6	the ICMPv6 protocol

Definition at line 68 of file ndisc-cache.cc.

References m_device, m_icmpv6, m_interface, and NS_LOG_FUNCTION.

◆ SetUnresQlen()

void ns3::NdiscCache::SetUnresQlen ( uint32_t unresQlen )

Set the max number of waiting packet.

Parameters

unresQlen value to set

Definition at line 176 of file ndisc-cache.cc.

References m_unresQlen, and NS_LOG_FUNCTION.

Member Data Documentation

◆ DEFAULT_UNRES_QLEN

const uint32_t ns3::NdiscCache::DEFAULT_UNRES_QLEN = 3

static

Default value for unres qlen.

Definition at line 51 of file ndisc-cache.h.

Referenced by GetTypeId().

◆ m_device

Ptr<NetDevice> ns3::NdiscCache::m_device

private

The NetDevice.

Definition at line 469 of file ndisc-cache.h.

Referenced by DoDispose(), GetDevice(), PrintNdiscCache(), and SetDevice().

◆ m_icmpv6

Ptr<Icmpv6L4Protocol> ns3::NdiscCache::m_icmpv6

private

the icmpv6 L4 protocol for this cache.

Definition at line 479 of file ndisc-cache.h.

Referenced by DoDispose(), ns3::NdiscCache::Entry::FunctionProbeTimeout(), ns3::NdiscCache::Entry::FunctionRetransmitTimeout(), and SetDevice().

◆ m_interface

Ptr<Ipv6Interface> ns3::NdiscCache::m_interface

private

the interface.

Definition at line 474 of file ndisc-cache.h.

Referenced by DoDispose(), GetInterface(), and SetDevice().

◆ m_ndCache

Cache ns3::NdiscCache::m_ndCache

protected

A list of Entry.

Definition at line 463 of file ndisc-cache.h.

Referenced by Add(), DoDispose(), Flush(), Lookup(), LookupInverse(), PrintNdiscCache(), Remove(), and RemoveAutoGeneratedEntries().

◆ m_unresQlen

uint32_t ns3::NdiscCache::m_unresQlen

private

Max number of packet stored in m_waiting.

Definition at line 484 of file ndisc-cache.h.

Referenced by GetTypeId(), GetUnresQlen(), and SetUnresQlen().

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

src/internet/model/ndisc-cache.h
src/internet/model/ndisc-cache.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Member Typedef Documentation

◆ Cache

◆ CacheI

◆ Ipv6PayloadHeaderPair

Constructor & Destructor Documentation

◆ NdiscCache() [1/2]

◆ ~NdiscCache()

◆ NdiscCache() [2/2]

Member Function Documentation

◆ Add()

◆ DoDispose()

◆ Flush()

◆ GetDevice()

◆ GetInterface()

◆ GetTypeId()

◆ GetUnresQlen()

◆ Lookup()

◆ LookupInverse()

◆ operator=()

◆ PrintNdiscCache()

◆ Remove()

◆ RemoveAutoGeneratedEntries()

◆ SetDevice()

◆ SetUnresQlen()

Member Data Documentation

◆ DEFAULT_UNRES_QLEN

◆ m_device

◆ m_icmpv6

◆ m_interface

◆ m_ndCache

◆ m_unresQlen