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
受信した ID リクエスト メッセージへの参照。
[out] sendResp
レスポンス メッセージをイニシエータに送信する必要がある場合は、true に設定する必要があるブール値への参照。
[out] respMsg
イニシエータに送信される IdentityResponse メッセージへの参照。

パブリック関数

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

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

param[in] exchangeMgr Weave Exchange Manager へのポインタ。

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

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

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

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