Doxygen introspection did not find any typical Config paths. More...

#include <ndisc-cache.h>

Inheritance diagram for ns3::NdiscCache:

Collaboration diagram for ns3::NdiscCache:

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

Public Member Functions
	NdiscCache ()
	Constructor. More...

	~NdiscCache ()
	Destructor. More...

NdiscCache::Entry *	Add (Ipv6Address to)
	Add an entry. More...

void	Flush ()
	Flush the cache. More...

Ptr< NetDevice >	GetDevice () const
	Get the NetDevice associated with this cache. More...

Ptr< Ipv6Interface >	GetInterface () const
	Get the Ipv6Interface associated with this cache. More...

uint32_t	GetUnresQlen ()
	Get the max number of waiting packet. More...

NdiscCache::Entry *	Lookup (Ipv6Address dst)
	Lookup in the cache. More...

void	Remove (NdiscCache::Entry *entry)
	Delete an entry. More...

void	SetDevice (Ptr< NetDevice > device, Ptr< Ipv6Interface > interface)
	Set the device and interface. More...

void	SetUnresQlen (uint32_t unresQlen)
	Set the max number of waiting packet. More...

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. 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

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

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::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...

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

Private Types
typedef sgi::hash_map < Ipv6Address, NdiscCache::Entry *, Ipv6AddressHash >	Cache
	Neighbor Discovery Cache container. More...

typedef sgi::hash_map < Ipv6Address, NdiscCache::Entry *, Ipv6AddressHash >::iterator	CacheI
	Neighbor Discovery Cache container iterator. More...

Private Member Functions
	NdiscCache (NdiscCache const &)
	Copy constructor. More...

void	DoDispose ()
	Dispose this object. More...

NdiscCache &	operator= (NdiscCache const &)
	Copy constructor. More...

Private Attributes
Ptr< NetDevice >	m_device
	The NetDevice. More...

Ptr< Ipv6Interface >	m_interface
	the interface. More...

Cache	m_ndCache
	A list of Entry. More...

uint32_t	m_unresQlen
	Max number of packet stored in m_waiting. More...

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

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Doxygen introspection did not find any typical Config paths.

IPv6 Neighbor Discovery cache.

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: construct write read

No TraceSources are defined for this type.

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

Member Typedef Documentation

typedef sgi::hash_map<Ipv6Address, NdiscCache::Entry *, Ipv6AddressHash> ns3::NdiscCache::Cache

private

Neighbor Discovery Cache container.

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

typedef sgi::hash_map<Ipv6Address, NdiscCache::Entry *, Ipv6AddressHash>::iterator ns3::NdiscCache::CacheI

private

Neighbor Discovery Cache container iterator.

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

Constructor & Destructor Documentation

ns3::NdiscCache::NdiscCache ( )

Constructor.

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

References NS_LOG_FUNCTION_NOARGS.

ns3::NdiscCache::~NdiscCache ( )

Destructor.

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

References Flush(), and NS_LOG_FUNCTION_NOARGS.

Here is the call graph for this function:

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

private

Copy constructor.

Not implemented to avoid misuse

Member Function Documentation

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

Add an entry.

Parameters

to	address to add

Returns: an new Entry

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

References m_ndCache, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::HandleNS(), ns3::Icmpv6L4Protocol::HandleRedirection(), ns3::Icmpv6L4Protocol::HandleRS(), ns3::Icmpv6L4Protocol::Lookup(), and ns3::Icmpv6L4Protocol::ReceiveLLA().

Here is the caller graph for this function:

void ns3::NdiscCache::DoDispose ( void )

privatevirtual

Dispose this object.

Reimplemented from ns3::Object.

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

References ns3::Object::DoDispose(), Flush(), m_device, m_interface, and NS_LOG_FUNCTION_NOARGS.

Here is the call graph for this function:

void ns3::NdiscCache::Flush ( void )

Flush the cache.

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

References m_ndCache, and NS_LOG_FUNCTION_NOARGS.

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

Here is the caller graph for this function:

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

Get the NetDevice associated with this cache.

Returns: NetDevice

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

References m_device, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::Icmpv6L4Protocol::Lookup().

Here is the caller graph for this function:

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

Get the Ipv6Interface associated with this cache.

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

References m_interface, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::Icmpv6L4Protocol::HandleNA(), ns3::Icmpv6L4Protocol::Lookup(), and ns3::Icmpv6L4Protocol::ReceiveLLA().

Here is the caller graph for this function:

TypeId ns3::NdiscCache::GetTypeId ( void )

static

Get the type ID.

Returns: type ID

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

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

Here is the call graph for this function:

uint32_t ns3::NdiscCache::GetUnresQlen ( )

Get the max number of waiting packet.

Returns: max number

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

References m_unresQlen, and NS_LOG_FUNCTION_NOARGS.

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

Lookup in the cache.

Parameters

dst	destination address

Returns: the entry if found, 0 otherwise

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

References m_ndCache, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::HandleNA(), ns3::Icmpv6L4Protocol::HandleNS(), ns3::Icmpv6L4Protocol::HandleRedirection(), ns3::Icmpv6L4Protocol::HandleRS(), ns3::Icmpv6L4Protocol::Lookup(), and ns3::Icmpv6L4Protocol::ReceiveLLA().

Here is the caller graph for this function:

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

private

Copy constructor.

Not implemented to avoid misuse

Returns

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

Delete an entry.

Parameters

entry pointer to delete from the list.

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

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

Referenced by ns3::Icmpv6L4Protocol::Lookup().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Set the device and interface.

Parameters

device	the device
interface	the IPv6 interface

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

References m_device, m_interface, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::CreateCache().

Here is the caller graph for this function:

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

Set the max number of waiting packet.

Parameters

unresQlen value to set

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

References m_unresQlen, and NS_LOG_FUNCTION.

Member Data Documentation

const uint32_t ns3::NdiscCache::DEFAULT_UNRES_QLEN = 3

static

Default value for unres qlen.

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

Referenced by GetTypeId().

Ptr<NetDevice> ns3::NdiscCache::m_device

private

The NetDevice.

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

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

Ptr<Ipv6Interface> ns3::NdiscCache::m_interface

private

the interface.

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

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

Cache ns3::NdiscCache::m_ndCache

private

A list of Entry.

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

Referenced by Add(), ns3::NdiscCache::Entry::AddWaitingPacket(), Flush(), ns3::NdiscCache::Entry::FunctionDelayTimeout(), ns3::NdiscCache::Entry::FunctionProbeTimeout(), ns3::NdiscCache::Entry::FunctionRetransmitTimeout(), Lookup(), and Remove().

uint32_t ns3::NdiscCache::m_unresQlen

private

Max number of packet stored in m_waiting.

Definition at line 462 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 Member Functions

Static Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation