nl::Weave::Profiles::MessageIterator

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

Um Nachrichtenpuffer sinnvoll verwenden zu können, definieren wir diesen Iterator, der verwendet werden kann, um Grenzen usw. im Auge zu behalten.

Zusammenfassung

Übernahme

Übernommen von: nl::Weave::Profiles::RetainedPacketBuffer

Konstruktoren und Zerstörer
MessageIterator(System::PacketBuffer *)
Die Konstruktormethode.

Öffentliche Attribute
thePoint
uint8_t *

Öffentliche Funktionen
append(void)
void
Setzen Sie den Punkt auf nach allen Daten, die sich derzeit im Puffer 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 genügend 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 Konstruktormethode.

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

append

void append(
  void
)

Setzen Sie den Punkt auf nach allen Daten, die sich derzeit im Puffer befinden.

finishWriting

void finishWriting(
  void
)

Passen Sie den Puffer nach dem Schreiben an.

hasData

bool hasData(
  uint16_t
)

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

hasRoom

bool hasRoom(
  uint16_t
)

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

Operator!=

bool operator!=(
  const MessageIterator &
)

Details
Parameter
aMessageIterator
Ein weiterer Nachrichten-iterator, mit dem verglichen werden soll.

Operator*

uint8_t & operator*(
  void
)

Details
Rückgabe
Was wir im Zwischenspeicher ansehen.

Operator+

MessageIterator & operator+(
  uint16_t
)

Details
Parameter
inc
Ein Inkrement, das auf den Nachrichten-Iterator angewendet wird.
Rückgabe
Der Iteration, die um den angegebenen Wert erhöht wird, wenn genügend Platz ist, oder wird direkt gegen das Ende eingeschlagen, wenn nicht.

Operator++

MessageIterator & operator++(
  void
)

Erhöhen Sie einen Nachrichten-iterator um 1, wenn genügend Platz vorhanden ist.

operator-

MessageIterator & operator-(
  uint16_t
)

Details
Parameter
dec
Ein Dekrement, das auf den Nachrichten-iterator angewendet wird.
Rückgabe
Der Iterator, der um den gegebenen Wert verringert wird, wenn genügend Platz vorhanden ist, oder er wird direkt am Anfang zusammengeschlagen, wenn er nicht vorhanden ist.

Operator==

bool operator==(
  const MessageIterator &
)

Details
Parameter
aMessageIterator
Ein weiterer Nachrichten-iterator, mit dem verglichen werden soll.

read16

WEAVE_ERROR read16(
  uint16_t *
)

Details
Parameter
aDestination
Ein Ort, um einen kurzen Text aus dem Puffer abzulesen.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn die Ausführung über das Ende des Puffers hinausgeht.

read32

WEAVE_ERROR read32(
  uint32_t *
)

Details
Parameter
aDestination
Stelle, an der 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 die Ausführung über das Ende des Puffers hinausgeht.

read64

WEAVE_ERROR read64(
  uint64_t *
)

Details
Parameter
aDestination
Ort zum Auslesen eines 64-Bit-Werts aus dem Zwischenspeicher.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn die Ausführung über das Ende des Puffers hinausgeht.

readByte

WEAVE_ERROR readByte(
  uint8_t *
)

Details
Parameter
aDestination
Ein Ort, an dem ein gelesener Byte aus dem Zwischenspeicher abgelegt werden kann.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn die Ausführung über das Ende des Puffers hinausgeht.

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 gespeichert werden.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn die Ausführung über das Ende des Puffers hinausgeht.

readString

WEAVE_ERROR readString(
  uint16_t,
  char *
)

Details
Parameter
aLength
Die Länge der zu lesenden Zeichenfolge.
aString
Eine Stelle, an der die Zeichenfolge eingefügt werden soll.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn die Ausführung über das Ende des Puffers hinausgeht.

write16

WEAVE_ERROR write16(
  uint16_t
)

Details
Parameter
aValue
Ein kurzer Wert, der ausgeschrieben werden soll.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn die Ausführung über das Ende des Puffers hinausgeht.

write32

WEAVE_ERROR write32(
  uint32_t
)

Details
Parameter
aValue
Ein 32-Bit-Wert, der ausgeschrieben werden soll.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn die Ausführung über das Ende des Puffers hinausgeht.

write64

WEAVE_ERROR write64(
  uint64_t
)

Details
Parameter
aValue
Ein 64-Bit-Wert, der ausgeschrieben werden soll.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn die Ausführung über das Ende des Puffers hinausgeht.

writeByte

WEAVE_ERROR writeByte(
  uint8_t
)

Details
Parameter
aValue
Ein zu schreibender Bytewert.
Rückgabewerte
WEAVE_NO_ERROR
Wenn alles in Ordnung ist.
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn die Ausführung über das Ende des Puffers hinausgeht.

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 die Ausführung über das Ende des Puffers hinausgeht.

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 die Ausführung über das Ende des Puffers hinausgeht.