Symbols

loading (4/5)...

Files

loading (4/5)...

Summary Syntax Arguments References Call Tree Data Use

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

ot::Mle::MleRouter::SetRouterEligible() method

Sets whether or not the device is router-eligible. If @p aEligible is false and the device is currently operating as a router, this call will cause the device to detach and attempt to reattach as a child.

Syntax

Show:

Summary

Declaration

Definition

from mle_router.hpp:110

Error SetRouterEligible(bool aEligible);

Implemented in mle_router.cpp:139

Arguments

Argument

Description

aEligible

TRUE to configure device router-eligible, FALSE otherwise.

Return value

kErrorNone Successfully set the router-eligible configuration. kErrorNotCapable The device is not capable of becoming a router.

References

Code

Location

Error MleRouter::SetRouterEligible(bool aEligible)

mle_router.cpp:139

Error SetRouterEligible(bool aEligible);

mle_router.hpp:110

Call Tree

ot::Mle::MleRouter::SetRouterEligible() calls 1 function:

ot::Mle::MleRouter::SetRouterEligible()

ot::Mle::MleRouter::RouterRoleTransition::StartTimeout()

Data Use

ot::Mle::MleRouter::SetRouterEligible() reads 12 variables and writes 1 variable:

ot::Mle::DeviceRole::kRoleDisabled

ot::Mle::DeviceRole::kRoleDetached

ot::Mle::DeviceRole::kRoleChild

ot::Mle::DeviceRole::kRoleRouter

ot::Mle::DeviceRole::kRoleLeader

ot::kErrorNone

ot::kErrorNotCapable

ot::Mle::Mle::IsFullThreadDevice() const

ot::Mle::Mle::mRole

ot::Mle::MleRouter::mRouterEligible

ot::Mle::MleRouter::mRouterRoleTransition

ot::Mle::Mle::BecomeDetached()

ot::Mle::MleRouter::SetRouterEligible()

ot::Mle::MleRouter::mRouterEligible

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out