nl::Weave::Logging

تتضمن مساحة الاسم هذه جميع الواجهات داخل Weave لدعم التسجيل المشترك.

ملخّص

تتضمن الواجهات وحدات ماكرو وثوابت ودوال لواجهة تسجيل مستقلة عن النظام الأساسي لحزمة Weave SDK.

يمكن لعملاء Weave SDK الاختيار في وقت التجميع من بين Android أو C Standard I/O أو عمليات تنفيذ أنماط التسجيل الخارجية (التي يحدِّدها النظام الأساسي وأداة الدمج) والتي سيتم استدعاؤها عند تأكيد أي من الرموز التالية للمعالجات المسبقة:

عمليات التعداد

@406 تعداد
LogCategory تعداد
تحدد فئة تنتمي إليها رسالة خطأ معينة.
LogModule تعداد
تحدد قسمًا منطقيًا من التعليمة البرمجية مصدر رسائل السجل.

تعريف الأنواع

LogMessageFunct)(uint8_t module, uint8_t category, const char *msg, va_list ap) تعريف الكتابة
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

تحدد قسمًا منطقيًا من التعليمة البرمجية مصدر رسائل السجل.

تعريف الأنواع

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
)