NL::编织::简介::网络供应::网络供应服务器
#include <src/lib/profiles/network-provisioning/NetworkProvisioning.h>
用于实现网络供应配置文件的服务器类。
概括
遗产
:从继承NL ::编织:: WeaveServerBase直接已知的子类: nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl<NetworkProvisioningServerImpl> nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl<ImplClass> 受保护的属性
mCurOpType
uint8_t mCurOpType
运行结果
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217 mLastOpResult
公共属性
状态配置文件 ID
uint32_t StatusProfileId
公共职能
在里面
WEAVE_ERROR Init(
WeaveExchangeManager *exchangeMgr
)
初始化网络供应服务器状态并注册以接收网络供应消息。
细节 | 参数 | [in] exchangeMgr | 指向系统 Weave Exchange Manager 的指针。 |
|
返回值 | WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS | 如果已经注册了太多的消息处理程序。 | WEAVE_NO_ERROR | 关于成功。 |
|
网络供应服务器
NetworkProvisioningServer(
void
)
发送添加网络完成
virtual WEAVE_ERROR SendAddNetworkComplete(
uint32_t networkId
)
如果网络已成功添加,则发送添加网络完成消息。
细节 | 参数 | |
返回值 | WEAVE_ERROR_INCORRECT_STATE | 如果 Network Provisioning Server 未正确初始化。 | WEAVE_ERROR_NO_MEMORY | 分配 PacketBuffer 失败时。 | WEAVE_NO_ERROR | 关于成功。 | other | 其他 Weave 或特定于平台的错误代码表示发生错误,阻止设备发送添加网络完成消息。 |
|
发送获取网络完成
virtual WEAVE_ERROR SendGetNetworksComplete(
uint8_t resultCount,
PacketBuffer *resultsTLV
)
发送包含先前扫描的网络的获取网络完成消息。
细节 | 参数 | [in] resultCount | 扫描结果的数量。 | [in] scanResultsTLV | 扫描结果。 |
|
返回值 | WEAVE_ERROR_INCORRECT_STATE | 如果 Network Provisioning Server 未正确初始化。 | 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 | 如果 Network Provisioning Server 未正确初始化。 | WEAVE_ERROR_NO_MEMORY | 分配 PacketBuffer 失败时。 | WEAVE_NO_ERROR | 关于成功。 | other | 其他 Weave 或特定于平台的错误代码表示发生错误,阻止设备发送添加网络完成消息。 |
|
发送网络扫描完成
virtual WEAVE_ERROR SendNetworkScanComplete(
uint8_t resultCount,
PacketBuffer *scanResultsTLV
)
发送包含扫描结果的网络扫描完成响应消息。
细节 | 参数 | [in] resultCount | 扫描结果的数量。 | [in] scanResultsTLV | 扫描结果。 |
|
返回值 | WEAVE_ERROR_INCORRECT_STATE | 如果 Network Provisioning Server 未正确初始化。 | WEAVE_ERROR_BUFFER_TOO_SMALL | 如果结果缓冲区不够大。 | WEAVE_NO_ERROR | 关于成功。 | other | 其他 Weave 或特定于平台的错误代码表示发生错误,阻止设备发送扫描完成响应。 |
|
发送状态报告
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 或特定于平台的错误代码,表明发生了阻止设备发送状态报告的错误。 |
|
发送成功响应
virtual WEAVE_ERROR SendSuccessResponse(
void
)
向网络供应请求发送成功响应。
细节 | 返回值 | WEAVE_ERROR_INCORRECT_STATE | 如果没有正在处理的请求。 | WEAVE_NO_ERROR | 关于成功。 | other | 其他 Weave 或特定于平台的错误代码表示发生错误,阻止设备发送成功响应。 |
|