Google 致力于为黑人社区推动种族平等。查看具体行动

边界路由器

此模块包含使用 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)
此函数会获取本地网络数据中的下一个 On Mesh 前缀。
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
)

此函数会获取本地网络数据中的下一个 On Mesh 前缀。

详情
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in,out] aIterator
指向网络数据迭代器上下文的指针。如需获取第一个网状条目,应将其设置为 OT_NETWORK_DATA_ITERATOR_INIT。
[out] aConfig
指向网状网前缀信息的指针。
返回值
OT_ERROR_NONE
成功找到下一个 On Mesh 前缀。
OT_ERROR_NOT_FOUND
线程网络数据中没有后续的 On Mesh 前缀。

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 上的源代码。 如需了解详情或为我们的文档做贡献,请参阅资源