ot::Mac::ChannelMask::GetNextChannel() const method

Gets the next channel in the channel mask. Can be used to iterate over all channels in the channel mask. To get the first channel (channel with lowest number) in the mask the @p aChannel should be set to `kChannelIteratorFirst`.

Syntax

Show:

Summary

Declaration

Definition

from channel_mask.hpp:194

Error GetNextChannel(uint8_t &aChannel) const;

Implemented in channel_mask.cpp:55

Arguments

Argument

Description

aChannel

A reference to a `uint8_t`. On entry it should contain the previous channel or `kChannelIteratorFirst`. On exit it contains the next channel.

Return value

kErrorNone Got the next channel, @p aChannel updated successfully. kErrorNotFound No next channel in the channel mask (note: @p aChannel may be changed).

Examples

References

from examples

ot::Mac::ChannelMask::GetNextChannel() const method

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle