Symbols

loading (2/5)...

Files

loading (3/5)...

Summary Syntax Arguments References Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Mle::MleRouter::SetPreferredRouterId()

ot::Mle::MleRouter::SetPreferredRouterId() method

Sets the preferred Router Id. Upon becoming a router/leader the node attempts to use this Router Id. If the preferred Router Id is not set or if it can not be used, a randomly generated router Id is picked. This property can be set when he device role is detached or disabled.

Syntax

Show:

Summary

Declaration

Definition

from mle_router.hpp:209

Error SetPreferredRouterId(uint8_t aRouterId);

Implemented in mle_router.cpp:3152

Arguments

Argument

Description

aRouterId

The preferred Router Id.

Return value

kErrorNone Successfully set the preferred Router Id. kErrorInvalidState Could not set (role is other than detached and disabled)

References

Code

Location

Error MleRouter::SetPreferredRouterId(uint8_t aRouterId)

mle_router.cpp:3152

Error SetPreferredRouterId(uint8_t aRouterId);

mle_router.hpp:209

Call Tree

All items filtered out

All items filtered out

Data Use

ot::Mle::MleRouter::SetPreferredRouterId() reads 4 variables and writes 1 variable:

ot::kErrorInvalidState

ot::Mle::Mle::IsDisabled() const

ot::Mle::Mle::IsDetached() const

ot::Mle::MleRouter::SetPreferredRouterId()

ot::Mle::MleRouter::mPreviousRouterId

Class Tree

All items filtered out

All items filtered out

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Lifecycle

All items filtered out

All items filtered out