This module includes functions for the OpenThread Backbone Router Service. More...
Data Structures | |
struct | otBackboneRouterConfig |
Typedefs | |
typedef struct otBackboneRouterConfig | otBackboneRouterConfig |
Enumerations | |
enum | otBackboneRouterState { OT_BACKBONE_ROUTER_STATE_DISABLED = 0, OT_BACKBONE_ROUTER_STATE_SECONDARY = 1, OT_BACKBONE_ROUTER_STATE_PRIMARY = 2 } |
Functions | |
otError | otBackboneRouterGetPrimary (otInstance *aInstance, otBackboneRouterConfig *aConfig) |
void | otBackboneRouterSetEnabled (otInstance *aInstance, bool aEnable) |
otBackboneRouterState | otBackboneRouterGetState (otInstance *aInstance) |
void | otBackboneRouterGetConfig (otInstance *aInstance, otBackboneRouterConfig *aConfig) |
void | otBackboneRouterSetConfig (otInstance *aInstance, const otBackboneRouterConfig *aConfig) |
otError | otBackboneRouterRegister (otInstance *aInstance) |
uint8_t | otBackboneRouterGetRegistrationJitter (otInstance *aInstance) |
void | otBackboneRouterSetRegistrationJitter (otInstance *aInstance, uint8_t aJitter) |
This module includes functions for the OpenThread Backbone Router Service.
typedef struct otBackboneRouterConfig otBackboneRouterConfig |
This structure represents Backbone Router configuration.
void otBackboneRouterGetConfig | ( | otInstance * | aInstance, |
otBackboneRouterConfig * | aConfig | ||
) |
This function 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. |
otError otBackboneRouterGetPrimary | ( | otInstance * | aInstance, |
otBackboneRouterConfig * | aConfig | ||
) |
This function 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. |
OT_ERROR_NONE | Successfully got Primary Backbone Router information. |
OT_ERROR_NOT_FOUND | No Primary Backbone Router exists. |
uint8_t otBackboneRouterGetRegistrationJitter | ( | otInstance * | aInstance | ) |
This method returns the Backbone Router registration jitter value.
otBackboneRouterState otBackboneRouterGetState | ( | otInstance * | aInstance | ) |
This function gets the Backbone Router state.
[in] | aInstance | A pointer to an OpenThread instance. |
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. |
otError otBackboneRouterRegister | ( | otInstance * | aInstance | ) |
This function explicitly registers local Backbone Router configuration.
[in] | aInstance | A pointer to an OpenThread instance. |
OT_ERROR_NO_BUFS | Insufficient space to add the Backbone Router service. |
OT_ERROR_NONE | Successfully queued a Server Data Request message for delivery. |
void otBackboneRouterSetConfig | ( | otInstance * | aInstance, |
const otBackboneRouterConfig * | aConfig | ||
) |
This function sets the local Backbone Router configuration.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aConfig | A pointer to the Backbone Router configuration to take effect. |
void otBackboneRouterSetEnabled | ( | otInstance * | aInstance, |
bool | aEnable | ||
) |
This function enables or disables Backbone functionality.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aEnable | TRUE to enable Backbone functionality, FALSE otherwise. |
void otBackboneRouterSetRegistrationJitter | ( | otInstance * | aInstance, |
uint8_t | aJitter | ||
) |
This method sets the Backbone Router registration jitter value.
[in] | aJitter | the Backbone Router registration jitter value to set. |