Backbone Router#

otBackboneRouterState#

otBackboneRouterState

Represents the Backbone Router Status.

otBackboneRouterMulticastListenerEvent#

otBackboneRouterMulticastListenerEvent

Represents the Multicast Listener events.

otBackboneRouterNdProxyEvent#

otBackboneRouterNdProxyEvent

Represents the ND Proxy events.

otBackboneRouterDomainPrefixEvent#

otBackboneRouterDomainPrefixEvent

Represents the Domain Prefix events.

otBackboneRouterConfig#

typedef struct otBackboneRouterConfig otBackboneRouterConfig

This structure represents Backbone Router configuration.

otBackboneRouterMulticastListenerCallback#

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

This function pointer is called whenever the Multicast Listeners change.

otBackboneRouterMulticastListenerIterator#

typedef uint16_t otBackboneRouterMulticastListenerIterator

Used to iterate through Multicast Listeners.

otBackboneRouterMulticastListenerInfo#

typedef struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

This structure represents a Backbone Router Multicast Listener info.

otBackboneRouterNdProxyCallback#

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

This function pointer is called whenever the Nd Proxy changed.

otBackboneRouterNdProxyInfo#

typedef struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo

Represents the Backbone Router ND Proxy info.

otBackboneRouterDomainPrefixCallback#

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

This function pointer is called whenever the Domain Prefix changed.

otBackboneRouterGetPrimary#

otError otBackboneRouterGetPrimary (otInstance * aInstance, otBackboneRouterConfig * aConfig)

This function gets the Primary Backbone Router information in the Thread Network.

otBackboneRouterSetEnabled#

void otBackboneRouterSetEnabled (otInstance * aInstance, bool aEnable)

Enables or disables Backbone functionality.

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

• otBackboneRouterGetState

• otBackboneRouterGetConfig

• otBackboneRouterSetConfig

• otBackboneRouterRegister

otBackboneRouterGetState#

otBackboneRouterState otBackboneRouterGetState (otInstance * aInstance)

Gets the Backbone Router otBackboneRouterState.

See Also

• otBackboneRouterSetEnabled

• otBackboneRouterGetConfig

• otBackboneRouterSetConfig

• otBackboneRouterRegister

otBackboneRouterGetConfig#

void otBackboneRouterGetConfig (otInstance * aInstance, otBackboneRouterConfig * aConfig)

Gets the local Backbone Router configuration.

Available when OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE is enabled.

See Also

• otBackboneRouterSetEnabled

• otBackboneRouterGetState

• otBackboneRouterSetConfig

• otBackboneRouterRegister

otBackboneRouterSetConfig#

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

Sets the local Backbone Router configuration otBackboneRouterConfig.

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

• otBackboneRouterSetEnabled

• otBackboneRouterGetState

• otBackboneRouterGetConfig

• otBackboneRouterRegister

otBackboneRouterRegister#

otError otBackboneRouterRegister (otInstance * aInstance)

Explicitly registers local Backbone Router configuration.

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

• otBackboneRouterSetEnabled

• otBackboneRouterGetState

• otBackboneRouterGetConfig

• otBackboneRouterSetConfig

otBackboneRouterGetRegistrationJitter#

uint8_t otBackboneRouterGetRegistrationJitter (otInstance * aInstance)

This method returns the Backbone Router registration jitter value.

Returns

• The Backbone Router registration jitter value.

See Also

• otBackboneRouterSetRegistrationJitter

otBackboneRouterSetRegistrationJitter#

void otBackboneRouterSetRegistrationJitter (otInstance * aInstance, uint8_t aJitter)

This method sets the Backbone Router registration jitter value.

See Also

• otBackboneRouterGetRegistrationJitter

otBackboneRouterGetDomainPrefix#

otError otBackboneRouterGetDomainPrefix (otInstance * aInstance, otBorderRouterConfig * aConfig)

This method gets the local Domain Prefix configuration.

otBackboneRouterConfigNextDuaRegistrationResponse#

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

This method configures response status for next DUA registration.

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.

otBackboneRouterConfigNextMulticastListenerRegistrationResponse#

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse (otInstance * aInstance, uint8_t aStatus)

Configures the response status for the next Multicast Listener Registration.

Available when OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE, and OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE are enabled.

otBackboneRouterSetMulticastListenerCallback#

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

This method sets the Backbone Router Multicast Listener callback.

otBackboneRouterMulticastListenerClear#

void otBackboneRouterMulticastListenerClear (otInstance * aInstance)

Clears the Multicast Listeners.

Available when OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE, and OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE are enabled.

See Also

• otBackboneRouterMulticastListenerAdd

• otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerAdd#

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

Adds a Multicast Listener with a timeout value, in seconds.

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

• otBackboneRouterMulticastListenerClear

• otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerGetNext#

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

This function gets the next Multicast Listener info (using an iterator).

See Also

• otBackboneRouterMulticastListenerClear

• otBackboneRouterMulticastListenerAdd

otBackboneRouterSetNdProxyCallback#

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

This method sets the Backbone Router ND Proxy callback.

otBackboneRouterGetNdProxyInfo#

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

This method gets the Backbone Router ND Proxy info.

otBackboneRouterSetDomainPrefixCallback#

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

This method sets the Backbone Router Domain Prefix callback.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT#

#define OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT

    0

Initializer for otBackboneRouterMulticastListenerIterator.