This module includes functions for the Thread Border Agent role.

Typedefs
typedef enum otBorderAgentState	otBorderAgentState
	This enumeration defines the Border Agent state.

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

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

Detailed Description

This module includes functions for the Thread Border Agent role.

Enumeration Type Documentation

This enumeration defines the Border Agent state.

Enumerator
OT_BORDER_AGENT_STATE_STOPPED	Border agent role is disabled.
OT_BORDER_AGENT_STATE_STARTED	Border agent is started.
OT_BORDER_AGENT_STATE_ACTIVE	Border agent is connected with external commissioner.

otBorderAgentState otBorderAgentGetState ( otInstance * aInstance )

This function gets the state of Thread Border Agent role.

Parameters

[in] aInstance A pointer to an OpenThread instance.