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

履歴トラッカー

概要

列挙

anonymous enum {
OT_HISTORY_TRACKER_MSG_PRIORITY_LOW = OT_MESSAGE_PRIORITY_LOW,
OT_HISTORY_TRACKER_MSG_PRIORITY_NORMAL = OT_MESSAGE_PRIORITY_NORMAL,
OT_HISTORY_TRACKER_MSG_PRIORITY_HIGH = OT_MESSAGE_PRIORITY_HIGH,
OT_HISTORY_TRACKER_MSG_PRIORITY_NET = OT_MESSAGE_PRIORITY_HIGH + 1
}
列挙型
使用されるメッセージの優先度を表す定数otHistoryTrackerMessageInfo構造体を。
otHistoryTrackerAddressEvent {
OT_HISTORY_TRACKER_ADDRESS_EVENT_ADDED = 0,
OT_HISTORY_TRACKER_ADDRESS_EVENT_REMOVED = 1
}
列挙型
この列挙は、IPv6(ユニキャストまたはマルチキャスト)アドレス情報(つまり、アドレスが追加されるか削除されるか)のイベントを定義します。
otHistoryTrackerNeighborEvent {
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_ADDED = 0,
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_REMOVED = 1,
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_CHANGED = 2,
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING = 3
}
列挙型
この列挙は、ネイバー情報のイベントを定義します(つまり、

Typedef

otHistoryTrackerIterator typedef
このタイプは、履歴リストを反復処理するイテレーターを表します。
otHistoryTrackerMessageInfo typedef
この構造は、RX / TXIPv6メッセージ情報を表します。
otHistoryTrackerMulticastAddressInfo typedef
この構造は、IPv6マルチキャストアドレス情報を表します。
otHistoryTrackerNeighborInfo typedef
この構造は、ネイバー情報を表します。
otHistoryTrackerNetworkInfo typedef
この構造は、スレッドネットワーク情報を表します。
otHistoryTrackerUnicastAddressInfo typedef
この構造は、ユニキャストIPv6アドレス情報を表します。

関数

otHistoryTrackerEntryAgeToString (uint32_t aEntryAge, char *aBuffer, uint16_t aSize)
void
この関数は、指定された入力年齢を人間が読める文字列に変換します。
otHistoryTrackerInitIterator ( otHistoryTrackerIterator *aIterator)
void
この関数は、初期化otHistoryTrackerIterator
otHistoryTrackerIterateMulticastAddressHistory ( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
この関数は、マルチキャストアドレス履歴リストのエントリを繰り返し処理します。
otHistoryTrackerIterateNeighborHistory ( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
この関数は、ネイバー履歴リストのエントリを繰り返し処理します。
otHistoryTrackerIterateNetInfoHistory ( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
この関数は、ネットワーク情報履歴リストのエントリを繰り返し処理します。
otHistoryTrackerIterateRxHistory ( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
この関数は、RXメッセージ履歴リストのエントリを繰り返し処理します。
otHistoryTrackerIterateTxHistory ( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
この関数は、TXメッセージ履歴リストのエントリを繰り返し処理します。
otHistoryTrackerIterateUnicastAddressHistory ( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
この関数は、ユニキャストアドレス履歴リストのエントリを繰り返し処理します。

構造体

otHistoryTrackerIterator

このタイプは、履歴リストを反復処理するイテレーターを表します。

otHistoryTrackerMessageInfo

この構造は、RX / TXIPv6メッセージ情報を表します。

otHistoryTrackerMulticastAddressInfo

この構造は、IPv6マルチキャストアドレス情報を表します。

otHistoryTrackerNeighborInfo

この構造は、ネイバー情報を表します。

otHistoryTrackerNetworkInfo

この構造は、スレッドネットワーク情報を表します。

otHistoryTrackerUnicastAddressInfo

この構造は、ユニキャストIPv6アドレス情報を表します。

列挙

匿名列挙型

 anonymous enum

使用されるメッセージの優先度を表す定数otHistoryTrackerMessageInfo構造体を。

プロパティ
OT_HISTORY_TRACKER_MSG_PRIORITY_HIGH

優先度が高い。

OT_HISTORY_TRACKER_MSG_PRIORITY_LOW

優先度が低い。

OT_HISTORY_TRACKER_MSG_PRIORITY_NET

ネットワーク制御の優先度。

OT_HISTORY_TRACKER_MSG_PRIORITY_NORMAL

通常の優先度。

otHistoryTrackerAddressEvent

 otHistoryTrackerAddressEvent

この列挙は、IPv6(ユニキャストまたはマルチキャスト)アドレス情報(つまり、アドレスが追加されるか削除されるか)のイベントを定義します。

プロパティ
OT_HISTORY_TRACKER_ADDRESS_EVENT_ADDED

アドレスが追加されます。

OT_HISTORY_TRACKER_ADDRESS_EVENT_REMOVED

アドレスが削除されます。

otHistoryTrackerNeighborEvent

 otHistoryTrackerNeighborEvent

この列挙は、ネイバー情報のイベントを定義します(つまり、

ネイバーが追加、削除、または変更されたかどうか)。

イベントOT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING一人っ子隣人に適用されます。これは、デバイスが(再)起動した後、前の子リストが不揮発性設定から取得され、デバイスがそれらへの接続を復元しようとしたときにトリガーされます。

プロパティ
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_ADDED

隣人が追加されます。

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_CHANGED

ネイバーが変更されました(たとえば、デバイスモードフラグが変更されました)。

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_REMOVED

隣人が削除されます。

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING

隣人が復元されています(子供にのみ適用されます)。

Typedef

otHistoryTrackerIterator

struct otHistoryTrackerIterator otHistoryTrackerIterator

このタイプは、履歴リストを反復処理するイテレーターを表します。

このタイプのフィールドは不透明(OpenThreadコアでの使用を目的としています)であるため、呼び出し元がアクセス/使用しないでください。

イテレータを使用する前に、それは使用して初期化しなければなりませんotHistoryTrackerInitIterator()

otHistoryTrackerMessageInfo

struct otHistoryTrackerMessageInfo otHistoryTrackerMessageInfo

この構造は、RX / TXIPv6メッセージ情報を表します。

この構造体のフィールドのいくつかは、例えば、唯一のRXメッセージまたはTXメッセージに適用されるmAveRxRss受信したメッセージを形成するすべてのフラグメントフレームの平均RSSで、RXメッセージにのみ適用されます。

otHistoryTrackerMulticastAddressInfo

struct otHistoryTrackerMulticastAddressInfo otHistoryTrackerMulticastAddressInfo

この構造は、IPv6マルチキャストアドレス情報を表します。

otHistoryTrackerNeighborInfo

struct otHistoryTrackerNeighborInfo otHistoryTrackerNeighborInfo

この構造は、ネイバー情報を表します。

otHistoryTrackerNetworkInfo

struct otHistoryTrackerNetworkInfo otHistoryTrackerNetworkInfo

この構造は、スレッドネットワーク情報を表します。

otHistoryTrackerUnicastAddressInfo

struct otHistoryTrackerUnicastAddressInfo otHistoryTrackerUnicastAddressInfo

この構造は、ユニキャストIPv6アドレス情報を表します。

関数

otHistoryTrackerEntryAgeToString

void otHistoryTrackerEntryAgeToString(
  uint32_t aEntryAge,
  char *aBuffer,
  uint16_t aSize
)

この関数は、指定された入力年齢を人間が読める文字列に変換します。

入力年齢文字列は、「」の形式に従います。 「時間、分、秒、ミリ秒(1日より短い場合)または」

日々 "(1日より長い場合)。

結果の文字列が中に入らない場合aBuffer (その内aSize文字)、文字列が切り捨てられますが、出力された文字列は常にヌルで終了です。

詳細
パラメーター
[in] aEntryAge
エントリー年齢(ミリ秒単位の期間)。
[out] aBuffer
文字列を出力するためのchar配列へのポインタ(NULLであってはなりません)。
[in] aSize
大きさaBuffer 。使用することをお勧めOT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE

otHistoryTrackerInitIterator

void otHistoryTrackerInitIterator(
  otHistoryTrackerIterator *aIterator
)

この関数は、初期化otHistoryTrackerIterator

イテレータは、使用する前に初期化する必要があります。

イテレータは、リストの最初から開始するように再度初期化できます。

リスト内のエントリを反復処理する場合、エントリの経過時間が一貫していることを確認するために、経過時間はイテレータが初期化された時間に関連して指定されます。つまり、エントリの経過時間は、イベントからの期間(ミリ秒単位)として提供されます(エントリが記録)イテレータの初期化時間に。

詳細
パラメーター
[in] aIterator
初期化するイテレータへのポインタ(NULLであってはなりません)。

otHistoryTrackerIterateMulticastAddressHistory

const otHistoryTrackerMulticastAddressInfo * otHistoryTrackerIterateMulticastAddressHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

この関数は、マルチキャストアドレス履歴リストのエントリを繰り返し処理します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in,out] aIterator
イテレータへのポインタ。初期化する必要があります。そうでない場合、動作は未定義です。
[out] aEntryAge
エントリの経過時間を出力する変数へのポインタ。 NULLであってはなりません。年齢は、エントリがに記録されたときから(ミリ秒)の期間として提供さaIterator初期化時間。それは次のように設定されOT_HISTORY_TRACKER_MAX_AGE最大年齢よりも古いエントリを。
戻り値
ポインタotHistoryTrackerMulticastAddressInfoエントリまたはNULLリスト内にこれ以上のエントリがある場合。

otHistoryTrackerIterateNeighborHistory

const otHistoryTrackerNeighborInfo * otHistoryTrackerIterateNeighborHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

この関数は、ネイバー履歴リストのエントリを繰り返し処理します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in,out] aIterator
イテレータへのポインタ。初期化する必要があります。そうでない場合、動作は未定義です。
[out] aEntryAge
エントリの経過時間を出力する変数へのポインタ。 NULLであってはなりません。年齢は、エントリがに記録されたときから(ミリ秒)の期間として提供さaIterator初期化時間。それは次のように設定されOT_HISTORY_TRACKER_MAX_AGE最大年齢よりも古いエントリを。
戻り値
otHistoryTrackerNeighborInfoエントリまたはNULLリスト内にこれ以上のエントリがある場合。

otHistoryTrackerIterateNetInfoHistory

const otHistoryTrackerNetworkInfo * otHistoryTrackerIterateNetInfoHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

この関数は、ネットワーク情報履歴リストのエントリを繰り返し処理します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in,out] aIterator
イテレータへのポインタ。初期化する必要があります。そうでない場合、動作は未定義です。
[out] aEntryAge
エントリの経過時間を出力する変数へのポインタ。 NULLであってはなりません。年齢は、エントリがに記録されたときから(ミリ秒)の期間として提供さaIterator初期化時間。それは次のように設定されOT_HISTORY_TRACKER_MAX_AGE最大年齢よりも古いエントリを。
戻り値
ポインタotHistoryTrackerNetworkInfoエントリまたはNULLリスト内にこれ以上のエントリがある場合。

otHistoryTrackerIterateRxHistory

const otHistoryTrackerMessageInfo * otHistoryTrackerIterateRxHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

この関数は、RXメッセージ履歴リストのエントリを繰り返し処理します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in,out] aIterator
イテレータへのポインタ。初期化する必要があります。そうでない場合、動作は未定義です。
[out] aEntryAge
エントリの経過時間を出力する変数へのポインタ。 NULLであってはなりません。年齢は、エントリがに記録されたときから(ミリ秒)の期間として提供さaIterator初期化時間。それは次のように設定されOT_HISTORY_TRACKER_MAX_AGE最大年齢よりも古いエントリを。
戻り値
otHistoryTrackerMessageInfoエントリまたはNULLリスト内にこれ以上のエントリがある場合。

otHistoryTrackerIterateTxHistory

const otHistoryTrackerMessageInfo * otHistoryTrackerIterateTxHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

この関数は、TXメッセージ履歴リストのエントリを繰り返し処理します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in,out] aIterator
イテレータへのポインタ。初期化する必要があります。そうでない場合、動作は未定義です。
[out] aEntryAge
エントリの経過時間を出力する変数へのポインタ。 NULLであってはなりません。年齢は、エントリがに記録されたときから(ミリ秒)の期間として提供さaIterator初期化時間。それは次のように設定されOT_HISTORY_TRACKER_MAX_AGE最大年齢よりも古いエントリを。
戻り値
otHistoryTrackerMessageInfoエントリまたはNULLリスト内にこれ以上のエントリがある場合。

otHistoryTrackerIterateUnicastAddressHistory

const otHistoryTrackerUnicastAddressInfo * otHistoryTrackerIterateUnicastAddressHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

この関数は、ユニキャストアドレス履歴リストのエントリを繰り返し処理します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in,out] aIterator
イテレータへのポインタ。初期化する必要があります。そうでない場合、動作は未定義です。
[out] aEntryAge
エントリの経過時間を出力する変数へのポインタ。 NULLであってはなりません。年齢は、エントリがに記録されたときから(ミリ秒)の期間として提供さaIterator初期化時間。それは次のように設定されOT_HISTORY_TRACKER_MAX_AGE最大年齢よりも古いエントリを。
戻り値
ポインタotHistoryTrackerUnicastAddressInfoエントリまたはNULLリスト内にこれ以上のエントリがある場合。

マクロ

OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE

 OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE 21

エントリ年齢の文字列表現に推奨されるサイズ。

OT_HISTORY_TRACKER_MAX_AGE

 OT_HISTORY_TRACKER_MAX_AGE (49 * 24 * 60 * 60 * 1000u)

このヘッダーは、HistoryTrackerのパブリックAPIを定義します。

履歴トラッカーモジュールは、スレッドネットワークの動作中に、さまざまなイベント(RXおよびTXメッセージやネットワーク情報の変更など)の履歴を記録します。追跡されたすべてのエントリにはタイムスタンプが付けられます。

ときに、このモジュールの関数が用意されていますOPENTHREAD_CONFIG_HISTOR_TRACKER_ENABLE有効になっています。この定数は、エントリの最大経過時間を49日(ミリ秒単位)で指定します。

最大年齢より古いエントリは、年齢としてこの値を示します。