nl::Weave::HostPortList

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

Per gestire e manipolare un elenco di porte host, una raccolta compatta con codifica binaria di tuple di identificatori di porta e host associata a Weave Service Directory.

Riepilogo

Costruttori e distruttori
HostPortList(void)
Costruttore predefinito della classe (void).
HostPortList(const uint8_t *hostPortList, uint8_t hostPortCount, const uint8_t *suffixList, const uint8_t suffixCount)

Funzioni pubbliche
Clear(void)
void
Reimposta l'elenco come vuoto.
Get(uint8_t index, char *hostBuf, uint32_t hostBufSize, uint16_t & port) const
Recupera dall'elenco il nome e la porta dell'host nell'indice specificato.
IsEmpty(void) const
bool
Pop(char *hostBuf, uint32_t hostBufSize, uint16_t & port)
Recupera e rimuovi dall'elenco il nome host e la porta.

Funzioni pubbliche

Cancella

void Clear(
  void
)

Reimposta l'elenco come vuoto.

Get

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

Recupera dall'elenco il nome e la porta dell'host nell'indice specificato.

Dettagli
Parametri
[in] index
La posizione nell'elenco per restituire il nome host e la porta.
[in,out] hostBuf
Un puntatore allo spazio di archiviazione in cui copiare il nome host.
[in] hostBufSize
La quantità di spazio di archiviazione disponibile in hostBuf.
[out] port
Il numero di porta.
Valori restituiti
WEAVE_ERROR_INVALID_ARGUMENT
L'indice richiesto supera le dimensioni dell'elenco.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
L'elemento Host Port richiesto era di un tipo non supportato.
WEAVE_ERROR_BUFFER_TOO_SMALL
La lunghezza del nome host della porta host è superiore al buffer fornito.
WEAVE_NO_ERROR
Un successo.

HostPortList

 HostPortList(
  void
)

Costruttore predefinito della classe (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
)

Recupera e rimuovi dall'elenco il nome host e la porta.

Dettagli
Parametri
[in,out] hostBuf
Un puntatore allo spazio di archiviazione in cui copiare il nome host.
[in] hostBufSize
La quantità di spazio di archiviazione disponibile in hostBuf.
[out] port
Il numero di porta.
Valori restituiti
WEAVE_ERROR_HOST_PORT_LIST_EMPTY
Nessuna voce nell'elenco.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
L'elemento Host Port rilevato era di un tipo non supportato.
WEAVE_ERROR_BUFFER_TOO_SMALL
La lunghezza del nome host della porta host è superiore al buffer fornito.
WEAVE_NO_ERROR
Un successo.