nl::Weave::HostPortList

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

Służy do zarządzania listą portów hosta, która jest zwartą, zakodowaną binarnie listą krotek identyfikatorów hostów i portów powiązaną z Katalogiem usług Weave.

Podsumowanie

Konstruktory i niszczyciele
HostPortList(void)
Domyślny konstruktor klasy (void).
HostPortList(const uint8_t *hostPortList, uint8_t hostPortCount, const uint8_t *suffixList, const uint8_t suffixCount)

Funkcje publiczne
Clear(void)
void
Zresetuj listę.
Get(uint8_t index, char *hostBuf, uint32_t hostBufSize, uint16_t & port) const
Pobierz z listy nazwę hosta i port o określonym indeksie.
IsEmpty(void) const
bool
Pop(char *hostBuf, uint32_t hostBufSize, uint16_t & port)
Pobierz nazwę pierwszego hosta i port z listy i usuń ją z listy.

Funkcje publiczne

Wyczyść

void Clear(
  void
)

Zresetuj listę.

Pobierz

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

Pobierz z listy nazwę hosta i port o określonym indeksie.

Szczegóły
Parametry
[in] index
Pozycja na liście, która zwraca nazwę hosta i port.
[in,out] hostBuf
Wskaźnik do miejsca na dane, do którego ma zostać skopiowana nazwa hosta.
[in] hostBufSize
Ilość miejsca dostępnego w hostBuf.
[out] port
Numer portu.
Zwracane wartości
WEAVE_ERROR_INVALID_ARGUMENT
Żądany indeks przekracza rozmiar listy.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
Żądany element portu hosta jest nieobsługiwany.
WEAVE_ERROR_BUFFER_TOO_SMALL
Długość nazwy hosta portu hosta jest dłuższa niż podany bufor.
WEAVE_NO_ERROR
Powodzenie.

HostPortList

 HostPortList(
  void
)

Domyślny konstruktor klasy (void).

HostPortList

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

IsEmpty

bool IsEmpty(
  void
) const

Pop

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

Pobierz nazwę pierwszego hosta i port z listy i usuń ją z listy.

Szczegóły
Parametry
[in,out] hostBuf
Wskaźnik do miejsca na dane, do którego ma zostać skopiowana nazwa hosta.
[in] hostBufSize
Ilość miejsca dostępnego w hostBuf.
[out] port
Numer portu.
Zwracane wartości
WEAVE_ERROR_HOST_PORT_LIST_EMPTY
Brak wpisów na liście.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
Napotkano nieobsługiwany typ elementu Port hosta.
WEAVE_ERROR_BUFFER_TOO_SMALL
Długość nazwy hosta portu hosta jest dłuższa niż podany bufor.
WEAVE_NO_ERROR
Powodzenie.