מעקב אחר היסטוריה

מתעדת את ההיסטוריה של אירועים שונים, למשל הודעות RX ו-TX או שינויים בפרטי הרשת.

סיכום

כל הערכים במעקב נמצאים בחותמות זמן.

הפונקציות במודול הזה זמינות כשמפעילים את OPENTHREAD_CONFIG_HISTOR_TRACKER_ENABLE.

הדמיות

anonymous enum{
  OT_HISTORY_TRACKER_MSG_PRIORITY_LOW = OT_MESSAGE_PRIORITY_LOW,
  OT_HISTORY_TRACKER_MSG_PRIORITY_NORMAL = OT_MESSAGE_PRIORITY_NORMAL,
  OT_HISTORY_TRACKER_MSG_PRIORITY_HIGH = OT_MESSAGE_PRIORITY_HIGH,
  OT_HISTORY_TRACKER_MSG_PRIORITY_NET = OT_MESSAGE_PRIORITY_HIGH + 1
}
Enum
קבועים המייצגים עדיפות הודעה המשמשת ב-otHistoryTrackerMessageInfo מבנה.
otHistoryTrackerAddressEvent{
  OT_HISTORY_TRACKER_ADDRESS_EVENT_ADDED = 0,
  OT_HISTORY_TRACKER_ADDRESS_EVENT_REMOVED = 1
}
Enum
הספירה הזו מגדירה את האירועים עבור כתובת IPv6 (unicast או Multicast) (כלומר, אם הכתובת נוספה או הוסרה).
otHistoryTrackerNeighborEvent{
  OT_HISTORY_TRACKER_NEIGHBOR_EVENT_ADDED = 0,
  OT_HISTORY_TRACKER_NEIGHBOR_EVENT_REMOVED = 1,
  OT_HISTORY_TRACKER_NEIGHBOR_EVENT_CHANGED = 2,
  OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING = 3
}
Enum
ספירה זו מגדירה את האירועים במידע של שכן (כלומר
otHistoryTrackerNetDataEvent{
  OT_HISTORY_TRACKER_NET_DATA_ENTRY_ADDED = 0,
  OT_HISTORY_TRACKER_NET_DATA_ENTRY_REMOVED = 1
}
Enum
ספירה זו מגדירה את האירועים לרשומת נתוני רשת (כלומר, אם נוסף או הוסר רשומה).

סוג מגן

otHistoryTrackerExternalRouteInfo typedef
המבנה הזה מייצג מידע על מסלול חיצוני של נתוני רשת.
otHistoryTrackerIterator typedef
סוג זה מייצג איטרציה לחזרה באמצעות רשימת היסטוריה.
otHistoryTrackerMessageInfo typedef
המבנה הזה מייצג פרטי הודעה מסוג RX/TX IPv6.
otHistoryTrackerMulticastAddressInfo typedef
המבנה הזה מייצג את פרטי הכתובת של שידור לקבוצה ב-IPv6.
otHistoryTrackerNeighborInfo typedef
מבנה זה מייצג מידע סמוך.
otHistoryTrackerNetworkInfo typedef
המבנה הזה מייצג את פרטי הרשת בשרשור.
otHistoryTrackerOnMeshPrefixInfo typedef
המבנה הזה מייצג נתוני רשת בקידומת רשת.
otHistoryTrackerUnicastAddressInfo typedef
המבנה הזה מייצג פרטי כתובת IPv6 חד-פעמיים.

פונקציות

otHistoryTrackerEntryAgeToString(uint32_t aEntryAge, char *aBuffer, uint16_t aSize)
void
הפונקציה הזו ממירה גיל נתון למחרוזת שניתן לקרוא אותה.
otHistoryTrackerInitIterator(otHistoryTrackerIterator *aIterator)
void
פונקציה זו מפעילה otHistoryTrackerIterator.
otHistoryTrackerIterateExternalRouteHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
הפונקציה הזו חוזרת על עצמה ברשימה של היסטוריית הכניסות למסלולים של נתוני רשת.
otHistoryTrackerIterateMulticastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
הפונקציה הזו חוזרת על עצמה ברשימות של היסטוריית הכתובות לקבוצה של ריבוי שידורים.
otHistoryTrackerIterateNeighborHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
פונקציה זו חוזרת על עצמה ברשומות ברשימת ההיסטוריה של השכן.
otHistoryTrackerIterateNetInfoHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
הפונקציה הזו חוזרת על עצמה בערכים ברשימת היסטוריית המידע ברשת.
otHistoryTrackerIterateOnMeshPrefixHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
הפונקציה הזו חוזרת על עצמה ברשימת הערכים בהיסטוריית הקידומות של נתוני הרשת.
otHistoryTrackerIterateRxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
הפונקציה הזו חוזרת על עצמה ברשימה של היסטוריית ההודעות ב-RX.
otHistoryTrackerIterateTxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
הפונקציה הזו חוזרת על עצמה ברשימות של היסטוריית ההודעות ב-TX.
otHistoryTrackerIterateUnicastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
פונקציה זו חוזרת על עצמה על הערכים ברשימת היסטוריית הכתובות של ה-Unicast.

שטרטס

otHistoryTrackerExternalRouteInfo

המבנה הזה מייצג מידע על מסלול חיצוני של נתוני רשת.

otHistoryTrackerIterator

סוג זה מייצג איטרציה לחזרה באמצעות רשימת היסטוריה.

otHistoryTrackerMessageInfo

המבנה הזה מייצג פרטי הודעה מסוג RX/TX IPv6.

otHistoryTrackerMulticastAddressInfo

המבנה הזה מייצג את פרטי הכתובת של שידור לקבוצה ב-IPv6.

otHistoryTrackerNeighborInfo

מבנה זה מייצג מידע סמוך.

otHistoryTrackerNetworkInfo

המבנה הזה מייצג את פרטי הרשת בשרשור.

otHistoryTrackerOnMeshPrefixInfo

המבנה הזה מייצג נתוני רשת בקידומת רשת.

otHistoryTrackerUnicastAddressInfo

המבנה הזה מייצג פרטי כתובת IPv6 חד-פעמיים.

הדמיות

אנום אנונימי

 anonymous enum

קבועים המייצגים עדיפות הודעה המשמשת ב-otHistoryTrackerMessageInfo מבנה.

מאפיינים
OT_HISTORY_TRACKER_MSG_PRIORITY_HIGH

עדיפות גבוהה.

OT_HISTORY_TRACKER_MSG_PRIORITY_LOW

רמת עדיפות נמוכה.

OT_HISTORY_TRACKER_MSG_PRIORITY_NET

רמת עדיפות של 'בקרת רשת'.

OT_HISTORY_TRACKER_MSG_PRIORITY_NORMAL

רמת עדיפות רגילה.

otHistoryTrackerAddressEvent

 otHistoryTrackerAddressEvent

הספירה הזו מגדירה את האירועים עבור כתובת IPv6 (unicast או Multicast) (כלומר, אם הכתובת נוספה או הוסרה).

מאפיינים
OT_HISTORY_TRACKER_ADDRESS_EVENT_ADDED

הכתובת נוספה.

OT_HISTORY_TRACKER_ADDRESS_EVENT_REMOVED

הכתובת הוסרה.

אירוע otHistoryTrackerNeighbor

 otHistoryTrackerNeighborEvent

ספירה זו מגדירה את האירועים במידע של שכן (כלומר

האם השכן נוסף, הוסר או השתנה).

אירוע OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING חל רק לגבי שכנים. היא מופעלת לאחר הפעלת המכשיר (המחדש) וכשרשימת הצאצאים הקודמים מאוחזרת מהגדרות שאינן משתנות, והמכשיר מנסה לשחזר את החיבור אליהן.

מאפיינים
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_ADDED

נוסף שכן.

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_CHANGED

השכן השתנה (למשל, הסימונים של מצב המכשיר השתנו).

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_REMOVED

השכן הוסר.

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING

מתבצע שחזור של שכן (רלוונטי לילד בלבד).

otHistoryTrackerNetDataEvent

 otHistoryTrackerNetDataEvent

ספירה זו מגדירה את האירועים לרשומת נתוני רשת (כלומר, אם נוסף או הוסר רשומה).

מאפיינים
OT_HISTORY_TRACKER_NET_DATA_ENTRY_ADDED

נוספה רשומה לנתוני רשת.

OT_HISTORY_TRACKER_NET_DATA_ENTRY_REMOVED

הרשומה של נתוני הרשת הוסרה.

סוג מגן

otHistoryTrackerExternalRouteInfo

struct otHistoryTrackerExternalRouteInfo otHistoryTrackerExternalRouteInfo

המבנה הזה מייצג מידע על מסלול חיצוני של נתוני רשת.

otHistoryTrackerIterator

struct otHistoryTrackerIterator otHistoryTrackerIterator

סוג זה מייצג איטרציה לחזרה באמצעות רשימת היסטוריה.

השדות בסוג זה הם אטומים (לשימוש של ליבה OpenThread) ולכן אין לגשת אליהם או להשתמש בהם בהתקשרות.

לפני השימוש באיטרטור, יש לאתחל אותו באמצעות otHistoryTrackerInitIterator(),

otHistoryTrackerMessageInfo

struct otHistoryTrackerMessageInfo otHistoryTrackerMessageInfo

המבנה הזה מייצג פרטי הודעה מסוג RX/TX IPv6.

חלק מהשדות במבנה זה חלים על הודעת RX או על הודעת TX בלבד, לדוגמה: mAveRxRss הוא ה-RSS הממוצע של כל חלקי הקטעים שיוצרים הודעה שהתקבלה, והוא רלוונטי רק להודעת RX.

otHistoryTrackerMulticastAddressInfo

struct otHistoryTrackerMulticastAddressInfo otHistoryTrackerMulticastAddressInfo

המבנה הזה מייצג את פרטי הכתובת של שידור לקבוצה ב-IPv6.

otHistoryTrackerNeighborInfo

struct otHistoryTrackerNeighborInfo otHistoryTrackerNeighborInfo

מבנה זה מייצג מידע סמוך.

otHistoryTrackerNetworkInfo

struct otHistoryTrackerNetworkInfo otHistoryTrackerNetworkInfo

המבנה הזה מייצג את פרטי הרשת בשרשור.

otHistoryTrackerOnMeshPrefixInfo

struct otHistoryTrackerOnMeshPrefixInfo otHistoryTrackerOnMeshPrefixInfo

המבנה הזה מייצג נתוני רשת בקידומת רשת.

otHistoryTrackerUnicastAddressInfo

struct otHistoryTrackerUnicastAddressInfo otHistoryTrackerUnicastAddressInfo

המבנה הזה מייצג פרטי כתובת IPv6 חד-פעמיים.

פונקציות

otHistoryTrackerEntryAgeToString

void otHistoryTrackerEntryAgeToString(
  uint32_t aEntryAge,
  char *aBuffer,
  uint16_t aSize
)

הפונקציה הזו ממירה גיל נתון למחרוזת שניתן לקרוא אותה.

מחרוזת הגיל של הרשומה מבוססת על הפורמט "::הנתונים." עבור שעות, דקות, שניות ואלפיות שנייה (אם קצר יותר מיום אחד) או "

ימים ::." (אם יותר מיום אחד).

אם המחרוזת שמתקבלת לא מתאימה ל-aBuffer (בתוך aSize תווים), המחרוזת תיקטע, אבל המחרוזת עם הפלט תמיד תסתיים.

פרטים
פרמטרים
[in] aEntryAge
גיל ההזנה (משך באלפיות השנייה).
[out] aBuffer
מצביע למערך תווים כדי להוציא את המחרוזת (ייתכן שלא יהיה NULL).
[in] aSize
הגודל של aBuffer. מומלץ להשתמש ב-OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE.

otHistoryTrackerInitIterator

void otHistoryTrackerInitIterator(
  otHistoryTrackerIterator *aIterator
)

פונקציה זו מפעילה otHistoryTrackerIterator.

יש לאתחל איטרטור לפני השימוש בו.

אפשר להתחיל אתחול של איטרטור מתחילת הרשימה.

בעת חזרה על ערכים ברשימה, כדי להבטיח שגילאי הערכים יהיו עקביים, הגיל מצוין ביחס למועד האתחול של האיטרטור, כלומר, גיל הכניסה מסופק כמשך הזמן (באלפיות שנייה) מהאירוע (כאשר הערך היה הוקלט) לזמן האתחול של האיטרטור.

פרטים
פרמטרים
[in] aIterator
מצביע לאיטרטור לאתחול (לא יכול להיות NULL).

otHistoryTrackerIterateExternalRouteHistory

const otHistoryTrackerExternalRouteInfo * otHistoryTrackerIterateExternalRouteHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

הפונקציה הזו חוזרת על עצמה ברשימה של היסטוריית הכניסות למסלולים של נתוני רשת.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in,out] aIterator
מצביע לאיטרטור. חובה לאתחל או שההתנהגות לא מוגדרת.
[out] aEntryAge
מצביע למשתנה שמציג את גיל הרשומה. חייב להיות לא NULL. הגיל מצוין כמשך הזמן (באלפיות שנייה) מהתאריך שבו הרשומה הוקלטה עד לזמן האתחול של aIterator. הערך מוגדר ל-OT_HISTORY_TRACKER_MAX_AGE עבור רשומות בנות יותר מהגיל המקסימלי.
החזרות
הערך otHistoryTrackerExternalRouteInfo או NULL, אם אין עוד ערכים ברשימה.

otHistoryTrackerIterateMulticastAddressHistory

const otHistoryTrackerMulticastAddressInfo * otHistoryTrackerIterateMulticastAddressHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

הפונקציה הזו חוזרת על עצמה ברשימות של היסטוריית הכתובות לקבוצה של ריבוי שידורים.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in,out] aIterator
מצביע לאיטרטור. חובה לאתחל או שההתנהגות לא מוגדרת.
[out] aEntryAge
מצביע למשתנה שמציג את גיל הרשומה. חייב להיות לא NULL. הגיל מצוין כמשך הזמן (באלפיות שנייה) מהתאריך שבו הרשומה הוקלטה עד לזמן האתחול של aIterator. הערך מוגדר ל-OT_HISTORY_TRACKER_MAX_AGE עבור רשומות בנות יותר מהגיל המקסימלי.
החזרות
מצביע לערך otHistoryTrackerMulticastAddressInfo או NULL אם אין עוד ערכים ברשימה.

otHistoryTrackerIterateNeighborHistory

const otHistoryTrackerNeighborInfo * otHistoryTrackerIterateNeighborHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

פונקציה זו חוזרת על עצמה ברשומות ברשימת ההיסטוריה של השכן.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in,out] aIterator
מצביע לאיטרטור. חובה לאתחל או שההתנהגות לא מוגדרת.
[out] aEntryAge
מצביע למשתנה שמציג את גיל הרשומה. חייב להיות לא NULL. הגיל מצוין כמשך הזמן (באלפיות שנייה) מהתאריך שבו הרשומה הוקלטה עד לזמן האתחול של aIterator. הערך מוגדר ל-OT_HISTORY_TRACKER_MAX_AGE עבור רשומות בנות יותר מהגיל המקסימלי.
החזרות
הערך otHistoryTrackerNeighborInfo או NULL, אם אין עוד ערכים ברשימה.

otHistoryTrackerIterateNetInfoHistory

const otHistoryTrackerNetworkInfo * otHistoryTrackerIterateNetInfoHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

הפונקציה הזו חוזרת על עצמה בערכים ברשימת היסטוריית המידע ברשת.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in,out] aIterator
מצביע לאיטרטור. חובה לאתחל או שההתנהגות לא מוגדרת.
[out] aEntryAge
מצביע למשתנה שמציג את גיל הרשומה. חייב להיות לא NULL. הגיל מצוין כמשך הזמן (באלפיות שנייה) מהתאריך שבו הרשומה הוקלטה עד לזמן האתחול של aIterator. הערך מוגדר ל-OT_HISTORY_TRACKER_MAX_AGE עבור רשומות בנות יותר מהגיל המקסימלי.
החזרות
מצביע לערך otHistoryTrackerNetworkInfo או NULL אם אין עוד ערכים ברשימה.

otHistoryTrackerIterateOnMeshPrefixHistory

const otHistoryTrackerOnMeshPrefixInfo * otHistoryTrackerIterateOnMeshPrefixHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

הפונקציה הזו חוזרת על עצמה ברשימת הערכים בהיסטוריית הקידומות של נתוני הרשת.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in,out] aIterator
מצביע לאיטרטור. חובה לאתחל או שההתנהגות לא מוגדרת.
[out] aEntryAge
מצביע למשתנה שמציג את גיל הרשומה. חייב להיות לא NULL. הגיל מצוין כמשך הזמן (באלפיות שנייה) מהתאריך שבו הרשומה הוקלטה עד לזמן האתחול של aIterator. הערך מוגדר ל-OT_HISTORY_TRACKER_MAX_AGE עבור רשומות בנות יותר מהגיל המקסימלי.
החזרות
הערך otHistoryTrackerOnMeshPrefixInfo או NULL, אם אין עוד ערכים ברשימה.

