nl::Weave::Profiles::FabricProvisioning::FabricProvisioningServer

#include <src/lib/profiles/fabric-provisioning/FabricProvisioning.h>

用于实现 Fabric 配置配置文件的服务器类。

摘要

继承

继承自： nl::Weave::WeaveServerBase
直接已知子类： nl::Weave::DeviceLayer::Internal::FabricProvisioningServer

构造函数和构造函数
FabricProvisioningServer(void)

受保护的属性
mCurClientOp
mDelegate

公共函数
Init(WeaveExchangeManager *exchangeMgr)
初始化 Fabric 配置服务器状态并注册以接收 Fabric 配置消息。
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
向请求发送状态报告响应。
SendSuccessResponse(void)
virtual WEAVE_ERROR
向 Fabric 配置请求发送成功响应。
SessionHasFabricConfigAccessPrivilege(uint16_t keyId, uint64_t peerNodeId) const
bool
指示具有指定节点 ID 和会话密钥 ID 的会话是否有权检索结构配置信息。
SetDelegate(FabricProvisioningDelegate *delegate)
void
设置委托来处理 Fabric 配置事件。
Shutdown(void)
关停 Fabric 配置服务器。

受保护的属性

mCurClientOp

ExchangeContext * mCurClientOp

mDelegate

FabricProvisioningDelegate * mDelegate

公共函数

FabricProvisioningServer

 FabricProvisioningServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

初始化 Fabric 配置服务器状态并注册以接收 Fabric 配置消息。

详细信息
参数
[in] exchangeMgr
指向系统 Weave Exchange Manager 的指针。
返回值
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
如果已经注册的邮件处理程序过多。
WEAVE_NO_ERROR
成功时。

发送状态报告

virtual WEAVE_ERROR SendStatusReport(
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

向请求发送状态报告响应。

详细信息
参数
[in] statusProfileId
此状态报告所涉及的 Weave 配置文件 ID。
[in] statusCode
要包含在此响应中的状态代码。
[in] sysError
要包含在此响应中的系统错误代码。
返回值
WEAVE_ERROR_INCORRECT_STATE
如果未处理任何请求。
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台错误代码，表示发生错误，导致无法发送状态报告。

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

向 Fabric 配置请求发送成功响应。

详细信息
返回值
WEAVE_ERROR_INCORRECT_STATE
如果未处理任何请求。
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台错误代码，指示发生错误，因此无法发送成功响应。

SessionHasFabricConfigAccessPrivilege

bool SessionHasFabricConfigAccessPrivilege(
  uint16_t keyId,
  uint64_t peerNodeId
) const

指示具有指定节点 ID 和会话密钥 ID 的会话是否有权检索结构配置信息。

详细信息
返回值
如果指定的对等实体拥有特权，则返回 'true' else 'false'。

设置代理

void SetDelegate(
  FabricProvisioningDelegate *delegate
)

设置委托来处理 Fabric 配置事件。

详细信息
参数
[in] delegate
指向 Fabric 配置委托的指针。

关机

WEAVE_ERROR Shutdown(
  void
)

关停 Fabric 配置服务器。

详细信息
返回值
WEAVE_NO_ERROR
无条件。