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
אחזור הגרסה הנוכחית של הנתונים שנמצאים ב-sink הזה.
HandleUnknownLeafHandle(void)
פונקציית נוחות ל-data sinks לטיפול בכינויי עלים לא ידועים עם סבילות ברמת המערכת לסכימה לא תואמת שהוגדרה על ידי 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

אחזור הגרסה הנוכחית של הנתונים שנמצאים ב-sink הזה.

HandleUnknownLeafHandle

WEAVE_ERROR HandleUnknownLeafHandle(
  void
)

פונקציית נוחות ל-data sinks לטיפול בכינויי עלים לא ידועים עם סבילות ברמת המערכת לסכימה לא תואמת שהוגדרה על ידי 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 שבהמשך לכל פריטי העלה במאגר הנתונים הזמני.

ניתן גם להעביר פונקציית דחיית שינוי שתופעל אם ה-sink יבחר לדחות את הנתונים האלה מסיבה כלשהי.

פרטים
מוחזר ערכים
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 הוא צומת ללא עלים והוא מבוטל, 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
)