inet::GenericRoute Class Reference

A generic route that uses generic addresses as destination and next hop. More...

#include <GenericRoute.h>

Inheritance diagram for inet::GenericRoute:

Public Member Functions
	GenericRoute ()
virtual	~GenericRoute ()
virtual std::string	info () const override
virtual std::string	detailedInfo () const override
bool	equals (const IRoute &route) const
virtual void	setRoutingTable (GenericRoutingTable *owner)
virtual void	setDestination (const L3Address &dest) override
virtual void	setPrefixLength (int l) override
virtual void	setNextHop (const L3Address &nextHop) override
virtual void	setInterface (InterfaceEntry *ie) override
virtual void	setSourceType (SourceType sourceType) override
virtual void	setSource (cObject *source) override
virtual void	setMetric (int metric) override
virtual void	setProtocolData (cObject *protocolData) override
virtual IRoutingTable *	getRoutingTableAsGeneric () const override
	The routing table in which this route is inserted, or nullptr. More...
virtual L3Address	getDestinationAsGeneric () const override
	Destination address prefix to match. More...
virtual int	getPrefixLength () const override
	Represents length of prefix to match. More...
virtual L3Address	getNextHopAsGeneric () const override
	Next hop address. More...
virtual InterfaceEntry *	getInterface () const override
	Next hop interface. More...
SourceType	getSourceType () const override
	Source type of the route. More...
virtual cObject *	getSource () const override
	Source of route. More...
virtual int	getMetric () const override
	Cost to reach the destination. More...
virtual cObject *	getProtocolData () const override
Public Member Functions inherited from inet::IRoute
virtual	~IRoute ()

Protected Member Functions
void	changed (int fieldCode)

Private Attributes
GenericRoutingTable *	owner
int	prefixLength
L3Address	destination
L3Address	nextHop
InterfaceEntry *	interface
SourceType	sourceType
cObject *	source
cObject *	protocolData
int	metric

Additional Inherited Members
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...
Static Public Member Functions inherited from inet::IRoute
static const char *	sourceTypeName (SourceType sourceType)

Detailed Description

A generic route that uses generic addresses as destination and next hop.

Constructor & Destructor Documentation

inet::GenericRoute::GenericRoute ( )

inline

                   : owner(nullptr), prefixLength(0), interface(nullptr), sourceType(IRoute::MANUAL),
        source(nullptr), protocolData(nullptr), metric(0) {}

virtual inet::GenericRoute::~GenericRoute ( )

inlinevirtual

{ delete protocolData; }

Member Function Documentation

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

protected

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

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

overridevirtual

{
    return "";    //TODO
}

bool inet::GenericRoute::equals

(

const IRoute &

route

)

const

{
    return false;    //TODO
}

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

inlineoverridevirtual

Destination address prefix to match.

Implements inet::IRoute.

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

{ return destination; }

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

inlineoverridevirtual

Next hop interface.

Implements inet::IRoute.

Referenced by inet::GenericRoutingTable::addRoute(), and inet::GenericNetworkProtocol::routePacket().

{ return interface; }

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

inlineoverridevirtual

Cost to reach the destination.

Implements inet::IRoute.

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

{ return metric; }

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

inlineoverridevirtual

Next hop address.

Implements inet::IRoute.

Referenced by inet::GenericNetworkProtocol::routePacket().

{ return nextHop; }

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

inlineoverridevirtual

Represents length of prefix to match.

Implements inet::IRoute.

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

{ return prefixLength; }

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

inlineoverridevirtual

Implements inet::IRoute.

{ return protocolData; }

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

overridevirtual

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

Implements inet::IRoute.

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

{
    return owner;
}

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

inlineoverridevirtual

Source of route.

Implements inet::IRoute.

{ return source; }

SourceType inet::GenericRoute::getSourceType ( ) const

inlineoverridevirtual

Source type of the route.

Implements inet::IRoute.

{ return sourceType; }

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

overridevirtual

Referenced by inet::GenericNetworkConfigurator::addStaticRoutes(), and inet::operator<<().

{
    std::stringstream out;

    out << "dest:";
    if (destination.isUnspecified())
        out << "*  ";
    else
        out << destination << "  ";
    out << "gw:";
    if (nextHop.isUnspecified())
        out << "*  ";
    else
        out << nextHop << "  ";
    out << "metric:" << metric << " ";
    out << "if:";
    if (!interface)
        out << "*";
    else
        out << interface->getName();
    if (interface && interface->getGenericNetworkProtocolData())
        out << "(" << interface->getGenericNetworkProtocolData()->getAddress() << ")";
    out << "  ";
    out << (nextHop.isUnspecified() ? "DIRECT" : "REMOTE");
    out << " " << IRoute::sourceTypeName(sourceType);

    return out.str();
}

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

inlineoverridevirtual

Implements inet::IRoute.

Referenced by inet::GenericNetworkConfigurator::addStaticRoutes().

{ if (destination != dest) { this->destination = dest; changed(F_DESTINATION); } }

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

inlineoverridevirtual

Implements inet::IRoute.

Referenced by inet::GenericNetworkConfigurator::addStaticRoutes().

{ if (interface != ie) { this->interface = ie; changed(F_IFACE); } }

virtual void inet::GenericRoute::setMetric ( int  metric )

inlineoverridevirtual

Implements inet::IRoute.

{ if (this->metric != metric) { this->metric = metric; changed(F_METRIC); } }

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

inlineoverridevirtual

Implements inet::IRoute.

Referenced by inet::GenericNetworkConfigurator::addStaticRoutes().

{ if (this->nextHop != nextHop) { this->nextHop = nextHop; changed(F_NEXTHOP); } }

virtual void inet::GenericRoute::setPrefixLength ( int  l )

inlineoverridevirtual

Implements inet::IRoute.

{ if (prefixLength != l) { this->prefixLength = l; changed(F_PREFIX_LENGTH); } }

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

inlineoverridevirtual

Implements inet::IRoute.

{ this->protocolData = protocolData; }

virtual void inet::GenericRoute::setRoutingTable ( GenericRoutingTable *  owner )

inlinevirtual

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

{ this->owner = owner; }

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

inlineoverridevirtual

Implements inet::IRoute.

{ if (this->source != source) { this->source = source; changed(F_SOURCE); } }

virtual void inet::GenericRoute::setSourceType ( SourceType  sourceType )

inlineoverridevirtual

Implements inet::IRoute.

Referenced by inet::GenericNetworkConfigurator::addStaticRoutes().

{ if (this->sourceType != sourceType) { this->sourceType = sourceType; changed(F_TYPE); } }

Member Data Documentation

L3Address inet::GenericRoute::destination

private

Referenced by info().

InterfaceEntry* inet::GenericRoute::interface

private

Referenced by info().

int inet::GenericRoute::metric

private

Referenced by info().

L3Address inet::GenericRoute::nextHop

private

Referenced by info().

GenericRoutingTable* inet::GenericRoute::owner

private

Referenced by changed(), and getRoutingTableAsGeneric().

int inet::GenericRoute::prefixLength

private

cObject* inet::GenericRoute::protocolData

private

cObject* inet::GenericRoute::source

private

SourceType inet::GenericRoute::sourceType

private

Referenced by info().

---

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

• GenericRoute.h
• GenericRoute.cc