נתב גבולות

המודול הזה כולל פונקציות לניהול נתוני רשת מקומית באמצעות נתב ה-OpenThread Border Router.

סיכום

סוג שגיאות
otBorderRouterNetDataFullCallback)(void *aContext) typedef
void(*
הקריאה החוזרת (callback) של מצביע הפונקציה מופעלת כשנתוני הרשת (מקומיים או מובילים) מתמלאים.

פונקציות
otBorderRouterAddOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
הוספת תצורה של נתב גבולות לנתונים של הרשת המקומית.
otBorderRouterAddRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
הוספת הגדרה של נתיב חיצוני לנתוני הרשת המקומית.
otBorderRouterGetNetData(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
מספקת עותק מלא או יציב של הנתונים המקומיים של Thread.
otBorderRouterGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
קבלת הקידומת הבאה של On Mesh בנתוני הרשת המקומית.
otBorderRouterGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
קבלת המסלול החיצוני הבא בנתוני הרשת המקומיים.
otBorderRouterRegister(otInstance *aInstance)
רושמים מיד את נתוני הרשת המקומית אצל Leader.
otBorderRouterRemoveOnMeshPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
מסירים תצורה של נתב גבולות מנתוני הרשת המקומית.
otBorderRouterRemoveRoute(otInstance *aInstance, const otIp6Prefix *aPrefix)
מסירים הגדרה של מסלול חיצוני מנתוני הרשת המקומית.
otBorderRouterSetNetDataFullCallback(otInstance *aInstance, otBorderRouterNetDataFullCallback aCallback, void *aContext)
void
מגדיר את הקריאה החוזרת כדי לציין מתי נתוני הרשת מלאים.

סוג שגיאות

otBorderRouterNetDataFullCallback

void(* otBorderRouterNetDataFullCallback)(void *aContext)

הקריאה החוזרת (callback) של מצביע הפונקציה מופעלת כשנתוני הרשת (מקומיים או מובילים) מתמלאים.

פרטים
פרמטרים
[in] aContext
מצביעים על מידע הקשר שרירותי.

פונקציות

otBorderRouterAddOnMeshPrefix

otError otBorderRouterAddOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

הוספת תצורה של נתב גבולות לנתונים של הרשת המקומית.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aConfig
מצביע אל התצורה של נתב הגבולות.
ערכי החזרה
OT_ERROR_NONE
ההגדרה נוספה לנתוני הרשת המקומית.
OT_ERROR_INVALID_ARGS
פרמטר הגדרה אחד או יותר לא היה חוקי.
OT_ERROR_NO_BUFS
אין מספיק מקום פנוי כדי להוסיף את התצורה לנתוני הרשת המקומית.
מידע נוסף:
otBorderRouterRemoveOnMeshPrefix
otBorderRouterRegister

OTBorderRouterAddRoute

otError otBorderRouterAddRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aConfig
מצביע אל תצורת הנתיב החיצוני.
ערכי החזרה
OT_ERROR_NONE
ההגדרה נוספה לנתוני הרשת המקומית.
OT_ERROR_INVALID_ARGS
פרמטר הגדרה אחד או יותר לא היה חוקי.
OT_ERROR_NO_BUFS
אין מספיק מקום פנוי כדי להוסיף את התצורה לנתוני הרשת המקומית.
מידע נוסף:
otBorderRouterRemoveRoute
otBorderRouterRegister

otBorderRouterGetNetData

otError otBorderRouterGetNetData(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

מספקת עותק מלא או יציב של הנתונים המקומיים של Thread.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aStable
הערך TRUE בזמן העתקת הגרסה היציבה, FALSE בהעתקת הגרסה המלאה.
[out] aData
מצביע אל מאגר הנתונים הזמני.
[in,out] aDataLength
בכניסה, גודל מאגר הנתונים שאליו מפנה aData. בעת היציאה, מספר הבייטים שהועתקו.

otBorderRouterGetNextOnMeshPrefix

otError otBorderRouterGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

קבלת הקידומת הבאה של On Mesh בנתוני הרשת המקומית.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in,out] aIterator
מצביע אל ההקשר של עדכון הנתונים ברשת. כדי לקבל את הרשומה הראשונה ברשת, צריך להגדיר אותה כ-OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
מצביע אל המידע על קידומת ה-Mesh.
ערכי החזרה
OT_ERROR_NONE
נמצאה הקידומת הבאה של On Mesh.
OT_ERROR_NOT_FOUND
לא קיימת קידומת של Mesh שמופיעה בהמשך בנתוני הרשת של Thread.

OTBorderRouterGetNextRoute

otError otBorderRouterGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

קבלת המסלול החיצוני הבא בנתוני הרשת המקומיים.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in,out] aIterator
מצביע אל ההקשר של עדכון הנתונים ברשת. כדי לקבל את הערך החיצוני הראשון של הנתיב, יש להגדיר אותו כ-OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
מצביע אל המידע של מסלול חיצוני.
ערכי החזרה
OT_ERROR_NONE
המסלול החיצוני הבא נמצא בהצלחה.
OT_ERROR_NOT_FOUND
לא קיימת רשומה חיצונית של נתיב חיצוני בנתונים של Thread Network.

otBorderRouterRegister

otError otBorderRouterRegister(
  otInstance *aInstance
)

רושמים מיד את נתוני הרשת המקומית אצל Leader.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
ערכי החזרה
OT_ERROR_NONE
נוספה בהצלחה בקשה לתור לנתוני נתונים למסירה.
מידע נוסף:
otBorderRouterAddOnMeshPrefix
otBorderRouterRemoveOnMeshPrefix
otBorderRouterAddRoute
otBorderRouterRemoveRoute

otBorderRouterRemoveOnMeshPrefix

otError otBorderRouterRemoveOnMeshPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

מסירים תצורה של נתב גבולות מנתוני הרשת המקומית.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aPrefix
מצביע לקידומת IPv6.
ערכי החזרה
OT_ERROR_NONE
ההגדרה הוסרה מנתוני הרשת המקומית.
OT_ERROR_NOT_FOUND
לא ניתן למצוא את הכניסה לנתב הגבולות.
מידע נוסף:
otBorderRouterAddOnMeshPrefix
otBorderRouterRegister

OTBorderRouterRemoveRoute

otError otBorderRouterRemoveRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

מסירים הגדרה של מסלול חיצוני מנתוני הרשת המקומית.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aPrefix
מצביע לקידומת IPv6.
ערכי החזרה
OT_ERROR_NONE
ההגדרה הוסרה מנתוני הרשת המקומית.
OT_ERROR_NOT_FOUND
לא ניתן למצוא את הכניסה לנתב הגבולות.
מידע נוסף:
otBorderRouterAddRoute
otBorderRouterRegister

otBorderRouterSetNetDataFullCallback

void otBorderRouterSetNetDataFullCallback(
  otInstance *aInstance,
  otBorderRouterNetDataFullCallback aCallback,
  void *aContext
)

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

נדרשת גרסה OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL.

הקריאה החוזרת מופעלת בכל פעם:

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aCallback
הקריאה החוזרת (callback).
[in] aContext
הפניה למידע שרירותי על הקשר שנעשה בו שימוש עם aCallback.

משאבים

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