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.

Examples

References

from examples

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

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle