inet::IPv6NeighbourCache Class Reference

IPv6 Neighbour Cache (RFC 2461 Neighbor Discovery for IPv6). More...

#include <IPv6NeighbourCache.h>

Classes
class	DefaultRouterList
struct	Key
	Key into neighbour cache. More...
struct	Neighbour
	Stores a neighbour (or router) entry. More...

Public Types
enum	ReachabilityState {   INCOMPLETE, REACHABLE, STALE, DELAY,   PROBE }
	Neighbour's reachability state. More...
typedef std::vector< cMessage * >	MsgPtrVector
typedef std::map< Key, Neighbour >	NeighbourMap
	The std::map underlying the Neighbour Cache data structure. More...

Public Member Functions
	IPv6NeighbourCache (cSimpleModule &neighbourDiscovery)
virtual	~IPv6NeighbourCache ()
virtual Neighbour *	lookup (const IPv6Address &addr, int interfaceID)
	Returns a neighbour entry, or nullptr. More...
virtual const Key *	lookupKeyAddr (Key &key)
	Experimental code. More...
DefaultRouterList &	getDefaultRouterList ()
NeighbourMap::iterator	begin ()
	For iteration on the internal std::map. More...
NeighbourMap::iterator	end ()
	For iteration on the internal std::map. More...
virtual Neighbour *	addNeighbour (const IPv6Address &addr, int interfaceID)
	Creates and initializes a neighbour entry with isRouter=false, state=INCOMPLETE. More...
virtual Neighbour *	addNeighbour (const IPv6Address &addr, int interfaceID, MACAddress macAddress)
	Creates and initializes a neighbour entry with isRouter=false, MAC address and state=STALE. More...
virtual Neighbour *	addRouter (const IPv6Address &addr, int interfaceID, MACAddress macAddress, simtime_t expiryTime, bool isHomeAgent=false)
	Creates and initializes a router entry (isRouter=isDefaultRouter=true), MAC address and state=STALE. More...
virtual void	remove (const IPv6Address &addr, int interfaceID)
	Deletes the given neighbour from the cache. More...
virtual void	invalidateEntriesForInterfaceID (int interfaceID)
	Set status of all neighbours on given interface to state PROBE. More...
virtual void	invalidateAllEntries ()
	Set status of all neighbours to state PROBE. More...
virtual void	remove (NeighbourMap::iterator it)
	Deletes the given neighbour from the cache. More...

Static Public Member Functions
static const char *	stateName (ReachabilityState state)
	Returns the name of the given state as string. More...

Protected Attributes
cSimpleModule &	neighbourDiscovery
NeighbourMap	neighbourMap
DefaultRouterList	defaultRouterList

Detailed Description

IPv6 Neighbour Cache (RFC 2461 Neighbor Discovery for IPv6).

Used internally by the IPv6NeighbourDiscovery simple module.

This is just a plain container class – the IPv6NeighbourDiscovery module is free to manipulate the contents of the Neighbour entries as it pleases.

NOTE: IPv6NeighbourCache also stores the Default Router List. A router becomes a default router by calling getDefaultRouterList().add(router) and stops to be a default router after getDefaultRouterList().remove(router) has been called. References to default routers are stored in a circular list to ease round-robin selection.

Member Typedef Documentation

typedef std::vector<cMessage *> inet::IPv6NeighbourCache::MsgPtrVector

typedef std::map<Key, Neighbour> inet::IPv6NeighbourCache::NeighbourMap

The std::map underlying the Neighbour Cache data structure.

Member Enumeration Documentation

enum inet::IPv6NeighbourCache::ReachabilityState

Neighbour's reachability state.

Enumerator
INCOMPLETE
REACHABLE
STALE
DELAY
PROBE

{ INCOMPLETE, REACHABLE, STALE, DELAY, PROBE };

Constructor & Destructor Documentation

inet::IPv6NeighbourCache::IPv6NeighbourCache

(

cSimpleModule &

neighbourDiscovery

)

    : neighbourDiscovery(neighbourDiscovery)
{
    WATCH_MAP(neighbourMap);
}

virtual inet::IPv6NeighbourCache::~IPv6NeighbourCache ( )

