連結指標

這個模組內含控管連結指標通訊協定的函式。

摘要

列舉
otLinkMetricsEnhAckFlags{
  OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
  OT_LINK_METRICS_ENH_ACK_REGISTER = 1
} 		列舉
加強 ACK 標記。
otLinkMetricsStatus 列舉
連結指標狀態值。

Typedefs
otLinkMetricsEnhAckFlags typedef
加強 ACK 標記。
otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext) typedef
void(*
收到 Enh-ACK Probing 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 連結指標管理要求，以便設定/清除強化型探測器。
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 Link Probe 訊息。

結構
otLinkMetricsSeriesFlags

代表追蹤追蹤系列中會呈現的影格。
otLinkMetricsValues

代表「連結指標」查詢的結果 (值)。

列舉

otLinkMetricsEnhAckFlags

 otLinkMetricsEnhAckFlags

加強 ACK 標記。

這些會在增強型探測器中用於表示是否要註冊或清除探測作業。

屬性
OT_LINK_METRICS_ENH_ACK_CLEAR

一目了然，
OT_LINK_METRICS_ENH_ACK_REGISTER

註冊。

otLinkMetricsStatus

 otLinkMetricsStatus

連結指標狀態值。

Typedefs

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

加強 ACK 標記。

這些會在增強型探測器中用於表示是否要註冊或清除探測作業。

otLinkMetricsEnhAckProbingIeReportCallback

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

收到 Enh-ACK Probing IE 時，系統會呼叫指標。

詳細說明
參數
[in] aShortAddress
Probing 主旨的 Mac 短地址。
[in] aExtAddress
指向 Probing 主旨的 Mac 延伸位址。
[in] aMetricsValues
指向從 IE 取得的連結指標值。
[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 為空值時)。
[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 連結指標管理要求，以便設定/清除強化型探測器。

必須啟用 OT_LINK_METRICS_INITIATOR 功能，才能使用這項功能。

詳細說明
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aDestination
指向目的地地址的指標。
[in] aEnhAckFlags
Enh-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 裝置，不支援連結指標。

otLinkMetricsManagerGetMetricsValueByExtAddr

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

根據延伸地址取得鄰點的連結指標資料。

詳細說明
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aExtAddress
指向 Probing 主旨的 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 Link Probe 訊息。

詳細說明
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aDestination
指向目的地地址的指標。
[in] aSeriesId
Probe 訊息的目標 ID [1, 254]。
[in] aLength
連結 Probe TLV 中的資料酬載長度 0, 64。
傳回值
OT_ERROR_NONE
已成功傳送連結探測訊息。
OT_ERROR_NO_BUFS
緩衝區不足，無法產生 MLE Link Probe 訊息。
OT_ERROR_INVALID_ARGS
aSeriesId 或 aLength 不在有效範圍內。
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination 非連結本機，或找不到鄰點。
OT_ERROR_NOT_CAPABLE
鄰點不是 Thread 1.2 裝置，不支援連結指標。

資源

OpenThread API 參考資料主題源自原始碼，請前往 GitHub 取得。如要瞭解詳情或對說明文件做出貢獻，請參閱資源。