nl::Weave::Logging

Cet espace de noms inclut toutes les interfaces de Weave pour la prise en charge de la journalisation partagée.

Résumé

Les interfaces incluent des macros, des constantes et des fonctions pour une interface de journalisation indépendante de la plate-forme pour le SDK Weave.

Au moment de la compilation, les clients du SDK Weave peuvent choisir entre Android, les E/S standard C ou des implémentations de style de journalisation externes (définies par la plate-forme et l'intégrateur) qui seront appelées lorsque l'un des symboles de préprocesseur suivants est revendiqué:

Énumérations

@406 enum
LogCategory enum
Identifie la catégorie à laquelle appartient un message d'erreur spécifique.
LogModule enum
Identifie une section de code logique qui est une source de messages de journal.

Typedefs

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

Variables

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

distantes

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
Consignez, dans le mécanisme spécifié par la plate-forme, le message de journal spécifié, msg, pour le module spécifié, module, dans la catégorie fournie, category.
PrintMessagePrefix(uint8_t module)
void
SetLogFilter(uint8_t category)
NL_DLL_EXPORT void
SetLogFunct(LogMessageFunct logFunct)
NL_DLL_EXPORT void

Énumérations

@406

 @406

LogCategory

 LogCategory

Identifie la catégorie à laquelle appartient un message d'erreur spécifique.

LogModule

 LogModule

Identifie une section de code logique qui est une source de messages de journal.

Typedefs

LogMessageFunct

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

Variables

ModuleNames

const char ModuleNames[]

gLogFilter

uint8_t gLogFilter = kLogCategory_Max

gLogFunct

LogMessageFunct gLogFunct = DefaultLogMessage

distantes

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
)

Journal

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

Consignez, dans le mécanisme spécifié par la plate-forme, le message de journal spécifié, msg, pour le module spécifié, module, dans la catégorie fournie, category.

Détails
Paramètres
[in] module
Énumération LogModule indiquant la source du module du package Weave qui a généré le message de journal. Ce nom doit être traduit dans la fonction en nom de module pour être inclus dans le message de journal.
[in] category
Énumération LogCategory indiquant la catégorie du message de journal. La catégorie peut être filtrée ou exclue si WEAVE_LOG_FILTERING a été revendiqué.
[in] msg
Pointeur vers une chaîne C terminée par une valeur NULL avec des spécificateurs de format de type Bibliothèque standard C contenant le message de journal à formater et à consigner.
[in] ...
Liste d'arguments variables dont les éléments doivent correspondre aux spécificateurs de format dans msg.

PrintMessagePrefix

void PrintMessagePrefix(
  uint8_t module
)

SetLogFilter

NL_DLL_EXPORT void SetLogFilter(
  uint8_t category
)

SetLogFunct

NL_DLL_EXPORT void SetLogFunct(
  LogMessageFunct logFunct
)