nl::Weave::Profiles::ServiceProvisioning

この名前空間には、Weave サービス プロビジョニング プロファイル用の Weave 内のすべてのインターフェースが含まれます。これは、3 つの Weave プロビジョニング プロファイルのうちの 3 番目です。

概要

列挙型

@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
}
enum
サービス プロビジョニングのステータス コード。
@305 enum
サービス プロビジョニング メッセージ タイプ。
@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
}
enum
サービス プロビジョニングのデータ要素タグ。

関数

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

[ 配列, 長さ >= 1 ] サービスの信頼できる CA 証明書のリスト。

各要素は、セキュリティ プロファイルで定義されている WeaveCertificate です。

kTag_ServiceConfig_DirectoryEndPoint

[structs ] サービスのプライマリ ディレクトリ エンドポイントの連絡先情報が含まれます。

ServiceEndPoint 構造のコンテンツの定義を以下に示します。

kTag_ServiceEndPoint

[構造 ] Weave サービス エンドポイントを記述します。

kTag_ServiceEndPointAddress_HostName

[ utf-8 string ] ホスト名またはリテラル IP アドレス。

kTag_ServiceEndPointAddress_Port

[ uint, 1-63353 ] IP ポート番号。

省略可

kTag_ServiceEndPoint_Addresses

[ 配列, 長さ >= 1 ] サービス エンドポイントのアドレスのリスト。

各要素は、以下に定義するように ServiceEndPointAddress 構造です。

kTag_ServiceEndPoint_Id

[ uint、8-64 ビット ] サービス エンドポイントに割り当てられたサービス エンドポイント ID(EUI-64)。

kTag_ServiceEndPoint_NodeId

[ uint、8 ~ 64 ビット ] サービスを提供しているノードの Weave ノード ID。

アドレスリストとは相互に排他的です。

関数

EncodeServiceConfig

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