inet::RIPRoute Struct Reference

#include <RIPRouting.h>

Inheritance diagram for inet::RIPRoute:

Public Types
enum	RouteType {   RIP_ROUTE_RTE, RIP_ROUTE_STATIC, RIP_ROUTE_DEFAULT, RIP_ROUTE_REDISTRIBUTE,   RIP_ROUTE_INTERFACE }

Public Member Functions
	RIPRoute (IRoute *route, RouteType type, int metric, uint16 tag)
virtual std::string	info () const override
RouteType	getType () const
IRoute *	getRoute () const
L3Address	getDestination () const
int	getPrefixLength () const
L3Address	getNextHop () const
InterfaceEntry *	getInterface () const
L3Address	getFrom () const
int	getMetric () const
uint16	getRouteTag () const
bool	isChanged () const
simtime_t	getLastUpdateTime () const
void	setType (RouteType type)
void	setRoute (IRoute *route)
void	setDestination (const L3Address &dest)
void	setPrefixLength (int prefixLength)
void	setNextHop (const L3Address &nextHop)
void	setInterface (InterfaceEntry *ie)
void	setMetric (int metric)
void	setRouteTag (uint16 routeTag)
void	setFrom (const L3Address &from)
void	setChanged (bool changed)
void	setLastUpdateTime (simtime_t time)

Private Attributes
RouteType	type = (RouteType)-1
IRoute *	route = nullptr
L3Address	dest
int	prefixLength = 0
L3Address	nextHop
InterfaceEntry *	ie = nullptr
L3Address	from
int	metric = 0
uint16	tag = 0
bool	changed = false
simtime_t	lastUpdateTime

Member Enumeration Documentation

enum inet::RIPRoute::RouteType

Enumerator
RIP_ROUTE_RTE
RIP_ROUTE_STATIC
RIP_ROUTE_DEFAULT
RIP_ROUTE_REDISTRIBUTE
RIP_ROUTE_INTERFACE

                   {
        RIP_ROUTE_RTE,    // route learned from a RIPEntry
        RIP_ROUTE_STATIC,    // static route
        RIP_ROUTE_DEFAULT,    // default route
        RIP_ROUTE_REDISTRIBUTE,    // route imported from another routing protocol
        RIP_ROUTE_INTERFACE    // route belongs to a local interface
    };

Constructor & Destructor Documentation

inet::RIPRoute::RIPRoute	(	IRoute *	route,
		RouteType	type,
		int	metric,
		uint16	tag
	)

    : type(type), route(route), metric(metric), changed(false), lastUpdateTime(0)
{
    dest = route->getDestinationAsGeneric();
    prefixLength = route->getPrefixLength();
    nextHop = route->getNextHopAsGeneric();
    ie = route->getInterface();
    tag = routeTag;
}

Member Function Documentation

L3Address inet::RIPRoute::getDestination ( ) const

inline

Referenced by inet::RIPRouting::receiveSignal(), inet::RIPRouting::sendRoutes(), and inet::RIPRouting::updateRoute().

{ return dest; }

L3Address inet::RIPRoute::getFrom ( ) const

inline

Referenced by inet::RIPRouting::processResponse().

{ return from; }

InterfaceEntry* inet::RIPRoute::getInterface ( ) const

inline

Referenced by inet::RIPRouting::receiveSignal(), and inet::RIPRouting::sendRoutes().

{ return ie; }

simtime_t inet::RIPRoute::getLastUpdateTime ( ) const

inline

Referenced by inet::RIPRouting::checkRouteIsExpired().

{ return lastUpdateTime; }

int inet::RIPRoute::getMetric ( ) const

inline

Referenced by inet::RIPRouting::processRequest(), inet::RIPRouting::processResponse(), inet::RIPRouting::sendRoutes(), and inet::RIPRouting::updateRoute().

{ return metric; }

L3Address inet::RIPRoute::getNextHop ( ) const

inline

Referenced by inet::RIPRouting::receiveSignal().

{ return nextHop; }

int inet::RIPRoute::getPrefixLength ( ) const

inline

Referenced by inet::RIPRouting::receiveSignal(), inet::RIPRouting::sendRoutes(), and inet::RIPRouting::updateRoute().

{ return prefixLength; }

IRoute* inet::RIPRoute::getRoute ( ) const

inline

Referenced by inet::RIPRouting::invalidateRoute(), inet::RIPRouting::purgeRoute(), and inet::RIPRouting::updateRoute().

{ return route; }

uint16 inet::RIPRoute::getRouteTag ( ) const

inline

Referenced by inet::RIPRouting::sendRoutes().

{ return tag; }

RouteType inet::RIPRoute::getType ( ) const

inline

Referenced by inet::RIPRouting::checkRouteIsExpired(), inet::RIPRouting::processResponse(), and inet::RIPRouting::purgeRoute().

{ return type; }

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

overridevirtual

Referenced by inet::operator<<().

{
    std::stringstream out;

    out << "dest:";
    if (dest.isUnspecified())
        out << "*  ";
    else
        out << dest << "  ";
    out << "prefix:" << prefixLength << "  ";
    out << "gw:";
    if (nextHop.isUnspecified())
        out << "*  ";
    else
        out << nextHop << "  ";
    out << "metric:" << metric << " ";
    out << "if:";
    if (!ie)
        out << "*  ";
    else
        out << ie->getName() << "  ";
    out << "tag:" << tag << " ";
    out << "upd:" << lastUpdateTime << "s  ";
    switch (type) {
        case RIP_ROUTE_INTERFACE:
            out << "INTERFACE";
            break;

        case RIP_ROUTE_STATIC:
            out << "STATIC";
            break;

        case RIP_ROUTE_DEFAULT:
            out << "DEFAULT";
            break;

        case RIP_ROUTE_RTE:
            out << "RTE";
            break;

        case RIP_ROUTE_REDISTRIBUTE:
            out << "REDISTRIBUTE";
            break;
    }

    return out.str();
}

bool inet::RIPRoute::isChanged ( ) const

inline

Referenced by inet::RIPRouting::sendRoutes().

{ return changed; }

void inet::RIPRoute::setChanged ( bool  changed )

inline

Referenced by inet::RIPRouting::addRoute(), inet::RIPRouting::invalidateRoute(), inet::RIPRouting::receiveSignal(), and inet::RIPRouting::updateRoute().

{ this->changed = changed; }

void inet::RIPRoute::setDestination ( const L3Address &  dest )

inline

Referenced by inet::RIPRouting::receiveSignal().

{ this->dest = dest; }

void inet::RIPRoute::setFrom ( const L3Address &  from )

inline

Referenced by inet::RIPRouting::addRoute(), and inet::RIPRouting::updateRoute().

{ this->from = from; }

void inet::RIPRoute::setInterface ( InterfaceEntry *  ie )

inline

Referenced by inet::RIPRouting::importRoute(), inet::RIPRouting::receiveSignal(), and inet::RIPRouting::updateRoute().

{ this->ie = ie; if (route && type == RIP_ROUTE_RTE) route->setInterface(ie); }

void inet::RIPRoute::setLastUpdateTime ( simtime_t  time )

inline

Referenced by inet::RIPRouting::addRoute(), inet::RIPRouting::processResponse(), and inet::RIPRouting::updateRoute().

{ lastUpdateTime = time; }

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

inline

Referenced by inet::RIPRouting::invalidateRoute(), and inet::RIPRouting::updateRoute().

{ this->metric = metric; if (route && type == RIP_ROUTE_RTE) route->setMetric(metric); }

void inet::RIPRoute::setNextHop ( const L3Address &  nextHop )

inline

Referenced by inet::RIPRouting::receiveSignal(), and inet::RIPRouting::updateRoute().

{ this->nextHop = nextHop; if (route && type == RIP_ROUTE_RTE) route->setNextHop(nextHop); }

void inet::RIPRoute::setPrefixLength ( int  prefixLength )

inline

Referenced by inet::RIPRouting::receiveSignal().

{ this->prefixLength = prefixLength; }

void inet::RIPRoute::setRoute ( IRoute *  route )

inline

Referenced by inet::RIPRouting::invalidateRoute(), inet::RIPRouting::purgeRoute(), and inet::RIPRouting::updateRoute().

{ this->route = route; }

void inet::RIPRoute::setRouteTag ( uint16  routeTag )

inline

Referenced by inet::RIPRouting::updateRoute().

{ this->tag = routeTag; }

void inet::RIPRoute::setType ( RouteType  type )

inline

Referenced by inet::RIPRouting::updateRoute().

{ this->type = type; }

Member Data Documentation

bool inet::RIPRoute::changed = false

private

Referenced by isChanged(), and setChanged().

L3Address inet::RIPRoute::dest

private

Referenced by getDestination(), info(), inet::RIPRouting::numInitStages(), RIPRoute(), and setDestination().

L3Address inet::RIPRoute::from

private

Referenced by getFrom(), inet::RIPRouting::numInitStages(), and setFrom().

InterfaceEntry* inet::RIPRoute::ie = nullptr

private

Referenced by inet::RIPRouting::getHostName(), getInterface(), info(), RIPRoute(), and setInterface().

simtime_t inet::RIPRoute::lastUpdateTime

private

Referenced by getLastUpdateTime(), and info().

int inet::RIPRoute::metric = 0

private

Referenced by getMetric(), info(), inet::RIPRouting::numInitStages(), and setMetric().

L3Address inet::RIPRoute::nextHop

private

Referenced by getNextHop(), info(), inet::RIPRouting::numInitStages(), RIPRoute(), and setNextHop().

int inet::RIPRoute::prefixLength = 0

private

Referenced by getPrefixLength(), info(), inet::RIPRouting::numInitStages(), RIPRoute(), and setPrefixLength().

IRoute* inet::RIPRoute::route = nullptr

private

Referenced by getRoute(), inet::RIPRouting::numInitStages(), and setRoute().

uint16 inet::RIPRoute::tag = 0

private

Referenced by getRouteTag(), info(), and RIPRoute().

RouteType inet::RIPRoute::type = (RouteType)-1

private

Referenced by getType(), info(), inet::RIPRouting::numInitStages(), and setType().

---

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

• RIPRouting.h
• RIPRouting.cc