ot::SettingsDriver class

Syntax

Show:

Summary

Declaration

from settings_driver.hpp:49

class SettingsDriver : public InstanceLocator, private NonCopyable { public: explicit SettingsDriver(Instance &aInstance) : InstanceLocator(aInstance) #if OPENTHREAD_CONFIG_PLATFORM_FLASH_API_ENABLE , mFlash(aInstance) #endif { } void Init(const uint16_t *aSensitiveKeys, uint16_t aSensitiveKeysLength) { #if OPENTHREAD_CONFIG_PLATFORM_FLASH_API_ENABLE OT_UNUSED_VARIABLE(aSensitiveKeys); OT_UNUSED_VARIABLE(aSensitiveKeysLength); mFlash.Init(); #else otPlatSettingsInit(GetInstancePtr(), aSensitiveKeys, aSensitiveKeysLength); #endif } void Deinit(void) { #if !OPENTHREAD_CONFIG_PLATFORM_FLASH_API_ENABLE otPlatSettingsDeinit(GetInstancePtr()); #endif } Error Add(uint16_t aKey, const void *aValue, uint16_t aValueLength) { Error error; const uint8_t *value = reinterpret_cast<const uint8_t *>(aValue); #if OPENTHREAD_CONFIG_PLATFORM_FLASH_API_ENABLE error = mFlash.Add(aKey, value, aValueLength); #else error = otPlatSettingsAdd(GetInstancePtr(), aKey, value, aValueLength); #endif return error; } Error Delete(uint16_t aKey, int aIndex = -1) { Error error; #if OPENTHREAD_CONFIG_PLATFORM_FLASH_API_ENABLE error = mFlash.Delete(aKey, aIndex); #else error = otPlatSettingsDelete(GetInstancePtr(), aKey, aIndex); #endif return error; } Error Get(uint16_t aKey, int aIndex, void *aValue, uint16_t *aValueLength) const { Error error; uint8_t *value = reinterpret_cast<uint8_t *>(aValue); #if OPENTHREAD_CONFIG_PLATFORM_FLASH_API_ENABLE error = mFlash.Get(aKey, aIndex, value, aValueLength); #else error = otPlatSettingsGet(GetInstancePtr(), aKey, aIndex, value, aValueLength); #endif return error; } Error Get(uint16_t aKey, void *aValue, uint16_t *aValueLength) const { return Get(aKey, 0, aValue, aValueLength); } Error Set(uint16_t aKey, const void *aValue, uint16_t aValueLength) { Error error; const uint8_t *value = reinterpret_cast<const uint8_t *>(aValue); #if OPENTHREAD_CONFIG_PLATFORM_FLASH_API_ENABLE error = mFlash.Set(aKey, value, aValueLength); #else error = otPlatSettingsSet(GetInstancePtr(), aKey, value, aValueLength); #endif return error; } void Wipe(void) { #if OPENTHREAD_CONFIG_PLATFORM_FLASH_API_ENABLE mFlash.Wipe(); #else otPlatSettingsWipe(GetInstancePtr()); #endif } private: otInstance *GetInstancePtr(void) const { return reinterpret_cast<otInstance *>(&InstanceLocator::GetInstance()); } #if OPENTHREAD_CONFIG_PLATFORM_FLASH_API_ENABLE Flash mFlash; #endif };

Methods

Init()

Initializes the settings storage driver.

Deinit()

Deinitializes the settings driver.

Add()

Adds a value to @p aKey.

Delete()

Removes a value from @p aKey.

Get() const

Fetches the value identified by @p aKey at a given @p aIndex.

Get() const

Fetches the value identified by @p aKey at a given @p aIndex.

Set()

Sets or replaces the value identified by @p aKey. If there was more than one value previously associated with @p aKey, then they are all deleted and replaced with this single entry.