Monitor historii

Rejestruje historię różnych zdarzeń, np. wiadomości RX i TX lub zmiany informacji o sieci.

Podsumowanie

Wszystkie śledzone wpisy są oznaczone sygnaturą czasową.

Funkcje tego modułu są dostępne po włączeniu OPENTHREAD_CONFIG_HISTOR_TRACKER_ENABLE.

Wyliczenia

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
}
wyliczenie
Stałe wartości priorytetu wiadomości używane w strukturze otHistoryTrackerMessageInfo.
otHistoryTrackerAddressEvent{
  OT_HISTORY_TRACKER_ADDRESS_EVENT_ADDED = 0,
  OT_HISTORY_TRACKER_ADDRESS_EVENT_REMOVED = 1
}
wyliczenie
To wyliczenie definiuje zdarzenia dla adresu IPv6 (unicast lub multicast) (np. to, czy adres został dodany czy usunięty).
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
}
wyliczenie
To wyliczenie definiuje zdarzenia w sąsiedztwie (np.
otHistoryTrackerNetDataEvent{
  OT_HISTORY_TRACKER_NET_DATA_ENTRY_ADDED = 0,
  OT_HISTORY_TRACKER_NET_DATA_ENTRY_REMOVED = 1
}
wyliczenie
To wyliczenie definiuje zdarzenia dla wpisu sieciowego (np. dodanego lub usuniętego wpisu).

Typedefs

otHistoryTrackerExternalRouteInfo typedef
Ta struktura reprezentuje informacje o zewnętrznym trasach danych sieciowych.
otHistoryTrackerIterator typedef
Ten typ odpowiada iteratorom na liście historii.
otHistoryTrackerMessageInfo typedef
Ta struktura reprezentuje informacje RX/TX IPv6.
otHistoryTrackerMulticastAddressInfo typedef
Ta struktura reprezentuje adres grupowy IPv6.
otHistoryTrackerNeighborInfo typedef
Ta struktura przedstawia informacje o sąsiedzie.
otHistoryTrackerNetworkInfo typedef
Ta struktura reprezentuje informacje o sieci.
otHistoryTrackerOnMeshPrefixInfo typedef
Ta struktura reprezentuje dane sieci w prefiksie sieci typu mesh.
otHistoryTrackerUnicastAddressInfo typedef
Ta struktura reprezentuje informacje o adresie IPv6.

Funkcje

otHistoryTrackerEntryAgeToString(uint32_t aEntryAge, char *aBuffer, uint16_t aSize)
void
Ta funkcja konwertuje podany wiek wiekowy na ciąg zrozumiały dla człowieka.
otHistoryTrackerInitIterator(otHistoryTrackerIterator *aIterator)
void
Ta funkcja inicjuje tag otHistoryTrackerIterator.
otHistoryTrackerIterateExternalRouteHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Ta funkcja iteruje wpisy na liście historii wpisów zewnętrznych tras w sieci.
otHistoryTrackerIterateMulticastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Ta funkcja powtarza się nad wpisami na liście historii adresów grupowych.
otHistoryTrackerIterateNeighborHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Ta funkcja powtarza się nad wpisami na liście historii sąsiada.
otHistoryTrackerIterateNetInfoHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Ta funkcja powtarza się nad wpisami na liście historii informacji o sieci.
otHistoryTrackerIterateOnMeshPrefixHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Ta funkcja powtarza się nad wpisami na liście historii wpisów w prefiksie danych sieci komórkowej.
otHistoryTrackerIterateRxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Ta funkcja powtarza się nad wpisami na liście historii wiadomości RX.
otHistoryTrackerIterateTxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Ta funkcja powtarza się nad wpisami na liście historii wiadomości TX.
otHistoryTrackerIterateUnicastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Ta funkcja powtarza się nad wpisami na liście historii adresów unicast.

Strugi

otHistoryTrackerExternalRouteInfo

Ta struktura reprezentuje informacje o zewnętrznym trasach danych sieciowych.

otHistoryTrackerIterator

Ten typ odpowiada iteratorom na liście historii.

otHistoryTrackerMessageInfo

Ta struktura reprezentuje informacje RX/TX IPv6.

otHistoryTrackerMulticastAddressInfo

Ta struktura reprezentuje adres grupowy IPv6.

otHistoryTrackerNeighborInfo

Ta struktura przedstawia informacje o sąsiedzie.

otHistoryTrackerNetworkInfo

Ta struktura reprezentuje informacje o sieci.

otHistoryTrackerOnMeshPrefixInfo (w języku angielskim)

Ta struktura reprezentuje dane sieci w prefiksie sieci typu mesh.

otHistoryTrackerUnicastAddressInfo

Ta struktura reprezentuje informacje o adresie IPv6.

Wyliczenia

anonimowy enum

 anonymous enum

Stałe wartości priorytetu wiadomości używane w strukturze otHistoryTrackerMessageInfo.

Właściwości
OT_HISTORY_TRACKER_MSG_PRIORITY_HIGH

Poziom wysoki.

OT_HISTORY_TRACKER_MSG_PRIORITY_LOW

Niski priorytet.

OT_HISTORY_TRACKER_MSG_PRIORITY_NET

Poziom priorytetu Kontroli sieciowej.

OT_HISTORY_TRACKER_MSG_PRIORITY_NORMAL

Normalny poziom priorytetu.

otHistoryTrackerAddressEvent

 otHistoryTrackerAddressEvent

To wyliczenie definiuje zdarzenia dla adresu IPv6 (unicast lub multicast) (np. to, czy adres został dodany czy usunięty).

Właściwości
OT_HISTORY_TRACKER_ADDRESS_EVENT_ADDED

Adres został dodany.

OT_HISTORY_TRACKER_ADDRESS_EVENT_REMOVED

Adres został usunięty.

otHistoryTrackerNeighborEvent

 otHistoryTrackerNeighborEvent

To wyliczenie definiuje zdarzenia w sąsiedztwie (np.

informację o tym, czy sąsiad jest dodawany, usuwany czy zmieniany;

Zdarzenie OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING dotyczy tylko sąsiadów podrzędnych. Jest ona wyzwalana po ponownym uruchomieniu urządzenia, gdy poprzednia lista dzieci zostanie pobrana z niestabilnych ustawień, a urządzenie spróbuje przywrócić z nim połączenie.

Właściwości
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_ADDED

Dodano sąsiad.

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_CHANGED

Zmieniła się sąsiad (np. zmieniła się flaga trybu urządzenia).

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_REMOVED

Sąsiad został usunięty.

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING

Trwa przywracanie sąsiada (tylko dzieci).

otHistoryTrackerNetDataEvent

 otHistoryTrackerNetDataEvent

To wyliczenie definiuje zdarzenia dla wpisu sieciowego (np. dodanego lub usuniętego wpisu).

Właściwości
OT_HISTORY_TRACKER_NET_DATA_ENTRY_ADDED

Wpis danych sieci został dodany.

OT_HISTORY_TRACKER_NET_DATA_ENTRY_REMOVED

Wpis danych sieci został usunięty.

Typedefs

otHistoryTrackerExternalRouteInfo

struct otHistoryTrackerExternalRouteInfo otHistoryTrackerExternalRouteInfo

Ta struktura reprezentuje informacje o zewnętrznym trasach danych sieciowych.

otHistoryTrackerIterator,

struct otHistoryTrackerIterator otHistoryTrackerIterator

Ten typ odpowiada iteratorom na liście historii.

Pola tego typu są nieprzezroczyste (przeznaczone do użytku przez główny wątek), dlatego nie powinny być używane przez wywołującego.

Przed użyciem iteratora MUSZ, zostać zainicjowany za pomocą otHistoryTrackerInitIterator(),

otHistoryTrackerMessageInfo,

struct otHistoryTrackerMessageInfo otHistoryTrackerMessageInfo

Ta struktura reprezentuje informacje RX/TX IPv6.

Niektóre pola w tej strukturze dotyczą tylko wiadomości RX lub wiadomości TX, np. mAveRxRss to średni kanał RSS wszystkich ramek z fragmentami, które tworzą otrzymaną wiadomość, i dotyczy tylko wiadomości RX.

otHistoryTrackerMulticastAddressInfo,

struct otHistoryTrackerMulticastAddressInfo otHistoryTrackerMulticastAddressInfo

Ta struktura reprezentuje adres grupowy IPv6.

otHistoryTrackerNeighborInfo

struct otHistoryTrackerNeighborInfo otHistoryTrackerNeighborInfo

Ta struktura przedstawia informacje o sąsiedzie.

otHistoryTrackerNetworkInfo

struct otHistoryTrackerNetworkInfo otHistoryTrackerNetworkInfo

Ta struktura reprezentuje informacje o sieci.

otHistoryTrackerOnMeshPrefixInfo

struct otHistoryTrackerOnMeshPrefixInfo otHistoryTrackerOnMeshPrefixInfo

Ta struktura reprezentuje dane sieci w prefiksie sieci typu mesh.

otHistoryTrackerUnicastAddressInfo.

struct otHistoryTrackerUnicastAddressInfo otHistoryTrackerUnicastAddressInfo

Ta struktura reprezentuje informacje o adresie IPv6.

Funkcje

otHistoryTrackerEntryAgeToString,

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

Ta funkcja konwertuje podany wiek wiekowy na ciąg zrozumiały dla człowieka.

Ciąg wiekowy wpisu ma format „::danych”, aby określić godziny, minuty, sekundy i milisekundy (jeśli jest krótszy niż 1 dzień) lub

dni ::." (jeśli trwa dłużej niż jeden dzień).

Jeśli wynikowy ciąg nie mieści się w parametrze aBuffer (w ciągu aSize znaków), zostanie on obcięty, ale jego wartość zawsze będzie zakończona wartością null.

Szczegóły
Parametry
[in] aEntryAge
Wiek wpisu (czas trwania w milisekundach).
[out] aBuffer
Najedź kursorem na tablicę znaków, aby wygenerować ciąg (NIE MO beE być NULL).
[in] aSize
Rozmiar: aBuffer. Zalecane użycie: OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE.

otHistoryTrackerInitIterator,

void otHistoryTrackerInitIterator(
  otHistoryTrackerIterator *aIterator
)

Ta funkcja inicjuje tag otHistoryTrackerIterator.

Musi być zainicjowane iterator przed jego użyciem.

Inicjowanie iteratora może rozpocząć się od początku listy.

Gdy iterujesz wpisy na liście, ich wiek jest ustawiany względem tego, kiedy iterator został zainicjowany, czyli wiek wpisu jest określany jako czas trwania (w milisekundach) zdarzenia (gdy wpis był). ) do czasu inicjacji iteratora.

Szczegóły
Parametry
[in] aIterator
Wskaźnik iteratora do inicjowania (NIE musi być pusty).

otHistoryTrackerIterateExternalRouteHistory

const otHistoryTrackerExternalRouteInfo * otHistoryTrackerIterateExternalRouteHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

Ta funkcja iteruje wpisy na liście historii wpisów zewnętrznych tras w sieci.

Szczegóły
Parametry
[in] aInstance
Wskaźnik instancji OpenThread.
[in,out] aIterator
Wskaźnik do iteratora. MUSI być zainicjowane lub zachowanie jest niezdefiniowane.
[out] aEntryAge
Wskaźnik zmiennej, która podaje wiek wpisu. NIE JEST NULL. Wiek jest podany jako czas trwania (w milisekundach) od zarejestrowania wpisu do czasu zainicjowania aIterator. W przypadku wpisów starszych niż maksymalny wiek jest on ustawiony na OT_HISTORY_TRACKER_MAX_AGE.
Zwroty
Wpis otHistoryTrackerExternalRouteInfo lub NULL, jeśli nie ma więcej wpisów na liście.

otHistoryTrackerIterateMulticastAddressHistory

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

Ta funkcja powtarza się nad wpisami na liście historii adresów grupowych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik instancji OpenThread.
[in,out] aIterator
Wskaźnik do iteratora. MUSI być zainicjowane lub zachowanie jest niezdefiniowane.
[out] aEntryAge
Wskaźnik zmiennej, która podaje wiek wpisu. NIE JEST NULL. Wiek jest podany jako czas trwania (w milisekundach) od zarejestrowania wpisu do czasu zainicjowania aIterator. W przypadku wpisów starszych niż maksymalny wiek jest on ustawiony na OT_HISTORY_TRACKER_MAX_AGE.
Zwroty
Wskaźnik na wpis otHistoryTrackerMulticastAddressInfo lub NULL, jeśli nie ma więcej wpisów na liście.

otHistoryTrackerIterateNeighborHistory

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

Ta funkcja powtarza się nad wpisami na liście historii sąsiada.

Szczegóły
Parametry
[in] aInstance
Wskaźnik instancji OpenThread.
[in,out] aIterator
Wskaźnik do iteratora. MUSI być zainicjowane lub zachowanie jest niezdefiniowane.
[out] aEntryAge
Wskaźnik zmiennej, która podaje wiek wpisu. NIE JEST NULL. Wiek jest podany jako czas trwania (w milisekundach) od zarejestrowania wpisu do czasu zainicjowania aIterator. W przypadku wpisów starszych niż maksymalny wiek jest on ustawiony na OT_HISTORY_TRACKER_MAX_AGE.
Zwroty
Wpis otHistoryTrackerNeighborInfo lub NULL, jeśli nie ma więcej wpisów na liście.

otHistoryTrackerIterateNetInfoHistory

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

Ta funkcja powtarza się nad wpisami na liście historii informacji o sieci.

Szczegóły
Parametry
[in] aInstance
Wskaźnik instancji OpenThread.
[in,out] aIterator
Wskaźnik do iteratora. MUSI być zainicjowane lub zachowanie jest niezdefiniowane.
[out] aEntryAge
Wskaźnik zmiennej, która podaje wiek wpisu. NIE JEST NULL. Wiek jest podany jako czas trwania (w milisekundach) od zarejestrowania wpisu do czasu zainicjowania aIterator. W przypadku wpisów starszych niż maksymalny wiek jest on ustawiony na OT_HISTORY_TRACKER_MAX_AGE.
Zwroty
Wskaźnik na wpis otHistoryTrackerNetworkInfo lub NULL, jeśli nie ma więcej wpisów na liście.

otHistoryTrackerIterateOnMeshPrefixHistory

const otHistoryTrackerOnMeshPrefixInfo * otHistoryTrackerIterateOnMeshPrefixHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

Ta funkcja powtarza się nad wpisami na liście historii wpisów w prefiksie danych sieci komórkowej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik instancji OpenThread.
[in,out] aIterator
Wskaźnik do iteratora. MUSI być zainicjowane lub zachowanie jest niezdefiniowane.
[out] aEntryAge
Wskaźnik zmiennej, która podaje wiek wpisu. NIE JEST NULL. Wiek jest podany jako czas trwania (w milisekundach) od zarejestrowania wpisu do czasu zainicjowania aIterator. W przypadku wpisów starszych niż maksymalny wiek jest on ustawiony na OT_HISTORY_TRACKER_MAX_AGE.
Zwroty
Wpis otHistoryTrackerOnMeshPrefixInfo lub NULL, jeśli nie ma więcej wpisów na liście.

otHistoryTrackerIterateRxHistory

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

Ta funkcja powtarza się nad wpisami na liście historii wiadomości RX.

Szczegóły
Parametry
[in] aInstance
Wskaźnik instancji OpenThread.
[in,out] aIterator
Wskaźnik do iteratora. MUSI być zainicjowane lub zachowanie jest niezdefiniowane.
[out] aEntryAge
Wskaźnik zmiennej, która podaje wiek wpisu. NIE JEST NULL. Wiek jest podany jako czas trwania (w milisekundach) od zarejestrowania wpisu do czasu zainicjowania aIterator. W przypadku wpisów starszych niż maksymalny wiek jest on ustawiony na OT_HISTORY_TRACKER_MAX_AGE.
Zwroty
Wpis otHistoryTrackerMessageInfo lub NULL, jeśli nie ma więcej wpisów na liście.

otHistoryTrackerIterateTxHistory

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

Ta funkcja powtarza się nad wpisami na liście historii wiadomości TX.

Szczegóły
Parametry
[in] aInstance
Wskaźnik instancji OpenThread.
[in,out] aIterator
Wskaźnik do iteratora. MUSI być zainicjowane lub zachowanie jest niezdefiniowane.
[out] aEntryAge
Wskaźnik zmiennej, która podaje wiek wpisu. NIE JEST NULL. Wiek jest podany jako czas trwania (w milisekundach) od zarejestrowania wpisu do czasu zainicjowania aIterator. W przypadku wpisów starszych niż maksymalny wiek jest on ustawiony na OT_HISTORY_TRACKER_MAX_AGE.
Zwroty
Wpis otHistoryTrackerMessageInfo lub NULL, jeśli nie ma więcej wpisów na liście.

otHistoryTrackerIterateUnicastAddressHistory

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

Ta funkcja powtarza się nad wpisami na liście historii adresów unicast.

Szczegóły
Parametry
[in] aInstance
Wskaźnik instancji OpenThread.
[in,out] aIterator
Wskaźnik do iteratora. MUSI być zainicjowane lub zachowanie jest niezdefiniowane.
[out] aEntryAge
Wskaźnik zmiennej, która podaje wiek wpisu. NIE JEST NULL. Wiek jest podany jako czas trwania (w milisekundach) od zarejestrowania wpisu do czasu zainicjowania aIterator. W przypadku wpisów starszych niż maksymalny wiek jest on ustawiony na OT_HISTORY_TRACKER_MAX_AGE.
Zwroty
Wskaźnik na wpis otHistoryTrackerUnicastAddressInfo lub NULL, jeśli nie ma więcej wpisów na liście.

Makra

OT_History_TRACKER_ENTRY_AGE_STRING_SIZE

 OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE 21

Zalecany rozmiar reprezentujący wiek wpisu.

OT_History_TRACKER_MAX_AGE

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

Ta wartość określa maksymalny wiek wpisów (49 dni).

Wpisy starsze niż maksymalny wiek będą miały tę wartość.

Zasoby

Tematy referencyjne interfejsu API OpenThread pochodzą z kodu źródłowego, który jest dostępny w GitHub. Jeśli chcesz dowiedzieć się więcej lub utworzyć dokumentację, zapoznaj się z materiałami.