Ghi nhật ký – Ngăn xếp luồng

Mô-đun này bao gồm các định nghĩa liên quan đến việc ghi nhật ký OpenThread.

Tóm tắt

Hàm
otDumpCritPlat(const char *aText, const void *aData, uint16_t aDataLength)
void void void void void void
Tạo tệp kết xuất bộ nhớ ở cấp độ nhật ký quan trọng.
otDumpDebgPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Tạo tệp kết xuất bộ nhớ ở cấp nhật ký gỡ lỗi.
otDumpInfoPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Tạo tệp kết xuất bộ nhớ ở cấp nhật ký thông tin.
otDumpNotePlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Tạo tệp kết xuất bộ nhớ ở cấp độ nhật ký ghi chú.
otDumpWarnPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Tạo tệp kết xuất bộ nhớ ở cấp nhật ký cảnh báo.
otLogCli(otLogLevel aLogLevel, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2
void
Phát ra thông điệp nhật ký ở cấp độ nhật ký nhất định.
otLogCritPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void
Phát ra thông điệp nhật ký ở cấp độ nhật ký quan trọng.
otLogDebgPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void void
Phát ra thông điệp nhật ký ở cấp độ nhật ký gỡ lỗi.
otLogGenerateNextHexDumpLine(otLogHexDumpInfo *aInfo)
Tạo dòng kết xuất hệ lục phân tiếp theo.
otLogInfoPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void
Phát ra thông điệp nhật ký ở cấp độ nhật ký thông tin.
otLogNotePlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void
Phát ra thông điệp nhật ký ở cấp độ nhật ký ghi chú.
otLogPlat(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3
void
Phát ra thông điệp nhật ký ở cấp độ nhật ký nhất định bằng tên mô-đun nền tảng.
otLogPlatArgs(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, va_list aArgs)
void void
Phát ra thông điệp nhật ký ở cấp độ nhật ký nhất định bằng tên mô-đun nền tảng.
otLogWarnPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void
Phát ra thông điệp nhật ký ở cấp độ nhật ký cảnh báo.
otLoggingGetLevel(void)
Trả về cấp độ nhật ký hiện tại.
otLoggingSetLevel(otLogLevel aLogLevel)
Thiết lập cấp độ nhật ký.

Cấu trúc
otLogHexDumpInfo

Biểu thị thông tin dùng để tạo kết quả tệp báo lỗi hex.

Hàm

otDumpCritPlat

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

Tạo tệp kết xuất bộ nhớ ở cấp độ nhật ký quan trọng.

Nếu bạn không đặt OPENTHREAD_CONFIG_LOG_PLATFORM hoặc OPENTHREAD_CONFIG_LOG_PKT_DUMP hoặc cấp độ nhật ký hiện tại thấp hơn mức tới hạn, thì hàm này sẽ không phát đi bất kỳ thông điệp nhật ký nào.

Thông tin chi tiết
Thông số
[in] aText
Một chuỗi được in trước các byte.
[in] aData
Con trỏ đến vùng đệm dữ liệu.
[in] aDataLength
Số byte trong aData.

otDumpDebgPlat

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

Tạo tệp kết xuất bộ nhớ ở cấp nhật ký gỡ lỗi.

Nếu bạn không đặt OPENTHREAD_CONFIG_LOG_PLATFORM hoặc OPENTHREAD_CONFIG_LOG_PKT_DUMP hoặc cấp độ nhật ký hiện tại thấp hơn cấp độ nhật ký để gỡ lỗi, thì hàm này sẽ không phát ra thông điệp nhật ký nào.

Thông tin chi tiết
Thông số
[in] aText
Một chuỗi được in trước các byte.
[in] aData
Con trỏ đến vùng đệm dữ liệu.
[in] aDataLength
Số byte trong aData.

otDumpInfoPlat

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

Tạo tệp kết xuất bộ nhớ ở cấp nhật ký thông tin.

Nếu bạn không đặt OPENTHREAD_CONFIG_LOG_PLATFORM hoặc OPENTHREAD_CONFIG_LOG_PKT_DUMP hoặc cấp độ nhật ký hiện tại thấp hơn thông tin, thì hàm này sẽ không phát đi thông điệp nhật ký nào.

Thông tin chi tiết
Thông số
[in] aText
Một chuỗi được in trước các byte.
[in] aData
Con trỏ đến vùng đệm dữ liệu.
[in] aDataLength
Số byte trong aData.

otDumpNotePlat

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

Tạo tệp kết xuất bộ nhớ ở cấp độ nhật ký ghi chú.

Nếu bạn không đặt OPENTHREAD_CONFIG_LOG_PLATFORM hoặc OPENTHREAD_CONFIG_LOG_PKT_DUMP hoặc cấp độ nhật ký hiện tại thấp hơn, hãy lưu ý rằng hàm này không phát đi bất kỳ thông điệp nhật ký nào.

Thông tin chi tiết
Thông số
[in] aText
Một chuỗi được in trước các byte.
[in] aData
Con trỏ đến vùng đệm dữ liệu.
[in] aDataLength
Số byte trong aData.

otDumpWarnPlat

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

Tạo tệp kết xuất bộ nhớ ở cấp nhật ký cảnh báo.

Nếu bạn không đặt OPENTHREAD_CONFIG_LOG_PLATFORM hoặc OPENTHREAD_CONFIG_LOG_PKT_DUMP hoặc mức nhật ký hiện tại thấp hơn mức cảnh báo, thì hàm này sẽ không phát đi thông điệp nhật ký nào.

Thông tin chi tiết
Thông số
[in] aText
Một chuỗi được in trước các byte.
[in] aData
Con trỏ đến vùng đệm dữ liệu.
[in] aDataLength
Số byte trong aData.

otLogCli

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

Phát ra thông điệp nhật ký ở cấp độ nhật ký nhất định.

Chỉ dành cho CLI. Nếu bạn không đặt OPENTHREAD_CONFIG_LOG_CLI hoặc cấp độ nhật ký hiện tại thấp hơn cấp độ nhật ký đã cho, thì hàm này sẽ không phát đi bất kỳ thông điệp nhật ký nào.

Thông tin chi tiết
Thông số
[in] aLogLevel
Cấp độ nhật ký.
[in] aFormat
Chuỗi định dạng.
[in] ...
Đối số cho thông số kỹ thuật về định dạng.

otLogCritPlat

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

Phát ra thông điệp nhật ký ở cấp độ nhật ký quan trọng.

Chỉ sử dụng theo nền tảng. Nếu bạn không đặt OPENTHREAD_CONFIG_LOG_PLATFORM hoặc mức nhật ký hiện tại dưới mức tới hạn, thì hàm này sẽ không phát đi thông điệp nhật ký.

Thông tin chi tiết
Thông số
[in] aFormat
Chuỗi định dạng.
[in] ...
Đối số cho thông số kỹ thuật về định dạng.

otLogDebgPlat

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

Phát ra thông điệp nhật ký ở cấp độ nhật ký gỡ lỗi.

Chỉ sử dụng theo nền tảng. Nếu bạn không đặt OPENTHREAD_CONFIG_LOG_PLATFORM hoặc cấp độ nhật ký hiện tại ở dưới cấp độ gỡ lỗi, thì hàm này sẽ không phát đi thông điệp nhật ký nào.

Thông tin chi tiết
Thông số
[in] aFormat
Chuỗi định dạng.
[in] ...
Đối số cho thông số kỹ thuật về định dạng.

otLogGenerateNextHexDumpLine

otError otLogGenerateNextHexDumpLine(
  otLogHexDumpInfo *aInfo
)

Tạo dòng kết xuất hệ lục phân tiếp theo.

Có thể gọi phương thức này liên tiếp để tạo dòng đầu ra kết xuất hex theo từng dòng. Trong lần gọi đầu tiên, trường mIterator trong aInfo PHẢI được đặt thành 0.

Dưới đây là ví dụ về kết quả tệp báo lỗi hex được tạo:

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

Thông tin chi tiết
Thông số
[in,out] aInfo
Con trỏ đến otLogHexDumpInfo dùng để tạo tệp kết xuất hex.
Giá trị trả về
OT_ERROR_NONE
Đã tạo thành công dòng tiếp theo, trường mLine trong aInfo sẽ được cập nhật.
OT_ERROR_NOT_FOUND
Đã đến cuối và không còn dòng để tạo.

otLogInfoPlat

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

Phát ra thông điệp nhật ký ở cấp độ nhật ký thông tin.

Chỉ sử dụng theo nền tảng. Nếu bạn không đặt OPENTHREAD_CONFIG_LOG_PLATFORM hoặc cấp độ nhật ký hiện tại thấp hơn thông tin, thì hàm này sẽ không phát đi bất kỳ thông điệp nhật ký nào.

Thông tin chi tiết
Thông số
[in] aFormat
Chuỗi định dạng.
[in] ...
Đối số cho thông số kỹ thuật về định dạng.

otLogNotePlat

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

Phát ra thông điệp nhật ký ở cấp độ nhật ký ghi chú.

Chỉ sử dụng theo nền tảng. Nếu bạn không đặt OPENTHREAD_CONFIG_LOG_PLATFORM hoặc mức nhật ký hiện tại thấp hơn ghi chú, thì hàm này sẽ không phát đi thông điệp nhật ký nào.

Thông tin chi tiết
Thông số
[in] aFormat
Chuỗi định dạng.
[in] ...
Đối số cho thông số kỹ thuật về định dạng.

otLogPlat

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

Phát ra thông điệp nhật ký ở cấp độ nhật ký nhất định bằng tên mô-đun nền tảng.

Hướng dẫn này dành cho nền tảng. Nếu bạn không đặt OPENTHREAD_CONFIG_LOG_PLATFORM hoặc mức nhật ký hiện tại thấp hơn aLogLevel , thì hàm này sẽ không phát đi thông điệp nhật ký nào.

Tên aPlatModuleName dùng để xác định tên mô-đun nhật ký trong thông điệp nhật ký được phát ra, theo định dạng P-{PlatModuleName}---. Tức là chuỗi tiền tố "P-" được thêm vào để cho biết đây là mô-đun con của nền tảng, theo sau là 12 ký tự tiếp theo của chuỗi PlatModuleName, với dấu gạch nối có khoảng đệm - ở cuối để đảm bảo tên khu vực dài 14 ký tự.

Thông tin chi tiết
Thông số
[in] aLogLevel
Cấp độ nhật ký.
[in] aPlatModuleName
Tên mô-đun con của nền tảng.
[in] aFormat
Chuỗi định dạng.
[in] ...
Đối số cho thông số kỹ thuật về định dạng.

otLogPlatArgs

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

Phát ra thông điệp nhật ký ở cấp độ nhật ký nhất định bằng tên mô-đun nền tảng.

Hướng dẫn này dành cho nền tảng. Nếu bạn không đặt OPENTHREAD_CONFIG_LOG_PLATFORM hoặc mức nhật ký hiện tại thấp hơn aLogLevel , thì hàm này sẽ không phát đi thông điệp nhật ký nào.

Tên aPlatModuleName dùng để xác định tên mô-đun nhật ký trong thông điệp nhật ký được phát ra, theo định dạng P-{PlatModuleName}---. Tức là chuỗi tiền tố "P-" được thêm vào để cho biết đây là mô-đun con của nền tảng, theo sau là 12 ký tự tiếp theo của chuỗi PlatModuleName, với dấu gạch nối có khoảng đệm - ở cuối để đảm bảo tên khu vực dài 14 ký tự.

Thông tin chi tiết
Thông số
[in] aLogLevel
Cấp độ nhật ký.
[in] aPlatModuleName
Tên mô-đun con của nền tảng.
[in] aFormat
Chuỗi định dạng.
[in] aArgs
Đối số cho thông số kỹ thuật về định dạng.

otLogWarnPlat

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

Phát ra thông điệp nhật ký ở cấp độ nhật ký cảnh báo.

Chỉ sử dụng theo nền tảng. Nếu bạn không đặt OPENTHREAD_CONFIG_LOG_PLATFORM hoặc cấp độ nhật ký hiện tại thấp hơn cảnh báo, thì hàm này sẽ không phát đi thông điệp nhật ký.

Thông tin chi tiết
Thông số
[in] aFormat
Chuỗi định dạng.
[in] ...
Đối số cho thông số kỹ thuật về định dạng.

otLoggingGetLevel

otLogLevel otLoggingGetLevel(
  void
)

Trả về cấp độ nhật ký hiện tại.

Nếu bạn bật tính năng cấp nhật ký động OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE, hàm này sẽ trả về cấp độ nhật ký động hiện đã thiết lập. Nếu không, hàm này sẽ trả về cấp độ nhật ký được định cấu hình tại thời điểm tạo bản dựng.

Thông tin chi tiết
Trả về
Cấp độ nhật ký.

otLoggingSetLevel

otError otLoggingSetLevel(
  otLogLevel aLogLevel
)

Thiết lập cấp độ nhật ký.

Thông tin chi tiết
Thông số
[in] aLogLevel
Cấp độ nhật ký.
Giá trị trả về
OT_ERROR_NONE
Đã cập nhật thành công cấp độ nhật ký.
OT_ERROR_INVALID_ARGS
Giá trị cấp nhật ký không hợp lệ.

Macro

OT_LOG_HEX_DUMP_LINE_SIZE

 OT_LOG_HEX_DUMP_LINE_SIZE 73

Kích thước chuỗi dòng kết xuất hex.

Tài nguyên

Các chủ đề tham khảo API OpenThread bắt nguồn từ mã nguồn, có trên GitHub. Để biết thêm thông tin hoặc để đóng góp cho tài liệu của chúng tôi, hãy tham khảo Tài nguyên.