ロギング - スレッド スタック
このモジュールには、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) | voidinfo ログレベルでメモリダンプを生成します。 | 
| 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デバッグログ レベルでログメッセージを出力します。 | 
| otLogGenerateNextHexDumpLine(otLogHexDumpInfo *aInfo) | 次の 16 進数ダンプ行を生成します。 | 
| otLogInfoPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1 | void void void voidinfo ログレベルでログメッセージを出力します。 | 
| otLogNotePlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1 | void void voidメモのログレベルでログメッセージを出力します。 | 
| otLogPlat(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3 | voidプラットフォーム モジュール名を使用して、指定したログレベルのログメッセージを出力します。 | 
| otLogPlatArgs(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, va_list aArgs) | void voidプラットフォーム モジュール名を使用して、指定したログレベルのログメッセージを出力します。 | 
| otLogWarnPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1 | void void警告ログレベルでログメッセージを出力します。 | 
| otLoggingGetLevel(void) | 現在のログレベルを返します。 | 
| otLoggingSetLevel(otLogLevel aLogLevel) | ログレベルを設定します。 | 
| 構造体 | |
|---|---|
| otLogHexDumpInfo | 16 進数ダンプ出力の生成に使用される情報を表します。 | 
関数
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 が設定されていない場合、または現在のログレベルが重大レベルを下回っている場合、この関数はログメッセージを出力しません。
| 詳細 | |||||||
|---|---|---|---|---|---|---|---|
| パラメータ | 
 | ||||||
otDumpDebgPlat
void otDumpDebgPlat( const char *aText, const void *aData, uint16_t aDataLength )
デバッグログ レベルでメモリダンプを生成します。
OPENTHREAD_CONFIG_LOG_PLATFORM または OPENTHREAD_CONFIG_LOG_PKT_DUMP が設定されていない場合、または現在のログレベルが debug より低い場合、この関数はログメッセージを出力しません。
| 詳細 | |||||||
|---|---|---|---|---|---|---|---|
| パラメータ | 
 | ||||||
otDumpInfoPlat
void otDumpInfoPlat( const char *aText, const void *aData, uint16_t aDataLength )
info ログレベルでメモリダンプを生成します。
OPENTHREAD_CONFIG_LOG_PLATFORM または OPENTHREAD_CONFIG_LOG_PKT_DUMP が設定されていない場合、または現在のログレベルが info を下回っている場合、この関数はログメッセージを出力しません。
| 詳細 | |||||||
|---|---|---|---|---|---|---|---|
| パラメータ | 
 | ||||||
otDumpNotePlat
void otDumpNotePlat( const char *aText, const void *aData, uint16_t aDataLength )
メモのログレベルでメモリダンプを生成します。
OPENTHREAD_CONFIG_LOG_PLATFORM または OPENTHREAD_CONFIG_LOG_PKT_DUMP が設定されていない場合、または現在のログレベルがそれを下回っている場合、この関数はログメッセージを出力しません。
| 詳細 | |||||||
|---|---|---|---|---|---|---|---|
| パラメータ | 
 | ||||||
otDumpWarnPlat
void otDumpWarnPlat( const char *aText, const void *aData, uint16_t aDataLength )
警告ログレベルでメモリダンプを生成します。
OPENTHREAD_CONFIG_LOG_PLATFORM または OPENTHREAD_CONFIG_LOG_PKT_DUMP が設定されていないか、現在のログレベルが警告を下回っている場合、この関数はログメッセージを出力しません。
| 詳細 | |||||||
|---|---|---|---|---|---|---|---|
| パラメータ | 
 | ||||||
otLogCli
void otLogCli( otLogLevel aLogLevel, const char *aFormat, ... ) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2
指定されたログレベルのログメッセージを出力します。
CLI 専用です。OPENTHREAD_CONFIG_LOG_CLI が設定されていない場合、または現在のログレベルが指定されたログレベルを下回っている場合、この関数はログメッセージを出力しません。
| 詳細 | |||||||
|---|---|---|---|---|---|---|---|
| パラメータ | 
 | ||||||
otLogCritPlat
void otLogCritPlat( const char *aFormat, ... ) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
重大ログレベルのログメッセージを出力します。
プラットフォームによる使用を対象としています。OPENTHREAD_CONFIG_LOG_PLATFORM が設定されていない場合、または現在のログレベルが重大未満の場合、この関数はログメッセージを出力しません。
| 詳細 | |||||
|---|---|---|---|---|---|
| パラメータ | 
 | ||||
otLogDebgPlat
void void void void void otLogDebgPlat( const char *aFormat, ... ) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
デバッグログ レベルでログメッセージを出力します。
プラットフォームによる使用を対象としています。OPENTHREAD_CONFIG_LOG_PLATFORM が設定されていない場合、または現在のログレベルが debug 未満の場合、この関数はログメッセージを出力しません。
| 詳細 | |||||
|---|---|---|---|---|---|
| パラメータ | 
 | ||||
otLogGenerateNextHexDumpLine
otError otLogGenerateNextHexDumpLine( otLogHexDumpInfo *aInfo )
次の 16 進数ダンプ行を生成します。
このメソッドを連続して呼び出し、1 行ごとに 16 進数ダンプ出力を生成できます。最初の呼び出しでは、aInfo の mIterator フィールドを 0 に設定する必要があります。
生成された 16 進数ダンプの出力例を次に示します。
"==========================[{mTitle} len=070]============================" "| 41 D8 87 34 12 FF FF 25 | 4C 57 DA F2 FB 2F 62 7F | A..4...%LW.../b. |" "| 3B 01 F0 4D 4C 4D 4C 54 | 4F 00 15 15 00 00 00 00 | ;..MLTO....... |" "| 00 00 00 01 80 DB 60 82 | 7E 33 72 3B CC B3 A1 84 | ......`.~3r;.... |" "| 3B E6 AD B2 0B 45 E7 45 | C5 B9 00 1A CB 2D 6D 1C | ;....E.E.....-m. |" "| 10 3E 3C F5 D3 70 | | .><..p |" "------------------------------------------------------------------------"
| 詳細 | |||||
|---|---|---|---|---|---|
| パラメータ | 
 | ||||
| 戻り値 | 
 | ||||
otLogInfoPlat
void void void void otLogInfoPlat( const char *aFormat, ... ) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
info ログレベルでログメッセージを出力します。
プラットフォームによる使用を対象としています。OPENTHREAD_CONFIG_LOG_PLATFORM が設定されていない場合、または現在のログレベルが info 未満の場合、この関数はログメッセージを出力しません。
| 詳細 | |||||
|---|---|---|---|---|---|
| パラメータ | 
 | ||||
otLogNotePlat
void void void otLogNotePlat( const char *aFormat, ... ) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
メモのログレベルでログメッセージを出力します。
プラットフォームによる使用を対象としています。OPENTHREAD_CONFIG_LOG_PLATFORM が設定されていない場合、または現在のログレベルがメモより下の場合、この関数はログメッセージを出力しません。
| 詳細 | |||||
|---|---|---|---|---|---|
| パラメータ | 
 | ||||
otLogPlat
void otLogPlat( otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, ... ) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3
プラットフォーム モジュール名を使用して、指定したログレベルのログメッセージを出力します。
これは、プラットフォームによる使用が意図されています。OPENTHREAD_CONFIG_LOG_PLATFORM が設定されていない場合、または現在のログレベルが aLogLevel 未満の場合、この関数はログメッセージを出力しません。
aPlatModuleName 名は、P-{PlatModuleName}--- 形式に従って、出力されたログメッセージのログ モジュール名を決定するために使用されます。つまり、プラットフォーム サブモジュールであることを示す接頭辞文字列「P-」が追加され、その後に PlatModuleName 文字列の次の 12 文字が続きます。リージョン名が 14 文字になるように、末尾にハイフン - がパディングされています。
| 詳細 | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| パラメータ | 
 | ||||||||
otLogPlatArgs
void void otLogPlatArgs( otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, va_list aArgs )
プラットフォーム モジュール名を使用して、指定したログレベルのログメッセージを出力します。
これは、プラットフォームによる使用が意図されています。OPENTHREAD_CONFIG_LOG_PLATFORM が設定されていない場合、または現在のログレベルが aLogLevel 未満の場合、この関数はログメッセージを出力しません。
aPlatModuleName 名は、P-{PlatModuleName}--- 形式に従って、出力されたログメッセージのログ モジュール名を決定するために使用されます。つまり、プラットフォーム サブモジュールであることを示す接頭辞文字列「P-」が追加され、その後に PlatModuleName 文字列の次の 12 文字が続きます。リージョン名が 14 文字になるように、末尾にハイフン - がパディングされています。
| 詳細 | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| パラメータ | 
 | ||||||||
otLogWarnPlat
void void otLogWarnPlat( const char *aFormat, ... ) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
警告ログレベルでログメッセージを出力します。
プラットフォームによる使用を対象としています。OPENTHREAD_CONFIG_LOG_PLATFORM が設定されていない場合、または現在のログレベルが警告を下回っている場合、この関数はログメッセージを出力しません。
| 詳細 | |||||
|---|---|---|---|---|---|
| パラメータ | 
 | ||||
otLoggingGetLevel
otLogLevel otLoggingGetLevel( void )
現在のログレベルを返します。
動的ログレベルの機能 OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE が有効になっている場合、この関数は現在設定されている動的ログレベルを返します。それ以外の場合、この関数はビルド時に構成されたログレベルを返します。
| 詳細 | |
|---|---|
| 戻り値 | ログレベル。 | 
otLoggingSetLevel
otError otLoggingSetLevel( otLogLevel aLogLevel )
ログレベルを設定します。
| 詳細 | |||||
|---|---|---|---|---|---|
| パラメータ | 
 | ||||
| 戻り値 | 
 | ||||
マクロ
OT_LOG_HEX_DUMP_LINE_SIZE
OT_LOG_HEX_DUMP_LINE_SIZE 73
ダンプ行文字列のサイズ(16 進数)。
関連情報
OpenThread API リファレンスのトピックは、GitHub で入手できるソースコードに由来しています。 詳細について、またはドキュメントへの投稿については、リソースをご覧ください。