inet::L3AddressResolver Class Reference

Utility class for finding IPv4 or IPv6 address of a host or router. More...

#include <L3AddressResolver.h>

Inheritance diagram for inet::L3AddressResolver:

Public Types
enum	{   ADDR_IPv4 = 1, ADDR_IPv6 = 2, ADDR_MAC = 4, ADDR_MODULEPATH = 8,   ADDR_MODULEID = 16, ADDR_MASK = 32 }

Public Member Functions
	L3AddressResolver ()
virtual	~L3AddressResolver ()
virtual L3Address	resolve (const char *str, int addrType=DEFAULT_ADDR_TYPE)
	Accepts dotted decimal notation ("127.0.0.1"), module name of the host or router ("host[2]"), and empty string (""). More...
virtual std::vector< L3Address >	resolve (std::vector< std::string > strs, int addrType=DEFAULT_ADDR_TYPE)
	Utility function: Calls resolve() for each item in the string vector, and returns the result in an address vector. More...
virtual bool	tryResolve (const char *str, L3Address &result, int addrType=DEFAULT_ADDR_TYPE)
	Similar to resolve(), but returns false (instead of throwing an error) if the address cannot be resolved because the given host (or interface) doesn't have an address assigned yet. More...
Utility functions supporting resolve()
virtual L3Address	addressOf (cModule *host, int addrType=DEFAULT_ADDR_TYPE)
	Returns IPv4 or IPv6 address of the given host or router. More...
virtual L3Address	addressOf (cModule *host, const char *ifname, int addrType=DEFAULT_ADDR_TYPE)
	Similar to addressOf(), but only looks at the given interface. More...
virtual L3Address	addressOf (cModule *host, cModule *destmod, int addrType=DEFAULT_ADDR_TYPE)
	Returns IPv4 or IPv6 address of the given host or router. More...
virtual L3Address	routerIdOf (cModule *host)
	Returns the router Id of the given router. More...
virtual L3Address	getAddressFrom (IInterfaceTable *ift, int addrType=DEFAULT_ADDR_TYPE)
	Returns the IPv4 or IPv6 address of the given host or router, given its IInterfaceTable module. More...
virtual L3Address	getAddressFrom (InterfaceEntry *ie, int addrType=DEFAULT_ADDR_TYPE)
	Returns the IPv4 or IPv6 address of the given interface (of a host or router). More...
virtual IInterfaceTable *	interfaceTableOf (cModule *host)
	The function tries to look up the IInterfaceTable module as submodule "interfaceTable" or "networkLayer.interfaceTable" within the host/router module. More...
virtual IIPv4RoutingTable *	routingTableOf (cModule *host)
	The function tries to look up the IIPv4RoutingTable module as submodule "routingTable" or "networkLayer.routingTable" within the host/router module. More...
virtual IPv6RoutingTable *	routingTable6Of (cModule *host)
	The function tries to look up the IPv6RoutingTable module as submodule "routingTable6" or "networkLayer.routingTable6" within the host/router module. More...
virtual IInterfaceTable *	findInterfaceTableOf (cModule *host)
	Like interfaceTableOf(), but doesn't throw error if not found. More...
virtual IIPv4RoutingTable *	findIPv4RoutingTableOf (cModule *host)
	Like routingTableOf(), but doesn't throw error if not found. More...
virtual IPv6RoutingTable *	findIPv6RoutingTableOf (cModule *host)
	Like interfaceTableOf(), but doesn't throw error if not found. More...
virtual GenericRoutingTable *	findGenericRoutingTableOf (cModule *host)
	Like interfaceTableOf(), but doesn't throw error if not found. More...
virtual cModule *	findHostWithAddress (const L3Address &addr)
	Find the Host with the specified address. More...

