NL::编织：：简介::设备描述::设备描述客户端

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

用于发出设备描述请求的客户端对象。

概括

构造函数和析构函数

DeviceDescriptionClient (void)

公共类型

HandleIdentifyResponseFunct )(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg)类型定义
void(*
该函数负责处理 IdentityResponse 消息。

公共属性

AppState
void *
应用程序定义的状态对象。
ExchangeMgr
[只读] Exchange 管理器对象
FabricState
[只读] Fabric 状态对象
OnIdentifyResponseReceived

公共职能

CancelExchange (void)
取消等待响应的正在进行的识别请求交换。
Init ( WeaveExchangeManager *exchangeMgr)
初始化设备描述客户端状态。
SendIdentifyRequest (const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
将 IdentityRequest 消息发送到特定的 IP 地址。
SendIdentifyRequest (const IdentifyRequestMessage & msg)
发送广播标识请求消息以发现 Weave 节点。
Shutdown (void)
关闭设备描述客户端。

公共类型

处理识别响应函数

void(* HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg)

该函数负责处理 IdentityResponse 消息。

细节
参数
[in] appState
创建 IdentityRequest 交换上下文时指向应用程序定义状态集的指针。
[in] nodeId
消息源的 Weave 节点 ID。
[in] nodeAddr
响应节点的 IP 地址。
[in] msg
对传入的 IdentificationResponse 消息的引用。

公共属性

应用状态

void * AppState

应用程序定义的状态对象。

交换管理器

WeaveExchangeManager * ExchangeMgr

[只读] Exchange 管理器对象

织物状态

const WeaveFabricState * FabricState

[只读] Fabric 状态对象

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

公共职能

取消交换

WEAVE_ERROR CancelExchange(
  void
)

取消等待响应的正在进行的识别请求交换。

细节
返回值
WEAVE_NO_ERROR
无条件。

设备描述客户端

 DeviceDescriptionClient(
  void
)

在里面

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

初始化设备描述客户端状态。

param[in] exchangeMgr 指向 Weave Exchange Manager 的指针。

细节
返回值
WEAVE_ERROR_INCORRECT_STATE
当远程被动集合服务器已经注册时。
WEAVE_NO_ERROR
在成功。

发送识别请求

WEAVE_ERROR SendIdentifyRequest(
  const IPAddress & nodeAddr,
  const IdentifyRequestMessage & msg
)

将 IdentityRequest 消息发送到特定的 IP 地址。

细节
参数
[in] nodeAddr
对要查询的 Weave 节点的 IP 地址的引用。
[in] msg
要发送的 IdentityRequest 消息的引用。
返回值
WEAVE_ERROR_NO_MEMORY
如果分配数据包缓冲区的交换上下文失败。
WEAVE_NO_ERROR
在成功。
other
其他 Weave 或平台特定的错误代码，表明发生了阻止发送 IdentityRequest 的错误。

发送识别请求

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

发送广播标识请求消息以发现 Weave 节点。

细节
参数
[in] msg
要发送的 IdentityRequest 消息的引用。

关掉

WEAVE_ERROR Shutdown(
  void
)

关闭设备描述客户端。

此函数关闭任何活动的交换上下文并重置指针。此外，可通过调用被重用初始化再次方法。

细节
返回值
WEAVE_NO_ERROR
无条件。