Border Agent

This module includes functions for the Thread Border Agent role.

Summary

Enumerations

otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
}
enum
This enumeration defines the Border Agent state.

Typedefs

otBorderAgentState typedef
This enumeration defines the Border Agent state.

Functions

otBorderAgentGetState(otInstance *aInstance)
This function gets the state of Thread Border Agent role.

Enumerations

otBorderAgentState

 otBorderAgentState

This enumeration defines the Border Agent state.

Properties
OT_BORDER_AGENT_STATE_ACTIVE

Border agent is connected with external commissioner.

OT_BORDER_AGENT_STATE_STARTED

Border agent is started.

OT_BORDER_AGENT_STATE_STOPPED

Border agent role is disabled.

Typedefs

otBorderAgentState

enum otBorderAgentState otBorderAgentState

This enumeration defines the Border Agent state.

Functions

otBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

This function gets the state of Thread Border Agent role.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
State of the Border Agent.