本頁面由 Cloud Translation API 翻譯而成。

記錄 - 執行緒堆疊

這個模組包含 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` 在偵錯記錄層級發出記錄訊息。
`otLogGenerateNextHexDumpLine(otLogHexDumpInfo *aInfo)`	`otError` 產生下一個十六進位傾印行。
`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` 於註記記錄層級發出記錄訊息。
`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)`	`otLogLevel` 傳回目前的記錄層級。
`otLoggingSetLevel(otLogLevel aLogLevel)`	`otError` 設定記錄層級。

結構
otLogHexDumpInfo	代表用於產生十六進位傾印輸出內容的資訊。

函式

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，或目前的記錄層級低於偵錯，這個函式不會發出任何記錄訊息。

詳細說明

參數

`[in] aFormat`	格式字串。
`[in] ...`	格式規格的引數。

otLogGenerateNextHexDumpLine

otError otLogGenerateNextHexDumpLine(
  otLogHexDumpInfo *aInfo
)

產生下一個十六進位傾印行。

可以連續呼叫這個方法，以逐行產生十六進位轉儲輸出。第一次呼叫 aInfo 中的 mIterator 欄位時，必須設為零。

以下是產生的十六進位傾印輸出內容範例：

"==========================[{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 4C 4D 4C 54 | 4F 00 15 15 00 00 00 00 | ;..MLMLTO....|" "| 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..-m.|" "| 10 3E 3C F5 D3 70 | | .><..p |" "-----------------------------------------------------------------------"

詳細說明

參數

[in,out] aInfo

用於產生十六進位傾印的 otLogHexDumpInfo 指標。

傳回值

`OT_ERROR_NONE`	已成功產生下一行，並更新「`aInfo`」中的 `mLine` 欄位。
`OT_ERROR_NOT_FOUND`	已到達終點，沒有更多行可以生成。

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] ...`	格式規格的引數。

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 個字元。

詳細說明

參數

`[in] aLogLevel`	記錄層級。
`[in] aPlatModuleName`	平台子模組名稱。
`[in] aFormat`	格式字串。
`[in] ...`	格式規格的引數。

otLogPlatArgs

void void otLogPlatArgs(
  otLogLevel aLogLevel,
  const char *aPlatModuleName,
  const char *aFormat,
  va_list aArgs
)

使用平台模組名稱，在指定記錄層級發出記錄訊息。

這是供平台使用。如未設定 OPENTHREAD_CONFIG_LOG_PLATFORM 或目前的記錄層級低於 aLogLevel，這個函式不會發出任何記錄訊息。

詳細說明

參數

`[in] aLogLevel`	記錄層級。
`[in] aPlatModuleName`	平台子模組名稱。
`[in] aFormat`	格式字串。
`[in] aArgs`	格式規格的引數。

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
)

設定記錄層級。

注意：這個函式需要 OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE=1。

詳細說明

參數

[in] aLogLevel

記錄層級。

傳回值

`OT_ERROR_NONE`	已成功更新記錄層級。
`OT_ERROR_INVALID_ARGS`	記錄檔層級值無效。

巨集

OT_LOG_HEX_DUMP_LINE_SIZE

 OT_LOG_HEX_DUMP_LINE_SIZE 73

十六進位轉儲行字串大小。

資源

OpenThread API 參考資料主題源自原始碼，請前往 GitHub 取得。如要瞭解詳情或對說明文件做出貢獻，請參閱資源。

記錄 - 執行緒堆疊

摘要

函式

結構

函式

otDumpCritPlat

otDumpDebgPlat

otDumpInfoPlat

otDumpNotePlat

otDumpWarnPlat

otLogCli

otLogCritPlat

otLogDebgPlat

otLogGenerateNextHexDumpLine

otLogInfoPlat

otLogNotePlat

otLogPlat

otLogPlatArgs

otLogWarnPlat

otLoggingGetLevel

otLoggingSetLevel

巨集

OT_LOG_HEX_DUMP_LINE_SIZE

資源