inet::IPv6Route Class Reference

Represents a route in the route table. More...

#include <IPv6Route.h>

Inheritance diagram for inet::IPv6Route:

Public Types
enum	RouteAdminDist {   dDirectlyConnected = 0, dStatic = 1, dEIGRPSummary = 5, dBGPExternal = 20,   dEIGRPInternal = 90, dIGRP = 100, dOSPF = 110, dISIS = 115,   dRIP = 120, dEGP = 140, dODR = 160, dEIGRPExternal = 170,   dBGPInternal = 200, dDHCPlearned = 254, dUnknown = 255 }
	Cisco like administrative distances (includes IPv4 protocols) More...
Public Types inherited from inet::IRoute
enum	SourceType {   MANUAL, IFACENETMASK, ROUTER_ADVERTISEMENT, OWN_ADV_PREFIX,   ICMP_REDIRECT, RIP, OSPF, BGP,   ZEBRA, MANET, MANET2, DYMO,   AODV }
	Specifies where the route comes from. More...
enum	ChangeCodes {   F_DESTINATION, F_PREFIX_LENGTH, F_NEXTHOP, F_IFACE,   F_SOURCE, F_TYPE, F_ADMINDIST, F_METRIC,   F_EXPIRYTIME, F_LAST }
	Field codes for NB_ROUTE_CHANGED notifications. More...

Public Member Functions
	IPv6Route (IPv6Address destPrefix, int prefixLength, SourceType sourceType)
	Constructor. More...
virtual	~IPv6Route ()
virtual std::string	info () const override
virtual std::string	detailedInfo () const override
virtual void	setRoutingTable (IPv6RoutingTable *rt)
	To be called by the routing table when this route is added or removed from it. More...
IPv6RoutingTable *	getRoutingTable () const
void	setNextHop (const IPv6Address &nextHop)
void	setExpiryTime (simtime_t expiryTime)
void	setMetric (int metric) override
void	setAdminDist (unsigned int adminDist)
const IPv6Address &	getDestPrefix () const
virtual int	getPrefixLength () const override
	Represents length of prefix to match. More...
virtual SourceType	getSourceType () const override
	Source type of the route. More...
const IPv6Address &	getNextHop () const
simtime_t	getExpiryTime () const
virtual int	getMetric () const override
	Cost to reach the destination. More...
unsigned int	getAdminDist () const
virtual IRoutingTable *	getRoutingTableAsGeneric () const override
	The routing table in which this route is inserted, or nullptr. More...
virtual void	setDestination (const L3Address &dest) override
virtual void	setPrefixLength (int prefixLength) override
virtual void	setNextHop (const L3Address &nextHop) override
virtual void	setSource (cObject *source) override
virtual void	setSourceType (SourceType type) override
virtual L3Address	getDestinationAsGeneric () const override
	Destination address prefix to match. More...
virtual L3Address	getNextHopAsGeneric () const override
	Next hop address. More...
virtual InterfaceEntry *	getInterface () const override
	Next hop interface. More...
virtual void	setInterface (InterfaceEntry *ie) override
virtual cObject *	getSource () const override
	Source of route. More...
virtual cObject *	getProtocolData () const override
virtual void	setProtocolData (cObject *protocolData) override
Public Member Functions inherited from inet::IRoute
virtual	~IRoute ()
virtual void	setSourceType (SourceType type)=0

Protected Member Functions
void	changed (int fieldCode)
	Routing Protocol specific data. More...

Protected Attributes
IPv6RoutingTable *	_rt
IPv6Address	_destPrefix
short	_prefixLength
SourceType	_sourceType
InterfaceEntry *	_interfacePtr
IPv6Address	_nextHop
simtime_t	_expiryTime
int	_metric
unsigned int	_adminDist
cObject *	_source
cObject *	_protocolData
	Object identifying the source. More...

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

Detailed Description

Represents a route in the route table.

Routes with sourceType=ROUTER_ADVERTISEMENT represent on-link prefixes advertised by routers.

Member Enumeration Documentation

enum inet::IPv6Route::RouteAdminDist

Cisco like administrative distances (includes IPv4 protocols)

Enumerator
dDirectlyConnected
dStatic
dEIGRPSummary
dBGPExternal
dEIGRPInternal
dIGRP
dOSPF
dISIS
dRIP
dEGP
dODR
dEIGRPExternal
dBGPInternal
dDHCPlearned
dUnknown

                        {
        dDirectlyConnected = 0,
        dStatic = 1,
        dEIGRPSummary = 5,
        dBGPExternal = 20,
        dEIGRPInternal = 90,
        dIGRP = 100,
        dOSPF = 110,
        dISIS = 115,
        dRIP = 120,
        dEGP = 140,
        dODR = 160,
        dEIGRPExternal = 170,
        dBGPInternal = 200,
        dDHCPlearned = 254,
        dUnknown = 255
    };

