nl::Weave::Logging

מרחב השמות הזה כולל את כל הממשקים ב-Weave לתמיכה משותפת ברישום ביומן.

סיכום

הממשקים כוללים פקודות מאקרו, קבועים ופונקציות עבור ממשק רישום ביומן שאינו תלוי-פלטפורמה עבור Weave SDK.

לקוחות Weave של ה-SDK יכולים לבחור הטמעות של סגנון רישום ביומן עם Android, C Standard I/O או סגנונות רישום חיצוניים (בהגדרת הפלטפורמה והמטמיע), שיופעלו אם תתקבל הצהרה על אחד מהסמלים הבאים של מעבדי מידע מראש:

ערכים של ספירה

@406 טיפוסים בני מנייה (enum)
LogCategory טיפוסים בני מנייה (enum)
מזהה את הקטגוריה שאליה שייכת הודעת שגיאה מסוימת.
LogModule טיפוסים בני מנייה (enum)
מזהה קטע לוגי בקוד שמשמש כמקור להודעות ביומן.

Typedefs

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, עבור המודול שצוין, Module, בקטגוריה 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

מזהה קטע לוגי בקוד שמשמש כמקור להודעות ביומן.

Typedefs

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, עבור המודול שצוין, Module, בקטגוריה category (קטגוריה) שצוינה.

פרטים
פרמטרים
[in] module
ספירת LogModule שמציינת את המקור של מודול חבילת Weave שיצר את הודעת היומן. צריך לתרגם את הערך הזה בתוך הפונקציה לשם מודול שייכלל בהודעת היומן.
[in] category
ספירת LogCategory שמציינת את הקטגוריה של הודעת היומן. יכול להיות שהקטגוריה תסונן פנימה או החוצה אם הוצהרה בעלות על WEAVE_LOG_FILTERING.
[in] msg
מצביע למחרוזת C עם סיום של NULL, עם מזהים בפורמט C Standard של ספרייה, שמכילים את הודעת היומן שיש לעצב ולרשום ביומן.
[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
)