nl::Weave::Profiles::DeviceControl::DeviceControlServer

#include <src/lib/profiles/device-control/DeviceControl.h>

用於實作 Device Control 設定檔的伺服器類別。

總結

繼承

沿用來源： nl::Weave::WeaveServerBase
直接已知子類別： nl::Weave::DeviceLayer::Internal::DeviceControlServer

建構函式和解構程式
DeviceControlServer(void)

受保護的屬性
mCurClientOp
mDelegate
mFailSafeArmed
bool
mFailSafeToken
uint32_t
mRemotePassiveRendezvousClientCon
mRemotePassiveRendezvousEncryptionType
uint8_t
mRemotePassiveRendezvousJoinerAddr
mRemotePassiveRendezvousJoinerCon
mRemotePassiveRendezvousKeyId
uint16_t
mRemotePassiveRendezvousOp
mRemotePassiveRendezvousTimeout
uint16_t
mRemotePassiveRendezvousTunnel
mResetFlags
uint16_t
mTunnelInactivityTimeout
uint16_t

公開函式
Init(WeaveExchangeManager *exchangeMgr)
初始化裝置控制伺服器狀態並註冊接收裝置控制訊息。
IsRemotePassiveRendezvousInProgress(void) const
bool
傳回遠端被動式約會狀態。
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
傳送狀態報告回應給要求。
SendSuccessResponse(void)
virtual WEAVE_ERROR
傳送成功回應至裝置控制要求。
SetDelegate(DeviceControlDelegate *delegate)
void
設定委派對象，以處理裝置控制伺服器事件。
Shutdown(void)
關閉裝置控制伺服器。
SystemTestTimeout(void)
void

受保護的屬性

mCurClientOp

ExchangeContext * mCurClientOp

委派

DeviceControlDelegate * mDelegate

mFailSafeArmed

bool mFailSafeArmed

mFailSafeToken

uint32_t mFailSafeToken

mRemotePassiveRendezvousClientCon

WeaveConnection * mRemotePassiveRendezvousClientCon

mRemotePassiveRendezvousEncryptionType

uint8_t mRemotePassiveRendezvousEncryptionType

mRemotePassiveRendezvousjoinerAddr

IPAddress mRemotePassiveRendezvousJoinerAddr

mRemotePassiveRendezvousjoinerCon

WeaveConnection * mRemotePassiveRendezvousJoinerCon

mRemotePassiveRendezvousKeyId

uint16_t mRemotePassiveRendezvousKeyId

mRemotePassiveRendezvousOp

ExchangeContext * mRemotePassiveRendezvousOp

mRemotePassiveRendezvousTimeout

uint16_t mRemotePassiveRendezvousTimeout

mRemotePassiveRendezvousTunnel

WeaveConnectionTunnel * mRemotePassiveRendezvousTunnel

重設重設標記

uint16_t mResetFlags

mTunnelInactivityTimeout

uint16_t mTunnelInactivityTimeout

公開函式

裝置控制伺服器

 DeviceControlServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

初始化裝置控制伺服器狀態並註冊接收裝置控制訊息。

詳細資料
參數
[in] exchangeMgr
可通往 Weave Exchange 管理員。
傳回值
WEAVE_ERROR_INCORRECT_STATE
已註冊遠端被動式轉譯伺服器時。
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
註冊了太多來路不明的訊息處理常式。
WEAVE_NO_ERROR
成功。

.

bool IsRemotePassiveRendezvousInProgress(
  void
) const

傳回遠端被動式約會狀態。

詳細資料
傳回值
TRUE
。
FALSE
沒有遠端被動式傳輸

傳送狀態報告

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 或平台專屬的錯誤代碼，表示發生錯誤而無法傳送狀態報告。

傳送成功回應

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

傳送成功回應至裝置控制要求。

詳細資料
傳回值
WEAVE_ERROR_INCORRECT_STATE
如果沒有處理任何要求，
WEAVE_NO_ERROR
成功。
other
其他 Weave 或平台專屬的錯誤代碼，表示發生錯誤而無法傳送成功回應。

設定委派

void SetDelegate(
  DeviceControlDelegate *delegate
)

設定委派對象，以處理裝置控制伺服器事件。

詳細資料
參數
[in] delegate
指向裝置控制委派代表的指標。

停用

WEAVE_ERROR Shutdown(
  void
)

關閉裝置控制伺服器。

詳細資料
傳回值
WEAVE_NO_ERROR
無條件

系統測試逾時

void SystemTestTimeout(
  void
)