A record that holds information about a NdiscCache entry. More...

#include "ndisc-cache.h"

Collaboration diagram for ns3::NdiscCache::Entry:

Public Types
enum	NdiscCacheEntryState_e { INCOMPLETE , REACHABLE , STALE , DELAY , PROBE , PERMANENT , STATIC_AUTOGENERATED }
	The Entry state enumeration. More...

Public Member Functions
	Entry (NdiscCache *nd)
	Constructor. More...

virtual	~Entry ()=default

void	AddWaitingPacket (Ipv6PayloadHeaderPair p)
	Add a packet (or replace old value) in the queue. More...

void	ClearWaitingPacket ()
	Clear the waiting packet list. More...

void	FunctionDelayTimeout ()
	Function called when delay timer timeout. More...

void	FunctionProbeTimeout ()
	Function called when probe timer timeout. More...

void	FunctionReachableTimeout ()
	Function called when reachable timer timeout. More...

void	FunctionRetransmitTimeout ()
	Function called when retransmit timer timeout. More...

NdiscCacheEntryState_e	GetEntryState () const
	Get the state of the entry. More...

Ipv6Address	GetIpv6Address () const
	Get the IPv6 address. More...

Time	GetLastReachabilityConfirmation () const
	Get the time of last reachability confirmation. More...

Address	GetMacAddress () const
	Get the MAC address of this entry. More...

bool	IsAutoGenerated () const
	Is the entry STATIC_AUTOGENERATED. More...

bool	IsDelay () const
	Is the entry DELAY. More...

bool	IsIncomplete () const
	Is the entry INCOMPLETE. More...

bool	IsPermanent () const
	Is the entry PERMANENT. More...

bool	IsProbe () const
	Is the entry PROBE. More...

bool	IsReachable () const
	Is the entry REACHABLE. More...

bool	IsRouter () const
	If the entry is a host or a router. More...

bool	IsStale () const
	Is the entry STALE. More...

void	MarkAutoGenerated ()
	Changes the state of this entry to auto-generated. More...

void	MarkDelay ()
	Change the state to this entry to DELAY. More...

void	MarkIncomplete (Ipv6PayloadHeaderPair p)
	Changes the state to this entry to INCOMPLETE. More...

void	MarkPermanent ()
	Change the state to this entry to PERMANENT. More...

void	MarkProbe ()
	Changes the state to this entry to PROBE. More...

void	MarkReachable ()
	Changes the state to this entry to REACHABLE. More...

std::list< Ipv6PayloadHeaderPair >	MarkReachable (Address mac)
	Changes the state to this entry to REACHABLE. More...

void	MarkStale ()
	Changes the state to this entry to STALE. More...

std::list< Ipv6PayloadHeaderPair >	MarkStale (Address mac)
	Changes the state to this entry to STALE. More...

void	Print (std::ostream &os) const
	Print this entry to the given output stream. More...

void	SetIpv6Address (Ipv6Address ipv6Address)
	Set the IPv6 address. More...

void	SetMacAddress (Address mac)
	Set the MAC address of this entry. More...

void	SetRouter (bool router)
	Set the node type. More...

void	StartDelayTimer ()
	Start delay timer. More...

void	StartProbeTimer ()
	Start probe timer. More...

void	StartReachableTimer ()
	Start the reachable timer. More...

void	StartRetransmitTimer ()
	Start retransmit timer. More...

void	StopNudTimer ()
	Stop NUD timer and reset the NUD retransmission counter. More...

void	UpdateReachableTimer ()
	Update the reachable timer. More...

Public Attributes
NdiscCacheEntryState_e	m_state
	The state of the entry. More...

Protected Attributes
NdiscCache *	m_ndCache
	the NdiscCache associated. More...

Private Attributes
Ipv6Address	m_ipv6Address
	The IPv6 address. More...

Time	m_lastReachabilityConfirmation
	Last time we see a reachability confirmation. More...

Address	m_macAddress
	The MAC address. More...

uint8_t	m_nsRetransmit
	Number of NS retransmission. More...

Timer	m_nudTimer
	Timer (used for NUD). More...

bool	m_router
	Type of node (router or host). More...

std::list< Ipv6PayloadHeaderPair >	m_waiting
	The list of packet waiting. More...

Detailed Description

A record that holds information about a NdiscCache entry.

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

Member Enumeration Documentation

◆ NdiscCacheEntryState_e

enum ns3::NdiscCache::Entry::NdiscCacheEntryState_e

The Entry state enumeration.

