nl::Weave::Profiles::DeviceDescription::DeviceDescriptionClient

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

用于发出设备说明请求的客户端对象。

摘要

构造函数和析构函数
DeviceDescriptionClient(void)

公共类型
HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
此函数负责处理 IdentityResponse 消息。

公共属性
AppState
void *
应用定义的状态对象。
ExchangeMgr
[只读] Exchange 管理员对象
FabricState
[只读] Fabric 状态对象
OnIdentifyResponseReceived

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

公共类型

HandleIdentifyResponseFunct

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

此函数负责处理 IdentityResponse 消息。

详细信息
参数
[in] appState
指向创建 IdentityRequest Exchange Context 时应用定义状态集的指针。
[in] nodeId
消息来源的 Weave 节点 ID。
[in] nodeAddr
做出响应的节点的 IP 地址。
[in] msg
对传入的 IdentityResponse 消息的引用。

公共属性

AppState

void * AppState

应用定义的状态对象。

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[只读] Exchange 管理员对象

FabricState

const WeaveFabricState * FabricState

[只读] Fabric 状态对象

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

公共函数

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

取消正在进行的等待响应的 IdentityRequest 交换。

详细信息
返回值
WEAVE_NO_ERROR
。

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

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

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

详细信息
返回值
WEAVE_ERROR_INCORRECT_STATE
已注册远程被动集合服务器。
WEAVE_NO_ERROR
成功时。

SendIdentifyRequest

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

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

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

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

发送广播 IdentityRequest 消息以发现 Weave 节点。

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

关停

WEAVE_ERROR Shutdown(
  void
)

关闭设备说明客户端。

此函数会关闭所有活跃的 Exchange 上下文并重置指针。通过再次调用 Init 方法，可以重复使用该对象。

详细信息
返回值
WEAVE_NO_ERROR
。