Métricas de link

Este módulo inclui funções que controlam o protocolo de métricas de link.

Resumo

Enumerações
otLinkMetricsEnhAckFlags{
  OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
  OT_LINK_METRICS_ENH_ACK_REGISTER = 1
} 		enum
Flags ACK aprimoradas.
otLinkMetricsStatus enum
Valores de status das métricas de link.

Typedefs
otLinkMetricsEnhAckFlags typedef
Flags ACK aprimoradas.
otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext) typedef
void(*
O ponteiro é chamado quando o IE de sondagem Enh-ACK é recebido.
otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
O ponteiro é chamado quando uma resposta do gerenciamento de métricas de link é recebida.
otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
O ponteiro é chamado quando um relatório de métricas de link é recebido.
otLinkMetricsSeriesFlags typedef
Representa quais frames são contabilizados em uma série de acompanhamento avançado.
otLinkMetricsStatus typedef
Valores de status das métricas de link.
otLinkMetricsValues typedef
Representa o resultado (valor) de uma consulta de métricas de link.

remotas
otLinkMetricsConfigEnhAckProbing(otInstance *aInstance, const otIp6Address *aDestination, otLinkMetricsEnhAckFlags aEnhAckFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext, otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback, void *aEnhAckCallbackContext)
Envia uma solicitação de gerenciamento de métricas de link do MLE para configurar/limpar uma sondagem baseada em ACK.
otLinkMetricsConfigForwardTrackingSeries(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext)
Envia uma solicitação de gerenciamento de métricas de link do MLE para configurar ou limpar uma série de rastreamento futuro.
otLinkMetricsManagerGetMetricsValueByExtAddr(otInstance *aInstance, const otExtAddress *aExtAddress, otLinkMetricsValues *aLinkMetricsValues)
Recebe dados de métricas de link de um vizinho pelo endereço estendido.
otLinkMetricsManagerSetEnabled(otInstance *aInstance, bool aEnable)
void
Ativar ou desativar o Gerenciador de métricas de link.
otLinkMetricsQuery(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsReportCallback aCallback, void *aCallbackContext)
Envia uma solicitação de dados MLE para consultar métricas de link.
otLinkMetricsSendLinkProbe(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, uint8_t aLength)
Envia uma mensagem de sondagem de link de MLE.

Estruturas
otLinkMetricsSeriesFlags

Representa quais frames são contabilizados em uma série de acompanhamento avançado.

otLinkMetricsValues

Representa o resultado (valor) de uma consulta de métricas de link.

Enumerações

otLinkMetricsEnhAckFlags

 otLinkMetricsEnhAckFlags

Flags ACK aprimoradas.

Elas são usadas na sondagem baseada em ACK para indicar se é necessário registrar ou limpar a sondagem.

Propriedades
OT_LINK_METRICS_ENH_ACK_CLEAR

claro

OT_LINK_METRICS_ENH_ACK_REGISTER

Cadastre-se.

otLinkMetricsStatus

 otLinkMetricsStatus

Valores de status das métricas de link.

Typedefs

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

Flags ACK aprimoradas.

Elas são usadas na sondagem baseada em ACK para indicar se é necessário registrar ou limpar a sondagem.

otLinkMetricsEnhAckProbingIeReportCallback

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

O ponteiro é chamado quando o IE de sondagem Enh-ACK é recebido.

Detalhes
Parâmetros
[in] aShortAddress
O endereço curto do Mac do assunto da sondagem.
[in] aExtAddress
Um ponteiro para o endereço estendido do Mac do assunto de sondagem.
[in] aMetricsValues
Um ponteiro para os valores de métricas de link extraídos do IE.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otLinkMetricsMgmtResponseCallback

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

O ponteiro é chamado quando uma resposta do gerenciamento de métricas de link é recebida.

Detalhes
Parâmetros
[in] aSource
Um ponteiro para o endereço de origem.
[in] aStatus
Código de status na resposta.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otLinkMetricsReportCallback

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

O ponteiro é chamado quando um relatório de métricas de link é recebido.

Detalhes
Parâmetros
[in] aSource
Um ponteiro para o endereço de origem.
[in] aMetricsValues
Um ponteiro para os valores de métricas de link (o resultado da consulta).
[in] aStatus
O código de status no relatório (útil apenas quando aMetricsValues é NULL).
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otLinkMetricsSeriesFlags

struct otLinkMetricsSeriesFlags otLinkMetricsSeriesFlags

Representa quais frames são contabilizados em uma série de acompanhamento avançado.

otLinkMetricsStatus

enum otLinkMetricsStatus otLinkMetricsStatus

Valores de status das métricas de link.

otLinkMetricsValues

struct otLinkMetricsValues otLinkMetricsValues

Representa o resultado (valor) de uma consulta de métricas de link.

remotas

otLinkMetricsConfigEnhAckProbing

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

Envia uma solicitação de gerenciamento de métricas de link do MLE para configurar/limpar uma sondagem baseada em ACK.

Esta funcionalidade requer a ativação do recurso OT_LINK_METRICS_INITIATOR.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDestination
Um ponteiro para o endereço de destino.
[in] aEnhAckFlags
Sinalizações de Enh-ACK para indicar se a sondagem precisa ser registrada ou limpa. 0 para limpar e 1 para registrar. Outros valores estão reservados.
[in] aLinkMetricsFlags
Um ponteiro para sinalizações que especificam quais métricas devem ser consultadas. Precisa ser NULL quando aEnhAckFlags é 0.
[in] aCallback
Um ponteiro para uma função que é chamada quando uma confirmação aprimorada com métricas de link é recebida.
[in] aCallbackContext
Um ponteiro para o contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
A mensagem de solicitação de gerenciamento de métricas de vinculação foi enviada.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar a mensagem de solicitação de gerenciamento de link de métricas do MLE.
OT_ERROR_INVALID_ARGS
aEnhAckFlags não é um valor válido ou aLinkMetricsFlags está incorreto.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination não é link-local ou o vizinho não foi encontrado.
OT_ERROR_NOT_CAPABLE
O vizinho não é um dispositivo com Thread 1.2 e não oferece suporte para métricas de link.

otLinkMetricsConfigForwardTrackingSeries

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

Envia uma solicitação de gerenciamento de métricas de link do MLE para configurar ou limpar uma série de rastreamento futuro.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDestination
Um ponteiro para o endereço de destino.
[in] aSeriesId
O ID da série com que operar.
[in] aSeriesFlags
Os sinalizadores da série que especificam quais frames devem ser contabilizados.
[in] aLinkMetricsFlags
Um ponteiro para sinalizações que especificam quais métricas devem ser consultadas. Precisa ser NULL quando aSeriesFlags é 0.
[in] aCallback
Um ponteiro para uma função que é chamada quando a resposta de gerenciamento de métricas de link é recebida.
[in] aCallbackContext
Um ponteiro para o contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
A mensagem de solicitação de gerenciamento de métricas de vinculação foi enviada.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar a mensagem de solicitação de gerenciamento de link de métricas do MLE.
OT_ERROR_INVALID_ARGS
aSeriesId não está dentro do intervalo válido.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination não é link-local ou o vizinho não foi encontrado.
OT_ERROR_NOT_CAPABLE
O vizinho não é um dispositivo com Thread 1.2 e não oferece suporte para métricas de link.

otLinkMetricsManagerGetMetricsValueByExtAddr

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

Recebe dados de métricas de link de um vizinho pelo endereço estendido.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aExtAddress
Um ponteiro para o endereço estendido do Mac do assunto de sondagem.
[out] aLinkMetricsValues
Um ponteiro para os valores de métricas de link do assunto.
Valores de retorno
OT_ERROR_NONE
Os dados de métricas do link foram recebidos.
OT_ERROR_INVALID_ARGS
Os argumentos são inválidos.
OT_ERROR_NOT_FOUND
Nenhum vizinho com o endereço estendido fornecido foi encontrado.

otLinkMetricsManagerSetEnabled

void otLinkMetricsManagerSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Ativar ou desativar o Gerenciador de métricas de link.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEnable
É um booleano que indica a ativação ou desativação.

otLinkMetricsQuery

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

Envia uma solicitação de dados MLE para consultar métricas de link.

Pode ser uma série de sonda única ou encaminhamento.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDestination
Um ponteiro para o endereço de destino.
[in] aSeriesId
O ID da série sobre o qual consultar, 0 para sondagem única.
[in] aLinkMetricsFlags
Um ponteiro para sinalizações que especificam quais métricas devem ser consultadas.
[in] aCallback
Um ponteiro para uma função que é chamada quando o relatório de métricas de link é recebido.
[in] aCallbackContext
Um ponteiro para o contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
A mensagem de consulta de métricas de link foi enviada.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar a mensagem de solicitação de dados do MLE.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination não é link-local ou o vizinho não foi encontrado.
OT_ERROR_NOT_CAPABLE
O vizinho não é um dispositivo com Thread 1.2 e não oferece suporte para métricas de link.

otLinkMetricsSendLinkProbe

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

Envia uma mensagem de sondagem de link de MLE.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDestination
Um ponteiro para o endereço de destino.
[in] aSeriesId
O ID da série [1, 254] a que a mensagem da sondagem visa.
[in] aLength
O comprimento do payload de dados no Link Probe TLV, 0, 64.
Valores de retorno
OT_ERROR_NONE
Mensagem da sondagem de link enviada.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar a mensagem do MLE Link Probe.
OT_ERROR_INVALID_ARGS
aSeriesId ou aLength não está dentro do intervalo válido.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination não é link-local ou o vizinho não foi encontrado.
OT_ERROR_NOT_CAPABLE
O vizinho não é um dispositivo com Thread 1.2 e não oferece suporte para métricas de link.

Recursos

Os tópicos de Referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para mais informações ou para contribuir com nossa documentação, consulte Recursos.