רישום ביומן - מקבץ שרשורים

המודול הזה כולל הגדרות שקשורות לרישום ביומן OpenThread.

סיכום

פונקציות
otDumpCritPlat(const char *aText, const void *aData, uint16_t aDataLength)
void void void void void void
יוצר קובץ dump זיכרון ברמת יומן קריטית.
otDumpDebgPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
יוצר קובץ Dump של זיכרון ברמת יומן ניפוי הבאגים.
otDumpInfoPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
יוצרת תמונת מצב של הזיכרון ברמת יומן המידע.
otDumpNotePlat(const char *aText, const void *aData, uint16_t aDataLength)
void
יוצר קובץ dump זיכרון ברמת יומן ההערות.
otDumpWarnPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
יוצר קובץ dump זיכרון ברמת יומן האזהרה.
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)
יוצר את שורת ה-dump הקסדצימלית הבאה.
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

מייצג מידע שמשמש ליצירת פלט dump הקסדצימלי.

פונקציות

otDumpCritPlat

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

יוצר קובץ dump זיכרון ברמת יומן קריטית.

אם הערכים 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
)

יוצר קובץ Dump של זיכרון ברמת יומן ניפוי הבאגים.

אם הערכים 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
)

יוצר קובץ dump זיכרון ברמת יומן ההערות.

אם הערכים 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
)

יוצר קובץ dump זיכרון ברמת יומן האזהרה.

אם הערכים 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
)

יוצר את שורת ה-dump הקסדצימלית הבאה.

אפשר לקרוא לשיטה הזו בהמרה (back-to-back)) כדי ליצור את שורת הפלט של dump הקסדצימלי בכל שורה. בקריאה הראשונה, השדה mIterator ב-aInfo חייב להיות מוגדר כאפס.

דוגמה לפלט ה-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.E.....-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 ברמת היומן הדינמי מופעלת, הפונקציה הזו מחזירה את רמת היומן הדינמי המוגדרת כרגע. אחרת, הפונקציה הזו מחזירה את רמת היומן המוגדרת בזמן ה-build.

פרטים
החזרות
רמת היומן.

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

גודל מחרוזת של שורת Dump של הקסדצימלי.

מקורות מידע

המקור של נושאי העזר של OpenThread API הוא קוד המקור, שזמין ב-GitHub. אפשר לקרוא מידע נוסף או לתרום למסמכי התיעוד שלנו בדף מקורות מידע.