nl::Weave::Profiles::MessageIterator

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

Per utilizzare i buffer dei messaggi in modo ragionevole, definiamo questo iteratore, che può essere utilizzato per tenere traccia dei confini e così via.

Riepilogo

Eredità

Eredita da: nl::Weave::Profiles::RetainedPacketBuffer

Costruttori e distruttori
MessageIterator(System::PacketBuffer *)
Il metodo del costruttore.

Attributi pubblici
thePoint
uint8_t *

Funzioni pubbliche
append(void)
void
Imposta il punto dopo i dati attualmente presenti nel buffer.
finishWriting(void)
void
Regola il buffer dopo la scrittura.
hasData(uint16_t)
bool
hasRoom(uint16_t)
bool
operator!=(const MessageIterator &)
bool
operator*(void)
uint8_t &
operator+(uint16_t)
operator++(void)
Aumenta di 1 un iteratore dei messaggi se c'è spazio.
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 *)

Attributi pubblici

thePoint

uint8_t * thePoint

Funzioni pubbliche

MessageIterator

 MessageIterator(
  System::PacketBuffer *
)

Il metodo del costruttore.

Dettagli
Parametri
aBuffer
Un buffer di messaggi da eseguire l'iterazione.

Aggiunta

void append(
  void
)

Imposta il punto dopo i dati attualmente presenti nel buffer.

finishWriting

void finishWriting(
  void
)

Regola il buffer dopo la scrittura.

hasData

bool hasData(
  uint16_t
)

Dettagli
Parametri
inc
Un numero intero che può essere letto dal buffer.
Valori restituiti
true
La lunghezza dei dati attuale del buffer è maggiore o uguale all'incremento specificato.
false
Altrimenti.

hasRoom

bool hasRoom(
  uint16_t
)

Dettagli
Parametri
inc
Un numero intero che può essere scritto nel buffer.
Valori restituiti
true
La differenza tra la lunghezza dei dati attuale del buffer e la lunghezza massima consentita (la lunghezza dei dati disponibile) è inferiore o uguale all'incremento specificato.
false
Altrimenti.

operator!=

bool operator!=(
  const MessageIterator &
)

Dettagli
Parametri
aMessageIterator
Un altro iteratore di messaggi con cui eseguire il confronto.

operatore*

uint8_t & operator*(
  void
)

Dettagli
Restituisce
Ciò che stiamo guardando nel buffer.

operatore+

MessageIterator & operator+(
  uint16_t
)

Dettagli
Parametri
inc
Un incremento da applicare all'iteratore dei messaggi.
Restituisce
L'iteratore è stato incrementato del valore specificato se c'è spazio oppure si è scontrato direttamente alla fine in caso contrario.

operatore++

MessageIterator & operator++(
  void
)

Aumenta di 1 un iteratore dei messaggi se c'è spazio.

operator-

MessageIterator & operator-(
  uint16_t
)

Dettagli
Parametri
dec
Un decremento da applicare all'iteratore dei messaggi.
Restituisce
L'iteratore è diminuito in base al valore specificato, se c'è spazio, oppure si è scontrato contro l'inizio in caso contrario.

operatore==

bool operator==(
  const MessageIterator &
)

Dettagli
Parametri
aMessageIterator
Un altro iteratore di messaggi con cui eseguire il confronto.

read16

WEAVE_ERROR read16(
  uint16_t *
)

Dettagli
Parametri
aDestination
Un posto in cui mettere una breve lettura dal buffer.
Valori restituiti
WEAVE_NO_ERROR
Se è tutto a posto.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se stiamo superando la fine del buffer.

read32

WEAVE_ERROR read32(
  uint32_t *
)

Dettagli
Parametri
aDestination
Un posto in cui inserire un valore a 32 bit letto dal buffer.
Valori restituiti
WEAVE_NO_ERROR
Se è tutto a posto.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se stiamo superando la fine del buffer.

read64

WEAVE_ERROR read64(
  uint64_t *
)

Dettagli
Parametri
aDestination
Un posto in cui inserire un valore a 64 bit letto dal buffer.
Valori restituiti
WEAVE_NO_ERROR
Se è tutto a posto.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se stiamo superando la fine del buffer.

readByte

WEAVE_ERROR readByte(
  uint8_t *
)

Dettagli
Parametri
aDestination
Un posto in cui mettere un byte letto dal buffer.
Valori restituiti
WEAVE_NO_ERROR
Se è tutto a posto.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se stiamo superando la fine del buffer.

readBytes

WEAVE_ERROR readBytes(
  uint16_t,
  uint8_t *
)

Dettagli
Parametri
aLength
La lunghezza della stringa di byte da leggere.
aByteString
Un posto in cui inserire i byte.
Valori restituiti
WEAVE_NO_ERROR
Se è tutto a posto.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se stiamo superando la fine del buffer.

readString

WEAVE_ERROR readString(
  uint16_t,
  char *
)

Dettagli
Parametri
aLength
La lunghezza della stringa da leggere.
aString
Un posto in cui inserire la stringa.
Valori restituiti
WEAVE_NO_ERROR
Se è tutto a posto.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se stiamo superando la fine del buffer.

write16

WEAVE_ERROR write16(
  uint16_t
)

Dettagli
Parametri
aValue
Un valore breve da indicare.
Valori restituiti
WEAVE_NO_ERROR
Se è tutto a posto.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se stiamo superando la fine del buffer.

write32

WEAVE_ERROR write32(
  uint32_t
)

Dettagli
Parametri
aValue
Un valore a 32 bit da scrivere.
Valori restituiti
WEAVE_NO_ERROR
Se è tutto a posto.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se stiamo superando la fine del buffer.

write64

WEAVE_ERROR write64(
  uint64_t
)

Dettagli
Parametri
aValue
Un valore a 64 bit da scrivere.
Valori restituiti
WEAVE_NO_ERROR
Se è tutto a posto.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se stiamo superando la fine del buffer.

writeByte

WEAVE_ERROR writeByte(
  uint8_t
)

Dettagli
Parametri
aValue
Un valore di byte da scrivere.
Valori restituiti
WEAVE_NO_ERROR
Se è tutto a posto.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se stiamo superando la fine del buffer.

writeBytes

WEAVE_ERROR writeBytes(
  uint16_t,
  uint8_t *
)

Dettagli
Parametri
aLength
La lunghezza della stringa di byte da scrivere.
aString
La stringa di byte stessa.
Valori restituiti
WEAVE_NO_ERROR
Se è tutto a posto.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se stiamo superando la fine del buffer.

writeString

WEAVE_ERROR writeString(
  uint16_t,
  char *
)

Dettagli
Parametri
aLength
La lunghezza della stringa da scrivere.
aString
La stringa stessa.
Valori restituiti
WEAVE_NO_ERROR
Se è tutto a posto.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se stiamo superando la fine del buffer.