Protected Member Functions
virtual bool	getIPv4AddressFrom (L3Address &retAddr, IInterfaceTable *ift, bool netmask)
virtual bool	getIPv6AddressFrom (L3Address &retAddr, IInterfaceTable *ift, bool netmask)
virtual bool	getMACAddressFrom (L3Address &retAddr, IInterfaceTable *ift, bool netmask)
virtual bool	getModulePathAddressFrom (L3Address &retAddr, IInterfaceTable *ift, bool netmask)
virtual bool	getModuleIdAddressFrom (L3Address &retAddr, IInterfaceTable *ift, bool netmask)
virtual bool	getInterfaceIPv4Address (L3Address &ret, InterfaceEntry *ie, bool mask)
virtual bool	getInterfaceIPv6Address (L3Address &ret, InterfaceEntry *ie, bool mask)
virtual bool	getInterfaceMACAddress (L3Address &ret, InterfaceEntry *ie, bool mask)
virtual bool	getInterfaceModulePathAddress (L3Address &ret, InterfaceEntry *ie, bool mask)
virtual bool	getInterfaceModuleIdAddress (L3Address &ret, InterfaceEntry *ie, bool mask)

Detailed Description

Utility class for finding IPv4 or IPv6 address of a host or router.

Syntax variations understood:

• literal IPv4 address: "186.54.66.2"
• literal IPv6 address: "3011:7cd6:750b:5fd6:aba3:c231:e9f9:6a43"
• module name: "server", "subnet.server[3]"
• interface of a host or router: "server%eth0", "subnet.server[3]%eth0"
• IPv4 or IPv6 address of a host or router: "server(ipv4)", "subnet.server[3](ipv6)"
• IPv4 or IPv6 address of an interface of a host or router: "server%eth0(ipv4)", "subnet.server[3]%eth0(ipv6)"
• routerId: "router1%routerId", "R1%routerId"
• interface of a host or router toward defined another node: "client1>router"

Member Enumeration Documentation

anonymous enum

Enumerator
ADDR_IPv4
ADDR_IPv6
ADDR_MAC
ADDR_MODULEPATH
ADDR_MODULEID
ADDR_MASK

         {
        ADDR_IPv4 = 1,
        ADDR_IPv6 = 2,
        ADDR_MAC = 4,
        ADDR_MODULEPATH = 8,
        ADDR_MODULEID = 16,
        ADDR_MASK = 32
    };

Constructor & Destructor Documentation

inet::L3AddressResolver::L3AddressResolver ( )

inline

Referenced by findHostWithAddress(), inet::GenericNetworkConfigurator::findRoutingTable(), and inet::IPv4NetworkConfigurator::findRoutingTable().

{}

virtual inet::L3AddressResolver::~L3AddressResolver ( )

inlinevirtual

{}

Member Function Documentation

L3Address inet::L3AddressResolver::addressOf ( cModule *  host, int  addrType = DEFAULT_ADDR_TYPE  )

virtual

Returns IPv4 or IPv6 address of the given host or router.

This function uses routingTableOf() to find the IIPv4RoutingTable module, then invokes getAddressFrom() to extract the IP address.

Referenced by tryResolve().

{
    IInterfaceTable *ift = interfaceTableOf(host);
    return getAddressFrom(ift, addrType);
}

L3Address inet::L3AddressResolver::addressOf ( cModule *  host, const char *  ifname, int  addrType = DEFAULT_ADDR_TYPE  )

virtual

Similar to addressOf(), but only looks at the given interface.

{
    IInterfaceTable *ift = interfaceTableOf(host);
    InterfaceEntry *ie = ift->getInterfaceByName(ifname);
    if (ie)
        return getAddressFrom(ie, addrType);

    throw cRuntimeError("L3AddressResolver: no interface called `%s' in interface table of `%s'", ifname, host->getFullPath().c_str());
}

L3Address inet::L3AddressResolver::addressOf ( cModule *  host, cModule *  destmod, int  addrType = DEFAULT_ADDR_TYPE  )

virtual

Returns IPv4 or IPv6 address of the given host or router.

This function find an interface of host connected to destmod then invokes getAddressFrom() to extract the IP address.

{
    IInterfaceTable *ift = interfaceTableOf(host);
    for (int i = 0; i < ift->getNumInterfaces(); i++) {
        InterfaceEntry *ie = ift->getInterface(i);
        if (ie) {
            int gateId = ie->getNodeOutputGateId();
            if (gateId != -1)
                if (host->gate(gateId)->pathContains(destmod))
                    return getAddressFrom(ie, addrType);

        }
    }
    throw cRuntimeError("L3AddressResolver: no interface connected to `%s' module in interface table of `%s'", destmod->getFullPath().c_str(), host->getFullPath().c_str());
}

