inet::IPv4NodeConfigurator Class Reference

This module provides the static configuration for the IPv4RoutingTable and the IPv4 network interfaces of a particular node in the network. More...

#include <IPv4NodeConfigurator.h>

Inheritance diagram for inet::IPv4NodeConfigurator:

Public Member Functions
	IPv4NodeConfigurator ()
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Member Functions
virtual int	numInitStages () const override
virtual void	handleMessage (cMessage *msg) override
virtual void	initialize (int stage) override
virtual bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
virtual void	prepareNode ()
virtual void	prepareInterface (InterfaceEntry *interfaceEntry)
virtual void	configureInterface ()
virtual void	configureRoutingTable ()

Protected Attributes
NodeStatus *	nodeStatus
IInterfaceTable *	interfaceTable
IIPv4RoutingTable *	routingTable
IPv4NetworkConfigurator *	networkConfigurator

Detailed Description

This module provides the static configuration for the IPv4RoutingTable and the IPv4 network interfaces of a particular node in the network.

For more info please see the NED file.

Constructor & Destructor Documentation

inet::IPv4NodeConfigurator::IPv4NodeConfigurator

(

)

{
    nodeStatus = nullptr;
    interfaceTable = nullptr;
    routingTable = nullptr;
    networkConfigurator = nullptr;
}

Member Function Documentation

void inet::IPv4NodeConfigurator::configureInterface ( )

protectedvirtual

Referenced by handleOperationStage(), and initialize().

{
    ASSERT(networkConfigurator);
    for (int i = 0; i < interfaceTable->getNumInterfaces(); i++)
        networkConfigurator->configureInterface(interfaceTable->getInterface(i));
}

void inet::IPv4NodeConfigurator::configureRoutingTable ( )

protectedvirtual

Referenced by handleOperationStage(), and initialize().

{
    ASSERT(networkConfigurator);
    if (par("configureRoutingTable").boolValue())
        networkConfigurator->configureRoutingTable(routingTable);
}

virtual void inet::IPv4NodeConfigurator::handleMessage ( cMessage *  msg )

inlineoverrideprotectedvirtual

{ throw cRuntimeError("this module doesn't handle messages, it runs only in initialize()"); }

bool inet::IPv4NodeConfigurator::handleOperationStage ( LifecycleOperation *  operation, int  stage, IDoneCallback *  doneCallback  )

overrideprotectedvirtual

Perform one stage of a lifecycle operation.

Processing may be done entirely within this method, or may be a longer process that involves nonzero simulation time or several events, and is triggered by this method call.

Return value: true = "done"; false = "not yet done, will invoke doneCallback when done"

Implements inet::ILifecycle.

{
    Enter_Method_Silent();
    if (dynamic_cast<NodeStartOperation *>(operation)) {
        if ((NodeStartOperation::Stage)stage == NodeStartOperation::STAGE_LINK_LAYER)
            prepareNode();
        else if ((NodeStartOperation::Stage)stage == NodeStartOperation::STAGE_NETWORK_LAYER && networkConfigurator) {
            configureInterface();
            configureRoutingTable();
        }
    }
    else if (dynamic_cast<NodeShutdownOperation *>(operation)) {    /*nothing to do*/
        ;
    }
    else if (dynamic_cast<NodeCrashOperation *>(operation)) {    /*nothing to do*/
        ;
    }
    else
        throw cRuntimeError("Unsupported lifecycle operation '%s'", operation->getClassName());
    return true;
}

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

overrideprotectedvirtual

{
    cSimpleModule::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        cModule *node = getContainingNode(this);
        if (!node)
            throw cRuntimeError("The container @networkNode module not found");
        const char *networkConfiguratorPath = par("networkConfiguratorModule");
        nodeStatus = dynamic_cast<NodeStatus *>(node->getSubmodule("status"));
        interfaceTable = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
        routingTable = L3AddressResolver().findIPv4RoutingTableOf(node);

        if (!networkConfiguratorPath[0])
            networkConfigurator = nullptr;
        else {
            cModule *module = getModuleByPath(networkConfiguratorPath);
            if (!module)
                throw cRuntimeError("Configurator module '%s' not found (check the 'networkConfiguratorModule' parameter)", networkConfiguratorPath);
            networkConfigurator = check_and_cast<IPv4NetworkConfigurator *>(module);
        }
    }
    else if (stage == INITSTAGE_NETWORK_LAYER) {
        if (!nodeStatus || nodeStatus->getState() == NodeStatus::UP)
            prepareNode();
    }
    else if (stage == INITSTAGE_NETWORK_LAYER_2) {
        if ((!nodeStatus || nodeStatus->getState() == NodeStatus::UP) && networkConfigurator)
            configureInterface();
    }
    else if (stage == INITSTAGE_NETWORK_LAYER_3) {
        if ((!nodeStatus || nodeStatus->getState() == NodeStatus::UP) && networkConfigurator)
            configureRoutingTable();
    }
}

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::IPv4NodeConfigurator::prepareInterface ( InterfaceEntry *  interfaceEntry )

protectedvirtual

Referenced by prepareNode().

{
    ASSERT(!interfaceEntry->ipv4Data());
    IPv4InterfaceData *interfaceData = new IPv4InterfaceData();
    interfaceEntry->setIPv4Data(interfaceData);
    if (interfaceEntry->isLoopback()) {
        // we may reconfigure later it to be the routerId
        interfaceData->setIPAddress(IPv4Address::LOOPBACK_ADDRESS);
        interfaceData->setNetmask(IPv4Address::LOOPBACK_NETMASK);
        interfaceData->setMetric(1);
    }
    else {
        // metric: some hints: OSPF cost (2e9/bps value), MS KB article Q299540, ...
        interfaceData->setMetric((int)ceil(2e9 / interfaceEntry->getDatarate()));    // use OSPF cost as default
        if (interfaceEntry->isMulticast()) {
            interfaceData->joinMulticastGroup(IPv4Address::ALL_HOSTS_MCAST);
            if (routingTable->isForwardingEnabled())
                interfaceData->joinMulticastGroup(IPv4Address::ALL_ROUTERS_MCAST);
        }
    }
}

void inet::IPv4NodeConfigurator::prepareNode ( )

protectedvirtual

Referenced by handleOperationStage(), and initialize().

{
    for (int i = 0; i < interfaceTable->getNumInterfaces(); i++)
        prepareInterface(interfaceTable->getInterface(i));
}

Member Data Documentation

IInterfaceTable* inet::IPv4NodeConfigurator::interfaceTable

protected

Referenced by configureInterface(), initialize(), IPv4NodeConfigurator(), and prepareNode().

IPv4NetworkConfigurator* inet::IPv4NodeConfigurator::networkConfigurator

protected

Referenced by configureInterface(), configureRoutingTable(), handleOperationStage(), initialize(), and IPv4NodeConfigurator().

NodeStatus* inet::IPv4NodeConfigurator::nodeStatus

protected

Referenced by initialize(), and IPv4NodeConfigurator().

IIPv4RoutingTable* inet::IPv4NodeConfigurator::routingTable

protected

Referenced by configureRoutingTable(), initialize(), IPv4NodeConfigurator(), and prepareInterface().

---

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

• IPv4NodeConfigurator.h
• IPv4NodeConfigurator.cc