inet::IPv4MulticastRoute Class Reference

IPv4 multicast route in IIPv4RoutingTable. More...

#include <IPv4Route.h>

Inheritance diagram for inet::IPv4MulticastRoute:

Public Types
enum	{   F_ORIGIN, F_ORIGINMASK, F_MULTICASTGROUP, F_IN,   F_OUT, F_SOURCE, F_METRIC, F_LAST }
Public Types inherited from inet::IMulticastRoute
enum	SourceType { MANUAL, DVMRP, PIM_DM, PIM_SM }
	Specifies where the route comes from. More...
typedef std::vector< OutInterface * >	OutInterfaceVector

Public Member Functions
	IPv4MulticastRoute ()
virtual	~IPv4MulticastRoute ()
virtual std::string	info () const override
virtual std::string	detailedInfo () const override
virtual void	setRoutingTable (IIPv4RoutingTable *rt)
	To be called by the routing table when this route is added or removed from it. More...
IIPv4RoutingTable *	getRoutingTable () const
virtual bool	isValid () const
	test validity of route entry, e.g. More...
virtual bool	matches (const IPv4Address &origin, const IPv4Address &group) const
virtual void	setOrigin (IPv4Address _origin)
virtual void	setOriginNetmask (IPv4Address _netmask)
virtual void	setMulticastGroup (IPv4Address _group)
virtual void	setInInterface (InInterface *_inInterface) override
virtual void	clearOutInterfaces () override
virtual void	addOutInterface (OutInterface *outInterface) override
virtual bool	removeOutInterface (const InterfaceEntry *ie) override
virtual void	removeOutInterface (unsigned int i) override
virtual void	setSourceType (SourceType _source) override
virtual void	setMetric (int _metric) override
IPv4Address	getOrigin () const
	Source address prefix to match. More...
IPv4Address	getOriginNetmask () const
	Represents length of prefix to match. More...
IPv4Address	getMulticastGroup () const
	Multicast group address. More...
InInterface *	getInInterface () const
	In interface. More...
unsigned int	getNumOutInterfaces () const
	Number of out interfaces. More...
OutInterface *	getOutInterface (unsigned int k) const
	The kth out interface. More...
SourceType	getSourceType () const override
	Source of route. More...
int	getMetric () const override
	"Cost" to reach the destination More...
void	setSource (cObject *_source) override
cObject *	getSource () const override
	Source of route. More...
virtual IRoutingTable *	getRoutingTableAsGeneric () const override
	The routing table in which this route is inserted, or nullptr. More...
virtual void	setEnabled (bool enabled) override
virtual void	setOrigin (const L3Address &origin) override
virtual void	setPrefixLength (int len) override
virtual void	setMulticastGroup (const L3Address &group) override
virtual bool	isEnabled () const override
	Disabled entries are ignored by routing until the became enabled again. More...
virtual bool	isExpired () const override
	Expired entries are ignored by routing, and may be periodically purged. More...
virtual L3Address	getOriginAsGeneric () const override
	Source address prefix to match. More...
virtual int	getPrefixLength () const override
	Prefix length to match. More...
virtual L3Address	getMulticastGroupAsGeneric () const override
	Multicast group address. More...
Public Member Functions inherited from inet::IMulticastRoute
virtual	~IMulticastRoute ()
virtual void	setInInterface (InInterface *_inInterface)=0
virtual void	setSourceType (SourceType type)=0

Protected Member Functions
void	changed (int fieldCode)

Private Member Functions
	IPv4MulticastRoute (const IPv4MulticastRoute &obj)
IPv4MulticastRoute &	operator= (const IPv4MulticastRoute &obj)

Private Attributes
IIPv4RoutingTable *	rt
	the routing table in which this route is inserted, or nullptr More...
IPv4Address	origin
	Source network. More...
IPv4Address	originNetmask
	Source network mask. More...
IPv4Address	group
	Multicast group, if unspecified then matches any. More...
InInterface *	inInterface
	In interface (upstream) More...
OutInterfaceVector	outInterfaces
	Out interfaces (downstream) More...
SourceType	sourceType
	manual, routing prot, etc. More...
cObject *	source
	Object identifying the source. More...
int	metric
	Metric ("cost" to reach the source) More...