GenericRoutingTable * inet::L3AddressResolver::findGenericRoutingTableOf ( cModule *  host )

virtual

Like interfaceTableOf(), but doesn't throw error if not found.

{
#ifdef WITH_GENERIC
    // KLUDGE: TODO: look deeper temporarily
    GenericRoutingTable *rt = dynamic_cast<GenericRoutingTable *>(host->getSubmodule("routingTable"));
    if (!rt)
        rt = dynamic_cast<GenericRoutingTable *>(host->getModuleByPath(".routingTable.generic"));
    return rt;
#else // ifdef WITH_GENERIC
    return nullptr;
#endif // ifdef WITH_GENERIC
}

cModule * inet::L3AddressResolver::findHostWithAddress ( const L3Address &  addr )

virtual

Find the Host with the specified address.

Referenced by inet::visualizer::RoutingTableVisualizerBase::addRouteVisualizations(), and inet::visualizer::TransportConnectionVisualizerBase::receiveSignal().

{
    if (add.isUnspecified() || add.isMulticast())
        return nullptr;

    cTopology topo("topo");
    topo.extractByProperty("networkNode");

    // fill in isIPNode, ift and rt members in nodeInfo[]

    for (int i = 0; i < topo.getNumNodes(); i++) {
        cModule *mod = topo.getNode(i)->getModule();
        IInterfaceTable *itable = L3AddressResolver().findInterfaceTableOf(mod);
        if (itable != nullptr) {
            for (int i = 0; i < itable->getNumInterfaces(); i++) {
                InterfaceEntry *entry = itable->getInterface(i);
                switch (add.getType()) {
#ifdef WITH_IPv6
                    case L3Address::IPv6:
                        if (entry->ipv6Data()->hasAddress(add.toIPv6()))
                            return mod;
                        break;

#endif // ifdef WITH_IPv6
#ifdef WITH_IPv4
                    case L3Address::IPv4:
                        if (entry->ipv4Data() && entry->ipv4Data()->getIPAddress() == add.toIPv4())
                            return mod;
                        break;

#endif // ifdef WITH_IPv4
                    default:
                        (void)entry;    // eliminate warning: unused variable 'entry'
                        throw cRuntimeError("findHostWithAddress() doesn't accept AddressType '%s', yet", L3Address::getTypeName(add.getType()));
                        break;
                }
            }
        }
    }
    return nullptr;
}

IInterfaceTable * inet::L3AddressResolver::findInterfaceTableOf ( cModule *  host )

virtual

Like interfaceTableOf(), but doesn't throw error if not found.

Referenced by inet::visualizer::InterfaceTableVisualizerBase::addAllInterfaceVisualizations(), inet::FlatNetworkConfigurator::extractTopology(), inet::NetworkConfiguratorBase::findInterfaceTable(), inet::InterfaceMatcher::findMatchingSelector(), inet::visualizer::LinkBreakVisualizerBase::findNode(), inet::visualizer::RoutingTableVisualizerBase::getDestinations(), inet::visualizer::VisualizerBase::getInterfaceEntry(), inet::visualizer::InterfaceTableCanvasVisualizer::getInterfaceEntry(), inet::TED::initializeTED(), inet::FlatNetworkConfigurator6::isIPNode(), inet::GenericARP::mapUnicastAddress(), inet::visualizer::MediumVisualizerBase::matchesTransmission(), inet::visualizer::Ieee80211VisualizerBase::receiveSignal(), and inet::ModulePathAddress::tryParse().

{
    return dynamic_cast<IInterfaceTable *>(host->getSubmodule("interfaceTable"));
}

IIPv4RoutingTable * inet::L3AddressResolver::findIPv4RoutingTableOf ( cModule *  host )

virtual

Like routingTableOf(), but doesn't throw error if not found.

Referenced by inet::FlatNetworkConfigurator::extractTopology(), inet::IPv4NodeConfigurator::initialize(), inet::TED::initializeTED(), routingTableOf(), and inet::visualizer::RoutingTableVisualizerBase::updateAllRouteVisualizations().

