nl::Weave::Profiles::DataManagement_Current::Command

#include <src/lib/profiles/data-management/Current/Command.h>

概要

注: このクラスは、コマンド処理で特定の詳細を非表示にするように設計されています。ExchangeContext と認証システムの検証の詳細を非表示にし、PacketBuffers の処理はアプリケーション層に任せるという決定が下されました。 コマンド処理に関するこのラッパーの有用性は実際に制限されています。これは主に、セキュリティ検証およびデータのシリアル化 / シリアル化解除に伴う複雑さと柔軟性によるものです。

コマンド検証の詳細は未定

In-Progress、Status Report、Response メッセージの再送信のタイミングを調整するには、アプリケーション レイヤで ExchangeContext オブジェクトをなんらかの方法で処理する必要があります。最善の方法は未定ですが、アプリケーション レイヤには次の 3 つの選択肢があります。

1)GetExchangeContext を通じて Exchange コンテキストを取得し、直接評価/調整します。2)起動時に、コマンドが届く前にバインディングを事前に割り当てて構成し、適切に構成する。3)この関数 BindingPool::NewResponderBindingFromExchangeContext を使用して一時的な Binding を作成する

(2)と(3)の両方で、アプリケーション レイヤは Binding::ConfigureExistingExchangeContext を介してセキュリティ/タイミング設定を適用できます。Binding はカスタム コマンドの新しい交換コンテキストの生成に使用されないため、このハンドル内に格納する必要はありません。

また、リクエスト パケット バッファもこのハンドル内に格納されません。これは明らかに使用されていないためです。アプリケーション レイヤがこのコマンドを処理してレスポンスを直接送信できる場合は特にそうです。

アプリケーション レイヤは、このコマンド ハンドルを受け取るのと同じコールバックからパケット バッファを受け取ります。このコマンドを非同期で処理する場合は、コマンド ハンドルとパケット バッファの両方を保存する必要があります。

公開タイプ

CommandFlags{
  kCommandFlag_MustBeVersionValid = 0x0001,
  kCommandFlag_InitiationTimeValid = 0x0002,
  kCommandFlag_ActionTimeValid = 0x0004,
  kCommandFlag_ExpiryTimeValid = 0x0008,
  kCommandFlag_IsOneWay = 0x0010
}
enum
コマンドフラグビット。
CommandFlags typedef
コマンドフラグビット。

パブリック属性

actionTimeMicroSecond
int64_t
commandType
uint64_t
expiryTimeMicroSecond
int64_t
initiationTimeMicroSecond
int64_t
mustBeVersion
uint64_t

パブリック関数

Close(void)
void
GetExchangeContext(void) const
この受信コマンドで使用されるエクスチェンジ コンテキスト オブジェクトを取得します。
IsActionTimeValid(void) const
bool
IsExpiryTimeValid(void) const
bool
IsInitiationTimeValid(void) const
bool
IsMustBeVersionValid(void) const
bool
IsOneWay(void) const
bool
SendError(uint32_t aProfileId, uint16_t aStatusCode, WEAVE_ERROR aWeaveError)
SendInProgress(void)
SendResponse(uint32_t traitInstanceVersion, nl::Weave::System::PacketBuffer *apPayload)
ValidateAuthenticator(nl::Weave::System::PacketBuffer *aRequestBuffer)

公開タイプ

CommandFlags

 CommandFlags

コマンドフラグビット。

プロパティ
kCommandFlag_ActionTimeValid

アクション時間が有効なときに設定されます。

kCommandFlag_ExpiryTimeValid

有効期限が有効なときに設定します。

kCommandFlag_InitiationTimeValid

初期化時刻が有効なときに設定されます。

kCommandFlag_IsOneWay

コマンドが一方向の場合に設定されます。

kCommandFlag_MustBeVersionValid

バージョン フィールドが有効な場合に設定されます。

CommandFlags

enum nl::Weave::Profiles::DataManagement_Current::Command::CommandFlags CommandFlags

コマンドフラグビット。

パブリック属性

actionTimeMicroSecond

int64_t actionTimeMicroSecond

commandType

uint64_t commandType

expiryTimeMicroSecond

int64_t expiryTimeMicroSecond

initiationTimeMicroSecond

int64_t initiationTimeMicroSecond

mustBeVersion

uint64_t mustBeVersion

パブリック関数

閉じる

void Close(
  void
)

GetExchangeContext

nl::Weave::ExchangeContext * GetExchangeContext(
  void
) const 

この受信コマンドで使用されるエクスチェンジ コンテキスト オブジェクトを取得します。

詳細
戻り値
この受信コマンドで使用されるエクスチェンジ コンテキスト オブジェクトへのポインタ。

IsActionTimeValid

bool IsActionTimeValid(
  void
) const 

IsExpiryTimeValid

bool IsExpiryTimeValid(
  void
) const 

IsInitiationTimeValid

bool IsInitiationTimeValid(
  void
) const 

IsMustBeVersionValid

bool IsMustBeVersionValid(
  void
) const 

IsOneWay

bool IsOneWay(
  void
) const 

SendError

WEAVE_ERROR SendError(
  uint32_t aProfileId,
  uint16_t aStatusCode,
  WEAVE_ERROR aWeaveError
)

SendInProgress

WEAVE_ERROR SendInProgress(
  void
)

SendResponse

WEAVE_ERROR SendResponse(
  uint32_t traitInstanceVersion,
  nl::Weave::System::PacketBuffer *apPayload
)

ValidateAuthenticator

WEAVE_ERROR ValidateAuthenticator(
  nl::Weave::System::PacketBuffer *aRequestBuffer
)