Definições

Este módulo inclui a abstração da plataforma para armazenamento não volátil de configurações.

Resumo

Funções
`otPlatSettingsAdd ( otInstance aInstance, uint16_t aKey, const uint8_t aValue, uint16_t aValueLength)`	`otError` Adiciona um valor a uma configuração.
`otPlatSettingsDeinit ( otInstance *aInstance)`	`void` Executa qualquer inicialização do subsistema de configurações, se necessário.
`otPlatSettingsDelete ( otInstance *aInstance, uint16_t aKey, int aIndex)`	`otError` Remove uma configuração do armazenamento de configurações.
`otPlatSettingsGet ( otInstance aInstance, uint16_t aKey, int aIndex, uint8_t aValue, uint16_t *aValueLength)`	`otError` Busca o valor de uma configuração.
`otPlatSettingsInit ( otInstance *aInstance)`	`void` Executa qualquer inicialização para o subsistema de configurações, se necessário.
`otPlatSettingsSet ( otInstance aInstance, uint16_t aKey, const uint8_t aValue, uint16_t aValueLength)`	`otError` Define ou substitui o valor de uma configuração.
`otPlatSettingsWipe ( otInstance *aInstance)`	`void` Remove todas as configurações do armazenamento de configurações.

Funções

otPlatSettingsAdd

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

Adiciona um valor a uma configuração.

Esta função adiciona o valor a uma configuração identificada por aKey, sem substituir nenhum valor existente.

Observe que a implementação subjacente não é necessária para manter a ordem dos itens associados a uma chave específica. O valor agregado pode ser agregado ao final, ao começo ou mesmo em algum lugar no meio. A ordem de quaisquer valores pré-existentes também pode mudar.

Chamar essa função com êxito pode fazer com que configurações não relacionadas com vários valores sejam reordenadas.

Detalhes

Parâmetros

`[in] aInstance`	A estrutura da instância OpenThread.
`[in] aKey`	A chave associada à configuração a ser alterada.
`[in] aValue`	Um ponteiro para onde o novo valor da configuração deve ser lido. NÃO DEVE ser NULL se aValueLength for diferente de zero.
`[in] aValueLength`	O comprimento dos dados apontados por aValue. Pode ser zero.

Valores Retornados

`OT_ERROR_NONE`	A configuração fornecida foi adicionada ou preparada para ser adicionada.
`OT_ERROR_NOT_IMPLEMENTED`	Esta função não está implementada nesta plataforma.
`OT_ERROR_NO_BUFS`	Nenhum espaço restante para armazenar a configuração fornecida.

otPlatSettingsDeinit

void otPlatSettingsDeinit(
  otInstance *aInstance
)

Executa qualquer inicialização do subsistema de configurações, se necessário.

Detalhes

Parâmetros

[in] aInstance

A estrutura da instância OpenThread.

otPlatSettingsDelete

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

Remove uma configuração do armazenamento de configurações.

Esta função exclui um valor específico da configuração identificada por aKey do armazenamento de configurações.

Observe que a implementação subjacente não é necessária para manter a ordem dos itens associados a uma chave específica.

Detalhes

Parâmetros

`[in] aInstance`	A estrutura da instância OpenThread.
`[in] aKey`	A chave associada à configuração solicitada.
`[in] aIndex`	O índice do valor a ser removido. Se definido como -1, todos os valores para esta aKey serão removidos.

Valores Retornados

`OT_ERROR_NONE`	A chave e o índice fornecidos foram encontrados e removidos com sucesso.
`OT_ERROR_NOT_FOUND`	A chave ou índice fornecido não foi encontrado no armazenamento de configurações.
`OT_ERROR_NOT_IMPLEMENTED`	Esta função não está implementada nesta plataforma.

otPlatSettingsGet

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

Busca o valor de uma configuração.

Esta função busca o valor da configuração identificada por aKey e o grava na memória apontada por aValue. Em seguida, ele grava o comprimento no número inteiro apontado por aValueLength. O valor inicial de aValueLength é o número máximo de bytes a serem gravados em aValue.

Esta função pode ser usada para verificar a existência de uma chave sem buscar o valor, definindo aValue e aValueLength como NULL. Você também pode verificar o comprimento da configuração sem buscá-la, definindo apenas aValue como NULL.

Observe que a implementação de armazenamento subjacente não é necessária para manter a ordem das configurações com vários valores. A ordem de tais valores PODE mudar após QUALQUER operação de gravação na loja.

Detalhes

Parâmetros

`[in] aInstance`	A estrutura da instância OpenThread.
`[in] aKey`	A chave associada à configuração solicitada.
`[in] aIndex`	O índice do item específico a ser obtido.
`[out] aValue`	Um ponteiro para onde o valor da configuração deve ser escrito. Pode ser definido como NULL se estiver apenas testando a presença ou a duração de uma configuração.
`[in,out] aValueLength`	Um ponteiro para o comprimento do valor. Quando chamado, este ponteiro deve apontar para um inteiro contendo o tamanho máximo do valor que pode ser escrito em um valor. No retorno, a duração real da configuração é gravada. Isso pode ser definido como NULL se estiver executando uma verificação de presença.

Valores Retornados

`OT_ERROR_NONE`	A configuração fornecida foi encontrada e obtida com sucesso.
`OT_ERROR_NOT_FOUND`	A configuração fornecida não foi encontrada no armazenamento de configuração.
`OT_ERROR_NOT_IMPLEMENTED`	Esta função não está implementada nesta plataforma.

otPlatSettingsInit

void otPlatSettingsInit(
  otInstance *aInstance
)

Executa qualquer inicialização para o subsistema de configurações, se necessário.

Detalhes

Parâmetros

[in] aInstance

A estrutura da instância OpenThread.

otPlatSettingsSet

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

Define ou substitui o valor de uma configuração.

Esta função define ou substitui o valor de uma configuração identificada por aKey. Se houver mais de um valor associado anteriormente a aKey, todos eles serão excluídos e substituídos por essa única entrada.

Chamar essa função com êxito pode fazer com que configurações não relacionadas com vários valores sejam reordenadas.

Detalhes

Parâmetros

`[in] aInstance`	A estrutura da instância OpenThread.
`[in] aKey`	A chave associada à configuração a ser alterada.
`[in] aValue`	Um ponteiro para onde o novo valor da configuração deve ser lido. NÃO DEVE ser NULL se aValueLength for diferente de zero.
`[in] aValueLength`	O comprimento dos dados apontados por aValue. Pode ser zero.

Valores Retornados

`OT_ERROR_NONE`	A configuração fornecida foi alterada ou preparada.
`OT_ERROR_NOT_IMPLEMENTED`	Esta função não está implementada nesta plataforma.
`OT_ERROR_NO_BUFS`	Nenhum espaço restante para armazenar a configuração fornecida.

otPlatSettingsWipe

void otPlatSettingsWipe(
  otInstance *aInstance
)

Remove todas as configurações do armazenamento de configurações.

Esta função exclui todas as configurações do armazenamento de configurações, restaurando-o ao seu estado inicial de fábrica.

Detalhes

Parâmetros

[in] aInstance

A estrutura da instância OpenThread.