Backbone Router

This module includes functions for the OpenThread Backbone Router Service.

Classes

struct  otBackboneRouterConfig
 This structure represents Backbone Router configuration.

Typedefs

typedef struct otBackboneRouterConfig otBackboneRouterConfig
 This structure represents Backbone Router configuration.

Enumerations

enum  otBackboneRouterState {
  OT_BACKBONE_ROUTER_STATE_DISABLED = 0,
  OT_BACKBONE_ROUTER_STATE_SECONDARY = 1,
  OT_BACKBONE_ROUTER_STATE_PRIMARY = 2
}
 Represents the Backbone Router Status.

Functions

otError otBackboneRouterGetPrimary (otInstance *aInstance, otBackboneRouterConfig *aConfig)
 This function gets the Primary Backbone Router information in the Thread Network.
 
void otBackboneRouterSetEnabled (otInstance *aInstance, bool aEnable)
 This function enables or disables Backbone functionality.
 
otBackboneRouterState otBackboneRouterGetState (otInstance *aInstance)
 This function gets the Backbone Router state.
 
void otBackboneRouterGetConfig (otInstance *aInstance, otBackboneRouterConfig *aConfig)
 This function gets the local Backbone Router configuration.
 
void otBackboneRouterSetConfig (otInstance *aInstance, const otBackboneRouterConfig *aConfig)
 This function sets the local Backbone Router configuration.
 
otError otBackboneRouterRegister (otInstance *aInstance)
 This function explicitly registers local Backbone Router configuration.
 
uint8_t otBackboneRouterGetRegistrationJitter (otInstance *aInstance)
 This method returns the Backbone Router registration jitter value.
 
void otBackboneRouterSetRegistrationJitter (otInstance *aInstance, uint8_t aJitter)
 This method sets the Backbone Router registration jitter value.
 
otError otBackboneRouterGetDomainPrefix (otInstance *aInstance, otBorderRouterConfig *aConfig)
 This method gets the local Domain Prefix configuration.

Detailed Description

This module includes functions for the OpenThread Backbone Router Service.

Enumeration Type Documentation

◆ 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.

Function Documentation

◆ otBackboneRouterGetConfig()

void otBackboneRouterGetConfig ( otInstance aInstance,
otBackboneRouterConfig aConfig 
)

This function gets the local Backbone Router configuration.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[out]aConfigA pointer where to put local Backbone Router configuration.
See also
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterRegister

◆ otBackboneRouterGetDomainPrefix()

otError otBackboneRouterGetDomainPrefix ( otInstance aInstance,
otBorderRouterConfig aConfig 
)

This method gets the local Domain Prefix configuration.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[out]aConfigA pointer to the Domain Prefix configuration.
Return values
OT_ERROR_NONESuccessfully got the Domain Prefix configuration.
OT_ERROR_NOT_FOUNDNo Domain Prefix was configured.

◆ otBackboneRouterGetPrimary()

otError otBackboneRouterGetPrimary ( otInstance aInstance,
otBackboneRouterConfig aConfig 
)

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

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[out]aConfigA pointer to where to put Primary Backbone Router information.
Return values
OT_ERROR_NONESuccessfully got Primary Backbone Router information.
OT_ERROR_NOT_FOUNDNo Primary Backbone Router exists.

◆ 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

◆ otBackboneRouterGetState()

otBackboneRouterState otBackboneRouterGetState ( otInstance aInstance)

This function gets the Backbone Router state.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
Return values
OT_BACKBONE_ROUTER_STATE_DISABLEDBackbone functionality is disabled.
OT_BACKBONE_ROUTER_STATE_SECONDARYSecondary Backbone Router.
OT_BACKBONE_ROUTER_STATE_PRIMARYThe Primary Backbone Router.
See also
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

◆ otBackboneRouterRegister()

otError otBackboneRouterRegister ( otInstance aInstance)

This function explicitly registers local Backbone Router configuration.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
Return values
OT_ERROR_NO_BUFSInsufficient space to add the Backbone Router service.
OT_ERROR_NONESuccessfully queued a Server Data Request message for delivery.
See also
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

◆ otBackboneRouterSetConfig()

void otBackboneRouterSetConfig ( otInstance aInstance,
const otBackboneRouterConfig aConfig 
)

This function sets the local Backbone Router configuration.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aConfigA pointer to the Backbone Router configuration to take effect.
See also
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister

◆ otBackboneRouterSetEnabled()

void otBackboneRouterSetEnabled ( otInstance aInstance,
bool  aEnable 
)

This function enables or disables Backbone functionality.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aEnableTRUE to enable Backbone functionality, FALSE otherwise.
See also
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

◆ otBackboneRouterSetRegistrationJitter()

void otBackboneRouterSetRegistrationJitter ( otInstance aInstance,
uint8_t  aJitter 
)

This method sets the Backbone Router registration jitter value.

Parameters
[in]aJitterthe Backbone Router registration jitter value to set.
See also
otBackboneRouterGetRegistrationJitter