מדדי קישורים

המודול הזה כולל פונקציות ששולטות בפרוטוקול Link Metrics.

סיכום

ספירות
otLinkMetricsEnhAckFlags{   OT_LINK_METRICS_ENH_ACK_CLEAR = 0,   OT_LINK_METRICS_ENH_ACK_REGISTER = 1 }	טיפוסים בני מנייה (enum) דגלי ACK משופרים.
otLinkMetricsStatus	טיפוסים בני מנייה (enum) ערכי סטטוס של מדדי קישורים.

ערכי דף
otLinkMetricsEnhAckFlags	typedef enum otLinkMetricsEnhAckFlags דגלי ACK משופרים.
otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext)	typedef void(* מתבצעת הפעלה של המצביע כאשר מתקבל Enh-ACK Probing IE.
otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext)	typedef void(* מתבצעת הפעלה של המצביע כאשר מתקבלת תגובה של ניהול מדדי הקישורים.
otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext)	typedef void(* מתבצעת הפעלה של המצביע כאשר מתקבל דוח 'מדדי קישורים'.
otLinkMetricsSeriesFlags	typedef struct otLinkMetricsSeriesFlags מייצג את המסגרות הכלולות בסדרת 'מעקב אחר העברה'.
otLinkMetricsStatus	typedef enum otLinkMetricsStatus ערכי סטטוס של מדדי קישורים.
otLinkMetricsValues	typedef struct otLinkMetricsValues מייצג את התוצאה (ערך) של שאילתה של מדדי קישורים.

פונקציות
otLinkMetricsConfigEnhAckProbing(otInstance *aInstance, const otIp6Address *aDestination, otLinkMetricsEnhAckFlags aEnhAckFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext, otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback, void *aEnhAckCallbackContext)	otError נשלחת בקשה לניהול מדדי קישורים של MLE כדי להגדיר/לנקות בדיקה מבוססת-ACK משופרת.
otLinkMetricsConfigForwardTrackingSeries(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext)	otError נשלחת בקשה לניהול מדדי קישורים של MLE כדי להגדיר או למחוק סדרה של מעקב אחר העברה.
otLinkMetricsManagerGetMetricsValueByExtAddr(otInstance *aInstance, const otExtAddress *aExtAddress, otLinkMetricsValues *aLinkMetricsValues)	otError קבלת נתונים של מדדי קישורים של שכן לפי הכתובת המורחבת שלו.
otLinkMetricsManagerSetEnabled(otInstance *aInstance, bool aEnable)	void הפעלה או השבתה של Link Metrics Manager.
otLinkMetricsQuery(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsReportCallback aCallback, void *aCallbackContext)	otError נשלחת בקשת נתוני MLE כדי לשלוח שאילתה למדדי קישורים.
otLinkMetricsSendLinkProbe(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, uint8_t aLength)	otError נשלחת הודעה של MLE Link Probe.

מבנים
otLinkMetricsSeriesFlags	מייצג את המסגרות הכלולות בסדרת 'מעקב אחר העברה'.
otLinkMetricsValues	מייצג את התוצאה (ערך) של שאילתה של מדדי קישורים.

ספירות

otLinkMetricsEnhAckFlags

 otLinkMetricsEnhAckFlags

דגלי ACK משופרים.

נעשה שימוש בבדיקות האלה במסגרת Enhanced-ACK based Probing כדי לציין אם לרשום או לנקות את הבדיקה.

תכונות
OT_LINK_METRICS_ENH_ACK_CLEAR	ברור.
OT_LINK_METRICS_ENH_ACK_REGISTER	הרשמה.

otLinkMetricsStatus

 otLinkMetricsStatus

ערכי סטטוס של מדדי קישורים.

ערכי דף

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

דגלי ACK משופרים.

נעשה שימוש בבדיקות האלה במסגרת Enhanced-ACK based Probing כדי לציין אם לרשום או לנקות את הבדיקה.

otLinkMetricsEnhAckProbingIeReportCallback

void(* otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext)

מתבצעת הפעלה של המצביע כאשר מתקבל Enh-ACK Probing IE.

פרטים
פרמטרים	[in] aShortAddress הכתובת המקוצרת של נושא Probing ב-Mac. [in] aExtAddress מצביע על כך שהוא מפנה לכתובת של נושא הבדיקה ב-Mac. [in] aMetricsValues הפניה לערכי 'מדדי קישורים' שהתקבלו מאירלנד. [in] aContext הפניה להקשר ספציפי לאפליקציה.

otLinkMetricsMgmtResponseCallback

void(* otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext)

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

פרטים
פרמטרים	[in] aSource מצביע לכתובת המקור. [in] aStatus קוד הסטטוס בתשובה. [in] aContext הפניה להקשר ספציפי לאפליקציה.

otLinkMetricsReportCallback

void(* otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext)

מתבצעת הפעלה של המצביע כאשר מתקבל דוח 'מדדי קישורים'.

פרטים
פרמטרים	[in] aSource מצביע לכתובת המקור. [in] aMetricsValues קישור למדדי הקישורים (תוצאת השאילתה). [in] aStatus קוד הסטטוס בדוח (מועיל רק אם הערך של aMetricsValues הוא NULL). [in] aContext הפניה להקשר ספציפי לאפליקציה.

otLinkMetricsSeriesFlags

struct otLinkMetricsSeriesFlags otLinkMetricsSeriesFlags

מייצג את המסגרות הכלולות בסדרת 'מעקב אחר העברה'.

otLinkMetricsStatus

enum otLinkMetricsStatus otLinkMetricsStatus

ערכי סטטוס של מדדי קישורים.

otLinkMetricsValues

struct otLinkMetricsValues otLinkMetricsValues

מייצג את התוצאה (ערך) של שאילתה של מדדי קישורים.

פונקציות

otLinkMetricsConfigEnhAckProbing

otError otLinkMetricsConfigEnhAckProbing(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  otLinkMetricsEnhAckFlags aEnhAckFlags,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsMgmtResponseCallback aCallback,
  void *aCallbackContext,
  otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback,
  void *aEnhAckCallbackContext
)

נשלחת בקשה לניהול מדדי קישורים של MLE כדי להגדיר/לנקות בדיקה מבוססת-ACK משופרת.

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

פרטים
פרמטרים	[in] aInstance מצביע למופע של OpenThread. [in] aDestination מצביע לכתובת היעד. [in] aEnhAckFlags סימונים של Enh-ACK כדי לציין אם לרשום או לנקות את הבדיקה. 0 למחיקה ו-1 להרשמה. ערכים אחרים שמורים. [in] aLinkMetricsFlags מצביע לדגלים שמציינים על אילו מדדים צריך להריץ את השאילתה. הערך צריך להיות NULL כאשר הערך של aEnhAckFlags הוא 0. [in] aCallback הפניה לפונקציה מופעלת כשמתקבל אישור משופר עם מדדי קישורים. [in] aCallbackContext הפניה להקשר ספציפי לאפליקציה.
ערכים מוחזרים	OT_ERROR_NONE נשלחה בהצלחה הודעה על בקשה לניהול מדדי קישורים. OT_ERROR_NO_BUFS אין מספיק מאגרים כדי ליצור את הודעת הבקשה לניהול מדדי קישורים של MLE. OT_ERROR_INVALID_ARGS aEnhAckFlags אינו ערך חוקי או ש-aLinkMetricsFlags אינו נכון. OT_ERROR_UNKNOWN_NEIGHBOR aDestination לא מוגדר כ-link-local או שהשכן לא נמצא. OT_ERROR_NOT_CAPABLE השכן הוא לא מכשיר ב-Thread 1.2 ולא תומך במדדי קישורים.

otLinkMetricsConfigForwardTrackingSeries

otError otLinkMetricsConfigForwardTrackingSeries(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  otLinkMetricsSeriesFlags aSeriesFlags,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsMgmtResponseCallback aCallback,
  void *aCallbackContext
)

נשלחת בקשה לניהול מדדי קישורים של MLE כדי להגדיר או למחוק סדרה של מעקב אחר העברה.

פרטים
פרמטרים	[in] aInstance מצביע למופע של OpenThread. [in] aDestination מצביע לכתובת היעד. [in] aSeriesId מזהה הסדרה שאיתו יש לפעול. [in] aSeriesFlags ה-Series flags שמציינים אילו מסגרות יש להביא בחשבון. [in] aLinkMetricsFlags מצביע לדגלים שמציינים על אילו מדדים צריך להריץ את השאילתה. הערך צריך להיות NULL כאשר הערך של aSeriesFlags הוא 0. [in] aCallback מצביע אל פונקציה שמופעלת כשמתקבלת התגובה של ניהול מדדי הקישורים. [in] aCallbackContext הפניה להקשר ספציפי לאפליקציה.
ערכים מוחזרים	OT_ERROR_NONE נשלחה בהצלחה הודעה על בקשה לניהול מדדי קישורים. OT_ERROR_NO_BUFS אין מספיק מאגרים כדי ליצור את הודעת הבקשה לניהול מדדי קישורים של MLE. OT_ERROR_INVALID_ARGS הערך aSeriesId לא בטווח החוקי. OT_ERROR_UNKNOWN_NEIGHBOR aDestination לא מוגדר כ-link-local או שהשכן לא נמצא. OT_ERROR_NOT_CAPABLE השכן הוא לא מכשיר ב-Thread 1.2 ולא תומך במדדי קישורים.

otLinkMetricsManagerGetMetricsValueByExtAddr

otError otLinkMetricsManagerGetMetricsValueByExtAddr(
  otInstance *aInstance,
  const otExtAddress *aExtAddress,
  otLinkMetricsValues *aLinkMetricsValues
)

קבלת נתונים של מדדי קישורים של שכן לפי הכתובת המורחבת שלו.

פרטים
פרמטרים	[in] aInstance מצביע למופע של OpenThread. [in] aExtAddress מצביע על כך שהוא מפנה לכתובת של נושא הבדיקה ב-Mac. [out] aLinkMetricsValues קישור לערכי 'מדדי הקישורים' של הנושא.
ערכים מוחזרים	OT_ERROR_NONE הנתונים של מדדי הקישורים התקבלו. OT_ERROR_INVALID_ARGS הארגומנטים לא חוקיים. OT_ERROR_NOT_FOUND לא נמצא שכן עם הכתובת המורחבת הנתונה.

otLinkMetricsManagerSetEnabled

void otLinkMetricsManagerSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

הפעלה או השבתה של Link Metrics Manager.

פרטים
פרמטרים	[in] aInstance מצביע למופע של OpenThread. [in] aEnable ערך בוליאני שמציין להפעיל או להשבית.

otLinkMetricsQuery

otError otLinkMetricsQuery(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsReportCallback aCallback,
  void *aCallbackContext
)

נשלחת בקשת נתוני MLE כדי לשלוח שאילתה למדדי קישורים.

זו יכולה להיות סדרת בדיקות יחידה או סדרת מעקב קדימה.

פרטים
פרמטרים	[in] aInstance מצביע למופע של OpenThread. [in] aDestination מצביע לכתובת היעד. [in] aSeriesId מזהה הסדרה שעליה יש להריץ שאילתה, 0 עבור 'בדיקה יחידה'. [in] aLinkMetricsFlags מצביע לדגלים שמציינים על אילו מדדים צריך להריץ את השאילתה. [in] aCallback הפניה לפונקציה מופעלת כשמתקבל הדוח 'מדדי קישורים'. [in] aCallbackContext הפניה להקשר ספציפי לאפליקציה.
ערכים מוחזרים	OT_ERROR_NONE נשלחה בהצלחה הודעה לגבי שאילתה של מדדי קישורים. OT_ERROR_NO_BUFS אין מספיק מאגרים כדי ליצור את ההודעה 'בקשה לנתוני MLE'. OT_ERROR_UNKNOWN_NEIGHBOR aDestination לא מוגדר כ-link-local או שהשכן לא נמצא. OT_ERROR_NOT_CAPABLE השכן הוא לא מכשיר ב-Thread 1.2 ולא תומך במדדי קישורים.

otLinkMetricsSendLinkProbe

otError otLinkMetricsSendLinkProbe(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  uint8_t aLength
)

נשלחת הודעה של MLE Link Probe.

פרטים
פרמטרים	[in] aInstance מצביע למופע של OpenThread. [in] aDestination מצביע לכתובת היעד. [in] aSeriesId מזהה הסדרה [1, 254] שאליו מיועדת הודעת Probe. [in] aLength אורך המטען הייעודי (payload) של הנתונים ב-Link Probe TLV, 0, 64.
ערכים מוחזרים	OT_ERROR_NONE ההודעה 'בדיקת קישור' נשלחה בהצלחה. OT_ERROR_NO_BUFS אין מספיק מאגרים כדי ליצור את ההודעה של MLE Link Probe. OT_ERROR_INVALID_ARGS הערכים aSeriesId או aLength הם לא בטווח החוקי. OT_ERROR_UNKNOWN_NEIGHBOR aDestination לא מוגדר כ-link-local או שהשכן לא נמצא. OT_ERROR_NOT_CAPABLE השכן הוא לא מכשיר ב-Thread 1.2 ולא תומך במדדי קישורים.

מקורות מידע

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