nl::Weave::Profiles::MessageIterator

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

Um Nachrichtenpuffer sinnvoll zu verwenden, definieren wir diesen Iterator, mit dem unter anderem Grenzen verfolgt werden können.

Zusammenfassung

Übernahme

Übernimmt von: nl::Weave::Profiles::RetainedPacketBuffer

Konstruktoren und Zerstörer
MessageIterator(System::PacketBuffer *)
Die Konstruktor-Methode.

Öffentliche Attribute
thePoint
uint8_t *

Öffentliche Funktionen
append(void)
void
Setzt den Punkt auf nach allen Daten, die sich derzeit im Zwischenspeicher befinden.
finishWriting(void)
void
Passen Sie den Puffer nach dem Schreiben an.
hasData(uint16_t)
bool
hasRoom(uint16_t)
bool
operator!=(const MessageIterator &)
bool
operator*(void)
uint8_t &
operator+(uint16_t)
operator++(void)
Erhöhen Sie einen Nachrichten-Iterator um 1, wenn Platz vorhanden ist.
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 *)

Öffentliche Attribute

thePoint

uint8_t * thePoint

Öffentliche Funktionen

MessageIterator

 MessageIterator(
  System::PacketBuffer *
)

Die Konstruktor-Methode.

Details
Parameter
aBuffer
Ein Nachrichtenpuffer, über den iteriert werden soll.

append

void append(
  void
)

Setzt den Punkt auf nach allen Daten, die sich derzeit im Zwischenspeicher befinden.

finishWriting

void finishWriting(
  void
)

Passen Sie den Puffer nach dem Schreiben an.

hasData

bool hasData(
  uint16_t
)

Details
Parameter
inc
Ein ganzzahliger Wert, der aus dem Zwischenspeicher gelesen werden kann.
Rückgabewerte
true
Die aktuelle Datenlänge des Zwischenspeichers ist größer oder gleich dem angegebenen Inkrement.
false
Andernfalls.

hasRoom

bool hasRoom(
  uint16_t
)

Details
Parameter
inc
Ein ganzzahliger Wert, der in den Zwischenspeicher geschrieben werden kann.
Rückgabewerte
true
Die Differenz zwischen der aktuellen Datenlänge des Zwischenspeichers und seiner maximal zulässigen Datenlänge (seine verfügbare Datenlänge) ist kleiner oder gleich dem angegebenen Inkrement.
false
Andernfalls.

operator!=

bool operator!=(
  const MessageIterator &
)

Details
Parameter
aMessageIterator
Ein anderer Nachrichten-Iterator, mit dem verglichen werden soll.

Operator*

uint8_t & operator*(
  void
)

Details
Rückgabe
Das sehen wir uns im Zwischenspeicher an.

Operator+

MessageIterator & operator+(
  uint16_t
)

Details
Parameter
inc
Ein Inkrement, das auf den Nachrichten-Iterator angewendet werden soll.
Rückgabe
Der Iterator wird um den gegebenen Wert erhöht, wenn Platz vorhanden ist, oder er prallt direkt an das Ende an, wenn dies nicht der Fall ist.

Operator ++

MessageIterator & operator++(
  void
)

Erhöhen Sie einen Nachrichten-Iterator um 1, wenn Platz vorhanden ist.

operator-

MessageIterator & operator-(
  uint16_t
)

Details
Parameter
dec
Die Dekrementierung, die auf den Nachrichten-Iterator angewendet werden soll.
Rückgabe
Der Iterator verringert sich um den gegebenen Wert, wenn Platz vorhanden ist, oder er wanderte direkt am Anfang, wenn dies nicht der Fall ist.

Operator==

bool operator==(
  const MessageIterator &
)

Details
Parameter
aMessageIterator
Ein anderer Nachrichten-Iterator, mit dem verglichen werden soll.

read16

WEAVE_ERROR read16(
  uint16_t *
)

Details
Parameter
aDestination
Ein Ort, an dem ein kurzer Read aus dem Zwischenspeicher geladen werden kann.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn wir das Ende des Puffers überschreiten.

read32

WEAVE_ERROR read32(
  uint32_t *
)

Details
Parameter
aDestination
Ein Ort, an dem ein 32-Bit-Wert aus dem Zwischenspeicher gelesen werden kann.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn wir das Ende des Puffers überschreiten.

read64

WEAVE_ERROR read64(
  uint64_t *
)

Details
Parameter
aDestination
Ein Ort, an dem ein 64-Bit-Wert aus dem Zwischenspeicher gelesen werden kann.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn wir das Ende des Puffers überschreiten.

readByte

WEAVE_ERROR readByte(
  uint8_t *
)

Details
Parameter
aDestination
Ein Ort, an dem ein Byte-Read aus dem Zwischenspeicher gesetzt wird.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn wir das Ende des Puffers überschreiten.

readBytes

WEAVE_ERROR readBytes(
  uint16_t,
  uint8_t *
)

Details
Parameter
aLength
Die Länge des zu lesenden Bytestrings.
aByteString
Ein Ort, an dem die Bytes abgelegt werden.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn wir das Ende des Puffers überschreiten.

readString

WEAVE_ERROR readString(
  uint16_t,
  char *
)

Details
Parameter
aLength
Die Länge der zu lesenden Zeichenfolge.
aString
Ein Ort, an dem die Zeichenfolge eingefügt werden soll.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn wir das Ende des Puffers überschreiten.

write16

WEAVE_ERROR write16(
  uint16_t
)

Details
Parameter
aValue
Ein kurzer Wert, der geschrieben werden soll.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn wir das Ende des Puffers überschreiten.

write32

WEAVE_ERROR write32(
  uint32_t
)

Details
Parameter
aValue
Ein 32-Bit-Wert, der geschrieben werden soll.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn wir das Ende des Puffers überschreiten.

write64

WEAVE_ERROR write64(
  uint64_t
)

Details
Parameter
aValue
Ein 64-Bit-Wert, der geschrieben werden soll.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn wir das Ende des Puffers überschreiten.

writeByte

WEAVE_ERROR writeByte(
  uint8_t
)

Details
Parameter
aValue
Ein auszuschreibender Bytewert.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn wir das Ende des Puffers überschreiten.

writeBytes

WEAVE_ERROR writeBytes(
  uint16_t,
  uint8_t *
)

Details
Parameter
aLength
Die Länge des zu schreibenden Bytestrings.
aString
Der Bytestring selbst.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn wir das Ende des Puffers überschreiten.

writeString

WEAVE_ERROR writeString(
  uint16_t,
  char *
)

Details
Parameter
aLength
Die Länge der zu schreibenden Zeichenfolge.
aString
Die Zeichenfolge selbst.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn wir das Ende des Puffers überschreiten.