ot::Utils::MeshDiag class

Implements the Mesh Diagnostics.

Syntax

Show:

Summary

Declaration

from mesh_diag.hpp:70

class MeshDiag : public InstanceLocator { friend class ot::NetworkDiagnostic::Client; public: static constexpr uint16_t kVersionUnknown = OT_MESH_DIAG_VERSION_UNKNOWN; typedef otMeshDiagDiscoverConfig DiscoverConfig; typedef otMeshDiagDiscoverCallback DiscoverCallback; typedef otMeshDiagQueryChildTableCallback QueryChildTableCallback; typedef otMeshDiagChildIp6AddrsCallback ChildIp6AddrsCallback; typedef otMeshDiagQueryRouterNeighborTableCallback RouterNeighborTableCallback; class Ip6AddrIterator : public otMeshDiagIp6AddrIterator { friend class MeshDiag; public: Error GetNextAddress(Ip6::Address &aAddress); private: Error InitFrom(const Message &aMessage); const Message *mMessage; OffsetRange mOffsetRange; }; class RouterInfo : public otMeshDiagRouterInfo, public Clearable<RouterInfo> { friend class MeshDiag; private: Error ParseFrom(const Message &aMessage); }; class ChildInfo : public otMeshDiagChildInfo, public Clearable<ChildInfo> { }; class ChildIterator : public otMeshDiagChildIterator { friend class MeshDiag; public: Error GetNextChildInfo(ChildInfo &aChildInfo); private: Error InitFrom(const Message &aMessage, uint16_t aParentRloc16); const Message *mMessage; OffsetRange mOffsetRange; uint16_t mParentRloc16; }; explicit MeshDiag(Instance &aInstance); Error DiscoverTopology(const DiscoverConfig &aConfig, DiscoverCallback aCallback, void *aContext); Error QueryChildTable(uint16_t aRloc16, QueryChildTableCallback aCallback, void *aContext); Error QueryChildrenIp6Addrs(uint16_t aRloc16, ChildIp6AddrsCallback aCallback, void *aContext); Error QueryRouterNeighborTable(uint16_t aRloc16, RouterNeighborTableCallback aCallback, void *aContext); void Cancel(void); private: typedef ot::NetworkDiagnostic::Tlv Tlv; static constexpr uint32_t kResponseTimeout = OPENTHREAD_CONFIG_MESH_DIAG_RESPONSE_TIMEOUT; enum State : uint8_t { kStateIdle, kStateDiscoverTopology, kStateQueryChildTable, kStateQueryChildrenIp6Addrs, kStateQueryRouterNeighborTable, }; struct DiscoverInfo { Callback<DiscoverCallback> mCallback; Mle::RouterIdSet mExpectedRouterIdSet; }; struct QueryChildTableInfo { Callback<QueryChildTableCallback> mCallback; uint16_t mRouterRloc16; }; struct QueryChildrenIp6AddrsInfo { Callback<ChildIp6AddrsCallback> mCallback; uint16_t mParentRloc16; }; struct QueryRouterNeighborTableInfo { Callback<RouterNeighborTableCallback> mCallback; uint16_t mRouterRloc16; }; class ChildEntry : public otMeshDiagChildEntry { friend class MeshDiag; private: void SetFrom(const NetworkDiagnostic::ChildTlv &aChildTlv); }; class RouterNeighborEntry : public otMeshDiagRouterNeighborEntry { friend class MeshDiag; private: void SetFrom(const NetworkDiagnostic::RouterNeighborTlv &aTlv); }; Error SendQuery(uint16_t aRloc16, const uint8_t *aTlvs, uint8_t aTlvsLength); void Finalize(Error aError); void HandleTimer(void); bool HandleDiagnosticGetAnswer(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo); Error ProcessMessage(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo, uint16_t aSenderRloc16); bool ProcessChildTableAnswer(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo); bool ProcessChildrenIp6AddrsAnswer(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo); bool ProcessRouterNeighborTableAnswer(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo); void HandleDiagGetResponse(Coap::Message *aMessage, const Ip6::MessageInfo *aMessageInfo, Error aResult); static void HandleDiagGetResponse(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, Error aResult); using TimeoutTimer = TimerMilliIn<MeshDiag, &MeshDiag::HandleTimer>; State mState; uint16_t mExpectedQueryId; uint16_t mExpectedAnswerIndex; TimeoutTimer mTimer; union { DiscoverInfo mDiscover; QueryChildTableInfo mQueryChildTable; QueryChildrenIp6AddrsInfo mQueryChildrenIp6Addrs; QueryRouterNeighborTableInfo mQueryRouterNeighborTable; }; };

Fields

Field

Declared as

ot::Utils::MeshDiag::kVersionUnknown

ot::Utils::MeshDiag::kResponseTimeout

ot::Utils::MeshDiag::mState

State

ot::Utils::MeshDiag::mExpectedQueryId

uint16_t

ot::Utils::MeshDiag::mExpectedAnswerIndex

uint16_t

ot::Utils::MeshDiag::mTimer

TimeoutTimer

Methods

DiscoverTopology()

Starts network topology discovery.

QueryChildTable()

Starts query for child table for a given router.

QueryChildrenIp6Addrs()

Sends a query to a parent to retrieve the IPv6 addresses of all its MTD children.

QueryRouterNeighborTable()

Starts query for router neighbor table for a given router.

Cancel()

Cancels an ongoing discovery or query operation if there one, otherwise no action. When ongoing discovery is cancelled, the callback from `DiscoverTopology()` or `QueryChildTable()` will not be called anymore.