nl::Weave::Logging

Questo spazio dei nomi include tutte le interfacce di Weave per il supporto del logging condiviso.

Riepilogo

Le interfacce includono macro, costanti e funzioni per un'interfaccia di logging indipendente dalla piattaforma per l'SDK Weave.

I client SDK Weave possono scegliere, al momento della compilazione, tra Android, I/O standard C o implementazioni di stile di logging esterne (definite dalla piattaforma e dall'integratore) che verranno richiamate quando viene dichiarato uno dei seguenti simboli di preprocessore:

Enumerazioni
@406 enum
LogCategory enum
Identifica una categoria a cui appartiene un determinato messaggio di errore.
LogModule enum
Identifica una sezione logica del codice che funge da fonte di messaggi di log.

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

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

Funzioni
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
Registra, nel meccanismo specificato dalla piattaforma, il messaggio di log specificato, msg, per il modulo specificato, module, nella categoria specificata, category.
PrintMessagePrefix(uint8_t module)
void
SetLogFilter(uint8_t category)
NL_DLL_EXPORT void
SetLogFunct(LogMessageFunct logFunct)
NL_DLL_EXPORT void

Enumerazioni

@406

 @406

LogCategory

 LogCategory

Identifica una categoria a cui appartiene un determinato messaggio di errore.

LogModule

 LogModule

Identifica una sezione logica del codice che funge da fonte di messaggi di log.

Typedef

LogMessageFunct

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

Variabili

ModuleNames

const char ModuleNames[]

gLogFilter

uint8_t gLogFilter = kLogCategory_Max

gLogFunct

LogMessageFunct gLogFunct = DefaultLogMessage

Funzioni

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,
  ...
)

Registra, nel meccanismo specificato dalla piattaforma, il messaggio di log specificato, msg, per il modulo specificato, module, nella categoria specificata, category.

Dettagli
Parametri
[in] module
Un'enumerazione LogModule che indica l'origine del modulo del pacchetto Weave che ha generato il messaggio di log. Questo deve essere tradotto all'interno della funzione in un nome di modulo per l'inclusione nel messaggio di log.
[in] category
Un'enumerazione LogCategory che indica la categoria del messaggio di log. La categoria può essere filtrata o meno se WEAVE_LOG_FILTERING è stato dichiarato.
[in] msg
Un puntatore a una stringa C con terminazione NULL con indicatori di formato di tipo libreria standard C contenenti il messaggio di log da formattare e registrare.
[in] ...
Un elenco di argomenti variadi i cui elementi devono corrispondere agli indicatori di formato 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
)