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

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

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

概要

継承

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

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

プロテクト属性
mCurClientOp
mDelegate

パブリック関数
Init(WeaveExchangeManager *exchangeMgr)
Fabric Provisioning Server の状態を初期化し、Fabric Provisioning メッセージを受信するように登録します。
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
)

Fabric Provisioning Server の状態を初期化し、Fabric Provisioning メッセージを受信するように登録します。

詳細
パラメータ
[in] exchangeMgr
システムの Weave Exchange Manager へのポインタ。
戻り値
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 Provisioning リクエストに成功レスポンスを送信します。

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

SessionHasFabricConfigAccessPrivilege

bool SessionHasFabricConfigAccessPrivilege(
  uint16_t keyId,
  uint64_t peerNodeId
) const

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

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

SetDelegate

void SetDelegate(
  FabricProvisioningDelegate *delegate
)

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

詳細
パラメータ
[in] delegate
Fabric プロビジョニング委任へのポインタ。

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

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

詳細
戻り値
WEAVE_NO_ERROR
学習します。