Additional Inherited Members
Static Public Member Functions inherited from inet::IMulticastRoute
static const char *	sourceTypeName (SourceType sourceType)

Detailed Description

IPv4 multicast route in IIPv4RoutingTable.

Multicast routing protocols may extend this class to store protocol specific fields.

Multicast datagrams are forwarded along the edges of a multicast tree. The tree might depend on the multicast group and the source (origin) of the multicast datagram.

The forwarding algorithm chooses the route according the to origin (source address) and multicast group (destination address) of the received datagram. The route might specify a prefix of the origin and a multicast group to be matched.

Then the forwarding algorithm copies the datagrams arrived on the parent (upstream) interface to the child interfaces (downstream). If there are no downstream routers on a child interface (i.e. it is a leaf in the multicast routing tree), then the datagram is forwarded only if there are listeners of the multicast group on that link (TRPB routing).

See also

IIPv4RoutingTable, IPv4RoutingTable

Member Enumeration Documentation

anonymous enum

Enumerator
F_ORIGIN
F_ORIGINMASK
F_MULTICASTGROUP
F_IN
F_OUT
F_SOURCE
F_METRIC
F_LAST

{ F_ORIGIN, F_ORIGINMASK, F_MULTICASTGROUP, F_IN, F_OUT, F_SOURCE, F_METRIC, F_LAST };

Constructor & Destructor Documentation

inet::IPv4MulticastRoute::IPv4MulticastRoute ( const IPv4MulticastRoute &  obj )

private

inet::IPv4MulticastRoute::IPv4MulticastRoute ( )

inline

: rt(nullptr), inInterface(nullptr), sourceType(MANUAL), source(nullptr), metric(0) {}

inet::IPv4MulticastRoute::~IPv4MulticastRoute ( )

virtual

{
    delete inInterface;
    for (auto & elem : outInterfaces)
        delete elem;
    outInterfaces.clear();
}

Member Function Documentation

void inet::IPv4MulticastRoute::addOutInterface ( OutInterface *  outInterface )

overridevirtual

Implements inet::IMulticastRoute.

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::PIMSM::createIPv4Route(), inet::PIMDM::multicastReceiverAdded(), inet::IPv4NetworkConfigurator::readManualMulticastRouteConfiguration(), inet::PIMDM::rpfInterfaceHasChanged(), and inet::PIMDM::unroutableMulticastPacketArrived().

{
    ASSERT(outInterface);

    auto it = outInterfaces.begin();
    for ( ; it != outInterfaces.end(); ++it) {
        if ((*it)->getInterface() == outInterface->getInterface()) {
            delete *it;
            *it = outInterface;
            changed(F_OUT);
            return;
        }
    }

    outInterfaces.push_back(outInterface);
    changed(F_OUT);
}

void inet::IPv4MulticastRoute::changed ( int  fieldCode )

protected

{
    if (rt)
        rt->multicastRouteChanged(this, fieldCode);
}

void inet::IPv4MulticastRoute::clearOutInterfaces ( )

overridevirtual

Implements inet::IMulticastRoute.

{
    if (!outInterfaces.empty()) {
        for (auto & elem : outInterfaces)
            delete elem;
        outInterfaces.clear();
        changed(F_OUT);
    }
}

std::string inet::IPv4MulticastRoute::detailedInfo ( ) const

overridevirtual

{
    return info();
}

InInterface* inet::IPv4MulticastRoute::getInInterface ( ) const

inline

In interface.

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::IPv4RoutingTable::deleteInterfaceRoutes(), inet::IPv4NetworkConfigurator::dumpConfig(), inet::IPv4::forwardMulticastPacket(), inet::IPv4RoutingTable::internalAddMulticastRoute(), inet::IPv4RoutingTable::printMulticastRoutingTable(), inet::PIMDM::receiveSignal(), and inet::PIMDM::rpfInterfaceHasChanged().

{ return inInterface; }

int inet::IPv4MulticastRoute::getMetric ( ) const

inlineoverridevirtual

"Cost" to reach the destination

Implements inet::IMulticastRoute.

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::IPv4NetworkConfigurator::dumpConfig(), inet::IPv4RoutingTable::multicastRouteLessThan(), and inet::IPv4RoutingTable::printMulticastRoutingTable().

{ return metric; }

IPv4Address inet::IPv4MulticastRoute::getMulticastGroup ( ) const

