框線代理程式

這個模組包含 Thread 邊界代理程式的角色，

摘要

列舉
otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
} 		列舉
定義邊界代理程式狀態。

Typedefs
otBorderAgentId typedef
代表邊界代理程式 ID。
otBorderAgentState typedef
定義邊界代理程式狀態。

Variables
OT_TOOL_PACKED_END

函式
otBorderAgentGetId(otInstance *aInstance, otBorderAgentId *aId)
取得隨機產生的邊界代理程式 ID。
otBorderAgentGetState(otInstance *aInstance)
取得 Thread Border 代理程式角色的 otBorderAgentState。
otBorderAgentGetUdpPort(otInstance *aInstance)
uint16_t
取得 Thread 邊界代理程式服務的 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

框線代理程式角色已停用。

Typedefs

otBorderAgentId

struct otBorderAgentId otBorderAgentId

代表邊界代理程式 ID。

otBorderAgentState

enum otBorderAgentState otBorderAgentState

定義邊界代理程式狀態。

Variables

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

函式

otBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

取得隨機產生的邊界代理程式 ID。

這組 ID 會儲存在永久儲存空間中，而且重新啟動後仍然有效。典型的 ID 用途，就是在 BigtableCoP mDNS 服務中發布 id TXT 值，供用戶端識別這個邊界路由器/代理程式裝置。

詳細說明
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[out] aId
指向接收緩衝區來接收 ID 的指標。
回傳值
OT_ERROR_NONE
如果成功擷取邊界代理程式 ID，
...
如果無法擷取邊界代理程式 ID，
另請參閱：
otBorderAgentSetId

otBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

取得 Thread Border 代理程式角色的 otBorderAgentState。

詳細說明
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
傳回
Border 代理程式目前的 otBorderAgentState。

otBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

取得 Thread 邊界代理程式服務的 UDP 通訊埠。

詳細說明
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
傳回
邊界代理程式的 UDP 通訊埠。

otBorderAgentSetId

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

設定邊界代理程式 ID。

Border 代理程式 ID 會儲存在永久儲存空間中，並在重新啟動後繼續保留。恢復原廠設定後，只需設定一次 ID。如果從未透過呼叫此函式來設定 ID，系統會在呼叫 otBorderAgentGetId 時產生一個隨機 ID，並傳回。

詳細說明
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[out] aId
指向邊界代理程式 ID 的指標。
回傳值
OT_ERROR_NONE
如果已設定 Border 代理程式 ID，即可成功設定。
...
如果無法設定邊界代理程式 ID。
另請參閱：
otBorderAgentGetId

巨集

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

邊界服務專員/路由器 ID 的長度，以位元組為單位。

資源

OpenThread API 參考資料主題源自原始碼，可於 GitHub 取得。如需更多資訊或為說明文件貢獻心力，請參閱資源。