nl:: Weben:: Profile:: MessageIterator
#include <src/lib/profiles/common/WeaveMessage.h>
Um Nachrichtenpuffer sinnvoll zu nutzen, definieren wir diesen Iterator, mit dem man Grenzen verfolgen kann und so weiter.
Zusammenfassung
Erbe
Erbt von: nl :: Weave :: Profile :: RetainedPacketBuffer Öffentliche Attribute |
---|
thePoint | uint8_t * |
Öffentliche Attribute
Der Punkt
uint8_t * thePoint
Öffentliche Funktionen
MessageIterator
MessageIterator(
System::PacketBuffer *
)
Die Konstruktormethode.
Einzelheiten | Parameter | aBuffer | Ein Nachrichtenpuffer, über den iteriert werden soll. |
|
anhängen
void append(
void
)
Setzen Sie den Punkt auf nach allen Daten, die sich derzeit im Puffer befinden.
fertigSchreiben
void finishWriting(
void
)
Passen Sie den Puffer nach dem Schreiben an.
hasData
bool hasData(
uint16_t
)
Einzelheiten | Parameter | inc | Ein ganzzahliger Betrag, 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
)
Einzelheiten | Parameter | inc | Ein ganzzahliger Betrag, der in den Puffer geschrieben werden kann. |
|
Rückgabewerte | true | Die Differenz zwischen der aktuellen Datenlänge des Puffers und seiner maximal zulässigen Datenlänge (seine verfügbare Datenlänge) ist kleiner oder gleich der angegebenen Schrittweite. | false | Andernfalls. |
|
Betreiber!=
bool operator!=(
const MessageIterator &
)
Einzelheiten | Parameter | aMessageIterator | Ein weiterer Nachrichteniterator zum Vergleichen. |
|
Operator*
uint8_t & operator*(
void
)
Einzelheiten | Kehrt zurück | Was wir im Puffer sehen. |
Betreiber+
MessageIterator & operator+(
uint16_t
)
Einzelheiten | Parameter | inc | Ein Inkrement, das auf den Nachrichteniterator angewendet werden soll. |
|
Kehrt zurück | Der Iterator wird um den angegebenen Wert erhöht, wenn Platz vorhanden ist, oder knallt direkt gegen das Ende, wenn nicht vorhanden. |
Betreiber++
MessageIterator & operator++(
void
)
Erhöhen Sie einen Nachrichteniterator um 1, wenn Platz vorhanden ist.
Operator-
MessageIterator & operator-(
uint16_t
)
Einzelheiten | Parameter | dec | Ein Dekrement, das auf den Nachrichteniterator angewendet werden soll. |
|
Kehrt zurück | Der Iterator wird um den angegebenen Wert dekrementiert, wenn Platz vorhanden ist, oder knallt direkt gegen den Anfang, wenn nicht vorhanden |
Betreiber==
bool operator==(
const MessageIterator &
)
Einzelheiten | Parameter | aMessageIterator | Ein weiterer Nachrichteniterator zum Vergleichen. |
|
lesen16
WEAVE_ERROR read16(
uint16_t *
)
Einzelheiten | Parameter | aDestination | Ein Ort, um einen kurzen Lesevorgang aus dem Puffer zu setzen. |
|
Rückgabewerte | WEAVE_NO_ERROR | Wenn alles in Ordnung ist. | WEAVE_ERROR_BUFFER_TOO_SMALL | Wenn wir das Ende des Puffers überschreiten. |
|
lesen32
WEAVE_ERROR read32(
uint32_t *
)
Einzelheiten | Parameter | aDestination | Ein Ort, um einen 32-Bit-Wert abzulegen, der aus dem Puffer gelesen wird. |
|
Rückgabewerte | WEAVE_NO_ERROR | Wenn alles in Ordnung ist. | WEAVE_ERROR_BUFFER_TOO_SMALL | Wenn wir das Ende des Puffers überschreiten. |
|
lesen64
WEAVE_ERROR read64(
uint64_t *
)
Einzelheiten | Parameter | aDestination | Ein Ort, um einen 64-Bit-Wert abzulegen, der aus dem Puffer gelesen wird. |
|
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 *
)
Einzelheiten | Parameter | aDestination | Ein Platz, um ein aus dem Puffer gelesenes Byte zu platzieren. |
|
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 *
)
Einzelheiten | Parameter | aLength | Die Länge der zu lesenden Byte-Zeichenfolge. | aByteString | Ein Ort, um die Bytes zu setzen. |
|
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 *
)
Einzelheiten | Parameter | aLength | Die Länge der zu lesenden Zeichenfolge. | aString | Ein Ort, um die Saite zu legen. |
|
Rückgabewerte | WEAVE_NO_ERROR | Wenn alles in Ordnung ist. | WEAVE_ERROR_BUFFER_TOO_SMALL | Wenn wir das Ende des Puffers überschreiten. |
|
schreiben16
WEAVE_ERROR write16(
uint16_t
)
Einzelheiten | Parameter | aValue | Ein kurzer Wert zum Ausschreiben. |
|
Rückgabewerte | WEAVE_NO_ERROR | Wenn alles in Ordnung ist. | WEAVE_ERROR_BUFFER_TOO_SMALL | Wenn wir das Ende des Puffers überschreiten. |
|
schreiben32
WEAVE_ERROR write32(
uint32_t
)
Einzelheiten | Parameter | aValue | Ein 32-Bit-Wert zum Ausschreiben. |
|
Rückgabewerte | WEAVE_NO_ERROR | Wenn alles in Ordnung ist. | WEAVE_ERROR_BUFFER_TOO_SMALL | Wenn wir das Ende des Puffers überschreiten. |
|
schreiben64
WEAVE_ERROR write64(
uint64_t
)
Einzelheiten | Parameter | aValue | Ein zu schreibender 64-Bit-Wert. |
|
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
)
Einzelheiten | 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 *
)
Einzelheiten | Parameter | aLength | Die Länge der zu schreibenden Byte-Zeichenfolge. | aString | Die Byte-Zeichenfolge 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 *
)
Einzelheiten | Parameter | aLength | Die Länge der zu schreibenden Zeichenfolge. | aString | Die Saite selbst. |
|
Rückgabewerte | WEAVE_NO_ERROR | Wenn alles in Ordnung ist. | WEAVE_ERROR_BUFFER_TOO_SMALL | Wenn wir das Ende des Puffers überschreiten. |
|