Se usó la API de Cloud Translation para traducir esta página.

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{ 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_SLAAC_IID_SECRET_KEY = 0x0007, OT_SETTINGS_KEY_DAD_INFO = 0x0008, OT_SETTINGS_KEY_SRP_ECDSA_KEY = 0x000b, OT_SETTINGS_KEY_SRP_CLIENT_INFO = 0x000c, OT_SETTINGS_KEY_SRP_SERVER_INFO = 0x000d, OT_SETTINGS_KEY_BR_ULA_PREFIX = 0x000f, OT_SETTINGS_KEY_BR_ON_LINK_PREFIXES = 0x0010 }	Enum Esta enumeración define las claves de configuración.

Enumeraciones

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_SLAAC_IID_SECRET_KEY = 0x0007,
  OT_SETTINGS_KEY_DAD_INFO = 0x0008,
  OT_SETTINGS_KEY_SRP_ECDSA_KEY = 0x000b,
  OT_SETTINGS_KEY_SRP_CLIENT_INFO = 0x000c,
  OT_SETTINGS_KEY_SRP_SERVER_INFO = 0x000d,
  OT_SETTINGS_KEY_BR_ULA_PREFIX = 0x000f,
  OT_SETTINGS_KEY_BR_ON_LINK_PREFIXES = 0x0010
}

Enum

Esta enumeración define las claves de configuración.

Funciones
`otPlatSettingsAdd(otInstance aInstance, uint16_t aKey, const uint8_t aValue, uint16_t aValueLength)`	`otError` Agrega un valor a una configuración.
`otPlatSettingsDeinit(otInstance *aInstance)`	`void` Si es necesario, realiza cualquier proceso de inicialización para el subsistema de configuración.
`otPlatSettingsDelete(otInstance *aInstance, uint16_t aKey, int aIndex)`	`otError` Elimina una opción de configuración del almacén de configuraciones.
`otPlatSettingsGet(otInstance aInstance, uint16_t aKey, int aIndex, uint8_t aValue, uint16_t *aValueLength)`	`otError` Recupera el valor de una configuración.
`otPlatSettingsInit(otInstance aInstance, const uint16_t aSensitiveKeys, uint16_t aSensitiveKeysLength)`	`void` Realiza cualquier proceso de inicialización para el subsistema de configuración, si es necesario.
`otPlatSettingsSet(otInstance aInstance, uint16_t aKey, const uint8_t aValue, uint16_t aValueLength)`	`otError` Establece o reemplaza el valor de una configuración.
`otPlatSettingsWipe(otInstance *aInstance)`	`void` Elimina toda la configuración del almacén de configuraciones.

Enumeraciones

enumeración anónima

 anonymous enum

Esta enumeración define 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 a la seguridad, el desarrollador DEBE agregar la clave al arreglo aSensitiveKeys que se pasa en otPlatSettingsInit().

Propiedades
`OT_SETTINGS_KEY_ACTIVE_DATASET`	Conjunto de datos operativo activo.
`OT_SETTINGS_KEY_BR_ON_LINK_PREFIXES`	BR prefijos de vínculos locales.
`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 direcciones duplicadas (DAD).
`OT_SETTINGS_KEY_NETWORK_INFO`	Información de red del subproceso.
`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`	La clave de ANSAC para generar un IID semánticamente opaco.
`OT_SETTINGS_KEY_SRP_CLIENT_INFO`	La información del cliente SRP (dirección de servidor SRP seleccionada).
`OT_SETTINGS_KEY_SRP_ECDSA_KEY`	Par de claves pública/privada del cliente de SRP ECDSA.
`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 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 comienzo o incluso en algún punto intermedio. El orden de los valores preexistentes también puede cambiar.

Si se llama correctamente a esta función, es posible que se reordenen varios valores que no están relacionados con la configuración.

La pila de OpenThread garantiza el uso del método otPlatSettingsAdd() para un elemento aKey administrado anteriormente por otPlatSettingsAdd() (es decir, contiene uno o más elementos) o que está vacío o se borró por completo (no contiene ningún valor).

La capa de la plataforma puede usar y utilizar este dato para optimizar su implementación.

Detalles

Parámetros

`[in] aInstance`	La estructura de la instancia de OpenThread.
`[in] aKey`	La clave asociada con la configuración que se cambiará.
`[in] aValue`	Un puntero para ver dónde se debe leer el nuevo valor de la configuración. NO DEBE ser NULO si `aValueLength` no es cero.
`[in] aValueLength`	La longitud de los datos a los que apunta `aValue`. Puede ser cero.

Valores de retorno

