Backbone Router#
This module includes functions for the OpenThread Backbone Router Service.
Modules#
otBackboneRouterMulticastListenerInfo
Enumerations#
Represents the Backbone Router Status.
Represents the Multicast Listener events.
Represents the ND Proxy events.
Represents the Domain Prefix events.
Typedefs#
Represents Backbone Router configuration.
Pointer is called whenever the Multicast Listeners change.
Used to iterate through Multicast Listeners.
Represents a Backbone Router Multicast Listener info.
Pointer is called whenever the Nd Proxy changed.
Represents the Backbone Router ND Proxy info.
Pointer is called whenever the Domain Prefix changed.
Functions#
Gets the Primary Backbone Router information in the Thread Network.
Enables or disables Backbone functionality.
Gets the Backbone Router otBackboneRouterState.
Gets the local Backbone Router configuration.
Sets the local Backbone Router configuration otBackboneRouterConfig.
Explicitly registers local Backbone Router configuration.
Returns the Backbone Router registration jitter value.
Sets the Backbone Router registration jitter value.
Gets the local Domain Prefix configuration.
Configures response status for next DUA registration.
Configures the response status for the next Multicast Listener Registration.
Sets the Backbone Router Multicast Listener callback.
Clears the Multicast Listeners.
Adds a Multicast Listener with a timeout value, in seconds.
Gets the next Multicast Listener info (using an iterator).
Sets the Backbone Router ND Proxy callback.
Gets the Backbone Router ND Proxy info.
Sets the Backbone Router Domain Prefix callback.
Macros#
Initializer for otBackboneRouterMulticastListenerIterator.
Enumeration Documentation#
otBackboneRouterState#
otBackboneRouterState
Represents the Backbone Router Status.
Enumerator | |
---|---|
OT_BACKBONE_ROUTER_STATE_DISABLED | Backbone function is disabled. |
OT_BACKBONE_ROUTER_STATE_SECONDARY | Secondary Backbone Router. |
OT_BACKBONE_ROUTER_STATE_PRIMARY | The Primary Backbone Router. |
59
of file include/openthread/backbone_router_ftd.h
otBackboneRouterMulticastListenerEvent#
otBackboneRouterMulticastListenerEvent
Represents the Multicast Listener events.
Enumerator | |
---|---|
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED | Multicast Listener was added. |
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED | Multicast Listener was removed or expired. |
231
of file include/openthread/backbone_router_ftd.h
otBackboneRouterNdProxyEvent#
otBackboneRouterNdProxyEvent
Represents the ND Proxy events.
Enumerator | |
---|---|
OT_BACKBONE_ROUTER_NDPROXY_ADDED | ND Proxy was added. |
OT_BACKBONE_ROUTER_NDPROXY_REMOVED | ND Proxy was removed. |
OT_BACKBONE_ROUTER_NDPROXY_RENEWED | ND Proxy was renewed. |
OT_BACKBONE_ROUTER_NDPROXY_CLEARED | All ND Proxies were cleared. |
340
of file include/openthread/backbone_router_ftd.h
otBackboneRouterDomainPrefixEvent#
otBackboneRouterDomainPrefixEvent
Represents the Domain Prefix events.
Enumerator | |
---|---|
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED | Domain Prefix was added. |
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED | Domain Prefix was removed. |
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED | Domain Prefix was changed. |
403
of file include/openthread/backbone_router_ftd.h
Typedef Documentation#
otBackboneRouterConfig#
typedef struct otBackboneRouterConfig otBackboneRouterConfig
Represents Backbone Router configuration.
64
of file include/openthread/backbone_router.h
otBackboneRouterMulticastListenerCallback#
typedef void(* otBackboneRouterMulticastListenerCallback) (void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) )(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)
Pointer is called whenever the Multicast Listeners change.
[in] | aContext | The user context pointer. |
[in] | aEvent | The Multicast Listener event. |
[in] | aAddress | The IPv6 multicast address of the Multicast Listener. |
245
of file include/openthread/backbone_router_ftd.h
otBackboneRouterMulticastListenerIterator#
typedef uint16_t otBackboneRouterMulticastListenerIterator
Used to iterate through Multicast Listeners.
302
of file include/openthread/backbone_router_ftd.h
otBackboneRouterMulticastListenerInfo#
typedef struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo
Represents a Backbone Router Multicast Listener info.
312
of file include/openthread/backbone_router_ftd.h
otBackboneRouterNdProxyCallback#
typedef void(* otBackboneRouterNdProxyCallback) (void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua) )(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)
Pointer is called whenever the Nd Proxy changed.
[in] | aContext | The user context pointer. |
[in] | aEvent | The ND Proxy event. |
[in] | aDua | The Domain Unicast Address of the ND Proxy, or |
357
of file include/openthread/backbone_router_ftd.h
otBackboneRouterNdProxyInfo#
typedef struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo
Represents the Backbone Router ND Proxy info.
382
of file include/openthread/backbone_router_ftd.h
otBackboneRouterDomainPrefixCallback#
typedef void(* otBackboneRouterDomainPrefixCallback) (void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) )(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)
Pointer is called whenever the Domain Prefix changed.
[in] | aContext | The user context pointer. |
[in] | aEvent | The Domain Prefix event. |
[in] | aDomainPrefix | The new Domain Prefix if added or changed, nullptr otherwise. |
418
of file include/openthread/backbone_router_ftd.h
Function Documentation#
otBackboneRouterGetPrimary#
otError otBackboneRouterGetPrimary (otInstance * aInstance, otBackboneRouterConfig * aConfig)
Gets the Primary Backbone Router information in the Thread Network.
[in] | aInstance | A pointer to an OpenThread instance. |
[out] | aConfig | A pointer to where to put Primary Backbone Router information. |
76
of file include/openthread/backbone_router.h
otBackboneRouterSetEnabled#
void otBackboneRouterSetEnabled (otInstance * aInstance, bool aEnable)
Enables or disables Backbone functionality.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aEnable | TRUE to enable Backbone functionality, FALSE otherwise. |
If enabled, a Server Data Request message SRV_DATA.ntf
is triggered for the attached device if there is no Backbone Router Service in the Thread Network Data.
If disabled, SRV_DATA.ntf
is triggered if the Backbone Router is in the Primary state.
Available when OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
is enabled.
See Also
85
of file include/openthread/backbone_router_ftd.h
otBackboneRouterGetState#
otBackboneRouterState otBackboneRouterGetState (otInstance * aInstance)
Gets the Backbone Router otBackboneRouterState.
[in] | aInstance | A pointer to an OpenThread instance. |
See Also
102
of file include/openthread/backbone_router_ftd.h
otBackboneRouterGetConfig#
void otBackboneRouterGetConfig (otInstance * aInstance, otBackboneRouterConfig * aConfig)
Gets the local Backbone Router configuration.
[in] | aInstance | A pointer to an OpenThread instance. |
[out] | aConfig | A pointer where to put local Backbone Router configuration. |
Available when OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
is enabled.
See Also
119
of file include/openthread/backbone_router_ftd.h
otBackboneRouterSetConfig#
otError otBackboneRouterSetConfig (otInstance * aInstance, const otBackboneRouterConfig * aConfig)
Sets the local Backbone Router configuration otBackboneRouterConfig.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aConfig | A pointer to the Backbone Router configuration to take effect. |
A Server Data Request message SRV_DATA.ntf
is initiated automatically if BBR Dataset changes for Primary Backbone Router.
Available when OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
is enabled.
See Also
141
of file include/openthread/backbone_router_ftd.h
otBackboneRouterRegister#
otError otBackboneRouterRegister (otInstance * aInstance)
Explicitly registers local Backbone Router configuration.
[in] | aInstance | A pointer to an OpenThread instance. |
A Server Data Request message SRV_DATA.ntf
is triggered for the attached device.
Available when OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
is enabled.
See Also
161
of file include/openthread/backbone_router_ftd.h
otBackboneRouterGetRegistrationJitter#
uint8_t otBackboneRouterGetRegistrationJitter (otInstance * aInstance)
Returns the Backbone Router registration jitter value.
N/A | aInstance |
Returns
The Backbone Router registration jitter value.
See Also
171
of file include/openthread/backbone_router_ftd.h
otBackboneRouterSetRegistrationJitter#
void otBackboneRouterSetRegistrationJitter (otInstance * aInstance, uint8_t aJitter)
Sets the Backbone Router registration jitter value.
[in] | aInstance | the Backbone Router registration jitter value to set. |
N/A | aJitter |
See Also
181
of file include/openthread/backbone_router_ftd.h
otBackboneRouterGetDomainPrefix#
otError otBackboneRouterGetDomainPrefix (otInstance * aInstance, otBorderRouterConfig * aConfig)
Gets the local Domain Prefix configuration.
[in] | aInstance | A pointer to an OpenThread instance. |
[out] | aConfig | A pointer to the Domain Prefix configuration. |
193
of file include/openthread/backbone_router_ftd.h
otBackboneRouterConfigNextDuaRegistrationResponse#
void otBackboneRouterConfigNextDuaRegistrationResponse (otInstance * aInstance, const otIp6InterfaceIdentifier * aMlIid, uint8_t aStatus)
Configures response status for next DUA registration.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aMlIid | A pointer to the Mesh Local IID. If NULL, respond with |
[in] | aStatus | The status to respond. |
Note: available only when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
is enabled. Only used for test and certification.
TODO: (DUA) support coap error code and corresponding process for certification purpose.
210
of file include/openthread/backbone_router_ftd.h
otBackboneRouterConfigNextMulticastListenerRegistrationResponse#
void otBackboneRouterConfigNextMulticastListenerRegistrationResponse (otInstance * aInstance, uint8_t aStatus)
Configures the response status for the next Multicast Listener Registration.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aStatus | The status to respond. |
Available when OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
, and OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
are enabled.
225
of file include/openthread/backbone_router_ftd.h
otBackboneRouterSetMulticastListenerCallback#
void otBackboneRouterSetMulticastListenerCallback (otInstance * aInstance, otBackboneRouterMulticastListenerCallback aCallback, void * aContext)
Sets the Backbone Router Multicast Listener callback.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aCallback | A pointer to the Multicast Listener callback. |
[in] | aContext | A user context pointer. |
257
of file include/openthread/backbone_router_ftd.h
otBackboneRouterMulticastListenerClear#
void otBackboneRouterMulticastListenerClear (otInstance * aInstance)
Clears the Multicast Listeners.
[in] | aInstance | A pointer to an OpenThread instance. |
Available when OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
, and OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
are enabled.
See Also
274
of file include/openthread/backbone_router_ftd.h
otBackboneRouterMulticastListenerAdd#
otError otBackboneRouterMulticastListenerAdd (otInstance * aInstance, const otIp6Address * aAddress, uint32_t aTimeout)
Adds a Multicast Listener with a timeout value, in seconds.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aAddress | The Multicast Listener address. |
[in] | aTimeout | The timeout (in seconds) of the Multicast Listener, or 0 to use the default MLR timeout. |
Pass 0
to use the default MLR timeout.
Available when OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
, and OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
are enabled.
See Also
297
of file include/openthread/backbone_router_ftd.h
otBackboneRouterMulticastListenerGetNext#
otError otBackboneRouterMulticastListenerGetNext (otInstance * aInstance, otBackboneRouterMulticastListenerIterator * aIterator, otBackboneRouterMulticastListenerInfo * aListenerInfo)
Gets the next Multicast Listener info (using an iterator).
[in] | aInstance | A pointer to an OpenThread instance. |
[inout] | aIterator | A pointer to the iterator. On success the iterator will be updated to point to next Multicast Listener. To get the first entry the iterator should be set to OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT. |
[out] | aListenerInfo | A pointer to an |
See Also
332
of file include/openthread/backbone_router_ftd.h
otBackboneRouterSetNdProxyCallback#
void otBackboneRouterSetNdProxyCallback (otInstance * aInstance, otBackboneRouterNdProxyCallback aCallback, void * aContext)
Sets the Backbone Router ND Proxy callback.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aCallback | A pointer to the ND Proxy callback. |
[in] | aContext | A user context pointer. |
369
of file include/openthread/backbone_router_ftd.h
otBackboneRouterGetNdProxyInfo#
otError otBackboneRouterGetNdProxyInfo (otInstance * aInstance, const otIp6Address * aDua, otBackboneRouterNdProxyInfo * aNdProxyInfo)
Gets the Backbone Router ND Proxy info.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aDua | The Domain Unicast Address. |
[out] | aNdProxyInfo | A pointer to the ND Proxy info. |
395
of file include/openthread/backbone_router_ftd.h
otBackboneRouterSetDomainPrefixCallback#
void otBackboneRouterSetDomainPrefixCallback (otInstance * aInstance, otBackboneRouterDomainPrefixCallback aCallback, void * aContext)
Sets the Backbone Router Domain Prefix callback.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aCallback | A pointer to the Domain Prefix callback. |
[in] | aContext | A user context pointer. |
429
of file include/openthread/backbone_router_ftd.h