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 (Packet *pkt)

Private Attributes
ModuleRefByPar< IInterfaceTable >	ift

ModuleRefByPar< PimInterfaceTable >	pimIft

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

◆ handleMessage()

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

overrideprotectedvirtual

 {
     cGate *arrivalGate = msg->getArrivalGate();
  
     if (arrivalGate == ipIn) {
         Packet *packet = check_and_cast<Packet *>(msg);
         auto protocol = packet->getTag<PacketProtocolTag>()->getProtocol();
         if (protocol == &Protocol::icmpv4) {
             EV_WARN << "Received ICMP error " << msg->getName() << ", ignored\n";
             delete msg;
         }
         else if (protocol == &Protocol::pim) {
             processPIMPacket(packet);
         }
         else
             throw cRuntimeError("PimSplitter: received unknown packet '%s (%s)' from the network layer.", msg->getName(), msg->getClassName());
     }
     else if (arrivalGate == pimSMIn || arrivalGate == pimDMIn) {
         // Send other packets to the network layer
         EV_INFO << "Received packet from PIM module, sending it to the network." << endl;
         check_and_cast<Packet *>(msg)->addTagIfAbsent<DispatchProtocolReq>()->setProtocol(&Protocol::ipv4);
         send(msg, ipOut);
     }
     else
         throw cRuntimeError("PimSplitter: received packet on the unknown gate: %s.", arrivalGate ? arrivalGate->getBaseName() : "nullptr");
 }

◆ initialize()

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

overrideprotectedvirtual

 {
     cSimpleModule::initialize(stage);
  
     if (stage == INITSTAGE_LOCAL) {
         ift.reference(this, "interfaceTableModule", true);
         pimIft.reference(this, "pimInterfaceTableModule", true);
  
         ipIn = gate("ipIn");
         ipOut = gate("ipOut");
         pimDMIn = gate("pimDMIn");
         pimDMOut = gate("pimDMOut");
         pimSMIn = gate("pimSMIn");
         pimSMOut = gate("pimSMOut");
     }
 }

◆ numInitStages()

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

inlineoverrideprotectedvirtual

42 { return NUM_INIT_STAGES; }

◆ processPIMPacket()

void inet::PimSplitter::processPIMPacket ( Packet * pkt )

protectedvirtual

 {
     const auto& pimPkt = pkt->peekAtFront<PimPacket>();
     (void)pimPkt; // unused variable
     NetworkInterface *ie = ift->getInterfaceById(pkt->getTag<InterfaceInd>()->getInterfaceId());
     ASSERT(ie);
  
     EV_INFO << "Received packet on interface '" << ie->getInterfaceName() << "'" << endl;
  
     PimInterface *pimInt = pimIft->getInterfaceById(ie->getInterfaceId());
     if (!pimInt) {
         EV_WARN << "PIM is not enabled on interface '" << ie->getInterfaceName() << "', 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->getInterfaceName());
     }
 }