nl::Weave::HostPortList

#include <src/lib/core/HostPortList.h>

Untuk mengelola dan memanipulasi Host Port List, kumpulan tuple host dan ID port yang ringkas berenkode biner yang terkait dengan Direktori Layanan Weave.

Ringkasan

Konstruktor dan Destruktor
HostPortList(void)
Konstruktor default class (void).
HostPortList(const uint8_t *hostPortList, uint8_t hostPortCount, const uint8_t *suffixList, const uint8_t suffixCount)

Fungsi publik
Clear(void)
void
Reset daftar ke kosong.
Get(uint8_t index, char *hostBuf, uint32_t hostBufSize, uint16_t & port) const
Mendapatkan nama host dan port pada indeks yang ditentukan dari daftar.
IsEmpty(void) const
bool
Pop(char *hostBuf, uint32_t hostBufSize, uint16_t & port)
Dapatkan dan hapus port dan nama host pertama dari daftar.

Fungsi publik

Hapus

void Clear(
  void
)

Reset daftar ke kosong.

Dapatkan

WEAVE_ERROR Get(
  uint8_t index,
  char *hostBuf,
  uint32_t hostBufSize,
  uint16_t & port
) const

Mendapatkan nama host dan port pada indeks yang ditentukan dari daftar.

Detail
Parameter
[in] index
Posisi dalam daftar untuk menampilkan nama host dan port.
[in,out] hostBuf
Pointer ke penyimpanan tempat nama host akan disalin.
[in] hostBufSize
Jumlah penyimpanan yang tersedia di hostBuf.
[out] port
Nomor port.
Nilai Pengembalian
WEAVE_ERROR_INVALID_ARGUMENT
Indeks yang diminta melebihi ukuran daftar.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
Elemen Port Host yang diminta adalah jenis yang tidak didukung.
WEAVE_ERROR_BUFFER_TOO_SMALL
Panjang nama host Port Host lebih panjang dari buffering yang disediakan.
WEAVE_NO_ERROR
Setelah berhasil.

HostPortList

 HostPortList(
  void
)

Konstruktor default class (void).

HostPortList

 HostPortList(
  const uint8_t *hostPortList,
  uint8_t hostPortCount,
  const uint8_t *suffixList,
  const uint8_t suffixCount
)

IsEmpty

bool IsEmpty(
  void
) const

Semarak

WEAVE_ERROR Pop(
  char *hostBuf,
  uint32_t hostBufSize,
  uint16_t & port
)

Dapatkan dan hapus port dan nama host pertama dari daftar.

Detail
Parameter
[in,out] hostBuf
Pointer ke penyimpanan tempat nama host akan disalin.
[in] hostBufSize
Jumlah penyimpanan yang tersedia di hostBuf.
[out] port
Nomor port.
Nilai Pengembalian
WEAVE_ERROR_HOST_PORT_LIST_EMPTY
Tidak ada entri dalam daftar.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
Elemen Port Host yang ditemukan memiliki jenis yang tidak didukung.
WEAVE_ERROR_BUFFER_TOO_SMALL
Panjang nama host Port Host lebih panjang dari buffering yang disediakan.
WEAVE_NO_ERROR
Setelah berhasil.