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

NL::編織::簡介::設備描述::設備描述客戶端

#include <src/lib/profiles/device-description/DeviceDescription.h>

用於發出設備描述請求的客戶端對象。

概括

構造函數和析構函數

DeviceDescriptionClient (void)

公共類型

HandleIdentifyResponseFunct )(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg)類型定義
void(*
該函數負責處理 IdentityResponse 消息。

公共屬性

AppState
void *
應用程序定義的狀態對象。
ExchangeMgr
[只讀] Exchange 管理器對象
FabricState
[只讀] Fabric 狀態對象
OnIdentifyResponseReceived

公共職能

CancelExchange (void)
取消等待響應的正在進行的識別請求交換。
Init ( WeaveExchangeManager *exchangeMgr)
初始化設備描述客戶端狀態。
SendIdentifyRequest (const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
將 IdentityRequest 消息發送到特定的 IP 地址。
SendIdentifyRequest (const IdentifyRequestMessage & msg)
發送廣播標識請求消息以發現 Weave 節點。
Shutdown (void)
關閉設備描述客戶端。

公共類型

處理識別響應函數

void(* HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg)

該函數負責處理 IdentityResponse 消息。

細節
參數
[in] appState
創建 IdentityRequest 交換上下文時指向應用程序定義狀態集的指針。
[in] nodeId
消息源的 Weave 節點 ID。
[in] nodeAddr
響應節點的 IP 地址。
[in] msg
對傳入的 IdentificationResponse 消息的引用。

公共屬性

應用狀態

void * AppState

應用程序定義的狀態對象。

交換管理器

WeaveExchangeManager * ExchangeMgr

[只讀] Exchange 管理器對象

織物狀態

const WeaveFabricState * FabricState

[只讀] Fabric 狀態對象

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

公共職能

取消交換

WEAVE_ERROR CancelExchange(
  void
)

取消等待響應的正在進行的識別請求交換。

細節
返回值
WEAVE_NO_ERROR
無條件。

設備描述客戶端

 DeviceDescriptionClient(
  void
)

在裡面

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

初始化設備描述客戶端狀態。

param[in] exchangeMgr 指向 Weave Exchange Manager 的指針。

細節
返回值
WEAVE_ERROR_INCORRECT_STATE
當遠程被動集合服務器已經註冊時。
WEAVE_NO_ERROR
關於成功。

發送識別請求

WEAVE_ERROR SendIdentifyRequest(
  const IPAddress & nodeAddr,
  const IdentifyRequestMessage & msg
)

將 IdentityRequest 消息發送到特定的 IP 地址。

細節
參數
[in] nodeAddr
對要查詢的 Weave 節點的 IP 地址的引用。
[in] msg
要發送的 IdentityRequest 消息的引用。
返回值
WEAVE_ERROR_NO_MEMORY
如果分配數據包緩衝區的交換上下文失敗。
WEAVE_NO_ERROR
關於成功。
other
其他 Weave 或平台特定的錯誤代碼,表明發生了阻止發送 IdentityRequest 的錯誤。

發送識別請求

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

發送廣播標識請求消息以發現 Weave 節點。

細節
參數
[in] msg
要發送的 IdentityRequest 消息的引用。

關掉

WEAVE_ERROR Shutdown(
  void
)

關閉設備描述客戶端。

此函數關閉任何活動的交換上下文並重置指針。此外,可通過調用被重用初始化再次方法。

細節
返回值
WEAVE_NO_ERROR
無條件。