נתב גבולות

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

סיכום

פונקציות

otBorderRouterAddOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
הוספת תצורה של נתב גבול לנתוני הרשת המקומית.
otBorderRouterAddRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
הוספת תצורה של נתיב חיצוני לנתוני הרשת המקומית.
otBorderRouterGetNetData(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
השיטה הזו מספקת עותק מלא או יציב של נתוני הרשת המקומית.
otBorderRouterGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
הפונקציה הזו מקבלת את קידומת Mesh הבאה ברשת המקומית.
otBorderRouterGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
הפונקציה הזו מקבלת את הנתיב החיצוני הבא בנתוני הרשת המקומית.
otBorderRouterRegister(otInstance *aInstance)
רשום מיד את נתוני הרשת המקומית ב-Leader.
otBorderRouterRemoveOnMeshPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
מסירים תצורה של נתב גבול מנתוני הרשת המקומית.
otBorderRouterRemoveRoute(otInstance *aInstance, const otIp6Prefix *aPrefix)
מסירים תצורת נתיב חיצוני מנתוני הרשת המקומית.
otBorderRoutingGetNat64Prefix(otInstance *aInstance, otIp6Prefix *aPrefix)
הפונקציה הזו מחזירה את הקידומת NAT64 המקומית.
otBorderRoutingGetOmrPrefix(otInstance *aInstance, otIp6Prefix *aPrefix)
שיטה זו מחזירה את הקידומת "מחוץ לרשת" (OMR).
otBorderRoutingGetOnLinkPrefix(otInstance *aInstance, otIp6Prefix *aPrefix)
שיטה זו מחזירה את הקידומת של הקישור הצמוד לתשתית.
otBorderRoutingInit(otInstance *aInstance, uint32_t aInfraIfIndex, bool aInfraIfIsRunning)
שיטה זו מפעילה את מנהל ניתוב הגבול בממשק הנתון של התשתית.
otBorderRoutingSetEnabled(otInstance *aInstance, bool aEnabled)
שיטה זו מפעילה/משביתה את מנהל ניתוב הגבול.

פונקציות

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
otBorderRouterרישום

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
otBorderRouterרישום

otBorderRouterGetNetData

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

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

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

OTBorderRouterGetNextOnMeshPrefix

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

הפונקציה הזו מקבלת את קידומת Mesh הבאה ברשת המקומית.

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

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
לא קיימת רשומת מסלול חיצונית נוספת בנתוני שרשור הרשת.

otBorderRouterרישום

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
otBorderRouterרישום

OTBorderRouterRemoveRoute

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

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

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

OTBorderRoutingGetNat64Prefix

otError otBorderRoutingGetNat64Prefix(
  otInstance *aInstance,
  otIp6Prefix *aPrefix
)

הפונקציה הזו מחזירה את הקידומת NAT64 המקומית.

ייתכן שהקידומת הזו לא תפורסם ברשת של Thread.

הפונקציה הזו זמינה רק כאשר OPENTHREAD_CONFIG_BORDER_ROUTING_NAT64_ENABLE מופעל.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[out] aPrefix
מצביע למקום שאליו הקידומת תיבחר.
ערכי החזרה
OT_ERROR_INVALID_STATE
מנהל ניתוב הגבול עדיין לא אותחל.
OT_ERROR_NONE
אוחזר בהצלחה את הקידומת NAT64.

OTBorderRoutingGetOmrPrefix

otError otBorderRoutingGetOmrPrefix(
  otInstance *aInstance,
  otIp6Prefix *aPrefix
)

שיטה זו מחזירה את הקידומת "מחוץ לרשת" (OMR).

הקידומת שנוצרת באופן אקראי ב-64 ביט תפורסם ברשת Thread אם אין כבר קידומת OMR.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[out] aPrefix
מצביע למקום שאליו הקידומת תיבחר.
ערכי החזרה
OT_ERROR_INVALID_STATE
מנהל ניתוב הגבול עדיין לא אותחל.
OT_ERROR_NONE
אוחזר בהצלחה את הקידומת OMR.

OTBorderRoutingGetOnLinkPrefix

otError otBorderRoutingGetOnLinkPrefix(
  otInstance *aInstance,
  otIp6Prefix *aPrefix
)

שיטה זו מחזירה את הקידומת של הקישור הצמוד לתשתית.

הקישור ב-64 ביט שנוצר באופן אקראי יפורסם בקישור על התשתית, אם עדיין לא פורסמה בקישור קידומת שניתן להשתמש בה בקישור.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[out] aPrefix
מצביע למקום שאליו הקידומת תיבחר.
ערכי החזרה
OT_ERROR_INVALID_STATE
מנהל ניתוב הגבול עדיין לא אותחל.
OT_ERROR_NONE
אוחזר בהצלחה את הקידומת של הקישור.

otBorderRoutingInit

otError otBorderRoutingInit(
  otInstance *aInstance,
  uint32_t aInfraIfIndex,
  bool aInfraIfIsRunning
)

שיטה זו מפעילה את מנהל ניתוב הגבול בממשק הנתון של התשתית.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in] aInfraIfIndex
אינדקס ממשק התשתית.
[in] aInfraIfIsRunning
ערך בוליאני המציין אם ממשק התשתית פועל.
ערכי החזרה
OT_ERROR_NONE
מנהל ניתוב הגבול בתשתית הנתונה הופעל בהצלחה.
OT_ERROR_INVALID_STATE
מנהל ניתוב הגבול כבר אותחל.
OT_ERROR_INVALID_ARGS
האינדקס של ממשק התשתית לא חוקי.
OT_ERROR_FAILED
שגיאה פנימית. לרוב הסיבה לכך היא יצירת קידומות אקראיות.
ראו גם:
otPlatInfraIfStateChanged.

OTBorderRoutingSetEnabled

otError otBorderRoutingSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

שיטה זו מפעילה/משביתה את מנהל ניתוב הגבול.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in] aEnabled
ערך בוליאני להפעלה/השבתה של מנהל הניתוב.
ערכי החזרה
OT_ERROR_INVALID_STATE
מנהל ניתוב הגבול עדיין לא אותחל.
OT_ERROR_NONE
מנהל ניתוב הגבולות הופעל/הושבת בהצלחה.

מקורות מידע

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