Border Agent
API > Thread

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)
Gets the otBorderAgentState of the Thread Border Agent role.
uint16_t otBorderAgentGetUdpPort ( otInstance *aInstance)
Gets the UDP port of the Thread Border Agent service.

Detailed Description

This module includes functions for the Thread Border Agent role.

Enumeration Type Documentation

◆ otBorderAgentState

enum otBorderAgentState

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.

Function Documentation

◆ otBorderAgentGetState()

otBorderAgentState otBorderAgentGetState ( otInstance * aInstance )

Gets the otBorderAgentState of the Thread Border Agent role.

Parameters
[in] aInstance A pointer to an OpenThread instance.
Returns
The current otBorderAgentState of the Border Agent.

◆ otBorderAgentGetUdpPort()

uint16_t otBorderAgentGetUdpPort ( otInstance * aInstance )

Gets the UDP port of the Thread Border Agent service.

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