C++ interface for accessing unicast routing table entries of various protocols (IPv4, IPv6, etc) in a uniform way. More...

#include <IRoute.h>

Inheritance diagram for inet::IRoute:

Public Types
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
virtual	~IRoute ()

virtual IRoutingTable *	getRoutingTableAsGeneric () const =0
	The routing table in which this route is inserted, or nullptr. More...

virtual void	setDestination (const L3Address &dest)=0

virtual void	setPrefixLength (int l)=0

virtual void	setNextHop (const L3Address &nextHop)=0

virtual void	setInterface (InterfaceEntry *ie)=0

virtual void	setSource (cObject *source)=0

virtual void	setSourceType (SourceType type)=0

virtual void	setMetric (int metric)=0

virtual L3Address	getDestinationAsGeneric () const =0
	Destination address prefix to match. More...

virtual int	getPrefixLength () const =0
	Represents length of prefix to match. More...

virtual L3Address	getNextHopAsGeneric () const =0
	Next hop address. More...

virtual InterfaceEntry *	getInterface () const =0
	Next hop interface. More...

virtual cObject *	getSource () const =0
	Source of route. More...

virtual SourceType	getSourceType () const =0
	Source type of the route. More...

virtual int	getMetric () const =0
	Cost to reach the destination. More...

virtual cObject *	getProtocolData () const =0

virtual void	setProtocolData (cObject *protocolData)=0

Static Public Member Functions
static const char *	sourceTypeName (SourceType sourceType)

Detailed Description

C++ interface for accessing unicast routing table entries of various protocols (IPv4, IPv6, etc) in a uniform way.

See also: IRoutingTable, IPv4Route, IPv6Route

Member Enumeration Documentation

enum inet::IRoute::ChangeCodes

Field codes for NB_ROUTE_CHANGED notifications.

Enumerator
F_DESTINATION
F_PREFIX_LENGTH
F_NEXTHOP
F_IFACE
F_SOURCE
F_TYPE
F_ADMINDIST
F_METRIC
F_EXPIRYTIME
F_LAST

                      {
         F_DESTINATION,
         F_PREFIX_LENGTH,
         F_NEXTHOP,
         F_IFACE,
         F_SOURCE,
         F_TYPE,
         F_ADMINDIST,
         F_METRIC,
         F_EXPIRYTIME,
         F_LAST
     };

enum inet::IRoute::SourceType

Specifies where the route comes from.

Enumerator
MANUAL	manually added static route
IFACENETMASK	comes from an interface's netmask
ROUTER_ADVERTISEMENT	on-link prefix, from Router Advertisement
OWN_ADV_PREFIX	on routers: on-link prefix that the router itself advertises on the link
ICMP_REDIRECT	ICMP redirect message.
RIP	managed by the given routing protocol
OSPF	managed by the given routing protocol
BGP	managed by the given routing protocol
ZEBRA	managed by the Quagga/Zebra based model
MANET	managed by manet, search exact address
MANET2	managed by manet, search approximate address
DYMO	managed by DYMO routing
AODV	managed by AODV routing

                     {
         MANUAL,    
         IFACENETMASK,    
         ROUTER_ADVERTISEMENT,    
         OWN_ADV_PREFIX,    
         ICMP_REDIRECT,    
         RIP,    
         OSPF,    
         BGP,    
         ZEBRA,    
         MANET,    
         MANET2,    
         DYMO,    
         AODV,    
     };

Constructor & Destructor Documentation

virtual inet::IRoute::~IRoute ( )

inlinevirtual

77 {}

Member Function Documentation

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

pure virtual

Destination address prefix to match.

Implemented in inet::IPv4Route, inet::IPv6Route, and inet::GenericRoute.

Referenced by inet::RIPRouting::configureInitialRoutes(), inet::AODVRouting::expungeRoutes(), inet::AODVRouting::handleLinkBreakSendRERR(), inet::AODVRouting::handleRERR(), inet::operator<<(), inet::dymo::DYMO::processRERR(), inet::RIPRouting::receiveSignal(), inet::RoutingTableRecorder::recordRouteChange(), inet::RIPRoute::RIPRoute(), inet::dymo::DYMO::sendRERRForBrokenLink(), and inet::dymo::DYMO::updateRoutes().

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

pure virtual

Next hop interface.

Implemented in inet::IPv6Route, inet::IPv4Route, and inet::GenericRoute.

Referenced by inet::GenericRoutingTable::getOutputInterfaceForDestination(), inet::operator<<(), inet::dymo::DYMO::processRERR(), inet::RIPRouting::receiveSignal(), inet::dymo::DYMO::receiveSignal(), inet::RIPRoute::RIPRoute(), inet::dymo::DYMO::sendRERRForBrokenLink(), and inet::dymo::DYMO::sendRREP().

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

pure virtual

Cost to reach the destination.

