impostazioni

Questo modulo include l'astrazione della piattaforma per la memorizzazione non volatile delle impostazioni.

Sommario

Enumerazioni
`anonymous enum { OT_SETTINGS_KEY_ACTIVE_DATASET = 0x0001, OT_SETTINGS_KEY_PENDING_DATASET = 0x0002, OT_SETTINGS_KEY_NETWORK_INFO = 0x0003, OT_SETTINGS_KEY_PARENT_INFO = 0x0004, OT_SETTINGS_KEY_CHILD_INFO = 0x0005, OT_SETTINGS_KEY_RESERVED = 0x0006, OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY = 0x0007, OT_SETTINGS_KEY_DAD_INFO = 0x0008, OT_SETTINGS_KEY_OMR_PREFIX = 0x0009, OT_SETTINGS_KEY_ON_LINK_PREFIX = 0x000a, OT_SETTINGS_KEY_SRP_ECDSA_KEY = 0x000b }`	enum Questa enumerazione definisce le chiavi delle impostazioni.

Enumerazioni

anonymous enum {
 OT_SETTINGS_KEY_ACTIVE_DATASET = 0x0001,
 OT_SETTINGS_KEY_PENDING_DATASET = 0x0002,
 OT_SETTINGS_KEY_NETWORK_INFO = 0x0003,
 OT_SETTINGS_KEY_PARENT_INFO = 0x0004,
 OT_SETTINGS_KEY_CHILD_INFO = 0x0005,
 OT_SETTINGS_KEY_RESERVED = 0x0006,
 OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY = 0x0007,
 OT_SETTINGS_KEY_DAD_INFO = 0x0008,
 OT_SETTINGS_KEY_OMR_PREFIX = 0x0009,
 OT_SETTINGS_KEY_ON_LINK_PREFIX = 0x000a,
 OT_SETTINGS_KEY_SRP_ECDSA_KEY = 0x000b
 }

enum

Questa enumerazione definisce le chiavi delle impostazioni.

Funzioni
`otPlatSettingsAdd ( otInstance aInstance, uint16_t aKey, const uint8_t aValue, uint16_t aValueLength)`	`otError` Aggiunge un valore a un'impostazione.
`otPlatSettingsDeinit ( otInstance *aInstance)`	`void` Esegue qualsiasi de-inizializzazione per il sottosistema delle impostazioni, se necessario.
`otPlatSettingsDelete ( otInstance *aInstance, uint16_t aKey, int aIndex)`	`otError` Rimuove un'impostazione dall'archivio impostazioni.
`otPlatSettingsGet ( otInstance aInstance, uint16_t aKey, int aIndex, uint8_t aValue, uint16_t *aValueLength)`	`otError` Recupera il valore di un'impostazione.
`otPlatSettingsInit ( otInstance *aInstance)`	`void` Esegue qualsiasi inizializzazione per il sottosistema delle impostazioni, se necessario.
`otPlatSettingsSet ( otInstance aInstance, uint16_t aKey, const uint8_t aValue, uint16_t aValueLength)`	`otError` Imposta o sostituisce il valore di un'impostazione.
`otPlatSettingsSetCriticalKeys ( otInstance aInstance, const uint16_t aKeys, uint16_t aKeysLength)`	`void` Questa funzione imposta le chiavi critiche che devono essere archiviate nell'area protetta.
`otPlatSettingsWipe ( otInstance *aInstance)`	`void` Rimuove tutte le impostazioni dall'archivio impostazioni.

Enumerazioni

enumerazione anonima

 anonymous enum

Questa enumerazione definisce le chiavi delle impostazioni.

Nota: quando si aggiunge una nuova chiave di impostazione, se le impostazioni corrispondenti alla chiave contengono informazioni sensibili alla sicurezza, lo sviluppatore DEVE aggiungere la chiave all'array kCriticalKeys .

Proprietà
`OT_SETTINGS_KEY_ACTIVE_DATASET`	Set di dati operativi attivi.
`OT_SETTINGS_KEY_CHILD_INFO`	Informazioni sui bambini.
`OT_SETTINGS_KEY_DAD_INFO`	Informazioni su Duplicate Address Detection (DAD).
`OT_SETTINGS_KEY_NETWORK_INFO`	Informazioni sulla rete dei thread.
`OT_SETTINGS_KEY_OMR_PREFIX`	Prefisso instradabile off-mesh (OMR).
`OT_SETTINGS_KEY_ON_LINK_PREFIX`	Prefisso on-link per collegamento infrastruttura.
`OT_SETTINGS_KEY_PARENT_INFO`	Informazioni sui genitori.
`OT_SETTINGS_KEY_PENDING_DATASET`	Set di dati operativi in sospeso.
`OT_SETTINGS_KEY_RESERVED`	Riservato (in precedenza avvio automatico).
`OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY`	Chiave SLAAC per generare IID semanticamente opaco.
`OT_SETTINGS_KEY_SRP_ECDSA_KEY`	Coppia di chiavi pubblica / privata ECDSA client SRP.

Funzioni

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 alcun valore esistente.

Si noti 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 anche da qualche parte nel mezzo. Anche l'ordine di eventuali valori preesistenti può cambiare.

La chiamata corretta di questa funzione può causare il riordino di impostazioni non correlate con più valori.

Dettagli

Parametri

`[in] aInstance`	La struttura dell'istanza OpenThread.
`[in] aKey`	La chiave associata all'impostazione da modificare.
`[in] aValue`	Un puntatore da cui leggere il nuovo valore dell'impostazione. NON DEVE essere NULL se aValueLength è diverso da zero.
`[in] aValueLength`	La lunghezza dei dati puntati da aValue. Può essere zero.

