נתב עצם

מודול זה כולל פונקציות לשירות OpenThread Backbout Router.

סיכום

הדמיות

otBackboneRouterDomainPrefixEvent{
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED = 0,
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED = 1,
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED = 2
}
טיפוסים בני מנייה (enum)
מייצג את האירועים עם קידומת הדומיין.
otBackboneRouterMulticastListenerEvent{
  OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED = 0,
  OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED = 1
}
טיפוסים בני מנייה (enum)
מייצג את האירועים של Multicast.
otBackboneRouterNdProxyEvent{
  OT_BACKBONE_ROUTER_NDPROXY_ADDED = 0,
  OT_BACKBONE_ROUTER_NDPROXY_REMOVED = 1,
  OT_BACKBONE_ROUTER_NDPROXY_RENEWED = 2,
  OT_BACKBONE_ROUTER_NDPROXY_CLEARED = 3
}
טיפוסים בני מנייה (enum)
מייצג את אירועי ה-ND Proxy.
otBackboneRouterState{
  OT_BACKBONE_ROUTER_STATE_DISABLED = 0,
  OT_BACKBONE_ROUTER_STATE_SECONDARY = 1,
  OT_BACKBONE_ROUTER_STATE_PRIMARY = 2
}
טיפוסים בני מנייה (enum)
מייצג את הסטטוס של נתב השדרה.

סוג מגן