Implemented in inet::IPv4Route, inet::IPv6Route, and inet::GenericRoute.

Referenced by inet::AODVRouting::createGratuitousRREP(), inet::AODVRouting::createRREP(), inet::dymo::DYMO::createRREP(), inet::AODVRouting::ensureRouteForDatagram(), inet::AODVRouting::handleRREP(), inet::AODVRouting::handleRREQ(), inet::operator<<(), inet::AODVRouting::sendRREP(), and inet::dymo::DYMO::updateRoutes().

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

pure virtual

Next hop address.

Implemented in inet::IPv4Route, inet::IPv6Route, and inet::GenericRoute.

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

pure virtual

Represents length of prefix to match.

Implemented in inet::IPv4Route, inet::IPv6Route, and inet::GenericRoute.

Referenced by inet::RIPRouting::isDefaultRoute(), inet::operator<<(), inet::RIPRouting::receiveSignal(), inet::RoutingTableRecorder::recordRouteChange(), and inet::RIPRoute::RIPRoute().

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

pure virtual

Implemented in inet::IPv4Route, inet::IPv6Route, and inet::GenericRoute.

virtual IRoutingTable* inet::IRoute::getRoutingTableAsGeneric ( ) const

pure virtual

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

Implemented in inet::IPv4Route, inet::IPv6Route, and inet::GenericRoute.

Referenced by inet::RoutingTableRecorder::recordRouteChange().

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

pure virtual

Source of route.

Implemented in inet::IPv4Route, inet::IPv6Route, and inet::GenericRoute.

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

pure virtual

Source type of the route.

Implemented in inet::IPv4Route, inet::IPv6Route, and inet::GenericRoute.

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

pure virtual

Implemented in inet::IPv4Route, inet::IPv6Route, and inet::GenericRoute.

Referenced by inet::RIPRouting::addRoute(), inet::AODVRouting::createRoute(), and inet::dymo::DYMO::updateRoute().

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

pure virtual

Implemented in inet::IPv6Route, inet::IPv4Route, and inet::GenericRoute.

Referenced by inet::RIPRouting::addRoute(), inet::AODVRouting::createRoute(), inet::RIPRoute::setInterface(), and inet::dymo::DYMO::updateRoute().

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

pure virtual

Implemented in inet::IPv6Route, inet::IPv4Route, and inet::GenericRoute.

Referenced by inet::RIPRouting::addRoute(), inet::AODVRouting::createRoute(), inet::RIPRoute::setMetric(), inet::dymo::DYMO::updateRoute(), and inet::AODVRouting::updateRoutingTable().

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

pure virtual

Implemented in inet::IPv4Route, inet::IPv6Route, and inet::GenericRoute.

Referenced by inet::RIPRouting::addRoute(), inet::AODVRouting::createRoute(), inet::RIPRoute::setNextHop(), inet::dymo::DYMO::updateRoute(), and inet::AODVRouting::updateRoutingTable().

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

pure virtual

Implemented in inet::IPv4Route, inet::IPv6Route, and inet::GenericRoute.

Referenced by inet::RIPRouting::addRoute(), inet::AODVRouting::createRoute(), and inet::dymo::DYMO::updateRoute().

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

pure virtual

Implemented in inet::IPv4Route, inet::IPv6Route, and inet::GenericRoute.

Referenced by inet::AODVRouting::createRoute(), and inet::dymo::DYMO::createRoute().

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

pure virtual

Implemented in inet::IPv4Route, inet::IPv6Route, and inet::GenericRoute.

Referenced by inet::RIPRouting::addRoute(), inet::AODVRouting::createRoute(), and inet::dymo::DYMO::createRoute().

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

pure virtual

Implemented in inet::GenericRoute.

Referenced by inet::RIPRouting::addRoute(), inet::AODVRouting::createRoute(), and inet::dymo::DYMO::createRoute().

const char * inet::IRoute::sourceTypeName ( SourceType sourceType )

static

Referenced by inet::GenericRoute::info(), inet::IPv4Route::info(), and inet::IPv6Route::info().

 {
     switch (sourceType) {
         case MANUAL:
             return "MANUAL";
 
         case IFACENETMASK:
             return "IFACENETMASK";
 
         case ROUTER_ADVERTISEMENT:
             return "FROM_RA";
 
         case OWN_ADV_PREFIX:
             return "OWN_ADV_PREFIX";
 
         case ICMP_REDIRECT:
             return "REDIRECT";
 
         case RIP:
             return "RIP";
 
         case OSPF:
             return "OSPF";
 
         case BGP:
             return "BGP";
 
         case ZEBRA:
             return "ZEBRA";
 
         case MANET:
             return "MANET";
 
         case MANET2:
             return "MANET2";
 
         case DYMO:
             return "DYMO";
 
         case AODV:
             return "AODV";
 
         default:
             return "???";
     }
 }

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

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation