鏈接指標

該模塊包括控制鏈接度量協議的功能。

概要

枚舉
`otLinkMetricsEnhAckFlags { OT_LINK_METRICS_ENH_ACK_CLEAR = 0, OT_LINK_METRICS_ENH_ACK_REGISTER = 1 }`	枚舉增強型ACK標誌。
`otLinkMetricsStatus`	枚舉鏈接指標狀態值。

類型定義
`otLinkMetricsEnhAckFlags`	類型定義 `enum otLinkMetricsEnhAckFlags` 增強型ACK標誌。
`otLinkMetricsEnhAckProbingIeReportCallback )(otShortAddress aShortAddress, const otExtAddress aExtAddress, const otLinkMetricsValues aMetricsValues, void *aContext)`	類型定義 `void(*` 收到Enh-ACK Probing IE時將調用此功能指針。
`otLinkMetricsMgmtResponseCallback )(const otIp6Address aSource, uint8_t aStatus, void aContext)`	類型定義 `void(*` 收到鏈接度量標準管理響應時，將調用此函數指針。
`otLinkMetricsReportCallback )(const otIp6Address aSource, const otLinkMetricsValues aMetricsValues, uint8_t aStatus, void *aContext)`	類型定義 `void(*` 收到“鏈接指標”報告時，將調用此函數指針。
`otLinkMetricsSeriesFlags`	類型定義 `struct otLinkMetricsSeriesFlags` 此結構表示在向前跟踪系列中說明哪些框架。
`otLinkMetricsStatus`	類型定義 `enum otLinkMetricsStatus` 鏈接指標狀態值。
`otLinkMetricsValues`	類型定義 `struct otLinkMetricsValues` 此結構表示“鏈接指標”查詢的結果（值）。

職能
`otLinkMetricsConfigEnhAckProbing ( otInstance aInstance, const otIp6Address aDestination, otLinkMetricsEnhAckFlags aEnhAckFlags, const otLinkMetrics aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void aCallbackContext, otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback, void *aEnhAckCallbackContext)`	`otError` 此功能發送MLE鏈接度量標準管理請求以配置/清除基於增強ACK的探測。
`otLinkMetricsConfigForwardTrackingSeries ( otInstance aInstance, const otIp6Address aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void aCallbackContext)`	`otError` 此功能發送MLE鏈接度量標準管理請求以配置/清除前向跟踪系列。
`otLinkMetricsQuery ( otInstance aInstance, const otIp6Address aDestination, uint8_t aSeriesId, const otLinkMetrics aLinkMetricsFlags, otLinkMetricsReportCallback aCallback, void aCallbackContext)`	`otError` 此函數發送MLE數據請求以查詢鏈接指標。
`otLinkMetricsSendLinkProbe ( otInstance aInstance, const otIp6Address aDestination, uint8_t aSeriesId, uint8_t aLength)`	`otError` 此功能發送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獲得的“鏈接度量”值的指針。
`[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鏈接度量標準管理請求以配置/清除基於增強ACK的探測。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aDestination`	指向目標地址的指針。
`[in] aEnhAckFlags`	Enh-ACK標誌，指示是否註冊或清除探測。 `0`清除， `1`登記。其他值保留。
`[in] aLinkMetricsFlags`	指向標誌的指針，用於指定要查詢的指標。當`aEnhAckFlags`為`0` `aEnhAckFlags`為`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` `aSeriesFlags`為`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設備，並且不支持鏈接指標。

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設備，並且不支持鏈接指標。