Эта страница переведена с помощью Cloud Translation API.

Ведение журнала — стек потоков

Этот модуль включает определения, связанные с ведением журнала OpenThread.

Краткое содержание

Функции
`otDumpCritPlat (const char aText, const void aData, uint16_t aDataLength)`	`void void void void void void` Создает дамп памяти на критическом уровне журнала.
`otDumpDebgPlat (const char aText, const void aData, uint16_t aDataLength)`	`void` Создает дамп памяти на уровне журнала отладки.
`otDumpInfoPlat (const char aText, const void aData, uint16_t aDataLength)`	`void` Создает дамп памяти на уровне информационного журнала.
`otDumpNotePlat (const char aText, const void aData, uint16_t aDataLength)`	`void` Создает дамп памяти на уровне журнала заметок.
`otDumpWarnPlat (const char aText, const void aData, uint16_t aDataLength)`	`void` Создает дамп памяти на уровне журнала предупреждений.
`otLogCli ( otLogLevel aLogLevel, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2`	`void` Выдает сообщение журнала на заданном уровне журнала.
`otLogCritPlat (const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1`	`void` Выдает сообщение журнала на критическом уровне журнала.
`otLogDebgPlat (const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1`	`void void void void void` Выдает сообщение журнала на уровне журнала отладки.
`otLogGenerateNextHexDumpLine ( otLogHexDumpInfo *aInfo)`	`otError` Генерирует следующую строку шестнадцатеричного дампа.
`otLogInfoPlat (const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1`	`void void void void` Выдает сообщение журнала на уровне информационного журнала.
`otLogNotePlat (const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1`	`void void void` Выдает сообщение журнала на уровне журнала заметок.
`otLogPlat ( otLogLevel aLogLevel, const char aPlatModuleName, const char aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3`	`void` Выдает сообщение журнала на заданном уровне журнала, используя имя модуля платформы.
`otLogPlatArgs ( otLogLevel aLogLevel, const char aPlatModuleName, const char aFormat, va_list aArgs)`	`void void` Выдает сообщение журнала на заданном уровне журнала, используя имя модуля платформы.
`otLogWarnPlat (const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1`	`void void` Выдает сообщение журнала на уровне журнала предупреждений.
`otLoggingGetLevel (void)`	`otLogLevel` Возвращает текущий уровень журнала.
`otLoggingSetLevel ( otLogLevel aLogLevel)`	`otError` Устанавливает уровень журнала.

Структуры
отлогхексдаммпинфо	Представляет информацию, используемую для создания выходных данных шестнадцатеричного дампа.

Функции

отДампКритПлат

void void void void void void otDumpCritPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

Создает дамп памяти на критическом уровне журнала.

Если OPENTHREAD_CONFIG_LOG_PLATFORM или OPENTHREAD_CONFIG_LOG_PKT_DUMP не установлены или текущий уровень журнала ниже критического, эта функция не выдает никаких сообщений журнала.

Подробности

Параметры

`[in] aText`	Строка, которая печатается перед байтами.
`[in] aData`	Указатель на буфер данных.
`[in] aDataLength`	Количество байтов в `aData` .

отДампДебгПлат

void otDumpDebgPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

Создает дамп памяти на уровне журнала отладки.

Если OPENTHREAD_CONFIG_LOG_PLATFORM или OPENTHREAD_CONFIG_LOG_PKT_DUMP не установлены или текущий уровень журнала ниже уровня отладки, эта функция не выдает никаких сообщений журнала.

Подробности

Параметры

`[in] aText`	Строка, которая печатается перед байтами.
`[in] aData`	Указатель на буфер данных.
`[in] aDataLength`	Количество байтов в `aData` .

отДампИнфоПлат

void otDumpInfoPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

Создает дамп памяти на уровне информационного журнала.

Если OPENTHREAD_CONFIG_LOG_PLATFORM или OPENTHREAD_CONFIG_LOG_PKT_DUMP не установлены или текущий уровень журнала ниже информации, эта функция не выдает никаких сообщений журнала.

Подробности

Параметры

`[in] aText`	Строка, которая печатается перед байтами.
`[in] aData`	Указатель на буфер данных.
`[in] aDataLength`	Количество байтов в `aData` .

otDumpNotePlat

void otDumpNotePlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

Создает дамп памяти на уровне журнала заметок.

