nl::Weave::Logging

Dieser Namespace umfasst alle Schnittstellen in Weave zur Unterstützung des gemeinsamen Loggings.

Zusammenfassung

Die Schnittstellen umfassen Makros, Konstanten und Funktionen für eine plattformunabhängige Protokollierungsoberfläche für das Weave SDK.

Weave SDK-Clients können bei der Kompilierung unter Android, C Standard-E/A oder externen (von Plattform und Integrator definierten) Logging-Stilimplementierungen wählen, die aufgerufen werden, wenn eines der folgenden Präprozessorsymbole beansprucht wird:

Aufzählungen
@406 enum
LogCategory enum
Kennzeichnet eine Kategorie, zu der eine bestimmte Fehlermeldung gehört.
LogModule enum
Kennzeichnet einen logischen Codeabschnitt, der eine Quelle von Lognachrichten ist.

Typedefs
LogMessageFunct)(uint8_t module, uint8_t category, const char *msg, va_list ap) typedef.
void(*

Variablen
ModuleNames[]
const char
gLogFilter = kLogCategory_Max
uint8_t
gLogFunct = DefaultLogMessage
LogMessageFunct

Funktionen
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
Die angegebene Lognachricht msg für das angegebene Modul module in der angegebenen Kategorie category wird im plattformspezifischen Mechanismus protokolliert.
PrintMessagePrefix(uint8_t module)
void
SetLogFilter(uint8_t category)
NL_DLL_EXPORT void
SetLogFunct(LogMessageFunct logFunct)
NL_DLL_EXPORT void

Aufzählungen

@406

 @406

LogCategory

 LogCategory

Kennzeichnet eine Kategorie, zu der eine bestimmte Fehlermeldung gehört.

LogModule

 LogModule

Kennzeichnet einen logischen Codeabschnitt, der eine Quelle von Lognachrichten ist.

Typedefs

LogMessageFunct

void(* LogMessageFunct)(uint8_t module, uint8_t category, const char *msg, va_list ap)

Variablen

ModuleNames

const char ModuleNames[]

gLogFilter

uint8_t gLogFilter = kLogCategory_Max

gLogFunct

LogMessageFunct gLogFunct = DefaultLogMessage

Funktionen

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
)

Log

NL_DLL_EXPORT __WEAVE_LOGGING_LINK_ATTRIBUTE void Log(
  uint8_t module,
  uint8_t category,
  const char *msg,
  ...
)

Die angegebene Lognachricht msg für das angegebene Modul module in der angegebenen Kategorie category wird im plattformspezifischen Mechanismus protokolliert.

Details
Parameter
[in] module
Eine LogModule-Enumeration, die die Quelle des Weave-Paketmoduls angibt, das die Lognachricht generiert hat. Diese muss in der Funktion in einen Modulnamen umgewandelt werden, damit sie der Lognachricht hinzugefügt werden können.
[in] category
Eine LogCategory-Enumeration, die die Kategorie der Lognachricht angibt. Die Kategorie kann gefiltert werden, wenn WEAVE_LOG_FILTERING beansprucht wurde.
[in] msg
Ein Zeiger auf einen mit NULL beendeten C-String mit Formatspezifizierern im Stil der C-Standardbibliothek, die die zu formatierende und zu protokollierende Lognachricht enthalten.
[in] ...
Eine variadische Argumentliste, deren Elemente den Formatspezifizierern in msg entsprechen sollten.

PrintMessagePrefix

void PrintMessagePrefix(
  uint8_t module
)

SetLogFilter

NL_DLL_EXPORT void SetLogFilter(
  uint8_t category
)

SetLogFunct

NL_DLL_EXPORT void SetLogFunct(
  LogMessageFunct logFunct
)