nl::Weave::HostPortList

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

Para gerenciar e manipular uma Lista de portas de host, uma coleção compacta e codificada em binário de tuplas de host e identificador de porta associadas ao Diretório de serviços do Weave.

Resumo

Construtores e destruidores

HostPortList(void)
Construtor padrão da classe (nulo).
HostPortList(const uint8_t *hostPortList, uint8_t hostPortCount, const uint8_t *suffixList, const uint8_t suffixCount)

Funções públicas

Clear(void)
void
Redefina a lista para esvaziá-la.
Get(uint8_t index, char *hostBuf, uint32_t hostBufSize, uint16_t & port) const
Encontre na lista o nome do host e a porta no índice especificado.
IsEmpty(void) const
bool
Pop(char *hostBuf, uint32_t hostBufSize, uint16_t & port)
Consiga e remova o primeiro nome de host e a porta da lista.

Funções públicas

Limpar

void Clear(
  void
)

Redefina a lista para esvaziá-la.

Get

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

Encontre na lista o nome do host e a porta no índice especificado.

Detalhes
Parâmetros
[in] index
A posição na lista para retornar o nome do host e a porta.
[in,out] hostBuf
Um ponteiro para armazenar o nome do host.
[in] hostBufSize
A quantidade de armazenamento disponível no hostBuf.
[out] port
O número da porta.
Valores de retorno
WEAVE_ERROR_INVALID_ARGUMENT
O índice solicitado excede o tamanho da lista.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
O elemento da porta do host solicitado era de um tipo não compatível.
WEAVE_ERROR_BUFFER_TOO_SMALL
O comprimento do nome do host da porta do host é maior que o buffer fornecido.
WEAVE_NO_ERROR
Em caso de sucesso.

HostPortList

 HostPortList(
  void
)

Construtor padrão da classe (nulo).

HostPortList

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

IsEmpty

bool IsEmpty(
  void
) const 

Destacar

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

Consiga e remova o primeiro nome de host e a porta da lista.

Detalhes
Parâmetros
[in,out] hostBuf
Um ponteiro para armazenar o nome do host.
[in] hostBufSize
A quantidade de armazenamento disponível no hostBuf.
[out] port
O número da porta.
Valores de retorno
WEAVE_ERROR_HOST_PORT_LIST_EMPTY
Não há entradas na lista.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
O tipo de porta do host encontrado era incompatível.
WEAVE_ERROR_BUFFER_TOO_SMALL
O comprimento do nome do host da porta do host é maior que o buffer fornecido.
WEAVE_NO_ERROR
Em caso de sucesso.