Если OPENTHREAD_CONFIG_LOG_PLATFORM или OPENTHREAD_CONFIG_LOG_PKT_DUMP не установлены или текущий уровень журнала ниже, обратите внимание, что эта функция не выдает никаких сообщений журнала.

Подробности

Параметры

`[in] aText`	Строка, которая печатается перед байтами.
`[in] aData`	Указатель на буфер данных.
`[in] aDataLength`	Количество байтов в `aData` .

otDumpWarnPlat

void otDumpWarnPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

Создает дамп памяти на уровне журнала предупреждений.

Если OPENTHREAD_CONFIG_LOG_PLATFORM или OPENTHREAD_CONFIG_LOG_PKT_DUMP не установлены или текущий уровень журнала ниже предупреждения, эта функция не выдает никаких сообщений журнала.

Подробности

Параметры

`[in] aText`	Строка, которая печатается перед байтами.
`[in] aData`	Указатель на буфер данных.
`[in] aDataLength`	Количество байтов в `aData` .

отлогкли

void otLogCli(
  otLogLevel aLogLevel,
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2

Выдает сообщение журнала на заданном уровне журнала.

Предназначен только для использования через CLI. Если OPENTHREAD_CONFIG_LOG_CLI не установлен или текущий уровень журнала ниже заданного уровня журнала, эта функция не выдает никаких сообщений журнала.

Подробности

Параметры

`[in] aLogLevel`	Уровень журнала.
`[in] aFormat`	Строка формата.
`[in] ...`	Аргументы спецификации формата.

отлогкритплат

void otLogCritPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

Выдает сообщение журнала на критическом уровне журнала.

Предназначен для использования платформой. Если OPENTHREAD_CONFIG_LOG_PLATFORM не установлен или текущий уровень журнала ниже критического, эта функция не выдает никаких сообщений журнала.

Подробности

Параметры

`[in] aFormat`	Строка формата.
`[in] ...`	Аргументы спецификации формата.

отлогдебгплат

void void void void void otLogDebgPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

Выдает сообщение журнала на уровне журнала отладки.

Предназначен для использования платформой. Если OPENTHREAD_CONFIG_LOG_PLATFORM не установлен или текущий уровень журнала ниже уровня отладки, эта функция не выдает никаких сообщений журнала.

Подробности

Параметры

`[in] aFormat`	Строка формата.
`[in] ...`	Аргументы спецификации формата.

отлогженератенекстхексдаммплине

otError otLogGenerateNextHexDumpLine(
  otLogHexDumpInfo *aInfo
)

Генерирует следующую строку шестнадцатеричного дампа.

Можно вызывать этот метод последовательно, чтобы построчно генерировать выходные данные шестнадцатеричного дампа. При первом вызове поле mIterator в aInfo ДОЛЖНО быть установлено в ноль.

Вот пример сгенерированного вывода шестнадцатеричного дампа:

"=========================[{mTitle} len=070]=============== =============" "| 41 D8 87 34 12 FF FF 25 | 4C 57 DA F2 FB 2F 62 7F | A..4...%LW.../b. | " "| 3B 01 F0 4D 4C 4D 4C 54 | 4F 00 15 15 00 00 00 00 | ;..MLMLTO....... |" "| 00 00 00 01 80 DB 60 82 | 7E 33 72 3B CC B3 A1 84 | ......`.~3r;.... |" "| 3B E6 AD B2 0B 45 E7 45 | C5 B9 00 1A CB 2D 6D 1C | ;....ЕЕ....-м. |" "| 10 3E 3C F5 D3 70 | | .><..p |" "-------------------------------------------------- -----------------------"

Подробности

Параметры

[in,out] aInfo

Указатель на otLogHexDumpInfo , используемый для создания шестнадцатеричного дампа.

Возвращаемые значения

`OT_ERROR_NONE`	Следующая строка успешно сгенерирована, поле `mLine` в `aInfo` обновляется.
`OT_ERROR_NOT_FOUND`	Дошел до конца и больше нет строки для генерации.

отЛогИнфоПлат

void void void void otLogInfoPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

Выдает сообщение журнала на уровне информационного журнала.

Предназначен для использования платформой. Если OPENTHREAD_CONFIG_LOG_PLATFORM не установлен или текущий уровень журнала ниже информации, эта функция не выдает никаких сообщений журнала.

Подробности

Параметры

`[in] aFormat`	Строка формата.
`[in] ...`	Аргументы спецификации формата.

otLogNotePlat

void void void otLogNotePlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

Выдает сообщение журнала на уровне журнала заметок.

Предназначен для использования платформой. Если OPENTHREAD_CONFIG_LOG_PLATFORM не установлен или текущий уровень журнала ниже примечания, эта функция не выдает никаких сообщений журнала.

Подробности

Параметры

`[in] aFormat`	Строка формата.
`[in] ...`	Аргументы спецификации формата.

отЛогПлат

void otLogPlat(
  otLogLevel aLogLevel,
  const char *aPlatModuleName,
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3

Выдает сообщение журнала на заданном уровне журнала, используя имя модуля платформы.

Это предназначено для использования платформой. Если OPENTHREAD_CONFIG_LOG_PLATFORM не установлен или текущий уровень журнала ниже aLogLevel , эта функция не выдает никаких сообщений журнала.

Имя aPlatModuleName используется для определения имени модуля журнала в выдаваемом сообщении журнала в формате P-{PlatModuleName}--- . Это означает, что добавляется префиксная строка «P-», указывающая, что это субмодуль платформы, за которым следуют следующие 12 символов строки PlatModuleName с дополненными дефисами - конце, чтобы гарантировать, что имя региона состоит из 14 символов. длинный.

Подробности

Параметры

`[in] aLogLevel`	Уровень журнала.
`[in] aPlatModuleName`	Имя подмодуля платформы.
`[in] aFormat`	Строка формата.
`[in] ...`	Аргументы спецификации формата.

отлогплатаргс

void void otLogPlatArgs(
  otLogLevel aLogLevel,
  const char *aPlatModuleName,
  const char *aFormat,
  va_list aArgs
)

Выдает сообщение журнала на заданном уровне журнала, используя имя модуля платформы.

Подробности

Параметры

`[in] aLogLevel`	Уровень журнала.
`[in] aPlatModuleName`	Имя подмодуля платформы.
`[in] aFormat`	Строка формата.
`[in] aArgs`	Аргументы спецификации формата.

отлогварнплат

void void otLogWarnPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

Выдает сообщение журнала на уровне журнала предупреждений.

Предназначен для использования платформой. Если OPENTHREAD_CONFIG_LOG_PLATFORM не установлен или текущий уровень журнала ниже предупреждения, эта функция не выдает никаких сообщений журнала.

Подробности

Параметры

`[in] aFormat`	Строка формата.
`[in] ...`	Аргументы спецификации формата.

отлоггингжетлевел

otLogLevel otLoggingGetLevel(
  void
)

Возвращает текущий уровень журнала.

Если функция динамического уровня журнала OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE включена, эта функция возвращает текущий установленный уровень динамического журнала. В противном случае эта функция возвращает уровень журнала, настроенный во время сборки.

Подробности
Возврат	Уровень журнала.

отлоггингсетлевел

otError otLoggingSetLevel(
  otLogLevel aLogLevel
)

Устанавливает уровень журнала.

Примечание. Для этой функции требуется OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE=1 .

Подробности

Параметры

[in] aLogLevel

Уровень журнала.

Возвращаемые значения

`OT_ERROR_NONE`	Уровень журнала успешно обновлен.
`OT_ERROR_INVALID_ARGS`	Недопустимое значение уровня журнала.

Макросы

OT_LOG_HEX_DUMP_LINE_SIZE

 OT_LOG_HEX_DUMP_LINE_SIZE 73

Размер строки шестнадцатеричного дампа.

Ресурсы

Справочные разделы API OpenThread взяты из исходного кода, доступного на GitHub . Для получения дополнительной информации или внесения вклада в нашу документацию обратитесь к Ресурсам .

Ведение журнала — стек потоков

Краткое содержание

Функции

Структуры

Функции

отДампКритПлат

отДампДебгПлат

отДампИнфоПлат

otDumpNotePlat

otDumpWarnPlat

отлогкли

отлогкритплат

отлогдебгплат

отлогженератенекстхексдаммплине

отЛогИнфоПлат

otLogNotePlat

отЛогПлат

отлогплатаргс

отлогварнплат

отлоггингжетлевел

отлоггингсетлевел

Макросы

OT_LOG_HEX_DUMP_LINE_SIZE

Ресурсы