nl::Weave::Profiles::DataManagement_Current::ResourceIdentifier

#include <src/lib/profiles/data-management/Current/ResourceIdentifier.h>

Struktur yang mengenkapsulasi ID resource.

Ringkasan

ResourceIdentifier dapat berupa ID objek 64-bit umum dari jenis tertentu atau UUID. Jika dienkode secara eksternal, representasi berikut ini akan didukung:

bilangan bulat 64-bit tanpa tanda yang sesuai dengan objek umum jenis DEVICE dengan ID yang ditentukan dalam representasi

representasi umum yang dikodekan sebagai string byte 10 oktet. Dua oktet pertama mengkodekan tipe sumber daya sebagai 16-bit, integer endian kecil, dengan 8 byte sisanya mengkodekan ID sumber daya 64-bit endian kecil.

ResourceIdentifier juga mencerminkan 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)
Buat ResourceIdentifier jenis DEVICE berdasarkan aNodeId tertentu.
ResourceIdentifier(uint16_t aResourceType, const uint64_t & aResourceId)
Membuat ResourceIdentifier jenis yang ditentukan dengan ID yang diberikan.
ResourceIdentifier(uint16_t aResourceType, const uint8_t *aResourceId, size_t aResourceIdLen)
Membuat ResourceIdentifier jenis yang ditentukan dengan ID yang diberikan.

Jenis publik
@125{
  RESOURCE_TYPE_RESERVED = 0
} 		enum
@126 enum
Menentukan nilai khusus untuk NodeId yang merujuk pada 'self'.
@127 enum

Atribut publik
ResourceId
uint64_t
ResourceIdBytes[8]
uint8_t

Fungsi publik
FromString(const char *inBuffer, size_t inBufferLen)
Mengurai representasi string kanonis resource ke dalam objek resource.
FromString(const char *inBuffer, size_t inBufferLen, const uint64_t & aSelfNodeId)
Mengurai representasi string kanonis resource ke dalam objek resource.
FromTLV(nl::Weave::TLV::TLVReader & aReader)
Lakukan deserialisasi ResourceIdentifier dari representasi TLV ke dalam objek ini.
FromTLV(nl::Weave::TLV::TLVReader & aReader, const uint64_t & aSelfNodeId)
Lakukan 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 *
Menghasilkan representasi string dari ResourceType.
ToString(char *buffer, size_t bufferLen)
Mengonversi 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 diberikan.

Fungsi statis publik
ResourceTypeAsString(uint16_t aResourceType)
const char *
Menghasilkan representasi string dari jenis resource.

Kelas teman
operator==
friend bool

Jenis publik

@125

 @125
Properti
RESOURCE_TYPE_RESERVED

Jenis resource yang dicadangkan.

Enum dipilih sedemikian rupa sehingga tidak bertentangan dengan nilai enum dari enum Schema::Weave:::Common::ResourceType. Saat ini, dua nilai ResourceId dimungkinkan untuk jenis resource RESERVED: kNodeIdNotSpecified sesuai dengan ResourceIdentifier yang disatukan, dan SELF_ pakai_ID sesuai dengan resource yang akan dipetakan ulang ke SELF dari representasi lainnya.

@126

 @126

Menentukan nilai khusus untuk NodeId yang merujuk pada 'self'.

Dalam interaksi WDM tertentu, memiliki nilai mandiri untuk resource memungkinkan kompresi informasi tersebut karena redundan terhadap ID node sumber dari perangkat yang dinyatakan dalam pesan Weave.

@127

 @127

Atribut publik

ResourceId

uint64_t ResourceId

ResourceIdBytes

uint8_t ResourceIdBytes[8]

Fungsi publik

FromString

WEAVE_ERROR FromString(
  const char *inBuffer,
  size_t inBufferLen
)

Mengurai representasi string kanonis resource ke dalam objek resource.

Mengonversi representasi string kanonis resource menjadi objek resource. Perhatikan bahwa hanya sebagian resource yang dapat direpresentasikan sebagai string, khususnya, penerapan referensi di Weave hanya akan mengurai resource jenis kanonis seperti yang dinyatakan dalam ResourceTypeEnum.

Detail
Parameter
[in] inBuffer
Buffering yang berisi ID resource yang akan diurai
[in] inBufferLen
Panjang (dalam byte) string yang akan diurai

FromString

WEAVE_ERROR FromString(
  const char *inBuffer,
  size_t inBufferLen,
  const uint64_t & aSelfNodeId
)

Mengurai representasi string kanonis resource ke dalam objek resource.

Mengonversi representasi string kanonis resource menjadi objek resource. Perhatikan bahwa hanya sebagian resource yang dapat direpresentasikan sebagai string, khususnya, penerapan referensi di Weave hanya akan mengurai resource jenis kanonis seperti yang dinyatakan dalam ResourceTypeEnum.