`OT_ERROR_NONE`	La configuración determinada se agregó o se organizó para que se agregue.
`OT_ERROR_NOT_IMPLEMENTED`	Esta función no está implementada en esta plataforma.
`OT_ERROR_NO_BUFS`	No hay más espacio para almacenar la configuración.

otPlatSettingsDeinit

void otPlatSettingsDeinit(
  otInstance *aInstance
)

Si es necesario, realiza cualquier proceso de inicialización para el subsistema de configuración.

Detalles

Parámetros

[in] aInstance

La estructura de la instancia de OpenThread.

otPlatSettingsDelete

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

Elimina una opción de configuración del almacén de configuraciones.

Esta función borra un valor específico del parámetro de configuración identificado por 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

`[in] aInstance`	La estructura de la instancia de OpenThread.
`[in] aKey`	La clave asociada con la configuración solicitada.
`[in] aIndex`	El índice del valor que se quitará. Si se establece en -1, se quitarán todos los valores de `aKey`.

Valores de retorno

`OT_ERROR_NONE`	Se encontraron y quitaron correctamente la clave y el índice especificados.
`OT_ERROR_NOT_FOUND`	No se encontró la clave o el índice dados en el almacén de configuración.
`OT_ERROR_NOT_IMPLEMENTED`	Esta función no está implementada en esta plataforma.

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 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 estableciendo aValue y aValueLength en NULL. También puedes verificar la longitud de la configuración sin recuperarla estableciendo aValue como 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 el almacén.

Detalles

Parámetros

`[in] aInstance`	La estructura de la instancia de OpenThread.
`[in] aKey`	La clave asociada con la configuración solicitada.
`[in] aIndex`	El índice del elemento específico que se obtendrá.
`[out] aValue`	Un puntero al lugar donde se debe escribir el valor de la configuración. Se puede establecer en NULL si solo se prueba la presencia o la longitud de una configuración.
`[in,out] aValueLength`	Un puntero para la longitud del valor. Cuando se llama, este puntero debe apuntar a un número entero que contenga el tamaño de valor máximo que se puede escribir en `aValue`. En la devolución, se escribe la longitud real de la configuración. Esto se puede configurar como NULL si se realiza una verificación de presencia.

Valores de retorno

`OT_ERROR_NONE`	Se encontró y recuperó la configuración determinada.
`OT_ERROR_NOT_FOUND`	La configuración especificada no se encontró en la tienda de configuración.
`OT_ERROR_NOT_IMPLEMENTED`	Esta función no está implementada en esta plataforma.

otPlatSettingsInit

void otPlatSettingsInit(
  otInstance *aInstance,
  const uint16_t *aSensitiveKeys,
  uint16_t aSensitiveKeysLength
)

Realiza cualquier proceso de inicialización para el subsistema de configuración, si es necesario.

Esta función también configura las claves sensibles que deben almacenarse en el área segura.

Ten en cuenta que la memoria que apunta aSensitiveKeys no debe liberarse antes de que se destruya aInstance.

Detalles

Parámetros

`[in] aInstance`	La estructura de la instancia de OpenThread.
`[in] aSensitiveKeys`	Un puntero para un arreglo que contiene la lista de claves sensibles. Puede ser NULL solo si `aSensitiveKeysLength` es 0, lo que significa que no hay claves sensibles.
`[in] aSensitiveKeysLength`	La cantidad de entradas en el arreglo `aSensitiveKeys`.

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 una configuración identificada por aKey.

Si se llama correctamente a esta función, es posible que se reordenen varios valores que no están relacionados con la configuración.

La pila de OpenThread garantiza el uso del método otPlatSettingsSet() para un 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 y utilizar este dato para optimizar su implementación.

Detalles

Parámetros

`[in] aInstance`	La estructura de la instancia de OpenThread.
`[in] aKey`	La clave asociada con la configuración que se cambiará.
`[in] aValue`	Un puntero para ver dónde se debe leer el nuevo valor de la configuración. NO DEBE ser NULO si `aValueLength` no es cero.
`[in] aValueLength`	La longitud de los datos a los que apunta aValue. Puede ser cero.

Valores de retorno

`OT_ERROR_NONE`	La configuración específica se modificó o organizó en etapa de pruebas.
`OT_ERROR_NOT_IMPLEMENTED`	Esta función no está implementada en esta plataforma.
`OT_ERROR_NO_BUFS`	No hay más espacio para almacenar la configuración.

otPlatSettingsWipe

void otPlatSettingsWipe(
  otInstance *aInstance
)

Elimina toda la configuración del almacén de configuraciones.

Esta función borra toda la configuración del almacén de configuración y la restablece al estado de fábrica inicial.

Detalles

Parámetros

[in] aInstance

La estructura de la instancia de OpenThread.

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 contribuir con nuestra documentación, consulta Recursos.