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

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

用於實作裝置控制設定檔的伺服器類別。

摘要

繼承

沿用自： 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

mDelegate

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

mResetFlags

uint16_t mResetFlags

mTunnelInactivityTimeout

uint16_t mTunnelInactivityTimeout

公開函式

DeviceControlServer

 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
成功時。

IsRemotePassiveRendezvousInProgress

bool IsRemotePassiveRendezvousInProgress(
  void
) const

傳回遠端被動顯示狀態。

詳細資料
傳回值
TRUE
表示「遠端被動 Rendezvous」執行中。
FALSE
表示「遠端被動 Rendezvous」並未執行

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
)

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

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

SetDelegate

void SetDelegate(
  DeviceControlDelegate *delegate
)

設定委派代表處理裝置控制伺服器事件。

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

關閉

WEAVE_ERROR Shutdown(
  void
)

關閉裝置控制伺服器。

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

SystemTestTimeout

void SystemTestTimeout(
  void
)