{
#ifdef WITH_IPv4
    // KLUDGE: TODO: look deeper temporarily
    IIPv4RoutingTable *rt = dynamic_cast<IIPv4RoutingTable *>(host->getSubmodule("routingTable"));
    if (!rt)
        rt = dynamic_cast<IIPv4RoutingTable *>(host->getModuleByPath(".routingTable.ipv4"));
    return rt;
#else // ifdef WITH_IPv4
    return nullptr;
#endif // ifdef WITH_IPv4
}

IPv6RoutingTable * inet::L3AddressResolver::findIPv6RoutingTableOf ( cModule *  host )

virtual

Like interfaceTableOf(), but doesn't throw error if not found.

Referenced by inet::FlatNetworkConfigurator6::addOwnAdvPrefixRoutes(), inet::FlatNetworkConfigurator6::addStaticRoutes(), inet::FlatNetworkConfigurator6::configureAdvPrefixes(), inet::FlatNetworkConfigurator6::isIPNode(), and routingTable6Of().

{
#ifdef WITH_IPv6
    // KLUDGE: TODO: look deeper temporarily
    IPv6RoutingTable *rt = dynamic_cast<IPv6RoutingTable *>(host->getSubmodule("routingTable"));
    if (!rt)
        rt = dynamic_cast<IPv6RoutingTable *>(host->getModuleByPath(".routingTable.ipv6"));
    return rt;
#else // ifdef WITH_IPv6
    return nullptr;
#endif // ifdef WITH_IPv6
}

L3Address inet::L3AddressResolver::getAddressFrom ( IInterfaceTable *  ift, int  addrType = DEFAULT_ADDR_TYPE  )

virtual

Returns the IPv4 or IPv6 address of the given host or router, given its IInterfaceTable module.

For IPv4, the first usable interface address is chosen.

Referenced by addressOf().

{
    L3Address ret;
    bool netmask = addrType & ADDR_MASK;
    if ((addrType & ADDR_IPv4) && getIPv4AddressFrom(ret, ift, netmask))
        return ret;
    else if ((addrType & ADDR_IPv6) && getIPv6AddressFrom(ret, ift, netmask))
        return ret;
    else if ((addrType & ADDR_MAC) && getMACAddressFrom(ret, ift, netmask))
        return ret;
    else if ((addrType & ADDR_MODULEPATH) && getModulePathAddressFrom(ret, ift, netmask))
        return ret;
    else if ((addrType & ADDR_MODULEID) && getModuleIdAddressFrom(ret, ift, netmask))
        return ret;
    else
        throw cRuntimeError("L3AddressResolver: unknown addrType %d", addrType);
    return ret;
}

L3Address inet::L3AddressResolver::getAddressFrom ( InterfaceEntry *  ie, int  addrType = DEFAULT_ADDR_TYPE  )

virtual

Returns the IPv4 or IPv6 address of the given interface (of a host or router).

{
    L3Address ret;
    bool mask = addrType & ADDR_MASK;

    if ((addrType & ADDR_IPv4) && getInterfaceIPv4Address(ret, ie, mask))
        return ret;
    else if ((addrType & ADDR_IPv6) && getInterfaceIPv6Address(ret, ie, mask))
        return ret;
    else if ((addrType & ADDR_MAC) && getInterfaceMACAddress(ret, ie, mask))
        return ret;
    else if ((addrType & ADDR_MODULEPATH) && getInterfaceModulePathAddress(ret, ie, mask))
        return ret;
    else if ((addrType & ADDR_MODULEID) && getInterfaceModuleIdAddress(ret, ie, mask))
        return ret;
    else
        throw cRuntimeError("L3AddressResolver: unknown addrType %d at %s", addrType, ie->getFullPath().c_str());

    return ret;
}

bool inet::L3AddressResolver::getInterfaceIPv4Address ( L3Address &  ret, InterfaceEntry *  ie, bool  mask  )

protectedvirtual

Reimplemented in inet::IPv4NetworkConfigurator.

Referenced by getAddressFrom(), getInterfaceIPv4Address(), and getIPv4AddressFrom().

