关联指标

此模块包含控制链接指标协议的函数。

摘要

枚举
otLinkMetricsEnhAckFlags{
  OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
  OT_LINK_METRICS_ENH_ACK_REGISTER = 1
} 		枚举
增强型 ACK 标记。
otLinkMetricsStatus 枚举
关联指标状态值。

类型定义符
otLinkMetricsEnhAckFlags typedef
增强型 ACK 标记。
otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext) typedef
void(*
在收到 Enh-ACK 探测 IE 时调用指针。
otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
收到链接指标管理响应时，系统会调用指针。
otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
在收到“链接指标”报告时，系统会调用指针。
otLinkMetricsSeriesFlags typedef
表示在前向跟踪序列中计入的帧。
otLinkMetricsStatus typedef
关联指标状态值。
otLinkMetricsValues typedef
表示“链接指标”查询的结果（值）。

函数
otLinkMetricsConfigEnhAckProbing(otInstance *aInstance, const otIp6Address *aDestination, otLinkMetricsEnhAckFlags aEnhAckFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext, otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback, void *aEnhAckCallbackContext)
发送 MLE 链接指标管理请求，以配置/清除基于增强型 ACK 的探测。
otLinkMetricsConfigForwardTrackingSeries(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext)
发送 MLE 链接指标管理请求以配置或清除转发跟踪系列。
otLinkMetricsManagerGetMetricsValueByExtAddr(otInstance *aInstance, const otExtAddress *aExtAddress, otLinkMetricsValues *aLinkMetricsValues)
通过邻居的扩展地址获取其链路指标数据。
otLinkMetricsManagerSetEnabled(otInstance *aInstance, bool aEnable)
void
启用或停用关联指标管理器。
otLinkMetricsQuery(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsReportCallback aCallback, void *aCallbackContext)
发送 MLE 数据请求以查询链接指标。
otLinkMetricsSendLinkProbe(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, uint8_t aLength)
发送 MLE 链接探测消息。

结构体
otLinkMetricsSeriesFlags

表示在前向跟踪序列中计入的帧。
otLinkMetricsValues

表示“链接指标”查询的结果（值）。

枚举

otLinkMetricsEnhAckFlags

 otLinkMetricsEnhAckFlags

增强型 ACK 标记。

这些值在基于增强型 ACK 的探测中使用，用于指示是注册还是清除探测。

属性
OT_LINK_METRICS_ENH_ACK_CLEAR

清晰。
OT_LINK_METRICS_ENH_ACK_REGISTER

注册。

otLinkMetricsStatus

 otLinkMetricsStatus

关联指标状态值。

类型定义符

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

增强型 ACK 标记。

这些值在基于增强型 ACK 的探测中使用，用于指示是注册还是清除探测。

otLinkMetricsEnhAckProbingIeReportCallback

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

在收到 Enh-ACK 探测 IE 时调用指针。

具体说明
参数
[in] aShortAddress
探测对象的 Mac 简短地址。
[in] aExtAddress
指向探测对象的 Mac 扩展地址的指针。
[in] aMetricsValues
指向从 IE 获取的 Link Metrics 值的指针。
[in] aContext
指向应用特定上下文的指针。

otLinkMetricsMgmtResponseCallback

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

收到链接指标管理响应时，系统会调用指针。

具体说明
参数
[in] aSource
指向源地址的指针。
[in] aStatus
响应中的状态代码。
[in] aContext
指向应用特定上下文的指针。

otLinkMetricsReportCallback

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

在收到“链接指标”报告时，系统会调用指针。

具体说明
参数
[in] aSource
指向源地址的指针。
[in] aMetricsValues
指向“链接指标”值（查询结果）的指针。
[in] aStatus
报告中的状态代码（仅在 aMetricsValues 为 NULL 时有用）。
[in] aContext
指向应用特定上下文的指针。

otLinkMetricsSeriesFlags

struct otLinkMetricsSeriesFlags otLinkMetricsSeriesFlags

表示在前向跟踪序列中计入的帧。

otLinkMetricsStatus

enum otLinkMetricsStatus otLinkMetricsStatus

关联指标状态值。

otLinkMetricsValues

struct otLinkMetricsValues otLinkMetricsValues

表示“链接指标”查询的结果（值）。

函数

otLinkMetricsConfigEnhAckProbing

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

发送 MLE 链接指标管理请求，以配置/清除基于增强型 ACK 的探测。

此功能需要启用 OT_LINK_METRICS_INITIATOR 功能。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aDestination
指向目标地址的指针。
[in] aEnhAckFlags
Enh-ACK 标记，用于指示是注册还是清除探测。先清除 0，再注册 1。其他值则预留。
[in] aLinkMetricsFlags
指向用于指定要查询的指标的标志的指针。当 aEnhAckFlags 为 0 时，应为 NULL。
[in] aCallback
指向函数的指针，在收到包含链接指标的增强型确认时调用的函数。
[in] aCallbackContext
指向应用特定上下文的指针。
返回值
OT_ERROR_NONE
已成功发送“关联指标管理请求”消息。
OT_ERROR_NO_BUFS
缓冲区不足，无法生成 MLE 链路指标管理请求消息。
OT_ERROR_INVALID_ARGS
aEnhAckFlags 不是有效值或 aLinkMetricsFlags 不正确。
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination 不是链路本地或未找到邻近项。
OT_ERROR_NOT_CAPABLE
邻近设备不是 Thread 1.2 设备，并且不支持链接指标。

otLinkMetricsConfigForwardTrackingSeries

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

发送 MLE 链接指标管理请求以配置或清除转发跟踪系列。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aDestination
指向目标地址的指针。
[in] aSeriesId
要操作的连续剧 ID。
[in] aSeriesFlags
系列标记，用于指定要计算哪些帧。
[in] aLinkMetricsFlags
指向用于指定要查询的指标的标志的指针。当 aSeriesFlags 为 0 时，应为 NULL。
[in] aCallback
指向收到链接指标管理响应时所调用的函数的指针。
[in] aCallbackContext
指向应用特定上下文的指针。
返回值
OT_ERROR_NONE
已成功发送“关联指标管理请求”消息。
OT_ERROR_NO_BUFS
缓冲区不足，无法生成 MLE 链路指标管理请求消息。
OT_ERROR_INVALID_ARGS
aSeriesId 不在有效范围内。
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination 不是链路本地或未找到邻近项。
OT_ERROR_NOT_CAPABLE
邻近设备不是 Thread 1.2 设备，并且不支持链接指标。

otLinkMetricsManagerGetMetricsValueByExtAddr

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

通过邻居的扩展地址获取其链路指标数据。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aExtAddress
指向探测对象的 Mac 扩展地址的指针。
[out] aLinkMetricsValues
指向主题的链接指标值的指针。
返回值
OT_ERROR_NONE
成功获取链接指标数据。
OT_ERROR_INVALID_ARGS
参数无效。
OT_ERROR_NOT_FOUND
找不到具有给定扩展地址的相邻地址。

otLinkMetricsManagerSetEnabled

void otLinkMetricsManagerSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

启用或停用关联指标管理器。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aEnable
指示启用或停用的布尔值。

otLinkMetricsQuery

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

发送 MLE 数据请求以查询链接指标。

可以是单一探测，也可以是前向跟踪系列。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aDestination
指向目标地址的指针。
[in] aSeriesId
要查询的序列 ID，0 表示单个探测。
[in] aLinkMetricsFlags
指向用于指定要查询的指标的标志的指针。
[in] aCallback
指向在收到“链接指标”报告时调用的函数的指针。
[in] aCallbackContext
指向应用特定上下文的指针。
返回值
OT_ERROR_NONE
已成功发送“链接指标”查询消息。
OT_ERROR_NO_BUFS
缓冲区不足，无法生成 MLE 数据请求消息。
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination 不是链路本地或未找到邻近项。
OT_ERROR_NOT_CAPABLE
邻近设备不是 Thread 1.2 设备，并且不支持链接指标。

otLinkMetricsSendLinkProbe

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

发送 MLE 链接探测消息。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aDestination
指向目标地址的指针。
[in] aSeriesId
“探测”消息针对的连续剧 ID [1, 254]。
[in] aLength
链路探测 TLV 中数据载荷的长度，值为 0, 64。
返回值
OT_ERROR_NONE
已成功发送链接探测消息。
OT_ERROR_NO_BUFS
缓冲区不足，无法生成 MLE 链路探测消息。
OT_ERROR_INVALID_ARGS
aSeriesId 或 aLength 不在有效范围内。
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination 不是链路本地或未找到邻近项。
OT_ERROR_NOT_CAPABLE
邻近设备不是 Thread 1.2 设备，并且不支持链接指标。

资源

OpenThread API 参考文档源自 GitHub 上提供的源代码。如需了解详情，或者为我们的文档做贡献，请参阅资源。