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 สำหรับโมดูลที่ระบุ โมดูล ในหมวดหมู่ที่มีให้ หมวดหมู่
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 สำหรับโมดูลที่ระบุ โมดูล ในหมวดหมู่ที่มีให้ หมวดหมู่

รายละเอียด
พารามิเตอร์
[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
)