透過集合功能整理內容 你可以依據偏好儲存及分類內容。

邊界路由器

這個模組包含使用 OpenThread Border Router 管理本機網路資料的功能。

摘要

函式

otBorderRouterAddOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
在本機邊界資料中新增邊界路由器設定。
otBorderRouterAddRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
將外部路徑設定新增至本機網路資料。
otBorderRouterGetNetData(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
此方法可提供完整或穩定的本機執行緒網路資料副本。
otBorderRouterGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
這個函式會在本機網路資料中取得下一個「網狀網路前置字串」。
otBorderRouterGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
此函式會在本機網路資料中取得下一個外部路徑。
otBorderRouterRegister(otInstance *aInstance)
立即向當地領導者註冊當地網路資料。
otBorderRouterRemoveOnMeshPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
移除本機網路資料中的邊界路由器設定。
otBorderRouterRemoveRoute(otInstance *aInstance, const otIp6Prefix *aPrefix)
從本機網路資料中移除外部路徑設定。

函式

otBorderRouterAddOnMeshPrefix

otError otBorderRouterAddOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

在本機邊界資料中新增邊界路由器設定。

詳情
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aConfig
邊界路由器設定的遊標。
傳回值
OT_ERROR_NONE
已成功將設定新增至本機網路資料。
OT_ERROR_INVALID_ARGS
一或多個設定參數無效。
OT_ERROR_NO_BUFS
可用空間不足,無法新增本機網路資料。
另請參閱:
otBorderRouterRemoveOnMeshPrefix
otBorderRouterRegister

otBorderRouterAddRoute

otError otBorderRouterAddRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

將外部路徑設定新增至本機網路資料。

詳情
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aConfig
指向外部路徑設定的指標。
傳回值
OT_ERROR_NONE
已成功將設定新增至本機網路資料。
OT_ERROR_INVALID_ARGS
一或多個設定參數無效。
OT_ERROR_NO_BUFS
可用空間不足,無法新增本機網路資料。
另請參閱:
otBorderRouterRemoveRoute
otBorderRouterRegister

otBorderRouterGetNetData

otError otBorderRouterGetNetData(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

此方法可提供完整或穩定的本機執行緒網路資料副本。

詳情
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aStable
複製穩定版時為 TRUE,複製完整版本時為 FALSE。
[out] aData
指向資料緩衝區的指標。
[in,out] aDataLength
輸入時,資料緩衝區的大小指向 aData。結束時,複製的位元組數。

otBorderRouterGetNextOnMeshPrefix

otError otBorderRouterGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

這個函式會在本機網路資料中取得下一個「網狀網路前置字串」。

詳情
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in,out] aIterator
網路資料疊代器的內容。如要取得第一個網狀項目,請將其設為 OT_NETWORK_DATA_ITERATOR_INIT。
[out] aConfig
指向「網狀網路前置字串」資訊的指標。
傳回值
OT_ERROR_NONE
成功找到下一個「網格」前置字串。
OT_ERROR_NOT_FOUND
執行緒網路資料中沒有後續的網狀網格前置字串。

otBorderRouterGetNextRoute

otError otBorderRouterGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

此函式會在本機網路資料中取得下一個外部路徑。

詳情
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in,out] aIterator
網路資料疊代器的內容。如要取得第一個外部路徑項目,請將其設為 OT_NETWORK_DATA_ITERATOR_INIT。
[out] aConfig
指向外部路徑資訊的指標。
傳回值
OT_ERROR_NONE
已成功找到下一個外部路徑。
OT_ERROR_NOT_FOUND
執行緒網路資料中沒有後續的外部路徑項目。

otBorderRouterRegister

otError otBorderRouterRegister(
  otInstance *aInstance
)

立即向當地領導者註冊當地網路資料。

詳情
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
傳回值
OT_ERROR_NONE
已成功將伺服器資料要求訊息加入佇列。
另請參閱:
otBorderRouterAddOnMeshPrefix
otBorderRouterRemoveOnMeshPrefix
otBorderRouterAddRoute
otBorderRouterRemoveRoute

otBorderRouterRemoveOnMeshPrefix

otError otBorderRouterRemoveOnMeshPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

移除本機網路資料中的邊界路由器設定。

詳情
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aPrefix
IPv6 前置字串的指標。
傳回值
OT_ERROR_NONE
已成功將設定從本機網路資料中移除。
OT_ERROR_NOT_FOUND
找不到邊界路由器項目。
另請參閱:
otBorderRouterAddOnMeshPrefix
otBorderRouterRegister

otBorderRouterRemoveRoute

otError otBorderRouterRemoveRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

從本機網路資料中移除外部路徑設定。

詳情
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aPrefix
IPv6 前置字串的指標。
傳回值
OT_ERROR_NONE
已成功將設定從本機網路資料中移除。
OT_ERROR_NOT_FOUND
找不到邊界路由器項目。
另請參閱:
otBorderRouterAddRoute
otBorderRouterRegister

資源

OpenThread API 參考主題源自原始碼,可從 GitHub 取得。如要瞭解詳情或參閱說明文件,請參閱資源