nl::Weave::Profiles::MessageIterator

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

Afin d'utiliser les tampons de messages de façon judicieuse, 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 constructeur.

Attributs publics
thePoint
uint8_t *

Fonctions publiques
append(void)
void
Définissez le point après les données qui se trouvent 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émentez l'itérateur de message de 1 s'il y a suffisamment de 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 constructeur.

Détails
Paramètres
aBuffer
Un tampon de messages à répéter.

append

void append(
  void
)

Définissez le point après les données qui se trouvent 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
Nombre entier pouvant être lu dans le tampon.
Valeurs renvoyées
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
Nombre entier pouvant être écrit dans le tampon.
Valeurs renvoyées
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.

operator!=

bool operator!=(
  const MessageIterator &
)

Détails
Paramètres
aMessageIterator
Autre itérateur de message à comparer.

opérateur*

uint8_t & operator*(
  void
)

Détails
Renvoie
Ce que nous regardons dans la mémoire 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é d'une valeur donnée s'il y a de la place, ou s'affronter à la fin dans le cas contraire.

opérateur++

MessageIterator & operator++(
  void
)

Incrémentez l'itérateur de message de 1 s'il y a suffisamment de place.

operator-

MessageIterator & operator-(
  uint16_t
)

Détails
Paramètres
dec
Diminution à appliquer à l'itérateur de message.
Renvoie
L'itérateur décrémenté d'une valeur donnée s'il y a de la place ou, dans le cas contraire, s'est écrasé au début.

opérateur==

bool operator==(
  const MessageIterator &
)

Détails
Paramètres
aMessageIterator
Autre itérateur de message à comparer.

read16

WEAVE_ERROR read16(
  uint16_t *
)

Détails
Paramètres
aDestination
Emplacement pour lire une courte lecture hors du tampon.
Valeurs renvoyées
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si l'exécution dépasse la fin du tampon.

read32

WEAVE_ERROR read32(
  uint32_t *
)

Détails
Paramètres
aDestination
Emplacement pour placer une valeur de 32 bits lue à partir du tampon.
Valeurs renvoyées
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si l'exécution dépasse la fin du tampon.

read64

WEAVE_ERROR read64(
  uint64_t *
)

Détails
Paramètres
aDestination
Emplacement pour placer une valeur de 64 bits lue à partir du tampon.
Valeurs renvoyées
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si l'exécution dépasse la fin du tampon.

readByte

WEAVE_ERROR readByte(
  uint8_t *
)

Détails
Paramètres
aDestination
Emplacement pour placer un octet lu à partir du tampon.
Valeurs renvoyées
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si l'exécution dépasse 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
Emplacement pour placer les octets.
Valeurs renvoyées
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si l'exécution dépasse la fin du tampon.

readString

WEAVE_ERROR readString(
  uint16_t,
  char *
)

Détails
Paramètres
aLength
Longueur de la chaîne à lire.
aString
Emplacement où placer la chaîne.
Valeurs renvoyées
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si l'exécution dépasse la fin du tampon.

write16

WEAVE_ERROR write16(
  uint16_t
)

Détails
Paramètres
aValue
Valeur courte à écrire.
Valeurs renvoyées
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si l'exécution dépasse la fin du tampon.

write32

WEAVE_ERROR write32(
  uint32_t
)

Détails
Paramètres
aValue
Valeur de 32 bits à écrire.
Valeurs renvoyées
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si l'exécution dépasse la fin du tampon.

write64

WEAVE_ERROR write64(
  uint64_t
)

Détails
Paramètres
aValue
Valeur de 64 bits à écrire.
Valeurs renvoyées
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si l'exécution dépasse la fin du tampon.

writeByte

WEAVE_ERROR writeByte(
  uint8_t
)

Détails
Paramètres
aValue
Valeur d'octet à écrire.
Valeurs renvoyées
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si l'exécution dépasse 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
La chaîne d'octets elle-même.
Valeurs renvoyées
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si l'exécution dépasse 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 renvoyées
WEAVE_NO_ERROR
Si tout va bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si l'exécution dépasse la fin du tampon.