Impostazioni
Questo modulo include l'astrazione della piattaforma per l'archiviazione non volatile delle impostazioni.
Riepilogo
Enumerazioni |
|
---|---|
anonymous enum{
|
enum Questa enumerazione definisce le chiavi delle impostazioni. |
Functions |
|
---|---|
otPlatSettingsAdd(otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
|
Aggiunge un valore a un'impostazione.
|
otPlatSettingsDeinit(otInstance *aInstance)
|
void
Esegue l'eventuale inizializzazione per il sottosistema di impostazioni, se necessario.
|
otPlatSettingsDelete(otInstance *aInstance, uint16_t aKey, int aIndex)
|
Rimuove un'impostazione dall'archivio delle impostazioni.
|
otPlatSettingsGet(otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength)
|
Visualizza il valore di un'impostazione.
|
otPlatSettingsInit(otInstance *aInstance, const uint16_t *aSensitiveKeys, uint16_t aSensitiveKeysLength)
|
void
Esegue l'inizializzazione per il sottosistema di impostazioni, se necessario.
|
otPlatSettingsSet(otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
|
Imposta o sostituisce il valore di un'impostazione.
|
otPlatSettingsWipe(otInstance *aInstance)
|
void
Rimuove tutte le impostazioni dall'archivio delle impostazioni.
|
Enumerazioni
enumerazione anonima
anonymous enum
Questa enumerazione definisce le chiavi delle impostazioni.
Nota: quando aggiungi una nuova chiave delle impostazioni, se le impostazioni corrispondenti alla chiave contengono informazioni sensibili sulla sicurezza, lo sviluppatore DEVE aggiungere la chiave all'array aSensitiveKeys
che viene passato in otPlatSettingsInit()
.
Proprietà | |
---|---|
OT_SETTINGS_KEY_ACTIVE_DATASET
|
Set di dati operativo attivo. |
OT_SETTINGS_KEY_BR_ULA_PREFIX
|
Prefisso BR ULA. |
OT_SETTINGS_KEY_CHILD_INFO
|
Informazioni sul bambino. |
OT_SETTINGS_KEY_DAD_INFO
|
Informazioni sul rilevamento degli indirizzi duplicati (DAD). |
OT_SETTINGS_KEY_NETWORK_INFO
|
Cerca nelle informazioni sulla rete. |
OT_SETTINGS_KEY_PARENT_INFO
|
Informazioni sul genitore. |
OT_SETTINGS_KEY_PENDING_DATASET
|
Set di dati operativi in attesa. |
OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY
|
Chiave SLAAC per generare IID semanticamente opaco. |
OT_SETTINGS_KEY_SRP_CLIENT_INFO
|
Le informazioni sul client SRP (indirizzo del server SRP selezionato). |
OT_SETTINGS_KEY_SRP_ECDSA_KEY
|
Coppia di chiavi pubbliche/private per client ECDSA. |
OT_SETTINGS_KEY_SRP_SERVER_INFO
|
Le informazioni sul server SRP (porta UDP). |
Functions
OtPlatSettingsAdd
otError otPlatSettingsAdd( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
Aggiunge un valore a un'impostazione.
Questa funzione aggiunge il valore a un'impostazione identificata da aKey
, senza sostituire i valori esistenti.
Tieni presente che l'implementazione sottostante non è necessaria per mantenere l'ordine degli elementi associati a una chiave specifica. Il valore aggiunto può essere aggiunto alla fine, all'inizio o persino al centro. Anche l'ordine dei valori preesistenti può cambiare.
La chiamata corretta di questa funzione può causare il riordinamento delle impostazioni non correlate con più valori.
Lo stack OpenThread garantisce l'utilizzo del metodo otPlatSettingsAdd()
per un aKey
gestito in precedenza da otPlatSettingsAdd()
(ovvero contenente uno o più elementi) oppure vuoto e/o completamente eliminato (non contiene alcun valore).
Il livello piattaforma può fare affidamento su questo aspetto per ottimizzarne l'implementazione.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
|
||||||||
Valori di ritorno |
|
OtPlatImpostazioniDeinit
void otPlatSettingsDeinit( otInstance *aInstance )
Esegue l'eventuale inizializzazione per il sottosistema di impostazioni, se necessario.
Dettagli | |||
---|---|---|---|
Parametri |
|
otPlatSettingsDelete
otError otPlatSettingsDelete( otInstance *aInstance, uint16_t aKey, int aIndex )
Rimuove un'impostazione dall'archivio delle impostazioni.
Questa funzione elimina un valore specifico dall'impostazione identificata da aKey dall'archivio impostazioni.
Tieni presente che l'implementazione sottostante non è necessaria per mantenere l'ordine degli elementi associati a una chiave specifica.
Dettagli | |||||||
---|---|---|---|---|---|---|---|
Parametri |
|
||||||
Valori di ritorno |
|
OtPlatSettingsGet
otError otPlatSettingsGet( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength )
Visualizza il valore di un'impostazione.
Questa funzione recupera il valore dell'impostazione identificata da aKey
e la scrive nella memoria che punta a aValue. Quindi, scrive la lunghezza dell'intero numero puntato da aValueLength
. Il valore iniziale di aValueLength
è il numero massimo di byte da scrivere in aValue
.
Questa funzione può essere utilizzata per verificare l'esistenza di una chiave senza recuperare il valore impostando aValue
e aValueLength
su NULL. Puoi anche controllare la lunghezza dell'impostazione senza recuperarla impostando solo aValue su NULL.
Tieni presente che non è necessaria l'implementazione dello spazio di archiviazione sottostante per mantenere l'ordine delle impostazioni con più valori. L'ordine di tali valori POTREBBE cambiare dopo una qualsiasi operazione di scrittura nello store.
Dettagli | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parametri |
|
||||||||||
Valori di ritorno |
|
OtPlatSettingsInit
void otPlatSettingsInit( otInstance *aInstance, const uint16_t *aSensitiveKeys, uint16_t aSensitiveKeysLength )
Esegue l'inizializzazione per il sottosistema di impostazioni, se necessario.
Questa funzione imposta anche le chiavi sensibili che devono essere memorizzate nell'area protetta.
Tieni presente che la memoria indicata da aSensitiveKeys
DEVE non essere rimossa prima dell'eliminazione di aInstance
.
Dettagli | |||||||
---|---|---|---|---|---|---|---|
Parametri |
|
OtPlatSettingsSet
otError otPlatSettingsSet( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
Imposta o sostituisce il valore di un'impostazione.
Questa funzione imposta o sostituisce il valore di un'impostazione identificata da aKey
.
La chiamata corretta di questa funzione può causare il riordinamento delle impostazioni non correlate con più valori.
Lo stack OpenThread garantisce l'utilizzo del metodo otPlatSettingsSet()
per un aKey
impostato in precedenza tramite otPlatSettingsSet()
(ovvero contenente un singolo valore) o vuoto e/o completamente eliminato (non contiene alcun valore).
Il livello piattaforma può fare affidamento su questo aspetto per ottimizzarne l'implementazione.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
|
||||||||
Valori di ritorno |
|
Cancellazione impostazioni
void otPlatSettingsWipe( otInstance *aInstance )
Rimuove tutte le impostazioni dall'archivio delle impostazioni.
Questa funzione elimina tutte le impostazioni dall'archivio impostazioni, ripristinandone lo stato di fabbrica iniziale.
Dettagli | |||
---|---|---|---|
Parametri |
|
Risorse
Gli argomenti di riferimento per l'API OpenThread provengono dal codice sorgente, disponibile su GitHub. Per ulteriori informazioni o per contribuire alla nostra documentazione, consulta la sezione Risorse.