нл:: Переплетение:: Ведение журнала

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

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

Интерфейсы включают макросы, константы и функции для независимого от платформы интерфейса ведения журналов для Weave SDK.

Клиенты Weave SDK могут выбирать во время компиляции между Android, стандартным вводом-выводом C или внешними (определяемыми платформой и интегратором) реализациями стиля журналирования, которые будут вызываться при утверждении любого из следующих символов препроцессора:

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

@406 перечисление
LogCategory перечисление
Определяет категорию, к которой принадлежит конкретное сообщение об ошибке.
LogModule перечисление
Идентифицирует логический раздел кода, который является источником сообщений журнала.

Определения типов

LogMessageFunct )(uint8_t module, uint8_t category, const char *msg, va_list ap) определение типа
void(*

Переменные

ModuleNames []
const char
gLogFilter = kLogCategory_Max
uint8_t
gLogFunct = DefaultLogMessage
LogMessageFunct

Функции

GetCategoryName (char *buf, uint8_t bufSize, uint8_t category)
void
GetLogFilter ()
NL_DLL_EXPORT uint8_t
GetMessageWithPrefix (char *buf, uint8_t bufSize, uint8_t module, const char *msg)
void
GetModuleName (char *buf, uint8_t module)
void
Log (uint8_t module, uint8_t category, const char *msg, ...)
NL_DLL_EXPORT __WEAVE_LOGGING_LINK_ATTRIBUTE void
Зарегистрируйте в механизме, указанном платформой, указанное сообщение журнала msg для указанного модуля, module , в предоставленной категории, category .
PrintMessagePrefix (uint8_t module)
void
SetLogFilter (uint8_t category)
NL_DLL_EXPORT void
SetLogFunct (LogMessageFunct logFunct)
NL_DLL_EXPORT void

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

@406

 @406

Категория журнала

 LogCategory

Определяет категорию, к которой принадлежит конкретное сообщение об ошибке.

ЛогМодуль

 LogModule

Идентифицирует логический раздел кода, который является источником сообщений журнала.

Определения типов

ЖурналСообщениеФункция

void(* LogMessageFunct)(uint8_t module, uint8_t category, const char *msg, va_list ap)

Переменные

Имена модулей

const char ModuleNames[]

глогфильтр

uint8_t gLogFilter = kLogCategory_Max

глогфункт

LogMessageFunct gLogFunct = DefaultLogMessage

Функции

GetCategoryName

void GetCategoryName(
  char *buf,
  uint8_t bufSize,
  uint8_t category
)

GetLogFilter

NL_DLL_EXPORT uint8_t GetLogFilter()

Получить сообщение с префиксом

void GetMessageWithPrefix(
  char *buf,
  uint8_t bufSize,
  uint8_t module,
  const char *msg
)

GetModuleName

void GetModuleName(
  char *buf,
  uint8_t module
)

Бревно

NL_DLL_EXPORT __WEAVE_LOGGING_LINK_ATTRIBUTE void Log(
  uint8_t module,
  uint8_t category,
  const char *msg,
  ...
)

Зарегистрируйте в механизме, указанном платформой, указанное сообщение журнала msg для указанного модуля, module , в предоставленной категории, category .

Подробности
Параметры
[in] module
Перечисление LogModule, указывающее источник модуля пакета Weave, сгенерировавшего сообщение журнала. Внутри функции это значение необходимо преобразовать в имя модуля для включения в сообщение журнала.
[in] category
Перечисление LogCategory, указывающее категорию сообщения журнала. Категория может быть отфильтрована или исключена, если был установлен WEAVE_LOG_FILTERING.
[in] msg
Указатель на строку C, завершающуюся NULL, со спецификаторами формата в стиле стандартной библиотеки C, содержащую сообщение журнала, которое необходимо отформатировать и записать в журнал.
[in] ...
Список аргументов с переменным числом аргументов, элементы которого должны соответствовать спецификаторам формата в msg .

Префикс сообщения печати

void PrintMessagePrefix(
  uint8_t module
)

SetLogFilter

NL_DLL_EXPORT void SetLogFilter(
  uint8_t category
)

SetLogFunct

NL_DLL_EXPORT void SetLogFunct(
  LogMessageFunct logFunct
)