נתב גב
המודול הזה כולל פונקציות של שירות הנתב של OpenThread Backbone.
סיכום
מספור |
|
---|---|
otBackboneRouterDomainPrefixEvent{
|
טיפוסים בני מנייה (enum) האירועים של קידומת הדומיין. |
otBackboneRouterMulticastListenerEvent{
|
טיפוסים בני מנייה (enum) מייצג את אירועי ההאזנה ב-Multicast. |
otBackboneRouterNdProxyEvent{
|
טיפוסים בני מנייה (enum) אירועי ND Proxy. |
otBackboneRouterState{
|
טיפוסים בני מנייה (enum) מייצג את סטטוס נתב השדרה. |
סוג שגיאות |
|
---|---|
otBackboneRouterConfig
|
typedefstruct otBackboneRouterConfig
מייצג את ההגדרות של נתב השדרה. |
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)
|
typedefvoid(*
המצביע נקרא בכל פעם שקידומת הדומיין משתנה. |
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)
|
typedefvoid(*
המצביע מופעל בכל פעם שמאזינים ל-Multicast משתנים. |
otBackboneRouterMulticastListenerInfo
|
typedef מייצג מידע של מאזין נתב RBone. |
otBackboneRouterMulticastListenerIterator
|
typedefuint16_t
משמש לביצוע איטרציה דרך פונקציות האזנה מרובות. |
otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)
|
typedefvoid(*
המצביע נקרא בכל פעם ששרת ה-Nd של שרת ה-proxy משתנה. |
otBackboneRouterNdProxyInfo
|
typedefstruct otBackboneRouterNdProxyInfo
מייצג את המידע על שרת ה-ND Proxy של הנתב האחורי. |
פונקציות |
|
---|---|
otBackboneRouterConfigNextDuaRegistrationResponse(otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
|
void
מגדירה את סטטוס התגובה לרישום הבא ב-DUA.
|
otBackboneRouterConfigNextMulticastListenerRegistrationResponse(otInstance *aInstance, uint8_t aStatus)
|
void
המדיניות הזו קובעת את סטטוס התגובה לרישום הבא של האזנת מולטיקאסט.
|
otBackboneRouterGetConfig(otInstance *aInstance, otBackboneRouterConfig *aConfig)
|
void
מקבל את תצורת הנתב המקומי של Backbone.
|
otBackboneRouterGetDomainPrefix(otInstance *aInstance, otBorderRouterConfig *aConfig)
|
מתקבלת ההגדרה המקומית של קידומת דומיין.
|
otBackboneRouterGetNdProxyInfo(otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
|
לקבלת מידע על שרת ה-ND Proxy של הנתב האחורי.
|
otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig)
|
קבלת המידע של נתב השדרה הראשית ברשת השרשורים.
|
otBackboneRouterGetRegistrationJitter(otInstance *aInstance)
|
uint8_t
מחזירה את ערך הרעידות של נתב ה-Backbone.
|
otBackboneRouterGetState(otInstance *aInstance)
|
מקבל את נתב Backbone otBackboneRouterState.
|
otBackboneRouterMulticastListenerAdd(otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
|
הוספת האזנה מסוג Multicast עם ערך של זמן קצוב לתפוגה בשניות.
|
otBackboneRouterMulticastListenerClear(otInstance *aInstance)
|
void
מנקה את המאזינים של מולטיקאסט.
|
otBackboneRouterMulticastListenerGetNext(otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
|
קבלת המידע הבא לגבי האזנה להקלטת מולטיקאסט (באמצעות איטרציה).
|
otBackboneRouterRegister(otInstance *aInstance)
|
רושם באופן מפורש את הגדרת הנתב המקומי של Backbone.
|
otBackboneRouterSetConfig(otInstance *aInstance, const otBackboneRouterConfig *aConfig)
|
מגדירה את ההגדרה המקומית של נתב Backbone otBackboneRouterConfig.
|
otBackboneRouterSetDomainPrefixCallback(otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
|
void
מגדיר את הקריאה החוזרת (precall) של קידומת הדומיין בנתב הקצה.
|
otBackboneRouterSetEnabled(otInstance *aInstance, bool aEnable)
|
void
הפעלה או השבתה של פונקציית השדרה המרכזית.
|
otBackboneRouterSetMulticastListenerCallback(otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
|
void
מגדיר את הקריאה החוזרת (callback) של הנתב בניתוב לאחור.
|
otBackboneRouterSetNdProxyCallback(otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
|
void
הגדרה של קריאה חוזרת (callback) של נתב Backbone ND Proxy.
|
otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter)
|
void
הגדרה של רעידת הניתוב של נתב הקצה.
|
מבנים |
|
---|---|
otBackboneRouterConfig |
מייצג את ההגדרות של נתב השדרה. |
otBackboneRouterMulticastListenerInfo |
מייצג מידע של מאזין נתב RBone. |
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
|
נוסף גורם מאזין ל-Multicast. |
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED
|
הכלי להאזנה להקלטות מרובות הוסר או שפג תוקפו. |
otBackboneRouterNdProxyEvent
otBackboneRouterNdProxyEvent
אירועי ND Proxy.
נכסים | |
---|---|
OT_BACKBONE_ROUTER_NDPROXY_ADDED
|
שרת proxy ל-ND התווסף. |
OT_BACKBONE_ROUTER_NDPROXY_CLEARED
|
כל שרתי ה-ND proxy נמחקו. |
OT_BACKBONE_ROUTER_NDPROXY_REMOVED
|
שרת proxy ל-ND הוסר. |
OT_BACKBONE_ROUTER_NDPROXY_RENEWED
|
שרת proxy ל-ND חודש. |
otBackboneRouterState
otBackboneRouterState
מייצג את סטטוס נתב השדרה.
נכסים | |
---|---|
OT_BACKBONE_ROUTER_STATE_DISABLED
|
פונקציית משושבת מושבתת. |
OT_BACKBONE_ROUTER_STATE_PRIMARY
|
הנתב הראשי. |
OT_BACKBONE_ROUTER_STATE_SECONDARY
|
נתב משענת משני. |
סוג שגיאות
otBackboneRouterConfig
struct otBackboneRouterConfig otBackboneRouterConfig
מייצג את ההגדרות של נתב השדרה.
otBackboneRouterDomainPrefixCallback
void(* otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)
המצביע נקרא בכל פעם שקידומת הדומיין משתנה.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
otBackboneRouterMulticastListenerCallback
void(* otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)
המצביע מופעל בכל פעם שמאזינים ל-Multicast משתנים.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
otBackboneRouterMulticastListenerInfo
struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo
מייצג מידע של מאזין נתב RBone.
otBackboneRouterMulticastListenerIterator
uint16_t otBackboneRouterMulticastListenerIterator
משמש לביצוע איטרציה דרך פונקציות האזנה מרובות.
otBackboneRouterNdProxyCallback
void(* otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)
המצביע נקרא בכל פעם ששרת ה-Nd של שרת ה-proxy משתנה.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
otBackboneRouterNdProxyInfo
struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo
מייצג את המידע על שרת ה-ND Proxy של הנתב האחורי.
פונקציות
otBackboneRouterConfigNextDuaRegistrationResponse
void otBackboneRouterConfigNextDuaRegistrationResponse( otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus )
מגדירה את סטטוס התגובה לרישום הבא ב-DUA.
הערה: זמין רק כאשר OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
מופעל. משמש רק לבדיקה ולאישור.
משימה לביצוע: (DUA) תמיכה בקוד שגיאה של Coap ובתהליך תואם לצורך האישור.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
otBackboneRouterConfigNextMulticastListenerRegistrationResponse
void otBackboneRouterConfigNextMulticastListenerRegistrationResponse( otInstance *aInstance, uint8_t aStatus )
המדיניות הזו קובעת את סטטוס התגובה לרישום הבא של האזנת מולטיקאסט.
זמין כאשר OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
ו-OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
מופעלות.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
otBackboneRouterGetConfig
void otBackboneRouterGetConfig( otInstance *aInstance, otBackboneRouterConfig *aConfig )
מקבל את תצורת הנתב המקומי של Backbone.
זמין כש-OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
מופעל.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterRegister
otBackboneRouterGetDomainPrefix
otError otBackboneRouterGetDomainPrefix( otInstance *aInstance, otBorderRouterConfig *aConfig )
מתקבלת ההגדרה המקומית של קידומת דומיין.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
||||
ערכי החזרה |
|
otBackboneRouterGetNdProxyInfo
otError otBackboneRouterGetNdProxyInfo( otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo )
לקבלת מידע על שרת ה-ND Proxy של הנתב האחורי.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
ערכי החזרה |
|
otBackboneRouterGetPrimary
otError otBackboneRouterGetPrimary( otInstance *aInstance, otBackboneRouterConfig *aConfig )
קבלת המידע של נתב השדרה הראשית ברשת השרשורים.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
||||
ערכי החזרה |
|
otBackboneRouterGetRegistrationJitter
uint8_t otBackboneRouterGetRegistrationJitter( otInstance *aInstance )
מחזירה את ערך הרעידות של נתב ה-Backbone.
פרטים | |
---|---|
החזרות |
ערך רעידת הנתב של Backbone.
|
otBackboneRouterSetRegistrationJitter
otBackboneRouterGetState
otBackboneRouterState otBackboneRouterGetState( otInstance *aInstance )
מקבל את נתב Backbone otBackboneRouterState.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
ערכי החזרה |
|
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister
otBackboneRouterMulticastListenerAdd
otError otBackboneRouterMulticastListenerAdd( otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout )
הוספת האזנה מסוג Multicast עם ערך של זמן קצוב לתפוגה בשניות.
עליך לעבור 0
כדי להשתמש בברירת המחדל של הזמן הקצוב לשימוש ב-MLR.
זמין כאשר OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
ו-OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
מופעלות.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
ערכי החזרה |
|
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext
otBackboneRouterMulticastListenerClear
void otBackboneRouterMulticastListenerClear( otInstance *aInstance )
מנקה את המאזינים של מולטיקאסט.
זמין כאשר OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
ו-OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
מופעלות.
פרטים | |||
---|---|---|---|
פרמטרים |
|
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext
otBackboneRouterMulticastListenerGetNext
otError otBackboneRouterMulticastListenerGetNext( otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo )
קבלת המידע הבא לגבי האזנה להקלטת מולטיקאסט (באמצעות איטרציה).
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
ערכי החזרה |
|
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd
otBackboneRouterRegister
otError otBackboneRouterRegister( otInstance *aInstance )
רושם באופן מפורש את הגדרת הנתב המקומי של Backbone.
הודעה של בקשת נתוני שרת SRV_DATA.ntf
מופעלת עבור המכשיר המצורף.
זמין כש-OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
מופעל.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
||||
ערכי החזרה |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterSetConfig
otError otBackboneRouterSetConfig( otInstance *aInstance, const otBackboneRouterConfig *aConfig )
מגדירה את ההגדרה המקומית של נתב Backbone otBackboneRouterConfig.
הודעה של בקשת נתוני שרת SRV_DATA.ntf
מופעלת באופן אוטומטי אם מערך הנתונים הראשי של BBR משתנה עבור נתב השדרה הראשי.
זמין כש-OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
מופעל.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
||||
ערכי החזרה |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister
otBackboneRouterSetDomainPrefixCallback
void otBackboneRouterSetDomainPrefixCallback( otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext )
מגדיר את הקריאה החוזרת (precall) של קידומת הדומיין בנתב הקצה.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
otBackboneRouterSetEnabled
void otBackboneRouterSetEnabled( otInstance *aInstance, bool aEnable )
הפעלה או השבתה של פונקציית השדרה המרכזית.
אם האפשרות SRV_DATA.ntf
מופעלת, תוצג בקשה לבקשה של נתוני שרת עבור המכשיר המצורף אם אין שירות נתב של Backbone בנתונים של רשת Thread.
מושבת, SRV_DATA.ntf
מופעל אם נתב השדרה נמצא במצב 'ראשי'.
זמין כש-OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
מופעל.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister
otBackboneRouterSetMulticastListenerCallback
void otBackboneRouterSetMulticastListenerCallback( otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext )
מגדיר את הקריאה החוזרת (callback) של הנתב בניתוב לאחור.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
otBackboneRouterSetNdProxyCallback
void otBackboneRouterSetNdProxyCallback( otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext )
הגדרה של קריאה חוזרת (callback) של נתב Backbone ND Proxy.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
otBackboneRouterSetRegistrationJitter
void otBackboneRouterSetRegistrationJitter( otInstance *aInstance, uint8_t aJitter )
הגדרה של רעידת הניתוב של נתב הקצה.
פרטים | |||
---|---|---|---|
פרמטרים |
|
otBackboneRouterGetRegistrationJitter
פקודות מאקרו
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0
אתחול עבור otBackboneRouterMulticastListenerIterator.
משאבים
הנושאים של קובצי העזר של OpenThread API מגיעים מקוד המקור, והם זמינים ב-GitHub. למידע נוסף או כדי לתרום למסמכי התיעוד שלנו, יש לעיין בקטע משאבים.