本頁面由 Cloud Translation API 翻譯而成。

連結指標

這個模組包含控制連結指標通訊協定的函式，

摘要

列舉
`otLinkMetricsEnhAckFlags{ OT_LINK_METRICS_ENH_ACK_CLEAR = 0, OT_LINK_METRICS_ENH_ACK_REGISTER = 1 }`	列舉增強型旗標。
`otLinkMetricsStatus`	列舉連結指標狀態值。

Typedefs
`otLinkMetricsEnhAckFlags`	typedef `enum otLinkMetricsEnhAckFlags` 增強型旗標。
`otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress aExtAddress, const otLinkMetricsValues aMetricsValues, void *aContext)`	typedef `void(*` 收到 Enh-ACK Probing 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 `struct otLinkMetricsSeriesFlags` 這個結構代表「轉寄追蹤」系列包含哪些頁框。
`otLinkMetricsStatus`	typedef `enum otLinkMetricsStatus` 連結指標狀態值。
`otLinkMetricsValues`	typedef `struct otLinkMetricsValues` 這個結構代表連結指標查詢的結果 (值)。

Functions
`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

增強型旗標。

這些值在 Enhanced ACK 式探測中用來表示是否要註冊或清除探測。

屬性
`OT_LINK_METRICS_ENH_ACK_CLEAR`	一目了然，
`OT_LINK_METRICS_ENH_ACK_REGISTER`	註冊。

otLinkMetrics 狀態

 otLinkMetricsStatus

連結指標狀態值。

Typedefs

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

增強型旗標。

這些值在 Enhanced ACK 式探測中用來表示是否要註冊或清除探測。

otLinkMetricsEnhAckProbingIeReportCallback

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

收到 Enh-ACK Probing IE 時，會呼叫此函式指標。

詳細資料

參數

`[in] aShortAddress`	調查對象的 Mac 簡稱。
`[in] aExtAddress`	指向 Probing 主體的擴充地址。
`[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

這個結構代表「轉寄追蹤」系列包含哪些頁框。

otLinkMetrics 狀態

enum otLinkMetricsStatus otLinkMetricsStatus

連結指標狀態值。

otLinkMetricsValues

struct otLinkMetricsValues otLinkMetricsValues

這個結構代表連結指標查詢的結果 (值)。

Functions

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`	Ent-ACK 旗標來指出是否要註冊或清除探測。輸入 `0` 即可清除，並在註冊為 `1` 時完成。其他值則保留。
`[in] aLinkMetricsFlags`	指向查詢指標的指標。「`aEnhAckFlags`」為「`0`」時，應為 `NULL`。
`[in] aCallback`	收到包含連結指標的加強型 Ack 時，所呼叫的函式的指標。
`[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 裝置，不支援連結指標。

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`	Probe 訊息指定的系列 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`	鄰居不是 Thread 1.2 裝置，不支援連結指標。

資源

OpenThread API 參考資料主題出自原始碼，可於 GitHub 取得。如需更多資訊，或想參閱我們的說明文件，請參閱資源。