A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::RipRoutingTableEntry Class Reference

Rip Routing Table Entry. More...

#include "rip.h"

+ Inheritance diagram for ns3::RipRoutingTableEntry:
+ Collaboration diagram for ns3::RipRoutingTableEntry:

Public Types

enum  Status_e { RIP_VALID , RIP_INVALID }
 Route status. More...
 

Public Member Functions

 RipRoutingTableEntry ()
 
 RipRoutingTableEntry (Ipv4Address network, Ipv4Mask networkPrefix, Ipv4Address nextHop, uint32_t interface)
 Constructor.
 
 RipRoutingTableEntry (Ipv4Address network, Ipv4Mask networkPrefix, uint32_t interface)
 Constructor.
 
virtual ~RipRoutingTableEntry ()
 
uint8_t GetRouteMetric () const
 Get the route metric.
 
Status_e GetRouteStatus () const
 Get the route status.
 
uint16_t GetRouteTag () const
 Get the route tag.
 
bool IsRouteChanged () const
 Get the route changed status.
 
void SetRouteChanged (bool changed)
 Set the route as changed.
 
void SetRouteMetric (uint8_t routeMetric)
 Set the route metric.
 
void SetRouteStatus (Status_e status)
 Set the route status.
 
void SetRouteTag (uint16_t routeTag)
 Set the route tag.
 
- Public Member Functions inherited from ns3::Ipv4RoutingTableEntry
 Ipv4RoutingTableEntry ()
 This constructor does nothing.
 
 Ipv4RoutingTableEntry (const Ipv4RoutingTableEntry &route)
 Copy Constructor.
 
 Ipv4RoutingTableEntry (const Ipv4RoutingTableEntry *route)
 Copy Constructor.
 
Ipv4Address GetDest () const
 
Ipv4Address GetDestNetwork () const
 
Ipv4Mask GetDestNetworkMask () const
 
Ipv4Address GetGateway () const
 
uint32_t GetInterface () const
 
bool IsDefault () const
 
bool IsGateway () const
 
bool IsHost () const
 
bool IsNetwork () const
 

Private Attributes

bool m_changed
 route has been updated
 
uint8_t m_metric
 route metric
 
Status_e m_status
 route status
 
uint16_t m_tag
 route tag
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::Ipv4RoutingTableEntry
static Ipv4RoutingTableEntry CreateDefaultRoute (Ipv4Address nextHop, uint32_t interface)
 
static Ipv4RoutingTableEntry CreateHostRouteTo (Ipv4Address dest, Ipv4Address nextHop, uint32_t interface)
 
static Ipv4RoutingTableEntry CreateHostRouteTo (Ipv4Address dest, uint32_t interface)
 
static Ipv4RoutingTableEntry CreateNetworkRouteTo (Ipv4Address network, Ipv4Mask networkMask, Ipv4Address nextHop, uint32_t interface)
 
static Ipv4RoutingTableEntry CreateNetworkRouteTo (Ipv4Address network, Ipv4Mask networkMask, uint32_t interface)
 

Detailed Description

Rip Routing Table Entry.

Definition at line 64 of file rip.h.

Member Enumeration Documentation

◆ Status_e

Route status.

Enumerator
RIP_VALID 
RIP_INVALID 

Definition at line 70 of file rip.h.

Constructor & Destructor Documentation

◆ RipRoutingTableEntry() [1/3]

ns3::RipRoutingTableEntry::RipRoutingTableEntry ( )

Definition at line 1409 of file rip.cc.

◆ RipRoutingTableEntry() [2/3]

ns3::RipRoutingTableEntry::RipRoutingTableEntry ( Ipv4Address  network,
Ipv4Mask  networkPrefix,
Ipv4Address  nextHop,
uint32_t  interface 
)

Constructor.

Parameters
networknetwork address
networkPrefixnetwork prefix
nextHopnext hop address to route the packet
interfaceinterface index

Definition at line 1417 of file rip.cc.

◆ RipRoutingTableEntry() [3/3]

