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) 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، للوحدة المحددة، msg، في الفئة المتوفرة، 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

تحدِّد مقطعًا منطقيًا من الرمز يكون مصدرًا لرسائل السجلّ.

تحديدات النوع

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، للوحدة المحددة، msg، في الفئة المتوفرة، msg.

التفاصيل
المَعلمات
[in] module
يشير تعداد وحدة السجل إلى مصدر وحدة حزمة 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
)