Symbols ![]()
loading (4/5)...
Files ![]()
loading (4/5)...
ot::MeshCoP::PendingDatasetManager class
Syntax
class PendingDatasetManager;
class DatasetManager : public InstanceLocator
{
friend class ActiveDatasetManager;
friend class PendingDatasetManager;
public:
typedef otDatasetMgmtSetCallback MgmtSetCallback;
enum SecurityPolicyCheckMode : uint8_t
{
kCheckSecurityPolicyFlags,
kIgnoreSecurityPolicyFlags,
};
const Timestamp &GetTimestamp(void) const { return mNetworkTimestamp; }
void Clear(void);
Error Restore(void);
Error Read(Dataset &aDataset) const;
Error Read(Dataset::Info &aDatasetInfo) const;
Error Read(Dataset::Tlvs &aDatasetTlvs) const;
void SaveLocal(const Dataset &aDataset);
void SaveLocal(const Dataset::Info &aDatasetInfo);
Error SaveLocal(const Dataset::Tlvs &aDatasetTlvs);
Error Save(const Dataset &aDataset) { return Save(aDataset, false); }
Error GetChannelMask(Mac::ChannelMask &aChannelMask) const;
Error ApplyConfiguration(void) const;
Error SendSetRequest(const Dataset::Info &aDatasetInfo,
const uint8_t *aTlvs,
uint8_t aLength,
MgmtSetCallback aCallback,
void *aContext);
Error SendGetRequest(const Dataset::Components &aDatasetComponents,
const uint8_t *aTlvTypes,
uint8_t aLength,
const otIp6Address *aAddress) const;
Coap::Message *ProcessGetRequest(const Coap::Message &aRequest, SecurityPolicyCheckMode aCheckMode) const;
private:
static constexpr uint8_t kMaxGetTypes = 64;
static constexpr uint32_t kSendSetDelay = 5000;
using Type = Dataset::Type;
class TlvList : public Array<uint8_t, kMaxGetTypes>
{
public:
TlvList(void) = default;
void Add(uint8_t aTlvType);
};
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
using KeyRef = Crypto::Storage::KeyRef;
struct SecurelyStoredTlv
{
KeyRef GetKeyRef(Dataset::Type aType) const
{
return (aType == Dataset::kActive) ? mActiveKeyRef : mPendingKeyRef;
}
Tlv::Type mTlvType;
KeyRef mActiveKeyRef;
KeyRef mPendingKeyRef;
};
static const SecurelyStoredTlv kSecurelyStoredTlvs[];
#endif
#if OPENTHREAD_FTD
enum MgmtCommand : uint8_t
{
kMgmtSet,
kMgmtReplace,
};
struct RequestInfo : Clearable<RequestInfo>
{
Dataset mDataset;
bool mIsFromCommissioner;
bool mAffectsConnectivity;
bool mAffectsNetworkKey;
};
#endif
DatasetManager(Instance &aInstance, Type aType, TimerMilli::Handler aTimerHandler);
bool IsActiveDataset(void) const { return (mType == Dataset::kActive); }
bool IsPendingDataset(void) const { return (mType == Dataset::kPending); }
void Restore(const Dataset &aDataset);
Error ApplyConfiguration(const Dataset &aDataset) const;
void HandleGet(const Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo) const;
void HandleTimer(void);
Error Save(const Dataset &aDataset, bool aAllowOlderTimestamp);
void LocalSave(const Dataset &aDataset);
void SignalDatasetChange(void) const;
void SyncLocalWithLeader(const Dataset &aDataset);
Error SendSetRequest(const Dataset &aDataset);
void HandleMgmtSetResponse(Coap::Message *aMessage, const Ip6::MessageInfo *aMessageInfo, Error aError);
static void HandleMgmtSetResponse(void *aContext,
otMessage *aMessage,
const otMessageInfo *aMessageInfo,
Error aError);
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
void MoveKeysToSecureStorage(Dataset &aDataset) const;
void DestroySecurelyStoredKeys(void) const;
void EmplaceSecurelyStoredKeys(Dataset &aDataset) const;
void SaveTlvInSecureStorageAndClearValue(Dataset &aDataset, Tlv::Type aTlvType, KeyRef aKeyRef) const;
Error ReadTlvFromSecureStorage(Dataset &aDataset, Tlv::Type aTlvType, KeyRef aKeyRef) const;
#endif
#if OPENTHREAD_FTD
Error HandleSetOrReplace(MgmtCommand aCommand, const Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo);
Error ProcessSetOrReplaceRequest(MgmtCommand aCommand, const Coap::Message &aMessage, RequestInfo &aInfo) const;
void SendSetOrReplaceResponse(const Coap::Message &aRequest,
const Ip6::MessageInfo &aMessageInfo,
StateTlv::State aState);
#endif
Type mType;
bool mLocalSaved : 1;
bool mMgmtPending : 1;
TimeMilli mLocalUpdateTime;
Timestamp mLocalTimestamp;
Timestamp mNetworkTimestamp;
TimerMilli mTimer;
Callback<MgmtSetCallback> mMgmtSetCallback;
};
class ActiveDatasetManager : public DatasetManager, private NonCopyable
{
friend class Tmf::Agent;
public:
explicit ActiveDatasetManager(Instance &aInstance);
bool IsPartiallyComplete(void) const;
bool IsComplete(void) const;
bool IsCommissioned(void) const;
#if OPENTHREAD_FTD
Error CreateNewNetwork(Dataset::Info &aDatasetInfo) { return aDatasetInfo.GenerateRandom(GetInstance()); }
void StartLeader(void);
#if OPENTHREAD_CONFIG_OPERATIONAL_DATASET_AUTO_INIT
Error GenerateLocal(void);
#endif
#endif
private:
template <Uri kUri> void HandleTmf(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo);
static void HandleTimer(Timer &aTimer);
void HandleTimer(void) { DatasetManager::HandleTimer(); }
};
DeclareTmfHandler(ActiveDatasetManager, kUriActiveGet);
#if OPENTHREAD_FTD
DeclareTmfHandler(ActiveDatasetManager, kUriActiveSet);
DeclareTmfHandler(ActiveDatasetManager, kUriActiveReplace);
#endif
class PendingDatasetManager : public DatasetManager,
private NonCopyable;
Implemented in ![]()
dataset_manager.hpp:405
Fields
Field
Declared as
References
Code
Location
Scope
Referrer
Class Tree
ot::MeshCoP::PendingDatasetManager is inherited by 2 classess:
Instances
Instance
Scope
Location
Project