inet::PIMNeighbor Class Reference

Class holding information about a neighboring PIM router. More...

#include <PIMNeighborTable.h>

Inheritance diagram for inet::PIMNeighbor:

Public Member Functions
	PIMNeighbor (InterfaceEntry *ie, IPv4Address address, int version)
virtual	~PIMNeighbor ()
virtual std::string	info () const override
int	getInterfaceId () const
InterfaceEntry *	getInterfacePtr () const
IPv4Address	getAddress () const
int	getVersion () const
unsigned int	getGenerationId () const
long	getDRPriority () const
cMessage *	getLivenessTimer () const
void	setGenerationId (unsigned int genId)
void	setDRPriority (long priority)

Protected Member Functions
void	changed ()

Protected Attributes
PIMNeighborTable *	nt
InterfaceEntry *	ie
IPv4Address	address
int	version
unsigned int	generationId
long	drPriority
cMessage *	livenessTimer

Friends
class	PIMNeighborTable

Detailed Description

Class holding information about a neighboring PIM router.

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

Currently only the version of the routers are stored. TODO add fields for options received in Hello Messages (RFC 3973 4.7.5, RFC 4601 4.9.2).

Constructor & Destructor Documentation

inet::PIMNeighbor::PIMNeighbor	(	InterfaceEntry *	ie,
		IPv4Address	address,
		int	version
	)

    : nt(nullptr), ie(ie), address(address), version(version), generationId(0), drPriority(-1L)
{
    ASSERT(ie);

    livenessTimer = new cMessage("NeighborLivenessTimer", PIMNeighborTable::NeighborLivenessTimer);
    livenessTimer->setContextPointer(this);
}

inet::PIMNeighbor::~PIMNeighbor ( )

virtual

{
    ASSERT(!livenessTimer->isScheduled());
    delete livenessTimer;
}

Member Function Documentation

void inet::PIMNeighbor::changed ( )

protected

{
    if (nt)
        nt->emit(NF_PIM_NEIGHBOR_CHANGED, this);
}

IPv4Address inet::PIMNeighbor::getAddress ( ) const

inline

Referenced by inet::PIMNeighborTable::addNeighbor(), inet::PIMSM::addNewRouteG(), inet::PIMSM::addNewRouteSG(), inet::operator<<(), inet::PIMNeighborTable::processLivenessTimer(), and inet::PIMSM::updateDesignatedRouterAddress().

{ return address; }

long inet::PIMNeighbor::getDRPriority ( ) const

inline

Referenced by inet::operator<<(), and inet::PIMSM::updateDesignatedRouterAddress().

{ return drPriority; }

unsigned int inet::PIMNeighbor::getGenerationId ( ) const

inline

Referenced by inet::operator<<().

{ return generationId; }

int inet::PIMNeighbor::getInterfaceId ( ) const

inline

Referenced by inet::PIMNeighborTable::addNeighbor(), inet::PIMNeighborTable::deleteNeighbor(), and inet::PIMNeighborTable::findNeighbor().

{ return ie->getInterfaceId(); }

InterfaceEntry* inet::PIMNeighbor::getInterfacePtr ( ) const

inline

Referenced by inet::operator<<(), and inet::PIMSM::receiveSignal().

{ return ie; }

cMessage* inet::PIMNeighbor::getLivenessTimer ( ) const

inline

Referenced by inet::PIMNeighborTable::addNeighbor(), inet::PIMNeighborTable::deleteNeighbor(), inet::PIMNeighborTable::restartLivenessTimer(), and inet::PIMNeighborTable::~PIMNeighborTable().

{ return livenessTimer; }

int inet::PIMNeighbor::getVersion ( ) const

inline

Referenced by inet::operator<<().

{ return version; }

std::string inet::PIMNeighbor::info ( ) const

overridevirtual

Referenced by inet::PIMNeighborTable::addNeighbor().

{
    std::stringstream out;
    out << "PIMNeighbor addr=" << address << ", iface=" << ie->getName() << ", v=" << version << ", priority=" << this->drPriority << "}";
    return out.str();
}

void inet::PIMNeighbor::setDRPriority ( long  priority )

inline

Referenced by inet::PIMBase::processHelloPacket().

{ if (drPriority != priority) { drPriority = priority; changed(); } }

void inet::PIMNeighbor::setGenerationId ( unsigned int  genId )

inline

Referenced by inet::PIMBase::processHelloPacket().

{ if (generationId != genId) { generationId = genId; changed(); } }

Friends And Related Function Documentation

friend class PIMNeighborTable

friend

Member Data Documentation

IPv4Address inet::PIMNeighbor::address

protected

Referenced by info().

long inet::PIMNeighbor::drPriority

protected

Referenced by info().

unsigned int inet::PIMNeighbor::generationId

protected

InterfaceEntry* inet::PIMNeighbor::ie

protected

Referenced by info().

cMessage* inet::PIMNeighbor::livenessTimer

protected

Referenced by PIMNeighbor(), and ~PIMNeighbor().

PIMNeighborTable* inet::PIMNeighbor::nt

protected

Referenced by inet::PIMNeighborTable::addNeighbor(), changed(), and inet::PIMNeighborTable::deleteNeighbor().

int inet::PIMNeighbor::version

protected

Referenced by info().

---

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

• PIMNeighborTable.h
• PIMNeighborTable.cc