INET Framework for OMNeT++/OMNEST
inet::eigrp::EigrpNeighbor< IPAddress > Class Template Reference

Class represents one entry in EIGRP Neighbor Table. More...

#include <EigrpNeighbor.h>

Inheritance diagram for inet::eigrp::EigrpNeighbor< IPAddress >:

Public Member Functions

virtual ~EigrpNeighbor ()
 
 EigrpNeighbor (int ifaceId, const char *ifaceNname, IPAddress ipAddress)
 
void setStateUp (bool stateUp)
 
void setHoldInt (int holdInt)
 
void setHoldTimer (EigrpTimer *holdt)
 Sets timer for a neighbor. More...
 
void setNeighborId (int neighborId)
 
void setSeqNumber (int seqNumber)
 
void setAck (uint32_t waitForAck)
 
void setRoutesForDeletion (bool routesForDeletion)
 
void setStubConf (const EigrpStub &stubConf)
 
void setStubEnable (bool stubEnabled)
 
IPAddress getIPAddress () const
 
int getIfaceId () const
 
bool isStateUp () const
 
int getHoldInt () const
 
EigrpTimergetHoldTimer () const
 
int getNeighborId () const
 
int getSeqNumber () const
 
uint32_t getAck () const
 
bool getRoutesForDeletion () const
 
EigrpStub getStubConf () const
 
bool isStubEnabled () const
 
const char * getIfaceName () const
 

Static Public Attributes

static const int UNSPEC_ID = 0
 

Protected Attributes

int ifaceId
 ID of interface that is connected to the neighbor. More...
 
const char * ifaceName
 
int neighborId
 ID of neighbor. More...
 
IPAddress ipAddress
 IP address of neighbor. More...
 
bool isUp
 State of neighbor. More...
 
int holdInt
 Neighbor's Hold interval used to set Hold timer. More...
 
uint32_t seqNumber
 Sequence number received from neighbor. More...
 
bool routesForDeletion
 After receiving Ack from the neighbor will be removed unreachable routes from TT. More...
 
uint32_t waitForAck
 Waiting for ack number from neighbor (for reliable transport) More...
 
EigrpTimerholdt
 Pointer to Hold timer. More...
 
bool stubEnabled
 Neighbor is a stub. More...
 
EigrpStub stubConf
 Neighbor's stub configuration. More...
 

Detailed Description

template<typename IPAddress>
class inet::eigrp::EigrpNeighbor< IPAddress >

Class represents one entry in EIGRP Neighbor Table.

Constructor & Destructor Documentation

◆ ~EigrpNeighbor()

template<typename IPAddress >
virtual inet::eigrp::EigrpNeighbor< IPAddress >::~EigrpNeighbor ( )
inlinevirtual
52 { delete holdt; }

◆ EigrpNeighbor()

template<typename IPAddress >
inet::eigrp::EigrpNeighbor< IPAddress >::EigrpNeighbor ( int  ifaceId,
const char *  ifaceNname,
IPAddress  ipAddress 
)
inline
53  :
54  ifaceId(ifaceId), ifaceName(ifaceNname), neighborId(UNSPEC_ID), ipAddress(ipAddress), isUp(false), holdt(nullptr)
55  { seqNumber = 0; holdInt = 0; routesForDeletion = false; waitForAck = 0; stubEnabled = false; }

Member Function Documentation

◆ getAck()

template<typename IPAddress >
uint32_t inet::eigrp::EigrpNeighbor< IPAddress >::getAck ( ) const
inline

◆ getHoldInt()

◆ getHoldTimer()

◆ getIfaceId()

◆ getIfaceName()

template<typename IPAddress >
const char* inet::eigrp::EigrpNeighbor< IPAddress >::getIfaceName ( ) const
inline

◆ getIPAddress()

◆ getNeighborId()

◆ getRoutesForDeletion()

template<typename IPAddress >
bool inet::eigrp::EigrpNeighbor< IPAddress >::getRoutesForDeletion ( ) const
inline

◆ getSeqNumber()

template<typename IPAddress >
int inet::eigrp::EigrpNeighbor< IPAddress >::getSeqNumber ( ) const
inline

◆ getStubConf()

template<typename IPAddress >
EigrpStub inet::eigrp::EigrpNeighbor< IPAddress >::getStubConf ( ) const
inline
79 { return this->stubConf; }

◆ isStateUp()

◆ isStubEnabled()

◆ setAck()

template<typename IPAddress >
void inet::eigrp::EigrpNeighbor< IPAddress >::setAck ( uint32_t  waitForAck)
inline

◆ setHoldInt()

◆ setHoldTimer()

template<typename IPAddress >
void inet::eigrp::EigrpNeighbor< IPAddress >::setHoldTimer ( EigrpTimer holdt)
inline

Sets timer for a neighbor.

62 { ASSERT(this->holdt == nullptr); this->holdt = holdt; }

Referenced by inet::eigrp::EigrpIpv4Pdm::createNeighbor(), and inet::eigrp::EigrpIpv6Pdm::createNeighbor().

