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)
初始化 Fabric 佈建伺服器狀態並註冊以接收 Fabric 佈建訊息。
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 佈建伺服器。

受保護的屬性

mCurClientOp

ExchangeContext * mCurClientOp

mDelegate

FabricProvisioningDelegate * mDelegate

公開函式

FabricProvisioningServer

 FabricProvisioningServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

初始化 Fabric 佈建伺服器狀態並註冊以接收 Fabric 佈建訊息。

詳細資料
參數
[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 佈建要求。

詳細資料
傳回值
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 佈建委派代表的指標。

關閉

WEAVE_ERROR Shutdown(
  void
)

關閉 Fabric 佈建伺服器。

詳細資料
傳回值
WEAVE_NO_ERROR
無條件使用