Border Agent
This module includes functions for the Thread Border Agent role.
Summary
Enumerations |
|
---|---|
otBorderAgentState{
|
enum This enumeration defines the Border Agent state. |
Typedefs |
|
---|---|
otBorderAgentState
|
typedefenum otBorderAgentState
This enumeration defines the Border Agent state. |
Functions |
|
---|---|
otBorderAgentGetId(otInstance *aInstance, uint8_t *aId, uint16_t *aLength)
|
Gets the randomly generated Border Agent ID.
|
otBorderAgentGetState(otInstance *aInstance)
|
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
Typedefs
otBorderAgentState
enum otBorderAgentState otBorderAgentState
This enumeration defines the Border Agent state.
Functions
otBorderAgentGetId
otError otBorderAgentGetId( otInstance *aInstance, uint8_t *aId, uint16_t *aLength )
Gets the randomly generated Border Agent ID.
The ID is saved in persistent storage and survives reboots. The typical use case of the ID is to be published in the MeshCoP mDNS service as the id
TXT value for the client to identify this Border Router/Agent device.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otBorderAgentGetState
otBorderAgentState otBorderAgentGetState( otInstance *aInstance )
Gets the otBorderAgentState of the Thread Border Agent role.
Details | |||
---|---|---|---|
Parameters |
|
||
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 |
|
||
Returns |
UDP port of the Border Agent.
|
Macros
OT_BORDER_AGENT_ID_LENGTH
OT_BORDER_AGENT_ID_LENGTH (16)
The length of Border Agent/Router ID in bytes.
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.