otMeshDiagRouterInfo

#include <mesh_diag.h>

Represents information about a router in Thread mesh discovered using otMeshDiagDiscoverTopology().

Summary

Public attributes
`mChildIterator`	`otMeshDiagChildIterator *` A pointer to an iterator to go through the list of children of the router.
`mExtAddress`	`otExtAddress` Extended MAC address.
`mIp6AddrIterator`	`otMeshDiagIp6AddrIterator *` A pointer to an iterator to go through the list of IPv6 addresses of the router.
`mIsBorderRouter`	`bool` Whether router acts as a border router providing ext connectivity.
`mIsLeader`	`bool` Whether router is leader.
`mIsThisDevice`	`bool` Whether router is this device itself.
`mIsThisDeviceParent`	`bool` Whether router is parent of this device (when device is a child).
`mLinkQualities[OT_NETWORK_MAX_ROUTER_ID+1]`	`uint8_t` Provides the link quality from this router to other routers, also indicating whether a link is established between the routers.
`mRloc16`	`uint16_t` RLOC16.
`mRouterId`	`uint8_t` Router ID.
`mVersion`	`uint16_t` Thread Version. `OT_MESH_DIAG_VERSION_UNKNOWN` if unknown.

Public attributes

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.

mExtAddress

otExtAddress otMeshDiagRouterInfo::mExtAddress

Extended MAC address.

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.

mIsBorderRouter

bool otMeshDiagRouterInfo::mIsBorderRouter

Whether router acts as a border router providing ext connectivity.

mIsLeader

bool otMeshDiagRouterInfo::mIsLeader

Whether router is leader.

mIsThisDevice

bool otMeshDiagRouterInfo::mIsThisDevice

Whether router is this device itself.

mIsThisDeviceParent

bool otMeshDiagRouterInfo::mIsThisDeviceParent

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

mLinkQualities

uint8_t otMeshDiagRouterInfo::mLinkQualities[OT_NETWORK_MAX_ROUTER_ID+1]

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).

mRloc16

uint16_t otMeshDiagRouterInfo::mRloc16

RLOC16.

mRouterId

uint8_t otMeshDiagRouterInfo::mRouterId

Router ID.

mVersion

uint16_t otMeshDiagRouterInfo::mVersion

Thread Version. OT_MESH_DIAG_VERSION_UNKNOWN if unknown.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.