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
Device Control Server イベントを処理するようにデリゲートを設定します。
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
リモート パッシブ ランデブが進行中の場合。
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
)

デバイス コントロール リクエストに成功レスポンスを送信します。

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

SetDelegate

void SetDelegate(
  DeviceControlDelegate *delegate
)

Device Control Server イベントを処理するようにデリゲートを設定します。

詳細
パラメータ
[in] delegate
デバイス コントロール デリゲートへのポインタ。

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

デバイス コントロール サーバーをシャットダウンします。

詳細
戻り値
WEAVE_NO_ERROR
作成できます。

SystemTestTimeout

void SystemTestTimeout(
  void
)