Valori restituiti

`OT_ERROR_NONE`	L'impostazione data è stata aggiunta o messa in scena per essere aggiunta.
`OT_ERROR_NOT_IMPLEMENTED`	Questa funzione non è implementata su questa piattaforma.
`OT_ERROR_NO_BUFS`	Nessuno spazio rimanente per memorizzare l'impostazione data.

otPlatSettingsDeinit

void otPlatSettingsDeinit(
  otInstance *aInstance
)

Esegue qualsiasi de-inizializzazione per il sottosistema delle impostazioni, se necessario.

Dettagli

Parametri

[in] aInstance

La struttura dell'istanza OpenThread.

otPlatSettingsDelete

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

Rimuove un'impostazione dall'archivio impostazioni.

Questa funzione elimina un valore specifico dall'impostazione identificata da aKey dall'archivio impostazioni.

Si noti che l'implementazione sottostante non è necessaria per mantenere l'ordine degli elementi associati a una chiave specifica.

Dettagli

Parametri

`[in] aInstance`	La struttura dell'istanza OpenThread.
`[in] aKey`	La chiave associata all'impostazione richiesta.
`[in] aIndex`	L'indice del valore da rimuovere. Se impostato su -1, tutti i valori per questa aKey verranno rimossi.

Valori restituiti

`OT_ERROR_NONE`	La chiave e l'indice forniti sono stati trovati e rimossi correttamente.
`OT_ERROR_NOT_FOUND`	La chiave o l'indice specificato non è stato trovato nell'archivio delle impostazioni.
`OT_ERROR_NOT_IMPLEMENTED`	Questa funzione non è implementata su questa piattaforma.

otPlatSettingsGet

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

Recupera il valore di un'impostazione.

Questa funzione preleva il valore dell'impostazione identificato da aKey e lo scrive nella memoria puntata da aValue. Quindi scrive la lunghezza sull'intero 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. È anche possibile controllare la lunghezza dell'impostazione senza recuperarla impostando solo aValue su NULL.

Si noti che l'implementazione dell'archiviazione sottostante non è necessaria per mantenere l'ordine delle impostazioni con più valori. L'ordine di tali valori PU cambiare dopo QUALSIASI operazione di scrittura nel negozio.

Dettagli

Parametri

`[in] aInstance`	La struttura dell'istanza OpenThread.
`[in] aKey`	La chiave associata all'impostazione richiesta.
`[in] aIndex`	L'indice dell'articolo specifico da ottenere.
`[out] aValue`	Un puntatore al punto in cui deve essere scritto il valore dell'impostazione. Può essere impostato su NULL se si verifica solo la presenza o la lunghezza di un'impostazione.
`[in,out] aValueLength`	Un puntatore alla lunghezza del valore. Quando viene chiamato, questo puntatore dovrebbe puntare a un numero intero contenente la dimensione massima del valore che può essere scritta in aValue. Al ritorno, viene scritta la lunghezza effettiva dell'impostazione. Può essere impostato su NULL se si esegue un controllo di presenza.

Valori restituiti

`OT_ERROR_NONE`	L'impostazione fornita è stata trovata e recuperata correttamente.
`OT_ERROR_NOT_FOUND`	L'impostazione data non è stata trovata nell'archivio impostazioni.
`OT_ERROR_NOT_IMPLEMENTED`	Questa funzione non è implementata su questa piattaforma.

otPlatSettingsInit

void otPlatSettingsInit(
  otInstance *aInstance
)

Se necessario, esegue qualsiasi inizializzazione per il sottosistema delle impostazioni.

Dettagli

Parametri

[in] aInstance

La struttura dell'istanza OpenThread.

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. Se era presente più di un valore precedentemente associato a aKey, vengono tutti eliminati e sostituiti con questa singola voce.

La chiamata corretta di questa funzione può causare il riordino di impostazioni non correlate con più valori.

Dettagli

Parametri

`[in] aInstance`	La struttura dell'istanza OpenThread.
`[in] aKey`	La chiave associata all'impostazione da modificare.
`[in] aValue`	Un puntatore alla posizione da cui leggere il nuovo valore dell'impostazione. NON DEVE essere NULL se aValueLength è diverso da zero.
`[in] aValueLength`	La lunghezza dei dati puntati da aValue. Può essere zero.

Valori restituiti

`OT_ERROR_NONE`	L'impostazione data è stata modificata o messa in scena.
`OT_ERROR_NOT_IMPLEMENTED`	Questa funzione non è implementata su questa piattaforma.
`OT_ERROR_NO_BUFS`	Nessuno spazio rimanente per memorizzare l'impostazione data.

otPlatSettingsSetCriticalKeys

void otPlatSettingsSetCriticalKeys(
  otInstance *aInstance,
  const uint16_t *aKeys,
  uint16_t aKeysLength
)

Questa funzione imposta le chiavi critiche che devono essere archiviate nell'area protetta.

Notare che la memoria puntata da aKeys non DEVE essere rilasciata prima che aInstance venga distrutta.

Dettagli

Parametri

`[in] aInstance`	La struttura dell'istanza OpenThread.
`[in] aKeys`	Puntatore a una matrice contenente l'elenco delle chiavi critiche.
`[in] aKeysLength`	Il numero di voci nell'array `aKeys` .

otPlatSettingsWipe

void otPlatSettingsWipe(
  otInstance *aInstance
)

Rimuove tutte le impostazioni dall'archivio impostazioni.

Questa funzione cancella tutte le impostazioni dalla memoria delle impostazioni, riportandola allo stato di fabbrica iniziale.

Dettagli

Parametri

[in] aInstance

La struttura dell'istanza OpenThread.