Symbols ![]()
loading...
Files ![]()
loading (2/5)...
ot::MeshCoP::BorderAgent::GetId() method
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.
Syntax
Implemented in ![]()
border_agent.cpp:258
Return value
kErrorNone If successfully retrieved the Border Agent ID. ... If failed to retrieve the Border Agent ID.
Related Functions
Found 4 other functions taking a ![]()
otBorderAgentId
argument:
Function
Description
Gets the randomly generated Border Agent ID. Requires `OPENTHREAD_CONFIG_BORDER_AGENT_ID_ENABLE`. 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. @sa otBorderAgentSetId
Sets the Border Agent ID. Requires `OPENTHREAD_CONFIG_BORDER_AGENT_ID_ENABLE`. The Border Agent ID will be saved in persistent storage and survive reboots. It's required to set the ID only once after factory reset. If the ID has never been set by calling this function, a random ID will be generated and returned when `otBorderAgentGetId` is called. @sa otBorderAgentGetId
Sets the Border Agent ID. The Border Agent ID will be saved in persistent storage and survive reboots. It's required to set the ID only once after factory reset. If the ID has never been set by calling this method, a random ID will be generated and returned when `GetId()` is called.
References
Code
Location
Data Use
ot::MeshCoP::BorderAgent::GetId() reads 3 variables and writes 1 variable: