ورود به سیستم - پشته موضوع

این ماژول شامل تعاریف مربوط به ثبت گزارش 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

نشان دهنده اطلاعات مورد استفاده برای تولید خروجی hex dump است.

کارکرد

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 باید روی صفر تنظیم شود.

در اینجا یک نمونه از خروجی هگزا تولید شده آورده شده است:

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

جزئیات
مولفه های
[in,out] aInfo
یک اشاره گر به otLogHexDumpInfo برای استفاده برای تولید هگز dump.
ارزش های بازگشتی
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

اندازه رشته خط هگزا.

منابع

موضوعات مرجع OpenThread API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.