Configuración
Este módulo incluye la abstracción de la plataforma para el almacenamiento no volátil de la configuración.
Resumen
Enumeraciones |
|
---|---|
anonymous enum{
|
enum En esta enumeración, se definen las claves de configuración. |
Functions |
|
---|---|
otPlatSettingsAdd(otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
|
Agrega un valor a una configuración.
|
otPlatSettingsDeinit(otInstance *aInstance)
|
void
Si es necesario, realiza cualquier proceso de inicialización del subsistema de configuración.
|
otPlatSettingsDelete(otInstance *aInstance, uint16_t aKey, int aIndex)
|
Quita una opción de configuración de la tienda de parámetros.
|
otPlatSettingsGet(otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength)
|
Recupera el valor de una configuración.
|
otPlatSettingsInit(otInstance *aInstance, const uint16_t *aSensitiveKeys, uint16_t aSensitiveKeysLength)
|
void
Si es necesario, realiza cualquier inicialización del subsistema de configuración.
|
otPlatSettingsSet(otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
|
Establece o reemplaza el valor de una configuración.
|
otPlatSettingsWipe(otInstance *aInstance)
|
void
Quita todos los parámetros de configuración del almacén.
|
Enumeraciones
enumeración anónima
anonymous enum
En esta enumeración, se definen las claves de configuración.
Nota: Cuando se agrega una nueva clave de configuración, si la configuración correspondiente a la clave contiene información sensible de seguridad, el desarrollador DEBE agregar la clave al arreglo kSensitiveKeys
.
Properties | |
---|---|
OT_SETTINGS_KEY_ACTIVE_DATASET
|
Conjunto de datos operativo activo. |
OT_SETTINGS_KEY_BR_ULA_PREFIX
|
Prefijo BR ULA. |
OT_SETTINGS_KEY_CHILD_INFO
|
Información del niño |
OT_SETTINGS_KEY_DAD_INFO
|
Información de detección de dirección duplicada (DAD) |
OT_SETTINGS_KEY_LEGACY_NAT64_PREFIX
|
Reservados. Prefijo NAT64 heredado. |
OT_SETTINGS_KEY_LEGACY_OMR_PREFIX
|
Reservados. Prefijo heredado de enrutamiento de malla (OMR). |
OT_SETTINGS_KEY_NETWORK_INFO
|
Información de red de subprocesos. |
OT_SETTINGS_KEY_ON_LINK_PREFIX
|
Prefijo en el vínculo de vínculo de infraestructura. |
OT_SETTINGS_KEY_PARENT_INFO
|
Información de los padres |
OT_SETTINGS_KEY_PENDING_DATASET
|
Conjunto de datos operativo pendiente. |
OT_SETTINGS_KEY_RESERVED
|
Reservado (antes llamado inicio automático) |
OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY
|
La clave de ANSAC para generar un IID semántico opaco. |
OT_SETTINGS_KEY_SRP_CLIENT_INFO
|
La información del cliente de SRP (dirección del servidor de SRP seleccionada). |
OT_SETTINGS_KEY_SRP_ECDSA_KEY
|
Par de claves públicas/privadas ECDSA del cliente. |
OT_SETTINGS_KEY_SRP_SERVER_INFO
|
La información del servidor SRP (puerto UDP). |
Functions
OtPlatSettingsAdd
otError otPlatSettingsAdd( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
Agrega un valor a una configuración.
Esta función agrega el valor a una configuración identificada por aKey, sin reemplazar ningún valor existente.
Ten en cuenta que la implementación subyacente no es necesaria para mantener el orden de los elementos asociados con una clave específica. El valor agregado se puede agregar al final, al principio o incluso en algún punto intermedio. El orden de los valores preexistentes también puede cambiar.
Si se llama a esta función correctamente, es posible que se reordenen los valores no relacionados con los valores no relacionados.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
otPlatSettingsDeinit
void otPlatSettingsDeinit( otInstance *aInstance )
Si es necesario, realiza cualquier proceso de inicialización del subsistema de configuración.
Detalles | |||
---|---|---|---|
Parámetros |
|
otPlatSettingsDelete
otError otPlatSettingsDelete( otInstance *aInstance, uint16_t aKey, int aIndex )
Quita una opción de configuración de la tienda de parámetros.
Esta función borra un valor específico de la configuración que identifica aKey del almacén de configuración.
Ten en cuenta que la implementación subyacente no es necesaria para mantener el orden de los elementos asociados con una clave específica.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores que se muestran |
|
OtPlatSettingsGet
otError otPlatSettingsGet( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength )
Recupera el valor de una configuración.
Esta función recupera el valor de la configuración que identifica aKey y la escribe en la memoria a la que apunta aValue. Luego, escribe la longitud en el número entero al que apunta aValueValue. El valor inicial de aValueLength es la cantidad máxima de bytes que se escriben en aValue.
Esta función se puede usar para verificar la existencia de una clave sin recuperar el valor configurando aValue y aValueLength como NULL. También puedes verificar la longitud de la configuración sin recuperarla configurando solo aValue como NULL.
Ten en cuenta que no es necesario que implementes la implementación de almacenamiento subyacente para mantener el orden de los parámetros de configuración con varios valores. El orden de tales valores PUEDE cambiar después de CUALQUIER operación de escritura en la tienda.
Detalles | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||
Valores que se muestran |
|
otPlatSettingsInit
void otPlatSettingsInit( otInstance *aInstance, const uint16_t *aSensitiveKeys, uint16_t aSensitiveKeysLength )
Si es necesario, realiza cualquier inicialización del subsistema de configuración.
Esta función también configura las claves sensibles que se deben almacenar en el área segura.
Ten en cuenta que la memoria dirigida por aSensitiveKeys
DEBE no liberarse antes de que se destruya aInstance
.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otPlatSettingsSet
otError otPlatSettingsSet( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
Establece o reemplaza el valor de una configuración.
Esta función establece o reemplaza el valor de una configuración identificada por aKey. Si había más de un valor asociado con aKey, se borran y se reemplazan con esta entrada única.
Si se llama a esta función correctamente, es posible que se reordenen los valores no relacionados con los valores no relacionados.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
OtPlatSettingswipe
void otPlatSettingsWipe( otInstance *aInstance )
Quita todos los parámetros de configuración del almacén.
Esta función borra todos los parámetros de configuración del almacén, lo que restablece el estado de fábrica inicial.
Detalles | |||
---|---|---|---|
Parámetros |
|
Recursos
Los temas de referencia de la API de OpenThread se originan en el código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta Recursos.