服务器

此模块包含使用 OpenThread Server 管理本地网络数据的功能。

摘要

函数
otServerAddService(otInstance *aInstance, const otServiceConfig *aConfig)	otError 向本地网络数据添加服务配置。
otServerGetNetDataLocal(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)	otError 提供本地 Thread 网络数据的完整或稳定副本。
otServerGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)	otError 获取本地网络数据中的下一个服务。
otServerRegister(otInstance *aInstance)	otError 立即向主要副本注册本地网络数据。
otServerRemoveService(otInstance *aInstance, uint32_t aEnterpriseNumber, const uint8_t *aServiceData, uint8_t aServiceDataLength)	otError 从本地网络数据中移除服务配置。

函数

otServerAddService

otError otServerAddService(
  otInstance *aInstance,
  const otServiceConfig *aConfig
)

向本地网络数据添加服务配置。

具体说明
参数	[in] aInstance 指向 OpenThread 实例的指针。 [in] aConfig 指向服务配置的指针。
返回值	OT_ERROR_NONE 已成功将配置添加到本地网络数据。 OT_ERROR_INVALID_ARGS 一个或多个配置参数无效。 OT_ERROR_NO_BUFS 可用空间不足，无法将配置添加到本地网络数据。

另请参阅：
otServerRemoveService
otServerRegister

otServerGetNetDataLocal

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

提供本地 Thread 网络数据的完整或稳定副本。

具体说明
参数	[in] aInstance 指向 OpenThread 实例的指针。 [in] aStable 如果复制稳定版，则为 TRUE；如果复制完整版本，则为 FALSE。 [out] aData 指向数据缓冲区的指针。 [in,out] aDataLength 条目时，由 aData 指向的数据缓冲区的大小。退出时复制的字节数。

otServerGetNextService

otError otServerGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

获取本地网络数据中的下一个服务。

具体说明
参数	[in] aInstance 指向 OpenThread 实例的指针。 [in,out] aIterator 指向网络数据迭代器上下文的指针。要获取第一个服务条目，应将其设置为 OT_NETWORK_DATA_ITERATOR_INIT。 [out] aConfig 指向服务信息的放置位置的指针。
返回值	OT_ERROR_NONE 成功找到下一项服务。 OT_ERROR_NOT_FOUND Thread 网络数据中没有后续服务。

otServerRegister

otError otServerRegister(
  otInstance *aInstance
)

立即向主要副本注册本地网络数据。

具体说明
参数	[in] aInstance 指向 OpenThread 实例的指针。
返回值	OT_ERROR_NONE 已成功将服务器数据请求消息加入队列等待传送。

另请参阅：
otServerAddService
otServerRemoveService

otServerRemoveService

otError otServerRemoveService(
  otInstance *aInstance,
  uint32_t aEnterpriseNumber,
  const uint8_t *aServiceData,
  uint8_t aServiceDataLength
)

从本地网络数据中移除服务配置。

具体说明
参数	[in] aInstance 指向 OpenThread 实例的指针。 [in] aEnterpriseNumber 要删除的服务条目的企业编号。 [in] aServiceData 指向要在删除期间查找的服务数据的指针。 [in] aServiceDataLength aServiceData 的长度（以字节为单位）。
返回值	OT_ERROR_NONE 已成功从本地网络数据中移除配置。 OT_ERROR_NOT_FOUND 找不到“边界路由器”条目。

另请参阅：
otServerAddService
otServerRegister

资源

OpenThread API 参考文档源自 GitHub 上提供的源代码。如需了解详情，或者为我们的文档做贡献，请参阅资源。