Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

リンク指標

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

概要

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

Typedef
otLinkMetricsEnhAckFlags typedef
拡張 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

拡張 ACK フラグ。

Enhanced-ACK ベースのプローブでは、プローブの登録とクリアのどちらを行うかを決める際に使用します。

プロパティ
OT_LINK_METRICS_ENH_ACK_CLEAR

明快で
OT_LINK_METRICS_ENH_ACK_REGISTER

登録する

otLinkMetricsStatus

 otLinkMetricsStatus

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

Typedef

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

拡張 ACK フラグ。

Enhanced-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 データ リクエストを送信してリンク指標をクエリします。

Single Probe または Forward Tracking Series のいずれかです。

詳細
パラメータ
[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 で入手可能なソースコードに基づいています。 詳細またはドキュメントへの投稿については、リソースをご覧ください。