{
#ifdef WITH_IPv4
    if (ie->ipv4Data()) {
        IPv4Address addr = ie->ipv4Data()->getIPAddress();
        if (!addr.isUnspecified()) {
            ret.set(netmask ? ie->ipv4Data()->getNetmask() : addr);
            return true;
        }
    }
    else {
        // find address in the configurator's notebook
        // TODO: how do we know where is the configurator? get the path from a NED parameter?
        L3AddressResolver *configurator = dynamic_cast<L3AddressResolver *>(getSimulation()->getModuleByPath("configurator"));
        if (configurator)
            return configurator->getInterfaceIPv4Address(ret, ie, netmask);
    }
#endif // ifdef WITH_IPv4
    return false;
}

bool inet::L3AddressResolver::getInterfaceIPv6Address ( L3Address &  ret, InterfaceEntry *  ie, bool  mask  )

protectedvirtual

Referenced by getAddressFrom().

{
#ifdef WITH_IPv6
    if (netmask)
        return false; // IPv6 netmask not supported yet
    if (ie->ipv6Data()) {
        IPv6Address addr = ie->ipv6Data()->getPreferredAddress();
        if (!addr.isUnspecified()) {
            ret.set(addr);
            return true;
        }
    }
#endif // ifdef WITH_IPv6
    return false;
}

bool inet::L3AddressResolver::getInterfaceMACAddress ( L3Address &  ret, InterfaceEntry *  ie, bool  mask  )

protectedvirtual

Referenced by getAddressFrom(), and getMACAddressFrom().

{
    if (!ie->getMacAddress().isUnspecified() && false) {
        ret = ie->getMacAddress();
        return true;
    }
    return false;
}

bool inet::L3AddressResolver::getInterfaceModuleIdAddress ( L3Address &  ret, InterfaceEntry *  ie, bool  mask  )

protectedvirtual

Referenced by getAddressFrom(), and getModuleIdAddressFrom().

{
    ret = ie->getModuleIdAddress();
    return true;
}

bool inet::L3AddressResolver::getInterfaceModulePathAddress ( L3Address &  ret, InterfaceEntry *  ie, bool  mask  )

protectedvirtual

Referenced by getAddressFrom(), and getModulePathAddressFrom().

{
    ret = ie->getModulePathAddress();
    return true;
}

bool inet::L3AddressResolver::getIPv4AddressFrom ( L3Address &  retAddr, IInterfaceTable *  ift, bool  netmask  )

protectedvirtual

Referenced by getAddressFrom().

{
    if (ift->getNumInterfaces() == 0)
        throw cRuntimeError("L3AddressResolver: interface table `%s' has no interface registered "
                            "(yet? try in a later init stage!)", ift->getFullPath().c_str());

#ifdef WITH_IPv4
    // choose first usable interface address (configured for IPv4, non-loopback if, addr non-null)
    for (int i = 0; i < ift->getNumInterfaces(); i++) {
        InterfaceEntry *ie = ift->getInterface(i);
        if (ie->isLoopback())
            continue;
        if (getInterfaceIPv4Address(retAddr, ie, netmask))
            return true;
    }
#endif // ifdef WITH_IPv4
    return false;
}

bool inet::L3AddressResolver::getIPv6AddressFrom ( L3Address &  retAddr, IInterfaceTable *  ift, bool  netmask  )

protectedvirtual

Referenced by getAddressFrom().

{
    // browse interfaces and pick a globally routable address
    if (ift->getNumInterfaces() == 0)
        throw cRuntimeError("L3AddressResolver: interface table `%s' has no interface registered "
                            "(yet? try in a later init stage!)", ift->getFullPath().c_str());

#ifndef WITH_IPv6
    return false;
#else // ifndef WITH_IPv6
    if (netmask)
        return false; // IPv6 netmask not supported yet

    bool ret = false;
    IPv6Address::Scope retScope = IPv6Address::UNSPECIFIED;

    for (int i = 0; i < ift->getNumInterfaces() && retScope != IPv6Address::GLOBAL; i++) {
        InterfaceEntry *ie = ift->getInterface(i);
        if (!ie->ipv6Data() || ie->isLoopback())
            continue;
        IPv6Address curAddr = ie->ipv6Data()->getPreferredAddress();
        IPv6Address::Scope curScope = curAddr.getScope();
        if (curScope > retScope) {
            retAddr = curAddr;
            retScope = curScope;
            ret = true;
        }
    }
    return ret;
#endif // ifndef WITH_IPv6
}

