nl::Weave::HostPortList

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

Permet de gérer et de manipuler une liste de ports hôtes, une collection compacte et encodée au format binaire de tuples d'identifiant d'hôte et de port associé à l'annuaire des services Weave.

Résumé

Constructeurs et destructeurs
HostPortList(void)
Constructeur de classe par défaut (void).
HostPortList(const uint8_t *hostPortList, uint8_t hostPortCount, const uint8_t *suffixList, const uint8_t suffixCount)

Fonctions publiques
Clear(void)
void
Réinitialisez la liste pour qu'elle soit vide.
Get(uint8_t index, char *hostBuf, uint32_t hostBufSize, uint16_t & port) const
Permet d'obtenir dans la liste le nom d'hôte et le port associés à l'index spécifié.
IsEmpty(void) const
bool
Pop(char *hostBuf, uint32_t hostBufSize, uint16_t & port)
Récupérez et supprimez le premier nom d'hôte et le premier port de la liste.

Fonctions publiques

Effacer

void Clear(
  void
)

Réinitialisez la liste pour qu'elle soit vide.

Télécharger

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

Permet d'obtenir dans la liste le nom d'hôte et le port associés à l'index spécifié.

Détails
Paramètres
[in] index
Position dans la liste où renvoyer le nom d'hôte et le port.
[in,out] hostBuf
Pointeur vers un espace de stockage dans lequel copier le nom d'hôte.
[in] hostBufSize
Quantité de stockage disponible dans hostBuf.
[out] port
Numéro de port.
Valeurs de retour
WEAVE_ERROR_INVALID_ARGUMENT
L'index demandé dépasse la taille de la liste.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
Le type de l'élément Port de l'hôte demandé n'est pas compatible.
WEAVE_ERROR_BUFFER_TOO_SMALL
La longueur du nom d'hôte du port hôte dépasse la longueur de la mémoire tampon fournie.
WEAVE_NO_ERROR
Pour la réussite.

HostPortList

 HostPortList(
  void
)

Constructeur de classe par défaut (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
)

Récupérez et supprimez le premier nom d'hôte et le premier port de la liste.

Détails
Paramètres
[in,out] hostBuf
Pointeur vers un espace de stockage dans lequel copier le nom d'hôte.
[in] hostBufSize
Quantité de stockage disponible dans hostBuf.
[out] port
Numéro de port.
Valeurs de retour
WEAVE_ERROR_HOST_PORT_LIST_EMPTY
La liste ne contient aucune entrée.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
L'élément Port de l'hôte rencontré n'est pas compatible.
WEAVE_ERROR_BUFFER_TOO_SMALL
La longueur du nom d'hôte du port hôte dépasse la longueur de la mémoire tampon fournie.
WEAVE_NO_ERROR
Pour la réussite.