nl::Weave::Logging

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ý dùng chung.

Tóm tắt

Các giao diện này có các macro, hằng số và hàm dành cho giao diện ghi nhật ký độc lập với nền tảng của Weave SDK.

Tại thời điểm biên dịch, các ứng dụng Weave SDK có thể chọn trong số các phương pháp triển khai kiểu ghi nhật ký (do nền tảng và nhà tích hợp) Android, C Standard I/O hoặc bên ngoài (do nền tảng và nhà tích hợp xác định) sẽ được gọi khi xác nhận bất kỳ biểu tượng tiền xử lý nào sau đây:

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

Typedef
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

Hàm
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
Ghi nhật ký cho cơ chế được nền tảng chỉ định, thông điệp nhật ký được chỉ định, msg, cho mô-đun được chỉ định, mô-đun, trong danh mục được cung cấp, danh mục.
PrintMessagePrefix(uint8_t module)
void
SetLogFilter(uint8_t category)
NL_DLL_EXPORT void
SetLogFunct(LogMessageFunct logFunct)
NL_DLL_EXPORT void

Bảng liệt kê

@406

 @406

LogCategory

 LogCategory

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

LogModule

 LogModule

Xác định một phần logic của mã là nguồn của thông điệp nhật ký.

Typedef

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

Hàm

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,
  ...
)

Ghi nhật ký cho cơ chế được nền tảng chỉ định, thông điệp nhật ký được chỉ định, msg, cho mô-đun được chỉ định, mô-đun, trong danh mục được cung cấp, danh mục.

Thông tin chi tiết
Các tham số
[in] module
Bảng liệt kê LogModule cho biết nguồn của mô-đun gói Weave đã tạo thông điệp nhật ký. Tên này phải được dịch trong hàm thành tên mô-đun để đưa vào thông điệp nhật ký.
[in] category
Bảng liệt kê LogCategory cho biết danh mục thông điệp nhật ký. Danh mục có thể được lọc vào hoặc bị loại ra nếu WEAVE_LOG_FILTERING được xác nhận.
[in] msg
Con trỏ đến một chuỗi C kết thúc bằng giá trị NULL với thông số định dạng kiểu Thư viện chuẩn C có chứa thông điệp nhật ký cần được định dạng và ghi nhật ký.
[in] ...
Danh sách đối số biến đổi có các phần tử phải tương ứng với thông số đị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
)