bool inet::L3AddressResolver::getMACAddressFrom ( L3Address &  retAddr, IInterfaceTable *  ift, bool  netmask  )

protectedvirtual

Referenced by getAddressFrom().

{
    if (ift->getNumInterfaces() == 0)
        throw cRuntimeError("L3AddressResolver: interface table `%s' has no interface registered "
                            "(yet? try in a later init stage!)", ift->getFullPath().c_str());

    // choose first usable interface address (configured for generic, non-loopback if, addr non-null)
    for (int i = 0; i < ift->getNumInterfaces(); i++) {
        InterfaceEntry *ie = ift->getInterface(i);
        if (ie->isLoopback())
            continue;
        if (getInterfaceMACAddress(retAddr, ie, netmask))
            return true;
    }
    return false;
}

bool inet::L3AddressResolver::getModuleIdAddressFrom ( L3Address &  retAddr, IInterfaceTable *  ift, bool  netmask  )

protectedvirtual

Referenced by getAddressFrom().

{
    if (ift->getNumInterfaces() == 0)
        throw cRuntimeError("L3AddressResolver: interface table `%s' has no interface registered "
                            "(yet? try in a later init stage!)", ift->getFullPath().c_str());

    // choose first usable interface address (configured for generic, non-loopback if, addr non-null)
    for (int i = 0; i < ift->getNumInterfaces(); i++) {
        InterfaceEntry *ie = ift->getInterface(i);
        if (ie->isLoopback())
            continue;
        if (getInterfaceModuleIdAddress(retAddr, ie, netmask))
            return true;
    }
    return false;
}

bool inet::L3AddressResolver::getModulePathAddressFrom ( L3Address &  retAddr, IInterfaceTable *  ift, bool  netmask  )

protectedvirtual

Referenced by getAddressFrom().

{
    if (ift->getNumInterfaces() == 0)
        throw cRuntimeError("L3AddressResolver: interface table `%s' has no interface registered "
                            "(yet? try in a later init stage!)", ift->getFullPath().c_str());

    // choose first usable interface address (configured for generic, non-loopback if, addr non-null)
    for (int i = 0; i < ift->getNumInterfaces(); i++) {
        InterfaceEntry *ie = ift->getInterface(i);
        if (ie->isLoopback())
            continue;
        if (getInterfaceModulePathAddress(retAddr, ie, netmask))
            return true;
    }
    return false;
}

IInterfaceTable * inet::L3AddressResolver::interfaceTableOf ( cModule *  host )

virtual

The function tries to look up the IInterfaceTable module as submodule "interfaceTable" or "networkLayer.interfaceTable" within the host/router module.

Throws an error if not found.

Referenced by inet::FlatNetworkConfigurator6::addOwnAdvPrefixRoutes(), addressOf(), inet::FlatNetworkConfigurator6::addStaticRoutes(), inet::FlatNetworkConfigurator6::configureAdvPrefixes(), inet::FlatNetworkConfigurator::extractTopology(), and inet::HostAutoConfigurator::setupNetworkLayer().

{
    // find IInterfaceTable
    cModule *mod = host->getSubmodule("interfaceTable");
    if (!mod)
        throw cRuntimeError("L3AddressResolver: IInterfaceTable not found as submodule "
                            " `interfaceTable' in host/router `%s'", host->getFullPath().c_str());

    return check_and_cast<IInterfaceTable *>(mod);
}

L3Address inet::L3AddressResolver::resolve ( const char *  str, int  addrType = DEFAULT_ADDR_TYPE  )

virtual

Accepts dotted decimal notation ("127.0.0.1"), module name of the host or router ("host[2]"), and empty string ("").

For the latter, it returns the null address. If module name is specified, the module will be looked up using getModuleByPath(), and then addressOf() will be called to determine its IP address.

