nl::Weave::Profiles::FabricProvisioning::FabricProvisioningServer

#include <src/lib/profiles/fabric-provisioning/FabricProvisioning.h>

Fabric プロビジョニング プロファイルを実装するためのサーバークラス。

概要

継承

継承元: nl::Weave::WeaveServerBase
直接的な既知のサブクラス: nl::Weave::DeviceLayer::Internal::FabricProvisioningServer

コンストラクタとデストラクタ
FabricProvisioningServer(void)

プロテクト属性
mCurClientOp
mDelegate

パブリック関数
Init(WeaveExchangeManager *exchangeMgr)
ファブリック プロビジョニング サーバーの状態を初期化し、ファブリック プロビジョニング メッセージを受信するよう登録します。
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
リクエストへのステータス レポート レスポンスを送信します。
SendSuccessResponse(void)
virtual WEAVE_ERROR
Fabric プロビジョニング リクエストに成功レスポンスを送信します。
SessionHasFabricConfigAccessPrivilege(uint16_t keyId, uint64_t peerNodeId) const
bool
指定されたノード ID とセッションキー ID のセッションに、ファブリック構成情報の取得が許可されているかどうかを示します。
SetDelegate(FabricProvisioningDelegate *delegate)
void
Fabric プロビジョニング イベントを処理するようにデリゲートを設定します。
Shutdown(void)
Fabric Provisioning Server をシャットダウンします。

プロテクト属性

mCurClientOp

ExchangeContext * mCurClientOp

mDelegate

FabricProvisioningDelegate * mDelegate

パブリック関数

FabricProvisioningServer

 FabricProvisioningServer(
  void
)

init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

ファブリック プロビジョニング サーバーの状態を初期化し、ファブリック プロビジョニング メッセージを受信するよう登録します。

詳細
パラメータ
[in] exchangeMgr
システムの Weave Exchange マネージャーへのポインタ。
戻り値
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
すでに登録されているメッセージ ハンドラが多すぎる場合。
WEAVE_NO_ERROR
成功時。

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
)

Fabric プロビジョニング リクエストに成功レスポンスを送信します。

詳細
戻り値
WEAVE_ERROR_INCORRECT_STATE
処理中のリクエストがない場合。
WEAVE_NO_ERROR
成功時。
other
エラーが発生して成功レスポンスを送信できないことを示すその他の Weave またはプラットフォーム固有のエラーコード。

SessionHasFabricConfigAccessPrivilege

bool SessionHasFabricConfigAccessPrivilege(
  uint16_t keyId,
  uint64_t peerNodeId
) const

指定されたノード ID とセッションキー ID のセッションに、ファブリック構成情報の取得が許可されているかどうかを示します。

詳細
戻り値
指定されたピアが特権の場合は「true」を返し、それ以外の場合は「false」を返します。

SetDelegate

void SetDelegate(
  FabricProvisioningDelegate *delegate
)

Fabric プロビジョニング イベントを処理するようにデリゲートを設定します。

詳細
パラメータ
[in] delegate
Fabric Provisioning Delegate へのポインタ。

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

Fabric Provisioning Server をシャットダウンします。

詳細
戻り値
WEAVE_NO_ERROR
作成できます。