ไม่มี:: สาน:: โปรไฟล์:: DataManagement_Legacy
เนมสเปซนี้รวมอินเทอร์เฟซทั้งหมดภายใน Weave สำหรับโปรไฟล์ Weave Data Management (WDM) ที่กำลังจะเลิกใช้
สรุป
Typedefs | |
---|---|
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 ด้วยแท็กที่เลิกใช้แล้วและ ID อินสแตนซ์จำนวนเต็ม |
EncodeDeprecatedPath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ...) | เข้ารหัสเส้นทาง WDM ด้วยแท็กที่เลิกใช้แล้วและ ID อินสแตนซ์สตริง |
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ...) | เข้ารหัสเส้นทาง WDM ด้วย ID อินสแตนซ์ของโปรไฟล์จำนวนเต็ม |
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint32_t aInstanceIdLen, const uint8_t *aInstanceId, uint32_t aPathLen, ...) | เข้ารหัสเส้นทาง WDM ด้วย ID อินสแตนซ์อาร์เรย์ไบต์ |
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ...) | เข้ารหัสเส้นทาง WDM ด้วย ID อินสแตนซ์สตริง |
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) | สร้าง ID หัวข้อเฉพาะผู้เผยแพร่ตั้งแต่เริ่มต้น |
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 ที่คาดหวัง |
การแจงนับ
@103
@103
@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
ค่าเหล่านี้ถูกเรียกออกมาในข้อกำหนดการจัดการข้อมูล
บันทึก!! ณ ไตรมาสที่ 1 ปี 2015 ประเภทข้อความที่ใช้ใน WDM เวอร์ชันก่อนหน้าได้เลิกใช้แล้วและมีการกำหนดประเภทข้อความใหม่แล้ว ซึ่งสะท้อนถึงการเปลี่ยนแปลงที่เพียงพอกับรายละเอียดการบรรจุและการแยกวิเคราะห์ที่ผ่านมาเพื่อปรับการแบ่งที่สะอาด
@168
@168
ค่าคงที่เฉพาะ WDM เบ็ดเตล็ด
คุณสมบัติ | |
---|---|
kDefaultBindingTableIndex | ดัชนีของการรวมเริ่มต้นในตารางการเชื่อมโยงเอ็นจินโปรโตคอลที่มีมากกว่าหนึ่งรายการ |
kInstanceIdNotSpecified | ในการเรียกที่ต้องใช้ข้อมูลจำเพาะของอินสแตนซ์ของโปรไฟล์ จะระบุว่า "ไม่มี" ส่วนใหญ่มักจะหมายความว่ามีเพียงหนึ่งอินสแตนซ์ของโปรไฟล์ที่มีอยู่ในเอนทิตีที่เป็นปัญหา |
kResponseTimeoutNotSpecified | ในเมธอดที่ขอธุรกรรม แสดงว่าผู้โทรปฏิเสธที่จะระบุการหมดเวลา โดยทั่วไปหมายความว่าควรใช้ค่าเริ่มต้น |
kTransactionIdNotSpecified | ในเมธอดและโครงสร้างข้อมูลที่ใช้รหัสธุรกรรม จะระบุว่า "ไม่มี" หรือค่าไวด์การ์ด |
kVersionNotSpecified | ในการเรียกที่ต้องการข้อมูลจำเพาะของเวอร์ชันข้อมูล แสดงว่า "ไม่มีเวอร์ชันเฉพาะ" |
kWeaveTLVControlByteLen | ความยาวของ TLV ควบคุมไบต์ใช้ในวิธีการสนับสนุนว่าโครงสร้างเข้ารหัส WDM ใน TLV |
kWeaveTLVTagLen | ความยาวมาตรฐานไบต์เต็มที่มีคุณภาพ TLV แท็กที่ใช้ในวิธีการสนับสนุนว่าโครงสร้างเข้ารหัส WDM ใน TLV |
@169
@169
รหัสสถานะเฉพาะ WDM
@170
@170
แท็กโปรโตคอลการจัดการข้อมูล
โปรโตคอลการจัดการข้อมูลกำหนดจำนวนแท็กเพื่อนำมาใช้ใน TLV ตัวแทนของข้อมูลรายละเอียด
ตามปกติจะมีปัญหาความเข้ากันได้ระหว่าง WDM ใหม่และเก่า ในสมัยก่อนแย่ แท็กเหล่านี้ทั้งหมดถูกใช้เป็นแบบเฉพาะโปรไฟล์ ซึ่งเปลืองเนื้อที่ ตอนนี้เรากำลังใช้แท็กบริบทหากเป็นไปได้ แต่เราจำเป็นต้องเก็บแท็กเก่าไว้ (และมีกลไกสำหรับการเข้ารหัสเส้นทางด้วย) ตามความเหมาะสม
แท็ก kTag_WDMDataListElementData ไม่ได้ใช้ในรุ่นก่อนหน้าและถูกละเว้นโดยโค้ดโดยสิ้นเชิง ดังนั้นเราจึงไม่ต้องจัดเตรียมเวอร์ชันที่เลิกใช้แล้ว
คุณสมบัติ | |
---|---|
kTag_WDMDataList | องค์ประกอบนี้เป็นรายการโครงสร้างที่มีพาธ รุ่นทางเลือก และองค์ประกอบข้อมูล ประเภทแท็ก: Profile-specific Element Type: Array Disposition: Top-level |
kTag_WDMDataListElementData | องค์ประกอบแสดงถึงข้อมูลที่ชี้ไปตามเส้นทางที่กำหนดและมีเวอร์ชันที่กำหนด ประเภทแท็ก: Context-specific Element Type: Any Disposition: Required |
kTag_WDMDataListElementData_Deprecated | เลิกใช้แล้ว ประเภทแท็ก: Context-specific Element Type: Any Disposition: Required |
kTag_WDMDataListElementPath | องค์ประกอบนี้เป็นองค์ประกอบเส้นทางขององค์ประกอบรายการข้อมูล ประเภทแท็ก: Context-specific Element Type: เส้นทางการจัดการ: จำเป็น |
kTag_WDMDataListElementPath_Deprecated | เลิกใช้แล้ว ประเภทแท็ก: Profile-specific Element Type: เส้นทางการจัดการ: จำเป็น |
kTag_WDMDataListElementVersion | องค์ประกอบนี้เป็นองค์ประกอบเวอร์ชันขององค์ประกอบรายการข้อมูล ประเภทแท็ก: Context-specific Element Type: Integer Disposition: Required |
kTag_WDMDataListElementVersion_Deprecated | เลิกใช้แล้ว ประเภทแท็ก: Profile-specific Element Type: Integer Disposition: Required |
kTag_WDMPathArrayIndexSelector | องค์ประกอบเส้นทางสอดคล้องกับอาร์เรย์ในสคีมาและองค์ประกอบจำนวนเต็มที่มีอยู่จะถูกใช้เป็นดัชนีในอาร์เรย์นั้น ประเภทแท็ก: Profile-specific Element Type: Integer Disposition: Optional |
kTag_WDMPathArrayValueSelector | อิลิเมนต์พาธสอดคล้องกับอาร์เรย์ในสคีมา และอิลิเมนต์ที่ห่อหุ้มจะใช้เป็นตัวเลือกเรกคอร์ด ประเภทแท็ก: เฉพาะโปรไฟล์ ประเภทองค์ประกอบ: โครงสร้าง การจัดการ: ตัวเลือก |
kTag_WDMPathList | องค์ประกอบที่เป็นรายการของ TLV เส้นทาง ประเภทแท็ก: Profile-specific Element Type: Array Disposition: Top-level |
kTag_WDMPathProfile | องค์ประกอบนี้เป็นโครงสร้างที่ใช้ในการเริ่มต้นเส้นทางและมีข้อมูลโปรไฟล์โดยที่แท็กในเส้นทางจะถูกตีความ ประเภทแท็ก: เฉพาะโปรไฟล์ ประเภทองค์ประกอบ: โครงสร้าง จำหน่าย: จำเป็น |
kTag_WDMPathProfileId | องค์ประกอบที่เป็นส่วนประกอบ ID รายละเอียดขององค์ประกอบรายละเอียดเส้นทางที่จะเริ่มต้น TLV เส้นทาง ประเภทแท็ก: Context-specific Element Type: Integer Disposition: Required |
kTag_WDMPathProfileId_Deprecated | เลิกใช้แล้ว ประเภทแท็ก: Profile-specific Element Type: Integer Disposition: Required |
kTag_WDMPathProfileInstance | องค์ประกอบที่เป็นเช่นรายละเอียดซึ่งอาจปฏิบัติตามรหัสโปรไฟล์ใน TLV เส้นทาง โปรดทราบว่าโหนดอาจมีหรือไม่มีหลายอินสแตนซ์ของโปรไฟล์เฉพาะ และในกรณีที่มีเพียงหนึ่งองค์ประกอบ อาจถูกละเว้น ประเภทแท็ก: Context-specific Element Type: Any Disposition: Optional |
kTag_WDMPathProfileInstance_Deprecated | เลิกใช้แล้ว ประเภทแท็ก: Profile-specific Element Type: ใด ๆ จำหน่าย: Optional |
@171
@171
ID หัวข้อที่โดดเด่น
มีรหัสหัวข้อที่น่าสนใจสามรายการ โดยทั้งสามมีรูปแบบเป็น "เฉพาะผู้เผยแพร่โฆษณา"
WeaveTransportOption
WeaveTransportOption
ตัวเลือกการขนส่ง WDM
สิ่งเหล่านี้เป็นตัวเลือกการขนส่งที่แยกจากกันสำหรับ WDM
Typedefs
ตัวระบุหัวข้อ
uint64_t TopicIdentifier
ตัวระบุหัวข้อ
ตัวระบุหัวข้อคือปริมาณ 64 บิตที่มีการใช้/ความหมายที่เกี่ยวข้องสองรายการ ประการแรก อาจใช้เป็นชวเลขแบบธรรมดาสำหรับชุดเส้นทางที่รู้จักกันดี เช่น "เครื่องตรวจจับควัน Nest" รหัสหัวข้อที่ใช้ในลักษณะนี้ เหมือนกับตัวระบุโปรไฟล์ มีรหัสผู้ขายที่ป้องกัน ID หัวข้อที่เลือกโดยอัตโนมัติโดยผู้ขายที่แตกต่างกันไม่ให้ขัดแย้งกัน ดังนี้:
บิต 48 - 63 | บิต 0 - 47 |
รหัสผู้ขาย | หมายเลขหัวข้อ |
WeaveVendorIdentifiers.hpp
ฟังก์ชั่น
ตรวจสอบTLVType
bool CheckTLVType( nl::Weave::TLV::TLVType aType, nl::Weave::TLV::TLVReader & aReader )
ตรวจสอบว่า TLV อ่านองค์ประกอบเป็นมีที่คาดว่าจะ TLV ประเภท
ตรวจสอบให้ TLV ประเภทกับประเภทองค์ประกอบที่หัวของที่ TLV อ่าน
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
| ||||
คืนสินค้า | true ถ้า TLVType ขององค์ประกอบและ aType ตรงกัน |
WeaveTLVTypes.h
ตรวจสอบWDMTแท็ก
bool CheckWDMTag( uint32_t aTagNum, nl::Weave::TLV::TLVReader & aReader )
ตรวจสอบแท็กเฉพาะ WDM
ตรวจสอบหมายเลขของแท็ก WDM เฉพาะจาก ... ข้อมูล / การจัดการ / 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 สะท้อนให้เห็นถึงการไร้ความสามารถที่จะออกจากภาชนะ |
ปิดรายการ
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 ด้วยแท็กที่เลิกใช้แล้วและ ID อินสแตนซ์จำนวนเต็ม
หมายเหตุ: การเข้ารหัสเส้นทางโดยใช้ชุดแท็กเลิกการยอมรับจากบริการก่อนสานปล่อย 2.0 เมธอดเวอร์ชันนี้ใช้ตัวระบุอินสแตนซ์ที่เป็นตัวเลข เมธอดนี้เริ่มต้นคอนเทนเนอร์ด้วย ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfile) จากนั้นแทรก ID โปรไฟล์ด้วย ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileId_Deprecated) จากนั้นแทรก ID อินสแตนซ์ด้วย ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileInstance_Deprecated) นี่เป็นหนึ่งในเวอร์ชันที่เลิกใช้แล้วสำหรับการเข้ารหัสเส้นทาง และการออกแบบใหม่จะต้องหลีกเลี่ยงการใช้รูปแบบนี้
รายละเอียด | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
| ||||||||||||
คืนสินค้า | 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 ด้วยแท็กที่เลิกใช้แล้วและ ID อินสแตนซ์สตริง
หมายเหตุ: การเข้ารหัสเส้นทางโดยใช้ชุดแท็กเลิก (ดู DMConstants.h) เมธอดเวอร์ชันนี้ใช้สตริง ID อินสแตนซ์ เมธอดนี้เริ่มต้นคอนเทนเนอร์ด้วย ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfile) จากนั้นแทรก ID โปรไฟล์ด้วย ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileId_Deprecated) จากนั้นแทรก ID อินสแตนซ์ด้วย ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileInstance_Deprecated) นี่เป็นหนึ่งในเวอร์ชันที่เลิกใช้แล้วสำหรับการเข้ารหัสเส้นทาง และการออกแบบใหม่จะต้องหลีกเลี่ยงการใช้รูปแบบนี้
รายละเอียด | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
| ||||||||||||
คืนสินค้า | 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 ด้วย ID อินสแตนซ์ของโปรไฟล์จำนวนเต็ม
หมายเหตุ: การเขียน TLV เส้นทางของชนิดที่ใช้ในการจัดการข้อมูลที่โดยเฉพาะอย่างยิ่งมีการกำหนดรายละเอียดที่วางอยู่ที่จุดเริ่มต้นเพื่อให้ความหมายขององค์ประกอบเส้นทางที่ตามมา เมธอดเวอร์ชันนี้ใช้ ID อินสแตนซ์โปรไฟล์จำนวนเต็ม
เมธอดนี้แทรก ID อินสแตนซ์โดยใช้ 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 ด้วย ID อินสแตนซ์อาร์เรย์ไบต์
หมายเหตุ: การเขียน TLV เส้นทางของชนิดที่ใช้ในการจัดการข้อมูลที่โดยเฉพาะอย่างยิ่งมีการกำหนดรายละเอียดที่วางอยู่ที่จุดเริ่มต้นเพื่อให้ความหมายขององค์ประกอบเส้นทางที่ตามมา เมธอดเวอร์ชันนี้ใช้ ID อินสแตนซ์โปรไฟล์แบบไบต์อาเรย์พร้อมกับความยาว
เมธอดนี้แทรก ID อินสแตนซ์โดยใช้ 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 ด้วย ID อินสแตนซ์สตริง
หมายเหตุ: การเขียน TLV เส้นทางของชนิดที่ใช้ในการจัดการข้อมูลที่โดยเฉพาะอย่างยิ่งมีการกำหนดรายละเอียดที่วางอยู่ที่จุดเริ่มต้นเพื่อให้ความหมายขององค์ประกอบเส้นทางที่ตามมา เมธอดเวอร์ชันนี้ใช้ ID อินสแตนซ์โปรไฟล์สตริง
เมธอดนี้แทรก ID อินสแตนซ์โดยใช้ 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 หาก ID หัวข้อเฉพาะผู้เผยแพร่เท่านั้น มิฉะนั้นจะเป็นเท็จ |
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 )
สร้าง ID หัวข้อเฉพาะผู้เผยแพร่ตั้งแต่เริ่มต้น
รายละเอียด | |
---|---|
คืนสินค้า | ตัวระบุหัวข้อใหม่ |
SendStatusReport
WEAVE_ERROR SendStatusReport( ExchangeContext *aExchangeCtx, StatusReport & aStatus )
StartDataList
WEAVE_ERROR StartDataList( nl::Weave::TLV::TLVWriter & aWriter )
เริ่มเขียนรายการข้อมูล
เขียน TLV สำหรับจุดเริ่มต้นของรายการข้อมูล WDM e กรัมเป็นอาร์กิวเมนต์หลักของการ 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 e กรัมเป็นอาร์กิวเมนต์หลักของ 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 )
ตรวจสอบTLVType
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
ตรวจสอบWDMTag
WEAVE_ERROR ValidateWDMTag( uint32_t aTagNum, nl::Weave::TLV::TLVReader & aReader )
ตรวจสอบว่า TLV องค์ประกอบการอ่านมีแท็ก WDM ที่คาดหวัง
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
| ||||
คืนสินค้า | WEAVE_NO_ERROR ประสบความสำเร็จใน มิฉะนั้น WEAVE_ERROR_INVALID_TLV_TAG หากแท็กไม่ตรงกับจำนวนแท็กได้รับเมื่อตีความว่าเป็นแท็ก WDM |