otBackboneRouterConfig typedef
המבנה הזה מייצג את תצורת הנתב של Backbone.
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) typedef
void(*
קריאה לפונקציה הזו נקראת בכל פעם שהקידומת של הדומיין השתנתה.
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) typedef
void(*
קריאה לפונקציה הזו משתנה בכל פעם שמאזינים לשידורים מרובים.
otBackboneRouterMulticastListenerInfo typedef
מבנה זה מייצג מידע לגבי מעבד שידורים מרובים של נתב גב.
otBackboneRouterMulticastListenerIterator typedef
uint16_t
כדי לבצע איטרציה באמצעות מעבדי Multicast.
otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua) typedef
void(*
קריאה לפונקציה הזו נקראת בכל פעם ש-Nd Proxy השתנה.
otBackboneRouterNdProxyInfo typedef
מייצג את המידע על שרת ה-ND Proxy.

פונקציות

otBackboneRouterConfigNextDuaRegistrationResponse(otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
void
שיטה זו מגדירה את סטטוס התגובה להרשמה הבאה מסוג DUA.
otBackboneRouterConfigNextMulticastListenerRegistrationResponse(otInstance *aInstance, uint8_t aStatus)
void
שיטה זו מגדירה את סטטוס התגובה להרשמה הבאה של Multicast listener.
otBackboneRouterGetConfig(otInstance *aInstance, otBackboneRouterConfig *aConfig)
void
הפונקציה הזו מקבלת את התצורה של נתב ה-Backbone המקומי.
otBackboneRouterGetDomainPrefix(otInstance *aInstance, otBorderRouterConfig *aConfig)
שיטה זו מקבלת את התצורה המקומית של קידומת של דומיין.
otBackboneRouterGetNdProxyInfo(otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
שיטה זו מקבלת את ה-Proxy של נתב ה-ND בפרטי שרת ה-Proxy.
otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig)
הפונקציה הזו מקבלת את מידע הנתב של עמוד השדרה הראשי ברשת של שרשור.
otBackboneRouterGetRegistrationJitter(otInstance *aInstance)
uint8_t
שיטה זו מחזירה את ערך הרעידות בהרשמה של הנתב.
otBackboneRouterGetState(otInstance *aInstance)
הפונקציה הזו מקבלת את המצב של נתב השדרה.
otBackboneRouterMulticastListenerAdd(otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
שיטה זו מוסיפה מעבד Multicast.
otBackboneRouterMulticastListenerClear(otInstance *aInstance)
void
שיטה זו מנקה מעבדי Multicast.
otBackboneRouterMulticastListenerGetNext(otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
הפונקציה הזו מקבלת את המידע הבא של Multicast listener (באמצעות איטרטור).
otBackboneRouterRegister(otInstance *aInstance)
הפונקציה הזו רושמת במפורש את נתב הנתב המקומי המקומי.
otBackboneRouterSetConfig(otInstance *aInstance, const otBackboneRouterConfig *aConfig)
הפונקציה הזו מגדירה את תצורת הנתב המקומי המקומי.
otBackboneRouterSetDomainPrefixCallback(otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
void
שיטה זו מגדירה את הקריאה החוזרת בקידומת הדומיין של הנתב Backbone.
otBackboneRouterSetEnabled(otInstance *aInstance, bool aEnable)
void
פונקציה זו מפעילה או משביתה את פונקציית Backbone.
otBackboneRouterSetMulticastListenerCallback(otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
שיטה זו מגדירה את ה-callback של נתב Multibone Router.
otBackboneRouterSetNdProxyCallback(otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
void
שיטה זו מגדירה את הקריאה החוזרת לשרת ה-Proxy ND של ה-Backbone.
otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter)
void
שיטה זו מגדירה את ערך הרעידות בהרשמה של הנתב.

שטרטס

otBackboneRouterConfig

המבנה הזה מייצג את תצורת הנתב של Backbone.

otBackboneRouterMulticastListenerInfo

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

otBackboneRouterNdProxyInfo

מייצג את המידע על שרת ה-ND Proxy.

הדמיות

otBackboneRouterDomainPrefixEvent

 otBackboneRouterDomainPrefixEvent

מייצג את האירועים עם קידומת הדומיין.

מאפיינים
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED

הוספת קידומת של דומיין.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED

קידומת הדומיין השתנתה.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED

קידומת הדומיין הוסרה.

otBackboneRouterMulticastListenerEvent

 otBackboneRouterMulticastListenerEvent

מייצג את האירועים של Multicast.

מאפיינים
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED

נוסף מעבד שידורים מרובים.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

התכונה Multicast listener הוסרה או שפג תוקפה.

otBackboneRouterNdProxyEvent

 otBackboneRouterNdProxyEvent

מייצג את אירועי ה-ND Proxy.

מאפיינים
OT_BACKBONE_ROUTER_NDPROXY_ADDED

נוסף שרת proxy של ND.

OT_BACKBONE_ROUTER_NDPROXY_CLEARED

כל שרתי ה-ND proxy נמחקו.

OT_BACKBONE_ROUTER_NDPROXY_REMOVED

ND Proxy הוסר.

OT_BACKBONE_ROUTER_NDPROXY_RENEWED

ND Proxy חודש.

otBackboneRouterState

 otBackboneRouterState

מייצג את הסטטוס של נתב השדרה.

מאפיינים
OT_BACKBONE_ROUTER_STATE_DISABLED

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

OT_BACKBONE_ROUTER_STATE_PRIMARY

נתב עמוד השדרה הראשי.

OT_BACKBONE_ROUTER_STATE_SECONDARY

נתב עמוד שדרה משני.

סוג מגן

otBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

המבנה הזה מייצג את תצורת הנתב של Backbone.

otBackboneRouterDomainPrefixCallback

void(* otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)

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

פרטים
פרמטרים
[in] aContext
המצביע על הקשר המשתמש.
[in] aEvent
אירוע התחילית של הדומיין.
[in] aDomainPrefix
התחילית החדשה של דומיין אם נוספה או שונתה, nullptr אחרת.

otBackboneRouterMulticastListenerCallback

void(* otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)

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

פרטים
פרמטרים
[in] aContext
המצביע על הקשר המשתמש.
[in] aEvent
אירוע Multicast listener.
[in] aAddress
כתובת שידור לקבוצה ב-IPv6 של ה-castcast של שידורים מרובים.

otBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

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

otBackboneRouterMulticastListenerIterator

uint16_t otBackboneRouterMulticastListenerIterator

כדי לבצע איטרציה באמצעות מעבדי Multicast.

otBackboneRouterNdProxyCallback

void(* otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)

קריאה לפונקציה הזו נקראת בכל פעם ש-Nd Proxy השתנה.

פרטים
פרמטרים
[in] aContext
המצביע על הקשר המשתמש.
[in] aEvent
האירוע ND Proxy.
[in] aDua
כתובת ה-Unicast של הדומיין של שרת ה-Proxy מסוג ND, או nullptr אם הערך של aEvent הוא OT_BACKBONE_ROUTER_NDPROXY_CLEARED.

otBackboneRouterNdProxyInfo

struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo

מייצג את המידע על שרת ה-ND Proxy.

פונקציות

otBackboneRouterConfigNextDuaRegistrationResponse

void otBackboneRouterConfigNextDuaRegistrationResponse(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aMlIid,
  uint8_t aStatus
)

שיטה זו מגדירה את סטטוס התגובה להרשמה הבאה מסוג DUA.

הערה: האפשרות הזו זמינה רק כאשר OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE מופעל. משמש לבדיקה ולאישור בלבד.

GCP: (DUA) הוא תמיכה בקוד שגיאה של קואפ ותהליך תואם למטרת אישור.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in] aMlIid
מצביע ל-IDI מקומי של Mesh. אם NULL, הגיבו עם aStatus לכל DUA.req שיתרחש, אחרת תענו רק את זה עם aMlIid תואם.
[in] aStatus
הסטטוס לתגובה.

otBackboneRouterConfigNextMulticastListenerRegistrationResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

שיטה זו מגדירה את סטטוס התגובה להרשמה הבאה של Multicast listener.

הערה: האפשרות הזו זמינה רק כאשר OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE מופעל. משמש לבדיקה ולאישור בלבד.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in] aStatus
הסטטוס לתגובה.

otBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[out] aConfig
מצביע למיקום הגדרת התצורה של הנתב המקומי.
מידע נוסף:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterרישום

otBackboneRouterGetDomainPrefix

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

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

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

otBackboneRouterGetNdProxyInfo

otError otBackboneRouterGetNdProxyInfo(
  otInstance *aInstance,
  const otIp6Address *aDua,
  otBackboneRouterNdProxyInfo *aNdProxyInfo
)

שיטה זו מקבלת את ה-Proxy של נתב ה-ND בפרטי שרת ה-Proxy.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in] aDua
כתובת Unicast של הדומיין.
[out] aNdProxyInfo
מצביע למידע על שרת ה-ND Proxy.
ערכי החזרה
OT_ERROR_NONE
הפרטים של ה-ND Proxy התקבלו בהצלחה.
OT_ERROR_NOT_FOUND
איתור כתובת ה-Unicast של הדומיין נכשל בטבלת ND Proxy.

otBackboneRouterGetPrimary

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

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

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

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

שיטה זו מחזירה את ערך הרעידות בהרשמה של הנתב.

פרטים
החזרות
ערך הרעידות ברישום ה-Backbone.
מידע נוסף:
otBackboneRouterSetRegistrationJitter

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
ערכי החזרה
OT_BACKBONE_ROUTER_STATE_DISABLED
פונקציונליות עמוד השדרה מושבתת.
OT_BACKBONE_ROUTER_STATE_SECONDARY
נתב עמוד שדרה משני.
OT_BACKBONE_ROUTER_STATE_PRIMARY
נתב עמוד השדרה הראשי.
מידע נוסף:
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterרישום

otBackboneRouterMulticastListenerAdd

otError otBackboneRouterMulticastListenerAdd(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint32_t aTimeout
)

שיטה זו מוסיפה מעבד Multicast.

הערה: האפשרות הזו זמינה רק כאשר OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE מופעל. משמש לבדיקה ולאישור בלבד.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in] aAddress
הכתובת של המאזינים Multicast.
[in] aTimeout
הזמן הקצוב לתפוגה (בשניות) של ה-Multicast listener, או 0 כדי להשתמש בברירת המחדל של הזמן הקצוב לתפוגה של MLR.
ערכי החזרה
OT_ERROR_NONE
אם ה-Multicast listener נוסף בהצלחה.
OT_ERROR_INVALID_ARGS
אם כתובת ה-Multicast של המאזינים לא הייתה חוקית.
OT_ERROR_NO_BUFS
אין שטח פנוי לשמירת ה-castcast של שידור.
לעיונך:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerClear

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

שיטה זו מנקה מעבדי Multicast.

הערה: האפשרות הזו זמינה רק כאשר OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE מופעל. משמש לבדיקה ולאישור בלבד.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
לעיונך:
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerGetNext

otError otBackboneRouterMulticastListenerGetNext(
  otInstance *aInstance,
  otBackboneRouterMulticastListenerIterator *aIterator,
  otBackboneRouterMulticastListenerInfo *aListenerInfo
)

הפונקציה הזו מקבלת את המידע הבא של Multicast listener (באמצעות איטרטור).

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in,out] aIterator
מצביע לאיטרטור. בהצלחה, האיטרטור יעודכן כך שיצביע על המאזינים הבאים לשידור מרובה שידורים. כדי לקבל את הערך הראשון, יש להגדיר את האיטרטור ל-OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT.
[out] aListenerInfo
מצביע ל-otBackboneRouterMulticastListenerInfo שבו נמצא המידע בנוגע למעבד הבא משודרג (בהצלחה).
ערכי החזרה
OT_ERROR_NONE
פרטי ה-Listencast הבאים (aListenerInfo) עודכנו בהצלחה.
OT_ERROR_NOT_FOUND
לא נמצאו מידע נוסף של מאזינים מרובים בשידור חי.
לעיונך:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

רישום otBackboneRouter

otError otBackboneRouterRegister(
  otInstance *aInstance
)

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
ערכי החזרה
OT_ERROR_NO_BUFS
אין מספיק מקום כדי להוסיף את שירות הנתב של Backbone.
OT_ERROR_NONE
הודעת בקשת נתונים של שרת הועברה בהצלחה להגשה.
מידע נוסף:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

otBackboneRouterSetConfig

otError otBackboneRouterSetConfig(
  otInstance *aInstance,
  const otBackboneRouterConfig *aConfig
)

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

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

otBackboneRouterSetDomainPrefixCallback

void otBackboneRouterSetDomainPrefixCallback(
  otInstance *aInstance,
  otBackboneRouterDomainPrefixCallback aCallback,
  void *aContext
)

שיטה זו מגדירה את הקריאה החוזרת בקידומת הדומיין של הנתב Backbone.

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

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in] aEnable
TRUE כדי להפעיל פונקציונליות Backbone, אחרת FALSE.
מידע נוסף:
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterרישום

otBackboneRouterSetMulticastListenerCallback

void otBackboneRouterSetMulticastListenerCallback(
  otInstance *aInstance,
  otBackboneRouterMulticastListenerCallback aCallback,
  void *aContext
)

שיטה זו מגדירה את ה-callback של נתב Multibone Router.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in] aCallback
מצביע ל-callback של Multicast.
[in] aContext
מצביע הקשר למשתמש.

otBackboneRouterSetNdProxyCallback

void otBackboneRouterSetNdProxyCallback(
  otInstance *aInstance,
  otBackboneRouterNdProxyCallback aCallback,
  void *aContext
)

שיטה זו מגדירה את הקריאה החוזרת לשרת ה-Proxy ND של ה-Backbone.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in] aCallback
הצבעה חוזרת ל-ND Proxy.
[in] aContext
מצביע הקשר למשתמש.

otBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

שיטה זו מגדירה את ערך הרעידות בהרשמה של הנתב.

פרטים
פרמטרים
[in] aJitter
ערך הרעידה של רישום הנתב בשדרה השנייה.
מידע נוסף:
otBackboneRouterGetRegistrationJitter

פקודות מאקרו

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT

 OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0

מאתחל עבור otBackboneRouterMulticastListenerIterator.

מקורות מידע

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