nl:: Menenun:: Profil:: DataManagement_Legacy
Namespace ini mencakup semua antarmuka dalam profil Weave untuk Weave Data Management (WDM) yang akan segera dihentikan.
Ringkasan
Typedef | |
---|---|
TopicIdentifier | typedefuint64_t Pengidentifikasi topik. |
Fungsi | |
---|---|
CheckTLVType ( nl::Weave::TLV::TLVType aType,nl::Weave::TLV::TLVReader & aReader) | bool |
CheckWDMTag (uint32_t aTagNum,nl::Weave::TLV::TLVReader & aReader) | bool Periksa tag khusus WDM. |
CloseDataListElement (nl::Weave::TLV::TLVReader & aReader) | Berhenti membaca elemen daftar data WDM. |
CloseList (nl::Weave::TLV::TLVReader & aReader) | Berhenti membaca jalur WDM atau daftar data. |
EncodeDeprecatedPath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ...) | Enkode jalur WDM dengan tag yang tidak digunakan lagi dan ID instans bilangan bulat. |
EncodeDeprecatedPath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ...) | Enkode jalur WDM dengan tag yang tidak digunakan lagi dan ID instance string. |
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ...) | Enkode jalur WDM dengan ID instans profil integer. |
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint32_t aInstanceIdLen, const uint8_t *aInstanceId, uint32_t aPathLen, ...) | Enkode jalur WDM dengan ID instance array byte. |
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ...) | Enkode jalur WDM dengan ID instance string. |
EndDataListElement (nl::Weave::TLV::TLVWriter & aWriter) | Selesai menulis elemen daftar data. |
EndEncodePath (TLVWriter & aWriter, TLVType & mOuterContainer, WEAVE_ERROR mError) | |
EndList (nl::Weave::TLV::TLVWriter & aWriter) | Selesai menulis daftar jalur atau daftar data. |
EndList ( ReferencedTLVData & aList,nl::Weave::TLV::TLVWriter & aWriter) | Selesai menulis daftar jalur atau daftar data. |
IsPublisherSpecific (const TopicIdentifier & aTopicId) | bool Periksa apakah ID topik khusus penayang. |
OpenDataList ( ReferencedTLVData & aDataList,nl::Weave::TLV::TLVReader & aReader) | Mulai membaca daftar data. |
OpenDataListElement (nl::Weave::TLV::TLVReader & aReader,nl::Weave::TLV::TLVReader & aPathReader, uint64_t & aVersion) | Mulai membaca elemen daftar data. |
OpenPathList ( ReferencedTLVData & aPathList,nl::Weave::TLV::TLVReader & aReader) | Mulai membaca daftar jalur. |
PublisherSpecificTopicId (void) | Buat ID topik khusus penayang dari awal. |
SendStatusReport ( ExchangeContext *aExchangeCtx, StatusReport & aStatus) | |
StartDataList (nl::Weave::TLV::TLVWriter & aWriter) | Mulai menulis daftar data. |
StartDataList ( ReferencedTLVData & aDataList,nl::Weave::TLV::TLVWriter & aWriter) | Mulailah menulis daftar data ke diberikan ReferencedTLVData objek. |
StartDataListElement (nl::Weave::TLV::TLVWriter & aWriter) | Mulai menulis elemen daftar data. |
StartEncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, TLVType & mOuterContainer, TLVType & mPath) | |
StartPathList (nl::Weave::TLV::TLVWriter & aWriter) | Mulai menulis daftar jalur. |
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) | Validasi bahwa TLV elemen makhluk read memiliki tag WDM yang diharapkan. |
Kelas | |
---|---|
nl :: Weave :: Profil :: DataManagement_Legacy :: Binding | The Binding kelas mengelola negara komunikasi atas nama entitas aplikasi yang menggunakan Weave. |
nl :: Weave :: Profil :: DataManagement_Legacy :: ClientDataManager | Kelas abstrak yang berisi definisi metode konfirmasi dan indikasi yang diperlukan oleh klien WDM. |
nl :: Weave :: Profil :: DataManagement_Legacy :: ClientNotifier | Kelas tambahan yang digunakan saat dukungan langganan dan pemberitahuan diinginkan pada klien WDM. |
nl :: Weave :: Profil :: DataManagement_Legacy :: DMClient | Kelas dasar abstrak untuk klien WDM khusus aplikasi. |
nl :: Weave :: Profil :: DataManagement_Legacy :: DMPublisher | Kelas dasar abstrak untuk penerbit WDM khusus aplikasi. |
nl :: Weave :: Profil :: DataManagement_Legacy :: ProfileDatabase | Abstrak ProfileDatabase kelas tambahan. |
nl :: Weave :: Profil :: DataManagement_Legacy :: ProtocolEngine | Kelas mesin protokol WDM. |
nl :: Weave :: Profil :: DataManagement_Legacy :: PublisherDataManager | Kelas abstrak yang berisi definisi metode konfirmasi dan notifikasi yang diperlukan oleh penerbit WDM. |
Enumerasi
@103
@103
@166
@166
Ukuran kolam dan meja WDM.
WDM mendefinisikan berbagai kumpulan dan tabel yang diperlukan untuk operasinya, sebagai berikut.
Kumpulan transaksi klien:
- kViewPoolSize
- kBerlanggananPoolSize
- kCancelSubscriptionPoolSize
- kUpdatePoolSize
Kumpulan transaksi penerbit:
- kNotifyPoolSize
Tabel mesin protokol:
- kTransaksiTableSize
- kBindingTableSize
Tabel terkait langganan:
- kNotifierTableSize (khusus klien)
- kSubscriptionMgrTableSize (khusus penerbit)
Catatan bahwa ini adalah jumlah dikonfigurasi dan bahwa nilai-nilai per-platform muncul di terkait WeaveConfig.h .
Properti | |
---|---|
kBindingTableSize | Ini adalah ukuran default dari tabel binding di mesin protokol WDM. Nilai ini dapat dikonfigurasi melalui WEAVE_CONFIG_WDM_BINDING_TABLE_SIZE . |
kCancelSubscriptionPoolSize | Ini adalah ukuran default dari kumpulan transaksi permintaan pembatalan langganan untuk klien WDM. Nilai ini dapat dikonfigurasi melalui WEAVE_CONFIG_WDM_CANCEL_SUBSCRIPTION_POOL_SIZE . |
kNotifierTableSize | Ini adalah ukuran default tabel notifikasi untuk klien WDM. Nilai ini dapat dikonfigurasi melalui WEAVE_CONFIG_WDM_NOTIFIER_TABLE_SIZE . |
kNotifyPoolSize | Ini adalah ukuran default dari kumpulan transaksi permintaan pemberitahuan untuk penerbit WDM. Nilai ini dapat dikonfigurasi melalui WEAVE_CONFIG_WDM_NOTIFY_POOL_SIZE . |
kSubscribePoolSize | Ini adalah ukuran default dari kumpulan transaksi permintaan berlangganan untuk klien WDM. Nilai ini dapat dikonfigurasi melalui WEAVE_CONFIG_WDM_SUBSCRIBE_POOL_SIZE . |
kSubscriptionMgrTableSize | Ini adalah ukuran default tabel langganan untuk penerbit WDM. Nilai ini dapat dikonfigurasi melalui WEAVE_CONFIG_WDM_SUBSCRIPTION_MGR_TABLE_SIZE . |
kTransactionTableSize | Ini adalah ukuran default tabel transaksi di mesin protokol WDM. Nilai ini dapat dikonfigurasi melalui WEAVE_CONFIG_WDM_TRANSACTION_TABLE_SIZE . |
kUpdatePoolSize | Ini adalah ukuran default dari kumpulan transaksi permintaan pembaruan untuk klien WDM. Nilai ini dapat dikonfigurasi melalui WEAVE_CONFIG_WDM_UPDATE_POOL_SIZE . |
kViewPoolSize | Ini adalah ukuran default dari kumpulan transaksi permintaan tampilan untuk klien WDM. Nilai ini dapat dikonfigurasi melalui WEAVE_CONFIG_WDM_VIEW_POOL_SIZE . |
@167
@167
Jenis pesan profil WDM.
Nilai-nilai ini disebut dalam spesifikasi manajemen data.
CATATAN!! Mulai Q1 2015, jenis pesan yang digunakan dalam versi WDM sebelumnya tidak digunakan lagi dan jenis pesan baru telah ditentukan, yang mencerminkan pergeseran yang cukup dengan detail pengepakan dan penguraian sebelumnya untuk membenarkan jeda yang bersih.
@168
@168
Konstanta khusus WDM lainnya.
Properti | |
---|---|
kDefaultBindingTableIndex | Indeks pengikatan default dalam tabel pengikatan mesin protokol dengan lebih dari satu entri. |
kInstanceIdNotSpecified | Dalam panggilan yang memerlukan spesifikasi instans profil, menunjukkan "tidak ada". Paling sering ini berarti bahwa hanya satu contoh profil yang ada pada entitas yang dimaksud. |
kResponseTimeoutNotSpecified | Dalam metode yang meminta transaksi, menunjukkan bahwa pemanggil telah menolak untuk menentukan batas waktu. Umumnya ini berarti default harus digunakan. |
kTransactionIdNotSpecified | Dalam metode dan struktur data yang mengambil ID transaksi, menunjukkan "tidak ada" atau nilai wild-card. |
kVersionNotSpecified | Dalam panggilan yang membutuhkan spesifikasi versi data, menunjukkan "tidak ada versi tertentu". |
kWeaveTLVControlByteLen | Panjang dari TLV kontrol byte, yang digunakan dalam metode dukungan bahwa struktur encode WDM di TLV . |
kWeaveTLVTagLen | Panjang standar dalam byte penuh berkualitas TLV tag, yang digunakan dalam metode dukungan bahwa struktur encode WDM di TLV . |
@169
@169
Kode status khusus WDM.
@170
@170
Tag Protokol Manajemen Data.
Protokol manajemen data mendefinisikan sejumlah tag yang akan digunakan dalam TLV representasi data profil.
Seperti biasa ada masalah kompatibilitas antara WDM baru dan lama. di masa lalu yang buruk, semua tag ini diterapkan sebagai profil khusus, yang merupakan pemborosan ruang. sekarang kami menggunakan tag konteks jika memungkinkan, tetapi kami harus menyimpan yang lama (dan memiliki mekanisme untuk mengkodekan jalur dengan mereka di tempat) jika sesuai.
Tag kTag_WDMDataListElementData tidak digunakan dalam rilis sebelumnya dan sepenuhnya diabaikan oleh kode, jadi kami tidak perlu menyediakan versi yang tidak digunakan lagi.
Properti | |
---|---|
kTag_WDMDataList | Elemen adalah daftar struktur yang berisi jalur, versi opsional, dan elemen data. Jenis Tag: Jenis Elemen khusus profil: Disposisi Array: Tingkat atas |
kTag_WDMDataListElementData | Elemen mewakili data yang ditunjuk oleh jalur yang diberikan dan memiliki versi yang diberikan. Jenis Tag: Jenis Elemen khusus-konteks: Disposisi Apa Saja: Wajib |
kTag_WDMDataListElementData_Deprecated | Tidak digunakan lagi. Jenis Tag: Jenis Elemen khusus-konteks: Disposisi Apa Saja: Wajib |
kTag_WDMDataListElementPath | Elemen adalah komponen jalur dari elemen daftar data. Jenis Tag: Jenis Elemen Khusus Konteks: Disposisi Jalur: Wajib Path |
kTag_WDMDataListElementPath_Deprecated | Tidak digunakan lagi. Jenis Tag: Jenis Elemen Khusus Profil: Disposisi Jalur: Wajib |
kTag_WDMDataListElementVersion | Elemen adalah komponen versi dari elemen daftar data. Jenis Tag: Jenis Elemen Khusus Konteks: Disposisi Bilangan Bulat: Wajib |
kTag_WDMDataListElementVersion_Deprecated | Tidak digunakan lagi. Jenis Tag: Jenis Elemen Khusus Profil: Disposisi Bilangan Bulat: Wajib |
kTag_WDMPathArrayIndexSelector | Elemen path sesuai dengan array dalam skema dan elemen integer yang terkandung akan digunakan sebagai indeks ke dalam array itu. Jenis Tag: Jenis Elemen khusus profil: Disposisi Bilangan Bulat: Opsional |
kTag_WDMPathArrayValueSelector | Elemen jalur sesuai dengan larik dalam skema dan elemen yang dienkapsulasi akan digunakan sebagai pemilih rekaman. Jenis Tag: Jenis Elemen khusus profil: Disposisi Struktur: Opsional |
kTag_WDMPathList | Unsur adalah daftar TLV jalur. Jenis Tag: Jenis Elemen khusus profil: Disposisi Array: Tingkat atas |
kTag_WDMPathProfile | Elemen adalah struktur yang digunakan untuk memulai jalur dan berisi informasi profil yang akan diinterpretasikan oleh tag di jalur tersebut. Jenis Tag: Jenis Elemen khusus profil: Disposisi Struktur: Diperlukan |
kTag_WDMPathProfileId | Unsur adalah komponen ID profil dari jalur elemen profil yang memulai TLV jalan. Jenis Tag: Jenis Elemen Khusus Konteks: Disposisi Bilangan Bulat: Wajib |
kTag_WDMPathProfileId_Deprecated | Tidak digunakan lagi. Jenis Tag: Jenis Elemen Khusus Profil: Disposisi Bilangan Bulat: Wajib |
kTag_WDMPathProfileInstance | Unsur adalah contoh profil, yang dapat mengikuti ID profil di TLV jalan. Perhatikan bahwa node mungkin atau mungkin tidak memiliki beberapa contoh profil tertentu dan, dalam kasus di mana hanya ada satu, elemen ini dapat dihilangkan. Jenis Tag: Jenis Elemen khusus-konteks: Disposisi Apa Pun: Opsional |
kTag_WDMPathProfileInstance_Deprecated | Tidak digunakan lagi. Jenis Tag: Jenis Elemen khusus profil: Disposisi Apa Pun: Opsional |
@171
@171
ID topik yang berbeda.
Ada tiga ID topik yang menarik, ketiganya diformat sebagai "khusus penayang".
WeaveTransportOption
WeaveTransportOption
Pilihan transportasi WDM.
Ini adalah pilihan transportasi yang saling eksklusif untuk WDM.
Typedef
Pengidentifikasi Topik
uint64_t TopicIdentifier
Pengidentifikasi topik.
Pengidentifikasi topik adalah kuantitas 64-bit dengan dua kegunaan/semantik terkait. Pertama-tama, mereka dapat digunakan sebagai singkatan konvensional untuk rangkaian jalur yang terkenal, misalnya "detektor asap Nest". ID topik yang digunakan dengan cara ini harus, seperti pengidentifikasi profil, berisi kode vendor yang mencegah ID topik yang dipilih secara mandiri oleh vendor yang berbeda agar tidak bertentangan, sebagai berikut:
bit 48 - 63 | bit 0 - 47 |
ID Penjual | Nomor topik |
WeaveVendorIdentifiers.hpp
Fungsi
PeriksaTipe TLV
bool CheckTLVType( nl::Weave::TLV::TLVType aType, nl::Weave::TLV::TLVReader & aReader )
Periksa bahwa TLV elemen menjadi read memiliki diharapkan TLV jenis.
Periksa diberikan TLV jenis terhadap jenis elemen di kepala TLV pembaca.
rincian | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembali | true jika TLVType dari elemen dan aType cocok. |
WeaveTLVTypes.h
PeriksaWDMTag
bool CheckWDMTag( uint32_t aTagNum, nl::Weave::TLV::TLVReader & aReader )
Periksa tag khusus WDM.
Periksa jumlah tag WDM khusus, dari ... / data manajemen / DMConstants.h, terhadap tag yang sebenarnya di kepala TLV pembaca.
rincian | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembali | true iff aReader.GetTag() menghasilkan tag yang cocok dengan salah satu bentuk tag yang diharapkan untuk nomor tag yang diberikan. |
CloseDataListElement
WEAVE_ERROR CloseDataListElement( nl::Weave::TLV::TLVReader & aReader )
Berhenti membaca elemen daftar data WDM.
Metode ini mengasumsikan bahwa elemen yang dimaksud adalah bagian dari daftar data WDM dan dengan demikian meneruskan kTLVType_Array ke ExitContainer().
rincian | |||
---|---|---|---|
Parameter |
| ||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan ketidakmampuan untuk keluar wadah. |
TutupDaftar
WEAVE_ERROR CloseList( nl::Weave::TLV::TLVReader & aReader )
Berhenti membaca jalur WDM atau daftar data.
Metode ini mengasumsikan bahwa daftar tersebut adalah paling atas TLV elemen dan begitu melewati kTLVType_Sructure ke ExitContainer ().
rincian | |||
---|---|---|---|
Parameter |
| ||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan ketidakmampuan untuk keluar wadah. |
EncodeDeprecatedPath
WEAVE_ERROR EncodeDeprecatedPath( TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ... )
Enkode jalur WDM dengan tag yang tidak digunakan lagi dan ID instans bilangan bulat.
Catatan: Encode jalan menggunakan dihentikan tag set diterima oleh layanan sebelum Weave rilis 2.0. Versi metode ini menggunakan pengenal instan numerik. Metode ini memulai wadah dengan ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfile) dan kemudian memasukkan ID profil dengan ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileId_Deprecated). Kemudian memasukkan ID instance dengan ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileInstance_Deprecated). Ini adalah salah satu versi usang untuk pengkodean jalur, dan desain baru harus menghindari penggunaan format ini.
rincian | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||||||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan ketidakmampuan untuk memformat jalan yang diberikan. |
EncodeDeprecatedPath
WEAVE_ERROR EncodeDeprecatedPath( TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ... )
Enkode jalur WDM dengan tag yang tidak digunakan lagi dan ID instance string.
Catatan: Encode jalan menggunakan dihentikan tag set (lihat DMConstants.h). Versi metode ini mengambil string ID instance. Metode ini memulai wadah dengan ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfile) dan kemudian memasukkan ID profil dengan ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileId_Deprecated). Kemudian memasukkan ID instance dengan ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileInstance_Deprecated). Ini adalah salah satu versi usang untuk pengkodean jalur, dan desain baru harus menghindari penggunaan format ini.
rincian | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||||||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan ketidakmampuan untuk memformat jalan yang diberikan. |
EncodePath
WEAVE_ERROR EncodePath( TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ... )
Enkode jalur WDM dengan ID instans profil integer.
Catatan: Tulis TLV jalan dari jenis yang digunakan dalam pengelolaan data di mana, khususnya, ada sebutan profil ditempatkan di awal untuk memungkinkan penafsiran elemen jalan berikutnya. Versi metode ini mengambil ID instance profil integer.
Metode ini menyisipkan ID instance menggunakan ContextTag(kTag_WDMPathProfileInstance), yang merupakan versi terbaru untuk menyandikan jalur.
rincian | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||||||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan ketidakmampuan untuk memformat jalan yang diberikan. |
EncodePath
WEAVE_ERROR EncodePath( TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint32_t aInstanceIdLen, const uint8_t *aInstanceId, uint32_t aPathLen, ... )
Enkode jalur WDM dengan ID instance array byte.
Catatan: Tulis TLV jalan dari jenis yang digunakan dalam pengelolaan data di mana, khususnya, ada sebutan profil ditempatkan di awal untuk memungkinkan penafsiran elemen jalan berikutnya. Versi metode ini mengambil ID instance profil byte-array beserta panjangnya.
Metode ini menyisipkan ID instance menggunakan ContextTag(kTag_WDMPathProfileInstance), yang merupakan versi terbaru untuk menyandikan jalur.
rincian | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||||||||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan ketidakmampuan untuk memformat jalan yang diberikan. |
EncodePath
WEAVE_ERROR EncodePath( TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ... )
Enkode jalur WDM dengan ID instance string.
Catatan: Tulis TLV jalan dari jenis yang digunakan dalam pengelolaan data di mana, khususnya, ada sebutan profil ditempatkan di awal untuk memungkinkan penafsiran elemen jalan berikutnya. Versi metode ini mengambil ID instance profil string.
Metode ini menyisipkan ID instance menggunakan ContextTag(kTag_WDMPathProfileInstance), yang merupakan versi terbaru untuk menyandikan jalur.
rincian | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||||||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan ketidakmampuan untuk memformat jalan yang diberikan. |
EndDataListElement
WEAVE_ERROR EndDataListElement( nl::Weave::TLV::TLVWriter & aWriter )
Selesai menulis elemen daftar data.
Tuliskan TLV untuk akhir WDM daftar elemen data. Perhatikan ini, ini secara otomatis meneruskan jenis kTLVType_Array ke panggilan EndContainer() dengan asumsi bahwa kita selalu menutup item daftar.
rincian | |||
---|---|---|---|
Parameter |
| ||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan ketidakmampuan untuk mengakhiri sebuah wadah. |
EndEncodePath
WEAVE_ERROR EndEncodePath( TLVWriter & aWriter, TLVType & mOuterContainer, WEAVE_ERROR mError )
Daftar Akhir
WEAVE_ERROR EndList( nl::Weave::TLV::TLVWriter & aWriter )
Selesai menulis daftar jalur atau daftar data.
Tuliskan TLV untuk akhir jalan WDM atau daftar data. Juga, menyelesaikan penulis.
rincian | |||
---|---|---|---|
Parameter |
| ||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan ketidakmampuan untuk mengakhiri sebuah wadah. |
Daftar Akhir
WEAVE_ERROR EndList( ReferencedTLVData & aList, nl::Weave::TLV::TLVWriter & aWriter )
Selesai menulis daftar jalur atau daftar data.
Tuliskan TLV untuk akhir jalan WDM atau daftar data. Juga, menyelesaikan penulis. Dalam hal ini, ReferencedTLVData objek mana TLV sedang ditulis dilewatkan dan dimodifikasi untuk mencerminkan jumlah data tertulis.
rincian | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan ketidakmampuan untuk mengakhiri sebuah wadah. |
IsPublisherSpesifik
bool IsPublisherSpecific( const TopicIdentifier & aTopicId )
Periksa apakah ID topik khusus penayang.
rincian | |||
---|---|---|---|
Parameter |
| ||
Kembali | true jika ID topik khusus penerbit, false jika tidak |
OpenDataList
WEAVE_ERROR OpenDataList( ReferencedTLVData & aDataList, nl::Weave::TLV::TLVReader & aReader )
Mulai membaca daftar data.
Dengan pembaca baru dan daftar data, mulailah membaca daftar dan validasi tag dan jenis yang awalnya ditemukan dalam proses. Jika semuanya berjalan dengan baik, pembaca berhenti setelah wadah daftar dimasukkan.
rincian | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan kegagalan membuka daftar data dan / atau memvalidasi tag yang relevan dan jenis. |
OpenDataListElement
WEAVE_ERROR OpenDataListElement( nl::Weave::TLV::TLVReader & aReader, nl::Weave::TLV::TLVReader & aPathReader, uint64_t & aVersion )
Mulai membaca elemen daftar data.
Mengingat pembaca diposisikan pada elemen daftar data, mulai membaca elemen dan memvalidasi tag dan jenis yang awalnya ditemui dalam proses. Jika semuanya berjalan dengan baik, pembaca akhirnya diposisikan pada data elemen data dan pembaca jalur masuk/keluar diposisikan pada jalur yang sesuai.
rincian | |||||||
---|---|---|---|---|---|---|---|
Parameter |
| ||||||
Kembali | WEAVE_NO_ERROR pada keberhasilan atau orang WEAVE_ERROR terkait dengan membuka dan membaca data daftar elemen. |
DaftarJalan Terbuka
WEAVE_ERROR OpenPathList( ReferencedTLVData & aPathList, nl::Weave::TLV::TLVReader & aReader )
Mulai membaca daftar jalur.
Dengan pembaca baru dan daftar jalur, mulailah membaca daftar dan validasi tag dan jenis yang awalnya ditemukan dalam proses. Jika semuanya berjalan dengan baik, pembaca berhenti setelah wadah daftar dimasukkan.
rincian | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembali | WEAVE_NO_ERROR pada keberhasilan; sebaliknya, WEAVE_ERROR mencerminkan kegagalan yang membuka daftar jalur dan / atau memvalidasi tag yang relevan dan jenis. |
IdTopik Spesifik Penayang
TopicIdentifier PublisherSpecificTopicId( void )
Buat ID topik khusus penayang dari awal.
rincian | |
---|---|
Kembali | pengidentifikasi topik baru. |
KirimLaporanStatus
WEAVE_ERROR SendStatusReport( ExchangeContext *aExchangeCtx, StatusReport & aStatus )
StartDataList
WEAVE_ERROR StartDataList( nl::Weave::TLV::TLVWriter & aWriter )
Mulai menulis daftar data.
Tuliskan TLV untuk awal daftar data yang WDM, misalnya sebagai argumen utama dari UpdateRequest ().
rincian | |||
---|---|---|---|
Parameter |
| ||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan ketidakmampuan untuk memulai sebuah wadah. |
StartDataList
WEAVE_ERROR StartDataList( ReferencedTLVData & aDataList, nl::Weave::TLV::TLVWriter & aWriter )
Mulailah menulis daftar data ke diberikan ReferencedTLVData objek.
Tuliskan TLV untuk awal daftar WDM data. Dalam hal ini, kita asumsikan bahwa kita sedang menuliskan daftar data ke direferensikan TLV struktur data. Penulis diasumsikan tidak diinisialisasi - atau, dalam hal apa pun, akan diinisialisasi untuk menunjuk ke objek yang diberikan.
rincian | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan ketidakmampuan untuk memulai sebuah wadah. |
StartDataListElement
WEAVE_ERROR StartDataListElement( nl::Weave::TLV::TLVWriter & aWriter )
Mulai menulis elemen daftar data.
Tuliskan TLV untuk awal dari WDM daftar elemen data.
rincian | |||
---|---|---|---|
Parameter |
| ||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan ketidakmampuan untuk memulai sebuah wadah. |
MulaiEncodePath
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 )
Mulai menulis daftar jalur.
Tuliskan TLV untuk awal daftar jalur WDM, misalnya sebagai argumen utama dari ViewRequest ().
rincian | |||
---|---|---|---|
Parameter |
| ||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak mengembalikan WEAVE_ERROR mencerminkan ketidakmampuan untuk memulai sebuah wadah. |
TxnResponseHandler
void TxnResponseHandler( ExchangeContext *anExchangeCtx, const IPPacketInfo *anAddrInfo, const WeaveMessageInfo *aMsgInfo, uint32_t aProfileId, uint8_t aMsgType, PacketBuffer *aMsg )
TxnTimeoutHandler
void TxnTimeoutHandler( ExchangeContext *anExchangeCtx )
ValidasiTLVType
WEAVE_ERROR ValidateTLVType( nl::Weave::TLV::TLVType aType, nl::Weave::TLV::TLVReader & aReader )
Validasi bahwa TLV elemen makhluk read memiliki diharapkan TLV jenis.
Periksa diberikan TLV jenis terhadap jenis elemen di kepala TLV reader dan kembali kesalahan jika tidak ada pertandingan.
rincian | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembali | WEAVE_NO_ERROR jika ada pertandingan atau WEAVE_ERROR_WRONG_TLV_TYPE jika tidak. |
WeaveTLVTypes.h
ValidasiWDMTag
WEAVE_ERROR ValidateWDMTag( uint32_t aTagNum, nl::Weave::TLV::TLVReader & aReader )
Validasi bahwa TLV elemen makhluk read memiliki tag WDM yang diharapkan.
rincian | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembali | WEAVE_NO_ERROR Pada keberhasilan. Jika tidak WEAVE_ERROR_INVALID_TLV_TAG jika tag tidak sesuai jumlah tag yang diberikan ketika ditafsirkan sebagai tag WDM. |