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)
特定の IP アドレスに IdentifyRequest メッセージを送信します。
SendIdentifyRequest(const IdentifyRequestMessage & msg)
ブロードキャストの識別リクエスト メッセージを送信して、Weave ノードを検出します。
Shutdown(void)
Device Description Client をシャットダウンします。

公開タイプ

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
受信した ID レスポンス メッセージへの参照。

パブリック属性

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 Weave Exchange Manager へのポインタ。

詳細
戻り値
WEAVE_ERROR_INCORRECT_STATE
リモートパッシブランデブサーバが登録済みである場合。
WEAVE_NO_ERROR
成功時。

SendIdentifyRequest

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

特定の IP アドレスに IdentifyRequest メッセージを送信します。

詳細
パラメータ
[in] nodeAddr
クエリする Weave ノードの IP アドレスへの参照。
[in] msg
送信する識別リクエスト メッセージへの参照。
戻り値
WEAVE_ERROR_NO_MEMORY
パケット バッファの交換コンテキストの割り当てが失敗した場合。
WEAVE_NO_ERROR
成功時。
other
エラーが発生したため、IdentityRequest を送信できなかったことを示す、その他の Weave またはプラットフォーム固有のエラーコード。

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

ブロードキャストの識別リクエスト メッセージを送信して、Weave ノードを検出します。

詳細
パラメータ
[in] msg
送信する識別リクエスト メッセージへの参照。

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

Device Description Client をシャットダウンします。

この関数は、アクティブな交換コンテキストを閉じて、ポインタをリセットします。このオブジェクトは、Init メソッドを再度呼び出すことで再利用できます。

詳細
戻り値
WEAVE_NO_ERROR
学習します。