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. |
Funciones |
|
---|---|
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 del almacén correspondiente.
|
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 la 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 toda la configuración del almacén de parámetros.
|
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 array aSensitiveKeys
que se pasa en otPlatSettingsInit()
.
Propiedades | |
---|---|
OT_SETTINGS_KEY_ACTIVE_DATASET
|
Conjunto de datos operativo activo. |
OT_SETTINGS_KEY_BORDER_AGENT_ID
|
ID de router/agente de borde único |
OT_SETTINGS_KEY_BR_ON_LINK_PREFIXES
|
Prefijos locales de BR de Brasil. |
OT_SETTINGS_KEY_BR_ULA_PREFIX
|
Prefijo de la ULA de BR. |
OT_SETTINGS_KEY_CHILD_INFO
|
Información del publicador secundario |
OT_SETTINGS_KEY_DAD_INFO
|
Información de detección de direcciones duplicadas (DAD) |
OT_SETTINGS_KEY_NETWORK_INFO
|
Información de red de subprocesos. |
OT_SETTINGS_KEY_PARENT_INFO
|
Información de los padres |
OT_SETTINGS_KEY_PENDING_DATASET
|
Conjunto de datos operativo pendiente. |
OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY
|
Clave ANSAC para generar un IID opaco semánticamente. |
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ública/privada del cliente de SRP. |
OT_SETTINGS_KEY_SRP_SERVER_INFO
|
La información del servidor SRP (puerto UDP). |
Funciones
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 un parámetro de configuración identificado por aKey
, sin reemplazar ningún valor existente.
Ten en cuenta que no se requiere la implementación subyacente 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, a la mitad. El orden de los valores preexistentes también puede cambiar.
Si se llama correctamente a esta función, es posible que se reordene la configuración no relacionada con los valores múltiples.
La pila de OpenThread garantiza el uso del método otPlatSettingsAdd()
para un aKey
administrado anteriormente por otPlatSettingsAdd()
(es decir, contiene uno o más elementos) o está vacío o se borró por completo (no contiene valor).
La capa de la plataforma puede usar este hecho para optimizar su implementación.
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 del almacén correspondiente.
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 no se requiere la implementación subyacente para mantener el orden de los elementos asociados con una clave específica.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores que se muestran |
|
Configuración de la plataforma
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 lo escribe en la memoria a la que apunta aValue. Luego, escribe la longitud en el número entero al que apunta aValueLength
. El valor inicial de aValueLength
es la cantidad máxima de bytes que se escribirán en aValue
.
Esta función se puede usar para verificar la existencia de una clave sin recuperar el valor mediante la configuración de aValue
y aValueLength
como NULL. También puedes verificar la longitud de la configuración sin recuperarla estableciendo aValue como valor nulo.
Ten en cuenta que la implementación de almacenamiento subyacente no es necesaria para mantener el orden de la configuración con varios valores. El orden de dichos 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 la inicialización del subsistema de configuración.
Esta función también configura las claves sensibles que deben almacenarse en el área segura.
Ten en cuenta que la memoria a la que apunta aSensitiveKeys
debe liberarse antes de que se destruya aInstance
.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
Configuración de la plataforma
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 un parámetro de configuración identificado por aKey
.
Si se llama correctamente a esta función, es posible que se reordene la configuración no relacionada con los valores múltiples.
La pila de OpenThread garantiza el uso del método otPlatSettingsSet()
para un elemento aKey
que se configuró previamente con otPlatSettingsSet()
(es decir, contiene un solo valor) o está vacío o se borró por completo (no contiene ningún valor).
La capa de la plataforma puede usar este hecho para optimizar su implementación.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
otPlatSettingsWipe
void otPlatSettingsWipe( otInstance *aInstance )
Quita toda la configuración del almacén de parámetros.
Esta función borra todos los parámetros de configuración del almacén correspondiente y los restablece al estado de fábrica inicial.
Detalles | |||
---|---|---|---|
Parámetros |
|
Recursos
Los temas de referencia de la API de OpenThread se originan a partir del código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta la sección Recursos.