nl::Weave::Logging

เนมสเปซนี้มีอินเทอร์เฟซทั้งหมดภายใน Weave สำหรับการรองรับการบันทึกที่แชร์

สรุป

อินเทอร์เฟซประกอบด้วยมาโคร ค่าคงที่ และฟังก์ชันสำหรับอินเทอร์เฟซการบันทึกที่ไม่ขึ้นอยู่กับแพลตฟอร์มสำหรับ Weave SDK

ระหว่างเวลาที่คอมไพล์ ไคลเอ็นต์ Weave SDK อาจเลือกการใช้งานรูปแบบการบันทึกสำหรับ Android, C Standard I/O หรือการใช้งานรูปแบบการบันทึกภายนอก (กำหนดโดยแพลตฟอร์มและผู้ผสานรวม) ซึ่งจะเรียกใช้เมื่อมีการยืนยันสัญลักษณ์ตัวประมวลผลล่วงหน้าต่อไปนี้

การแจกแจง

@406 enum
LogCategory enum
ระบุหมวดหมู่ของข้อความแสดงข้อผิดพลาดนั้นๆ
LogModule enum
ระบุส่วนเชิงตรรกะของโค้ดที่เป็นแหล่งที่มาของข้อความบันทึก

Typedef

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

 LogCategory

ระบุหมวดหมู่ของข้อความแสดงข้อผิดพลาดนั้นๆ

LogModule

 LogModule

ระบุส่วนเชิงตรรกะของโค้ดที่เป็นแหล่งที่มาของข้อความบันทึก

Typedef

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 ที่สิ้นสุดค่า NULL ที่มีตัวระบุรูปแบบไลบรารีมาตรฐาน 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
)