Исторический трекер

Резюме

Перечисления

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
}
перечислить
Это перечисление определяет события в информации о соседях (т.е.

Typedefs

otHistoryTrackerIterator typedef
Этот тип представляет собой итератор для перебора списка истории.
otHistoryTrackerMessageInfo typedef
Эта структура представляет информацию о сообщении RX / TX IPv6.
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 / TX IPv6.

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

Сосед восстанавливается (только для ребенка).

Typedefs

otHistoryTrackerIterator

struct otHistoryTrackerIterator otHistoryTrackerIterator

Этот тип представляет собой итератор для перебора списка истории.

Поля в этом типе непрозрачны (предназначены для использования ядром OpenThread) и поэтому не должны быть доступны / использоваться вызывающим.

Перед использованием итератора, он должен быть инициализирован с помощью otHistoryTrackerInitIterator() ,

otHistoryTrackerMessageInfo

struct otHistoryTrackerMessageInfo otHistoryTrackerMessageInfo

Эта структура представляет информацию о сообщении RX / TX IPv6.

Некоторые из полех этой структуры применимы к сообщению 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
)

Эта функция преобразует заданный возраст поступления в удобочитаемую строку.

Строка возраста поступления соответствует формату " : : . "часы, минуты, секунды и миллисекунды (если короче одного дня) или"

дней : : . "(если дольше одного дня).

Если полученная строка не помещается в aBuffer ( в пределах своей aSize символов), то строка будет усечена , но выводимая строка всегда оканчивается нуль.

Подробности
Параметры
[in] aEntryAge
Возраст входа (продолжительность в миллисекундах).
[out] aBuffer
Указатель на массив символов для вывода строки (НЕ ДОЛЖЕН быть 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)

Этот заголовок определяет общедоступный API для History Tracker.

Модуль History Tracker записывает историю различных событий (например, сообщения RX и TX или изменения сетевой информации и т. Д.) Во время работы сети Thread. Все отслеживаемые записи имеют отметку времени.

Функции этого модуля доступны , когда OPENTHREAD_CONFIG_HISTOR_TRACKER_ENABLE включена. Эта константа определяет максимальный возраст записей, который составляет 49 дней (в миллисекундах).

Для записей старше максимального возраста это значение будет указано как их возраст.