Google 致力于为黑人社区推动种族平等。查看具体行动。

链接指标

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

摘要

枚举
otLinkMetricsEnhAckFlags{
  OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
  OT_LINK_METRICS_ENH_ACK_REGISTER = 1
} 		枚举
Enhanced-ACK 标志。
otLinkMetricsStatus 枚举
关联指标状态值。

类型定义符
otLinkMetricsEnhAckFlags typedef
Enhanced-ACK 标志。
otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext) typedef
void(*
在收到 Enh-ACK 探测 IE 时会调用此函数指针。
otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, uint8_t aStatus, void *aContext) typedef
void(*
在收到链接指标管理响应后，系统会调用此函数指针。
otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, uint8_t 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 链接指标管理请求，以配置/清除基于 Enhanced-ACK 的探测。
otLinkMetricsConfigForwardTrackingSeries(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext)
此函数会发送 MLE 链接指标管理请求，以配置/清除正向跟踪系列。
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

Enhanced-ACK 标志。

这些标记用于在基于增强的 ACK 的探测中指示是否注册或清除探测。

属性
OT_LINK_METRICS_ENH_ACK_CLEAR

清晰。
OT_LINK_METRICS_ENH_ACK_REGISTER

注册。

otLinkMetricsStatus

 otLinkMetricsStatus

关联指标状态值。

类型定义符

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

Enhanced-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 获取的“链接指标”值的指针。
[in] aContext
指向应用特定上下文的指针。

otLinkMetricsMgmtResponseCallback

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

在收到链接指标管理响应后，系统会调用此函数指针。

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

otLinkMetricsReportCallback

void(* otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, uint8_t 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 链接指标管理请求，以配置/清除基于 Enhanced-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
邻域不是线程 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
邻域不是线程 1.2 设备，并且不支持链接指标。

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
邻域不是线程 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
Link Probe 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
邻域不是线程 1.2 设备，并且不支持链接指标。

资源

OpenThread API 参考主题源自源代码，可在 GitHub 上找到。 如需了解详情或为我们的文档做贡献，请参阅资源。