nl :: Dệt :: Ghi nhật ký

Không gian tên này bao gồm tất cả các giao diện trong Weave để hỗ trợ ghi nhật ký được chia sẻ.

Tóm lược

Các giao diện bao gồm macro, hằng số và chức năng cho giao diện ghi nhật ký độc lập với nền tảng cho Weave SDK.

Ứng dụng khách Weave SDK có thể chọn, tại thời điểm biên dịch, giữa Android, I / O tiêu chuẩn C hoặc triển khai kiểu ghi nhật ký bên ngoài (nền tảng và người tích hợp xác định) sẽ được gọi khi bất kỳ ký hiệu tiền xử lý nào sau đây được khẳng định:

Bảng kê
`@406`	enum
`LogCategory`	enum Xác định danh mục chứa thông báo lỗi cụ thể.
`LogModule`	enum Xác định một đoạn mã hợp lý là nguồn thông báo nhật ký.

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

Biến
`ModuleNames []`	`const char`
`gLogFilter = kLogCategory_Max`	`uint8_t`
`gLogFunct = DefaultLogMessage`	`LogMessageFunct`

Chức năng
`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` Đăng nhập, cơ chế nền tảng quy định, thông điệp log định, msg, cho module cụ thể, mô-đun, trong hạng mục cung cấp, chủng loại.
`PrintMessagePrefix (uint8_t module)`	`void`
`SetLogFilter (uint8_t category)`	`NL_DLL_EXPORT void`
`SetLogFunct (LogMessageFunct logFunct)`	`NL_DLL_EXPORT void`

Bảng kê

@ 406

 @406

LogCategory

 LogCategory

Xác định danh mục chứa thông báo lỗi cụ thể.

LogModule

 LogModule

Xác định một đoạn mã hợp lý là nguồn thông báo nhật ký.

Typedefs

LogMessageFunct

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

Biến

ModuleNames

const char ModuleNames[]

gLogFilter

uint8_t gLogFilter = kLogCategory_Max

gLogFunct

LogMessageFunct gLogFunct = DefaultLogMessage

Chức năng

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
)

Nhật ký

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

Đăng nhập, cơ chế nền tảng quy định, thông điệp log định, msg, cho module cụ thể, mô-đun, trong hạng mục cung cấp, chủng loại.

Chi tiết

Thông số

`[in] module`	Một liệt kê LogModule chỉ ra nguồn của mô-đun gói Weave đã tạo ra thông báo nhật ký. Điều này phải được dịch trong hàm thành tên mô-đun để đưa vào thông báo nhật ký.
`[in] category`	Một liệt kê LogCategory cho biết danh mục của thông báo nhật ký. Danh mục có thể được lọc trong hoặc ngoài nếu WEAVE_LOG_FILTERING được khẳng định.
`[in] msg`	Một con trỏ đến một chuỗi C được kết thúc bằng NULL với các chỉ định định dạng kiểu Thư viện Chuẩn C chứa thông báo nhật ký được định dạng và ghi nhật ký.
`[in] ...`	Danh sách đối số đa dạng có các phần tử phải tương ứng với các chỉ định định dạng trong msg .

PrintMessagePrefix

void PrintMessagePrefix(
  uint8_t module
)

SetLogFilter

NL_DLL_EXPORT void SetLogFilter(
  uint8_t category
)

SetLogFunct

NL_DLL_EXPORT void SetLogFunct(
  LogMessageFunct logFunct
)