inline

Multicast group address.

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::IPv4NetworkConfigurator::dumpConfig(), inet::PIMDM::findIPv4MulticastRoute(), inet::PIMSM::findIPv4Route(), inet::IPv4RoutingTable::internalAddMulticastRoute(), inet::PIMDM::multicastReceiverAdded(), inet::PIMDM::multicastReceiverRemoved(), inet::IPv4RoutingTable::multicastRouteLessThan(), inet::IPv4RoutingTable::printMulticastRoutingTable(), and inet::PIMDM::rpfInterfaceHasChanged().

{ return group; }

virtual L3Address inet::IPv4MulticastRoute::getMulticastGroupAsGeneric ( ) const

inlineoverridevirtual

Multicast group address.

Implements inet::IMulticastRoute.

{ return getMulticastGroup(); }

unsigned int inet::IPv4MulticastRoute::getNumOutInterfaces ( ) const

inline

Number of out interfaces.

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::IPv4NetworkConfigurator::dumpConfig(), inet::IPv4::forwardMulticastPacket(), inet::IPv4RoutingTable::internalAddMulticastRoute(), and inet::IPv4RoutingTable::printMulticastRoutingTable().

{ return outInterfaces.size(); }

IPv4Address inet::IPv4MulticastRoute::getOrigin ( ) const

inline

Source address prefix to match.

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::IPv4NetworkConfigurator::dumpConfig(), inet::PIMDM::findIPv4MulticastRoute(), inet::PIMSM::findIPv4Route(), inet::IPv4RoutingTable::internalAddMulticastRoute(), inet::PIMDM::multicastReceiverAdded(), inet::PIMDM::multicastReceiverRemoved(), inet::IPv4RoutingTable::multicastRouteLessThan(), inet::IPv4RoutingTable::printMulticastRoutingTable(), inet::PIMDM::receiveSignal(), and inet::PIMDM::rpfInterfaceHasChanged().

{ return origin; }

virtual L3Address inet::IPv4MulticastRoute::getOriginAsGeneric ( ) const

inlineoverridevirtual

Source address prefix to match.

Implements inet::IMulticastRoute.

{ return getOrigin(); }

IPv4Address inet::IPv4MulticastRoute::getOriginNetmask ( ) const

inline

Represents length of prefix to match.

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::IPv4NetworkConfigurator::dumpConfig(), inet::IPv4RoutingTable::internalAddMulticastRoute(), inet::IPv4RoutingTable::multicastRouteLessThan(), and inet::IPv4RoutingTable::printMulticastRoutingTable().

{ return originNetmask; }

OutInterface* inet::IPv4MulticastRoute::getOutInterface ( unsigned int  k ) const

inline

The kth out interface.

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::IPv4NetworkConfigurator::dumpConfig(), inet::IPv4::forwardMulticastPacket(), inet::IPv4RoutingTable::internalAddMulticastRoute(), and inet::IPv4RoutingTable::printMulticastRoutingTable().

{ return outInterfaces.at(k); }

virtual int inet::IPv4MulticastRoute::getPrefixLength ( ) const

inlineoverridevirtual

Prefix length to match.

Implements inet::IMulticastRoute.

{ return getOriginNetmask().getNetmaskLength(); }    //TODO inconsistent naming

IIPv4RoutingTable* inet::IPv4MulticastRoute::getRoutingTable ( ) const

inline

Referenced by inet::IPv4RoutingTable::deleteInterfaceRoutes(), inet::IPv4RoutingTable::deleteMulticastRoute(), inet::IPv4RoutingTable::purge(), and inet::IPv4RoutingTable::removeMulticastRoute().

{ return rt; }

IRoutingTable * inet::IPv4MulticastRoute::getRoutingTableAsGeneric ( ) const

overridevirtual

The routing table in which this route is inserted, or nullptr.

Implements inet::IMulticastRoute.

{
    return getRoutingTable();
}

cObject* inet::IPv4MulticastRoute::getSource ( ) const

inlineoverridevirtual

Source of route.

Implements inet::IMulticastRoute.

Referenced by inet::PIMDM::clearRoutes(), inet::PIMSM::clearRoutes(), inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::PIMDM::findIPv4MulticastRoute(), inet::PIMSM::findIPv4Route(), inet::PIMDM::multicastReceiverAdded(), inet::PIMDM::multicastReceiverRemoved(), and inet::PIMDM::receiveSignal().

