ot::AnnounceSenderBase class

Implements the base class for an `AnnounceSender` and `AnnounceBeginSever`. Provides APIs to schedule periodic transmission of MLE Announcement messages for a given number transmissions per channel.

Syntax

Show:

Summary

Declaration

from announce_sender.hpp:54

class AnnounceSenderBase : public InstanceLocator, private NonCopyable { protected: static constexpr uint8_t kChannelIteratorFirst = Mac::ChannelMask::kChannelIteratorFirst; AnnounceSenderBase(Instance &aInstance, Timer::Handler aHandler); void SendAnnounce(uint8_t aCount); void Stop(void); bool IsRunning(void) const { return mTimer.IsRunning(); } uint32_t GetPeriod(void) const { return mPeriod; } void SetPeriod(uint32_t aPeriod) { mPeriod = aPeriod; } uint16_t GetJitter(void) const { return mJitter; } void SetJitter(uint16_t aJitter) { mJitter = aJitter; } const Mac::ChannelMask GetChannelMask(void) const { return mChannelMask; } void SetChannelMask(Mac::ChannelMask aChannelMask); uint8_t GetStartingChannel(void) const { return mStartingChannel; } void SetStartingChannel(uint8_t aStartingChannel); void HandleTimer(void); private: void SelectStartingChannel(void); Mac::ChannelMask mChannelMask; uint32_t mPeriod; uint16_t mJitter; uint8_t mCount; uint8_t mChannel; uint8_t mStartingChannel; TimerMilli mTimer; };

Fields

Field

Description

Declared as

ot::AnnounceSenderBase::kChannelIteratorFirst

This constant defines the special channel value to start from the first channel in the channel mask.

ot::AnnounceSenderBase::mChannelMask

Mac::ChannelMask

ot::AnnounceSenderBase::mPeriod

uint32_t

ot::AnnounceSenderBase::mJitter

uint16_t

ot::AnnounceSenderBase::mCount

uint8_t

ot::AnnounceSenderBase::mChannel

uint8_t

ot::AnnounceSenderBase::mStartingChannel

uint8_t

ot::AnnounceSenderBase::mTimer

TimerMilli

Methods

SendAnnounce()

Schedules the MLE Announce transmissions. Requests @p aCount additional MLE transmission cycles to be scheduled. Each cycle covers all the channels in the specified channel mask from `GetChannelMask()`, with `GetPeriod()` as the time interval between any two successive MLE Announcement transmissions (possibly) on different channels from the mask. The `GetJitter()` value is used to add a random interval from `[-jitter, jitter]` to each period interval. If a "starting channel" is specified using `SetStartingChannel()`, then the cycle starts with MLE Announce transmission on the given starting channel. Otherwise the cycle starts with the first channel (with smallest channel number) in the mask. If a previously requested MLE Announce transmission is still ongoing, a subsequent call to this method adds the @p aCount cycles to the schedule. If there is no active MLE Announce transmission, after call to `SendAnnounce()`, the first MLE Announce transmission happens within a short random interval selected from range `[0, jitter]`.

Stop()

Stops the ongoing MLE Announce transmissions.

IsRunning() const

Indicates whether a previously scheduled MLE Announce transmission is currently in progress or is finished.

GetPeriod() const

Gets the period interval.

SetPeriod()

Sets the period interval. The period along with jitter value from (`Get/SetJitter()`) determines the interval between two successive MLE Announcement transmissions (possibly) on different channels from the specified channel mask.

GetJitter() const

Gets the current jitter interval.

SetJitter()

Sets the jitter interval.

GetChannelMask() const

Gets the channel mask.

SetChannelMask()

Sets the channel mask.

GetStartingChannel() const

Gets the starting channel, i.e., the first channel in a TX cycle to send MLE Announcement on.

SetStartingChannel()

Sets the starting channel, i.e., the first channel in a TX cycle to send MLE Announcement on. @p aStartingChannel MUST be present in the current channel mask (from `GetChannelMask()`), otherwise it is ignored and an MLE transmission cycle starts with the first channel (with smallest channel number) in the channel mask.