設定值
該模塊包括用於非易失性存儲設置的平台抽象。
概括
枚舉 | |
---|---|
anonymous enum { | 枚舉 該枚舉定義了設置鍵。 |
功能 | |
---|---|
otPlatSettingsAdd ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength) | 向設置添加值。 |
otPlatSettingsDeinit ( otInstance *aInstance) | void 如有必要,對設置子系統執行任何取消初始化操作。 |
otPlatSettingsDelete ( otInstance *aInstance, uint16_t aKey, int aIndex) | 從設置存儲中刪除設置。 |
otPlatSettingsGet ( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength) | 獲取設置的值。 |
otPlatSettingsInit ( otInstance *aInstance) | void 如有必要,對設置子系統執行任何初始化。 |
otPlatSettingsSet ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength) | 設置或替換設置的值。 |
otPlatSettingsSetCriticalKeys ( otInstance *aInstance, const uint16_t *aKeys, uint16_t aKeysLength) | void 此功能設置應存儲在安全區域中的關鍵密鑰。 |
otPlatSettingsWipe ( otInstance *aInstance) | void 從設置存儲中刪除所有設置。 |
枚舉
匿名枚舉
anonymous enum
該枚舉定義了設置鍵。
注意:添加新的設置密鑰時,如果與密鑰相對應的設置包含安全敏感信息,則開發人員必須將密鑰添加到數組kCriticalKeys
。
功能
otPlatSettingsAdd
otError otPlatSettingsAdd( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
向設置添加值。
此功能將值添加到由aKey標識的設置中,而不替換任何現有值。
請注意,不需要底層實現來維護與特定鍵關聯的項的順序。附加值可以添加到結尾,開頭甚至中間的某個位置。任何預先存在的值的順序也可能會更改。
成功調用此函數可能會導致對具有多個值的不相關設置進行重新排序。
細節 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參數 |
| ||||||||
返回值 |
|
otPlatSettingsDeinit
void otPlatSettingsDeinit( otInstance *aInstance )
如有必要,對設置子系統執行任何取消初始化操作。
細節 | |||
---|---|---|---|
參數 |
|
otPlatSettingsDelete
otError otPlatSettingsDelete( otInstance *aInstance, uint16_t aKey, int aIndex )
從設置存儲中刪除設置。
此功能從設置存儲中由aKey標識的設置中刪除特定值。
請注意,不需要底層實現來維護與特定鍵關聯的項的順序。
細節 | |||||||
---|---|---|---|---|---|---|---|
參數 |
| ||||||
返回值 |
|
otPlatSettingsGet
otError otPlatSettingsGet( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength )
獲取設置的值。
該函數獲取由aKey標識的設置的值,並將其寫入aValue指向的內存中。然後,將長度寫入aValueLength指向的整數。 aValueLength的初始值是要寫入aValue的最大字節數。
通過將aValue和aValueLength設置為NULL,此函數可用於檢查鍵的存在而無需獲取值。您也可以通過僅將aValue設置為NULL來檢查設置的長度而無需獲取設置。
請注意,不需要基礎存儲實現即可維護具有多個值的設置順序。在對存儲進行任何寫操作後,此類值的順序可能會更改。
細節 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
參數 |
| ||||||||||
返回值 |
|
otPlatSettingsInit
void otPlatSettingsInit( otInstance *aInstance )
如有必要,對設置子系統執行任何初始化。
細節 | |||
---|---|---|---|
參數 |
|
otPlatSettingsSet
otError otPlatSettingsSet( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
設置或替換設置的值。
此功能設置或替換由aKey標識的設置的值。如果先前有多個與aKey關聯的值,則將它們全部刪除並替換為該單個條目。
成功調用此函數可能會導致對具有多個值的不相關設置進行重新排序。
細節 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參數 |
| ||||||||
返回值 |
|
otPlatSettingsSetCriticalKeys
void otPlatSettingsSetCriticalKeys( otInstance *aInstance, const uint16_t *aKeys, uint16_t aKeysLength )
此功能設置應存儲在安全區域中的關鍵密鑰。
請注意,在銷毀aInstance
之前,不得釋放由aKeys
指向的內存。
細節 | |||||||
---|---|---|---|---|---|---|---|
參數 |
|
otPlatSettingsWipe
void otPlatSettingsWipe( otInstance *aInstance )
從設置存儲中刪除所有設置。
此功能從設置存儲中刪除所有設置,並將其重置為初始出廠狀態。
細節 | |||
---|---|---|---|
參數 |
|