nl::Weave::Logging

Namespace ini mencakup semua antarmuka dalam Weave untuk dukungan logging bersama.

Ringkasan

Antarmuka tersebut mencakup makro, konstanta, dan fungsi untuk antarmuka logging yang tidak bergantung platform untuk Weave SDK.

Klien Weave SDK dapat memilih, pada waktu kompilasi, antara Android, I/O Standar C, atau implementasi gaya logging eksternal (yang ditentukan platform dan integrator) yang akan dipanggil saat salah satu simbol preprosesor berikut dinyatakan:

Enumerasi

@406 enum
LogCategory enum
Mengidentifikasi kategori untuk pesan error tertentu.
LogModule enum
Mengidentifikasi bagian kode yang logis yang merupakan sumber pesan log.

Typedef

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

Variabel

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

Fungsi

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
Log, ke mekanisme yang ditentukan platform, pesan log yang ditentukan, msg, untuk modul yang ditentukan, module, dalam kategori yang disediakan, category.
PrintMessagePrefix(uint8_t module)
void
SetLogFilter(uint8_t category)
NL_DLL_EXPORT void
SetLogFunct(LogMessageFunct logFunct)
NL_DLL_EXPORT void

Enumerasi

@406

 @406

LogCategory

 LogCategory

Mengidentifikasi kategori untuk pesan error tertentu.

LogModule

 LogModule

Mengidentifikasi bagian kode yang logis yang merupakan sumber pesan log.

Typedef

LogMessageFunct

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

Variabel

ModuleNames

const char ModuleNames[]

gLogFilter

uint8_t gLogFilter = kLogCategory_Max

gLogFunct

LogMessageFunct gLogFunct = DefaultLogMessage

Fungsi

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

Log, ke mekanisme yang ditentukan platform, pesan log yang ditentukan, msg, untuk modul yang ditentukan, module, dalam kategori yang disediakan, category.

Detail
Parameter
[in] module
Enumerasi LogModule yang menunjukkan sumber modul paket Weave yang menghasilkan pesan log. Nama ini harus diterjemahkan dalam fungsi menjadi nama modul untuk disertakan dalam pesan log.
[in] category
Enumerasi LogCategory yang menunjukkan kategori pesan log. Kategori dapat difilter ke dalam atau ke luar jika WEAVE_LOG_FILTERING dinyatakan.
[in] msg
Pointer ke string C yang dihentikan NULL dengan penentu format bergaya Library Standar C yang berisi pesan log yang akan diformat dan dicatat.
[in] ...
Daftar argumen variadic yang elemennya harus sesuai dengan penentu format di msg.

PrintMessagePrefix

void PrintMessagePrefix(
  uint8_t module
)

SetLogFilter

NL_DLL_EXPORT void SetLogFilter(
  uint8_t category
)

SetLogFunct

NL_DLL_EXPORT void SetLogFunct(
  LogMessageFunct logFunct
)