nl ：：織り::プロファイル:: DeviceDescription ：： DeviceDescriptionServer

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

デバイス記述要求に応答するためのサーバーオブジェクト。

概要

継承

：から継承NL ::織り:: WeaveServerBase
直系の既知のサブクラス： NL ::織り:: DeviceLayer ::内部:: DeviceDescriptionServer

コンストラクタとデストラクタ

DeviceDescriptionServer (void)

パブリックタイプ

HandleIdentifyRequestFunct )(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg) typedef
void(*

公開属性

AppState
void *
コールバックのコンテキストを提供するアプリケーション定義の状態ポインター。
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
この関数は、IdentityRequestメッセージの処理を担当します。

公の行事

Init ( WeaveExchangeManager *exchangeMgr)
デバイス記述サーバーの状態を初期化し、デバイス記述メッセージを受信するように登録します。
Shutdown (void)
デバイス記述サーバーをシャットダウンします。

パブリックタイプ

HandleIdentifyRequestFunct

void(* HandleIdentifyRequestFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg)

公開属性

AppState

void * AppState

コールバックのコンテキストを提供するアプリケーション定義の状態ポインター。

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

この関数は、IdentityRequestメッセージの処理を担当します。

詳細
パラメーター
[in] appState
このタイプのメッセージを受信するために登録するときに設定されるアプリケーション定義の状態へのポインター。
[in] nodeId
メッセージソースのウィーブノードID。
[in] nodeAddr
メッセージソースのIPアドレス。
[in] reqMsg
着信IdentifyRequestメッセージへの参照。
[out] sendResp
応答メッセージをイニシエーターに送信する必要がある場合にtrueに設定する必要があるブール値への参照。
[out] respMsg
イニシエーターに送信されるIdentifyResponseメッセージへの参照。

公の行事

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

初期化

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

デバイス記述サーバーの状態を初期化し、デバイス記述メッセージを受信するように登録します。

param [in] exchangeMgr Weave ExchangeManagerへのポインター。

詳細
戻り値
WEAVE_ERROR_INCORRECT_STATE
リモートパッシブランデブーサーバーがすでに登録されている場合。
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
登録されている未承諾メッセージハンドラーが多すぎる場合。
WEAVE_NO_ERROR
成功時。

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

デバイス記述サーバーをシャットダウンします。

詳細
戻り値
WEAVE_NO_ERROR
無条件に。