Zapis historii
Rejestruje historię różnych zdarzeń, np. wiadomości RX i TX czy zmian informacji o sieci.
Podsumowanie
Wszystkie śledzone wpisy mają sygnatury czasowe.
Funkcje w tym module są dostępne, gdy włączony jest język OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE
.
Definicje typów |
|
---|---|
otHistoryTrackerExternalRouteInfo
|
typedef Reprezentuj zewnętrzne informacje o trasie danych sieci. |
otHistoryTrackerIterator
|
typedefstruct otHistoryTrackerIterator
Reprezentuje iterator do iteracji z użyciem listy historii. |
otHistoryTrackerMessageInfo
|
typedefstruct otHistoryTrackerMessageInfo
Reprezentuje informacje o komunikacie IPv6 RX/TX. |
otHistoryTrackerMulticastAddressInfo
|
typedef Reprezentuj informacje o adresie multiemisji IPv6. |
otHistoryTrackerNeighborInfo
|
typedefstruct otHistoryTrackerNeighborInfo
Reprezentuje informacje o sąsiedzie. |
otHistoryTrackerNetworkInfo
|
typedefstruct otHistoryTrackerNetworkInfo
Reprezentuje informacje o sieci Thread. |
otHistoryTrackerOnMeshPrefixInfo
|
typedef Reprezentuje dane sieci w informacjach o prefiksie sieci typu mesh. |
otHistoryTrackerRouterInfo
|
typedefstruct otHistoryTrackerRouterInfo
Reprezentuje zdarzenie wejścia w tabeli routera. |
otHistoryTrackerUnicastAddressInfo
|
typedef Reprezentuj informacje o adresie IPv6 pojedynczym. |
Funkcje |
|
---|---|
otHistoryTrackerEntryAgeToString(uint32_t aEntryAge, char *aBuffer, uint16_t aSize)
|
void
Konwertuje wiek wpisu na ciąg zrozumiały dla człowieka.
|
otHistoryTrackerInitIterator(otHistoryTrackerIterator *aIterator)
|
void
Inicjuje
otHistoryTrackerIterator . |
otHistoryTrackerIterateExternalRouteHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
Powtarza się wpisy na liście historii zewnętrznych tras wpisów o sieciach danych.
|
otHistoryTrackerIterateMulticastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
Wykonuje iterację nad wpisami na liście historii adresów w trybie multicast.
|
otHistoryTrackerIterateNeighborHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerNeighborInfo *
Wykonuje iterację nad wpisami na liście historii sąsiadów.
|
otHistoryTrackerIterateNetInfoHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerNetworkInfo *
Powtarza się wpisy na liście historii informacji o sieci.
|
otHistoryTrackerIterateOnMeshPrefixHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerOnMeshPrefixInfo *
Wykonuje iteracje nad pozycjami na liście danych sieci na liście historii prefiksów sieci typu mesh.
|
otHistoryTrackerIterateRouterHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerRouterInfo *
Wykonuje iterację nad wpisami na liście historii routera.
|
otHistoryTrackerIterateRxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerMessageInfo *
Wykonuje iterację nad pozycjami na liście historii wiadomości RX.
|
otHistoryTrackerIterateTxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerMessageInfo *
Powtarza się pozycje na liście historii wiadomości TX.
|
otHistoryTrackerIterateUnicastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
Wykonuje iterację nad wpisami na liście historii adresów pojedyncza.
|
Konstrukcja |
|
---|---|
otHistoryTrackerExternalRouteInfo |
Reprezentuj zewnętrzne informacje o trasie danych sieci. |
otHistoryTrackerIterator |
Reprezentuje iterator do iteracji z użyciem listy historii. |
otHistoryTrackerMessageInfo |
Reprezentuje informacje o komunikacie IPv6 RX/TX. |
otHistoryTrackerMulticastAddressInfo |
Reprezentuj informacje o adresie multiemisji IPv6. |
otHistoryTrackerNeighborInfo |
Reprezentuje informacje o sąsiedzie. |
otHistoryTrackerNetworkInfo |
Reprezentuje informacje o sieci Thread. |
otHistoryTrackerOnMeshPrefixInfo |
Reprezentuje dane sieci w informacjach o prefiksie sieci typu mesh. |
otHistoryTrackerRouterInfo |
Reprezentuje zdarzenie wejścia w tabeli routera. |
otHistoryTrackerUnicastAddressInfo |
Reprezentuj informacje o adresie IPv6 pojedynczym. |
Wyliczenia
anonimowe wyliczenie
anonymous enum
Stałe reprezentujące priorytet wiadomości używane w strukturze otHistoryTrackerMessageInfo
.
Właściwości | |
---|---|
OT_HISTORY_TRACKER_MSG_PRIORITY_HIGH
|
Wysoki priorytet. |
OT_HISTORY_TRACKER_MSG_PRIORITY_LOW
|
Niski priorytet. |
OT_HISTORY_TRACKER_MSG_PRIORITY_NET
|
Poziom priorytetu Kontrola sieci. |
OT_HISTORY_TRACKER_MSG_PRIORITY_NORMAL
|
Zwykły priorytet. |
otHistoryTrackerAddressEvent
otHistoryTrackerAddressEvent
Definiuje zdarzenia dla informacji o adresie IPv6 (transmisja pojedyncza lub multiemisja) (tzn. 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
Definiuje zdarzenia w informacjach o sąsiedztwie (np.
czy sąsiad został dodany, usunięty czy zmieniony).
Zdarzenie OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING
dotyczy tylko sąsiadów podrzędnych. Jest wyzwalany po ponownym uruchomieniu urządzenia i pobraniu poprzedniej listy elementów podrzędnych z ustawień nieulotnych, a urządzenie spróbuje przywrócić z nimi połączenie.
Właściwości | |
---|---|
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_ADDED
|
Sąsiad został dodany. |
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_CHANGED
|
Zmieniono sąsiada (np. zmieniono flagi trybu urządzenia). |
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_REMOVED
|
Sąsiad został usunięty. |
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING
|
Przywracam sąsiada (tylko dla podmiotów podrzędnych). |
otHistoryTrackerNetDataEvent
otHistoryTrackerNetDataEvent
Definiuje zdarzenia dla wpisu Dane sieci (tzn. tego, czy wpis został dodany czy usunięty).
Właściwości | |
---|---|
OT_HISTORY_TRACKER_NET_DATA_ENTRY_ADDED
|
Dodano wpis danych sieci. |
OT_HISTORY_TRACKER_NET_DATA_ENTRY_REMOVED
|
Wpis danych sieci został usunięty. |
otHistoryTrackerRouterEvent
otHistoryTrackerRouterEvent
Definiuje zdarzenia w informacjach o routerze (np.
dodanie, usunięcie lub zmiana routera).
Właściwości | |
---|---|
OT_HISTORY_TRACKER_ROUTER_EVENT_ADDED
|
Router został dodany (przydzielony identyfikator routera). |
OT_HISTORY_TRACKER_ROUTER_EVENT_COST_CHANGED
|
Zmieniono koszt ścieżki wejścia routera (następny przeskok tak jak wcześniej). |
OT_HISTORY_TRACKER_ROUTER_EVENT_NEXT_HOP_CHANGED
|
Następny wpis routera i koszt zostały zmienione. |
OT_HISTORY_TRACKER_ROUTER_EVENT_REMOVED
|
Wpis routera został usunięty (identyfikator routera został zwolniony). |
Definicje typów
otHistoryTrackerExternalRouteInfo
struct otHistoryTrackerExternalRouteInfo otHistoryTrackerExternalRouteInfo
Reprezentuj zewnętrzne informacje o trasie danych sieci.
otHistoryTrackerIterator
struct otHistoryTrackerIterator otHistoryTrackerIterator
Reprezentuje iterator do iteracji z użyciem listy historii.
Pola tego typu są nieprzezroczyste (przeznaczone do użycia przez rdzeń OpenThread), więc element wywołujący nie powinien ich używać ani uzyskiwać do nich dostępu.
Przed użyciem iteratora MUSI zostać zainicjowana za pomocą polecenia otHistoryTrackerInitIterator()
,
otHistoryTrackerMessageInfo
struct otHistoryTrackerMessageInfo otHistoryTrackerMessageInfo
Reprezentuje informacje o komunikacie IPv6 RX/TX.
Niektóre z pól w tej strukturze mają zastosowanie tylko do wiadomości RX i wiadomości TX, np. mAveRxRss
to średni RSS ze wszystkich ramek fragmentu, które tworzą otrzymaną wiadomość, i ma zastosowanie tylko w przypadku wiadomości RX.
otHistoryTrackerMulticastAddressInfo
struct otHistoryTrackerMulticastAddressInfo otHistoryTrackerMulticastAddressInfo
Reprezentuj informacje o adresie multiemisji IPv6.
otHistoryTrackerNeighborInfo
struct otHistoryTrackerNeighborInfo otHistoryTrackerNeighborInfo
Reprezentuje informacje o sąsiedzie.
otHistoryTrackerNetworkInfo
struct otHistoryTrackerNetworkInfo otHistoryTrackerNetworkInfo
Reprezentuje informacje o sieci Thread.
otHistoryTrackerOnMeshPrefixInfo
struct otHistoryTrackerOnMeshPrefixInfo otHistoryTrackerOnMeshPrefixInfo
Reprezentuje dane sieci w informacjach o prefiksie sieci typu mesh.
otHistoryTrackerRouterInfo
struct otHistoryTrackerRouterInfo otHistoryTrackerRouterInfo
Reprezentuje zdarzenie wejścia w tabeli routera.
otHistoryTrackerUnicastAddressInfo
struct otHistoryTrackerUnicastAddressInfo otHistoryTrackerUnicastAddressInfo
Reprezentuj informacje o adresie IPv6 pojedynczym.
Funkcje
otHistoryTrackerEntryAgeToString
void otHistoryTrackerEntryAgeToString( uint32_t aEntryAge, char *aBuffer, uint16_t aSize )
Konwertuje wiek wpisu na ciąg zrozumiały dla człowieka.
Ciąg znaków dotyczący wieku wpisu ma format „
Jeśli powstały ciąg znaków nie mieści się w polu aBuffer
(łącznie ze znakami aSize
), zostanie on obcięty, ale wyjściowy ciąg będzie zawsze miał wartość null.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
otHistoryTrackerInitIterator
void otHistoryTrackerInitIterator( otHistoryTrackerIterator *aIterator )
Inicjuje otHistoryTrackerIterator
.
Przed użyciem iteratora MUSI zostać zainicjowany.
Iterator można ponownie zainicjować, aby zacząć od początku listy.
Podczas iteracji nad wpisami na liście, aby zapewnić spójność wieku wpisu, wiek jest podawany w odniesieniu do czasu zainicjowania iteratora. Wiek wpisu jest podawany jako czas trwania (w milisekundach) od zdarzenia (po zarejestrowaniu wpisu) do czasu inicjowania iteratora.
Szczegóły | |||
---|---|---|---|
Parametry |
|
otHistoryTrackerIterateExternalRouteHistory
const otHistoryTrackerExternalRouteInfo * otHistoryTrackerIterateExternalRouteHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Powtarza się wpisy na liście historii zewnętrznych tras wpisów o sieciach danych.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwroty |
Wpis
otHistoryTrackerExternalRouteInfo lub NULL , jeśli na liście nie ma więcej pozycji. |
otHistoryTrackerIterateMulticastAddressHistory
const otHistoryTrackerMulticastAddressInfo * otHistoryTrackerIterateMulticastAddressHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Wykonuje iterację nad wpisami na liście historii adresów w trybie multicast.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwroty |
Wskaźnik do wpisu
otHistoryTrackerMulticastAddressInfo lub NULL , jeśli na liście nie ma więcej pozycji. |
otHistoryTrackerIterateNeighborHistory
const otHistoryTrackerNeighborInfo * otHistoryTrackerIterateNeighborHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Wykonuje iterację nad wpisami na liście historii sąsiadów.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwroty |
Wpis
otHistoryTrackerNeighborInfo lub NULL , jeśli na liście nie ma więcej pozycji. |
otHistoryTrackerIterateNetInfoHistory
const otHistoryTrackerNetworkInfo * otHistoryTrackerIterateNetInfoHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Powtarza się wpisy na liście historii informacji o sieci.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwroty |
Wskaźnik do wpisu
otHistoryTrackerNetworkInfo lub NULL , jeśli na liście nie ma więcej pozycji. |
otHistoryTrackerIterateOnMeshPrefixHistory
const otHistoryTrackerOnMeshPrefixInfo * otHistoryTrackerIterateOnMeshPrefixHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Wykonuje iteracje nad pozycjami na liście danych sieci na liście historii prefiksów sieci typu mesh.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwroty |
Wpis
otHistoryTrackerOnMeshPrefixInfo lub NULL , jeśli na liście nie ma więcej pozycji. |
otHistoryTrackerIterateRouterHistory
const otHistoryTrackerRouterInfo * otHistoryTrackerIterateRouterHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Wykonuje iterację nad wpisami na liście historii routera.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwroty |
Wpis
otHistoryTrackerRouterInfo lub NULL , jeśli na liście nie ma więcej pozycji. |
otHistoryTrackerIterateRxHistory
const otHistoryTrackerMessageInfo * otHistoryTrackerIterateRxHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Wykonuje iterację nad pozycjami na liście historii wiadomości RX.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwroty |
Wpis
otHistoryTrackerMessageInfo lub NULL , jeśli na liście nie ma więcej pozycji. |
otHistoryTrackerIterateTxHistory
const otHistoryTrackerMessageInfo * otHistoryTrackerIterateTxHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Powtarza się pozycje na liście historii wiadomości TX.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwroty |
Wpis
otHistoryTrackerMessageInfo lub NULL , jeśli na liście nie ma więcej pozycji. |
otHistoryTrackerIterateUnicastAddressHistory
const otHistoryTrackerUnicastAddressInfo * otHistoryTrackerIterateUnicastAddressHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Wykonuje iterację nad wpisami na liście historii adresów pojedyncza.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwroty |
Wskaźnik do wpisu
otHistoryTrackerUnicastAddressInfo lub NULL , jeśli na liście nie ma więcej pozycji. |
Makra
OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE
OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE 21
Zalecany rozmiar na potrzeby reprezentacji wieku wpisu w postaci ciągu.
OT_HISTORY_TRACKER_INFINITE_PATH_COST
OT_HISTORY_TRACKER_INFINITE_PATH_COST 0
Koszt nieskończonej ścieżki – używany w otHistoryTrackerRouterInfo
.
OT_HISTORY_TRACKER_MAX_AGE
OT_HISTORY_TRACKER_MAX_AGE (49 * 24 * 60 * 60 * 1000u)
Ta stała określa maksymalny wiek wpisów, który wynosi 49 dni (ms).
Wpisy starsze niż maksymalny wiek będą zawierać tę wartość jako wiek.
OT_HISTORY_TRACKER_NO_NEXT_HOP
OT_HISTORY_TRACKER_NO_NEXT_HOP 63
Brak następnego przeskoku – dla: mNextHop
w: otHistoryTrackerRouterInfo
.
Zasoby
Tematy referencyjne interfejsu OpenThread API pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dołączyć do naszej dokumentacji, skorzystaj z sekcji Zasoby.