Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

ロギング - スレッド スタック

このモジュールでは、OpenThread ロギング関連の定義について説明します。

まとめ

関数

otDumpCritPlat(const char *aText, const void *aData, uint16_t aDataLength)
void void void void void void
この関数は、重要なログレベルでメモリダンプを生成します。
otDumpDebgPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
この関数は、デバッグログ レベルでメモリダンプを生成します。
otDumpInfoPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
この関数は、情報ログレベルでメモリダンプを生成します。
otDumpNotePlat(const char *aText, const void *aData, uint16_t aDataLength)
void
この関数は、メモのログレベルでメモリダンプを生成します。
otDumpWarnPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
この関数は、警告ログレベルでメモリダンプを生成します。
otLogCli(otLogLevel aLogLevel, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2
void
この関数は、指定されたログレベルでログメッセージを出力します。
otLogCritPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void
この関数は、重要なログレベルでログ メッセージを出力します。
otLogDebgPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void void
この関数は、デバッグログ レベルでログ メッセージを出力します。
otLogInfoPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void
この関数は、情報ログレベルでログメッセージを出力します。
otLogNotePlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void
この関数は、メモのログレベルでログ メッセージを出力します。
otLogWarnPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void
この関数は、警告ログレベルでログメッセージを出力します。
otLoggingGetLevel(void)
この関数は、現在のログレベルを返します。
otLoggingSetLevel(otLogLevel aLogLevel)
この関数は、ログレベルを設定します。

関数

otDumpCritPlat

void void void void void void otDumpCritPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

この関数は、重要なログレベルでメモリダンプを生成します。

OPENTHREAD_CONFIG_LOG_PLATFORM または OPENTHREAD_CONFIG_LOG_PKT_DUMP が設定されていない場合、または現在のログレベルが重要よりも低い場合、この関数はログメッセージを出力しません。

詳細
パラメータ
[in] aText
バイトの前に出力される文字列。
[in] aData
データバッファへのポインタ。
[in] aDataLength
aData のバイト数。

otDumpDebgPlat

void otDumpDebgPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

この関数は、デバッグログ レベルでメモリダンプを生成します。

OPENTHREAD_CONFIG_LOG_PLATFORM または OPENTHREAD_CONFIG_LOG_PKT_DUMP が設定されていない場合、または現在のログレベルがデバッグ未満の場合、この関数はログメッセージを出力しません。

詳細
パラメータ
[in] aText
バイトの前に出力される文字列。
[in] aData
データバッファへのポインタ。
[in] aDataLength
aData のバイト数。

otDumpInfoPlat

void otDumpInfoPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

この関数は、情報ログレベルでメモリダンプを生成します。

OPENTHREAD_CONFIG_LOG_PLATFORM または OPENTHREAD_CONFIG_LOG_PKT_DUMP が設定されていない場合、または現在のログレベルが情報の下にない場合、この関数はログメッセージを出力しません。

詳細
パラメータ
[in] aText
バイトの前に出力される文字列。
[in] aData
データバッファへのポインタ。
[in] aDataLength
aData のバイト数。

otDumpNotePlat

void otDumpNotePlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

この関数は、メモのログレベルでメモリダンプを生成します。

OPENTHREAD_CONFIG_LOG_PLATFORM または OPENTHREAD_CONFIG_LOG_PKT_DUMP が設定されていない場合、または現在のログレベルがそれよりも低い場合、この関数はログメッセージを出力しません。

詳細
パラメータ
[in] aText
バイトの前に出力される文字列。
[in] aData
データバッファへのポインタ。
[in] aDataLength
aData のバイト数。

otDumpWarnPlat

void otDumpWarnPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

この関数は、警告ログレベルでメモリダンプを生成します。

OPENTHREAD_CONFIG_LOG_PLATFORM または OPENTHREAD_CONFIG_LOG_PKT_DUMP が設定されていない場合、または現在のログレベルが警告より下の場合、この関数はログメッセージを出力しません。

詳細
パラメータ
[in] aText
バイトの前に出力される文字列。
[in] aData
データバッファへのポインタ。
[in] aDataLength
aData のバイト数。

otLogCli

void otLogCli(
  otLogLevel aLogLevel,
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2

この関数は、指定されたログレベルでログメッセージを出力します。

この関数は、CLI のみで使用するためのものです。OPENTHREAD_CONFIG_LOG_CLI が設定されていない場合、または現在のログレベルが指定したログレベルを下回っている場合、この関数はログメッセージを出力しません。

詳細
パラメータ
[in] aLogLevel
ログレベル。
[in] aFormat
形式設定文字列。
[in] ...
形式仕様の引数。

otLogCritPlat

void otLogCritPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

この関数は、重要なログレベルでログ メッセージを出力します。

この関数はプラットフォームで使用することを想定しています。OPENTHREAD_CONFIG_LOG_PLATFORM が設定されていない場合、または現在のログレベルが重要よりも低い場合、この関数はログメッセージを出力しません。

詳細
パラメータ
[in] aFormat
形式設定文字列。
[in] ...
形式仕様の引数。

otLogDebgPlat

void void void void void otLogDebgPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

この関数は、デバッグログ レベルでログ メッセージを出力します。

この関数はプラットフォームで使用することを想定しています。OPENTHREAD_CONFIG_LOG_PLATFORM が設定されていない場合、または現在のログレベルが debug 未満の場合、この関数はログメッセージを出力しません。

詳細
パラメータ
[in] aFormat
形式設定文字列。
[in] ...
形式仕様の引数。

otLogInfoPlat

void void void void otLogInfoPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

この関数は、情報ログレベルでログメッセージを出力します。

この関数はプラットフォームで使用することを想定しています。OPENTHREAD_CONFIG_LOG_PLATFORM が設定されていない場合、または現在のログレベルが情報未満の場合、この関数はログメッセージを出力しません。

詳細
パラメータ
[in] aFormat
形式設定文字列。
[in] ...
形式仕様の引数。

otLogNotePlat

void void void otLogNotePlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

この関数は、メモのログレベルでログ メッセージを出力します。

この関数はプラットフォームで使用することを想定しています。OPENTHREAD_CONFIG_LOG_PLATFORM が設定されていない場合、または現在のログレベルがメモ以下の場合、この関数はログメッセージを出力しません。

詳細
パラメータ
[in] aFormat
形式設定文字列。
[in] ...
形式仕様の引数。

otLogWarnPlat

void void otLogWarnPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

この関数は、警告ログレベルでログメッセージを出力します。

この関数はプラットフォームで使用することを想定しています。OPENTHREAD_CONFIG_LOG_PLATFORM が設定されていない場合、または現在のログレベルが警告を下回っている場合、この関数はログメッセージを出力しません。

詳細
パラメータ
[in] aFormat
形式設定文字列。
[in] ...
形式仕様の引数。

otLoggingGetLevel

otLogLevel otLoggingGetLevel(
  void
)

この関数は、現在のログレベルを返します。

動的ログレベル機能 OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE が有効になっている場合、この関数は、現在設定されている動的ログレベルを返します。それ以外の場合は、ビルド時に構成されたログレベルを返します。

詳細
戻り値
ログレベル。

otLoggingSetLevel

otError otLoggingSetLevel(
  otLogLevel aLogLevel
)

この関数は、ログレベルを設定します。

詳細
パラメータ
[in] aLogLevel
ログレベル。
戻り値
OT_ERROR_NONE
ログレベルを更新しました。
OT_ERROR_INVALID_ARGS
ログレベルの値が無効です。

リソース

OpenThread API リファレンスのトピックは、GitHub で入手可能なソースコードから始まります。詳細や Google のドキュメントへの貢献については、リソースをご覧ください。