Google is committed to advancing racial equity for Black communities. See how.
Se usó la API de Cloud Translation para traducir esta página.
Switch to English

Configuraciones

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

Resumen

Las 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 inicialización para el subsistema de configuración, si es necesario.
otPlatSettingsDelete ( otInstance *aInstance, uint16_t aKey, int aIndex)
Elimina una configuración del almacén de configuración.
otPlatSettingsGet ( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength)
Obtiene el valor de una configuración.
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.
otPlatSettingsWipe ( otInstance *aInstance)
void
Elimina todas las configuraciones del almacén de configuraciones.

Las 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 cualquier valor preexistente también puede cambiar.

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

Detalles
Parámetros
[in] aInstance
La estructura de instancia de OpenThread.
[in] aKey
La clave asociada con la configuración para cambiar.
[in] aValue
Un puntero a 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 señalados por aValue. Puede ser cero
Valores de retorno
OT_ERROR_NONE
La configuración dada fue agregada o puesta en escena 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 inicialización para el subsistema de configuración, si es necesario.

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

otPlatSettingsDelete

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

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

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 instancia de OpenThread.
[in] aKey
La clave asociada con la configuración solicitada.
[in] aIndex
El índice del valor a eliminar. Si se establece en -1, se eliminarán todos los valores para esta aKey.
Valores de retorno
OT_ERROR_NONE
La clave y el índice dados se encontraron y eliminaron con éxito.
OT_ERROR_NOT_FOUND
La clave o índice dado no se encontró 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
)

Obtiene el valor de una configuración.

Esta función obtiene el valor de la configuración identificada por aKey y lo escribe en la memoria señalada por aValue. Luego escribe la longitud al número entero apuntado por 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 usar para verificar 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 configurando solo unValor en NULL.

Tenga en cuenta que la implementación de almacenamiento subyacente no es necesaria para mantener el orden de las configuraciones con múltiples valores. El orden de tales valores PUEDE cambiar después de CUALQUIER operación de escritura en la tienda.

Detalles
Parámetros
[in] aInstance
La estructura de instancia de OpenThread.
[in] aKey
La clave asociada con la configuración solicitada.
[in] aIndex
El índice del artículo específico para obtener.
[out] aValue
Un puntero a donde se debe escribir el valor de la configuración. Puede establecerse en NULL si solo prueba la presencia o la longitud de una configuración.
[in,out] aValueLength
Un puntero a la longitud del valor. Cuando se invoca, este puntero debe apuntar a un número entero que contiene el tamaño de valor máximo que se puede escribir en aValue. Al regresar, se escribe la longitud real de la configuración. Esto puede establecerse en NULL si realiza una verificación de presencia.
Valores de retorno
OT_ERROR_NONE
La configuración dada fue encontrada y obtenida con éxito.
OT_ERROR_NOT_FOUND
La configuración dada 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
)

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

Detalles
Parámetros
[in] aInstance
La estructura de 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 aKey, 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 varios valores.

Detalles
Parámetros
[in] aInstance
La estructura de instancia de OpenThread.
[in] aKey
La clave asociada con la configuración para cambiar.
[in] aValue
Un puntero a 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 señalados por aValue. Puede ser cero
Valores de retorno
OT_ERROR_NONE
La configuración dada fue cambiada o puesta en escena.
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.

otPlatSettingsWipe

void otPlatSettingsWipe(
  otInstance *aInstance
)

Elimina todas las configuraciones del almacén de configuraciones.

Esta función elimina todas las configuraciones del almacén de configuraciones, restableciéndolas a su estado inicial de fábrica.

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