nl::Weave::Profiles::DeviceDescription::DeviceDescriptionServer

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

デバイス説明リクエストに応答するためのサーバー オブジェクト。

概要

継承

継承元: nl::Weave::WeaveServerBase
直接的な既知のサブクラス: nl::Weave::DeviceLayer::Internal::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
メッセージ ソースの Weave ノード ID。
[in] nodeAddr
メッセージ送信元の IP アドレス。
[in] reqMsg
受信した IdentityRequest メッセージへの参照。
[out] sendResp
レスポンス メッセージをイニシエータに送信する必要がある場合は true に設定する必要があるブール値への参照。
[out] respMsg
イニシエータに送信される identityResponse メッセージへの参照。

パブリック関数

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

デバイス説明サーバーの状態を初期化し、デバイス説明メッセージを受け取るよう登録します。

param[in] exchangeMgr - Weave Exchange マネージャーへのポインタ。

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

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

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

詳細
戻り値
WEAVE_NO_ERROR
作成できます。