Métricas de vínculos

Este módulo incluye funciones que controlan el protocolo de métricas de vínculos.

Resumen

Enumeraciones
otLinkMetricsEnhAckFlags{
  OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
  OT_LINK_METRICS_ENH_ACK_REGISTER = 1
} 		enum
Marcas de ACK mejoradas.
otLinkMetricsStatus enum
Valores de estado de las métricas del vínculo.

Typedefs
otLinkMetricsEnhAckFlags typedef
Marcas de ACK mejoradas.
otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext) typedef
void(*
Se llama al puntero cuando se recibe Enh-ACK Probing IE.
otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
Se llama al puntero cuando se recibe una respuesta de la administración de métricas de vínculos.
otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
Se llama al puntero cuando se recibe un informe Métricas de vínculos.
otLinkMetricsSeriesFlags typedef
Representa los fotogramas que se contabilizan en una serie de seguimiento hacia adelante.
otLinkMetricsStatus typedef
Valores de estado de las métricas del vínculo.
otLinkMetricsValues typedef
Representa el resultado (valor) de una consulta de métricas de vínculos.

remotas
otLinkMetricsConfigEnhAckProbing(otInstance *aInstance, const otIp6Address *aDestination, otLinkMetricsEnhAckFlags aEnhAckFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext, otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback, void *aEnhAckCallbackContext)
Envía una solicitud de administración de métricas de vínculos de MLE para configurar o borrar un sondeo basado en ACK mejorado.
otLinkMetricsConfigForwardTrackingSeries(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext)
Envía una solicitud de administración de métricas de vínculos de MLE para configurar o borrar una serie de seguimiento directo.
otLinkMetricsManagerGetMetricsValueByExtAddr(otInstance *aInstance, const otExtAddress *aExtAddress, otLinkMetricsValues *aLinkMetricsValues)
Obtén los datos de métricas de vínculos de un vecino según su dirección extendida.
otLinkMetricsManagerSetEnabled(otInstance *aInstance, bool aEnable)
void
Habilita o inhabilita el Administrador de métricas de vínculos.
otLinkMetricsQuery(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsReportCallback aCallback, void *aCallbackContext)
Envía una solicitud de datos de MLE para consultar las métricas del vínculo.
otLinkMetricsSendLinkProbe(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, uint8_t aLength)
Envía un mensaje de sondeo de vínculos de MLE.

Structs
otLinkMetricsSeriesFlags

Representa los fotogramas que se contabilizan en una serie de seguimiento hacia adelante.

otLinkMetricsValues

Representa el resultado (valor) de una consulta de métricas de vínculos.

Enumeraciones

otLinkMetricsEnhAckFlags

 otLinkMetricsEnhAckFlags

Marcas de ACK mejoradas.

Estos se usan en el sondeo basado en ACK mejorado para indicar si se debe registrar o borrar el sondeo.

Propiedades
OT_LINK_METRICS_ENH_ACK_CLEAR

claro

OT_LINK_METRICS_ENH_ACK_REGISTER

Regístrate.

otLinkMetricsStatus

 otLinkMetricsStatus

Valores de estado de las métricas del vínculo.

Typedefs

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

Marcas de ACK mejoradas.

Estos se usan en el sondeo basado en ACK mejorado para indicar si se debe registrar o borrar el sondeo.

otLinkMetricsEnhAckProbingIeReportCallback

void(* otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext)

Se llama al puntero cuando se recibe Enh-ACK Probing IE.

Detalles
Parámetros
[in] aShortAddress
Es la dirección corta de Mac del sujeto de sondeo.
[in] aExtAddress
Un puntero a la dirección extendida de Mac del sujeto de sondeo.
[in] aMetricsValues
Un puntero para los valores de métricas de vínculos obtenidos de IE.
[in] aContext
Un puntero para el contexto específico de la aplicación.

otLinkMetricsMgmtResponseCallback

void(* otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext)

Se llama al puntero cuando se recibe una respuesta de la administración de métricas de vínculos.

Detalles
Parámetros
[in] aSource
Un puntero a la dirección de origen.
[in] aStatus
El código de estado en la respuesta.
[in] aContext
Un puntero para el contexto específico de la aplicación.

otLinkMetricsReportCallback

void(* otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext)

Se llama al puntero cuando se recibe un informe Métricas de vínculos.

Detalles
Parámetros
[in] aSource
Un puntero a la dirección de origen.
[in] aMetricsValues
Un puntero para los valores de Métricas de vínculos (el resultado de la consulta)
[in] aStatus
El código de estado del informe (solo es útil cuando aMetricsValues es NULL).
[in] aContext
Un puntero para el contexto específico de la aplicación.

otLinkMetricsSeriesFlags

struct otLinkMetricsSeriesFlags otLinkMetricsSeriesFlags

Representa los fotogramas que se contabilizan en una serie de seguimiento hacia adelante.

otLinkMetricsStatus

enum otLinkMetricsStatus otLinkMetricsStatus

Valores de estado de las métricas del vínculo.

otLinkMetricsValues

struct otLinkMetricsValues otLinkMetricsValues

Representa el resultado (valor) de una consulta de métricas de vínculos.

remotas

otLinkMetricsConfigEnhAckProbing

otError otLinkMetricsConfigEnhAckProbing(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  otLinkMetricsEnhAckFlags aEnhAckFlags,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsMgmtResponseCallback aCallback,
  void *aCallbackContext,
  otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback,
  void *aEnhAckCallbackContext
)

Envía una solicitud de administración de métricas de vínculos de MLE para configurar o borrar un sondeo basado en ACK mejorado.

Esta función requiere que se habilite la función OT_LINK_METRICS_INITIATOR.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDestination
Un puntero a la dirección de destino.
[in] aEnhAckFlags
Marcas de Enh-ACK para indicar si se debe registrar o borrar el sondeo 0 para borrar y 1 para registrarse. Se reservan los demás valores.
[in] aLinkMetricsFlags
Un puntero para marcas que especifican qué métricas consultar. Debe ser NULL cuando aEnhAckFlags es 0.
[in] aCallback
Un puntero a una función a la que se llama cuando se recibe una confirmación mejorada con métricas de vínculos.
[in] aCallbackContext
Un puntero para el contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
Se envió correctamente un mensaje de solicitud de administración de métricas de vínculos.
OT_ERROR_NO_BUFS
Búferes insuficientes para generar el mensaje de solicitud de administración de métricas de vínculos de MLE.
OT_ERROR_INVALID_ARGS
aEnhAckFlags no es un valor válido o aLinkMetricsFlags no es correcto.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination no es un vínculo local o no se encuentra el vecino.
OT_ERROR_NOT_CAPABLE
El vecino no es un dispositivo Thread 1.2 y no es compatible con las métricas de vínculos.

otLinkMetricsConfigForwardTrackingSeries

otError otLinkMetricsConfigForwardTrackingSeries(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  otLinkMetricsSeriesFlags aSeriesFlags,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsMgmtResponseCallback aCallback,
  void *aCallbackContext
)

Envía una solicitud de administración de métricas de vínculos de MLE para configurar o borrar una serie de seguimiento directo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDestination
Un puntero a la dirección de destino.
[in] aSeriesId
El ID de serie con el que se operará.
[in] aSeriesFlags
Las marcas de serie que especifican qué fotogramas deben contabilizarse.
[in] aLinkMetricsFlags
Un puntero para marcas que especifican qué métricas consultar. Debe ser NULL cuando aSeriesFlags es 0.
[in] aCallback
Un puntero a una función a la que se llama cuando se recibe la respuesta de la administración de métricas de vínculos.
[in] aCallbackContext
Un puntero para el contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
Se envió correctamente un mensaje de solicitud de administración de métricas de vínculos.
OT_ERROR_NO_BUFS
Búferes insuficientes para generar el mensaje de solicitud de administración de métricas de vínculos de MLE.
OT_ERROR_INVALID_ARGS
aSeriesId no está dentro del rango válido.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination no es un vínculo local o no se encuentra el vecino.
OT_ERROR_NOT_CAPABLE
El vecino no es un dispositivo Thread 1.2 y no es compatible con las métricas de vínculos.

otLinkMetricsManagerGetMetricsValueByExtAddr

otError otLinkMetricsManagerGetMetricsValueByExtAddr(
  otInstance *aInstance,
  const otExtAddress *aExtAddress,
  otLinkMetricsValues *aLinkMetricsValues
)

Obtén los datos de métricas de vínculos de un vecino según su dirección extendida.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aExtAddress
Un puntero a la dirección extendida de Mac del sujeto de sondeo.
[out] aLinkMetricsValues
Un puntero a los valores de Métricas de vínculos del tema.
Valores que se muestran
OT_ERROR_NONE
Se obtuvieron correctamente los datos de las métricas de vínculos.
OT_ERROR_INVALID_ARGS
Los argumentos no son válidos.
OT_ERROR_NOT_FOUND
No se encontró ningún vecino con la dirección extendida proporcionada.

otLinkMetricsManagerSetEnabled

void otLinkMetricsManagerSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Habilita o inhabilita el Administrador de métricas de vínculos.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEnable
Es un valor booleano que indica habilitar o inhabilitar.

otLinkMetricsQuery

otError otLinkMetricsQuery(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsReportCallback aCallback,
  void *aCallbackContext
)

Envía una solicitud de datos de MLE para consultar las métricas del vínculo.

Podría ser una sonda única o una serie de seguimiento directo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDestination
Un puntero a la dirección de destino.
[in] aSeriesId
El ID de serie sobre el que se consultará, 0 para un sondeo único.
[in] aLinkMetricsFlags
Un puntero para marcas que especifican qué métricas consultar.
[in] aCallback
Un puntero a una función a la que se llama cuando se recibe el informe de métricas de vínculos.
[in] aCallbackContext
Un puntero para el contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
Se envió correctamente un mensaje de consulta de métricas de vínculos.
OT_ERROR_NO_BUFS
Búferes insuficientes para generar el mensaje de solicitud de datos de MLE.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination no es un vínculo local o no se encuentra el vecino.
OT_ERROR_NOT_CAPABLE
El vecino no es un dispositivo Thread 1.2 y no es compatible con las métricas de vínculos.

otLinkMetricsSendLinkProbe

otError otLinkMetricsSendLinkProbe(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  uint8_t aLength
)

Envía un mensaje de sondeo de vínculos de MLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDestination
Un puntero a la dirección de destino.
[in] aSeriesId
ID de serie [1, 254] al que apunta el mensaje Sonda.
[in] aLength
La longitud de la carga útil de datos en el TLV de Link Probe, 0, 64.
Valores que se muestran
OT_ERROR_NONE
Se envió correctamente un mensaje de sondeo de vínculo.
OT_ERROR_NO_BUFS
Búferes insuficientes para generar el mensaje de sondeo de vínculo de MLE.
OT_ERROR_INVALID_ARGS
aSeriesId o aLength no están dentro del rango válido.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination no es un vínculo local o no se encuentra el vecino.
OT_ERROR_NOT_CAPABLE
El vecino no es un dispositivo Thread 1.2 y no es compatible con las métricas de vínculos.

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