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 `enum otBorderAgentState` This enumeration defines the Border Agent state.

Functions
`otBorderAgentGetState(otInstance *aInstance)`	`otBorderAgentState` Gets the otBorderAgentState of the Thread Border Agent role.
`otBorderAgentGetUdpPort(otInstance *aInstance)`	`uint16_t` Gets the UDP port of the Thread Border Agent service.

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
)

Gets the otBorderAgentState of the Thread Border Agent role.

Details

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.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

UDP port of the Border Agent.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.