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 }	enum En esta enumeración, se definen 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
}

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)`	`otError` 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)`	`otError` 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)`	`otError` 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)`	`otError` 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 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_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_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`	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).

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 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.

La pila de OpenThread garantiza que se debe usar el método otPlatSettingsAdd() para un objeto aKey administrado anteriormente por otPlatSettingsAdd() (es decir, contiene uno o más elementos), o bien está vacío o se borró por completo (no contiene valor).

La capa de la plataforma puede confiar y usar esto para optimizar su implementación.

Detalles

Parámetros

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

Valores que se muestran

`OT_ERROR_NONE`	Se agregó a la configuración determinada o se configuró por etapas.
`OT_ERROR_NOT_IMPLEMENTED`	Esta función no está implementada en esta plataforma.
`OT_ERROR_NO_BUFS`	No queda espacio para almacenar la configuración determinada.

otPlatSettingsDeinit

void otPlatSettingsDeinit(
  otInstance *aInstance
)

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

Detalles

Parámetros

[in] aInstance

Estructura de la instancia de OpenThread

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

`[in] aInstance`	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 este objeto `aKey`.

Valores que se muestran

`OT_ERROR_NONE`	La clave y el índice proporcionados se encontraron y quitaron correctamente.
`OT_ERROR_NOT_FOUND`	No se encontró la clave o el índice proporcionados en el almacén de parámetros.
`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 si configuras aValue y aValueLength en 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

`[in] aInstance`	Estructura de la instancia de OpenThread
`[in] aKey`	La clave asociada con la configuración solicitada.
`[in] aIndex`	Es el índice del elemento específico que se debe obtener.
`[out] aValue`	Un puntero sobre dónde se debe escribir el valor del parámetro. 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 a este puntero, debe apuntar a un número entero que contenga el tamaño máximo permitido que se puede escribir en `aValue`. A la devolución, se escribe la longitud real de la configuración. Esto se puede establecer en NULL si se realiza una verificación de presencia.

Valores que se muestran

`OT_ERROR_NONE`	Se encontró el parámetro de configuración seleccionado y se lo recuperó correctamente.
`OT_ERROR_NOT_FOUND`	No se encontró la configuración especificada en la tienda de configuraciones.
`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
)

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

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

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 se llama a esta función correctamente, es posible que se reordenen los valores no relacionados con los valores no relacionados.

La pila de OpenThread garantiza que se utilizará el método otPlatSettingsSet() para un objeto aKey que se configuró previamente con otPlatSettingsSet() (es decir, contiene un valor único) o que está vacío o se borró por completo (no contiene ningún valor).

La capa de la plataforma puede confiar y usar esto para optimizar su implementación.

Detalles

Parámetros

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

Valores que se muestran

`OT_ERROR_NONE`	Se modificó la configuración o se habilitó a etapa.
`OT_ERROR_NOT_IMPLEMENTED`	Esta función no está implementada en esta plataforma.
`OT_ERROR_NO_BUFS`	No queda espacio para almacenar la configuración determinada.

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

[in] aInstance

Estructura de la instancia de OpenThread

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.