Logging - Stack Thread

Modul ini mencakup definisi terkait logging OpenThread.

Ringkasan

Fungsi
otDumpCritPlat(const char *aText, const void *aData, uint16_t aDataLength)
void void void void void void
Menghasilkan dump memori pada tingkat log penting.
otDumpDebgPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Menghasilkan dump memori pada level log debug.
otDumpInfoPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Menghasilkan dump memori pada tingkat log info.
otDumpNotePlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Menghasilkan dump memori pada tingkat log catatan.
otDumpWarnPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Menghasilkan dump memori pada tingkat log peringatan.
otLogCli(otLogLevel aLogLevel, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2
void
Memberikan pesan log pada level log tertentu.
otLogCritPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void
Memberikan pesan log pada level log kritis.
otLogDebgPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void void
Memberikan pesan log pada level log debug.
otLogGenerateNextHexDumpLine(otLogHexDumpInfo *aInfo)
Menghasilkan baris dump hex berikutnya.
otLogInfoPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void
Memancarkan pesan log di level log info.
otLogNotePlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void
Memberikan pesan log pada level log catatan.
otLogPlat(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3
void
Memberikan pesan log pada level log tertentu menggunakan nama modul platform.
otLogPlatArgs(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, va_list aArgs)
void void
Memberikan pesan log pada level log tertentu menggunakan nama modul platform.
otLogWarnPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void
Memancarkan pesan log di level log peringatan.
otLoggingGetLevel(void)
Menampilkan level log saat ini.
otLoggingSetLevel(otLogLevel aLogLevel)
Menetapkan level log.

Struct
otLogHexDumpInfo

Menampilkan informasi yang digunakan untuk menghasilkan output dump hex.

Fungsi

otDumpCritPlat

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

Menghasilkan dump memori pada tingkat log penting.

Jika OPENTHREAD_CONFIG_LOG_PLATFORM atau OPENTHREAD_CONFIG_LOG_PKT_DUMP tidak ditetapkan atau level log saat ini berada di bawah kritis, fungsi ini tidak akan mengeluarkan pesan log apa pun.

Detail
Parameter
[in] aText
String yang dicetak sebelum byte.
[in] aData
Pointer ke buffer data.
[in] aDataLength
Jumlah byte dalam aData.

otDumpDebgPlat

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

Menghasilkan dump memori pada level log debug.

Jika OPENTHREAD_CONFIG_LOG_PLATFORM atau OPENTHREAD_CONFIG_LOG_PKT_DUMP tidak ditetapkan atau level log saat ini berada di bawah debug, fungsi ini tidak akan memunculkan pesan log apa pun.

Detail
Parameter
[in] aText
String yang dicetak sebelum byte.
[in] aData
Pointer ke buffer data.
[in] aDataLength
Jumlah byte dalam aData.

otDumpInfoPlat

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

Menghasilkan dump memori pada tingkat log info.

Jika OPENTHREAD_CONFIG_LOG_PLATFORM atau OPENTHREAD_CONFIG_LOG_PKT_DUMP tidak ditetapkan atau level log saat ini berada di bawah info, fungsi ini tidak akan memunculkan pesan log apa pun.

Detail
Parameter
[in] aText
String yang dicetak sebelum byte.
[in] aData
Pointer ke buffer data.
[in] aDataLength
Jumlah byte dalam aData.

otDumpNotePlat

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

Menghasilkan dump memori pada tingkat log catatan.

Jika OPENTHREAD_CONFIG_LOG_PLATFORM atau OPENTHREAD_CONFIG_LOG_PKT_DUMP tidak ditetapkan atau level log saat ini berada di bawah, perhatikan bahwa fungsi ini tidak akan memunculkan pesan log apa pun.

Detail
Parameter
[in] aText
String yang dicetak sebelum byte.
[in] aData
Pointer ke buffer data.
[in] aDataLength
Jumlah byte dalam aData.

otDumpWarnPlat

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

Menghasilkan dump memori pada tingkat log peringatan.

Jika OPENTHREAD_CONFIG_LOG_PLATFORM atau OPENTHREAD_CONFIG_LOG_PKT_DUMP tidak ditetapkan atau level log saat ini di bawah peringatan, fungsi ini tidak akan memunculkan pesan log apa pun.

Detail
Parameter
[in] aText
String yang dicetak sebelum byte.
[in] aData
Pointer ke buffer data.
[in] aDataLength
Jumlah byte dalam aData.

otLogCli

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

Memberikan pesan log pada level log tertentu.

Dimaksudkan untuk digunakan hanya oleh CLI. Jika OPENTHREAD_CONFIG_LOG_CLI tidak ditetapkan atau level log saat ini berada di bawah level log tertentu, fungsi ini tidak akan memunculkan pesan log apa pun.

Detail
Parameter
[in] aLogLevel
Level log.
[in] aFormat
String format.
[in] ...
Argumen untuk spesifikasi format.

otLogCritPlat

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

Memberikan pesan log pada level log kritis.

Dimaksudkan untuk digunakan oleh platform. Jika OPENTHREAD_CONFIG_LOG_PLATFORM tidak ditetapkan atau level log saat ini berada di bawah kritis, fungsi ini tidak akan memunculkan pesan log apa pun.

Detail
Parameter
[in] aFormat
String format.
[in] ...
Argumen untuk spesifikasi format.

otLogDebgPlat

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

Memberikan pesan log pada level log debug.

Dimaksudkan untuk digunakan oleh platform. Jika OPENTHREAD_CONFIG_LOG_PLATFORM tidak ditetapkan atau level log saat ini berada di bawah debug, fungsi ini tidak akan memunculkan pesan log apa pun.

Detail
Parameter
[in] aFormat
String format.
[in] ...
Argumen untuk spesifikasi format.

otLogGenerateNextHexDumpLine

otError otLogGenerateNextHexDumpLine(
  otLogHexDumpInfo *aInfo
)

Menghasilkan baris dump hex berikutnya.

Dapat memanggil metode ini secara berturut-turut untuk menghasilkan output dump hex baris demi baris. Pada panggilan pertama, kolom mIterator di aInfo HARUS disetel ke nol.

Berikut adalah contoh output dump hex yang dihasilkan:

"==========================[{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 | ;..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 |" "------------------------------------------------------------------------"

Detail
Parameter
[in,out] aInfo
Pointer ke otLogHexDumpInfo yang akan digunakan untuk menghasilkan dump hex.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil membuat baris berikutnya, kolom mLine di aInfo diperbarui.
OT_ERROR_NOT_FOUND
Sudah mencapai akhir dan tidak ada lagi baris yang dibuat.

otLogInfoPlat

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

Memancarkan pesan log di level log info.

Dimaksudkan untuk digunakan oleh platform. Jika OPENTHREAD_CONFIG_LOG_PLATFORM tidak ditetapkan atau level log saat ini berada di bawah info, fungsi ini tidak akan memunculkan pesan log apa pun.

Detail
Parameter
[in] aFormat
String format.
[in] ...
Argumen untuk spesifikasi format.

otLogNotePlat

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

Memberikan pesan log pada level log catatan.

Dimaksudkan untuk digunakan oleh platform. Jika OPENTHREAD_CONFIG_LOG_PLATFORM tidak ditetapkan atau level log saat ini berada di bawah catatan, fungsi ini tidak akan memunculkan pesan log apa pun.

Detail
Parameter
[in] aFormat
String format.
[in] ...
Argumen untuk spesifikasi format.

otLogPlat

void otLogPlat(
  otLogLevel aLogLevel,
  const char *aPlatModuleName,
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3

Memberikan pesan log pada level log tertentu menggunakan nama modul platform.

Hal ini ditujukan untuk digunakan oleh platform. Jika OPENTHREAD_CONFIG_LOG_PLATFORM tidak ditetapkan atau level log saat ini di bawah aLogLevel , fungsi ini tidak akan memunculkan pesan log apa pun.

Nama aPlatModuleName digunakan untuk menentukan nama modul log dalam pesan log yang dihasilkan, dengan mengikuti format P-{PlatModuleName}---. Artinya, string awalan "P-" ditambahkan untuk menunjukkan bahwa ini adalah sub-modul platform, yang diikuti dengan 12 karakter berikutnya dari string PlatModuleName, dengan tanda hubung berbantalan - di bagian akhir untuk memastikan bahwa nama wilayah memiliki panjang 14 karakter.

Detail
Parameter
[in] aLogLevel
Level log.
[in] aPlatModuleName
Nama sub-modul platform.
[in] aFormat
String format.
[in] ...
Argumen untuk spesifikasi format.

otLogPlatArgs

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

Memberikan pesan log pada level log tertentu menggunakan nama modul platform.

Hal ini ditujukan untuk digunakan oleh platform. Jika OPENTHREAD_CONFIG_LOG_PLATFORM tidak ditetapkan atau level log saat ini di bawah aLogLevel , fungsi ini tidak akan memunculkan pesan log apa pun.

Nama aPlatModuleName digunakan untuk menentukan nama modul log dalam pesan log yang dihasilkan, dengan mengikuti format P-{PlatModuleName}---. Artinya, string awalan "P-" ditambahkan untuk menunjukkan bahwa ini adalah sub-modul platform, yang diikuti dengan 12 karakter berikutnya dari string PlatModuleName, dengan tanda hubung berbantalan - di bagian akhir untuk memastikan bahwa nama wilayah memiliki panjang 14 karakter.

Detail
Parameter
[in] aLogLevel
Level log.
[in] aPlatModuleName
Nama sub-modul platform.
[in] aFormat
String format.
[in] aArgs
Argumen untuk spesifikasi format.

otLogWarnPlat

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

Memancarkan pesan log di level log peringatan.

Dimaksudkan untuk digunakan oleh platform. Jika OPENTHREAD_CONFIG_LOG_PLATFORM tidak ditetapkan atau level log saat ini berada di bawah peringatan, fungsi ini tidak akan memunculkan pesan log apa pun.

Detail
Parameter
[in] aFormat
String format.
[in] ...
Argumen untuk spesifikasi format.

otLoggingGetLevel

otLogLevel otLoggingGetLevel(
  void
)

Menampilkan level log saat ini.

Jika fitur tingkat log dinamis OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE diaktifkan, fungsi ini akan menampilkan level log dinamis yang saat ini ditetapkan. Jika tidak, fungsi ini akan menampilkan level log yang dikonfigurasi waktu build.

Detail
Hasil
Level log.

otLoggingSetLevel

otError otLoggingSetLevel(
  otLogLevel aLogLevel
)

Menetapkan level log.

Detail
Parameter
[in] aLogLevel
Level log.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil memperbarui level log.
OT_ERROR_INVALID_ARGS
Nilai level log tidak valid.

Makro

OT_LOG_HEX_DUMP_LINE_SIZE

 OT_LOG_HEX_DUMP_LINE_SIZE 73

Ukuran string baris dump heksadesimal.

Referensi

Topik Referensi OpenThread API berasal dari kode sumber yang tersedia di GitHub. Untuk informasi selengkapnya, atau untuk berkontribusi pada dokumentasi kami, lihat Referensi.