边界代理

此模块包含 Thread Border Agent 角色的函数。

总结

枚举
otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
} 		枚举
定义边界代理状态。

类型定义符
otBorderAgentId typedef
表示边界代理 ID。
otBorderAgentState typedef
定义边界代理状态。

变量
OT_TOOL_PACKED_END

函数
otBorderAgentGetId(otInstance *aInstance, otBorderAgentId *aId)
获取随机生成的边界代理 ID。
otBorderAgentGetState(otInstance *aInstance)
获取 Thread Border Agent 角色的 otBorderAgentState。
otBorderAgentGetUdpPort(otInstance *aInstance)
uint16_t
获取 Thread Border Agent 服务的 UDP 端口。
otBorderAgentSetId(otInstance *aInstance, const otBorderAgentId *aId)
设置边界代理 ID。

结构体
otBorderAgentId

表示边界代理 ID。

枚举

otBorderAgentState

 otBorderAgentState

定义边界代理状态。

属性
OT_BORDER_AGENT_STATE_ACTIVE

边界代理已与外部专员联系。
OT_BORDER_AGENT_STATE_STARTED

已启动边界代理。
OT_BORDER_AGENT_STATE_STOPPED

边界代理角色已停用。

类型定义符

OTBorderAgentId

struct otBorderAgentId otBorderAgentId

表示边界代理 ID。

otBorderAgentState

enum otBorderAgentState otBorderAgentState

定义边界代理状态。

变量

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

函数

OTBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

获取随机生成的边界代理 ID。

该 ID 保存在永久性存储空间中，并会在重新启动后保留。该 ID 的典型用例是在 MeshCoP mDNS 服务中发布为 id TXT 值，供客户端标识此边界路由器/代理设备。

详情
参数
[in] aInstance
指向 OpenThread 实例的指针。
[out] aId
用于接收 ID 的缓冲区指针。
返回值
OT_ERROR_NONE
如果成功检索到边界代理 ID，
...
如果未能检索到边界代理 ID，
另请参阅：
otBorderAgentSetId

otBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

获取 Thread Border Agent 角色的 otBorderAgentState。

详情
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回
边界代理的当前 otBorderAgentState。

otBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

获取 Thread Border Agent 服务的 UDP 端口。

详情
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回
边界代理的 UDP 端口。

otBorderAgentSetId

otError otBorderAgentSetId(
  otInstance *aInstance,
  const otBorderAgentId *aId
)

设置边界代理 ID。

边界代理 ID 将保存在永久性存储空间中，在重新启动后仍然有效。恢复出厂设置后，只需要设置一次 ID。如果未通过调用此函数设置 ID，系统会生成随机 ID，并在调用 otBorderAgentGetId 时返回该 ID。

详情
参数
[in] aInstance
指向 OpenThread 实例的指针。
[out] aId
指向边界代理 ID 的指针。
返回值
OT_ERROR_NONE
如果成功设置，则边界代理 ID。
...
如果未能设置边界代理 ID，
另请参阅：
otBorderAgentGetId

宏

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

边界代理/路由器 ID 的长度（以字节为单位）。

资源

OpenThread API 参考主题源自源代码，可在 GitHub 上获取。 如需了解详情或为我们的文档贡献内容，请参阅资源。