Referenced by inet::UDPBasicApp::chooseDestAddr(), inet::MultiFieldClassifier::configureFilters(), inet::NetPerfMeter::createAndBindSocket(), inet::Define_Module(), inet::NetPerfMeter::establishConnection(), inet::xmlutils::getParameterIPAddressValue(), inet::PingApp::handleMessage(), inet::VoIPStreamSender::initialize(), inet::WiseRoute::initialize(), inet::SCTPNatServer::initialize(), inet::SCTPServer::initialize(), inet::SCTPClient::initialize(), inet::SCTPNatPeer::initialize(), inet::SCTPPeer::initialize(), inet::dymo::DYMO::initialize(), inet::ospf::ipv4AddressFromAddressString(), inet::ospf::ipv4NetmaskFromAddressString(), inet::PingApp::parseDestAddressesPar(), inet::UDPBasicBurst::processStart(), inet::IPv4NetworkConfigurator::readManualMulticastRouteConfiguration(), inet::IPv4NetworkConfigurator::readManualRouteConfiguration(), inet::RSVP::readTrafficRouteFromXML(), inet::UDPVideoStreamCli::requestStream(), resolve(), inet::IPv4NetworkConfigurator::resolveInterfaceAndGateway(), inet::tcp::TCPSpoof::sendSpoofPacket(), inet::SimpleVoIPSender::sendVoIPPacket(), inet::UDPSink::setSocketOptions(), inet::SCTPNatPeer::socketClosed(), inet::SCTPNatPeer::socketPeerClosed(), and inet::DHCPServer::startApp().

{
    L3Address addr;
    if (!tryResolve(s, addr, addrType))
        throw cRuntimeError("L3AddressResolver: address `%s' not configured (yet?)", s);
    return addr;
}

std::vector< L3Address > inet::L3AddressResolver::resolve ( std::vector< std::string >  strs, int  addrType = DEFAULT_ADDR_TYPE  )

virtual

Utility function: Calls resolve() for each item in the string vector, and returns the result in an address vector.

The string vector may come e.g. from cStringTokenizer::asVector().

{
    std::vector<L3Address> result;
    int n = strs.size();
    result.reserve(n);
    for (int i = 0; i < n; i++)
        result.push_back(resolve(strs[i].c_str(), addrType));
    return result;
}

L3Address inet::L3AddressResolver::routerIdOf ( cModule *  host )

virtual

Returns the router Id of the given router.

Router Id is obtained from the getRouterId() method of the IIPv4RoutingTable submodule.

Referenced by tryResolve().

{
#ifdef WITH_IPv4
    IIPv4RoutingTable *rt = routingTableOf(host);
    return L3Address(rt->getRouterId());
#else // ifdef WITH_IPv4
    throw cRuntimeError("INET was compiled without IPv4 support");
#endif // ifdef WITH_IPv4
}

IPv6RoutingTable * inet::L3AddressResolver::routingTable6Of ( cModule *  host )

virtual

The function tries to look up the IPv6RoutingTable module as submodule "routingTable6" or "networkLayer.routingTable6" within the host/router module.

Throws an error if not found.

Referenced by inet::xMIPv6::initialize().

{
    // find IPv6RoutingTable
    IPv6RoutingTable *mod = findIPv6RoutingTableOf(host);
    if (!mod)
        throw cRuntimeError("L3AddressResolver: IPv6RoutingTable not found as submodule "
                            " `routingTable' in host/router `%s'", host->getFullPath().c_str());
    return mod;
}

IIPv4RoutingTable * inet::L3AddressResolver::routingTableOf ( cModule *  host )

virtual

The function tries to look up the IIPv4RoutingTable module as submodule "routingTable" or "networkLayer.routingTable" within the host/router module.

Throws an error if not found.

Referenced by inet::FlatNetworkConfigurator::extractTopology(), routerIdOf(), and inet::HostAutoConfigurator::setupNetworkLayer().

{
    IIPv4RoutingTable *mod = findIPv4RoutingTableOf(host);
    if (!mod)
        throw cRuntimeError("L3AddressResolver: IIPv4RoutingTable not found as submodule "
                            " `routingTable' in host/router `%s'", host->getFullPath().c_str());
    return mod;
}

bool inet::L3AddressResolver::tryResolve ( const char *  str, L3Address &  result, int  addrType = DEFAULT_ADDR_TYPE  )

virtual

Similar to resolve(), but returns false (instead of throwing an error) if the address cannot be resolved because the given host (or interface) doesn't have an address assigned yet.

(It still throws an error on any other error condition).

Referenced by inet::TCPAppBase::connect(), inet::SCTPClient::connect(), inet::SCTPPeer::connect(), inet::IPvXTrafGen::handleMessage(), inet::UDPBasicApp::processStart(), and resolve().

{
    // empty address
    result = L3Address();
    if (!s || !*s)
        return true;

    // handle address literal
    if (result.tryParse(s))
        return true;

    // must be " modulename [ { '%' interfacename | '>' destnode } ] [ '(' protocol ')' ] [ '/' ] " syntax
    // interfacename: existing_interface_of_module | 'routerId'
    // protocol: 'ipv4' | 'ipv6' | 'mac' | 'modulepath' | 'moduleid'
    // '/': returns mask instead address
    std::string modname, ifname, protocol, destnodename;
    bool netmask = addrType & ADDR_MASK;
    const char *p = s;
    const char *endp = strchr(p, '\0');
    const char *nextsep = strpbrk(p, "%>(/");
    if (!nextsep)
        nextsep = endp;
    modname.assign(p, nextsep - p);

    char c = *nextsep;

    if (c == '%') {
        {
            p = nextsep + 1;
            nextsep = strpbrk(p, "(/");
            if (!nextsep)
                nextsep = endp;
        }
        ifname.assign(p, nextsep - p);
        c = *nextsep;
    }
    else if (c == '>') {
        {
            p = nextsep + 1;
            nextsep = strpbrk(p, "(/");
            if (!nextsep)
                nextsep = endp;
        }
        destnodename.assign(p, nextsep - p);
        c = *nextsep;
    }

    if (c == '(') {
        {
            p = nextsep + 1;
            nextsep = strpbrk(p, ")");
            if (!nextsep)
                nextsep = endp;
        }
        protocol.assign(p, nextsep - p);
        c = *nextsep;
        if (c == ')') {
            {
                p = nextsep + 1;
                nextsep = p;
            }
            c = *nextsep;
        }
    }

    if (c == '/') {
        netmask = true;
        {
            p = nextsep + 1;
            nextsep = p;
        }
        c = *nextsep;
    }

    if (c)
        throw cRuntimeError("L3AddressResolver: syntax error parsing address spec `%s'", s);

    // find module
    cModule *mod = getSimulation()->getModuleByPath(modname.c_str());
    if (!mod)
        throw cRuntimeError("L3AddressResolver: module `%s' not found", modname.c_str());

    // check protocol
    if (!protocol.empty()) {
        if (protocol == "ipv4")
            addrType = ADDR_IPv4;
        else if (protocol == "ipv6")
            addrType = ADDR_IPv6;
        else if (protocol == "mac")
            addrType = ADDR_MAC;
        else if (protocol == "modulepath")
            addrType = ADDR_MODULEPATH;
        else if (protocol == "moduleid")
            addrType = ADDR_MODULEID;
        else
            throw cRuntimeError("L3AddressResolver: error parsing address spec `%s': address type must be `(ipv4)' or `(ipv6)'", s);
    }
    if (netmask)
        addrType |= ADDR_MASK;

    // find interface for dest node
    // get address from the given module/interface
    if (!destnodename.empty()) {
        cModule *destnode = getSimulation()->getModuleByPath(destnodename.c_str());
        if (!destnode)
            throw cRuntimeError("L3AddressResolver: destination module `%s' not found", destnodename.c_str());
        result = addressOf(mod, destnode, addrType);
    }
    else if (ifname.empty())
        result = addressOf(mod, addrType);
    else if (ifname == "routerId")
        result = routerIdOf(mod); // addrType is meaningless here, routerId is protocol independent
    else
        result = addressOf(mod, ifname.c_str(), addrType);
    return !result.isUnspecified();
}

---

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

• L3AddressResolver.h
• L3AddressResolver.cc