Constructor & Destructor Documentation

inet::IPv6Route::IPv6Route ( IPv6Address  destPrefix, int  prefixLength, SourceType  sourceType  )

inline

Constructor.

The destination prefix and the route source is passed to the constructor and cannot be changed afterwards.

    {
        _rt = nullptr;
        _destPrefix = destPrefix;
        _prefixLength = prefixLength;
        _sourceType = sourceType;
        _interfacePtr = nullptr;
        _expiryTime = 0;
        _metric = 0;
        _adminDist = dUnknown;
        _source = nullptr;
        _protocolData = nullptr;
    }

virtual inet::IPv6Route::~IPv6Route ( )

inlinevirtual

{ delete _protocolData; }

Member Function Documentation

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

protected

Routing Protocol specific data.

{
    if (_rt)
        _rt->routeChanged(this, fieldCode);
}

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

overridevirtual

{
    return std::string();
}

unsigned int inet::IPv6Route::getAdminDist ( ) const

inline

Referenced by inet::IPv6RoutingTable::routeLessThan().

{ return _adminDist; }

virtual L3Address inet::IPv6Route::getDestinationAsGeneric ( ) const

inlineoverridevirtual

Destination address prefix to match.

Implements inet::IRoute.

{ return getDestPrefix(); }    //TODO rename IPv6 method

const IPv6Address& inet::IPv6Route::getDestPrefix ( ) const

inline

Referenced by info().

{ return _destPrefix; }

simtime_t inet::IPv6Route::getExpiryTime ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::determineNextHop(), inet::IPv6::determineOutputInterface(), and info().

{ return _expiryTime; }

virtual InterfaceEntry* inet::IPv6Route::getInterface ( ) const

inlineoverridevirtual

Next hop interface.

Implements inet::IRoute.

Referenced by inet::IPv6RoutingTable::deleteInterfaceRoutes(), inet::IPv6NeighbourDiscovery::determineNextHop(), inet::IPv6::determineOutputInterface(), and inet::IPv6RoutingTable::getOutputInterfaceForDestination().

{ return _interfacePtr; }

virtual int inet::IPv6Route::getMetric ( ) const

inlineoverridevirtual

Cost to reach the destination.

Implements inet::IRoute.

Referenced by inet::IPv6RoutingTable::routeLessThan().

{ return _metric; }

const IPv6Address& inet::IPv6Route::getNextHop ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::determineNextHop(), inet::IPv6::determineOutputInterface(), and info().

{ return _nextHop; }

virtual L3Address inet::IPv6Route::getNextHopAsGeneric ( ) const

inlineoverridevirtual

Next hop address.

Implements inet::IRoute.

Referenced by inet::IPv6RoutingTable::getNextHopForDestination().

{ return getNextHop(); }

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

inlineoverridevirtual

Represents length of prefix to match.

Implements inet::IRoute.

Referenced by info(), and inet::IPv6RoutingTable::routeLessThan().

{ return _prefixLength; }

virtual cObject* inet::IPv6Route::getProtocolData ( ) const

inlineoverridevirtual

Implements inet::IRoute.

{ return _protocolData; }

IPv6RoutingTable* inet::IPv6Route::getRoutingTable ( ) const

inline

Referenced by getRoutingTableAsGeneric(), inet::IPv6RoutingTable::internalAddRoute(), and inet::IPv6RoutingTable::internalRemoveRoute().

{ return _rt; }

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

overridevirtual

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

Implements inet::IRoute.

{
    return getRoutingTable();
}

virtual cObject* inet::IPv6Route::getSource ( ) const

inlineoverridevirtual

Source of route.

Implements inet::IRoute.

{ return _source; }

virtual SourceType inet::IPv6Route::getSourceType ( ) const

inlineoverridevirtual

Source type of the route.

Implements inet::IRoute.

Referenced by info().

{ return _sourceType; }

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

overridevirtual

Referenced by inet::operator<<().

{
    std::stringstream out;
    out << getDestPrefix() << "/" << getPrefixLength() << " --> ";
    out << "if:" << (_interfacePtr ? _interfacePtr->getName() : "*  ");
    out << " next hop:" << getNextHop();
    out << " " << IRoute::sourceTypeName(getSourceType());
    if (getExpiryTime() > 0)
        out << " exp:" << getExpiryTime();
    return out.str();
}

