nl:: Menenun:: Profil:: DataManagement_Legacy:: klien DM
#include <src/lib/profiles/data-management/Legacy/DMClient.h>
Kelas dasar abstrak untuk klien WDM khusus aplikasi.
Ringkasan
DMClient adalah klien WDM standar. Implementasinya secara opsional mencakup langganan/pemberitahuan. Ini adalah campuran dari DM ProtocolEngine kelas, yang menangani comms engkol-balik, dan sepenuhnya abstrak ClientDataManager kelas, dengan beberapa metode terkait langganan dilaksanakan sehingga lapisan yang lebih tinggi tidak perlu khawatir tentang mereka.
Penangan untuk tugas-tugas yang berhubungan dengan berlangganan terutama bertindak sebagai adaptor tipis di atas ClientNotifier objek. Pelaksana subkelas harus berhati-hati untuk memanggil metode kelas super yang relevan untuk menghidupkan engkol manajer langganan.
DMClient metode permintaan umumnya memiliki 2 tanda tangan, satu dengan ID node tujuan eksplisit dan yang lainnya dengan tujuan tertentu. Dalam kedua kasus tersebut, kemampuan untuk mengirim pesan ke penerbit bergantung pada pengikatan yang sudah ada sebelumnya di klien tetapi, dalam kasus pertama, ID tujuan dimaksudkan untuk memilih antara beberapa tujuan terikat dan, dalam kasus kedua, yang pertama item dalam tabel penjilidan dipilih sebagai default. Ini berguna, misalnya, jika klien hanya akan terikat pada satu penerbit.
Warisan
Mewarisi dari:nl::Menenun::Profil::DataManagement_Legacy::ProtocolEngine
nl::Menenun::Profil::DataManagement_Legacy::ClientDataManager
Konstruktor dan Destruktor | |
---|---|
DMClient (void) Konstruktor default untuk DMClient objek. | |
~DMClient (void) Destructor untuk DMClient objek. |
ViewRequest (const uint64_t & aDestinationId, ReferencedTLVData & aPathList, uint16_t aTxnId, uint32_t aTimeout) | virtual WEAVE_ERROR Meminta tampilan data yang dipublikasikan. |
ViewRequest ( ReferencedTLVData & aPathList, uint16_t aTxnId, uint32_t aTimeout) | virtual WEAVE_ERROR Minta tampilan data pada penerbit default. |
UpdateRequest (const uint64_t & aDestinationId, ReferencedTLVData & aDataList, uint16_t aTxnId, uint32_t aTimeout) | virtual WEAVE_ERROR Minta pembaruan untuk data yang dipublikasikan. |
UpdateRequest ( ReferencedTLVData & aDataList, uint16_t aTxnId, uint32_t aTimeout) | virtual WEAVE_ERROR Minta pembaruan data pada penerbit default. |
Atribut yang dilindungi | |
---|---|
mUpdatePool [kUpdatePoolSize] | |
mViewPool [kViewPoolSize] |
Fungsi publik | |
---|---|
CancelTransactionRequest (uint16_t aTxnId, WEAVE_ERROR aError) | Meminta agar transaksi yang dieksekusi dibatalkan. |
Clear (void) | virtual void Jelas keadaan internal terkait dengan DMClient objek. |
Finalize (void) | virtual void Matikan sebuah operasi DMClient . |
IncompleteIndication ( Binding *aBinding, StatusReport & aReport) | virtual void Menangani "tidak selesainya" pengikatan yang digunakan oleh klien. |
Fungsi yang dilindungi | |
---|---|
NewUpdate (void) | Update * |
NewView (void) | View * |
LihatPermintaan
virtual WEAVE_ERROR ViewRequest( const uint64_t & aDestinationId, ReferencedTLVData & aPathList, uint16_t aTxnId, uint32_t aTimeout )
Meminta tampilan data yang dipublikasikan.
Minta tampilan data yang berada dan dikelola oleh penerbit jarak jauh yang ditentukan.
rincian | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||
Mengembalikan Nilai |
| ||||||||
Kembali | Jika tidak, WEAVE_ERROR mencerminkan kegagalan untuk menginisialisasi atau mulai transaksi. |
LihatPermintaan
virtual WEAVE_ERROR ViewRequest( ReferencedTLVData & aPathList, uint16_t aTxnId, uint32_t aTimeout )
Minta tampilan data pada penerbit default.
Minta tampilan data yang berada dan dikelola oleh penerbit "default", yaitu penerbit pertama (atau satu-satunya) di tabel pengikatan klien.
rincian | |||||||
---|---|---|---|---|---|---|---|
Parameter |
| ||||||
Mengembalikan Nilai |
| ||||||
Kembali | Jika tidak, WEAVE_ERROR mencerminkan kegagalan untuk menginisialisasi atau mulai transaksi. |
PerbaruiPermintaan
virtual WEAVE_ERROR UpdateRequest( const uint64_t & aDestinationId, ReferencedTLVData & aDataList, uint16_t aTxnId, uint32_t aTimeout )
Minta pembaruan untuk data yang dipublikasikan.
Minta agar penerbit jarak jauh memperbarui data yang dikelola.
rincian | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||
Kembali | WEAVE_NO_ERROR pada keberhasilan atau WEAVE_ERROR_NO_MEMORY jika transaksi pembaruan tidak dapat dialokasikan. Jika tidak, mengembalikan WEAVE_ERROR mencerminkan kegagalan pembaruan. |
PerbaruiPermintaan
virtual WEAVE_ERROR UpdateRequest( ReferencedTLVData & aDataList, uint16_t aTxnId, uint32_t aTimeout )
Minta pembaruan data pada penerbit default.
Minta agar penerbit jarak jauh memperbarui data yang dikelola. Versi ini mengarahkan permintaan ke penerbit yang menjadi target pengikatan default klien.
rincian | |||||||
---|---|---|---|---|---|---|---|
Parameter |
| ||||||
Kembali | WEAVE_NO_ERROR pada keberhasilan atau WEAVE_ERROR_NO_MEMORY jika transaksi pembaruan tidak dapat dialokasikan. Jika tidak, mengembalikan WEAVE_ERROR mencerminkan kegagalan pembaruan. |
Atribut yang dilindungi
mUpdateKolam renang
Update mUpdatePool[kUpdatePoolSize]
mViewPool
View mViewPool[kViewPoolSize]
Fungsi publik
Batalkan Permintaan Transaksi
WEAVE_ERROR CancelTransactionRequest( uint16_t aTxnId, WEAVE_ERROR aError )
Meminta agar transaksi yang dieksekusi dibatalkan.
Metode ini tidak menghasilkan lalu lintas jaringan, tetapi hanya melepaskan sumber daya yang dialokasikan untuk transaksi yang ditentukan
rincian | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembali | WEAVE_NO_ERROR pada keberhasilan atau WEAVE_ERROR mencerminkan kegagalan untuk membatalkan transaksi. |
Bersih
virtual void Clear( void )
Jelas keadaan internal terkait dengan DMClient objek.
Secara khusus, metode ini menghapus semua kumpulan transaksi klien. Untuk klien yang telah digunakan dalam Finalisasi () metode adalah lebih karena juga membatalkan langganan dan membersihkan transaksi dan mengikat tabel.
Lihat juga:Menyelesaikan()
klien DM
DMClient( void )
Menyelesaikan
virtual void Finalize( void )
Matikan sebuah operasi DMClient .
Menghapus semua status operasi yang terkait dengan klien dan menghapus semua langganan terkait dari pemberi notifikasi. Setelah panggilan untuk Finalisasi () sebuah DMClient dapat reinitialized hanya dengan memanggil Init (). Finalisasi () dipanggil oleh DMClient destructor tetapi dapat disebut dalam kasus di mana DMClient membutuhkan pembersihan, misalnya dalam hal kegagalan atau shutdown sementara, tapi mungkin perlu dibentuk kembali pada beberapa waktu kemudian.
Indikasi tidak lengkap
virtual void IncompleteIndication( Binding *aBinding, StatusReport & aReport )
Menangani "tidak selesainya" pengikatan yang digunakan oleh klien.
Ketika pengikatan gagal secara tidak terduga, misalnya jika koneksi yang terlibat dalam pengikatan ditutup, maka metode ini dipanggil.
rincian | |||||
---|---|---|---|---|---|
Parameter |
|
~DMClient
virtual ~DMClient( void )
Destructor untuk DMClient objek.
Menghapus semua status internal dan, jika perlu, membatalkan langganan yang tertunda.
Fungsi yang dilindungi
Pembaruan Baru
Update * NewUpdate( void )
Pemandangan baru
View * NewView( void )