Detail
Parameter
[in] inBuffer
Buffering yang berisi ID resource yang akan diurai
[in] inBufferLen
Panjang (dalam byte) string yang akan diurai
[in] aSelfNodeId
ID 64-bit yang menunjukkan ID perangkat yang harus dipetakan ke SELF_systrace_ID

FromTLV

WEAVE_ERROR FromTLV(
  nl::Weave::TLV::TLVReader & aReader
)

Lakukan deserialisasi ResourceIdentifier dari representasi TLV ke dalam objek ini.

Detail
Parameter
[in] aReader
Pembaca TLV yang diposisikan pada elemen ResourceIdentifier
Hasil
WEAVE_NO_ERROR saat berhasil. Error dari TLVReader jika ResourceIdentifier tidak dapat dibaca dengan benar.

FromTLV

WEAVE_ERROR FromTLV(
  nl::Weave::TLV::TLVReader & aReader,
  const uint64_t & aSelfNodeId
)

Lakukan deserialisasi ResourceIdentifier dari representasi TLV ke dalam objek ini.

Detail
Parameter
[in] aReader
Pembaca TLV yang diposisikan pada elemen ResourceIdentifier
[in] aSelfNodeId
ResourceID 64-bit yang akan dipetakan ulang dari representasi yang diserialisasi ke SELF_inspect_ID
Hasil
WEAVE_NO_ERROR saat berhasil. Error dari TLVReader jika ResourceIdentifier tidak dapat dibaca dengan benar.

GetResourceId

uint64_t GetResourceId() const

Fungsi pengakses untuk mengambil ResourceId.

GetResourceType

uint16_t GetResourceType() const

Fungsi pengakses untuk mengambil ResourceType.

ResourceIdentifier

 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.

ResourceIdentifier

 ResourceIdentifier(
  const uint64_t & aNodeId
)

Buat ResourceIdentifier jenis DEVICE berdasarkan aNodeId tertentu.

Detail
Parameter
[in] aNodeId
NodeID dari ID Resource yang ditentukan

ResourceIdentifier

 ResourceIdentifier(
  uint16_t aResourceType,
  const uint64_t & aResourceId
)

Membuat ResourceIdentifier jenis yang ditentukan dengan ID yang diberikan.

Detail
Parameter
[in] aResourceType
Jenis resource yang akan diberi nama
[in] aResourceId
ID resource yang akan diberi nama

ResourceIdentifier

 ResourceIdentifier(
  uint16_t aResourceType,
  const uint8_t *aResourceId,
  size_t aResourceIdLen
)

Membuat ResourceIdentifier jenis yang ditentukan dengan ID yang diberikan.

Detail
Parameter
[in] aResourceType
Jenis resource yang akan diberi nama
[in] aResourceId
ID resource yang akan diberi nama sebagai array byte
[in] aResourceIdLen
Panjang ID dalam byte

ResourceTypeAsString

const char * ResourceTypeAsString(
  void
) const

Menghasilkan representasi string dari ResourceType.

Jenis resource yang dikonversi adalah resource yang dienumerasi dalam ResourceTypeEnum.h dan 0 (sesuai dengan RESOURCE_TYPE_RESERVED)

ToString

WEAVE_ERROR ToString(
  char *buffer,
  size_t bufferLen
)

Mengonversi ResourceIdentifier menjadi string yang dapat dicetak.

Detail
Parameter
[in] buffer
{i>Buffer<i} untuk mencetak ke
[in] bufferLen
Panjang {i>buffer<i}

ToTLV

WEAVE_ERROR ToTLV(
  nl::Weave::TLV::TLVWriter & aWriter
) const

Lakukan serialisasi resource ke representasi TLV menggunakan tag Path::ResourceID konteks.

Detail
Parameter
[in] aWriter
Penulis TLV yang akan diserialisasi ResourceIdentifier ke dalam

ToTLV

WEAVE_ERROR ToTLV(
  nl::Weave::TLV::TLVWriter & aWriter,
  const uint64_t & aTag
) const

Lakukan serialisasi resource ke representasi TLV menggunakan tag yang diberikan.

Detail
Parameter
[in] aWriter
Penulis TLV yang akan diserialisasi ResourceIdentifier ke dalam
[in] aTag
Tag yang menamai ResourceIdentifier serial

Fungsi statis publik

ResourceTypeAsString

const char * ResourceTypeAsString(
  uint16_t aResourceType
)

Menghasilkan representasi string dari jenis resource.

Jenis resource yang dikonversi adalah resource yang dienumerasi dalam ResourceTypeEnum.h dan 0 (sesuai dengan RESOURCE_TYPE_RESERVED)

Detail
Parameter
[in] aResourceType
Enum jenis resource yang akan dikonversi menjadi representasi string.

Kelas teman

operator==

friend bool operator==(const ResourceIdentifier &lhs, const ResourceIdentifier &rhs)