Configurações
Este módulo inclui a abstração de plataforma para armazenamento não volátil de configurações.
Resumo
Enumerações |
|
---|---|
anonymous enum{
|
tipo enumerado Essa enumeração define as chaves das configurações. |
Funções |
|
---|---|
otPlatSettingsAdd(otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
|
Adiciona um valor a uma configuração.
|
otPlatSettingsDeinit(otInstance *aInstance)
|
void
Realiza qualquer inicialização do subsistema de configurações, se necessário.
|
otPlatSettingsDelete(otInstance *aInstance, uint16_t aKey, int aIndex)
|
Remove uma configuração do armazenamento de configurações.
|
otPlatSettingsGet(otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength)
|
Busca o valor de uma configuração.
|
otPlatSettingsInit(otInstance *aInstance, const uint16_t *aSensitiveKeys, uint16_t aSensitiveKeysLength)
|
void
Executa qualquer inicialização do subsistema de configurações, se necessário.
|
otPlatSettingsSet(otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
|
Define ou substitui o valor de uma configuração.
|
otPlatSettingsWipe(otInstance *aInstance)
|
void
Remove todas as configurações do armazenamento de configurações.
|
Enumerações
enumeração anônima
anonymous enum
Essa enumeração define as chaves das configurações.
Observação: ao adicionar uma nova chave de configurações, se as configurações correspondentes à chave tiverem informações confidenciais de segurança, o desenvolvedor PRECISA adicionar a chave à matriz aSensitiveKeys
, que é transmitida em otPlatSettingsInit()
.
Propriedades | |
---|---|
OT_SETTINGS_KEY_ACTIVE_DATASET
|
Conjunto de dados operacional ativo. |
OT_SETTINGS_KEY_BORDER_AGENT_ID
|
ID de roteador/agente de borda exclusivo. |
OT_SETTINGS_KEY_BR_ON_LINK_PREFIXES
|
Prefixos locais do link BR. |
OT_SETTINGS_KEY_BR_ULA_PREFIX
|
BR ULA. |
OT_SETTINGS_KEY_CHILD_INFO
|
Informações filhas. |
OT_SETTINGS_KEY_DAD_INFO
|
Informações de detecção de endereço duplicado (DAD). |
OT_SETTINGS_KEY_NETWORK_INFO
|
Informações da rede Thread. |
OT_SETTINGS_KEY_PARENT_INFO
|
Informações do responsável. |
OT_SETTINGS_KEY_PENDING_DATASET
|
Conjunto de dados operacional pendente. |
OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY
|
Chave SLAAC para gerar IID semanticamente opaca. |
OT_SETTINGS_KEY_SRP_CLIENT_INFO
|
As informações do cliente SRP (endereço do servidor SRP selecionado). |
OT_SETTINGS_KEY_SRP_ECDSA_KEY
|
Par de chaves pública/privada ECDSA do cliente SRP. |
OT_SETTINGS_KEY_SRP_SERVER_INFO
|
As informações do servidor SRP (porta UDP). |
Funções
Configurações de adição de configurações
otError otPlatSettingsAdd( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
Adiciona um valor a uma configuração.
Essa função adiciona o valor a uma configuração identificada por aKey
, sem substituir os valores existentes.
A implementação não é necessária para manter a ordem dos itens associados a uma chave específica. O valor adicionado pode ser adicionado ao final, ao início ou até mesmo no meio. A ordem dos valores preexistentes também pode mudar.
Chamar essa função pode fazer com que configurações não relacionadas com vários valores sejam reordenadas.
A pilha do OpenThread garante o uso do método otPlatSettingsAdd()
para um aKey
gerenciado anteriormente por otPlatSettingsAdd()
(ou seja, contém um ou mais itens) ou está vazio e/ou totalmente excluído (não tem valor).
A camada de plataforma pode confiar e usar esse fato para otimizar sua implementação.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtPlatSettingsDeinit
void otPlatSettingsDeinit( otInstance *aInstance )
Realiza qualquer inicialização do subsistema de configurações, se necessário.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
OpPlatSettingsDelete
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.
A implementação não é necessária para manter a ordem dos itens associados a uma chave específica.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
Configurações de otPlatSettingsGet
otError otPlatSettingsGet( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength )
Busca o valor de uma configuração.
Essa função busca o valor da configuração identificada por aKey
e a 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
.
Essa função pode ser usada para verificar a existência de uma chave sem buscar o valor definindo aValue
e aValueLength
como NULL. Também é possível verificar o comprimento da configuração sem buscá-la definindo apenas aValue para NULL.
A implementação de armazenamento subjacente não é necessária para manter a ordem das configurações com vários valores. A ordem desses valores PODE mudar após QUALQUER operação de gravação no armazenamento.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||
Valores de retorno |
|
OpPlatSettingsInit
void otPlatSettingsInit( otInstance *aInstance, const uint16_t *aSensitiveKeys, uint16_t aSensitiveKeysLength )
Executa qualquer inicialização do subsistema de configurações, se necessário.
Essa função também define as chaves confidenciais que precisam ser armazenadas na área segura.
A memória apontada por aSensitiveKeys
NÃO PODE ser liberada antes que aInstance
seja destruído.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
Configuração de configurações otPlat
otError otPlatSettingsSet( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
Define ou substitui o valor de uma configuração.
Essa função define ou substitui o valor de uma configuração identificada por aKey
.
Chamar essa função pode fazer com que configurações não relacionadas com vários valores sejam reordenadas.
A pilha do OpenThread garante o uso do método otPlatSettingsSet()
para um aKey
que foi definido anteriormente usando otPlatSettingsSet()
(ou seja, contém um único valor) ou está vazio e/ou totalmente excluído (não contém valor).
A camada de plataforma pode confiar e usar esse fato para otimizar sua implementação.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
otPlatSettingsWipe
void otPlatSettingsWipe( otInstance *aInstance )
Remove todas as configurações do armazenamento de configurações.
Essa função exclui todas as configurações do armazenamento de configurações, redefinindo-a para o estado inicial de fábrica.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
Recursos
Os tópicos de referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para mais informações ou para contribuir com nossa documentação, consulte Recursos.