◆ setNeighborId()

template<typename IPAddress >
void inet::eigrp::EigrpNeighbor< IPAddress >::setNeighborId ( int  neighborId)
inline

◆ setRoutesForDeletion()

◆ setSeqNumber()

template<typename IPAddress >
void inet::eigrp::EigrpNeighbor< IPAddress >::setSeqNumber ( int  seqNumber)
inline

◆ setStateUp()

◆ setStubConf()

template<typename IPAddress >
void inet::eigrp::EigrpNeighbor< IPAddress >::setStubConf ( const EigrpStub stubConf)
inline

◆ setStubEnable()

template<typename IPAddress >
void inet::eigrp::EigrpNeighbor< IPAddress >::setStubEnable ( bool  stubEnabled)
inline

Member Data Documentation

◆ holdInt

template<typename IPAddress >
int inet::eigrp::EigrpNeighbor< IPAddress >::holdInt
protected

◆ holdt

◆ ifaceId

template<typename IPAddress >
int inet::eigrp::EigrpNeighbor< IPAddress >::ifaceId
protected

ID of interface that is connected to the neighbor.

Referenced by inet::eigrp::EigrpNeighbor< IPAddress >::getIfaceId().

◆ ifaceName

template<typename IPAddress >
const char* inet::eigrp::EigrpNeighbor< IPAddress >::ifaceName
protected

◆ ipAddress

template<typename IPAddress >
IPAddress inet::eigrp::EigrpNeighbor< IPAddress >::ipAddress
protected

IP address of neighbor.

Referenced by inet::eigrp::EigrpNeighbor< IPAddress >::getIPAddress().

◆ isUp

template<typename IPAddress >
bool inet::eigrp::EigrpNeighbor< IPAddress >::isUp
protected

State of neighbor.

Possible states are pending or up.

Referenced by inet::eigrp::EigrpNeighbor< IPAddress >::isStateUp().

◆ neighborId

template<typename IPAddress >
int inet::eigrp::EigrpNeighbor< IPAddress >::neighborId
protected

◆ routesForDeletion

template<typename IPAddress >
bool inet::eigrp::EigrpNeighbor< IPAddress >::routesForDeletion
protected

◆ seqNumber

template<typename IPAddress >
uint32_t inet::eigrp::EigrpNeighbor< IPAddress >::seqNumber
protected

◆ stubConf

template<typename IPAddress >
EigrpStub inet::eigrp::EigrpNeighbor< IPAddress >::stubConf
protected

◆ stubEnabled

◆ UNSPEC_ID

template<typename IPAddress >
const int inet::eigrp::EigrpNeighbor< IPAddress >::UNSPEC_ID = 0
static

◆ waitForAck

template<typename IPAddress >
uint32_t inet::eigrp::EigrpNeighbor< IPAddress >::waitForAck
protected

The documentation for this class was generated from the following file:
inet::eigrp::EigrpNeighbor::holdInt
int holdInt
Neighbor's Hold interval used to set Hold timer.
Definition: EigrpNeighbor.h:41
inet::eigrp::EigrpNeighbor::UNSPEC_ID
static const int UNSPEC_ID
Definition: EigrpNeighbor.h:50
inet::eigrp::EigrpNeighbor::neighborId
int neighborId
ID of neighbor.
Definition: EigrpNeighbor.h:37
inet::eigrp::EigrpNeighbor::holdt
EigrpTimer * holdt
Pointer to Hold timer.
Definition: EigrpNeighbor.h:45
inet::eigrp::EigrpNeighbor::ifaceId
int ifaceId
ID of interface that is connected to the neighbor.
Definition: EigrpNeighbor.h:35
inet::eigrp::EigrpNeighbor::isUp
bool isUp
State of neighbor.
Definition: EigrpNeighbor.h:40
inet::eigrp::EigrpNeighbor::ifaceName
const char * ifaceName
Definition: EigrpNeighbor.h:36
inet::eigrp::EigrpNeighbor::stubEnabled
bool stubEnabled
Neighbor is a stub.
Definition: EigrpNeighbor.h:46
inet::eigrp::EigrpNeighbor::seqNumber
uint32_t seqNumber
Sequence number received from neighbor.
Definition: EigrpNeighbor.h:42
inet::eigrp::EigrpNeighbor::stubConf
EigrpStub stubConf
Neighbor's stub configuration.
Definition: EigrpNeighbor.h:47
inet::eigrp::EigrpNeighbor::waitForAck
uint32_t waitForAck
Waiting for ack number from neighbor (for reliable transport)
Definition: EigrpNeighbor.h:44
inet::eigrp::EigrpNeighbor::routesForDeletion
bool routesForDeletion
After receiving Ack from the neighbor will be removed unreachable routes from TT.
Definition: EigrpNeighbor.h:43
inet::eigrp::EigrpNeighbor::ipAddress
IPAddress ipAddress
IP address of neighbor.
Definition: EigrpNeighbor.h:38