nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer

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

用于实现网络预配配置文件的服务器类。

摘要

继承

沿用自： nl::Weave::WeaveServerBase
直接已知的子类：
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt;NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt;ImplClass >

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

受保护的属性
mCurOp
mCurOpType
uint8_t
mDelegate
mLastOpResult
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217

公共属性
StatusCode
uint16_t
StatusProfileId
uint32_t
SysError

公共函数
Init(WeaveExchangeManager *exchangeMgr)
初始化网络配置服务器状态，并注册以接收网络配置消息。
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
如果网络添加成功，则发送“添加网络完成”消息。
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
发送包含之前扫描的网络的 Get Networks Complete 消息。
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
向对等端发送 GetWirelessRegulatoryConfigComplete 消息。
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
发送包含扫描结果的网络扫描完成响应消息。
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
向请求发送状态报告响应。
SendSuccessResponse(void)
virtual WEAVE_ERROR
向网络配置请求发送成功响应。
SetDelegate(NetworkProvisioningDelegate *delegate)
void
设置委托以处理网络配置服务器事件。
Shutdown(void)
关闭网络配置服务器。

受保护的属性

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

mDelegate

NetworkProvisioningDelegate * mDelegate

mLastOpResult

struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217 mLastOpResult

公共属性

StatusCode

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

公共函数

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

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

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

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

如果网络添加成功，则发送“添加网络完成”消息。

详细信息
参数
[in] networkId
已添加的广告联盟的 ID。
返回值
WEAVE_ERROR_INCORRECT_STATE
如果网络配置服务器未正确初始化。
WEAVE_ERROR_NO_MEMORY
在分配 PacketBuffer 失败时。
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定的错误代码，表示发生了错误，导致设备无法发送“Add Network complete”（添加网络完成）消息。

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

发送包含之前扫描的网络的 Get Networks Complete 消息。

详细信息
参数
[in] resultCount
扫描结果的数量。
[in] scanResultsTLV
扫描结果。
返回值
WEAVE_ERROR_INCORRECT_STATE
如果网络配置服务器未正确初始化。
WEAVE_ERROR_BUFFER_TOO_SMALL
如果结果缓冲区不够大。
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定的错误代码，表示发生了错误，导致设备无法发送“Get Networks Complete”消息。

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

向对等端发送 GetWirelessRegulatoryConfigComplete 消息。

详细信息
参数
[in] resultsTLV
包含要返回的无线监管配置信息的数据包缓冲区。
返回值
WEAVE_ERROR_INCORRECT_STATE
如果网络配置服务器未正确初始化。
WEAVE_ERROR_NO_MEMORY
在分配 PacketBuffer 失败时。
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台专用错误代码，表示发生了错误，导致设备无法发送“Add Network Complete”消息。

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

发送包含扫描结果的网络扫描完成响应消息。

详细信息
参数
[in] resultCount
扫描结果的数量。
[in] scanResultsTLV
扫描结果。
返回值
WEAVE_ERROR_INCORRECT_STATE
如果网络配置服务器未正确初始化。
WEAVE_ERROR_BUFFER_TOO_SMALL
如果结果缓冲区不够大。
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定的错误代码，表示发生了错误，导致设备无法发送“扫描完成”响应。

SendStatusReport

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
)

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

详细信息
返回值
WEAVE_ERROR_INCORRECT_STATE
如果没有正在处理的请求。
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定的错误代码，表示发生了错误，导致设备无法发送成功响应。

SetDelegate

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

设置委托以处理网络配置服务器事件。

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

关停

WEAVE_ERROR Shutdown(
  void
)

关闭网络配置服务器。

详细信息
返回值
WEAVE_NO_ERROR
成功时。