骨幹路由器
這個模組包含 OpenThread Backbone 路由器服務的函式。
摘要
列舉 |
|
---|---|
otBackboneRouterDomainPrefixEvent{
|
列舉 代表網域前置字串事件。 |
otBackboneRouterMulticastListenerEvent{
|
列舉 代表 Multicast 事件監聽器事件。 |
otBackboneRouterNdProxyEvent{
|
列舉 代表 ND Proxy 事件。 |
otBackboneRouterState{
|
列舉 代表中樞路由器狀態。 |
Typedefs |
|
---|---|
otBackboneRouterConfig
|
typedefstruct otBackboneRouterConfig
代表 Backbone 路由器設定。 |
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)
|
typedefvoid(*
每當「網域前置字串」變更時,系統就會呼叫指標。 |
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)
|
typedefvoid(*
當 Multicast 事件監聽器變更時,系統會呼叫指標。 |
otBackboneRouterMulticastListenerInfo
|
typedef 代表中樞路由器多點監聽器資訊。 |
otBackboneRouterMulticastListenerIterator
|
typedefuint16_t
用於透過 Multicast 事件監聽器疊代疊代。 |
otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)
|
typedefvoid(*
每次 Nd Proxy 變更時,系統都會呼叫指標。 |
otBackboneRouterNdProxyInfo
|
typedefstruct otBackboneRouterNdProxyInfo
代表 Backbone Router ND Proxy 資訊。 |
結構 |
|
---|---|
otBackboneRouterConfig |
代表 Backbone 路由器設定。 |
otBackboneRouterMulticastListenerInfo |
代表中樞路由器多點監聽器資訊。 |
otBackboneRouterNdProxyInfo |
代表 Backbone Router 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
|
多播監聽器已移除或已過期。 |
otBackboneRouterNdProxyEvent
otBackboneRouterNdProxyEvent
代表 ND Proxy 事件。
屬性 | |
---|---|
OT_BACKBONE_ROUTER_NDPROXY_ADDED
|
已新增 ND Proxy。 |
OT_BACKBONE_ROUTER_NDPROXY_CLEARED
|
已清除所有 NDK 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
|
主要 Backbone 路由器 |
OT_BACKBONE_ROUTER_STATE_SECONDARY
|
次要中樞路由器。 |
Typedefs
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
代表中樞路由器多點監聽器資訊。
otBackboneRouterMulticastListenerIterator
uint16_t otBackboneRouterMulticastListenerIterator
用於透過 Multicast 事件監聽器疊代疊代。
otBackboneRouterNdProxyCallback
void(* otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)
每次 Nd Proxy 變更時,系統都會呼叫指標。
詳細說明 | |||||||
---|---|---|---|---|---|---|---|
參數 |
|
otBackboneRouterNdProxyInfo
struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo
代表 Backbone Router ND Proxy 資訊。
執行作業
otBackboneRouterConfigNextDuaRegistrationResponse
void otBackboneRouterConfigNextDuaRegistrationResponse(
otInstance *aInstance,
const otIp6InterfaceIdentifier *aMlIid,
uint8_t aStatus
)
設定下一個 DUA 註冊的回應狀態。
注意:只有在啟用 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
時才能使用。僅用於測試和認證。
TODO:(DUA) 支援代碼錯誤代碼和對應的程序。
詳細說明 | |||||||
---|---|---|---|---|---|---|---|
參數 |
|
otBackboneRouterConfigNextMulticastListenerRegistrationResponse
void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
otInstance *aInstance,
uint8_t aStatus
)
設定下一個 Multicast Listener 註冊的回應狀態。
啟用 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
)
取得 Backbone Router ND Proxy 資訊。
詳細說明 | |||||||
---|---|---|---|---|---|---|---|
參數 |
|
||||||
回傳值 |
|
otBackboneRouterGetPrimary
otError otBackboneRouterGetPrimary(
otInstance *aInstance,
otBackboneRouterConfig *aConfig
)
取得 Thread 網路中的主要中樞路由器資訊。
詳細說明 | |||||
---|---|---|---|---|---|
參數 |
|
||||
回傳值 |
|
otBackboneRouterGetRegistrationJitter
uint8_t otBackboneRouterGetRegistrationJitter(
otInstance *aInstance
)
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
)
清除 Multicast 事件監聽器。
啟用 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
)
明確註冊本機中樞路由器設定。
連接的裝置觸發了伺服器資料要求訊息 SRV_DATA.ntf
。
啟用 OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
後才能使用。
詳細說明 | |||||
---|---|---|---|---|---|
參數 |
|
||||
回傳值 |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterSetConfig
otError otBackboneRouterSetConfig(
otInstance *aInstance,
const otBackboneRouterConfig *aConfig
)
設定本機 Backbone 路由器設定 otBackboneRouterConfig。
如果主要 Backbone 路由器的 BBR 資料集變更,系統會自動啟動伺服器資料要求訊息 SRV_DATA.ntf
。
啟用 OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
後才能使用。
詳細說明 | |||||
---|---|---|---|---|---|
參數 |
|
||||
回傳值 |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister
otBackboneRouterSetDomainPrefixCallback
void otBackboneRouterSetDomainPrefixCallback(
otInstance *aInstance,
otBackboneRouterDomainPrefixCallback aCallback,
void *aContext
)
設定 Backbone Router 網域前置字串回呼。
詳細說明 | |||||||
---|---|---|---|---|---|---|---|
參數 |
|
otBackboneRouterSetEnabled
void otBackboneRouterSetEnabled(
otInstance *aInstance,
bool aEnable
)
啟用或停用 Backbone 功能。
啟用後,如果 Thread 網路資料中沒有 Backbone 路由器服務,就會為連接的裝置觸發伺服器資料要求訊息 SRV_DATA.ntf
。
如果停用這項設定,且 Backbone 路由器處於「主要」狀態,則系統會觸發 SRV_DATA.ntf
。
啟用 OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
後才能使用。
詳細說明 | |||||
---|---|---|---|---|---|
參數 |
|
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister
otBackboneRouterSetMulticastListenerCallback
void otBackboneRouterSetMulticastListenerCallback(
otInstance *aInstance,
otBackboneRouterMulticastListenerCallback aCallback,
void *aContext
)
設定 Backbone Router Multicast 事件監聽器回呼。
詳細說明 | |||||||
---|---|---|---|---|---|---|---|
參數 |
|
otBackboneRouterSetNdProxyCallback
void otBackboneRouterSetNdProxyCallback(
otInstance *aInstance,
otBackboneRouterNdProxyCallback aCallback,
void *aContext
)
設定 Backbone Router ND Proxy 回呼。
詳細說明 | |||||||
---|---|---|---|---|---|---|---|
參數 |
|
otBackboneRouterSetRegistrationJitter
void otBackboneRouterSetRegistrationJitter(
otInstance *aInstance,
uint8_t aJitter
)
設定 Backbone Router 註冊時基誤差值。
詳細說明 | |||
---|---|---|---|
參數 |
|
otBackboneRouterGetRegistrationJitter
巨集
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0
otBackboneRouterMulticastListenerIterator 的初始化工具。
資源
OpenThread API 參考資料主題源自原始碼,可於 GitHub 取得。如需更多資訊或為說明文件貢獻心力,請參閱資源。