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 列舉
EventType 列舉
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 讀取器,以及指出是否收到空值類型,請在呼叫端設定資料。
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 讀取器,以及指出是否收到空值類型,請在呼叫端設定資料。

TDM 只會針對可為空值、選用、暫時或分葉的控點呼叫這個函式。如果 aHandle 是非分葉節點,且為空值,TDM 不會為其子項呼叫 SetData。

詳細說明
參數
[in] aHandle
有問題的 PropertyPathHandle。
[in,out] aReader
要讀取的 TLV 讀取器。
[out] aIsNull
帳號代碼是否可為空值?
傳回值
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
)