void inet::IPv6Route::setAdminDist ( unsigned int  adminDist )

inline

Referenced by inet::IPv6RoutingTable::addDefaultRoute(), inet::IPv6RoutingTable::addOrUpdateOnLinkPrefix(), inet::IPv6RoutingTable::addOrUpdateOwnAdvPrefix(), and inet::IPv6RoutingTable::addStaticRoute().

{ if (_adminDist != adminDist) { _adminDist = adminDist; changed(F_ADMINDIST); } }

virtual void inet::IPv6Route::setDestination ( const L3Address &  dest )

inlineoverridevirtual

Implements inet::IRoute.

{ if (_destPrefix != dest.toIPv6()) { _destPrefix = dest.toIPv6(); changed(F_DESTINATION); } }

void inet::IPv6Route::setExpiryTime ( simtime_t  expiryTime )

inline

Referenced by inet::IPv6RoutingTable::addDefaultRoute(), inet::IPv6RoutingTable::addOrUpdateOnLinkPrefix(), and inet::IPv6RoutingTable::addOrUpdateOwnAdvPrefix().

{ if (expiryTime != _expiryTime) { _expiryTime = expiryTime; changed(F_EXPIRYTIME); } }

virtual void inet::IPv6Route::setInterface ( InterfaceEntry *  ie )

inlineoverridevirtual

Implements inet::IRoute.

Referenced by inet::IPv6RoutingTable::addDefaultRoute(), inet::IPv6RoutingTable::addOrUpdateOnLinkPrefix(), inet::IPv6RoutingTable::addOrUpdateOwnAdvPrefix(), and inet::IPv6RoutingTable::addStaticRoute().

{ if (_interfacePtr != ie) { _interfacePtr = ie; changed(F_IFACE); } }

void inet::IPv6Route::setMetric ( int  metric )

inlineoverridevirtual

Implements inet::IRoute.

Referenced by inet::IPv6RoutingTable::addDefaultRoute(), inet::IPv6RoutingTable::addOrUpdateOnLinkPrefix(), inet::IPv6RoutingTable::addOrUpdateOwnAdvPrefix(), and inet::IPv6RoutingTable::addStaticRoute().

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

void inet::IPv6Route::setNextHop ( const IPv6Address &  nextHop )

inline

Referenced by inet::IPv6RoutingTable::addDefaultRoute(), and inet::IPv6RoutingTable::addStaticRoute().

{ if (_nextHop != nextHop) { _nextHop = nextHop; changed(F_NEXTHOP); } }

virtual void inet::IPv6Route::setNextHop ( const L3Address &  nextHop )

inlineoverridevirtual

Implements inet::IRoute.

{ if (_nextHop != nextHop.toIPv6()) { _nextHop = nextHop.toIPv6(); changed(F_NEXTHOP); } }

virtual void inet::IPv6Route::setPrefixLength ( int  prefixLength )

inlineoverridevirtual

Implements inet::IRoute.

{ if (_prefixLength != prefixLength) { _prefixLength = prefixLength; changed(F_PREFIX_LENGTH); } }

virtual void inet::IPv6Route::setProtocolData ( cObject *  protocolData )

inlineoverridevirtual

Implements inet::IRoute.

{ _protocolData = protocolData; }

virtual void inet::IPv6Route::setRoutingTable ( IPv6RoutingTable *  rt )

inlinevirtual

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

Referenced by inet::IPv6RoutingTable::internalAddRoute(), and inet::IPv6RoutingTable::internalRemoveRoute().

{ _rt = rt; }

virtual void inet::IPv6Route::setSource ( cObject *  source )

inlineoverridevirtual

Implements inet::IRoute.

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

virtual void inet::IPv6Route::setSourceType ( SourceType  type )

inlineoverridevirtual

{ if (_sourceType != type) { _sourceType = type; changed(F_TYPE); } }

Member Data Documentation

unsigned int inet::IPv6Route::_adminDist

protected

IPv6Address inet::IPv6Route::_destPrefix

protected

simtime_t inet::IPv6Route::_expiryTime

protected

InterfaceEntry* inet::IPv6Route::_interfacePtr

protected

Referenced by info().

int inet::IPv6Route::_metric

protected

IPv6Address inet::IPv6Route::_nextHop

protected

short inet::IPv6Route::_prefixLength

protected

cObject* inet::IPv6Route::_protocolData

protected

Object identifying the source.

IPv6RoutingTable* inet::IPv6Route::_rt

protected

Referenced by changed().

cObject* inet::IPv6Route::_source

protected

SourceType inet::IPv6Route::_sourceType

protected

---

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

• IPv6Route.h
• IPv6Route.cc