nl::Weave::Profiles::ServiceProvisioning

此命名空间包含 Weave 中针对 Weave 服务配置文件(三个 Weave 配置文件中的第三个)的所有接口。

摘要

枚举

@304{
  kStatusCode_TooManyServices = 1,
  kStatusCode_ServiceAlreadyRegistered = 2,
  kStatusCode_InvalidServiceConfig = 3,
  kStatusCode_NoSuchService = 4,
  kStatusCode_PairingServerError = 5,
  kStatusCode_InvalidPairingToken = 6,
  kStatusCode_PairingTokenOld = 7,
  kStatusCode_ServiceCommunicationError = 8,
  kStatusCode_ServiceConfigTooLarge = 9,
  kStatusCode_WrongFabric = 10,
  kStatusCode_TooManyFabrics = 11
}
枚举
服务配置状态代码。
@305 枚举
服务配置消息类型。
@306{
  kTag_ServiceConfig = 1,
  kTag_ServiceEndPoint = 2,
  kTag_ServiceConfig_CACerts = 1,
  kTag_ServiceConfig_DirectoryEndPoint = 2,
  kTag_ServiceEndPoint_Id = 1,
  kTag_ServiceEndPoint_Addresses = 2,
  kTag_ServiceEndPoint_NodeId = 3,
  kTag_ServiceEndPointAddress_HostName = 1,
  kTag_ServiceEndPointAddress_Port = 2
}
枚举
服务配置数据元素标记。

函数

EncodeServiceConfig(WeaveCertificateSet & certSet, const char *dirHostName, uint16_t dirPort, uint8_t *outBuf, uint16_t & outLen)
NL_DLL_EXPORT WEAVE_ERROR

nl::Weave::Profiles::ServiceProvisioning::IFJServiceFabricJoinMessage
nl::Weave::Profiles::ServiceProvisioning::PairDeviceToAccountMessage
nl::Weave::Profiles::ServiceProvisioning::RegisterServicePairAccountMessage
nl::Weave::Profiles::ServiceProvisioning::ServiceProvisioningDelegate
nl::Weave::Profiles::ServiceProvisioning::ServiceProvisioningServer

用于实现服务预配配置文件的简单服务器类。

nl::Weave::Profiles::ServiceProvisioning::UpdateServiceMessage

枚举

@304

 @304

服务配置状态代码。

属性
kStatusCode_InvalidPairingToken

该设备无法完成服务配对,因为它传递的配对令牌无效。

kStatusCode_InvalidServiceConfig

指定的服务配置无效。

kStatusCode_NoSuchService

指定的 ID 与设备上注册的服务不匹配。

kStatusCode_PairingServerError

该设备未能与配对服务器通信,因此无法完成服务配对。

kStatusCode_PairingTokenOld

该设备无法完成服务配对,因为其传递的配对令牌已过期。

kStatusCode_ServiceAlreadyRegistered

已在设备上注册了指定的服务。

kStatusCode_ServiceCommunicationError

该设备无法完成服务配对,因为在与服务通信时遇到了错误。

kStatusCode_ServiceConfigTooLarge

指定的服务配置过大。

kStatusCode_TooManyFabrics

结构中的织物过多。

kStatusCode_TooManyServices

此设备上注册的服务过多。

kStatusCode_WrongFabric

设备已与其他织物配对。

@305

 @305

服务配置消息类型。

@306

 @306

服务配置数据元素标记。

属性
kTag_ServiceConfig

[结构 ] 描述 Weave 服务。

kTag_ServiceConfig_CACerts

[数组, length >= 1 ] 服务的可信 CA 证书列表。

安全配置文件中所定义,每个元素都是一个 WeaveCertificate。

kTag_ServiceConfig_DirectoryEndPoint

[结构 ] 包含服务主目录端点的联系信息。

下面针对 ServiceEndPoint 结构定义了内容。

kTag_ServiceEndPoint

[结构 ] 描述 Weave 服务端点。

kTag_ServiceEndPointAddress_HostName

[ utf-8 string ] 主机名或文字 IP 地址。

kTag_ServiceEndPointAddress_Port

[ uint, 1-63353 ] IP 端口号。

可选

kTag_ServiceEndPoint_Addresses

[数组, length >= 1 ] 服务端点的地址列表。

每个元素都是一个 ServiceEndPointAddress 结构,如下文中所定义。

kTag_ServiceEndPoint_Id

[ uint, 8-64 bits ] 分配给服务端点的服务端点 ID(EUI-64)。

kTag_ServiceEndPoint_NodeId

[ uint, 8-64 bits ] 提供服务的节点的 Weave 节点 ID。

与地址列表相互排斥。

函数

EncodeServiceConfig

NL_DLL_EXPORT WEAVE_ERROR EncodeServiceConfig(
  WeaveCertificateSet & certSet,
  const char *dirHostName,
  uint16_t dirPort,
  uint8_t *outBuf,
  uint16_t & outLen
)