nl::Weave::Profiles::MessageIterator

#include <src/lib/profiles/common/WeaveMessage.h>

Afin d'utiliser judicieusement les tampons de message, nous définissons cet itérateur, qui permet d'effectuer le suivi des limites, etc.

Résumé

Héritage

Hérite de: nl::Weave::Profiles::RetainedPacketBuffer

Constructeurs et destructeurs

MessageIterator(System::PacketBuffer *)
Méthode du constructeur.

Attributs publics

thePoint
uint8_t *

Fonctions publiques

append(void)
void
Définissez le point après toutes les données actuellement dans la mémoire tampon.
finishWriting(void)
void
Ajustez le tampon après l'écriture.
hasData(uint16_t)
bool
hasRoom(uint16_t)
bool
operator!=(const MessageIterator &)
bool
operator*(void)
uint8_t &
operator+(uint16_t)
operator++(void)
Incrémenter un itérateur de message de 1 s'il y a de la place
operator-(uint16_t)
operator==(const MessageIterator &)
bool
read16(uint16_t *)
read32(uint32_t *)
read64(uint64_t *)
readByte(uint8_t *)
readBytes(uint16_t, uint8_t *)
readString(uint16_t, char *)
write16(uint16_t)
write32(uint32_t)
write64(uint64_t)
writeByte(uint8_t)
writeBytes(uint16_t, uint8_t *)
writeString(uint16_t, char *)

Attributs publics

thePoint

uint8_t * thePoint

Fonctions publiques

MessageIterator

 MessageIterator(
  System::PacketBuffer *
)

Méthode du constructeur.

Détails
Paramètres
aBuffer
Un tampon de message à itérer.

append

void append(
  void
)

Définissez le point après toutes les données actuellement dans la mémoire tampon.

finishWriting

void finishWriting(
  void
)

Ajustez le tampon après l'écriture.

hasData

bool hasData(
  uint16_t
)

Détails
Paramètres
inc
Quantité entière pouvant être lue à partir du tampon.
Valeurs de retour
true
La longueur de données actuelle du tampon est supérieure ou égale à l'incrément donné.
false
Sinon.

hasRoom

bool hasRoom(
  uint16_t
)

Détails
Paramètres
inc
Quantité entière pouvant être écrite dans le tampon.
Valeurs de retour
true
La différence entre la longueur de données actuelle du tampon et sa longueur de données maximale autorisée (longueur de données disponible) est inférieure ou égale à l'incrément donné.
false
Sinon.

opérateur!=

bool operator!=(
  const MessageIterator &
)

Détails
Paramètres
aMessageIterator
Un autre itérateur de message avec lequel comparer.

opérateur*

uint8_t & operator*(
  void
)

Détails
Renvoie
Ce que nous examinons dans le tampon.

opérateur+

MessageIterator & operator+(
  uint16_t
)

Détails
Paramètres
inc
Incrément à appliquer à l'itérateur de message.
Renvoie
Itérateur incrémenté de la valeur donnée s'il y a de la place, ou frappé sur la fin dans le cas contraire.

opérateur++

MessageIterator & operator++(
  void
)

Incrémenter un itérateur de message de 1 s'il y a de la place

operator-

MessageIterator & operator-(
  uint16_t
)

Détails
Paramètres
dec
Diminuer à appliquer à l'itérateur de message.
Renvoie
L'itérateur a diminué de la valeur donnée s'il y a de la place, ou se rabat sur le début dans le cas contraire.

opérateur==

bool operator==(
  const MessageIterator &
)

Détails
Paramètres
aMessageIterator
Un autre itérateur de message avec lequel comparer.

read16

WEAVE_ERROR read16(
  uint16_t *
)

Détails
Paramètres
aDestination
Un emplacement permettant d'exclure une courte lecture du tampon.
Valeurs de retour
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si nous avons dépassé la fin du tampon.

read32

WEAVE_ERROR read32(
  uint32_t *
)

Détails
Paramètres
aDestination
Un emplacement pour mettre une valeur 32 bits lue à partir du tampon.
Valeurs de retour
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si nous avons dépassé la fin du tampon.

read64

WEAVE_ERROR read64(
  uint64_t *
)

Détails
Paramètres
aDestination
Un emplacement pour placer une valeur de 64 bits lue à partir du tampon.
Valeurs de retour
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si nous avons dépassé la fin du tampon.

readByte

WEAVE_ERROR readByte(
  uint8_t *
)

Détails
Paramètres
aDestination
Un emplacement pour placer un octet lu hors du tampon.
Valeurs de retour
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si nous avons dépassé la fin du tampon.

readBytes

WEAVE_ERROR readBytes(
  uint16_t,
  uint8_t *
)

Détails
Paramètres
aLength
Longueur de la chaîne d'octets à lire.
aByteString
Un emplacement pour placer les octets.
Valeurs de retour
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si nous avons dépassé la fin du tampon.

readString

WEAVE_ERROR readString(
  uint16_t,
  char *
)

Détails
Paramètres
aLength
Longueur de la chaîne à lire.
aString
Un emplacement où insérer la chaîne.
Valeurs de retour
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si nous avons dépassé la fin du tampon.

write16

WEAVE_ERROR write16(
  uint16_t
)

Détails
Paramètres
aValue
Valeur courte à écrire.
Valeurs de retour
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si nous avons dépassé la fin du tampon.

write32

WEAVE_ERROR write32(
  uint32_t
)

Détails
Paramètres
aValue
Valeur de 32 bits à écrire.
Valeurs de retour
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si nous avons dépassé la fin du tampon.

write64

WEAVE_ERROR write64(
  uint64_t
)

Détails
Paramètres
aValue
Valeur de 64 bits à écrire.
Valeurs de retour
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si nous avons dépassé la fin du tampon.

writeByte

WEAVE_ERROR writeByte(
  uint8_t
)

Détails
Paramètres
aValue
Valeur d'octet à écrire.
Valeurs de retour
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si nous avons dépassé la fin du tampon.

writeBytes

WEAVE_ERROR writeBytes(
  uint16_t,
  uint8_t *
)

Détails
Paramètres
aLength
Longueur de la chaîne d'octets à écrire.
aString
Chaîne d'octets proprement dite.
Valeurs de retour
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si nous avons dépassé la fin du tampon.

writeString

WEAVE_ERROR writeString(
  uint16_t,
  char *
)

Détails
Paramètres
aLength
Longueur de la chaîne à écrire.
aString
La chaîne elle-même.
Valeurs de retour
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si nous avons dépassé la fin du tampon.