nl::Weave::Logging

この名前空間には、共有ロギングをサポートする Weave 内のすべてのインターフェースが含まれます。

概要

インターフェースには、プラットフォームに依存しない Weave SDK のロギングインターフェースのマクロ、定数、関数が含まれています。

Weave SDK クライアントは、コンパイル時に、Android、C 標準 I/O、または以下のプリプロセッサシンボルのいずれかがアサートされたときに呼び出される外部（プラットフォーム / インテグレータ定義）のロギングスタイルの実装を選択できます。

列挙型
`@406`	enum
`LogCategory`	enum 特定のエラーメッセージが属するカテゴリを示します。
`LogModule`	enum ログメッセージのソースとなるコードの論理セクションを識別します。

Typedef
`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` プラットフォーム指定のメカニズムに、指定されたカテゴリ category の指定されたモジュール module の指定されたログメッセージ msg をログに記録します。
`PrintMessagePrefix(uint8_t module)`	`void`
`SetLogFilter(uint8_t category)`	`NL_DLL_EXPORT void`
`SetLogFunct(LogMessageFunct logFunct)`	`NL_DLL_EXPORT void`

 @406

 LogCategory

特定のエラーメッセージが属するカテゴリを示します。

 LogModule

ログメッセージのソースとなるコードの論理セクションを識別します。

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

const char ModuleNames[]

uint8_t gLogFilter = kLogCategory_Max

LogMessageFunct gLogFunct = DefaultLogMessage

void GetCategoryName(
  char *buf,
  uint8_t bufSize,
  uint8_t category
)

NL_DLL_EXPORT uint8_t GetLogFilter()

void GetMessageWithPrefix(
  char *buf,
  uint8_t bufSize,
  uint8_t module,
  const char *msg
)

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

プラットフォーム指定のメカニズムに、指定されたカテゴリ category の指定されたモジュール module の指定されたログメッセージ msg をログに記録します。

詳細

パラメータ

`[in] module`	ログメッセージを生成した Weave パッケージモジュールのソースを示す LogModule 列挙型。ログメッセージに含めるには、関数内でモジュール名に変換する必要があります。
`[in] category`	ログメッセージのカテゴリを示す LogCategory 列挙型。WEAVE_LOG_FILTERING がアサートされた場合、カテゴリが除外または除外されることがあります。
`[in] msg`	フォーマットおよびログに記録されるログメッセージを含む C 標準ライブラリスタイルのフォーマット指定子を持つ、NULL で終わる C 文字列へのポインタ。
`[in] ...`	要素が msg 内の形式指定子に対応している必要がある可変引数リスト。

void PrintMessagePrefix(
  uint8_t module
)

NL_DLL_EXPORT void SetLogFilter(
  uint8_t category
)

NL_DLL_EXPORT void SetLogFunct(
  LogMessageFunct logFunct
)