nl::Weave::Profiles::DataManagement_Current::TraitDataSink

これは抽象クラスです。

概要

継承

継承元: nl::Weave::Profiles::DataManagement_Current::TraitSchemaEngine::ISetDataDelegate
直接的な既知のサブクラス: nl::Weave::Profiles::DataManagement_Current::TraitUpdatableDataSink

コンストラクタとデストラクタ
TraitDataSink(const TraitSchemaEngine *aEngine)
~TraitDataSink()

パブリック タイプ
ChangeFlags enum
EventType enum
OnChangeRejection)(uint16_t aRejectionStatusCode, uint64_t aVersion, void *aContext) typedef

プロテクト属性
mSchemaEngine

パブリック関数
ClearVersion(void)
void
GetSchemaEngine(void) const
GetSubscriptionClient()
virtual SubscriptionClient *
GetUpdateEncoder()
virtual UpdateEncoder *
GetVersion(void) const
uint64_t
このシンクに存在するデータの現在のバージョンを取得します。
HandleUnknownLeafHandle(void)
TDM_DISABLE_STRICT_SCHEMA_COMPILANCE で定義されているような、スキーマの不一致に対するシステムレベルの許容範囲で、不明なリーフハンドルを処理するためのデータシンクのコンビニエンス関数。
IsUpdatableDataSink(void)
virtual bool
IsVersionNewer(DataVersion & aVersion)
virtual bool
IsVersionValid(void) const
bool
バージョンが有効かどうかを示すブール値を返します。
OnEvent(uint16_t aType, void *aInEventParam)
virtual WEAVE_ERROR
SetSubscriptionClient(SubscriptionClient *apSubClient)
virtual WEAVE_ERROR
SetUpdateEncoder(UpdateEncoder *apEncoder)
virtual WEAVE_ERROR
StoreDataElement(PropertyPathHandle aHandle, TLV::TLVReader & aReader, uint8_t aFlags, OnChangeRejection aFunc, void *aContext, TraitDataHandle aDatahandle)
このメソッドが、このオブジェクトにバインドされたスキーマに準拠するデータ要素を指すデータ要素を指す場合、このメソッドはそのデータを処理し、バッファ内のすべてのリーフアイテムに対して以下の関連する SetLeafData 呼び出しを呼び出します。

プロテクト関数
GetLastNotifyVersion(void) const
uint64_t
RejectChange(uint16_t aRejectionStatusCode)
void
SetData(PropertyPathHandle aHandle, nl::Weave::TLV::TLVReader & aReader, bool aIsNull) __OVERRIDE
virtual WEAVE_ERROR
ノードへのパスハンドル、TLV リーダー、null 型を受け取ったかどうかの指示、呼び出し先にデータを設定します。
SetLastNotifyVersion(uint64_t version)
void
SetLeafData(PropertyPathHandle aLeafHandle, nl::Weave::TLV::TLVReader & aReader) __OVERRIDE=0
virtual WEAVE_ERROR
リーフノードへのパスハンドルと TLV リーダーが与えられると、呼び出し先でリーフデータを設定します。
SetVersion(uint64_t version)
void

共用体
nl::Weave::Profiles::DataManagement_Current::TraitDataSink::InEventParam

パブリック タイプ

ChangeFlags

 ChangeFlags

EventType

 EventType

OnChangeRejection

WEAVE_ERROR(* OnChangeRejection)(uint16_t aRejectionStatusCode, uint64_t aVersion, void *aContext)

プロテクト属性

mSchemaEngine

const TraitSchemaEngine * mSchemaEngine

パブリック関数

ClearVersion

void ClearVersion(
  void
)

GetSchemaEngine

const TraitSchemaEngine * GetSchemaEngine(
  void
) const

GetSubscriptionClient

virtual SubscriptionClient * GetSubscriptionClient()

GetUpdateEncoder

virtual UpdateEncoder * GetUpdateEncoder()

GetVersion

uint64_t GetVersion(
  void
) const

このシンクに存在するデータの現在のバージョンを取得します。

HandleUnknownLeafHandle

WEAVE_ERROR HandleUnknownLeafHandle(
  void
)

TDM_DISABLE_STRICT_SCHEMA_COMPILANCE で定義されているような、スキーマの不一致に対するシステムレベルの許容範囲で、不明なリーフハンドルを処理するためのデータシンクのコンビニエンス関数。

IsUpdatableDataSink

virtual bool IsUpdatableDataSink(
  void
)

IsVersionNewer

virtual bool IsVersionNewer(
  DataVersion & aVersion
)

IsVersionValid

bool IsVersionValid(
  void
) const

バージョンが有効かどうかを示すブール値を返します。

OnEvent

virtual WEAVE_ERROR OnEvent(
  uint16_t aType,
  void *aInEventParam
)

SetSubscriptionClient

virtual WEAVE_ERROR SetSubscriptionClient(
  SubscriptionClient *apSubClient
)

SetUpdateEncoder

virtual WEAVE_ERROR SetUpdateEncoder(
  UpdateEncoder *apEncoder
)

StoreDataElement

WEAVE_ERROR StoreDataElement(
  PropertyPathHandle aHandle,
  TLV::TLVReader & aReader,
  uint8_t aFlags,
  OnChangeRejection aFunc,
  void *aContext,
  TraitDataHandle aDatahandle
)

このメソッドが、このオブジェクトにバインドされたスキーマに準拠するデータ要素を指すデータ要素を指す場合、このメソッドはそのデータを処理し、バッファ内のすべてのリーフアイテムに対して以下の関連する SetLeafData 呼び出しを呼び出します。

変更拒否関数を渡すこともできます。この関数は、シンクがなんらかの理由でこのデータを拒否した場合に呼び出されます。

詳細
戻り値
WEAVE_NO_ERROR
成功時。
other
データの書き出し中にエラーが発生しました。

TraitDataSink

 TraitDataSink(
  const TraitSchemaEngine *aEngine
)

~TraitDataSink

virtual  ~TraitDataSink()

プロテクト関数

GetLastNotifyVersion

uint64_t GetLastNotifyVersion(
  void
) const

RejectChange

void RejectChange(
  uint16_t aRejectionStatusCode
)

SetData

virtual WEAVE_ERROR SetData(
  PropertyPathHandle aHandle,
  nl::Weave::TLV::TLVReader & aReader,
  bool aIsNull
) __OVERRIDE

ノードへのパスハンドル、TLV リーダー、null 型を受け取ったかどうかの指示、呼び出し先にデータを設定します。

TDM は、null 値許容、オプション、エフェメラル、リーフのハンドルに対してのみこの関数を呼び出します。aHandle が非リーフノードで null 化されている場合、TDM はその子の SetData を呼び出しません。

詳細
パラメータ
[in] aHandle
対象の PropertyPathHandle。
[in,out] aReader
読み取る TLV リーダー。
[out] aIsNull
aHandle が null 化されていますか？
戻り値
WEAVE_NO_ERROR
成功時。
other
リーダーからデータを読み取れませんでした。

SetLastNotifyVersion

void SetLastNotifyVersion(
  uint64_t version
)

SetLeafData

virtual WEAVE_ERROR SetLeafData(
  PropertyPathHandle aLeafHandle,
  nl::Weave::TLV::TLVReader & aReader
) __OVERRIDE=0

リーフノードへのパスハンドルと TLV リーダーが与えられると、呼び出し先でリーフデータを設定します。

詳細
戻り値
WEAVE_NO_ERROR
成功時。
other
リーダーからデータを読み取れませんでした。

SetVersion

void SetVersion(
  uint64_t version
)