Enumerator
INCOMPLETE	No mapping between IPv6 and L2 addresses.
REACHABLE	Mapping exists between IPv6 and L2 addresses.
STALE	Mapping is stale.
DELAY	Try to wait contact from remote host.
PROBE	Try to contact IPv6 address to know again its L2 address.
PERMANENT	Permanent Mapping exists between IPv6 and L2 addresses.
STATIC_AUTOGENERATED	Permanent entries generate by NeighborCacheHelper.

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

Constructor & Destructor Documentation

◆ Entry()

ns3::NdiscCache::Entry::Entry ( NdiscCache * nd )

Constructor.

Parameters

nd	The NdiscCache this entry belongs to.

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

References NS_LOG_FUNCTION.

◆ ~Entry()

virtual ns3::NdiscCache::Entry::~Entry ( )

virtualdefault

Member Function Documentation

◆ AddWaitingPacket()

void ns3::NdiscCache::Entry::AddWaitingPacket ( Ipv6PayloadHeaderPair p )

Add a packet (or replace old value) in the queue.

Parameters

p	packet to add

Todo:: report packet as 'dropped'

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

References ns3::NdiscCache::m_ndCache, and NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

◆ ClearWaitingPacket()

void ns3::NdiscCache::Entry::ClearWaitingPacket ( )

Clear the waiting packet list.

Todo:: report packets as 'dropped'

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

References NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::HandleNA(), ns3::Ipv6L3Protocol::ReachabilityHint(), ns3::Icmpv6L4Protocol::ReceiveLLA(), and ns3::NdiscCache::Remove().

Here is the caller graph for this function:

◆ FunctionDelayTimeout()

void ns3::NdiscCache::Entry::FunctionDelayTimeout ( )

Function called when delay timer timeout.

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

References ns3::Ipv6Address::IsAny(), ns3::NdiscCache::m_ndCache, NS_LOG_FUNCTION, and ns3::Ipv6L3Protocol::PROT_NUMBER.

Referenced by StartDelayTimer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FunctionProbeTimeout()

void ns3::NdiscCache::Entry::FunctionProbeTimeout ( )

Function called when probe timer timeout.

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

References ns3::Ipv6Address::IsAny(), ns3::NdiscCache::m_icmpv6, ns3::NdiscCache::m_ndCache, NS_LOG_FUNCTION, and ns3::Ipv6L3Protocol::PROT_NUMBER.

Referenced by StartProbeTimer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FunctionReachableTimeout()

void ns3::NdiscCache::Entry::FunctionReachableTimeout ( )

Function called when reachable timer timeout.

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

References NS_LOG_FUNCTION.

Referenced by StartReachableTimer().

Here is the caller graph for this function:

◆ FunctionRetransmitTimeout()

void ns3::NdiscCache::Entry::FunctionRetransmitTimeout ( )

Function called when retransmit timer timeout.

It verify that the NS retransmit has reached the max so discard the entry otherwise it retransmit a NS.

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

References ns3::Icmpv6Header::ICMPV6_ADDR_UNREACHABLE, ns3::Ipv6Address::IsAny(), ns3::NdiscCache::m_icmpv6, ns3::NdiscCache::m_ndCache, ns3::Ipv6Address::MakeSolicitedAddress(), and NS_LOG_FUNCTION.

Referenced by StartRetransmitTimer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetEntryState()

NdiscCacheEntryState_e ns3::NdiscCache::Entry::GetEntryState ( ) const

Get the state of the entry.

Returns: The state of the entry

◆ GetIpv6Address()

Ipv6Address ns3::NdiscCache::Entry::GetIpv6Address ( ) const

Get the IPv6 address.

Returns: The IPv6 address

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

References NS_LOG_FUNCTION.

◆ GetLastReachabilityConfirmation()

Time ns3::NdiscCache::Entry::GetLastReachabilityConfirmation ( ) const

Get the time of last reachability confirmation.

Returns: time

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

References NS_LOG_FUNCTION.

◆ GetMacAddress()

Address ns3::NdiscCache::Entry::GetMacAddress ( ) const

Get the MAC address of this entry.

Returns: the L2 address

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

References NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

◆ IsAutoGenerated()

bool ns3::NdiscCache::Entry::IsAutoGenerated ( ) const

Is the entry STATIC_AUTOGENERATED.

Returns: True if the state of this entry is auto-generated; false otherwise.

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

References NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::Lookup(), and ns3::Ipv6L3Protocol::ReachabilityHint().

Here is the caller graph for this function:

◆ IsDelay()

bool ns3::NdiscCache::Entry::IsDelay ( ) const

Is the entry DELAY.

Returns: true if the entry is in DELAY state, false otherwise

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

References DELAY, and NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

◆ IsIncomplete()

bool ns3::NdiscCache::Entry::IsIncomplete ( ) const

