Google is committed to advancing racial equity for Black communities. See how.

Backbone Router

This module includes functions for the OpenThread Backbone Router Service.

Summary

Enumerations

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

Typedefs

otBackboneRouterConfig typedef
This structure represents Backbone Router configuration.

Functions

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

Structs

otBackboneRouterConfig

This structure represents Backbone Router configuration.

Enumerations

otBackboneRouterState

 otBackboneRouterState

Represents the Backbone Router Status.

Properties
OT_BACKBONE_ROUTER_STATE_DISABLED

Backbone function is disabled.

OT_BACKBONE_ROUTER_STATE_PRIMARY

The Primary Backbone Router.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Secondary Backbone Router.

Typedefs

otBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

This structure represents Backbone Router configuration.

Functions

otBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

This function gets the local Backbone Router configuration.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[out] aConfig
A 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.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[out] aConfig
A pointer to the Domain Prefix configuration.
Return Values
OT_ERROR_NONE
Successfully got the Domain Prefix configuration.
OT_ERROR_NOT_FOUND
No Domain Prefix was configured.

otBackboneRouterGetPrimary

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

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

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[out] aConfig
A pointer to where to put Primary Backbone Router information.
Return Values
OT_ERROR_NONE
Successfully got Primary Backbone Router information.
OT_ERROR_NOT_FOUND
No Primary Backbone Router exists.

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

This method returns the Backbone Router registration jitter value.

Details
Returns
The Backbone Router registration jitter value.
See also:
otBackboneRouterSetRegistrationJitter

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

This function gets the Backbone Router state.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Return Values
OT_BACKBONE_ROUTER_STATE_DISABLED
Backbone functionality is disabled.
OT_BACKBONE_ROUTER_STATE_SECONDARY
Secondary Backbone Router.
OT_BACKBONE_ROUTER_STATE_PRIMARY
The Primary Backbone Router.
See also:
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterRegister

otError otBackboneRouterRegister(
  otInstance *aInstance
)

This function explicitly registers local Backbone Router configuration.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Return Values
OT_ERROR_NO_BUFS
Insufficient space to add the Backbone Router service.
OT_ERROR_NONE
Successfully queued a Server Data Request message for delivery.
See also:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

otBackboneRouterSetConfig

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

This function sets the local Backbone Router configuration.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aConfig
A pointer to the Backbone Router configuration to take effect.
Return Values
OT_ERROR_NONE
Successfully updated configuration.
OT_ERROR_INVALID_ARGS
The configuration in aConfig is invalid.
See also:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

This function enables or disables Backbone functionality.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aEnable
TRUE 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.

Details
Parameters
[in] aJitter
the Backbone Router registration jitter value to set.
See also:
otBackboneRouterGetRegistrationJitter