伺服器

這個模組包含的函式可使用 OpenThread 伺服器管理本機網路資料。

摘要

函式

otServerAddService(otInstance *aInstance, const otServiceConfig *aConfig)
將服務設定新增至區域網路資料。
otServerGetNetDataLocal(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
這個方法可提供本機執行緒網路資料的完整或穩定版副本。
otServerGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
這個函式會取得區域網路資料中的下一個服務。
otServerRegister(otInstance *aInstance)
立即向領導人註冊區域網路資料。
otServerRemoveService(otInstance *aInstance, uint32_t aEnterpriseNumber, const uint8_t *aServiceData, uint8_t aServiceDataLength)
移除區域網路資料的服務設定。

函式

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
)

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

說明
參數
[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
執行緒網路資料中沒有任何後續服務。

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。 如需更多資訊或參閱我們的說明文件,請參閱資源