Google is committed to advancing racial equity for Black communities. See how.

nl::Weave::Platform::PersistedStorage

Summary

Typedefs

Key typedef

Functions

Read(Key aKey, uint32_t & aValue)
Read integer value of a key from persistent storage.
Read(const char *aKey, uint32_t & aValue)
Write(Key aKey, uint32_t aValue)
Write the integer value of a key to persistent storage.
Write(const char *aKey, uint32_t aValue)

Typedefs

Key

WEAVE_CONFIG_PERSISTED_STORAGE_KEY_TYPE Key

Functions

Read

WEAVE_ERROR Read(
  Key aKey,
  uint32_t & aValue
)

Read integer value of a key from persistent storage.

Platform is responsible for validating aKey.

Details
Parameters
[in] aKey
A key to a persistently-stored value.
[in,out] aValue
A reference to an integer value.
Returns
WEAVE_ERROR_INVALID_ARGUMENT if aKey is NULL WEAVE_ERROR_INVALID_STRING_LENGTH if aKey exceeds WEAVE_CONFIG_PERSISTED_STORAGE_MAX_KEY_LENGTH WEAVE_ERROR_PERSISTED_STORAGE_VALUE_NOT_FOUND if aKey does not exist WEAVE_NO_ERROR otherwise

Read

WEAVE_ERROR Read(
  const char *aKey,
  uint32_t & aValue
)

Write

WEAVE_ERROR Write(
  Key aKey,
  uint32_t aValue
)

Write the integer value of a key to persistent storage.

Platform is responsible for validating aKey. If aKey does not exist, it will be created and assigned aValue. Otherwise any existing value of aKey will be replaced with aValue.

Details
Parameters
[in] aKey
A key to a persistently-stored value.
[in] aValue
The value.
Returns
WEAVE_ERROR_INVALID_ARGUMENT if aKey is NULL WEAVE_ERROR_INVALID_STRING_LENGTH if aKey exceeds WEAVE_CONFIG_PERSISTED_STORAGE_MAX_KEY_LENGTH WEAVE_NO_ERROR otherwise

Write

WEAVE_ERROR Write(
  const char *aKey,
  uint32_t aValue
)