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)
|
typedefvoid(*
この関数は IdentityResponse メッセージを処理します。 |
パブリック属性 |
|
---|---|
AppState
|
void *
アプリケーション定義の状態オブジェクト。
|
ExchangeMgr
|
[読み取り専用] Exchange マネージャー オブジェクト
|
FabricState
|
const WeaveFabricState *
[読み取り専用] ファブリック状態オブジェクト
|
OnIdentifyResponseReceived
|
パブリック関数 |
|
---|---|
CancelExchange(void)
|
応答を待っている進行中の IdentityRequest 交換をキャンセルします。
|
Init(WeaveExchangeManager *exchangeMgr)
|
Device Description クライアントの状態を初期化する。
|
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
|
IdentityRequest メッセージを特定の IP アドレスに送信します。
|
SendIdentifyRequest(const IdentifyRequestMessage & msg)
|
Weave ノードを検出するため、IdentifyRequest ブロードキャスト メッセージを送信します。
|
Shutdown(void)
|
Device Description Client をシャットダウンします。
|
パブリック タイプ
HandleIdentifyResponseFunct
void(* HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg)
この関数は IdentityResponse メッセージを処理します。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
パブリック属性
AppState
void * AppState
アプリケーション定義の状態オブジェクト。
OnIdentifyResponseReceived
HandleIdentifyResponseFunct OnIdentifyResponseReceived
パブリック関数
CancelExchange
WEAVE_ERROR CancelExchange( void )
応答を待っている進行中の IdentityRequest 交換をキャンセルします。
詳細 | |||
---|---|---|---|
戻り値 |
|
DeviceDescriptionClient
DeviceDescriptionClient( void )
init
WEAVE_ERROR Init( WeaveExchangeManager *exchangeMgr )
Device Description クライアントの状態を初期化する。
param[in] exchangeMgr - Weave Exchange マネージャーへのポインタ。
詳細 | |||||
---|---|---|---|---|---|
戻り値 |
|
SendIdentifyRequest
WEAVE_ERROR SendIdentifyRequest( const IPAddress & nodeAddr, const IdentifyRequestMessage & msg )
IdentityRequest メッセージを特定の IP アドレスに送信します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
SendIdentifyRequest
WEAVE_ERROR SendIdentifyRequest( const IdentifyRequestMessage & msg )
Weave ノードを検出するため、IdentifyRequest ブロードキャスト メッセージを送信します。
詳細 | |||
---|---|---|---|
パラメータ |
|
シャットダウン
WEAVE_ERROR Shutdown( void )
Device Description Client をシャットダウンします。
この関数は、アクティブな交換コンテキストをすべて閉じ、ポインタをリセットします。オブジェクトを再利用するには、Init メソッドをもう一度呼び出します。
詳細 | |||
---|---|---|---|
戻り値 |
|