Settings

This module includes the platform abstraction for non-volatile storage of settings.

Summary

Functions

otPlatSettingsAdd(otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
Adds a value to a setting.
otPlatSettingsDelete(otInstance *aInstance, uint16_t aKey, int aIndex)
Removes a setting from the setting store.
otPlatSettingsGet(otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength)
Fetches the value of a setting.
otPlatSettingsInit(otInstance *aInstance)
void
Performs any initialization for the settings subsystem, if necessary.
otPlatSettingsSet(otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
Sets or replaces the value of a setting.
otPlatSettingsWipe(otInstance *aInstance)
void
Removes all settings from the setting store.

Functions

otPlatSettingsAdd

otError otPlatSettingsAdd(
  otInstance *aInstance,
  uint16_t aKey,
  const uint8_t *aValue,
  uint16_t aValueLength
)

Adds a value to a setting.

This function adds the value to a setting identified by aKey, without replacing any existing values.

Note that the underlying implementation is not required to maintain the order of the items associated with a specific key. The added value may be added to the end, the beginning, or even somewhere in the middle. The order of any pre-existing values may also change.

Calling this function successfully may cause unrelated settings with multiple values to be reordered.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[in] aKey
The key associated with the setting to change.
[out] aValue
A pointer to where the new value of the setting should be read from. MUST NOT be NULL if aValueLength is non-zero.
[in,out] aValueLength
The length of the data pointed to by aValue. May be zero.
Return Values
OT_ERROR_NONE
The given setting was added or staged to be added.
OT_ERROR_NOT_IMPLEMENTED
This function is not implemented on this platform.

otPlatSettingsDelete

otError otPlatSettingsDelete(
  otInstance *aInstance,
  uint16_t aKey,
  int aIndex
)

Removes a setting from the setting store.

This function deletes a specific value from the setting identified by aKey from the settings store.

Note that the underlying implementation is not required to maintain the order of the items associated with a specific key.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[in] aKey
The key associated with the requested setting.
[in] aIndex
The index of the value to be removed. If set to -1, all values for this aKey will be removed.
Return Values
OT_ERROR_NONE
The given key and index was found and removed successfully.
OT_ERROR_NOT_FOUND
The given key or index was not found in the setting store.
OT_ERROR_NOT_IMPLEMENTED
This function is not implemented on this platform.

otPlatSettingsGet

otError otPlatSettingsGet(
  otInstance *aInstance,
  uint16_t aKey,
  int aIndex,
  uint8_t *aValue,
  uint16_t *aValueLength
)

Fetches the value of a setting.

This function fetches the value of the setting identified by aKey and write it to the memory pointed to by aValue. It then writes the length to the integer pointed to by aValueLength. The initial value of aValueLength is the maximum number of bytes to be written to aValue.

This function can be used to check for the existence of a key without fetching the value by setting aValue and aValueLength to NULL. You can also check the length of the setting without fetching it by setting only aValue to NULL.

Note that the underlying storage implementation is not required to maintain the order of settings with multiple values. The order of such values MAY change after ANY write operation to the store.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[in] aKey
The key associated with the requested setting.
[in] aIndex
The index of the specific item to get.
[out] aValue
A pointer to where the value of the setting should be written. May be set to NULL if just testing for the presence or length of a setting.
[in,out] aValueLength
A pointer to the length of the value. When called, this pointer should point to an integer containing the maximum value size that can be written to aValue. At return, the actual length of the setting is written. This may be set to NULL if performing a presence check.
Return Values
OT_ERROR_NONE
The given setting was found and fetched successfully.
OT_ERROR_NOT_FOUND
The given setting was not found in the setting store.
OT_ERROR_NOT_IMPLEMENTED
This function is not implemented on this platform.

otPlatSettingsInit

void otPlatSettingsInit(
  otInstance *aInstance
)

Performs any initialization for the settings subsystem, if necessary.

Details
Parameters
[in] aInstance
The OpenThread instance structure.

otPlatSettingsSet

otError otPlatSettingsSet(
  otInstance *aInstance,
  uint16_t aKey,
  const uint8_t *aValue,
  uint16_t aValueLength
)

Sets or replaces the value of a setting.

This function sets or replaces the value of a setting identified by aKey. If there was more than one value previously associated with aKey, then they are all deleted and replaced with this single entry.

Calling this function successfully may cause unrelated settings with multiple values to be reordered.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[in] aKey
The key associated with the setting to change.
[out] aValue
A pointer to where the new value of the setting should be read from. MUST NOT be NULL if aValueLength is non-zero.
[in] aValueLength
The length of the data pointed to by aValue. May be zero.
Return Values
OT_ERROR_NONE
The given setting was changed or staged.
OT_ERROR_NOT_IMPLEMENTED
This function is not implemented on this platform.

otPlatSettingsWipe

void otPlatSettingsWipe(
  otInstance *aInstance
)

Removes all settings from the setting store.

This function deletes all settings from the settings store, resetting it to its initial factory state.

Details
Parameters
[in] aInstance
The OpenThread instance structure.