{ return source; }

SourceType inet::IPv4MulticastRoute::getSourceType ( ) const

inlineoverridevirtual

Source of route.

MANUAL (read from file), from routing protocol, etc

Implements inet::IMulticastRoute.

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable().

{ return sourceType; }

std::string inet::IPv4MulticastRoute::info ( ) const

overridevirtual

Referenced by inet::operator<<().

{
    std::stringstream out;

    out << "origin:";
    if (origin.isUnspecified())
        out << "*  ";
    else
        out << origin << "  ";
    out << "mask:";
    if (originNetmask.isUnspecified())
        out << "*  ";
    else
        out << originNetmask << "  ";
    out << "group:";
    if (group.isUnspecified())
        out << "*  ";
    else
        out << group << "  ";
    out << "metric:" << metric << " ";
    out << "in:";
    if (!inInterface)
        out << "*  ";
    else
        out << inInterface->getInterface()->getName() << "  ";
    out << "out:";
    bool first = true;
    for (auto & elem : outInterfaces) {
        if (!first)
            out << ",";
        if (elem->isEnabled()) {
            out << elem->getInterface()->getName();
            first = false;
        }
    }

    out << " " << IMulticastRoute::sourceTypeName(sourceType);

    return out.str();
}

virtual bool inet::IPv4MulticastRoute::isEnabled ( ) const

inlineoverridevirtual

Disabled entries are ignored by routing until the became enabled again.

Implements inet::IMulticastRoute.

{ return true;    /*TODO: isEnabled();*/ }

virtual bool inet::IPv4MulticastRoute::isExpired ( ) const

inlineoverridevirtual

Expired entries are ignored by routing, and may be periodically purged.

Implements inet::IMulticastRoute.

{ return !isValid(); }    //TODO rename IPv4 method

virtual bool inet::IPv4MulticastRoute::isValid ( ) const

inlinevirtual

test validity of route entry, e.g.

check expiry

Referenced by inet::IPv4RoutingTable::purge().

{ return true; }

virtual bool inet::IPv4MulticastRoute::matches ( const IPv4Address &  origin, const IPv4Address &  group  ) const

inlinevirtual

    {
        return (this->group.isUnspecified() || this->group == group) &&
               IPv4Address::maskedAddrAreEqual(origin, this->origin, this->originNetmask);
    }

IPv4MulticastRoute& inet::IPv4MulticastRoute::operator= ( const IPv4MulticastRoute &  obj )

private

bool inet::IPv4MulticastRoute::removeOutInterface ( const InterfaceEntry *  ie )

overridevirtual

Implements inet::IMulticastRoute.

Referenced by inet::IPv4RoutingTable::deleteInterfaceRoutes(), inet::PIMSM::Route::removeDownstreamInterface(), and inet::PIMDM::rpfInterfaceHasChanged().

{
    for (auto it = outInterfaces.begin(); it != outInterfaces.end(); ++it) {
        if ((*it)->getInterface() == ie) {
            delete *it;
            outInterfaces.erase(it);
            changed(F_OUT);
            return true;
        }
    }
    return false;
}

void inet::IPv4MulticastRoute::removeOutInterface ( unsigned int  i )

overridevirtual

Implements inet::IMulticastRoute.

{
    OutInterface *outInterface = outInterfaces.at(i);
    delete outInterface;
    outInterfaces.erase(outInterfaces.begin() + i);
    changed(F_OUT);
}

virtual void inet::IPv4MulticastRoute::setEnabled ( bool  enabled )

inlineoverridevirtual

Implements inet::IMulticastRoute.

{    /*TODO: setEnabled(enabled);*/ }

void inet::IPv4MulticastRoute::setInInterface ( InInterface *  _inInterface )

overridevirtual

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::PIMSM::createIPv4Route(), inet::IPv4NetworkConfigurator::readManualMulticastRouteConfiguration(), inet::PIMDM::rpfInterfaceHasChanged(), and inet::PIMDM::unroutableMulticastPacketArrived().

{
    if (inInterface != _inInterface) {
        delete inInterface;
        inInterface = _inInterface;
        changed(F_IN);
    }
}

