Symbols

Files

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::RouterTable

ot::RouterTable class

Syntax

Show:

Summary

Declaration

from router_table.hpp:52

class RouterTable : public InstanceLocator, private NonCopyable { friend class NeighborTable; public: explicit RouterTable(Instance &aInstance); void Clear(void); void ClearNeighbors(void); Router *Allocate(void); Router *Allocate(uint8_t aRouterId); Error Release(uint8_t aRouterId); void RemoveRouterLink(Router &aRouter); uint8_t GetActiveRouterCount(void) const { return mRouters.GetLength(); } Router *GetLeader(void) { return AsNonConst(AsConst(this)->GetLeader()); } const Router *GetLeader(void) const; uint32_t GetLeaderAge(void) const; uint8_t GetLinkCost(const Router &aRouter) const; uint8_t GetLinkCost(uint8_t aRouterId) const; uint8_t GetPathCost(uint16_t aDestRloc16) const; uint8_t GetPathCostToLeader(void) const; uint16_t GetNextHop(uint16_t aDestRloc16) const; void GetNextHopAndPathCost(uint16_t aDestRloc16, uint16_t &aNextHopRloc16, uint8_t &aPathCost) const; Router *FindRouterById(uint8_t aRouterId) { return AsNonConst(AsConst(this)->FindRouterById(aRouterId)); } const Router *FindRouterById(uint8_t aRouterId) const; Router *FindRouterByRloc16(uint16_t aRloc16) { return AsNonConst(AsConst(this)->FindRouterByRloc16(aRloc16)); } const Router *FindRouterByRloc16(uint16_t aRloc16) const; Router *FindNextHopOf(const Router &aRouter) { return AsNonConst(AsConst(this)->FindNextHopOf(aRouter)); } const Router *FindNextHopOf(const Router &aRouter) const; Router *FindRouter(const Mac::ExtAddress &aExtAddress); bool Contains(const Neighbor &aNeighbor) const { return mRouters.IsInArrayBuffer(&static_cast<const Router &>(aNeighbor)); } Error GetRouterInfo(uint16_t aRouterId, Router::Info &aRouterInfo); uint8_t GetRouterIdSequence(void) const { return mRouterIdSequence; } TimeMilli GetRouterIdSequenceLastUpdated(void) const { return mRouterIdSequenceLastUpdated; } bool IsRouteTlvIdSequenceMoreRecent(const Mle::RouteTlv &aRouteTlv) const; uint8_t GetNeighborCount(LinkQuality aLinkQuality) const; bool IsAllocated(uint8_t aRouterId) const { return mRouterIdMap.IsAllocated(aRouterId); } void UpdateRouterIdSet(uint8_t aRouterIdSequence, const Mle::RouterIdSet &aRouterIdSet); void UpdateRoutes(const Mle::RouteTlv &aRouteTlv, uint8_t aNeighborId); void UpdateRouterOnFtdChild(const Mle::RouteTlv &aRouteTlv, uint8_t aParentId); void GetRouterIdSet(Mle::RouterIdSet &aRouterIdSet) const { return mRouterIdMap.GetAsRouterIdSet(aRouterIdSet); } void FillRouteTlv(Mle::RouteTlv &aRouteTlv, const Neighbor *aNeighbor = nullptr) const; void HandleTimeTick(void); #if OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE void GetRouterIdRange(uint8_t &aMinRouterId, uint8_t &aMaxRouterId) const; Error SetRouterIdRange(uint8_t aMinRouterId, uint8_t aMaxRouterId); #endif Router *begin(void) { return mRouters.begin(); } Router *end(void) { return mRouters.end(); } const Router *begin(void) const { return mRouters.begin(); } const Router *end(void) const { return mRouters.end(); } private: static constexpr uint32_t kRouterIdSequencePeriod = 10; static constexpr uint8_t kLinkAcceptSequenceRollback = 64; #if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE static constexpr uint8_t kMaxRoutersInRouteTlvForLinkAccept = 3; #else static constexpr uint8_t kMaxRoutersInRouteTlvForLinkAccept = 20; #endif Router *AddRouter(uint8_t aRouterId); void RemoveRouter(Router &aRouter); Router *FindNeighbor(uint16_t aRloc16); Router *FindNeighbor(const Mac::ExtAddress &aExtAddress); Router *FindNeighbor(const Mac::Address &aMacAddress); const Router *FindRouter(const Router::AddressMatcher &aMatcher) const; Router *FindRouter(const Router::AddressMatcher &aMatcher) { return AsNonConst(AsConst(this)->FindRouter(aMatcher)); } void SignalTableChanged(void); void HandleTableChanged(void); void LogRouteTable(void) const; class RouterIdMap : public Clearable<RouterIdMap> { public: RouterIdMap(void) { Clear(); } bool IsAllocated(uint8_t aRouterId) const { return (mIndexes[aRouterId] & kAllocatedFlag); } uint8_t GetIndex(uint8_t aRouterId) const { return (mIndexes[aRouterId] & kIndexMask); } void SetIndex(uint8_t aRouterId, uint8_t aIndex) { mIndexes[aRouterId] = kAllocatedFlag | aIndex; } bool CanAllocate(uint8_t aRouterId) const { return (mIndexes[aRouterId] == 0); } void Release(uint8_t aRouterId) { mIndexes[aRouterId] = kReuseDelay; } void GetAsRouterIdSet(Mle::RouterIdSet &aRouterIdSet) const; void HandleTimeTick(void); private: static constexpr uint8_t kReuseDelay = 100; static constexpr uint8_t kAllocatedFlag = 1 << 7; static constexpr uint8_t kIndexMask = 0x7f; static_assert(kReuseDelay <= kIndexMask, "kReuseDelay does not fit in 7 bits"); uint8_t mIndexes[Mle::kMaxRouterId + 1]; }; using ChangedTask = TaskletIn<RouterTable, &RouterTable::HandleTableChanged>; Array<Router, Mle::kMaxRouters> mRouters; ChangedTask mChangedTask; RouterIdMap mRouterIdMap; TimeMilli mRouterIdSequenceLastUpdated; uint8_t mRouterIdSequence; #if OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE uint8_t mMinRouterId; uint8_t mMaxRouterId; #endif };

Fields

Field

Declared as

ot::RouterTable::kRouterIdSequencePeriod

ot::RouterTable::kLinkAcceptSequenceRollback

ot::RouterTable::kMaxRoutersInRouteTlvForLinkAccept

ot::RouterTable::mRouters

Array<Router, Mle::kMaxRouters>

ot::RouterTable::mChangedTask

ChangedTask

ot::RouterTable::mRouterIdMap

RouterIdMap

ot::RouterTable::mRouterIdSequenceLastUpdated

TimeMilli

ot::RouterTable::mRouterIdSequence

uint8_t

ot::RouterTable::mMinRouterId

uint8_t

ot::RouterTable::mMaxRouterId

uint8_t

Methods

Clear()

Clears the router table.

ClearNeighbors()

Removes all neighbor links to routers.

Allocate()

Allocates a router with a random Router ID.

Allocate()

Allocates a router with a random Router ID.

Release()

Releases a Router ID.

RemoveRouterLink()

Removes a router link.

GetActiveRouterCount() const

Returns the number of active routers in the Thread network.

GetLeader()

Returns the leader in the Thread network.

GetLeader() const

Returns the leader in the Thread network.

GetLeaderAge() const

Returns the leader's age in seconds, i.e., seconds since the last Router ID Sequence update.

GetLinkCost() const

Returns the link cost for a neighboring router.

GetLinkCost() const

Returns the link cost for a neighboring router.

GetPathCost() const

Returns the minimum mesh path cost to the given RLOC16.

GetPathCostToLeader() const

Returns the mesh path cost to leader.

GetNextHop() const

Determines the next hop towards an RLOC16 destination.

GetNextHopAndPathCost() const

Determines the next hop and the path cost towards an RLOC16 destination.

FindRouterById()

Finds the router for a given Router ID.

FindRouterById() const

Finds the router for a given Router ID.

FindRouterByRloc16()

Finds the router for a given RLOC16.

FindRouterByRloc16() const

Finds the router for a given RLOC16.

FindNextHopOf()

Finds the router that is the next hop of a given router.

FindNextHopOf() const

Finds the router that is the next hop of a given router.

FindRouter()

Find the router for a given MAC Extended Address.

Contains() const

Indicates whether the router table contains a given `Neighbor` instance.

GetRouterInfo()

Retains diagnostic information for a given router.

GetRouterIdSequence() const

Returns the Router ID Sequence.

GetRouterIdSequenceLastUpdated() const

Returns the local time when the Router ID Sequence was last updated.

IsRouteTlvIdSequenceMoreRecent() const

Determines whether the Router ID Sequence in a received Route TLV is more recent than the current Router ID Sequence being used by `RouterTable`.

GetNeighborCount() const

Gets the number of router neighbors with `GetLinkQualityIn()` better than or equal to a given threshold.

IsAllocated() const

Indicates whether or not a Router ID is allocated.

UpdateRouterIdSet()

Updates the Router ID allocation set.

UpdateRoutes()

Updates the routes based on a received `RouteTlv` from a neighboring router.

UpdateRouterOnFtdChild()

Updates the routes on an FTD child based on a received `RouteTlv` from the parent. MUST be called when device is an FTD child and @p aRouteTlv is received from its current parent.

GetRouterIdSet() const

Gets the allocated Router ID set.

FillRouteTlv() const

Fills a Route TLV. When @p aNeighbor is not `nullptr`, we limit the number of router entries to `kMaxRoutersInRouteTlvForLinkAccept` when populating `aRouteTlv`, so that the TLV can be appended in a Link Accept message. In this case, we ensure to include router entries associated with @p aNeighbor, leader, and this device itself.