nl::Weave::HostPortList

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

Para administrar y manipular una Lista de puertos del host, es una colección compacta de codificación binaria de tuplas de identificador de puerto y host asociadas con el Directorio de servicios de Weave.

Resumen

Constructores y destructores
HostPortList(void)
Es el constructor predeterminado de la clase (vacío).
HostPortList(const uint8_t *hostPortList, uint8_t hostPortCount, const uint8_t *suffixList, const uint8_t suffixCount)

Funciones públicas
Clear(void)
void
Restablece la lista a vacía.
Get(uint8_t index, char *hostBuf, uint32_t hostBufSize, uint16_t & port) const
Obtén el nombre de host y el puerto del índice especificado de la lista.
IsEmpty(void) const
bool
Pop(char *hostBuf, uint32_t hostBufSize, uint16_t & port)
Obtén y quita el primer nombre de host y puerto de la lista.

Funciones públicas

Borrar

void Clear(
  void
)

Restablece la lista a vacía.

Obtener

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

Obtén el nombre de host y el puerto del índice especificado de la lista.

Detalles
Parámetros
[in] index
Es la posición en la lista en la que se mostrará el nombre de host y el puerto.
[in,out] hostBuf
Un puntero al almacenamiento en el que se copiará el nombre de host.
[in] hostBufSize
La cantidad de almacenamiento disponible en hostBuf.
[out] port
El número de puerto.
Valores de retorno
WEAVE_ERROR_INVALID_ARGUMENT
El índice solicitado supera el tamaño de la lista.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
El elemento de puerto del host solicitado era de un tipo no admitido.
WEAVE_ERROR_BUFFER_TOO_SMALL
La longitud del nombre de host del puerto del host es más larga que el búfer proporcionado.
WEAVE_NO_ERROR
Si tiene éxito.

HostPortList

 HostPortList(
  void
)

Es el constructor predeterminado de la clase (vacío).

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
)

Obtén y quita el primer nombre de host y puerto de la lista.

Detalles
Parámetros
[in,out] hostBuf
Un puntero al almacenamiento en el que se copiará el nombre de host.
[in] hostBufSize
La cantidad de almacenamiento disponible en hostBuf.
[out] port
El número de puerto.
Valores de retorno
WEAVE_ERROR_HOST_PORT_LIST_EMPTY
No hay entradas en la lista.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
El elemento de puerto del host que se encontró era de un tipo no admitido.
WEAVE_ERROR_BUFFER_TOO_SMALL
La longitud del nombre de host del puerto del host es más larga que el búfer proporcionado.
WEAVE_NO_ERROR
Si tiene éxito.