inet::NetworkInfo Class Reference

TODO documentation. More...

#include <NetworkInfo.h>

Inheritance diagram for inet::NetworkInfo:

Protected Member Functions
virtual void	initialize () override
virtual void	handleMessage (cMessage *msg) override
virtual void	processCommand (const cXMLElement &node) override
	Called by ScenarioManager whenever a script command needs to be carried out by the module. More...
virtual void	dumpRoutingInfo (cModule *target, const char *filename, bool append, bool compat)

Additional Inherited Members
Public Member Functions inherited from inet::IScriptable
virtual	~IScriptable ()

Detailed Description

TODO documentation.

Member Function Documentation

void inet::NetworkInfo::dumpRoutingInfo ( cModule *  target, const char *  filename, bool  append, bool  compat  )

protectedvirtual

Referenced by processCommand().

{
    std::ofstream s;
    s.open(filename, append ? (std::ios::app) : (std::ios::out));
    if (s.fail())
        throw cRuntimeError("cannot open `%s' for write", filename);

    if (compat)
        s << "Kernel IPv4 routing table" << endl;
    s << "Destination     Gateway         Genmask         ";
    if (compat)
        s << "Flags ";
    s << "Metric ";
    if (compat)
        s << "Ref    Use ";
    s << "Iface" << endl;

    cModule *rtmod = target->getSubmodule("routingTable");
    if (rtmod) {
        std::vector<std::string> lines;

        IIPv4RoutingTable *rt = check_and_cast<IIPv4RoutingTable *>(rtmod);
        for (int i = 0; i < rt->getNumRoutes(); i++) {
            IPv4Address dest = rt->getRoute(i)->getDestination();

            if (dest.isMulticast())
                continue;

            if (rt->getRoute(i)->getInterface()->isLoopback())
                continue;

            IPv4Address netmask = rt->getRoute(i)->getNetmask();
            IPv4Address gateway = rt->getRoute(i)->getGateway();
            int metric = rt->getRoute(i)->getMetric();

            std::ostringstream line;

            line << std::left;
            IPv4Address prefix = compat ? dest.doAnd(netmask) : dest;    // typically dest in routes is already masked, so this is a no-op
            line.width(16);
            if (prefix.isUnspecified())
                line << "0.0.0.0";
            else
                line << prefix;

            line.width(16);
            if (gateway.isUnspecified())
                line << "0.0.0.0";
            else
                line << gateway;

            line.width(16);
            if (netmask.isUnspecified())
                line << "0.0.0.0";
            else
                line << netmask;

            if (compat) {
                int pad = 3;
                line << "U";    // routes in INET are always up
                if (!gateway.isUnspecified())
                    line << "G";
                else
                    ++pad;
                if (netmask.equals(IPv4Address::ALLONES_ADDRESS))
                    line << "H";
                else
                    ++pad;
                line.width(pad);
                line << " ";
            }

            line.width(7);
            if (compat && rt->getRoute(i)->getSourceType() == IRoute::IFACENETMASK)
                metric = 0;
            line << metric;

            if (compat)
                line << "0        0 ";

            line << rt->getRoute(i)->getInterfaceName() << endl;

            if (compat)
                lines.push_back(line.str());
            else
                s << line.str();
        }

        if (compat) {
            // sort to avoid random order
            // typically routing tables are sorted by netmask prefix length (descending)
            // sorting by reversed natural order looks weired, but allows easy comparison
            // with `route -n | sort -r` output by means of `diff` command...
            std::stable_sort(lines.begin(), lines.end());
            for (std::vector<std::string>::reverse_iterator it = lines.rbegin(); it != lines.rend(); it++)
                s << *it;
        }
    }
    s << endl;
    s.close();
}

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

overrideprotectedvirtual

{
    ASSERT(false);
}

void inet::NetworkInfo::initialize ( )

overrideprotectedvirtual

{
    // so far no initialization
}

void inet::NetworkInfo::processCommand ( const cXMLElement &  node )

overrideprotectedvirtual

Called by ScenarioManager whenever a script command needs to be carried out by the module.

The command is represented by the XML element or element tree. The command name can be obtained as:

const char *command = node->getTagName()

Parameters are XML attributes, e.g. a "neighbour" parameter can be retrieved as:

const char *attr = node->getAttribute("neighbour")

More complex input can be passed in child elements.

See also

cXMLElement

Implements inet::IScriptable.

{
    cModule *target = getModuleByPath(node.getAttribute("target"));

    if (!strcmp(node.getTagName(), "routing")) {
        const char *filename = node.getAttribute("file");
        ASSERT(filename);
        const char *mode = node.getAttribute("mode");
        const char *compat = node.getAttribute("compat");

        dumpRoutingInfo(target, filename, (mode && !strcmp(mode, "a")), (compat && !strcmp(compat, "linux")));
    }
    else
        ASSERT(false);
}

---

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

• NetworkInfo.h
• NetworkInfo.cc