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 的布林值參照,如果應將回應訊息傳送至啟動器,該布林值就應設為 true。
[out] respMsg
要傳送給發起者的 IdentityResponse 訊息參考資料。

公用函式

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

初始化裝置說明伺服器狀態,並註冊以接收裝置說明訊息。

param[in] exchangeMgr A 指標,指向 Weave Exchange Manager。

詳細說明
傳回值
WEAVE_ERROR_INCORRECT_STATE
已註冊遠端被動路由伺服器。
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
註冊來路不明的訊息處理常式。
WEAVE_NO_ERROR
成功時。

關機

WEAVE_ERROR Shutdown(
  void
)

關閉裝置說明伺服器。

詳細說明
傳回值
WEAVE_NO_ERROR
不受條件限制