ot::AnnounceBeginClient Class Reference

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

#include <src/core/meshcop/announce_begin_client.hpp>

Inheritance diagram for ot::AnnounceBeginClient:

Public Member Functions
	AnnounceBeginClient (otInstance &aInstance)
	This constructor initializes the object.
otError	SendRequest (uint32_t aChannelMask, uint8_t aCount, uint16_t mPeriod, const Ip6::Address &aAddress)
	This method sends a Announce Begin message. More...
Public Member Functions inherited from ot::InstanceLocator
otInstance &	GetInstance (void) const
	This method returns a reference to the parent otInstance structure. More...
Ip6::Ip6 &	GetIp6 (void) const
	This method returns a reference to the Ip6. More...
ThreadNetif &	GetNetif (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

SendRequest()

otError ot::AnnounceBeginClient::SendRequest	(	uint32_t	aChannelMask,
		uint8_t	aCount,
		uint16_t	mPeriod,
		const Ip6::Address &	aAddress
	)

This method sends a Announce Begin message.

Parameters

[in]	aChannelMask	The channel mask value.
[in]	aCount	The number of energy measurements per channel.
[in]	aPeriod	The time between energy measurements (milliseconds).

Return values

OT_ERROR_NONE	Successfully enqueued the Announce Begin message.
OT_ERROR_NO_BUFS	Insufficient buffers to generate a Announce Begin message.

---

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

• src/core/meshcop/announce_begin_client.hpp