inet::PIMNeighborTable Class Reference

Class holding informatation about neighboring PIM routers. More...

#include <PIMNeighborTable.h>

Inheritance diagram for inet::PIMNeighborTable:

Public Types
enum	TimerKind { NeighborLivenessTimer = 1 }

Public Member Functions
virtual	~PIMNeighborTable ()
virtual bool	addNeighbor (PIMNeighbor *neighbor, double holdTime)
	Adds the a neighbor to the table. More...
virtual bool	deleteNeighbor (PIMNeighbor *neighbor)
	Deletes a neighbor from the table. More...
virtual void	restartLivenessTimer (PIMNeighbor *neighbor, double holdTime)
	Restarts the Neighbor Liveness timer of the given neighbor. More...
virtual PIMNeighbor *	findNeighbor (int interfaceId, IPv4Address addr)
	Returns the neighbor that is identified by the given (interfaceId,addr), or nullptr if no such neighbor. More...
virtual int	getNumNeighbors (int interfaceId)
	Returns the number of neighbors on the given interface. More...
virtual PIMNeighbor *	getNeighbor (int interfaceId, int index)
	Returns the neighbor on the given interface at the specified position. More...

Protected Types
typedef std::vector< PIMNeighbor * >	PIMNeighborVector
typedef std::map< int, PIMNeighborVector >	InterfaceToNeighborsMap

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleMessage (cMessage *) override
virtual void	processLivenessTimer (cMessage *timer)

Protected Attributes
InterfaceToNeighborsMap	neighbors

Friends
std::ostream &	operator<< (std::ostream &os, const PIMNeighborVector &v)

Detailed Description

Class holding informatation about neighboring PIM routers.

Routers are identified by the link to which they are connected and their address.

Expired entries are automatically deleted.

Member Typedef Documentation

typedef std::map<int, PIMNeighborVector> inet::PIMNeighborTable::InterfaceToNeighborsMap

protected

typedef std::vector<PIMNeighbor *> inet::PIMNeighborTable::PIMNeighborVector

protected

Member Enumeration Documentation

enum inet::PIMNeighborTable::TimerKind

Enumerator
NeighborLivenessTimer

                   {
        NeighborLivenessTimer = 1
    };

Constructor & Destructor Documentation

inet::PIMNeighborTable::~PIMNeighborTable ( )

virtual

{
    for (auto & elem : neighbors) {
        for (auto & _it2 : elem.second) {
            cancelEvent((_it2)->getLivenessTimer());
            delete (_it2);
        }
    }
}

Member Function Documentation

bool inet::PIMNeighborTable::addNeighbor ( PIMNeighbor *  neighbor, double  holdTime  )

virtual

Adds the a neighbor to the table.

The operation might fail if there is a neighbor with the same (ie,address) in the table. Success is indicated by the returned value.

{
    Enter_Method_Silent();

    PIMNeighborVector& neighborsOnInterface = neighbors[entry->getInterfaceId()];

    for (auto & elem : neighborsOnInterface)
        if ((elem)->getAddress() == entry->getAddress())
            return false;


    EV_DETAIL << "Added new neighbor to table: " << entry->info() << "\n";
    entry->nt = this;
    neighborsOnInterface.push_back(entry);
    take(entry->getLivenessTimer());
    restartLivenessTimer(entry, holdTime);

    emit(NF_PIM_NEIGHBOR_ADDED, entry);

    return true;
}

bool inet::PIMNeighborTable::deleteNeighbor ( PIMNeighbor *  neighbor )

virtual

Deletes a neighbor from the table.

If the neighbor was not found in the table then it is untouched, otherwise deleted. Returns true if the neighbor object was deleted.

{
    Enter_Method_Silent();

    auto it = neighbors.find(neighbor->getInterfaceId());
    if (it != neighbors.end()) {
        PIMNeighborVector& neighborsOnInterface = it->second;
        auto it2 = find(neighborsOnInterface.begin(), neighborsOnInterface.end(), neighbor);
        if (it2 != neighborsOnInterface.end()) {
            neighborsOnInterface.erase(it2);

            emit(NF_PIM_NEIGHBOR_DELETED, neighbor);

            neighbor->nt = nullptr;
            cancelEvent(neighbor->getLivenessTimer());
            delete neighbor;

            return true;
        }
    }
    return false;
}

PIMNeighbor * inet::PIMNeighborTable::findNeighbor ( int  interfaceId, IPv4Address  addr  )

virtual

Returns the neighbor that is identified by the given (interfaceId,addr), or nullptr if no such neighbor.

Referenced by inet::PIMSM::addNewRouteG(), and inet::PIMSM::addNewRouteSG().

{
    auto neighborsOnInterface = neighbors.find(interfaceId);
    if (neighborsOnInterface != neighbors.end()) {
        for (auto & elem : neighborsOnInterface->second)
            if ((elem)->getAddress() == addr && (elem)->getInterfaceId() == interfaceId)
                return elem;

    }
    return nullptr;
}

PIMNeighbor * inet::PIMNeighborTable::getNeighbor ( int  interfaceId, int  index  )

virtual

Returns the neighbor on the given interface at the specified position.

Referenced by inet::PIMSM::addNewRouteG(), inet::PIMSM::addNewRouteSG(), and inet::PIMSM::updateDesignatedRouterAddress().

{
    auto it = neighbors.find(interfaceId);
    return it != neighbors.end() ? it->second.at(index) : nullptr;
}

int inet::PIMNeighborTable::getNumNeighbors ( int  interfaceId )

virtual

Returns the number of neighbors on the given interface.

Referenced by inet::PIMSM::addNewRouteG(), inet::PIMSM::addNewRouteSG(), inet::PIMSM::processPruneG(), inet::PIMSM::processPrunePendingTimer(), inet::PIMSM::processPruneSG(), and inet::PIMSM::updateDesignatedRouterAddress().

{
    auto it = neighbors.find(interfaceId);
    return it != neighbors.end() ? it->second.size() : 0;
}

void inet::PIMNeighborTable::handleMessage ( cMessage *  msg )

overrideprotectedvirtual

{
    // self message (timer)
    if (msg->isSelfMessage()) {
        if (msg->getKind() == NeighborLivenessTimer) {
            processLivenessTimer(msg);
        }
        else
            ASSERT(false);
    }
    else
        throw cRuntimeError("PIMNeighborTable received a message although it does not have gates.");
}

void inet::PIMNeighborTable::initialize ( int  stage )

overrideprotectedvirtual

{
    cSimpleModule::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        WATCH_MAP(neighbors);
    }
}

virtual int inet::PIMNeighborTable::numInitStages ( ) const

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::PIMNeighborTable::processLivenessTimer ( cMessage *  timer )

protectedvirtual

{
    EV << "PIMNeighborTable::processNLTimer\n";
    PIMNeighbor *neighbor = check_and_cast<PIMNeighbor *>((cObject *)livenessTimer->getContextPointer());
    IPv4Address neighborAddress = neighbor->getAddress();
    deleteNeighbor(neighbor);
    EV << "PIM::processNLTimer: Neighbor " << neighborAddress << "was removed from PIM neighbor table.\n";
}

void inet::PIMNeighborTable::restartLivenessTimer ( PIMNeighbor *  neighbor, double  holdTime  )

virtual

Restarts the Neighbor Liveness timer of the given neighbor.

When the timer expires, the neigbor is automatically deleted.

{
    Enter_Method_Silent();
    cancelEvent(neighbor->getLivenessTimer());
    scheduleAt(simTime() + holdTime, neighbor->getLivenessTimer());
}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const PIMNeighborVector &  v  )

friend

{
    for (unsigned int i = 0; i < v.size(); i++) {
        PIMNeighbor *e = v[i];
        os << "[" << i << "]: "
           << "{ If = " << e->getInterfacePtr()->getName() << "; Addr = " << e->getAddress() << "; Ver = " << e->getVersion()
           << "; GenID = " << e->getGenerationId() << "; Pr = " << e->getDRPriority() << "}; ";
    }
    return os;
};

Member Data Documentation

InterfaceToNeighborsMap inet::PIMNeighborTable::neighbors

protected

---

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

• PIMNeighborTable.h
• PIMNeighborTable.cc