ot::RouterTable::GetRouterInfo() method

Retains diagnostic information for a given router.

Syntax

Show:

Summary

Declaration

Definition

from router_table.hpp:275

Error GetRouterInfo(uint16_t aRouterId, Router::Info &aRouterInfo);

Implemented in router_table.cpp:305

Arguments

Argument

Description

aRouterId

The router ID or RLOC16 for a given router.

aRouterInfo

The router information.

Return value

kErrorNone Successfully retrieved the router info for given id. kErrorInvalidArgs @p aRouterId is not a valid value for a router. kErrorNotFound No router entry with the given id.

Examples

References

from examples

ot::RouterTable::GetRouterInfo() method

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle