ns3::NdiscCache Class Reference

IPv6 Neighbor Discovery cache. More...

#include <ndisc-cache.h>

Inheritance diagram for ns3::NdiscCache:

Collaboration diagram for ns3::NdiscCache:

List of all members.

Classes
class	Entry
	A record that holds information about an NdiscCache entry. More...
Public Member Functions
	NdiscCache ()
	Constructor.
	~NdiscCache ()
	Destructor.
Ptr< NetDevice >	GetDevice () const
	Get the NetDevice associated with this cache.
Ptr< Ipv6Interface >	GetInterface () const
	Get the Ipv6Interface associated with this cache.
NdiscCache::Entry *	Lookup (Ipv6Address dst)
	Lookup in the cache.
NdiscCache::Entry *	Add (Ipv6Address to)
	Add an entry.
void	Remove (NdiscCache::Entry *entry)
	Delete an entry.
void	Flush ()
	Flush the cache.
void	SetUnresQlen (uint32_t unresQlen)
	Set the max number of waiting packet.
uint32_t	GetUnresQlen ()
	Get the max number of waiting packet.
void	SetDevice (Ptr< NetDevice > device, Ptr< Ipv6Interface > interface)
	Set the device and interface.
Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.
Static Public Attributes
static const uint32_t	DEFAULT_UNRES_QLEN = 3
	Default value for unres qlen.

---

Detailed Description

IPv6 Neighbor Discovery cache.

---

Member Function Documentation

NdiscCache::Entry * ns3::NdiscCache::Add

(

Ipv6Address

to

)

Add an entry.

Parameters:

to	address to add

Returns:

an new Entry

References NS_ASSERT, and NS_LOG_FUNCTION.

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

Ptr< NetDevice > ns3::NdiscCache::GetDevice

(

void

)

const

Get the NetDevice associated with this cache.

Returns:

NetDevice

References NS_LOG_FUNCTION_NOARGS.

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

TypeId ns3::NdiscCache::GetTypeId

(

void

)

[static]

Get the type ID.

This method returns the TypeId associated to ns3::NdiscCache.

Returns:

type ID

This object is accessible through the following paths with Config::Set and Config::Connect:

• /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::NdiscCache
• /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::NdiscCache

Attributes defined for this type:

• 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 defined for this type.

Reimplemented from ns3::Object.

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

uint32_t ns3::NdiscCache::GetUnresQlen

(

)

Get the max number of waiting packet.

Returns:

max number

References 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

References NS_LOG_FUNCTION.

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

void ns3::NdiscCache::Remove

(

NdiscCache::Entry *

entry

)

Delete an entry.

Parameters:

entry

pointer to delete from the list.

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

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

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

Set the device and interface.

Parameters:

device	the device
interface	the IPv6 interface

References NS_LOG_FUNCTION.

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

void ns3::NdiscCache::SetUnresQlen

(

uint32_t

unresQlen

)

Set the max number of waiting packet.

Parameters:

unresQlen

value to set

References NS_LOG_FUNCTION.

---

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

• src/internet/model/ndisc-cache.h
• doc/introspected-doxygen.h
• src/internet/model/ndisc-cache.cc