inet::PIMInterfaceTable Class Reference

PIMInterfaceTable contains an PIMInterface entry for each interface on which PIM is enabled. More...

#include <PIMInterfaceTable.h>

Inheritance diagram for inet::PIMInterfaceTable:

Public Member Functions
virtual	~PIMInterfaceTable ()
virtual int	getNumInterfaces ()
virtual PIMInterface *	getInterface (int k)
virtual PIMInterface *	getInterfaceById (int interfaceId)

Protected Types
typedef std::vector< PIMInterface * >	PIMInterfaceVector

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleMessage (cMessage *) override
virtual void	receiveSignal (cComponent *source, simsignal_t signalID, cObject *obj, cObject *details) override
virtual void	configureInterfaces (cXMLElement *config)
virtual PIMInterface *	createInterface (InterfaceEntry *ie, cXMLElement *config)
virtual PIMInterfaceVector::iterator	findInterface (InterfaceEntry *ie)
virtual void	addInterface (InterfaceEntry *ie)
virtual void	removeInterface (InterfaceEntry *ie)

Protected Attributes
PIMInterfaceVector	pimInterfaces

Detailed Description

PIMInterfaceTable contains an PIMInterface entry for each interface on which PIM is enabled.

When interfaces are added to/deleted from the InterfaceTable, then the corresponding PIMInterface entry is added/deleted automatically.

Member Typedef Documentation

typedef std::vector<PIMInterface *> inet::PIMInterfaceTable::PIMInterfaceVector

protected

Constructor & Destructor Documentation

inet::PIMInterfaceTable::~PIMInterfaceTable ( )

virtual

{
    for (auto & elem : pimInterfaces)
        delete elem;
}

Member Function Documentation

void inet::PIMInterfaceTable::addInterface ( InterfaceEntry *  ie )

protectedvirtual

{
    ASSERT(findInterface(ie) == pimInterfaces.end());

    cXMLElement *config = par("pimConfig").xmlValue();
    cXMLElementList interfaceElements = config->getChildrenByTagName("interface");
    InterfaceMatcher matcher(interfaceElements);

    int i = matcher.findMatchingSelector(ie);
    if (i >= 0) {
        PIMInterface *pimInterface = createInterface(ie, interfaceElements[i]);
        if (pimInterface)
            pimInterfaces.push_back(pimInterface);
    }
}

void inet::PIMInterfaceTable::configureInterfaces ( cXMLElement *  config )

protectedvirtual

{
    cXMLElementList interfaceElements = config->getChildrenByTagName("interface");
    InterfaceMatcher matcher(interfaceElements);
    IInterfaceTable *ift = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);

    for (int k = 0; k < ift->getNumInterfaces(); ++k) {
        InterfaceEntry *ie = ift->getInterface(k);
        if (ie->isMulticast() && !ie->isLoopback()) {
            int i = matcher.findMatchingSelector(ie);
            if (i >= 0) {
                PIMInterface *pimInterface = createInterface(ie, interfaceElements[i]);
                if (pimInterface)
                    pimInterfaces.push_back(pimInterface);
            }
        }
    }
}

PIMInterface * inet::PIMInterfaceTable::createInterface ( InterfaceEntry *  ie, cXMLElement *  config  )

protectedvirtual

{
    const char *modeAttr = config->getAttribute("mode");
    if (!modeAttr)
        return nullptr;

    PIMInterface::PIMMode mode;
    if (strcmp(modeAttr, "dense") == 0)
        mode = PIMInterface::DenseMode;
    else if (strcmp(modeAttr, "sparse") == 0)
        mode = PIMInterface::SparseMode;
    else
        throw cRuntimeError("PIMInterfaceTable: invalid 'mode' attribute value in the configuration of interface '%s'", ie->getName());

    const char *stateRefreshAttr = config->getAttribute("state-refresh");
    bool stateRefreshFlag = stateRefreshAttr && !strcmp(stateRefreshAttr, "true");

    return new PIMInterface(ie, mode, stateRefreshFlag);
}

PIMInterfaceTable::PIMInterfaceVector::iterator inet::PIMInterfaceTable::findInterface ( InterfaceEntry *  ie )

protectedvirtual

{
    for (auto it = pimInterfaces.begin(); it != pimInterfaces.end(); ++it)
        if ((*it)->getInterfacePtr() == ie)
            return it;

    return pimInterfaces.end();
}

virtual PIMInterface* inet::PIMInterfaceTable::getInterface ( int  k )

inlinevirtual

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

{ return pimInterfaces[k]; }

PIMInterface * inet::PIMInterfaceTable::getInterfaceById ( int  interfaceId )

virtual

Referenced by inet::PIMSM::getIncomingInterface(), inet::PIMSM::IamDR(), inet::PIMSM::receiveSignal(), inet::PIMSM::unroutableMulticastPacketArrived(), and inet::PIMSM::updateDesignatedRouterAddress().

{
    for (int i = 0; i < getNumInterfaces(); i++)
        if (interfaceId == getInterface(i)->getInterfaceId())
            return getInterface(i);

    return nullptr;
}

virtual int inet::PIMInterfaceTable::getNumInterfaces ( )

inlinevirtual

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

{ return pimInterfaces.size(); }

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

overrideprotectedvirtual

{
    throw cRuntimeError("This module doesn't process messages");
}

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

overrideprotectedvirtual

{
    cSimpleModule::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        WATCH_VECTOR(pimInterfaces);
    }
    else if (stage == INITSTAGE_LINK_LAYER_2) {
        configureInterfaces(par("pimConfig").xmlValue());

        cModule *host = findContainingNode(this);
        if (!host)
            throw cRuntimeError("PIMInterfaceTable: containing node not found.");
        host->subscribe(NF_INTERFACE_CREATED, this);
        host->subscribe(NF_INTERFACE_DELETED, this);
    }
}

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::PIMInterfaceTable::receiveSignal ( cComponent *  source, simsignal_t  signalID, cObject *  obj, cObject *  details  )

overrideprotectedvirtual

{
    Enter_Method_Silent();
    printNotificationBanner(signalID, obj);

    if (signalID == NF_INTERFACE_CREATED) {
        InterfaceEntry *ie = check_and_cast<InterfaceEntry *>(obj);
        if (ie->isMulticast() && !ie->isLoopback())
            addInterface(ie);
    }
    else if (signalID == NF_INTERFACE_DELETED) {
        InterfaceEntry *ie = check_and_cast<InterfaceEntry *>(obj);
        if (ie->isMulticast() && !ie->isLoopback())
            removeInterface(ie);
    }
}

void inet::PIMInterfaceTable::removeInterface ( InterfaceEntry *  ie )

protectedvirtual

{
    auto it = findInterface(ie);
    if (it != pimInterfaces.end())
        pimInterfaces.erase(it);
}

Member Data Documentation

PIMInterfaceVector inet::PIMInterfaceTable::pimInterfaces

protected

---

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

• PIMInterfaceTable.h
• PIMInterfaceTable.cc