This class represents a Thread Router. More...

#include <src/core/thread/topology.hpp>

Inheritance diagram for ot::Router:

Public Member Functions
uint8_t	GetNextHop (void) const
	This method gets the router ID of the next hop to this router. More...

void	SetNextHop (uint8_t aRouterId)
	This method sets the router ID of the next hop to this router. More...

uint8_t	GetLinkQualityOut (void) const
	This method gets the link quality out value for this router. More...

void	SetLinkQualityOut (uint8_t aLinkQuality)
	This method sets the link quality out value for this router. More...

uint8_t	GetCost (void) const
	This method get the route cost to this router. More...

void	SetCost (uint8_t aCost)
	This method sets the router cost to this router. More...

bool	IsAllocated (void) const
	This method indicates whether or not this router ID has been allocated. More...

void	SetAllocated (bool aAllocated)
	This method sets whether or not this router ID has been allocated. More...

bool	IsReclaimDelay (void) const
	This method indicates whether the reclaim delay is in effect for this router ID. More...

void	SetReclaimDelay (bool aReclaimDelay)
	This method sets whether the reclaim delay is in effect for this router ID. More...

Public Member Functions inherited from ot::Neighbor
State	GetState (void) const
	This method returns the current state. More...

void	SetState (State aState)
	This method sets the current state. More...

bool	IsStateRestoring (void) const
	Check if the neighbor/child is being restored. More...

bool	IsStateValidOrRestoring (void) const
	Check if the neighbor/child is in valid state or if it is being restored. More...

uint8_t	GetDeviceMode (void) const
	This method gets the device mode flags. More...

void	SetDeviceMode (uint8_t aMode)
	This method sets the device mode flags. More...

bool	IsRxOnWhenIdle (void) const
	This method indicates whether or not the device is rx-on-when-idle. More...

bool	IsFullThreadDevice (void) const
	This method indicates whether or not the device is a Full Thread Device. More...

bool	IsSecureDataRequest (void) const
	This method indicates whether or not the device uses secure IEEE 802.15.4 Data Request messages. More...

bool	IsFullNetworkData (void) const
	This method indicates whether or not the device requests Full Network Data. More...

void	ClearExtAddress (void)
	This method sets all bytes of the Extended Address to zero.

Mac::ExtAddress &	GetExtAddress (void)
	This method returns the Extended Address. More...

const Mac::ExtAddress &	GetExtAddress (void) const
	This method returns the Extended Address. More...

void	SetExtAddress (const Mac::ExtAddress &aAddress)
	This method sets the Extended Address. More...

uint32_t	GetKeySequence (void) const
	This method gets the key sequence value. More...

void	SetKeySequence (uint32_t aKeySequence)
	This method sets the key sequence value. More...

uint32_t	GetLastHeard (void) const
	This method returns the last heard time. More...

void	SetLastHeard (uint32_t aLastHeard)
	This method sets the last heard time. More...

uint32_t	GetLinkFrameCounter (void) const
	This method gets the link frame counter value. More...

void	SetLinkFrameCounter (uint32_t aFrameCounter)
	This method sets the link frame counter value. More...

uint32_t	GetMleFrameCounter (void) const
	This method gets the MLE frame counter value. More...

void	SetMleFrameCounter (uint32_t aFrameCounter)
	This method sets the MLE frame counter value. More...

uint16_t	GetRloc16 (void) const
	This method gets the RLOC16 value. More...

void	SetRloc16 (uint16_t aRloc16)
	This method sets the RLOC16 value. More...

bool	IsDataRequestPending (void) const
	This method indicates whether an IEEE 802.15.4 Data Request message was received. More...

void	SetDataRequestPending (bool aPending)
	This method sets the indicator for whether an IEEE 802.15.4 Data Request message was received. More...

uint8_t	GetLinkFailures (void) const
	This method gets the number of consecutive link failures. More...

void	IncrementLinkFailures (void)
	This method increments the number of consecutive link failures.

void	ResetLinkFailures (void)
	This method resets the number of consecutive link failures to zero.

LinkQualityInfo &	GetLinkInfo (void)
	This method returns the LinkQualityInfo object. More...

void	GenerateChallenge (void)
	This method generates a new challenge value for MLE Link Request/Response exchanges.

const uint8_t *	GetChallenge (void) const
	This method returns the current challenge value for MLE Link Request/Response exchanges. More...

uint8_t	GetChallengeSize (void) const
	This method returns the size (bytes) of the challenge value for MLE Link Request/Response exchanges. More...

Additional Inherited Members
Public Types inherited from ot::Neighbor
enum	State { kStateInvalid, kStateRestored, kStateParentRequest, kStateChildIdRequest, kStateLinkRequest, kStateChildUpdateRequest, kStateValid }
	Neighbor link states. More...

Detailed Description

This class represents a Thread Router.

Member Function Documentation

§ GetCost()

uint8_t ot::Router::GetCost ( void ) const

inline

This method get the route cost to this router.

Returns: The route cost to this router.

§ GetLinkQualityOut()

uint8_t ot::Router::GetLinkQualityOut ( void ) const

inline

This method gets the link quality out value for this router.

Returns: The link quality out value for this router.

§ GetNextHop()

uint8_t ot::Router::GetNextHop ( void ) const

inline

This method gets the router ID of the next hop to this router.

Returns: The router ID of the next hop to this router.

§ IsAllocated()

bool ot::Router::IsAllocated ( void ) const

inline

This method indicates whether or not this router ID has been allocated.

Returns: TRUE if this router ID has been allocated, FALSE otherwise.

§ IsReclaimDelay()

bool ot::Router::IsReclaimDelay ( void ) const

inline

This method indicates whether the reclaim delay is in effect for this router ID.

Returns: TRUE if the reclaim delay is in effect, FALSE otherwise.

§ SetAllocated()

void ot::Router::SetAllocated ( bool aAllocated )

inline

This method sets whether or not this router ID has been allocated.

Parameters

[in] aAllocated TRUE if this router ID has been allocated, FALSE otherwise.

§ SetCost()

void ot::Router::SetCost ( uint8_t aCost )

inline

This method sets the router cost to this router.

Parameters

[in] aCost The router cost to this router.

§ SetLinkQualityOut()

void ot::Router::SetLinkQualityOut ( uint8_t aLinkQuality )

inline

This method sets the link quality out value for this router.

Parameters

[in] aLinkQuality The link quality out value for this router.

§ SetNextHop()

void ot::Router::SetNextHop ( uint8_t aRouterId )

inline

This method sets the router ID of the next hop to this router.

Parameters

[in] aRouterId The router ID of the next hop to this router.

§ SetReclaimDelay()

void ot::Router::SetReclaimDelay ( bool aReclaimDelay )

inline

This method sets whether the reclaim delay is in effect for this router ID.

Parameters

[in] aReclaimDelay TRUE if the reclaim delay is in effect, FALSE otherwise.

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

src/core/thread/topology.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

§ GetCost()

§ GetLinkQualityOut()

§ GetNextHop()

§ IsAllocated()

§ IsReclaimDelay()

§ SetAllocated()

§ SetCost()

§ SetLinkQualityOut()

§ SetNextHop()

§ SetReclaimDelay()