nl :: Плетение :: логирование

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

Резюме

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

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

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

Typedefs
`LogMessageFunct )(uint8_t module, uint8_t category, const char *msg, va_list ap)`	typedef `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 , для указанного модуля, модуля в предоставленной категории, 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

 LogModule

Определяет логический раздел кода, являющийся источником сообщений журнала.

Typedefs

LogMessageFunct

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

Переменные

ModuleNames

const char ModuleNames[]

gLogFilter

uint8_t gLogFilter = kLogCategory_Max

gLogFunct

LogMessageFunct gLogFunct = DefaultLogMessage

Функции

GetCategoryName

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

GetLogFilter

NL_DLL_EXPORT uint8_t GetLogFilter()

GetMessageWithPrefix

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 , для указанного модуля, модуля в предоставленной категории, category .

Подробности

Параметры

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

PrintMessagePrefix

void PrintMessagePrefix(
  uint8_t module
)

SetLogFilter

NL_DLL_EXPORT void SetLogFilter(
  uint8_t category
)

SetLogFunct

NL_DLL_EXPORT void SetLogFunct(
  LogMessageFunct logFunct
)