Is the entry INCOMPLETE.

Returns: true if the entry is in INCOMPLETE state, false otherwise

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

References NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::HandleRedirection(), and ns3::Ipv6L3Protocol::ReachabilityHint().

Here is the caller graph for this function:

◆ IsPermanent()

bool ns3::NdiscCache::Entry::IsPermanent ( ) const

Is the entry PERMANENT.

Returns: true if the entry is in PERMANENT state, false otherwise

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

References NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::Lookup(), and ns3::Ipv6L3Protocol::ReachabilityHint().

Here is the caller graph for this function:

◆ IsProbe()

bool ns3::NdiscCache::Entry::IsProbe ( ) const

Is the entry PROBE.

Returns: true if the entry is in PROBE state, false otherwise

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

References NS_LOG_FUNCTION.

Referenced by ns3::Ipv6L3Protocol::ReachabilityHint().

Here is the caller graph for this function:

◆ IsReachable()

bool ns3::NdiscCache::Entry::IsReachable ( ) const

Is the entry REACHABLE.

Returns: true if the entry is in REACHABLE state, false otherwise

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

References NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::Lookup(), and ns3::Ipv6L3Protocol::ReachabilityHint().

Here is the caller graph for this function:

◆ IsRouter()

bool ns3::NdiscCache::Entry::IsRouter ( ) const

If the entry is a host or a router.

Returns: true if the node is a router, 0 if it is a host

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

References NS_LOG_FUNCTION.

◆ IsStale()

bool ns3::NdiscCache::Entry::IsStale ( ) const

Is the entry STALE.

Returns: true if the entry is in STALE state, false otherwise

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

References NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

◆ MarkAutoGenerated()

void ns3::NdiscCache::Entry::MarkAutoGenerated ( )

Changes the state of this entry to auto-generated.

The entry must have a valid MacAddress.

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

References NS_LOG_FUNCTION.

Referenced by ns3::NeighborCacheHelper::AddEntry().

Here is the caller graph for this function:

◆ MarkDelay()

void ns3::NdiscCache::Entry::MarkDelay ( )

Change the state to this entry to DELAY.

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

References DELAY, and NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

◆ MarkIncomplete()

void ns3::NdiscCache::Entry::MarkIncomplete ( Ipv6PayloadHeaderPair p )

Changes the state to this entry to INCOMPLETE.

Parameters

p	packet that wait to be sent

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

References NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

◆ MarkPermanent()

void ns3::NdiscCache::Entry::MarkPermanent ( )

Change the state to this entry to PERMANENT.

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

References NS_LOG_FUNCTION.

Referenced by FlushTest::DoRun().

Here is the caller graph for this function:

◆ MarkProbe()

void ns3::NdiscCache::Entry::MarkProbe ( )

Changes the state to this entry to PROBE.

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

References NS_LOG_FUNCTION.

◆ MarkReachable() [1/2]

void ns3::NdiscCache::Entry::MarkReachable ( )

Changes the state to this entry to REACHABLE.

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

References NS_LOG_FUNCTION.

◆ MarkReachable() [2/2]

std::list< NdiscCache::Ipv6PayloadHeaderPair > ns3::NdiscCache::Entry::MarkReachable ( Address mac )

Changes the state to this entry to REACHABLE.

Parameters

mac	MAC address

Returns: the list of packet waiting

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

References third::mac, and NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

◆ MarkStale() [1/2]

void ns3::NdiscCache::Entry::MarkStale ( )

Changes the state to this entry to STALE.

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

References NS_LOG_FUNCTION.

◆ MarkStale() [2/2]

std::list< NdiscCache::Ipv6PayloadHeaderPair > ns3::NdiscCache::Entry::MarkStale ( Address mac )

Changes the state to this entry to STALE.

Parameters

mac	L2 address

Returns: the list of packet waiting

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

References third::mac, and NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

◆ Print()

void ns3::NdiscCache::Entry::Print ( std::ostream & os ) const

Print this entry to the given output stream.

Parameters

os	the output stream to which this Ipv6Address is printed

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

References DELAY.

Referenced by ns3::operator<<().

Here is the caller graph for this function:

◆ SetIpv6Address()

void ns3::NdiscCache::Entry::SetIpv6Address ( Ipv6Address ipv6Address )

Set the IPv6 address.

Parameters

ipv6Address IPv6 address

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

References NS_LOG_FUNCTION.

◆ SetMacAddress()

void ns3::NdiscCache::Entry::SetMacAddress ( Address mac )

Set the MAC address of this entry.

Parameters

mac	the MAC address to set

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

References third::mac, and NS_LOG_FUNCTION.

