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

Đây là lớp trừu tượng.

Tóm tắt

Tính kế thừa

Kế thừa từ: nl::Weave::Profiles::DataManagement_Current::TraitSchemaEngine::ISetDataDelegate
lớp con đã biết trực tiếp: nl::Weave::Profiles::DataManagement_Current::TraitUpdatableDataSink

Hàm khởi tạo và hàm phá

TraitDataSink(const TraitSchemaEngine *aEngine)
~TraitDataSink()

Loại công khai

ChangeFlags enum
EventType enum
OnChangeRejection)(uint16_t aRejectionStatusCode, uint64_t aVersion, void *aContext) typedef

Thuộc tính được bảo vệ

mSchemaEngine

Hàm công khai

ClearVersion(void)
void
GetSchemaEngine(void) const
GetSubscriptionClient()
virtual SubscriptionClient *
GetUpdateEncoder()
virtual UpdateEncoder *
GetVersion(void) const
uint64_t
Truy xuất phiên bản hiện tại của dữ liệu nằm trong bồn lưu trữ dữ liệu này.
HandleUnknownLeafHandle(void)
Hàm tiện lợi cho các bồn lưu trữ dữ liệu nhằm xử lý các tay điều khiển lá không xác định với dung sai mức hệ thống đối với giản đồ không khớp như được xác định bởi TDM_Disabled_STRICT_SCHEMA_COMPILANCE.
IsUpdatableDataSink(void)
virtual bool
IsVersionNewer(DataVersion & aVersion)
virtual bool
IsVersionValid(void) const
bool
Trả về một giá trị boolean xác định liệu phiên bản có hợp lệ hay không.
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)
Với một trình đọc trỏ đến một phần tử dữ liệu tuân theo giản đồ liên kết với đối tượng này, phương thức này sẽ xử lý dữ liệu đó và gọi lệnh gọi SetLeafData liên quan bên dưới cho tất cả các mục lá trong vùng đệm.

Hàm được bảo vệ

GetLastNotifyVersion(void) const
uint64_t
RejectChange(uint16_t aRejectionStatusCode)
void
SetData(PropertyPathHandle aHandle, nl::Weave::TLV::TLVReader & aReader, bool aIsNull) __OVERRIDE
virtual WEAVE_ERROR
Khi được cung cấp một ô điều khiển đường dẫn đến một nút, một trình đọc TLV và một chỉ báo cho biết liệu có nhận được kiểu dữ liệu rỗng hay không, hãy thiết lập dữ liệu trong hàm được gọi.
SetLastNotifyVersion(uint64_t version)
void
SetLeafData(PropertyPathHandle aLeafHandle, nl::Weave::TLV::TLVReader & aReader) __OVERRIDE=0
virtual WEAVE_ERROR
Cung cấp một ô điều khiển đường dẫn cho một nút lá và một trình đọc TLV, hãy đặt dữ liệu lá trong hàm được gọi.
SetVersion(uint64_t version)
void

Hiệp hội

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

Loại công khai

ChangeFlags

 ChangeFlags

EventType

 EventType

OnChangeRejection

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

Thuộc tính được bảo vệ

mSchemaEngine

const TraitSchemaEngine * mSchemaEngine

Hàm công khai

ClearVersion

void ClearVersion(
  void
)

GetSchemaEngine

const TraitSchemaEngine * GetSchemaEngine(
  void
) const 

GetSubscriptionClient

virtual SubscriptionClient * GetSubscriptionClient()

GetUpdateEncoder

virtual UpdateEncoder * GetUpdateEncoder()

GetVersion

uint64_t GetVersion(
  void
) const 

Truy xuất phiên bản hiện tại của dữ liệu nằm trong bồn lưu trữ dữ liệu này.

HandleUnknownLeafHandle

WEAVE_ERROR HandleUnknownLeafHandle(
  void
)

Hàm tiện lợi cho các bồn lưu trữ dữ liệu nhằm xử lý các tay điều khiển lá không xác định với dung sai mức hệ thống đối với giản đồ không khớp như được xác định bởi TDM_Disabled_STRICT_SCHEMA_COMPILANCE.

IsUpdatableDataSink

virtual bool IsUpdatableDataSink(
  void
)

IsVersionNewer

virtual bool IsVersionNewer(
  DataVersion & aVersion
)

IsVersionValid

bool IsVersionValid(
  void
) const 

Trả về một giá trị boolean xác định liệu phiên bản có hợp lệ hay không.

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
)

Với một trình đọc trỏ đến một phần tử dữ liệu tuân theo giản đồ liên kết với đối tượng này, phương thức này sẽ xử lý dữ liệu đó và gọi lệnh gọi SetLeafData liên quan bên dưới cho tất cả các mục lá trong vùng đệm.

Hệ thống cũng có thể truyền hàm từ chối thay đổi vào hàm này nếu bồn lưu trữ dữ liệu chọn từ chối dữ liệu này vì bất kỳ lý do gì.

Thông tin chi tiết
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Đã xảy ra lỗi khi ghi dữ liệu.

TraitDataSink

 TraitDataSink(
  const TraitSchemaEngine *aEngine
)

~TraitDataSink

virtual  ~TraitDataSink()

Hàm được bảo vệ

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

Khi được cung cấp một ô điều khiển đường dẫn đến một nút, một trình đọc TLV và một chỉ báo cho biết liệu có nhận được kiểu dữ liệu rỗng hay không, hãy thiết lập dữ liệu trong hàm được gọi.

TDM sẽ chỉ gọi hàm này đối với những tên người dùng có thể nhận giá trị rỗng, không bắt buộc, tạm thời hoặc lá. Nếu aHandle là một nút không phải nút lá và bị vô hiệu hóa, TDM sẽ không gọi SetData cho nút con của nó.

Thông tin chi tiết
Thông số
[in] aHandle
PropertiesPathHandle được đề cập.
[in,out] aReader
Trình đọc TLV để đọc.
[out] aIsNull
aHandle có bị vô hiệu hóa không?
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Không thể đọc to dữ liệu từ trình đọc.

SetLastNotifyVersion

void SetLastNotifyVersion(
  uint64_t version
)

SetLeafData

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

Cung cấp một ô điều khiển đường dẫn cho một nút lá và một trình đọc TLV, hãy đặt dữ liệu lá trong hàm được gọi.

Thông tin chi tiết
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Không thể đọc to dữ liệu từ trình đọc.

SetVersion

void SetVersion(
  uint64_t version
)