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 读取器以及指示是否收到了 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

EventType

 EventType

OnChangeRejected [拒绝更改]

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 

检索此接收器中数据的当前版本。

标识名句柄

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 

返回确定版本是否有效的布尔值。

活动

virtual WEAVE_ERROR OnEvent(
  uint16_t aType,
  void *aInEventParam
)

设置订阅客户端

virtual WEAVE_ERROR SetSubscriptionClient(
  SubscriptionClient *apSubClient
)

SetUpdateEncoder

virtual WEAVE_ERROR SetUpdateEncoder(
  UpdateEncoder *apEncoder
)

存储元素

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

假设读取器指向的数据对象符合绑定到该对象的架构,该方法会处理这些数据并针对缓冲区中的所有叶项调用下面的相关 SetLeafData 调用。

您还可以传入更改拒绝函数,如果接收器出于任何原因选择拒绝这些数据,系统会调用该函数。

详细信息
返回值
WEAVE_NO_ERROR
成功时。
other
写入数据时出错。

特征数据接收器

 TraitDataSink(
  const TraitSchemaEngine *aEngine
)

~TraitDataSink

virtual  ~TraitDataSink()

受保护的函数

GetLastNotifyVersion

uint64_t GetLastNotifyVersion(
  void
) const 

拒绝更改

void RejectChange(
  uint16_t aRejectionStatusCode
)

设置数据

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

如果有节点的路径句柄、TLV 读取器以及指示是否收到了 null 类型,请在被调用方中设置数据。

TDM 只会为可为 null、可选、临时或叶级的句柄调用此函数。如果 aHandle 是非叶节点且已为空,则 TDM 不会为其子节点调用 SetData。

详细信息
参数
[in] aHandle
相关 PropertyPathHandle。
[in,out] aReader
要读取的 TLV 读取器。
[out] aIsNull
aHandle 是否为空?
返回值
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
无法从读取器读取数据。

设置版本

void SetVersion(
  uint64_t version
)