ns3::RipRoutingTableEntry::RipRoutingTableEntry ( Ipv4Address  network,
Ipv4Mask  networkPrefix,
uint32_t  interface 
)

Constructor.

Parameters
networknetwork address
networkPrefixnetwork prefix
interfaceinterface index

Definition at line 1430 of file rip.cc.

◆ ~RipRoutingTableEntry()

ns3::RipRoutingTableEntry::~RipRoutingTableEntry ( )
virtual

Definition at line 1442 of file rip.cc.

Member Function Documentation

◆ GetRouteMetric()

uint8_t ns3::RipRoutingTableEntry::GetRouteMetric ( ) const

Get the route metric.

Returns
the route metric

Definition at line 1473 of file rip.cc.

References m_metric.

Referenced by ns3::operator<<(), and ns3::Rip::PrintRoutingTable().

+ Here is the caller graph for this function:

◆ GetRouteStatus()

RipRoutingTableEntry::Status_e ns3::RipRoutingTableEntry::GetRouteStatus ( ) const

Get the route status.

Returns
the route status

Definition at line 1489 of file rip.cc.

References m_status.

Referenced by ns3::Rip::Lookup(), and ns3::Rip::PrintRoutingTable().

+ Here is the caller graph for this function:

◆ GetRouteTag()

uint16_t ns3::RipRoutingTableEntry::GetRouteTag ( ) const

Get the route tag.

Returns
the route tag

Definition at line 1457 of file rip.cc.

References m_tag.

Referenced by ns3::operator<<().

+ Here is the caller graph for this function:

◆ IsRouteChanged()

bool ns3::RipRoutingTableEntry::IsRouteChanged ( ) const

Get the route changed status.

Returns
true if route is changed

Definition at line 1501 of file rip.cc.

References m_changed.

◆ SetRouteChanged()

void ns3::RipRoutingTableEntry::SetRouteChanged ( bool  changed)

Set the route as changed.

The changed routes are scheduled for a Triggered Update. After a Triggered Update, all the changed flags are cleared from the routing table.

Parameters
changedtrue if route is changed

Definition at line 1495 of file rip.cc.

References m_changed.

Referenced by ns3::Rip::InvalidateRoute().

+ Here is the caller graph for this function:

◆ SetRouteMetric()

void ns3::RipRoutingTableEntry::SetRouteMetric ( uint8_t  routeMetric)

Set the route metric.

Parameters
routeMetricthe route metric

Definition at line 1463 of file rip.cc.

References m_changed, and m_metric.

Referenced by ns3::Rip::InvalidateRoute().

+ Here is the caller graph for this function:

◆ SetRouteStatus()

void ns3::RipRoutingTableEntry::SetRouteStatus ( Status_e  status)

Set the route status.

Parameters
statusthe route status

Definition at line 1479 of file rip.cc.

References m_changed, and m_status.

Referenced by ns3::Rip::InvalidateRoute().

+ Here is the caller graph for this function:

◆ SetRouteTag()

void ns3::RipRoutingTableEntry::SetRouteTag ( uint16_t  routeTag)

Set the route tag.

Parameters
routeTagthe route tag

Definition at line 1447 of file rip.cc.

References m_changed, and m_tag.

Member Data Documentation

◆ m_changed

bool ns3::RipRoutingTableEntry::m_changed
private

route has been updated

Definition at line 158 of file rip.h.

Referenced by IsRouteChanged(), SetRouteChanged(), SetRouteMetric(), SetRouteStatus(), and SetRouteTag().

◆ m_metric

uint8_t ns3::RipRoutingTableEntry::m_metric
private

route metric

Definition at line 156 of file rip.h.

Referenced by GetRouteMetric(), and SetRouteMetric().

◆ m_status

Status_e ns3::RipRoutingTableEntry::m_status
private

route status

Definition at line 157 of file rip.h.

Referenced by GetRouteStatus(), and SetRouteStatus().

◆ m_tag

uint16_t ns3::RipRoutingTableEntry::m_tag
private

route tag

Definition at line 155 of file rip.h.

Referenced by GetRouteTag(), and SetRouteTag().


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