virtual void inet::IPv4MulticastRoute::setMetric ( int  _metric )

inlineoverridevirtual

Implements inet::IMulticastRoute.

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), and inet::IPv4NetworkConfigurator::readManualMulticastRouteConfiguration().

{ if (metric != _metric) { metric = _metric; changed(F_METRIC); } }

virtual void inet::IPv4MulticastRoute::setMulticastGroup ( IPv4Address  _group )

inlinevirtual

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::PIMSM::createIPv4Route(), inet::IPv4NetworkConfigurator::readManualMulticastRouteConfiguration(), and inet::PIMDM::unroutableMulticastPacketArrived().

{ if (group != _group) { group = _group; changed(F_MULTICASTGROUP); } }

virtual void inet::IPv4MulticastRoute::setMulticastGroup ( const L3Address &  group )

inlineoverridevirtual

Implements inet::IMulticastRoute.

Referenced by setMulticastGroup().

{ setMulticastGroup(group.toIPv4()); }

virtual void inet::IPv4MulticastRoute::setOrigin ( IPv4Address  _origin )

inlinevirtual

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::PIMSM::createIPv4Route(), inet::IPv4NetworkConfigurator::readManualMulticastRouteConfiguration(), and inet::PIMDM::unroutableMulticastPacketArrived().

{ if (origin != _origin) { origin = _origin; changed(F_ORIGIN); } }

virtual void inet::IPv4MulticastRoute::setOrigin ( const L3Address &  origin )

inlineoverridevirtual

Implements inet::IMulticastRoute.

Referenced by setOrigin().

{ setOrigin(origin.toIPv4()); }

virtual void inet::IPv4MulticastRoute::setOriginNetmask ( IPv4Address  _netmask )

inlinevirtual

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::PIMSM::createIPv4Route(), inet::IPv4NetworkConfigurator::readManualMulticastRouteConfiguration(), and inet::PIMDM::unroutableMulticastPacketArrived().

{ if (originNetmask != _netmask) { originNetmask = _netmask; changed(F_ORIGINMASK); } }

virtual void inet::IPv4MulticastRoute::setPrefixLength ( int  len )

inlineoverridevirtual

Implements inet::IMulticastRoute.

{ setOriginNetmask(IPv4Address::makeNetmask(len)); }    //TODO inconsistent naming

virtual void inet::IPv4MulticastRoute::setRoutingTable ( IIPv4RoutingTable *  rt )

inlinevirtual

To be called by the routing table when this route is added or removed from it.

Referenced by inet::IPv4RoutingTable::internalAddMulticastRoute(), and inet::IPv4RoutingTable::removeMulticastRoute().

{ this->rt = rt; }

void inet::IPv4MulticastRoute::setSource ( cObject *  _source )

inlineoverridevirtual

Implements inet::IMulticastRoute.

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::PIMSM::createIPv4Route(), and inet::PIMDM::unroutableMulticastPacketArrived().

{ source = _source; }

virtual void inet::IPv4MulticastRoute::setSourceType ( SourceType  _source )

inlineoverridevirtual

Referenced by inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::PIMSM::createIPv4Route(), inet::IPv4NetworkConfigurator::readManualMulticastRouteConfiguration(), and inet::PIMDM::unroutableMulticastPacketArrived().

{ if (sourceType != _source) { sourceType = _source; changed(F_SOURCE); } }

Member Data Documentation

IPv4Address inet::IPv4MulticastRoute::group

private

Multicast group, if unspecified then matches any.

InInterface* inet::IPv4MulticastRoute::inInterface

private

In interface (upstream)

int inet::IPv4MulticastRoute::metric

private

Metric ("cost" to reach the source)

IPv4Address inet::IPv4MulticastRoute::origin

private

Source network.

IPv4Address inet::IPv4MulticastRoute::originNetmask

private

Source network mask.

OutInterfaceVector inet::IPv4MulticastRoute::outInterfaces

private

Out interfaces (downstream)

IIPv4RoutingTable* inet::IPv4MulticastRoute::rt

private

the routing table in which this route is inserted, or nullptr

cObject* inet::IPv4MulticastRoute::source

private

Object identifying the source.

SourceType inet::IPv4MulticastRoute::sourceType

private

manual, routing prot, etc.

---

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

• IPv4Route.h
• IPv4Route.cc