inet::PIMSplitter Class Reference

PIMSplitter register itself for PIM protocol (103) in the network layer, and dispatches the received packets either to PIMDM or PIMSM according to the PIM mode of the incoming interface. More...

#include <PIMSplitter.h>

Inheritance diagram for inet::PIMSplitter:

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleMessage (cMessage *msg) override
virtual void	processPIMPacket (PIMPacket *pkt)

Private Attributes
IInterfaceTable *	ift = nullptr
PIMInterfaceTable *	pimIft = nullptr
cGate *	ipIn = nullptr
cGate *	ipOut = nullptr
cGate *	pimDMIn = nullptr
cGate *	pimDMOut = nullptr
cGate *	pimSMIn = nullptr
cGate *	pimSMOut = nullptr

Detailed Description

PIMSplitter register itself for PIM protocol (103) in the network layer, and dispatches the received packets either to PIMDM or PIMSM according to the PIM mode of the incoming interface.

Packets received from the PIM modules are simply forwarded to the network layer.

Member Function Documentation

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

overrideprotectedvirtual

{
    cGate *arrivalGate = msg->getArrivalGate();

    if (arrivalGate == ipIn) {
        PIMPacket *pimPacket = dynamic_cast<PIMPacket *>(msg);
        if (pimPacket) {
            processPIMPacket(pimPacket);
        }
        else if (dynamic_cast<ICMPMessage *>(msg)) {
            EV_WARN << "Received ICMP error, ignoring.\n";
            delete msg;
        }
        else
            throw cRuntimeError("PIMSplitter: received unknown packet '%s (%s)' from the network layer.", msg->getName(), msg->getClassName());
    }
    else if (arrivalGate == pimSMIn || arrivalGate == pimDMIn) {
        if (dynamic_cast<RegisterTransportProtocolCommand *>(msg)) {
            // Drop protocol registrations, splitter register PIM protocol itself
            delete msg;
        }
        else {
            // Send other packets to the network layer
            EV_INFO << "Received packet from PIM module, sending it to the network." << endl;
            send(msg, ipOut);
        }
    }
    else
        throw cRuntimeError("PIMSplitter: received packet on the unknown gate: %s.", arrivalGate ? arrivalGate->getBaseName() : "nullptr");
}

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

overrideprotectedvirtual

{
    cSimpleModule::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        ift = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
        pimIft = getModuleFromPar<PIMInterfaceTable>(par("pimInterfaceTableModule"), this);

        ipIn = gate("ipIn");
        ipOut = gate("ipOut");
        pimDMIn = gate("pimDMIn");
        pimDMOut = gate("pimDMOut");
        pimSMIn = gate("pimSMIn");
        pimSMOut = gate("pimSMOut");
    }
    else if (stage == INITSTAGE_TRANSPORT_LAYER) {
        IPSocket ipSocket(ipOut);
        ipSocket.registerProtocol(IP_PROT_PIM);
    }
}

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::PIMSplitter::processPIMPacket ( PIMPacket *  pkt )

protectedvirtual

{
    IPv4ControlInfo *ctrlInfo = check_and_cast<IPv4ControlInfo *>(pkt->getControlInfo());
    InterfaceEntry *ie = ift->getInterfaceById(ctrlInfo->getInterfaceId());
    ASSERT(ie);

    EV_INFO << "Received packet on interface '" << ie->getName() << "'" << endl;

    PIMInterface *pimInt = pimIft->getInterfaceById(ie->getInterfaceId());
    if (!pimInt) {
        EV_WARN << "PIM is not enabled on interface '" << ie->getName() << "', dropping packet." << endl;
        delete pkt;
        return;
    }

    switch (pimInt->getMode()) {
        case PIMInterface::DenseMode:
            EV_INFO << "Sending packet to PIMDM.\n";
            send(pkt, pimDMOut);
            break;

        case PIMInterface::SparseMode:
            EV_INFO << "Sending packet to PIMSM.\n";
            send(pkt, pimSMOut);
            break;

        default:
            throw cRuntimeError("PIMSplitter: PIM mode of interface '%s' is invalid.", ie->getName());
    }
}

Member Data Documentation

IInterfaceTable* inet::PIMSplitter::ift = nullptr

private

cGate* inet::PIMSplitter::ipIn = nullptr

private

cGate* inet::PIMSplitter::ipOut = nullptr

private

cGate* inet::PIMSplitter::pimDMIn = nullptr

private

cGate* inet::PIMSplitter::pimDMOut = nullptr

private

PIMInterfaceTable* inet::PIMSplitter::pimIft = nullptr

private

cGate* inet::PIMSplitter::pimSMIn = nullptr

private

cGate* inet::PIMSplitter::pimSMOut = nullptr

private

---

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

• PIMSplitter.h
• PIMSplitter.cc