Google 致力于为黑人社区推动种族平等。查看具体行动

日志记录 - 线程堆栈

此模块包含与 OpenThread 日志记录相关的定义。

摘要

函数

otDumpCritPlat(const char *aText, const void *aData, uint16_t aDataLength)
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, ...)
void
此函数发出给定日志级别的日志消息。
otLogCritPlat(const char *aFormat, ...)
void
该函数会在关键日志级别发出日志消息。
otLogDebgPlat(const char *aFormat, ...)
void
此函数在调试日志级别发出日志消息。
otLogInfoPlat(const char *aFormat, ...)
void
此函数会在信息日志级别发出日志消息。
otLogNotePlat(const char *aFormat, ...)
void
此函数在备注日志级别发出日志消息。
otLogWarnPlat(const char *aFormat, ...)
void
该函数会在警告日志级别发出日志消息。
otLoggingGetLevel(void)
此函数返回当前日志级别。
otLoggingSetLevel(otLogLevel aLogLevel)
此函数设置日志级别。

函数

otDumpCritPlat

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

此函数会在关键日志级别生成内存转储。

如果 OPENTHREAD_CONFIG_LOG_PLATFORMOPENTHREAD_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_PLATFORMOPENTHREAD_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_PLATFORMOPENTHREAD_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_PLATFORMOPENTHREAD_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_PLATFORMOPENTHREAD_CONFIG_LOG_PKT_DUMP 未设置,或者当前日志级别低于警告,则该函数不会发出任何日志消息。

详情
参数
[in] aText
显示在字节之前的字符串。
[in] aData
指向数据缓冲区的指针。
[in] aDataLength
aData 中的字节数。

otLogCli

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

此函数发出给定日志级别的日志消息。

此函数仅供 CLI 使用。如果未设置 OPENTHREAD_CONFIG_LOG_CLI 或当前日志级别低于给定日志级别,则此函数不会发出任何日志消息。

详情
参数
[in] aLogLevel
日志级别。
[in] aFormat
格式字符串。
[in] ...
格式规范的参数。

otLogCritPlat

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

该函数会在关键日志级别发出日志消息。

此功能适用于平台。如果未设置 OPENTHREAD_CONFIG_LOG_PLATFORM 或当前日志级别低于严重级别,则此函数不会发出任何日志消息。

详情
参数
[in] aFormat
格式字符串。
[in] ...
格式规范的参数。

otLogDebgPlat

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

此函数在调试日志级别发出日志消息。

此功能适用于平台。如果未设置 OPENTHREAD_CONFIG_LOG_PLATFORM 或当前日志级别低于调试级别,则此函数不会发出任何日志消息。

详情
参数
[in] aFormat
格式字符串。
[in] ...
格式规范的参数。

otLogInfoPlat

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

此函数会在信息日志级别发出日志消息。

此功能适用于平台。如果未设置 OPENTHREAD_CONFIG_LOG_PLATFORM 或当前日志级别低于 info,则此函数不会发出任何日志消息。

详情
参数
[in] aFormat
格式字符串。
[in] ...
格式规范的参数。

otLogNotePlat

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

此函数在备注日志级别发出日志消息。

此功能适用于平台。如果未设置 OPENTHREAD_CONFIG_LOG_PLATFORM 或当前日志级别低于备注,则此函数不会发出任何日志消息。

详情
参数
[in] aFormat
格式字符串。
[in] ...
格式规范的参数。

otLogWarnPlat

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

该函数会在警告日志级别发出日志消息。

此功能适用于平台。如果未设置 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
日志级别值无效。

资源

OpenThread API 参考主题源自源代码,可在 GitHub 上找到。 如需了解详情或为我们的文档做贡献,请参阅资源