inlinevirtual

{}

Member Function Documentation

IPv6NeighbourCache::Neighbour * inet::IPv6NeighbourCache::addNeighbour ( const IPv6Address &  addr, int  interfaceID  )

virtual

Creates and initializes a neighbour entry with isRouter=false, state=INCOMPLETE.

Referenced by inet::IPv6NeighbourDiscovery::processIPv6Datagram(), inet::IPv6NeighbourDiscovery::processNSWithSpecifiedSrcAddr(), and inet::IPv6NeighbourDiscovery::processRAForRouterUpdates().

{
    Key key(addr, interfaceID);
    ASSERT(neighbourMap.find(key) == neighbourMap.end());    // entry must not exist yet
    Neighbour& nbor = neighbourMap[key];

    nbor.nceKey = lookupKeyAddr(key);
    nbor.isRouter = false;
    nbor.isHomeAgent = false;
    nbor.reachabilityState = INCOMPLETE;
    return &nbor;
}

IPv6NeighbourCache::Neighbour * inet::IPv6NeighbourCache::addNeighbour ( const IPv6Address &  addr, int  interfaceID, MACAddress  macAddress  )

virtual

Creates and initializes a neighbour entry with isRouter=false, MAC address and state=STALE.

{
    Key key(addr, interfaceID);
    ASSERT(neighbourMap.find(key) == neighbourMap.end());    // entry must not exist yet
    Neighbour& nbor = neighbourMap[key];

    nbor.nceKey = lookupKeyAddr(key);
    nbor.macAddress = macAddress;
    nbor.isRouter = false;
    nbor.isHomeAgent = false;
    nbor.reachabilityState = STALE;
    return &nbor;
}

IPv6NeighbourCache::Neighbour * inet::IPv6NeighbourCache::addRouter ( const IPv6Address &  addr, int  interfaceID, MACAddress  macAddress, simtime_t  expiryTime, bool  isHomeAgent = false  )

virtual

Creates and initializes a router entry (isRouter=isDefaultRouter=true), MAC address and state=STALE.

Update by CB: Added an optional parameter which is false by default. Specifies whether a router is also a home agent.

Referenced by inet::IPv6NeighbourDiscovery::processRAForRouterUpdates().

{
    Key key(addr, interfaceID);
    ASSERT(neighbourMap.find(key) == neighbourMap.end());    // entry must not exist yet
    Neighbour& nbor = neighbourMap[key];

    nbor.nceKey = lookupKeyAddr(key);
    nbor.macAddress = macAddress;
    nbor.isRouter = true;
    nbor.isHomeAgent = isHomeAgent;
    nbor.reachabilityState = STALE;
    nbor.routerExpiryTime = expiryTime;

    defaultRouterList.add(nbor);

    return &nbor;
}

NeighbourMap::iterator inet::IPv6NeighbourCache::begin ( )

inline

For iteration on the internal std::map.

Referenced by inet::IPv6NeighbourDiscovery::routersUnreachabilityDetection().

{ return neighbourMap.begin(); }

NeighbourMap::iterator inet::IPv6NeighbourCache::end ( )

inline

For iteration on the internal std::map.

Referenced by inet::IPv6NeighbourDiscovery::routersUnreachabilityDetection().

{ return neighbourMap.end(); }

DefaultRouterList& inet::IPv6NeighbourCache::getDefaultRouterList ( )

inline

Referenced by inet::IPv6NeighbourDiscovery::processNAForIncompleteNCEState(), inet::IPv6NeighbourDiscovery::processNAForOtherNCEStates(), and inet::IPv6NeighbourDiscovery::selectDefaultRouter().

{ return defaultRouterList; }

void inet::IPv6NeighbourCache::invalidateAllEntries ( )

virtual

Set status of all neighbours to state PROBE.

Referenced by inet::IPv6NeighbourDiscovery::invalidateNeigbourCache().

{
    while (!neighbourMap.empty()) {
        auto it = neighbourMap.begin();
        remove(it);
    }
    defaultRouterList.clear();

    /*
       int size = neighbourMap.size();
       EV << "size: " << size << endl;
       for (auto it = neighbourMap.begin(); it != neighbourMap.end(); it++)
       {
        it->second.reachabilityState = PROBE; // we make sure this neighbour is not used anymore in the future, unless reachability can be confirmed
       }
     */
}

