Function openthread_sys::otBorderAgentGetId

source ·

pub unsafe extern "C" fn otBorderAgentGetId(
    aInstance: *mut otInstance,
    aId: *mut otBorderAgentId
) -> otError

Expand 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.

@param[in] aInstance A pointer to an OpenThread instance. @param[out] aId A pointer to buffer to receive the ID.

@retval OT_ERROR_NONE If successfully retrieved the Border Agent ID. @retval … If failed to retrieve the Border Agent ID.

@sa otBorderAgentSetId