nl ::織り::プロファイル:: 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) | 応答を待っている進行中のIdentifyRequest交換をキャンセルします。 |
Init ( WeaveExchangeManager *exchangeMgr) | デバイス記述クライアントの状態を初期化します。 |
SendIdentifyRequest (const IPAddress & nodeAddr, const IdentifyRequestMessage & msg) | 特定のIPアドレスにIdentifyRequestメッセージを送信します。 |
SendIdentifyRequest (const IdentifyRequestMessage & msg) | ブロードキャストIdentifyRequestメッセージを送信して、Weaveノードを検出します。 |
Shutdown (void) | デバイス記述クライアントをシャットダウンします。 |
パブリックタイプ
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 )
応答を待っている進行中のIdentifyRequest交換をキャンセルします。
詳細 | |||
---|---|---|---|
戻り値 |
|
DeviceDescriptionClient
DeviceDescriptionClient( void )
初期化
WEAVE_ERROR Init( WeaveExchangeManager *exchangeMgr )
デバイス記述クライアントの状態を初期化します。
param [in] exchangeMgr Weave ExchangeManagerへのポインター。
詳細 | |||||
---|---|---|---|---|---|
戻り値 |
|
SendIdentifyRequest
WEAVE_ERROR SendIdentifyRequest( const IPAddress & nodeAddr, const IdentifyRequestMessage & msg )
特定のIPアドレスにIdentifyRequestメッセージを送信します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメーター |
| ||||||
戻り値 |
|
SendIdentifyRequest
WEAVE_ERROR SendIdentifyRequest( const IdentifyRequestMessage & msg )
ブロードキャストIdentifyRequestメッセージを送信して、Weaveノードを検出します。
詳細 | |||
---|---|---|---|
パラメーター |
|
シャットダウン
WEAVE_ERROR Shutdown( void )
デバイス記述クライアントをシャットダウンします。
この関数は、アクティブな交換コンテキストをすべて閉じ、ポインターをリセットします。オブジェクトは、呼び出すことで再利用できるのInit再び方法を。
詳細 | |||
---|---|---|---|
戻り値 |
|