nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningDelegate

这是一个抽象类。

#include <src/lib/profiles/network-provisioning/NetworkProvisioning.h>

用于实现网络配置操作的委托类。

摘要

继承

继承自： nl::Weave::WeaveServerDelegateBase
已知直接子类：
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< NetworkProvisioningServerImpl< NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::InternalImpl:

公共属性
Server
[只读] 此委托附加到的服务器对象。

公共函数
EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
对传入的网络配置请求消息强制执行消息级访问权限控制。
HandleAddNetwork(PacketBuffer *networkInfoTLV)=0
virtual WEAVE_ERROR
添加特定网络。
HandleDisableNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
停用指定的网络。
HandleEnableNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
启用指定的网络。
HandleGetNetworks(uint8_t flags)=0
virtual WEAVE_ERROR
获取已配置的网络。
HandleGetWirelessRegulatoryConfig(void)
virtual WEAVE_ERROR
获取无线监管配置信息。
HandleRemoveNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
移除已配置的网络。
HandleScanNetworks(uint8_t networkType)=0
virtual WEAVE_ERROR
执行网络扫描。
HandleSetRendezvousMode(uint16_t rendezvousMode)=0
virtual WEAVE_ERROR
设置约会模式。
HandleSetWirelessRegulatoryConfig(PacketBuffer *regConfigTLV)
virtual WEAVE_ERROR
设置无线监管配置信息。
HandleTestConnectivity(uint32_t networkId)=0
virtual WEAVE_ERROR
测试指定网络的连接情况。
HandleUpdateNetwork(PacketBuffer *networkInfoTLV)=0
virtual WEAVE_ERROR
更新网络的配置。
IsPairedToAccount() const
virtual bool
已进行调用以确定设备当前是否与某个账户配对。

公共属性

服务器

NetworkProvisioningServer * Server

[只读] 此委托附加到的服务器对象。

公共函数

EnforceAccessControl

virtual void EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  AccessControlResult & result
)

对传入的网络配置请求消息强制执行消息级访问权限控制。

具体说明
参数
[in] ec
接收邮件的 ExchangeContext。
[in] msgProfileId
所收到消息的个人资料 ID。
[in] msgType
所收到消息的消息类型。
[in] msgInfo
WeaveMessageInfo 结构，包含有关所收到消息的信息。
[in,out] result
一个枚举值，用于描述收到的消息的访问权限控制政策评估结果。进入该方法后，该值表示当前评估流程中的暂定结果。返回后，结果应表示对消息的访问权限控制政策的最终评估。

HandleAddNetwork

virtual WEAVE_ERROR HandleAddNetwork(
  PacketBuffer *networkInfoTLV
)=0

添加特定网络。

具体说明
参数
[in] networkInfoTLV
采用 TLV 编码的网络配置。
返回值
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定错误代码，表示发生错误，导致设备无法添加网络。
另请参阅：
NetworkProvisioningDataElementTags，了解有效类型。

HandleDisableNetwork

virtual WEAVE_ERROR HandleDisableNetwork(
  uint32_t networkId
)=0

停用指定的网络。

具体说明
参数
[in] networkId
要停用的广告联盟的 ID。
返回值
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定错误代码，表示发生了错误，导致设备无法停用网络。

HandleEnableNetwork

virtual WEAVE_ERROR HandleEnableNetwork(
  uint32_t networkId
)=0

启用指定的网络。

具体说明
参数
[in] networkId
要启用的广告联盟的 ID。
返回值
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定错误代码，表示发生错误，导致设备无法启用网络。

HandleGetNetworks

virtual WEAVE_ERROR HandleGetNetworks(
  uint8_t flags
)=0

获取已配置的网络。

具体说明
参数
[in] flags
用于过滤检索到的网络的标志。
返回值
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定错误代码，表示发生错误，导致设备无法获取配置的网络。

HandleGetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleGetWirelessRegulatoryConfig(
  void
)

获取无线监管配置信息。

具体说明
返回值
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定错误代码，表示发生错误，导致设备无法提取请求的信息。

HandleRemoveNetwork

virtual WEAVE_ERROR HandleRemoveNetwork(
  uint32_t networkId
)=0

移除已配置的网络。

具体说明
参数
[in] networkId
要移除的广告联盟的 ID。
返回值
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定错误代码，表示发生错误，导致设备无法移除网络。

HandleScanNetworks

virtual WEAVE_ERROR HandleScanNetworks(
  uint8_t networkType
)=0

执行网络扫描。

具体说明
参数
[in] networkType
要扫描的技术（例如 Wi-Fi 或 Thread）。
返回值
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定错误代码，表示发生了错误，导致设备无法执行网络扫描。
另请参阅：
NetworkType 了解有效类型。

HandleSetRendezvousMode

virtual WEAVE_ERROR HandleSetRendezvousMode(
  uint16_t rendezvousMode
)=0

设置约会模式。

具体说明
参数
[in] rendezvousMode
要使用的集合模式。
返回值
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定错误代码，表示发生错误，导致设备无法设置约车模式。
另请参阅：
RendezvousModeFlags，了解有效模式。

HandleSetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleSetWirelessRegulatoryConfig(
  PacketBuffer *regConfigTLV
)

设置无线监管配置信息。

具体说明
参数
[in] regConfigTLV
一个数据包缓冲区，其中包含以 TLV 格式编码的新无线监管配置信息。
返回值
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定错误代码，表示发生错误，导致设备无法设置请求的信息。

HandleTestConnectivity

virtual WEAVE_ERROR HandleTestConnectivity(
  uint32_t networkId
)=0

测试指定网络的连接情况。

具体说明
参数
[in] networkId
要测试其连接的网络的 ID。
返回值
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定错误代码，表示发生错误，导致设备无法测试连接。

HandleUpdateNetwork

virtual WEAVE_ERROR HandleUpdateNetwork(
  PacketBuffer *networkInfoTLV
)=0

更新网络的配置。

具体说明
参数
[in] networkInfoTLV
采用 TLV 编码的网络配置。
返回值
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定错误代码，表示发生错误，导致设备无法更新网络。
另请参阅：
NetworkProvisioningDataElementTags，了解有效类型。

IsPairedToAccount

virtual bool IsPairedToAccount() const

已进行调用以确定设备当前是否与某个账户配对。