ot::NeighborTable class

Represents the Thread neighbor table.

Syntax

Show:

Summary

Declaration

from neighbor_table.hpp:48

class NeighborTable : public InstanceLocator, private NonCopyable { public: typedef otNeighborTableCallback Callback; typedef otNeighborTableEntryInfo EntryInfo; enum Event : uint8_t { kChildAdded = OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED, kChildRemoved = OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED, kChildModeChanged = OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED, kRouterAdded = OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED, kRouterRemoved = OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED, }; explicit NeighborTable(Instance &aInstance); Neighbor *FindParent(Mac::ShortAddress aShortAddress, Neighbor::StateFilter aFilter = Neighbor::kInStateValidOrRestoring); Neighbor *FindParent(const Mac::ExtAddress &aExtAddress, Neighbor::StateFilter aFilter = Neighbor::kInStateValidOrRestoring); Neighbor *FindParent(const Mac::Address &aMacAddress, Neighbor::StateFilter aFilter = Neighbor::kInStateValidOrRestoring); Neighbor *FindNeighbor(Mac::ShortAddress aShortAddress, Neighbor::StateFilter aFilter = Neighbor::kInStateValidOrRestoring); Neighbor *FindNeighbor(const Mac::ExtAddress &aExtAddress, Neighbor::StateFilter aFilter = Neighbor::kInStateValidOrRestoring); Neighbor *FindNeighbor(const Mac::Address &aMacAddress, Neighbor::StateFilter aFilter = Neighbor::kInStateValidOrRestoring); #if OPENTHREAD_FTD Neighbor *FindNeighbor(const Ip6::Address &aIp6Address, Neighbor::StateFilter aFilter = Neighbor::kInStateValidOrRestoring); Neighbor *FindRxOnlyNeighborRouter(const Mac::ExtAddress &aExtAddress); Neighbor *FindRxOnlyNeighborRouter(const Mac::Address &aMacAddress); #endif Error GetNextNeighborInfo(otNeighborInfoIterator &aIterator, Neighbor::Info &aNeighInfo); void RegisterCallback(Callback aCallback) { mCallback = aCallback; } void Signal(Event aEvent, const Neighbor &aNeighbor); private: Neighbor *FindParent(const Neighbor::AddressMatcher &aMatcher); Neighbor *FindNeighbor(const Neighbor::AddressMatcher &aMatcher); #if OPENTHREAD_FTD Neighbor *FindChildOrRouter(const Neighbor::AddressMatcher &aMatcher); #endif Callback mCallback; };

Fields

Field

Declared as

ot::NeighborTable::mCallback

Callback

Methods

FindParent()

FindNeighbor()

FindRxOnlyNeighborRouter()

Searches in the neighbor table to find a `Neighbor` for which a one-way link is maintained (as in the case of an FTD child with neighbor routers).

FindRxOnlyNeighborRouter()

Searches in the neighbor table to find a `Neighbor` for which a one-way link is maintained (as in the case of an FTD child with neighbor routers).

GetNextNeighborInfo()

Gets the next neighbor information. It is used to iterate through the entries of the neighbor table.

RegisterCallback()

Registers the "neighbor table changed" callback function. The provided callback (if non-`nullptr`) will be invoked when a child/router entry is being added/remove to/from the neighbor table. Subsequent calls to this method will overwrite the previous callback.

ot::NeighborTable class

Syntax

Fields

Methods

FindParent()

FindParent()

FindParent()

FindNeighbor()

FindNeighbor()

FindNeighbor()

FindNeighbor()

FindRxOnlyNeighborRouter()

FindRxOnlyNeighborRouter()

GetNextNeighborInfo()

RegisterCallback()

Signal()

FindParent()

FindNeighbor()

FindChildOrRouter()

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle