מעקב היסטוריה
תיעוד ההיסטוריה של אירועים שונים, לדוגמה הודעות RX ו-TX או שינויים בפרטי הרשת.
סיכום
לכל הרשומות שבמעקב יש חותמת זמן.
הפונקציות במודול הזה זמינות כאשר OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE
מופעלת.
ערכי דף |
|
---|---|
otHistoryTrackerExternalRouteInfo
|
typedef לייצג פרטי נתיב חיצוניים של נתוני רשת. |
otHistoryTrackerIterator
|
typedefstruct otHistoryTrackerIterator
מייצג איטרטור שחוזר על עצמו דרך רשימת היסטוריה. |
otHistoryTrackerMessageInfo
|
typedefstruct otHistoryTrackerMessageInfo
מייצג פרטים של הודעת RX/TX IPv6. |
otHistoryTrackerMulticastAddressInfo
|
typedef ייצוג של פרטי כתובת Multicast של IPv6. |
otHistoryTrackerNeighborInfo
|
typedefstruct otHistoryTrackerNeighborInfo
מייצג את פרטי השכן. |
otHistoryTrackerNetworkInfo
|
typedefstruct otHistoryTrackerNetworkInfo
מייצג את פרטי הרשת של Thread. |
otHistoryTrackerOnMeshPrefixInfo
|
typedef ייצוג של נתוני רשת בפרטי קידומת של רשת. |
otHistoryTrackerRouterInfo
|
typedefstruct otHistoryTrackerRouterInfo
מייצג אירוע כניסה לטבלה בנתב. |
otHistoryTrackerUnicastAddressInfo
|
typedef לייצג פרטי כתובת של IPv6 בפורמט unicast. |
פונקציות |
|
---|---|
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)
|
const otHistoryTrackerNeighborInfo *
מבצע איטרציה לרשומות ברשימת היסטוריית השכנים.
|
otHistoryTrackerIterateNetInfoHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerNetworkInfo *
מתבצע איטרציה בין הערכים ברשימה של היסטוריית פרטי הרשת.
|
otHistoryTrackerIterateOnMeshPrefixHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerOnMeshPrefixInfo *
מתבצעת איטרציה של הערכים ברשימה של היסטוריית הרשומות של קידומת הרשת לנתוני רשת.
|
otHistoryTrackerIterateRouterHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerRouterInfo *
מתבצע איטרציה של הערכים ברשימת ההיסטוריה של הנתבים.
|
otHistoryTrackerIterateRxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerMessageInfo *
מבצע איטרציה לרשומות ברשימה של היסטוריית ההודעות של RX.
|
otHistoryTrackerIterateTxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerMessageInfo *
מתבצע איטרציה בין הערכים ברשימה של היסטוריית ההודעות ב-TX.
|
otHistoryTrackerIterateUnicastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
מתבצע איטרציה בין הערכים ברשימת היסטוריית הכתובות של Uncast.
|
מבנים |
|
---|---|
otHistoryTrackerExternalRouteInfo |
לייצג פרטי נתיב חיצוניים של נתוני רשת. |
otHistoryTrackerIterator |
מייצג איטרטור שחוזר על עצמו דרך רשימת היסטוריה. |
otHistoryTrackerMessageInfo |
מייצג פרטים של הודעת RX/TX IPv6. |
otHistoryTrackerMulticastAddressInfo |
ייצוג של פרטי כתובת Multicast של IPv6. |
otHistoryTrackerNeighborInfo |
מייצג את פרטי השכן. |
otHistoryTrackerNetworkInfo |
מייצג את פרטי הרשת של Thread. |
otHistoryTrackerOnMeshPrefixInfo |
ייצוג של נתוני רשת בפרטי קידומת של רשת. |
otHistoryTrackerRouterInfo |
מייצג אירוע כניסה לטבלה בנתב. |
otHistoryTrackerUnicastAddressInfo |
לייצג פרטי כתובת של IPv6 בפורמט unicast. |
ספירות
טיפוסים אנונימיים
anonymous enum
קבועים שמייצגים עדיפות הודעה שנמצאת בשימוש ב-struct 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
|
הכתובת הוסרה. |
otHistoryTrackerNeighborEvent
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
|
הזנת נתוני רשת הוסרה. |
otHistoryTrackerRouterEvent
otHistoryTrackerRouterEvent
מגדיר את האירועים בפרטי הנתב (כלומר
הוספה, הסרה או שינוי של הנתב).
תכונות | |
---|---|
OT_HISTORY_TRACKER_ROUTER_EVENT_ADDED
|
הנתב נוסף (מזהה נתב הוקצה). |
OT_HISTORY_TRACKER_ROUTER_EVENT_COST_CHANGED
|
העלות של נתיב הכניסה של הנתב השתנתה (השלב הבא כמו הקודם). |
OT_HISTORY_TRACKER_ROUTER_EVENT_NEXT_HOP_CHANGED
|
הצעד הבא של הנתב והעלות השתנו. |
OT_HISTORY_TRACKER_ROUTER_EVENT_REMOVED
|
רשומה של הנתב הוסרה (מזהה הנתב שוחרר). |
ערכי דף
otHistoryTrackerExternalRouteInfo
struct otHistoryTrackerExternalRouteInfo otHistoryTrackerExternalRouteInfo
לייצג פרטי נתיב חיצוניים של נתוני רשת.
otHistoryTrackerIterator
struct otHistoryTrackerIterator otHistoryTrackerIterator
מייצג איטרטור שחוזר על עצמו דרך רשימת היסטוריה.
השדות בסוג הזה אטומים (מיועדים לשימוש על ידי ליבת OpenThread) ולכן מבצע הקריאה החוזרת (caller) לא יכול לגשת אליהם או להשתמש בהם.
לפני השימוש באיטרטור, הוא חייב להיות מופעל באמצעות otHistoryTrackerInitIterator()
,
otHistoryTrackerMessageInfo
struct otHistoryTrackerMessageInfo otHistoryTrackerMessageInfo
מייצג פרטים של הודעת RX/TX IPv6.
חלק מהשדות במבנה הזה רלוונטיים להודעת RX או להודעת TX בלבד, לדוגמה: mAveRxRss
הוא ה-RSS הממוצע של כל מסגרות המקטעים שיוצרים הודעה שהתקבלה, והוא רלוונטי רק להודעת RX.
otHistoryTrackerMulticastAddressInfo
struct otHistoryTrackerMulticastAddressInfo otHistoryTrackerMulticastAddressInfo
ייצוג של פרטי כתובת Multicast של IPv6.
otHistoryTrackerNeighborInfo
struct otHistoryTrackerNeighborInfo otHistoryTrackerNeighborInfo
מייצג את פרטי השכן.
otHistoryTrackerNetworkInfo
struct otHistoryTrackerNetworkInfo otHistoryTrackerNetworkInfo
מייצג את פרטי הרשת של Thread.
otHistoryTrackerOnMeshPrefixInfo
struct otHistoryTrackerOnMeshPrefixInfo otHistoryTrackerOnMeshPrefixInfo
ייצוג של נתוני רשת בפרטי קידומת של רשת.
otHistoryTrackerRouterInfo
struct otHistoryTrackerRouterInfo otHistoryTrackerRouterInfo
מייצג אירוע כניסה לטבלה בנתב.
otHistoryTrackerUnicastAddressInfo
struct otHistoryTrackerUnicastAddressInfo otHistoryTrackerUnicastAddressInfo
לייצג פרטי כתובת של IPv6 בפורמט unicast.
פונקציות
otHistoryTrackerEntryAgeToString
void otHistoryTrackerEntryAgeToString( uint32_t aEntryAge, char *aBuffer, uint16_t aSize )
ממירה גיל ערך נתון למחרוזת שאנשים יכולים לקרוא.
מחרוזת הגיל של הרשומה מבוססת על הפורמט "
אם המחרוזת שתתקבל לא מתאימה למחרוזת aBuffer
(בתוך aSize
התווים שלה), המחרוזת תיחתך, אבל המחרוזת הפלט תמיד תהיה אפסית.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
otHistoryTrackerInitIterator
void otHistoryTrackerInitIterator( otHistoryTrackerIterator *aIterator )
מופעלת otHistoryTrackerIterator
.
חובה לאתחל איטרטור לפני השימוש בו.
אפשר לאתחל איטרטור פעם נוספת שיתחיל מתחילת הרשימה.
בעת חזרה על ערכים ברשימה, כדי להבטיח שגילאי הכניסה עקביים, הגיל מוקצה ביחס לזמן האתחול של האיטרטור, כלומר, גיל הכניסה מסופק כמשך הזמן (באלפיות שנייה) מהאירוע (כאשר הרשומה הוקלטה) ועד זמן האתחול של האיטרטור.
פרטים | |||
---|---|---|---|
פרמטרים |
|
otHistoryTrackerIterateExternalRouteHistory
const otHistoryTrackerExternalRouteInfo * otHistoryTrackerIterateExternalRouteHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
מבצע איטרציה לרשומות ברשימה של היסטוריית הכניסות של נתיבים חיצוניים של נתוני רשת.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
החזרות |
הערך
otHistoryTrackerExternalRouteInfo או NULL אם אין עוד ערכים ברשימה. |
otHistoryTrackerIterateMulticastAddressHistory
const otHistoryTrackerMulticastAddressInfo * otHistoryTrackerIterateMulticastAddressHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
מבצע איטרציה בין הערכים ברשימת היסטוריית הכתובות של שידורים מרובים.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
החזרות |
מצביע לרשומה
otHistoryTrackerMulticastAddressInfo או NULL אם אין עוד רשומות ברשימה. |
otHistoryTrackerIterateNeighborHistory
const otHistoryTrackerNeighborInfo * otHistoryTrackerIterateNeighborHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
מבצע איטרציה לרשומות ברשימת היסטוריית השכנים.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
החזרות |
הערך
otHistoryTrackerNeighborInfo או NULL אם אין עוד ערכים ברשימה. |
otHistoryTrackerIterateNetInfoHistory
const otHistoryTrackerNetworkInfo * otHistoryTrackerIterateNetInfoHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
מתבצע איטרציה בין הערכים ברשימה של היסטוריית פרטי הרשת.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
החזרות |
מצביע לרשומה
otHistoryTrackerNetworkInfo או NULL אם אין עוד רשומות ברשימה. |
otHistoryTrackerIterateOnMeshPrefixHistory
const otHistoryTrackerOnMeshPrefixInfo * otHistoryTrackerIterateOnMeshPrefixHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
מתבצעת איטרציה של הערכים ברשימה של היסטוריית הרשומות של קידומת הרשת לנתוני רשת.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
החזרות |
הערך
otHistoryTrackerOnMeshPrefixInfo או NULL אם אין עוד ערכים ברשימה. |
otHistoryTrackerIterateRouterHistory
const otHistoryTrackerRouterInfo * otHistoryTrackerIterateRouterHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
מתבצע איטרציה של הערכים ברשימת ההיסטוריה של הנתבים.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
החזרות |
הערך
otHistoryTrackerRouterInfo או NULL אם אין עוד ערכים ברשימה. |
otHistoryTrackerIterateRxHistory
const otHistoryTrackerMessageInfo * otHistoryTrackerIterateRxHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
מבצע איטרציה לרשומות ברשימה של היסטוריית ההודעות של RX.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
החזרות |
הערך
otHistoryTrackerMessageInfo או NULL אם אין עוד ערכים ברשימה. |
otHistoryTrackerIterateTxHistory
const otHistoryTrackerMessageInfo * otHistoryTrackerIterateTxHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
מתבצע איטרציה בין הערכים ברשימה של היסטוריית ההודעות ב-TX.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
החזרות |
הערך
otHistoryTrackerMessageInfo או NULL אם אין עוד ערכים ברשימה. |
otHistoryTrackerIterateUnicastAddressHistory
const otHistoryTrackerUnicastAddressInfo * otHistoryTrackerIterateUnicastAddressHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
מתבצע איטרציה בין הערכים ברשימת היסטוריית הכתובות של Uncast.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
החזרות |
מצביע לרשומה
otHistoryTrackerUnicastAddressInfo או NULL אם אין עוד רשומות ברשימה. |
פקודות מאקרו
OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE
OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE 21
גודל מומלץ לייצוג מחרוזת של גיל רשומה.
OT_HISTORY_TRACKER_INFINITE_PATH_COST
OT_HISTORY_TRACKER_INFINITE_PATH_COST 0
עלות נתיב אינסופית - בשימוש ב-otHistoryTrackerRouterInfo
.
OT_HISTORY_TRACKER_MAX_AGE
OT_HISTORY_TRACKER_MAX_AGE (49 * 24 * 60 * 60 * 1000u)
קבוע זה מציין את הגיל המקסימלי של ערכים שהוא 49 ימים (במילי-שניות).
רשומות שגדולות מהגיל המקסימלי יספקו את הערך הזה כגיל שלהם.
OT_HISTORY_TRACKER_NO_NEXT_HOP
OT_HISTORY_TRACKER_NO_NEXT_HOP 63
אין צעד נוסף – למשך mNextHop
ב-otHistoryTrackerRouterInfo
.
מקורות מידע
המקור של נושאי העזר של OpenThread API הוא קוד המקור, שזמין ב-GitHub. אפשר לקרוא מידע נוסף או לתרום למסמכי התיעוד שלנו בדף מקורות מידע.