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] switchMgr 指向 Weave Exchange Manager 的指针。

详细信息
返回值
WEAVE_ERROR_INCORRECT_STATE
已注册远程被动集合服务器。
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
注册过多未经请求的消息处理程序时。
WEAVE_NO_ERROR
成功时。

关停

WEAVE_ERROR Shutdown(
  void
)

关闭设备描述服务器。

详细信息
返回值
WEAVE_NO_ERROR
。