нл:: Переплетение:: Список хост-портов

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

Для управления и манипулирования списком портов хоста — компактной коллекцией кортежей идентификаторов хоста и порта в двоичном коде, связанных с каталогом служб Weave.

Краткое содержание

Конструкторы и деструкторы

HostPortList (void)
Конструктор класса по умолчанию (void).
HostPortList (const uint8_t *hostPortList, uint8_t hostPortCount, const uint8_t *suffixList, const uint8_t suffixCount)

Общественные функции

Clear (void)
void
Сбросьте список на пустой.
Get (uint8_t index, char *hostBuf, uint32_t hostBufSize, uint16_t & port) const
Получите имя хоста и порт по указанному индексу из списка.
IsEmpty (void) const
bool
Pop (char *hostBuf, uint32_t hostBufSize, uint16_t & port)
Получите и удалите первое имя хоста и порт из списка.

Общественные функции

Прозрачный

void Clear(
  void
)

Сбросьте список на пустой.

Получать

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

Получите имя хоста и порт по указанному индексу из списка.

Подробности
Параметры
[in] index
Позиция в списке для возврата имени хоста и порта.
[in,out] hostBuf
Указатель на хранилище, в которое можно скопировать имя хоста.
[in] hostBufSize
Объем памяти, доступной в HostBuf.
[out] port
Номер порта.
Возвращаемые значения
WEAVE_ERROR_INVALID_ARGUMENT
Запрошенный индекс превышает размер списка.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
Запрошенный элемент Host Port имел неподдерживаемый тип.
WEAVE_ERROR_BUFFER_TOO_SMALL
Длина имени хоста порта хоста превышает предоставленный буфер.
WEAVE_NO_ERROR
Об успехе.

Список хост-портов

 HostPortList(
  void
)

Конструктор класса по умолчанию (void).

Список хост-портов 

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

пусто 

bool IsEmpty(
  void
) const

Поп

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

Получите и удалите первое имя хоста и порт из списка.

Подробности
Параметры
[in,out] hostBuf
Указатель на хранилище, в которое можно скопировать имя хоста.
[in] hostBufSize
Объем памяти, доступной в HostBuf.
[out] port
Номер порта.
Возвращаемые значения
WEAVE_ERROR_HOST_PORT_LIST_EMPTY
В списке нет записей.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
Обнаруженный элемент Host Port имел неподдерживаемый тип.
WEAVE_ERROR_BUFFER_TOO_SMALL
Длина имени хоста порта хоста превышает предоставленный буфер.
WEAVE_NO_ERROR
Об успехе.