nl::Weave::Profiles::DeviceDescription::DeviceDescriptionClient

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

發出裝置說明要求的用戶端物件。

摘要

建構函式和解構函式
DeviceDescriptionClient(void)

公開類型
HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
這個函式會處理 IdentityResponse 訊息。

公開屬性
AppState
void *
應用程式定義的狀態物件。
ExchangeMgr
[僅供讀取] Exchange 管理員物件
FabricState
[僅供閱讀] 織品狀態物件
OnIdentifyResponseReceived

公用函式
CancelExchange(void)
取消處理中的 IdentityRequest 交換作業，等待回覆。
Init(WeaveExchangeManager *exchangeMgr)
初始化裝置說明用戶端狀態。
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
將 IdentityRequest 訊息傳送至特定 IP 位址。
SendIdentifyRequest(const IdentifyRequestMessage & msg)
傳送廣播的 FindRequest 訊息來探索 Weave 節點。
Shutdown(void)
關閉裝置說明用戶端。

公開類型

HandleIdentifyResponseFunct

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

這個函式會處理 IdentityResponse 訊息。

詳細說明
參數
[in] appState
指向建立 IdentityRequest Exchange 結構定義時設定的應用程式定義狀態的指標。
[in] nodeId
郵件來源的 Weave 節點 ID。
[in] nodeAddr
回應節點的 IP 位址。
[in] msg
傳入的 IdentityResponse 訊息的參考資料。

公開屬性

AppState

void * AppState

應用程式定義的狀態物件。

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[僅供讀取] Exchange 管理員物件

FabricState

const WeaveFabricState * FabricState

[僅供閱讀] 織品狀態物件

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

公用函式

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

取消處理中的 IdentityRequest 交換作業，等待回覆。

詳細說明
傳回值
WEAVE_NO_ERROR
不受條件限制

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

初始化裝置說明用戶端狀態。

param[in] exchangeMgr A 指標，指向 Weave Exchange Manager。

詳細說明
傳回值
WEAVE_ERROR_INCORRECT_STATE
已註冊遠端被動路由伺服器。
WEAVE_NO_ERROR
成功時。

SendIdentifyRequest

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 無法傳送。

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

傳送廣播的 FindRequest 訊息來探索 Weave 節點。

詳細說明
參數
[in] msg
要傳送的 IdentityRequest 訊息參考資料。

關機

WEAVE_ERROR Shutdown(
  void
)

關閉裝置說明用戶端。

這個函式會關閉所有有效的廣告交易平台結構定義，並重設指標。您可再次呼叫 Init 方法來重複使用物件。

詳細說明
傳回值
WEAVE_NO_ERROR
不受條件限制