nl:: Weave:: Profiles:: DataManagement_Legacy
מרחב השמות הזה כולל את כל הממשקים ב-Weave עבור פרופיל Weave Data Management (WDM) שעומדים לצאת משימוש.
סיכום
ערכי דף |
|
---|---|
TopicIdentifier
|
typedefuint64_t
מזהה הנושא. |
פונקציות |
|
---|---|
CheckTLVType(nl::Weave::TLV::TLVType aType, nl::Weave::TLV::TLVReader & aReader)
|
bool
|
CheckWDMTag(uint32_t aTagNum, nl::Weave::TLV::TLVReader & aReader)
|
bool
יש לבדוק תג ספציפי ל-WDM.
|
CloseDataListElement(nl::Weave::TLV::TLVReader & aReader)
|
הפסקת הקריאה של רכיב רשימת נתונים של WDM.
|
CloseList(nl::Weave::TLV::TLVReader & aReader)
|
הפסקת הקריאה של נתיב או רשימת נתונים של WDM.
|
EncodeDeprecatedPath(TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ...)
|
יש לקודד נתיב WDM עם תגים שהוצאו משימוש ומזהה מכונה עם מספר שלם.
|
EncodeDeprecatedPath(TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ...)
|
יש לקודד נתיב WDM באמצעות תגים שהוצאו משימוש ומזהה מופע של מחרוזת.
|
EncodePath(TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ...)
|
קידוד נתיב WDM עם מזהה מופע של פרופיל מספר שלם.
|
EncodePath(TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint32_t aInstanceIdLen, const uint8_t *aInstanceId, uint32_t aPathLen, ...)
|
קידוד נתיב WDM באמצעות מזהה מופע של מערך בייטים.
|
EncodePath(TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ...)
|
קידוד נתיב WDM באמצעות מזהה מופע של מחרוזת.
|
EndDataListElement(nl::Weave::TLV::TLVWriter & aWriter)
|
מסיימים לכתוב רכיב של רשימת נתונים.
|
EndEncodePath(TLVWriter & aWriter, TLVType & mOuterContainer, WEAVE_ERROR mError)
|
|
EndList(nl::Weave::TLV::TLVWriter & aWriter)
|
מסיימים לכתוב רשימת נתיבים או רשימת נתונים.
|
EndList(ReferencedTLVData & aList, nl::Weave::TLV::TLVWriter & aWriter)
|
מסיימים לכתוב רשימת נתיבים או רשימת נתונים.
|
IsPublisherSpecific(const TopicIdentifier & aTopicId)
|
bool
בודקים אם מזהה הנושא הוא ספציפי לבעל תוכן דיגיטלי.
|
OpenDataList(ReferencedTLVData & aDataList, nl::Weave::TLV::TLVReader & aReader)
|
מתחילים לקרוא רשימת נתונים.
|
OpenDataListElement(nl::Weave::TLV::TLVReader & aReader, nl::Weave::TLV::TLVReader & aPathReader, uint64_t & aVersion)
|
התחלת קריאה של רכיב ברשימת נתונים.
|
OpenPathList(ReferencedTLVData & aPathList, nl::Weave::TLV::TLVReader & aReader)
|
התחל לקרוא רשימת נתיבים.
|
PublisherSpecificTopicId(void)
|
יצירת מזהה נושא חדש וספציפי לבעל תוכן דיגיטלי.
|
SendStatusReport(ExchangeContext *aExchangeCtx, StatusReport & aStatus)
|
|
StartDataList(nl::Weave::TLV::TLVWriter & aWriter)
|
מתחילים לכתוב רשימת נתונים.
|
StartDataList(ReferencedTLVData & aDataList, nl::Weave::TLV::TLVWriter & aWriter)
|
מתחילים לכתוב רשימת נתונים לאובייקט ReferencedTLVData.
|
StartDataListElement(nl::Weave::TLV::TLVWriter & aWriter)
|
מתחילים לכתוב רכיב של רשימת נתונים.
|
StartEncodePath(TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, TLVType & mOuterContainer, TLVType & mPath)
|
|
StartPathList(nl::Weave::TLV::TLVWriter & aWriter)
|
מתחילים לכתוב רשימת נתיבים.
|
TxnResponseHandler(ExchangeContext *anExchangeCtx, const IPPacketInfo *anAddrInfo, const WeaveMessageInfo *aMsgInfo, uint32_t aProfileId, uint8_t aMsgType, PacketBuffer *aMsg)
|
void
|
TxnTimeoutHandler(ExchangeContext *anExchangeCtx)
|
void
|
ValidateTLVType(nl::Weave::TLV::TLVType aType, nl::Weave::TLV::TLVReader & aReader)
|
|
ValidateWDMTag(uint32_t aTagNum, nl::Weave::TLV::TLVReader & aReader)
|
מוודאים שרכיב TLV שבקריאה מכיל את תג WDM הצפוי.
|
מחלקות |
|
---|---|
nl:: |
המחלקה Binding מנהלת את מצב התקשורת מטעם ישות אפליקציה באמצעות Weave. |
nl:: |
מחלקה מופשטת שמכילה את ההגדרות של שיטות האישור והאינדיקציה הנדרשות על ידי לקוח ה-WDM. |
nl:: |
מחלקת עזר שמועסקת בו כשרוצים לקבל תמיכה במינוי ובהתראות בלקוח WDM. |
nl:: |
מחלקת הבסיס המופשטת ללקוחות WDM ספציפיים לאפליקציות. |
nl:: |
מחלקת הבסיס המופשטת לבעלי אתרי WDM ספציפיים לאפליקציות. |
nl:: |
מחלקת העזר המופשטת ProfileDatabase. |
nl:: |
מחלקת המנוע של פרוטוקול WDM. |
nl:: |
מחלקה מופשטת הכוללת הגדרות של אישור ושיטות התראה הנדרשות על ידי בעל התוכן הדיגיטלי של ה-WDM. |
ספירות
@103
@103
תכונות | |
---|---|
kStatus_CancelSuccess
|
המשמעות של קוד הסטטוס הקודם הזה היא שהמינוי בוטל בהצלחה. המשמעות של קוד הסטטוס הזה היא שהמינוי בוטל. |
kStatus_IllegalReadRequest
|
המשמעות של קוד הסטטוס הקודם הזה היא שלצומת ששולח בקשה לקרוא פריט נתונים מסוים אין הרשאה לעשות זאת. המשמעות של קוד הסטטוס הזה היא שלצומת ששולח בקשה לקרוא פריט נתונים מסוים אין הרשאה לעשות זאת. |
kStatus_IllegalWriteRequest
|
המשמעות של קוד הסטטוס הקודם היא שלצומת ששולח בקשה לכתיבה של פריט נתונים מסוים אין הרשאה לעשות זאת. המשמעות של קוד הסטטוס הזה היא שלצומת ששולח בקשה לכתוב פריט נתונים מסוים אין הרשאה לעשות זאת. |
kStatus_InvalidPath
|
המשמעות של קוד הסטטוס הקודם היא שנתיב מרשימת הנתיבים של מסגרת הבקשה לעדכון או לתצוגה לא תאם לסכימה של המשיב בצומת. משמעות קוד הסטטוס הזה היא שנתיב מרשימת הנתיבים של מסגרת בקשה לעדכון או של תצוגה מפורטת לא תאם לסכימה של המשיב בצומת. |
kStatus_InvalidVersion
|
המשמעות של קוד הסטטוס הקודם הזה היא שהגרסה של הנתונים שנכללו בבקשת העדכון לא תאמה לגרסה העדכנית ביותר של בעל התוכן הדיגיטלי, ולכן לא ניתן היה להחיל את העדכון. משמעות קוד הסטטוס הזה היא שהגרסה של הנתונים שנכללו בבקשת העדכון לא תאמה לגרסה העדכנית ביותר של בעל האתר, ולכן לא ניתן היה להחיל את העדכון. |
kStatus_UnknownTopic
|
המשמעות של קוד הסטטוס הקודם הזה היא שמזהה הנושא שסופק בבקשת ביטול או בהתראה לא תאם לאף מינוי קיים בצומת המקבל. משמעות קוד הסטטוס הזה היא שמזהה הנושא שסופק בבקשת ביטול או בהתראה לא תאם לאף מינוי קיים בצומת המקבל. |
kStatus_UnsupportedSubscriptionMode
|
המשמעות של קוד הסטטוס הקודם הזה היא שמצב המינוי המבוקש לא נתמך במכשיר המקבל. המשמעות של קוד הסטטוס הזה היא שמצב המינוי המבוקש אינו נתמך במכשיר המקבל. |
@166
@166
גודל בריכות וטבלאות של WDM.
WDM מגדיר מאגרי נתונים וטבלאות שונים שנדרשים להפעלתם, באופן הבא.
מאגרי עסקאות של לקוחות:
- kViewPoolSize
- kSubscribePoolSize
- kCancelSubscriptionPoolSize
- kUpdatePoolSize
מאגרי עסקאות של בעלי תוכן דיגיטלי:
- kNotifyPoolSize
טבלאות של מנועי פרוטוקול:
- kTransactionTableSize
- kBindingTableSize
טבלאות שקשורות למינויים:
- kNotifierTableSize (לקוח בלבד)
- kSubscriptionMgrTableSize (בעל אתר בלבד)
חשוב לשים לב שאלה כמויות שניתן להגדיר, ושהערכים לכל פלטפורמה מופיעים ב-WeaveConfig.h המשויך.
תכונות | |
---|---|
kBindingTableSize
|
זהו גודל ברירת המחדל של טבלת הקישור במנוע של פרוטוקול WDM. אפשר להגדיר את הערך הזה באמצעות WEAVE_CONFIG_WDM_BINDING_TABLE_SIZE. |
kCancelSubscriptionPoolSize
|
זהו גודל ברירת המחדל של מאגר העסקאות של בקשות לביטול המינוי עבור לקוח WDM. אפשר להגדיר את הערך הזה באמצעות WEAVE_CONFIG_WDM_CANCEL_SUBSCRIPTION_POOL_SIZE. |
kNotifierTableSize
|
זהו גודל ברירת המחדל של טבלת ההתראות ללקוחות WDM. אפשר להגדיר את הערך הזה באמצעות WEAVE_CONFIG_WDM_NOTIFIER_TABLE_SIZE. |
kNotifyPoolSize
|
זהו גודל ברירת המחדל של מאגר העסקאות של בקשות ההתראה עבור בעל תוכן דיגיטלי WDM. אפשר להגדיר את הערך הזה באמצעות WEAVE_CONFIG_WDM_NOTIFY_POOL_SIZE. |
kSubscribePoolSize
|
זהו גודל ברירת המחדל של מאגר העסקאות של בקשות ההרשמה עבור לקוח WDM. ניתן להגדיר את הערך הזה באמצעות WEAVE_CONFIG_WDM_SUBSCRIBE_POOL_SIZE. |
kSubscriptionMgrTableSize
|
זהו גודל ברירת המחדל של טבלת המינויים עבור מוציאים לאור של WDM. אפשר להגדיר את הערך הזה באמצעות WEAVE_CONFIG_WDM_SUBSCRIPTION_MGR_TABLE_SIZE. |
kTransactionTableSize
|
זהו גודל ברירת המחדל של טבלת הטרנזקציות במנוע של פרוטוקול WDM. אפשר להגדיר את הערך הזה באמצעות WEAVE_CONFIG_WDM_TRANSACTION_TABLE_SIZE. |
kUpdatePoolSize
|
זהו גודל ברירת המחדל של מאגר העסקאות של בקשות העדכון ללקוח WDM. אפשר להגדיר את הערך הזה באמצעות WEAVE_CONFIG_WDM_UPDATE_POOL_SIZE. |
kViewPoolSize
|
זהו גודל ברירת המחדל של מאגר העסקאות של בקשות לצפייה עבור לקוח WDM. אפשר להגדיר את הערך הזה באמצעות WEAVE_CONFIG_WDM_VIEW_POOL_SIZE. |
@167
@167
הסוגים של הודעות פרופיל WDM.
הערכים האלה מוצגים במפרט ניהול הנתונים.
הערה! החל מהרבעון הראשון של 2015, סוגי ההודעות שהיו בשימוש בגרסאות הקודמות של WDM הוצאו משימוש והוגדרו סוגי הודעות חדשים, ושיקפו שינוי מספיק בפרטי האריזה והניתוח הקודמים כדי להצדיק מעבר נקי.
תכונות | |
---|---|
kMsgType_CancelSubscriptionRequest
|
הודעה על ביטול בקשת הרשמה. |
kMsgType_CancelSubscriptionRequest_Deprecated
|
הוצא משימוש |
kMsgType_NotifyRequest
|
שליחת הודעה על הבקשה. |
kMsgType_NotifyRequest_Deprecated
|
הוצא משימוש |
kMsgType_SubscribeRequest
|
הודעת בקשת הרשמה. |
kMsgType_SubscribeRequest_Deprecated
|
הוצא משימוש |
kMsgType_SubscribeResponse
|
הודעת תגובה ל'הרשמה למינוי'. |
kMsgType_SubscribeResponse_Deprecated
|
הוצא משימוש |
kMsgType_UpdateRequest
|
עדכון הודעת הבקשה. |
kMsgType_UpdateRequest_Deprecated
|
הוצא משימוש |
kMsgType_ViewRequest
|
הצגת הודעת הבקשה. |
kMsgType_ViewRequest_Deprecated
|
הוצא משימוש |
kMsgType_ViewResponse
|
הצגת הודעת התשובה. |
kMsgType_ViewResponse_Deprecated
|
הוצא משימוש |
@168
@168
קבועים שונים שספציפיים ל-WDM.
תכונות | |
---|---|
kDefaultBindingTableIndex
|
האינדקס של קישור ברירת המחדל בטבלת קישורים של מנוע פרוטוקול עם יותר מרשומה אחת. |
kInstanceIdNotSpecified
|
בשיחות שמחייבות מפרט מופע של פרופיל, הערך מציין "None". בדרך כלל המשמעות היא שרק מופע אחד של הפרופיל נמצא בישות הנדונה. |
kResponseTimeoutNotSpecified
|
בשיטות שמבקשות עסקה, מציין שהמתקשר סירב לציין זמן קצוב לתפוגה. בדרך כלל, המשמעות היא שצריך להשתמש כברירת מחדל. |
kTransactionIdNotSpecified
|
ב-methods ובמבני נתונים שכוללים מזהה עסקה, המאפיין מציין ערך מסוג 'None' או ערך של תו כללי לחיפוש. |
kVersionNotSpecified
|
בשיחות המחייבות מפרט של גרסת נתונים, מציין "אין גרסה מסוימת". |
kWeaveTLVControlByteLen
|
האורך של בייט בקרה TLV, המשמש בשיטות תמיכה שמקודדות מבני WDM ב-TLV. |
kWeaveTLVTagLen
|
האורך הסטנדרטי בבייטים של תג TLV מלא, שמשמש בשיטות תמיכה שמקודדות מבני WDM ב-TLV. |
@169
@169
קודי מצב ספציפיים ל-WDM.
תכונות | |
---|---|
kStatus_CancelSuccess
|
המשמעות של קוד הסטטוס הקודם הזה היא שהמינוי בוטל בהצלחה. המשמעות של קוד הסטטוס הזה היא שהמינוי בוטל. |
kStatus_IllegalReadRequest
|
המשמעות של קוד הסטטוס הקודם הזה היא שלצומת ששולח בקשה לקרוא פריט נתונים מסוים אין הרשאה לעשות זאת. המשמעות של קוד הסטטוס הזה היא שלצומת ששולח בקשה לקרוא פריט נתונים מסוים אין הרשאה לעשות זאת. |
kStatus_IllegalWriteRequest
|
המשמעות של קוד הסטטוס הקודם היא שלצומת ששולח בקשה לכתיבה של פריט נתונים מסוים אין הרשאה לעשות זאת. המשמעות של קוד הסטטוס הזה היא שלצומת ששולח בקשה לכתוב פריט נתונים מסוים אין הרשאה לעשות זאת. |
kStatus_InvalidPath
|
המשמעות של קוד הסטטוס הקודם היא שנתיב מרשימת הנתיבים של מסגרת הבקשה לעדכון או לתצוגה לא תאם לסכימה של המשיב בצומת. משמעות קוד הסטטוס הזה היא שנתיב מרשימת הנתיבים של מסגרת בקשה לעדכון או של תצוגה מפורטת לא תאם לסכימה של המשיב בצומת. |
kStatus_InvalidVersion
|
המשמעות של קוד הסטטוס הקודם הזה היא שהגרסה של הנתונים שנכללו בבקשת העדכון לא תאמה לגרסה העדכנית ביותר של בעל התוכן הדיגיטלי, ולכן לא ניתן היה להחיל את העדכון. משמעות קוד הסטטוס הזה היא שהגרסה של הנתונים שנכללו בבקשת העדכון לא תאמה לגרסה העדכנית ביותר של בעל האתר, ולכן לא ניתן היה להחיל את העדכון. |
kStatus_UnknownTopic
|
המשמעות של קוד הסטטוס הקודם הזה היא שמזהה הנושא שסופק בבקשת ביטול או בהתראה לא תאם לאף מינוי קיים בצומת המקבל. משמעות קוד הסטטוס הזה היא שמזהה הנושא שסופק בבקשת ביטול או בהתראה לא תאם לאף מינוי קיים בצומת המקבל. |
kStatus_UnsupportedSubscriptionMode
|
המשמעות של קוד הסטטוס הקודם הזה היא שמצב המינוי המבוקש לא נתמך במכשיר המקבל. המשמעות של קוד הסטטוס הזה היא שמצב המינוי המבוקש אינו נתמך במכשיר המקבל. |
@170
@170
תגים של פרוטוקול ניהול נתונים.
הפרוטוקול לניהול נתונים מגדיר כמה תגים שישמשו בייצוג TLV של נתוני הפרופיל.
כמו תמיד, יש בעיות תאימות בין WDM החדש והישן. בימים הגרועים, כל התגים האלה הוחלו כספציפיים לפרופיל, וזה היה בזבוז של שטח. עכשיו אנחנו משתמשים בתגי הקשר במידת האפשר, אבל עלינו לשמור על התגים הישנים (ועם מנגנון לקידוד נתיבים שלהם) במידת הצורך.
התג kTag_WDMDataListElementData לא היה בשימוש בגרסאות קודמות והקוד התעלם ממנו לגמרי, לכן אנחנו לא צריכים לספק גרסה שהוצאה משימוש.
תכונות | |
---|---|
kTag_WDMDataList
|
הרכיב הוא רשימה של מבנים שמכילים נתיב, גרסה אופציונלית ורכיבי נתונים. סוג תג: סוג רכיב ספציפי לפרופיל: מערך: רמה עליונה |
kTag_WDMDataListElementData
|
הרכיב מייצג את הנתונים שאליהם מפנה הנתיב הנתון, ושהם כוללים את הגרסה הנתונה. סוג תג: סוג רכיב ספציפי להקשר: כל נטייה: נדרש |
kTag_WDMDataListElementData_Deprecated
|
הוּצא משימוש. סוג תג: סוג רכיב ספציפי להקשר: כל נטייה: נדרש |
kTag_WDMDataListElementPath
|
הרכיב הוא רכיב הנתיב ברכיב של רשימת נתונים. סוג תג: סוג רכיב ספציפי להקשר: מחיקת נתיב: נדרש |
kTag_WDMDataListElementPath_Deprecated
|
הוּצא משימוש. סוג תג: סוג רכיב ספציפי לפרופיל: פריסת נתיב: נדרש |
kTag_WDMDataListElementVersion
|
הרכיב הוא רכיב הגרסה של רכיב ברשימת נתונים. סוג תג: סוג רכיב ספציפי להקשר: העברת מספר שלם: נדרש |
kTag_WDMDataListElementVersion_Deprecated
|
הוּצא משימוש. סוג תג: סוג רכיב ספציפי לפרופיל: העברת מספר שלם: נדרש |
kTag_WDMPathArrayIndexSelector
|
רכיב הנתיב תואם למערך בסכימה, והרכיב של המספר השלם הכלול בו משמש כאינדקס למערך הזה. סוג תג: סוג רכיב ספציפי לפרופיל: מחיקת מספר שלם: אופציונלי |
kTag_WDMPathArrayValueSelector
|
רכיב הנתיב תואם למערך בסכימה, והרכיב המוקפץ משמש כבורר רשומות. סוג תג: סוג רכיב ספציפי לפרופיל: פריסת מבנה: אופציונלי |
kTag_WDMPathList
|
הרכיב הוא רשימה של נתיבי TLV. סוג תג: סוג רכיב ספציפי לפרופיל: מערך: רמה עליונה |
kTag_WDMPathProfile
|
הרכיב הוא מבנה המשמש להתחלת נתיב, ומכיל את פרטי הפרופיל שלפיהם יש לפרש את התגים בנתיב. סוג תג: סוג רכיב ספציפי לפרופיל: פריסת מבנה: נדרש |
kTag_WDMPathProfileId
|
הרכיב הוא רכיב של מזהה פרופיל ברכיב פרופיל הנתיב שמתחיל נתיב TLV. סוג תג: סוג רכיב ספציפי להקשר: העברת מספר שלם: נדרש |
kTag_WDMPathProfileId_Deprecated
|
הוּצא משימוש. סוג תג: סוג רכיב ספציפי לפרופיל: העברת מספר שלם: נדרש |
kTag_WDMPathProfileInstance
|
הרכיב הוא מופע פרופיל, והוא עשוי לעקוב אחרי מזהה הפרופיל בנתיב TLV. הערה: לצומת יכולים להיות כמה מופעים של פרופיל מסוים, וגם מקרים שבהם יש רק אחד מהם, ייתכן שהרכיב הזה יושמט. סוג תג: סוג רכיב ספציפי להקשר: כל חיסרון: אופציונלי |
kTag_WDMPathProfileInstance_Deprecated
|
הוּצא משימוש. סוג תג: סוג רכיב ספציפי לפרופיל: כל נטייה: אופציונלי |
@171
@171
מזהי נושאים ייחודיים.
יש שלושה מזהי נושאים ייחודיים שמעניינים אתכם, ושלושת מהם בפורמט 'ספציפי לבעל אתר'.
תכונות | |
---|---|
kAnyTopicId
|
שמור כמזהה נושא עם תו כללי לחיפוש. |
kTopicIdNotSpecified
|
זהו ערך מיוחד השמור לציון מזהה נושא לא חוקי או עם תו כללי לחיפוש. |
kTopicIdPublisherSpecificMask
|
משמש כמסכה ליצירה או לפרק מזהה של Topci. |
WeaveTransportOption
WeaveTransportOption
אפשרויות העברה של WDM.
אלו אפשרויות העברה בלעדיות ל-WDM.
תכונות | |
---|---|
kTransport_TCP
|
התעבורה הבסיסית היא TCP. ניתן להשלים את הקישור באמצעות מנהל השירות או ישירות באמצעות שכבת ההודעה. |
kTransport_UDP
|
התעבורה הבסיסית היא UDP בלבד. |
kTransport_WRMP
|
התעבורה הבסיסית היא אך ורק UDP, אבל עם שיפורים באמינות של 'שכבת התמיכה באפליקציות'. |
ערכי דף
TopicIdentifier
uint64_t TopicIdentifier
מזהה הנושא.
מזהי נושאים הם כמויות של 64 ביט עם שני שימושים/סמנטיקה קשורים. קודם כול, הם עשויים לשמש כקיצור נפוץ לקבוצת מסלולים ידועה, כמו "גלאי העשן של Nest". מזהי נושאים שנעשה בהם שימוש בדרך הזו צריכים להכיל קוד ספק, שמונע התנגשויות בין מזהי נושאים שנבחרו באופן עצמאי על ידי ספקים שונים, באופן הבא:
ביט 48 - 63 | ביט 0 - 47 |
מזהה הספק | מספר הנושא |
WeaveVendorIdentifiers.hpp
פונקציות
CheckTLVType
bool CheckTLVType( nl::Weave::TLV::TLVType aType, nl::Weave::TLV::TLVReader & aReader )
בודקים שרכיב TLV שבקריאה הוא מסוג TLV הצפוי.
בודקים סוג TLV נתון מול סוג הרכיב בחלק העליון של קורא TLV.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
||||
החזרות |
TRUEiff ל-TLVType של הרכיב להתאמה ל-aType.
|
WeaveTLVTypes.h
CheckWDMTag
bool CheckWDMTag( uint32_t aTagNum, nl::Weave::TLV::TLVReader & aReader )
יש לבדוק תג ספציפי ל-WDM.
בודקים את המספר של תג ספציפי ל-WDM, מ-.../data-management/DMConstants.h, לעומת התג בפועל בחלק העליון של קורא TLV.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
||||
החזרות |
true iff aReader.GetTag() יוצר תג שתואם לאחד מטופסי התג הצפוי עבור מספר התג הנתון.
|
CloseDataListElement
WEAVE_ERROR CloseDataListElement( nl::Weave::TLV::TLVReader & aReader )
הפסקת הקריאה של רכיב רשימת נתונים של WDM.
השיטה הזו מניחה שהרכיב המדובר הוא חלק מרשימת נתונים של WDM, ולכן מעבירה את kTLVType_Array ל-ExitContainer().
פרטים | |||
---|---|---|---|
פרמטרים |
|
||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, מחזירים WEAVE_ERROR שמשקפת חוסר יכולת לצאת מקונטיינר.
|
CloseList
WEAVE_ERROR CloseList( nl::Weave::TLV::TLVReader & aReader )
הפסקת הקריאה של נתיב או רשימת נתונים של WDM.
השיטה הזו מניחה שהרשימה הרלוונטית היא רכיב TLV העליון ביותר, ולכן מעבירה את kTLVType_Sructure אל ExitContainer().
פרטים | |||
---|---|---|---|
פרמטרים |
|
||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, מחזירים WEAVE_ERROR שמשקפת חוסר יכולת לצאת מקונטיינר.
|
EncodeDeprecatedPath
WEAVE_ERROR EncodeDeprecatedPath( TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ... )
יש לקודד נתיב WDM עם תגים שהוצאו משימוש ומזהה מכונה עם מספר שלם.
הערה: קודד נתיב באמצעות קבוצת התגים שהוצאה משימוש שאושרה על ידי השירות לפני גרסה 2.0 של Weave. גרסה זו של השיטה לוקחת מזהה מכונה מספרי. השיטה הזו מפעילה מאגר עם ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfile) ולאחר מכן מוסיפה את מזהה הפרופיל עם ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileId_הוצא משימוש). לאחר מכן, הוא מוסיף את מזהה המכונה עם ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileInstance_Removed). זוהי אחת מהגרסאות שהוצאו משימוש בקידוד נתיב, ועיצובים חדשים יימנעו משימוש בפורמט זה.
פרטים | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||||||||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, מחזירים WEAVE_ERROR המשקפת את חוסר היכולת לפרמט את הנתיב הנתון.
|
EncodeDeprecatedPath
WEAVE_ERROR EncodeDeprecatedPath( TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ... )
יש לקודד נתיב WDM באמצעות תגים שהוצאו משימוש ומזהה מופע של מחרוזת.
הערה: קידוד נתיב באמצעות קבוצת התגים שהוצאה משימוש (מידע נוסף זמין בדף DMConstants.h). בגרסה הזו של השיטה מופיעה מחרוזת של מזהה מכונה. השיטה הזו מפעילה מאגר עם ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfile) ולאחר מכן מוסיפה את מזהה הפרופיל עם ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileId_הוצא משימוש). לאחר מכן, הוא מוסיף את מזהה המכונה עם ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileInstance_Removed). זוהי אחת מהגרסאות שהוצאו משימוש בקידוד נתיב, ועיצובים חדשים יימנעו משימוש בפורמט זה.
פרטים | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||||||||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, מחזירים WEAVE_ERROR המשקפת את חוסר היכולת לפרמט את הנתיב הנתון.
|
EncodePath
WEAVE_ERROR EncodePath( TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ... )
קידוד נתיב WDM עם מזהה מופע של פרופיל מספר שלם.
הערה:כדאי לכתוב נתיב TLV מהסוג שבו משתמשים בניהול נתונים, כאשר באופן ספציפי יש סיווג פרופיל בתחילתו, כדי לאפשר פרשנות של רכיבי הנתיב הבאים. גרסה זו של השיטה לוקחת מזהה מופע של פרופיל במספר שלם.
השיטה הזו מוסיפה מזהה מופע באמצעות ContextTag(kTag_WDMPathProfileInstance), שהוא הגרסה האחרונה לקידוד נתיב.
פרטים | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||||||||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, מחזירים WEAVE_ERROR המשקפת את חוסר היכולת לפרמט את הנתיב הנתון.
|
EncodePath
WEAVE_ERROR EncodePath( TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint32_t aInstanceIdLen, const uint8_t *aInstanceId, uint32_t aPathLen, ... )
קידוד נתיב WDM באמצעות מזהה מופע של מערך בייטים.
הערה:כדאי לכתוב נתיב TLV מהסוג שבו משתמשים בניהול נתונים, כאשר באופן ספציפי יש סיווג פרופיל בתחילתו, כדי לאפשר פרשנות של רכיבי הנתיב הבאים. הגרסה הזו של השיטה לוקחת מזהה מופע של פרופיל מערך בייטים עם אורך.
השיטה הזו מוסיפה מזהה מופע באמצעות ContextTag(kTag_WDMPathProfileInstance), שהוא הגרסה האחרונה לקידוד נתיב.
פרטים | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||||||||||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, מחזירים WEAVE_ERROR המשקפת את חוסר היכולת לפרמט את הנתיב הנתון.
|
EncodePath
WEAVE_ERROR EncodePath( TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ... )
קידוד נתיב WDM באמצעות מזהה מופע של מחרוזת.
הערה:כדאי לכתוב נתיב TLV מהסוג שבו משתמשים בניהול נתונים, כאשר באופן ספציפי יש סיווג פרופיל בתחילתו, כדי לאפשר פרשנות של רכיבי הנתיב הבאים. גרסה זו של השיטה לוקחת מזהה מופע של פרופיל מחרוזת.
השיטה הזו מוסיפה מזהה מופע באמצעות ContextTag(kTag_WDMPathProfileInstance), שהוא הגרסה האחרונה לקידוד נתיב.
פרטים | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||||||||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, מחזירים WEAVE_ERROR המשקפת את חוסר היכולת לפרמט את הנתיב הנתון.
|
EndDataListElement
WEAVE_ERROR EndDataListElement( nl::Weave::TLV::TLVWriter & aWriter )
מסיימים לכתוב רכיב של רשימת נתונים.
כותבים את TLV לסוף רכיב רשימת הנתונים של WDM. חשוב לשים לב שפעולה זו מעבירה באופן אוטומטי סוג של kTLVType_Array לקריאה של EndContainer() בהנחה שאנחנו סוגרים תמיד פריט ברשימה.
פרטים | |||
---|---|---|---|
פרמטרים |
|
||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, מחזירים WEAVE_ERROR שמשקפת חוסר יכולת לסיים קונטיינר.
|
EndEncodePath
WEAVE_ERROR EndEncodePath( TLVWriter & aWriter, TLVType & mOuterContainer, WEAVE_ERROR mError )
EndList
WEAVE_ERROR EndList( nl::Weave::TLV::TLVWriter & aWriter )
מסיימים לכתוב רשימת נתיבים או רשימת נתונים.
כותבים את TLV לסוף של נתיב WDM או רשימת נתונים. כמו כן, השלימו את תהליך המחבר.
פרטים | |||
---|---|---|---|
פרמטרים |
|
||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, מחזירים WEAVE_ERROR שמשקפת חוסר יכולת לסיים קונטיינר.
|
EndList
WEAVE_ERROR EndList( ReferencedTLVData & aList, nl::Weave::TLV::TLVWriter & aWriter )
מסיימים לכתוב רשימת נתיבים או רשימת נתונים.
כותבים את TLV לסוף של נתיב WDM או רשימת נתונים. כמו כן, השלימו את תהליך המחבר. במקרה הזה, האובייקט ReferencedTLVData, שאליו נכתבת ה-TLV, מועבר ומשתנה כך שישקף את כמות הנתונים שכותבים.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
||||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, מחזירים WEAVE_ERROR שמשקפת חוסר יכולת לסיים קונטיינר.
|
IsPublisherSpecific
bool IsPublisherSpecific( const TopicIdentifier & aTopicId )
בודקים אם מזהה הנושא הוא ספציפי לבעל תוכן דיגיטלי.
פרטים | |||
---|---|---|---|
פרמטרים |
|
||
החזרות |
TRUE אם מזהה הנושא הוא ספציפי לבעל אתר, false אם לא
|
OpenDataList
WEAVE_ERROR OpenDataList( ReferencedTLVData & aDataList, nl::Weave::TLV::TLVReader & aReader )
מתחילים לקרוא רשימת נתונים.
באמצעות קורא עדכני ורשימת נתונים, תוכלו להתחיל לקרוא את הרשימה ולאמת את התגים והסוגים שזוהו בתהליך הראשוני. אם הכול תקין, הקורא מפסיק לפעול אחרי שמזינים את מאגר הרשימה.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
||||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, יחזיר WEAVE_ERROR המשקפת כשל, לאחר פתיחת רשימת הנתונים ו/או תיקוף התגים והסוגים הרלוונטיים.
|
OpenDataListElement
WEAVE_ERROR OpenDataListElement( nl::Weave::TLV::TLVReader & aReader, nl::Weave::TLV::TLVReader & aPathReader, uint64_t & aVersion )
התחלת קריאה של רכיב ברשימת נתונים.
בהנחה שקורא ממוקם ברכיב של רשימת נתונים, מתחילים לקרוא את הרכיב ומאמתים את התגים והסוגים שצוינו בתהליך הראשוני. אם הכול מתבצע בצורה תקינה, הקורא ממוקם בסופו של דבר בנתונים של רכיב הנתונים, והקורא של הנתיב הנכנס/היוצא ממוקם בנתיב המתאים.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
החזרות |
WEAVE_NO_ERROR בהצלחה, או שגיאה מסוג WEAVE_ERROR המשויכת לפתיחה ולקריאה של הרכיב של רשימת הנתונים.
|
OpenPathList
WEAVE_ERROR OpenPathList( ReferencedTLVData & aPathList, nl::Weave::TLV::TLVReader & aReader )
התחל לקרוא רשימת נתיבים.
בהנחה שיש לכם קורא חדש ורשימת נתיבים, תוכלו להתחיל לקרוא את הרשימה ולאמת את התגים והסוגים שזוהו בתהליך הראשוני. אם הכול תקין, הקורא מפסיק לפעול אחרי שמזינים את מאגר הרשימה.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
||||
החזרות |
WEAVE_NO_ERROR בהצלחה; אחרת, תופיע WEAVE_ERROR המשקפת כשל בפתיחת רשימת הנתיבים ו/או באימות התגים והסוגים הרלוונטיים.
|
PublisherSpecificTopicId
TopicIdentifier PublisherSpecificTopicId( void )
יצירת מזהה נושא חדש וספציפי לבעל תוכן דיגיטלי.
פרטים | |
---|---|
החזרות |
המזהה החדש של הנושא.
|
SendStatusReport
WEAVE_ERROR SendStatusReport( ExchangeContext *aExchangeCtx, StatusReport & aStatus )
StartDataList
WEAVE_ERROR StartDataList( nl::Weave::TLV::TLVWriter & aWriter )
מתחילים לכתוב רשימת נתונים.
כותבים את TLV בתחילת רשימת נתונים של WDM. למשל, כארגומנט הראשי של UpdateRequest() .
פרטים | |||
---|---|---|---|
פרמטרים |
|
||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, מחזירים WEAVE_ERROR שמשקפת חוסר יכולת להפעיל קונטיינר.
|
StartDataList
WEAVE_ERROR StartDataList( ReferencedTLVData & aDataList, nl::Weave::TLV::TLVWriter & aWriter )
מתחילים לכתוב רשימת נתונים לאובייקט ReferencedTLVData.
כותבים את TLV בתחילת רשימת נתוני WDM. במקרה הזה, אנחנו מניחים שאנחנו כותבים את רשימת הנתונים למבנה נתוני TLV שיש אליו הפניה. ההנחה היא שהמחבר לא מאותחל - או, במקרה כלשהו, יופעל כדי להצביע על האובייקט הנתון.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
||||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, מחזירים WEAVE_ERROR שמשקפת חוסר יכולת להפעיל קונטיינר.
|
StartDataListElement
WEAVE_ERROR StartDataListElement( nl::Weave::TLV::TLVWriter & aWriter )
מתחילים לכתוב רכיב של רשימת נתונים.
כותבים את TLV לתחילת רכיב רשימת הנתונים של WDM.
פרטים | |||
---|---|---|---|
פרמטרים |
|
||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, מחזירים WEAVE_ERROR שמשקפת חוסר יכולת להפעיל קונטיינר.
|
StartEncodePath
WEAVE_ERROR StartEncodePath( TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, TLVType & mOuterContainer, TLVType & mPath )
StartPathList
WEAVE_ERROR StartPathList( nl::Weave::TLV::TLVWriter & aWriter )
מתחילים לכתוב רשימת נתיבים.
כותבים TLV בתחילת רשימת נתיבים של WDM. למשל, כארגומנט הראשי של ViewRequest() .
פרטים | |||
---|---|---|---|
פרמטרים |
|
||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, מחזירים WEAVE_ERROR שמשקפת חוסר יכולת להפעיל קונטיינר.
|
TxnResponseHandler
void TxnResponseHandler( ExchangeContext *anExchangeCtx, const IPPacketInfo *anAddrInfo, const WeaveMessageInfo *aMsgInfo, uint32_t aProfileId, uint8_t aMsgType, PacketBuffer *aMsg )
TxnTimeoutHandler
void TxnTimeoutHandler( ExchangeContext *anExchangeCtx )
ValidateTLVType
WEAVE_ERROR ValidateTLVType( nl::Weave::TLV::TLVType aType, nl::Weave::TLV::TLVReader & aReader )
מוודאים שרכיב TLV שבקריאה הוא מסוג TLV הצפוי.
בודקים סוג TLV נתון מול סוג הרכיב בחלק העליון של קורא TLV ומחזירים שגיאה אם אין התאמה.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
||||
החזרות |
WEAVE_NO_ERROR אם יש התאמה, או WEAVE_ERROR_WRONG_TLV_TYPE אם לא.
|
WeaveTLVTypes.h
ValidateWDMTag
WEAVE_ERROR ValidateWDMTag( uint32_t aTagNum, nl::Weave::TLV::TLVReader & aReader )
מוודאים שרכיב TLV שבקריאה מכיל את תג WDM הצפוי.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
||||
החזרות |
WEAVE_NO_ERROR בהצלחה. אחרת, WEAVE_ERROR_INVALID_TLV_TAG אם התג לא תואם למספר התג הנתון כאשר הוא מפורש כתג WDM.
|