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.

References

Code

Location

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

router_table.cpp:305

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

router_table.hpp:275

Call Tree

ot::RouterTable::GetRouterInfo() calls 4 functions:

ot::RouterTable::GetRouterInfo()

ot::Mle::RouterIdFromRloc16()

ot::Mle::IsRouterRloc16()

ot::RouterTable::FindRouterById()

ot::Router::Info::SetFrom()

Data Use

ot::RouterTable::GetRouterInfo() reads 4 variables:

ot::Mle::kMaxRouterId

ot::kErrorNone

ot::kErrorInvalidArgs

ot::kErrorNotFound

ot::RouterTable::GetRouterInfo()

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out