otHistoryTrackerIterateRxHistory

const otHistoryTrackerMessageInfo * otHistoryTrackerIterateRxHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

הפונקציה הזו חוזרת על עצמה ברשימה של היסטוריית ההודעות ב-RX.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in,out] aIterator
מצביע לאיטרטור. חובה לאתחל או שההתנהגות לא מוגדרת.
[out] aEntryAge
מצביע למשתנה שמציג את גיל הרשומה. חייב להיות לא NULL. הגיל מצוין כמשך הזמן (באלפיות שנייה) מהתאריך שבו הרשומה הוקלטה עד לזמן האתחול של aIterator. הערך מוגדר ל-OT_HISTORY_TRACKER_MAX_AGE עבור רשומות בנות יותר מהגיל המקסימלי.
החזרות
הערך otHistoryTrackerMessageInfo או NULL, אם אין עוד ערכים ברשימה.

otHistoryTrackerIterateTxHistory

const otHistoryTrackerMessageInfo * otHistoryTrackerIterateTxHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

הפונקציה הזו חוזרת על עצמה ברשימות של היסטוריית ההודעות ב-TX.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in,out] aIterator
מצביע לאיטרטור. חובה לאתחל או שההתנהגות לא מוגדרת.
[out] aEntryAge
מצביע למשתנה שמציג את גיל הרשומה. חייב להיות לא NULL. הגיל מצוין כמשך הזמן (באלפיות שנייה) מהתאריך שבו הרשומה הוקלטה עד לזמן האתחול של aIterator. הערך מוגדר ל-OT_HISTORY_TRACKER_MAX_AGE עבור רשומות בנות יותר מהגיל המקסימלי.
החזרות
הערך otHistoryTrackerMessageInfo או NULL, אם אין עוד ערכים ברשימה.

otHistoryTrackerIterateUnicastAddressHistory

const otHistoryTrackerUnicastAddressInfo * otHistoryTrackerIterateUnicastAddressHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

פונקציה זו חוזרת על עצמה על הערכים ברשימת היסטוריית הכתובות של ה-Unicast.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in,out] aIterator
מצביע לאיטרטור. חובה לאתחל או שההתנהגות לא מוגדרת.
[out] aEntryAge
מצביע למשתנה שמציג את גיל הרשומה. חייב להיות לא NULL. הגיל מצוין כמשך הזמן (באלפיות שנייה) מהתאריך שבו הרשומה הוקלטה עד לזמן האתחול של aIterator. הערך מוגדר ל-OT_HISTORY_TRACKER_MAX_AGE עבור רשומות בנות יותר מהגיל המקסימלי.
החזרות
מצביע לערך otHistoryTrackerUnicastAddressInfo או NULL אם אין עוד ערכים ברשימה.

פקודות מאקרו

OT_היסטוריה_TRACKER_DIRECTION_AGE_STRING_SIZE

 OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE 21

גודל מומלץ לייצוג מחרוזות של גיל כניסה.

OT_History_TRACKER_MAX_AGE

 OT_HISTORY_TRACKER_MAX_AGE (49 * 24 * 60 * 60 * 1000u)

קבוע זה מציין את הגיל המקסימלי לרשומות, שהוא 49 ימים (באלפיות השנייה).

ערכים שגילם עולה על הגיל המקסימלי יקבלו את הערך הזה כגיל.

מקורות מידע

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