void inet::IPv6NeighbourCache::invalidateEntriesForInterfaceID ( int  interfaceID )

virtual

Set status of all neighbours on given interface to state PROBE.

{
    for (auto & elem : neighbourMap) {
        if (elem.first.interfaceID == interfaceID) {
            elem.second.reachabilityState = PROBE;    // we make sure this neighbour is not used anymore in the future, unless reachability can be confirmed
            neighbourDiscovery.cancelAndDelete(elem.second.nudTimeoutEvent);    // 20.9.07 - CB
            elem.second.nudTimeoutEvent = nullptr;
        }
    }
}

IPv6NeighbourCache::Neighbour * inet::IPv6NeighbourCache::lookup ( const IPv6Address &  addr, int  interfaceID  )

virtual

Returns a neighbour entry, or nullptr.

Referenced by inet::IPv6NeighbourDiscovery::processIPv6Datagram(), inet::IPv6NeighbourDiscovery::processNAPacket(), inet::IPv6NeighbourDiscovery::processNSWithSpecifiedSrcAddr(), inet::IPv6NeighbourDiscovery::processRAForRouterUpdates(), inet::IPv6NeighbourDiscovery::reachabilityConfirmed(), and inet::IPv6NeighbourDiscovery::resolveNeighbour().

{
    Key key(addr, interfaceID);
    auto i = neighbourMap.find(key);
    return i == neighbourMap.end() ? nullptr : &(i->second);
}

const IPv6NeighbourCache::Key * inet::IPv6NeighbourCache::lookupKeyAddr ( Key &  key )

virtual

Experimental code.

Referenced by addNeighbour(), and addRouter().

{
    auto i = neighbourMap.find(key);
    return &(i->first);
}

void inet::IPv6NeighbourCache::remove ( const IPv6Address &  addr, int  interfaceID  )

virtual

Deletes the given neighbour from the cache.

Referenced by inet::IPv6NeighbourDiscovery::dropQueuedPacketsAwaitingAR(), inet::IPv6NeighbourDiscovery::processNUDTimeout(), inet::IPv6NeighbourDiscovery::selectDefaultRouter(), and inet::IPv6NeighbourDiscovery::timeoutDefaultRouter().

{
    Key key(addr, interfaceID);
    auto it = neighbourMap.find(key);
    ASSERT(it != neighbourMap.end());    // entry must exist
    remove(it);
}

void inet::IPv6NeighbourCache::remove ( NeighbourMap::iterator  it )

virtual

Deletes the given neighbour from the cache.

{
    neighbourDiscovery.cancelAndDelete(it->second.nudTimeoutEvent);    // 20.9.07 - CB
    it->second.nudTimeoutEvent = nullptr;
    if (it->second.isDefaultRouter())
        defaultRouterList.remove(it->second);
    neighbourMap.erase(it);
}

const char * inet::IPv6NeighbourCache::stateName ( ReachabilityState  state )

static

Returns the name of the given state as string.

Referenced by inet::operator<<().

{
    switch (state) {
        case INCOMPLETE:
            return "INCOMPLETE";

        case REACHABLE:
            return "REACHABLE";

        case STALE:
            return "STALE";

        case DELAY:
            return "DELAY";

        case PROBE:
            return "PROBE";

        default:
            return "???";
    }
}

Member Data Documentation

DefaultRouterList inet::IPv6NeighbourCache::defaultRouterList

protected

Referenced by addRouter(), invalidateAllEntries(), and remove().

cSimpleModule& inet::IPv6NeighbourCache::neighbourDiscovery

protected

Referenced by invalidateEntriesForInterfaceID(), and remove().

NeighbourMap inet::IPv6NeighbourCache::neighbourMap

protected

Referenced by addNeighbour(), addRouter(), invalidateAllEntries(), invalidateEntriesForInterfaceID(), IPv6NeighbourCache(), lookup(), lookupKeyAddr(), and remove().

---

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

• IPv6NeighbourCache.h
• IPv6NeighbourCache.cc