0.01.00
ot::AnnounceBeginServer Class Reference

This class implements handling Announce Begin Requests. More...

#include <src/core/thread/announce_begin_server.hpp>

Inheritance diagram for ot::AnnounceBeginServer:
ot::InstanceLocator

Public Member Functions

 AnnounceBeginServer (otInstance &aInstance)
 This constructor initializes the object.
 
otError SendAnnounce (uint32_t aChannelMask)
 This method begins the MLE Announce transmission process using Count=3 and Period=1s. More...
 
otError SendAnnounce (uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod)
 This method begins the MLE Announce transmission process. More...
 
- Public Member Functions inherited from ot::InstanceLocator
otInstanceGetInstance (void) const
 This method returns a reference to the parent otInstance structure. More...
 
Ip6::Ip6GetIp6 (void) const
 This method returns a reference to the Ip6. More...
 
ThreadNetifGetNetif (void) const
 This method returns a reference to the thread network interface. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ot::InstanceLocator
 InstanceLocator (otInstance &aInstance)
 This constructor initializes the object. More...
 

Detailed Description

This class implements handling Announce Begin Requests.

Member Function Documentation

§ SendAnnounce() [1/2]

otError ot::AnnounceBeginServer::SendAnnounce ( uint32_t  aChannelMask)

This method begins the MLE Announce transmission process using Count=3 and Period=1s.

Parameters
[in]aChannelMaskThe channels to use for transmission.
Return values
OT_ERROR_NONESuccessfully started the transmission process.

§ SendAnnounce() [2/2]

otError ot::AnnounceBeginServer::SendAnnounce ( uint32_t  aChannelMask,
uint8_t  aCount,
uint16_t  aPeriod 
)

This method begins the MLE Announce transmission process.

Parameters
[in]aChannelMaskThe channels to use for transmission.
[in]aCountThe number of transmissions per channel.
[in]aPeriodThe time between transmissions (milliseconds).
Return values
OT_ERROR_NONESuccessfully started the transmission process.

The documentation for this class was generated from the following files: