リンクの指標

このモジュールには、Link Metrics プロトコルを制御する関数が含まれています。

概要

列挙型
otLinkMetricsEnhAckFlags{
  OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
  OT_LINK_METRICS_ENH_ACK_REGISTER = 1
} 		enum
拡張 ACK フラグ。
otLinkMetricsStatus enum
リンクの指標のステータス値。

Typedef
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 リンク指標管理リクエストを送信して、拡張 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
Link Metrics Manager を有効または無効にします。
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

リンクの指標のステータス値。

Typedef

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

拡張 ACK フラグ。

これらは、拡張 ACK ベースのプローブで、プロービングを登録するかクリアするかを示すために使用されます。

otLinkMetricsEnhAckProbingIeReportCallback

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

Enh-ACK Probing IE を受信すると、ポインタが呼び出されます。

詳細
パラメータ
[in] aShortAddress
調査サブジェクトの Mac 短いアドレス。
[in] aExtAddress
Probing Subject の 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 が 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
Probing Subject の Mac 拡張アドレスへのポインタ。
[out] aLinkMetricsValues
サブジェクトのリンク指標値へのポインタ。
戻り値
OT_ERROR_NONE
リンク指標データが正常に取得されました。
OT_ERROR_INVALID_ARGS
引数が無効です。
OT_ERROR_NOT_FOUND
指定された拡張アドレスを持つネイバーが見つかりません。

otLinkMetricsManagerSetEnabled

void otLinkMetricsManagerSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Link Metrics Manager を有効または無効にします。

詳細
パラメータ
[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
Probe メッセージが対象とするシリーズ 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 で入手できるソースコードに由来しています。 詳細について、またはドキュメントへの投稿については、リソースをご覧ください。