การบันทึก - ชุดชุดข้อความ

โมดูลนี้มีคำจำกัดความที่เกี่ยวข้องกับการบันทึก 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)
สร้างสายข้อมูลฐานสิบหกชุดถัดไป
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)
แสดงผลระดับการบันทึกปัจจุบัน
otLoggingSetLevel(otLogLevel aLogLevel)
ตั้งค่าระดับการบันทึก

โครงสร้าง
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
)

สร้างสายข้อมูลฐานสิบหกชุดถัดไป

สามารถเรียกใช้เมธอดนี้แบบต่อเนื่องเพื่อสร้างบรรทัดเอาต์พุตของ Hex Dump ทีละบรรทัด ในการเรียกครั้งแรก ช่อง mIterator ใน aInfo ต้องตั้งเป็น 0

ต่อไปนี้คือตัวอย่างของเอาต์พุตแบบ Hex Dump ที่สร้างขึ้น

"==========================[{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.....-ม. |" "| 10 3E 3C F5 D3 70 | | | .><..p |" "-----------------------------------------------------------------------"

รายละเอียด
พารามิเตอร์
[in,out] aInfo
ตัวชี้ไปยัง otLogHexDumpInfo สำหรับใช้เพื่อสร้างไฟล์ฐานสิบหก
แสดงผลค่า
OT_ERROR_NONE
สร้างบรรทัดถัดไปเรียบร้อยแล้ว อัปเดตช่อง mLine ใน aInfo
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-" เพื่อระบุว่านี่คือโมดูลย่อยของแพลตฟอร์ม ตามด้วยอักขระ 12 ตัวถัดไปของสตริง PlatModuleName โดยมีขีดกลางเสริม - ต่อท้าย เพื่อให้ชื่อภูมิภาคมีความยาว 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 ฟังก์ชันนี้จะไม่ปล่อยข้อความบันทึกใดๆ

ระบบจะใช้ชื่อ aPlatModuleName เพื่อระบุชื่อโมดูลบันทึกในข้อความบันทึกที่ปล่อยออกมา โดยอยู่ในรูปแบบ P-{PlatModuleName}--- ซึ่งหมายความว่าจะมีการเพิ่มสตริงคำนำหน้า "P-" เพื่อระบุว่านี่คือโมดูลย่อยของแพลตฟอร์ม ตามด้วยอักขระ 12 ตัวถัดไปของสตริง PlatModuleName โดยมีขีดกลางเสริม - ต่อท้าย เพื่อให้ชื่อภูมิภาคมีความยาว 14 อักขระ

รายละเอียด
พารามิเตอร์
[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
)

ตั้งค่าระดับการบันทึก

รายละเอียด
พารามิเตอร์
[in] aLogLevel
ระดับการบันทึก
แสดงผลค่า
OT_ERROR_NONE
อัปเดตระดับการบันทึกสำเร็จแล้ว
OT_ERROR_INVALID_ARGS
ค่าระดับการบันทึกไม่ถูกต้อง

มาโคร

OT_LOG_HEX_DUMP_LINE_SIZE

 OT_LOG_HEX_DUMP_LINE_SIZE 73

ขนาดสตริงบรรทัด Hex Dump

แหล่งข้อมูล

หัวข้ออ้างอิง API ของ OpenThread จะมาจากซอร์สโค้ดซึ่งพร้อมใช้งานใน GitHub ดูข้อมูลเพิ่มเติมหรือมีส่วนร่วมในเอกสารประกอบของเราได้ที่แหล่งข้อมูล