Referenced by ns3::NeighborCacheHelper::AddEntry(), FlushTest::DoRun(), ns3::Icmpv6L4Protocol::HandleNA(), ns3::Icmpv6L4Protocol::HandleRedirection(), and ns3::Icmpv6L4Protocol::ReceiveLLA().

Here is the caller graph for this function:

◆ SetRouter()

void ns3::NdiscCache::Entry::SetRouter ( bool router )

Set the node type.

Parameters

router true is a router, false means a host

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

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

◆ StartDelayTimer()

void ns3::NdiscCache::Entry::StartDelayTimer ( )

Start delay timer.

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

References FunctionDelayTimeout(), ns3::NdiscCache::m_ndCache, and NS_LOG_FUNCTION.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StartProbeTimer()

void ns3::NdiscCache::Entry::StartProbeTimer ( )

Start probe timer.

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

References FunctionProbeTimeout(), ns3::NdiscCache::m_ndCache, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ StartReachableTimer()

void ns3::NdiscCache::Entry::StartReachableTimer ( )

Start the reachable timer.

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

References FunctionReachableTimeout(), ns3::NdiscCache::m_ndCache, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StartRetransmitTimer()

void ns3::NdiscCache::Entry::StartRetransmitTimer ( )

Start retransmit timer.

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

References FunctionRetransmitTimeout(), ns3::NdiscCache::m_ndCache, and NS_LOG_FUNCTION.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StopNudTimer()

void ns3::NdiscCache::Entry::StopNudTimer ( )

Stop NUD timer and reset the NUD retransmission counter.

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

References NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

◆ UpdateReachableTimer()

void ns3::NdiscCache::Entry::UpdateReachableTimer ( )

Update the reachable timer.

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

References ns3::Simulator::Now(), and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6L3Protocol::ReachabilityHint(), and ns3::Ipv6L3Protocol::Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_ipv6Address

Ipv6Address ns3::NdiscCache::Entry::m_ipv6Address

private

The IPv6 address.

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

◆ m_lastReachabilityConfirmation

Time ns3::NdiscCache::Entry::m_lastReachabilityConfirmation

private

Last time we see a reachability confirmation.

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

◆ m_macAddress

Address ns3::NdiscCache::Entry::m_macAddress

private

The MAC address.

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

◆ m_ndCache

NdiscCache* ns3::NdiscCache::Entry::m_ndCache

protected

the NdiscCache associated.

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

◆ m_nsRetransmit

uint8_t ns3::NdiscCache::Entry::m_nsRetransmit

private

Number of NS retransmission.

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

◆ m_nudTimer

Timer ns3::NdiscCache::Entry::m_nudTimer

private

Timer (used for NUD).

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

◆ m_router

bool ns3::NdiscCache::Entry::m_router

private

Type of node (router or host).

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

◆ m_state

NdiscCacheEntryState_e ns3::NdiscCache::Entry::m_state

The state of the entry.

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

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

◆ m_waiting

std::list<Ipv6PayloadHeaderPair> ns3::NdiscCache::Entry::m_waiting

private

The list of packet waiting.

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

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

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

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ NdiscCacheEntryState_e

Constructor & Destructor Documentation

◆ Entry()

◆ ~Entry()

Member Function Documentation

◆ AddWaitingPacket()

◆ ClearWaitingPacket()

◆ FunctionDelayTimeout()

◆ FunctionProbeTimeout()

◆ FunctionReachableTimeout()

◆ FunctionRetransmitTimeout()

◆ GetEntryState()

◆ GetIpv6Address()

◆ GetLastReachabilityConfirmation()

◆ GetMacAddress()

◆ IsAutoGenerated()

◆ IsDelay()

◆ IsIncomplete()

◆ IsPermanent()

◆ IsProbe()

◆ IsReachable()

◆ IsRouter()

◆ IsStale()

◆ MarkAutoGenerated()

◆ MarkDelay()

◆ MarkIncomplete()

◆ MarkPermanent()

◆ MarkProbe()

◆ MarkReachable() [1/2]

◆ MarkReachable() [2/2]

◆ MarkStale() [1/2]

◆ MarkStale() [2/2]

◆ Print()

◆ SetIpv6Address()

◆ SetMacAddress()

◆ SetRouter()

◆ StartDelayTimer()

◆ StartProbeTimer()

◆ StartReachableTimer()

◆ StartRetransmitTimer()

◆ StopNudTimer()

◆ UpdateReachableTimer()

Member Data Documentation

◆ m_ipv6Address

◆ m_lastReachabilityConfirmation

◆ m_macAddress

◆ m_ndCache

◆ m_nsRetransmit

◆ m_nudTimer

◆ m_router

◆ m_state

◆ m_waiting