nl:: Weave:: Profil:: DataManagement_Current:: ResourceIdentifier
#include <src/lib/profiles/data-management/Current/ResourceIdentifier.h>
Struktur yang merangkum ID resource.
Ringkasan
ResourceIdentifier dapat berupa ID objek 64-bit umum dari jenis tertentu atau UUID. Jika dienkode secara eksternal, representasi berikut akan didukung:
bilangan bulat 64-bit tanpa tanda tangan yang terkait dengan objek umum jenis DEVICE dengan ID yang ditentukan dalam representasi
representasi umum yang dienkode sebagai string byte 10 oktet. Dua oktet pertama mengenkode jenis resource sebagai integer endian kecil 16-bit, dengan sisa 8 byte mengenkode ID resource 64-bit endian kecil.
ResourceIdentifier juga mewujudkan konvensi yang ada di seluruh kode WDM: ResourceIdentifier kosong sesuai dengan ID node DEVICE, dan konstruktor disediakan untuk kasus penggunaan yang paling umum.
Konstruktor dan Destruktor |
|
---|---|
ResourceIdentifier()
Buat ResourceIdentifier yang sesuai dengan ResourceID yang tidak ditentukan.
|
|
ResourceIdentifier(const uint64_t & aNodeId)
Membuat ResourceIdentifier dari jenis DEVICE berdasarkan aNodeId tertentu.
|
|
ResourceIdentifier(uint16_t aResourceType, const uint64_t & aResourceId)
Buat ResourceIdentifier dari jenis yang ditentukan dengan ID yang diberikan.
|
|
ResourceIdentifier(uint16_t aResourceType, const uint8_t *aResourceId, size_t aResourceIdLen)
Buat ResourceIdentifier dari jenis yang ditentukan dengan ID yang diberikan.
|
Jenis publik |
|
---|---|
@125{
|
enum |
@126
|
enum Menentukan nilai khusus untuk NodeId yang merujuk ke 'self'. |
@127
|
enum |
Atribut publik |
|
---|---|
ResourceId
|
uint64_t
|
ResourceIdBytes[8]
|
uint8_t
|
Fungsi publik |
|
---|---|
FromString(const char *inBuffer, size_t inBufferLen)
|
Menguraikan representasi string kanonis dari resource ke objek resource.
|
FromString(const char *inBuffer, size_t inBufferLen, const uint64_t & aSelfNodeId)
|
Menguraikan representasi string kanonis dari resource ke objek resource.
|
FromTLV(nl::Weave::TLV::TLVReader & aReader)
|
Deserialisasi ResourceIdentifier dari representasi TLV ke dalam objek ini.
|
FromTLV(nl::Weave::TLV::TLVReader & aReader, const uint64_t & aSelfNodeId)
|
Deserialisasi ResourceIdentifier dari representasi TLV ke dalam objek ini.
|
GetResourceId() const
|
uint64_t
Fungsi pengakses untuk mengambil ResourceId.
|
GetResourceType() const
|
uint16_t
Fungsi pengakses untuk mengambil ResourceType.
|
ResourceTypeAsString(void) const
|
const char *
Membuat representasi string dari ResourceType.
|
ToString(char *buffer, size_t bufferLen)
|
Konversikan ResourceIdentifier menjadi string yang dapat dicetak.
|
ToTLV(nl::Weave::TLV::TLVWriter & aWriter) const
|
Lakukan serialisasi resource ke representasi TLV menggunakan tag Path::ResourceID konteks.
|
ToTLV(nl::Weave::TLV::TLVWriter & aWriter, const uint64_t & aTag) const
|
Lakukan serialisasi resource ke representasi TLV menggunakan tag yang ditentukan.
|
Fungsi statis publik |
|
---|---|
ResourceTypeAsString(uint16_t aResourceType)
|
const char *
Membuat representasi string dari jenis resource.
|
Kelas teman |
|
---|---|
operator==
|
friend bool
|
Jenis publik
@125
@125
Properti | |
---|---|
RESOURCE_TYPE_RESERVED
|
Jenis resource yang direservasi. Enum dipilih sedemikian rupa sehingga tidak bertentangan dengan nilai enum dari enum Schema::Weave:::Common::ResourceType. Saat ini, dua nilai ResourceId yang dimungkinkan untuk jenis resource RESERVED: kNodeIdNotSpecified sesuai dengan ResourceIdentifier bersatu, dan SELF_NODE_ID sesuai dengan resource yang akan memetakan ulang ke SELF dari representasi lainnya. |
@126
@126
Menentukan nilai khusus untuk NodeId yang merujuk ke 'self'.
Pada interaksi WDM tertentu, memiliki nilai diri untuk resource memungkinkan mengompresi informasi tersebut karena redundan untuk ID node sumber perangkat yang dinyatakan dalam pesan Weave itu sendiri
@127
@127
Atribut publik
ID resource
uint64_t ResourceId
ResourceIdByte
uint8_t ResourceIdBytes[8]
Fungsi publik
DariString
WEAVE_ERROR FromString( const char *inBuffer, size_t inBufferLen )
Menguraikan representasi string kanonis dari resource ke objek resource.
Mengonversi representasi string kanonis dari resource menjadi objek resource. Perhatikan bahwa hanya subset resource yang dapat direpresentasikan sebagai string, khususnya, implementasi referensi di Weave hanya akan mengurai resource jenis kanonis seperti yang dinyatakan dalam ResourceTypeEnum.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
DariString
WEAVE_ERROR FromString( const char *inBuffer, size_t inBufferLen, const uint64_t & aSelfNodeId )
Menguraikan representasi string kanonis dari resource ke objek resource.
Mengonversi representasi string kanonis dari resource menjadi objek resource. Perhatikan bahwa hanya subset resource yang dapat direpresentasikan sebagai string, khususnya, implementasi referensi di Weave hanya akan mengurai resource jenis kanonis seperti yang dinyatakan dalam ResourceTypeEnum.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
DariTLV
WEAVE_ERROR FromTLV( nl::Weave::TLV::TLVReader & aReader )
Deserialisasi ResourceIdentifier dari representasi TLV ke dalam objek ini.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
WEAVE_NO_ERROR saat berhasil. Error dari TLVReader jika ResourceIdentifier tidak dapat dibaca dengan benar.
|
DariTLV
WEAVE_ERROR FromTLV( nl::Weave::TLV::TLVReader & aReader, const uint64_t & aSelfNodeId )
Deserialisasi ResourceIdentifier dari representasi TLV ke dalam objek ini.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Menampilkan |
WEAVE_NO_ERROR saat berhasil. Error dari TLVReader jika ResourceIdentifier tidak dapat dibaca dengan benar.
|
ID GetResource
uint64_t GetResourceId() const
Fungsi pengakses untuk mengambil ResourceId.
GetResourceType
uint16_t GetResourceType() const
Fungsi pengakses untuk mengambil ResourceType.
ID Resource
ResourceIdentifier()
Buat ResourceIdentifier yang sesuai dengan ResourceID yang tidak ditentukan.
ID resource yang tidak ditentukan adalah tuple yang terdiri dari jenis resource RESERVED dengan resource kNodeIdNotSpeficied.
ID Resource
ResourceIdentifier( const uint64_t & aNodeId )
Membuat ResourceIdentifier dari jenis DEVICE berdasarkan aNodeId tertentu.
Detail | |||
---|---|---|---|
Parameter |
|
ID Resource
ResourceIdentifier( uint16_t aResourceType, const uint64_t & aResourceId )
Buat ResourceIdentifier dari jenis yang ditentukan dengan ID yang diberikan.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
ID Resource
ResourceIdentifier( uint16_t aResourceType, const uint8_t *aResourceId, size_t aResourceIdLen )
Buat ResourceIdentifier dari jenis yang ditentukan dengan ID yang diberikan.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
ResourceTypeAsString
const char * ResourceTypeAsString( void ) const
Membuat representasi string dari ResourceType.
Jenis resource yang dikonversi adalah jenis resource yang disebutkan dalam ResourceTypeEnum.h dan 0 (sesuai dengan RESOURCE_TYPE_RESERVED)
ToString
WEAVE_ERROR ToString( char *buffer, size_t bufferLen )
Konversikan ResourceIdentifier menjadi string yang dapat dicetak.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
ToTLV
WEAVE_ERROR ToTLV( nl::Weave::TLV::TLVWriter & aWriter ) const
Lakukan serialisasi resource ke representasi TLV menggunakan tag Path::ResourceID konteks.
Detail | |||
---|---|---|---|
Parameter |
|
ToTLV
WEAVE_ERROR ToTLV( nl::Weave::TLV::TLVWriter & aWriter, const uint64_t & aTag ) const
Lakukan serialisasi resource ke representasi TLV menggunakan tag yang ditentukan.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
Fungsi statis publik
ResourceTypeAsString
const char * ResourceTypeAsString( uint16_t aResourceType )
Membuat representasi string dari jenis resource.
Jenis resource yang dikonversi adalah jenis resource yang disebutkan dalam ResourceTypeEnum.h dan 0 (sesuai dengan RESOURCE_TYPE_RESERVED)
Detail | |||
---|---|---|---|
Parameter |
|
Kelas teman
operator==
friend bool operator==(const ResourceIdentifier &lhs, const ResourceIdentifier &rhs)