Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.

Ajustes

Este módulo incluye la abstracción de la plataforma para el almacenamiento no volátil de configuraciones.

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_RESERVED = 0x0006,
OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY = 0x0007,
OT_SETTINGS_KEY_DAD_INFO = 0x0008,
OT_SETTINGS_KEY_OMR_PREFIX = 0x0009,
OT_SETTINGS_KEY_ON_LINK_PREFIX = 0x000a,
OT_SETTINGS_KEY_SRP_ECDSA_KEY = 0x000b,
OT_SETTINGS_KEY_SRP_CLIENT_INFO = 0x000c,
OT_SETTINGS_KEY_SRP_SERVER_INFO = 0x000d
}
enumeración
Esta enumeración define 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
Realiza cualquier desinicialización del subsistema de configuración, si es necesario.
otPlatSettingsDelete ( otInstance *aInstance, uint16_t aKey, int aIndex)
Elimina un ajuste del almacén de ajustes.
otPlatSettingsGet ( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength)
Obtiene el valor de un ajuste.
otPlatSettingsInit ( otInstance *aInstance)
void
Realiza cualquier inicialización para el subsistema de configuración, si es necesario.
otPlatSettingsSet ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
Establece o reemplaza el valor de una configuración.
otPlatSettingsSetCriticalKeys ( otInstance *aInstance, const uint16_t *aKeys, uint16_t aKeysLength)
void
Esta función establece las claves críticas que deben almacenarse en el área segura.
otPlatSettingsWipe ( otInstance *aInstance)
void
Elimina todos los ajustes del almacén de ajustes.

Enumeraciones

enumeración anónima

 anonymous enum

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

Nota: Cuando se agrega una clave nueva setings, si los ajustes correspondientes a la llave contiene información confidencial de seguridad, el desarrollador debe agregar la clave de la matriz kCriticalKeys .

Propiedades
OT_SETTINGS_KEY_ACTIVE_DATASET

Conjunto de datos operativos activos.

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 la red de hilos.

OT_SETTINGS_KEY_OMR_PREFIX

Prefijo enrutable fuera de la malla (OMR).

OT_SETTINGS_KEY_ON_LINK_PREFIX

Prefijo en enlace para enlace de infraestructura.

OT_SETTINGS_KEY_PARENT_INFO

Información para padres.

OT_SETTINGS_KEY_PENDING_DATASET

Conjunto de datos operativos pendiente.

OT_SETTINGS_KEY_RESERVED

Reservado (previamente inicio automático).

OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY

Clave SLAAC para generar 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 ECDSA del cliente 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 una configuración identificada por aKey, sin reemplazar ningún valor existente.

Tenga 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 puede agregarse al final, al principio o incluso en algún punto intermedio. El orden de los valores preexistentes también puede cambiar.

Llamar a esta función con éxito puede hacer que se reordenen configuraciones no relacionadas con múltiples valores.

Detalles
Parámetros
[in] aInstance
La estructura de la instancia de OpenThread.
[in] aKey
La clave asociada con la configuración que se va a cambiar.
[in] aValue
Un puntero al lugar desde donde se debe leer el nuevo valor de la configuración. NO DEBE ser NULL si aValueLength no es cero.
[in] aValueLength
La longitud de los datos apuntados por unValue. Puede ser cero.
Valores devueltos
OT_ERROR_NONE
La configuración dada fue agregada o preparada para ser agregada.
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 dada.

otPlatSettingsDeinit

void otPlatSettingsDeinit(
  otInstance *aInstance
)

Realiza cualquier desinicialización del subsistema de configuración, si es necesario.

Detalles
Parámetros
[in] aInstance
La estructura de la instancia de OpenThread.

otPlatSettingsDelete

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

Elimina un ajuste del almacén de ajustes.

Esta función elimina un valor específico de la configuración identificada por aKey del almacén de configuraciones.

Tenga 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 eliminará. Si se establece en -1, se eliminarán todos los valores de esta aKey.
Valores devueltos
OT_ERROR_NONE
La clave y el índice dados se encontraron y se eliminaron correctamente.
OT_ERROR_NOT_FOUND
La clave o índice proporcionado no se encontró en la tienda 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
)

Obtiene el valor de un ajuste.

Esta función obtiene el valor del ajuste identificado por aKey y lo escribe en la memoria apuntada por aValue. A continuación, escribe la longitud en el número entero al que apunta aValueLength. El valor inicial de aValueLength es el número máximo de bytes que se escribirán en aValue.

Esta función se puede utilizar para comprobar la existencia de una clave sin obtener el valor estableciendo aValue y aValueLength en NULL. También puede verificar la longitud de la configuración sin obtenerla estableciendo solo aValue en NULL.

Tenga 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
[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 va a obtener.
[out] aValue
Un puntero al lugar donde se debe escribir el valor de la configuración. Puede establecerse en NULL si solo se prueba la presencia o la duración de una configuración.
[in,out] aValueLength
Un puntero a la longitud del valor. Cuando se llama, este puntero debe apuntar a un número entero que contenga el tamaño máximo del valor que se puede escribir en unValue. Al regresar, se escribe la longitud real del ajuste. Esto se puede establecer en NULL si se realiza una verificación de presencia.
Valores devueltos
OT_ERROR_NONE
La configuración indicada se encontró y se recuperó correctamente.
OT_ERROR_NOT_FOUND
La configuración dada no se encontró en la tienda de configuraciones.
OT_ERROR_NOT_IMPLEMENTED
Esta función no está implementada en esta plataforma.

otPlatSettingsInit

void otPlatSettingsInit(
  otInstance *aInstance
)

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

Detalles
Parámetros
[in] aInstance
La estructura de la instancia de OpenThread.

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 previamente con una clave, entonces todos se eliminan y se reemplazan con esta única entrada.

Llamar a esta función con éxito puede hacer que se reordenen configuraciones no relacionadas con múltiples valores.

Detalles
Parámetros
[in] aInstance
La estructura de la instancia de OpenThread.
[in] aKey
La clave asociada con la configuración que se va a cambiar.
[in] aValue
Un puntero al lugar desde donde se debe leer el nuevo valor de la configuración. NO DEBE ser NULL si aValueLength no es cero.
[in] aValueLength
La longitud de los datos apuntados por unValue. Puede ser cero.
Valores devueltos
OT_ERROR_NONE
El escenario dado fue cambiado o organizado.
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 dada.

otPlatSettingsSetCriticalKeys

void otPlatSettingsSetCriticalKeys(
  otInstance *aInstance,
  const uint16_t *aKeys,
  uint16_t aKeysLength
)

Esta función establece las claves críticas que deben almacenarse en el área segura.

Tenga en cuenta que la memoria apuntada por aKeys no debe ser liberado antes de aInstance se destruye.

Detalles
Parámetros
[in] aInstance
La estructura de la instancia de OpenThread.
[in] aKeys
Un puntero a una matriz que contiene la lista de claves críticas.
[in] aKeysLength
El número de entradas en la aKeys matriz.

otPlatSettingsWipe

void otPlatSettingsWipe(
  otInstance *aInstance
)

Elimina todos los ajustes del almacén de ajustes.

Esta función borra todos los ajustes del almacén de ajustes y los restablece a su estado inicial de fábrica.

Detalles
Parámetros
[in] aInstance
La estructura de la instancia de OpenThread.