This type represents information about a router in Thread mesh.

Public Attributes#

Extended MAC address.

uint16_t

RLOC16.

uint8_t

Router ID.

uint16_t

Thread Version. OT_MESH_DIAG_VERSION_UNKNOWN if unknown.

bool

Whether router is this device itself.

bool

Whether router is parent of this device (when device is a child).

bool

Whether router is leader.

bool

Whether router acts as a border router providing ext connectivity.

uint8_t

This array provides the link quality from this router to other routers, also indicating whether a link is established between the routers.

A pointer to an iterator to go through the list of IPv6 addresses of the router.

A pointer to an iterator to go through the list of children of the router.

Public Attribute Documentation#

mExtAddress#

otExtAddress otMeshDiagRouterInfo::mExtAddress

Extended MAC address.


Definition at line 99 of file include/openthread/mesh_diag.h

mRloc16#

uint16_t otMeshDiagRouterInfo::mRloc16

RLOC16.


Definition at line 100 of file include/openthread/mesh_diag.h

mRouterId#

uint8_t otMeshDiagRouterInfo::mRouterId

Router ID.


Definition at line 101 of file include/openthread/mesh_diag.h

mVersion#

uint16_t otMeshDiagRouterInfo::mVersion

Thread Version. OT_MESH_DIAG_VERSION_UNKNOWN if unknown.


Definition at line 102 of file include/openthread/mesh_diag.h

mIsThisDevice#

bool otMeshDiagRouterInfo::mIsThisDevice

Whether router is this device itself.


Definition at line 103 of file include/openthread/mesh_diag.h

mIsThisDeviceParent#

bool otMeshDiagRouterInfo::mIsThisDeviceParent

Whether router is parent of this device (when device is a child).


Definition at line 104 of file include/openthread/mesh_diag.h

mIsLeader#

bool otMeshDiagRouterInfo::mIsLeader

Whether router is leader.


Definition at line 105 of file include/openthread/mesh_diag.h

mIsBorderRouter#

bool otMeshDiagRouterInfo::mIsBorderRouter

Whether router acts as a border router providing ext connectivity.


Definition at line 106 of file include/openthread/mesh_diag.h

mLinkQualities#

uint8_t otMeshDiagRouterInfo::mLinkQualities[OT_NETWORK_MAX_ROUTER_ID+1]

This array provides the link quality from this router to other routers, also indicating whether a link is established between the routers.

The array is indexed based on Router ID. mLinkQualities[routerId] indicates the incoming link quality, the router sees to the router with routerId. Link quality is a value in [0, 3]. Value zero indicates no link. Larger value indicate better link quality (as defined by Thread specification).


Definition at line 117 of file include/openthread/mesh_diag.h

mIp6AddrIterator#

otMeshDiagIp6AddrIterator* otMeshDiagRouterInfo::mIp6AddrIterator

A pointer to an iterator to go through the list of IPv6 addresses of the router.

The pointer is valid only while otMeshDiagRouterInfo is valid. It can be used in otMeshDiagGetNextIp6Address to iterate through the IPv6 addresses.

The pointer can be NULL when there was no request to discover IPv6 addresses (in otMeshDiagDiscoverConfig) or if the router did not provide the list.


Definition at line 129 of file include/openthread/mesh_diag.h

mChildIterator#

otMeshDiagChildIterator* otMeshDiagRouterInfo::mChildIterator

A pointer to an iterator to go through the list of children of the router.

The pointer is valid only while otMeshDiagRouterInfo is valid. It can be used in otMeshDiagGetNextChildInfo to iterate through the children of the router.

The pointer can be NULL when there was no request to discover children (in otMeshDiagDiscoverConfig) or if the router did not provide the list.


Definition at line 141 of file include/openthread/mesh_diag.h