NL::编织：：简介::设备描述::设备描述服务器

#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)类型定义
void(*

公共属性

AppState
void *
应用程序定义的状态指针为回调提供上下文。
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
该函数负责处理 IdentityRequest 消息。

公共职能

Init ( WeaveExchangeManager *exchangeMgr)
初始化设备描述服务器状态并注册以接收设备描述消息。
Shutdown (void)
关闭设备描述服务器。

公共类型

处理标识请求函数

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

公共属性

应用状态

void * AppState

应用程序定义的状态指针为回调提供上下文。

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

该函数负责处理 IdentityRequest 消息。

细节
参数
[in] appState
注册接收此类消息时指向应用程序定义状态集的指针。
[in] nodeId
消息源的 Weave 节点 ID。
[in] nodeAddr
消息源的 IP 地址。
[in] reqMsg
对传入的 IdentificationRequest 消息的引用。
[out] sendResp
如果应将响应消息发送到发起者，则对布尔值的引用应设置为 true。
[out] respMsg
对要发送给发起者的识别响应消息的引用。

公共职能

设备描述服务器

 DeviceDescriptionServer(
  void
)

在里面

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
无条件。