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
傳送成功回應至 Device Control 要求。
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 Manager 的指標。
傳回值
WEAVE_ERROR_INCORRECT_STATE
已註冊遠端被動路由伺服器。
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
註冊來路不明的訊息處理常式。
WEAVE_NO_ERROR
成功時。

IsRemotePassiveRendezvousInProgress

bool IsRemotePassiveRendezvousInProgress(
  void
) const 

傳回遠端被動語系。

詳細說明
傳回值
TRUE
是否正在運作。
FALSE

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
)

傳送成功回應至 Device Control 要求。

詳細說明
傳回值
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
)