nl::Weave::Profiles::MessageIterator

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

Para usar los búferes de mensajes de manera razonable, definimos este iterador, que se puede usar para realizar un seguimiento de los límites, etcétera.

Resumen

Herencia

Hereda de: nl::Weave::Profiles::RetainedPacketBuffer.

Constructores y destructores
MessageIterator(System::PacketBuffer *)
Es el método del constructor.

Atributos públicos
thePoint
uint8_t *

Funciones públicas
append(void)
void
Establece el punto después de los datos que se encuentran actualmente en el búfer.
finishWriting(void)
void
Ajusta el búfer después de escribirlo.
hasData(uint16_t)
bool
hasRoom(uint16_t)
bool
operator!=(const MessageIterator &)
bool
operator*(void)
uint8_t &
operator+(uint16_t)
operator++(void)
Aumenta el iterador de mensajes en 1 si hay espacio.
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 *)

Atributos públicos

thePoint

uint8_t * thePoint

Funciones públicas

MessageIterator

 MessageIterator(
  System::PacketBuffer *
)

Es el método del constructor.

Detalles
Parámetros
aBuffer
Un búfer de mensaje para iterar.

append

void append(
  void
)

Establece el punto después de los datos que se encuentran actualmente en el búfer.

finishWriting

void finishWriting(
  void
)

Ajusta el búfer después de escribirlo.

hasData

bool hasData(
  uint16_t
)

Detalles
Parámetros
inc
Es un número entero que se puede leer desde el búfer.
Valores que se muestran
true
La longitud actual de los datos del búfer es mayor o igual que el incremento determinado.
false
De lo contrario.

hasRoom

bool hasRoom(
  uint16_t
)

Detalles
Parámetros
inc
Es un número entero que se puede escribir en el búfer.
Valores que se muestran
true
La diferencia entre la longitud de datos actual del búfer y su longitud de datos máxima permitida (la longitud de datos disponible) es menor o igual que el incremento determinado.
false
De lo contrario.

operador!=

bool operator!=(
  const MessageIterator &
)

Detalles
Parámetros
aMessageIterator
Otro iterador de mensajes para comparar.

operador*

uint8_t & operator*(
  void
)

Detalles
Qué muestra
Lo que vemos en el búfer.

operador+

MessageIterator & operator+(
  uint16_t
)

Detalles
Parámetros
inc
Es un incremento para aplicar al iterador de mensajes.
Qué muestra
El iterador incrementado por el valor dado si hay espacio, o bien se impone directamente al final si no hay.

operador++

MessageIterator & operator++(
  void
)

Aumenta el iterador de mensajes en 1 si hay espacio.

operator-

MessageIterator & operator-(
  uint16_t
)

Detalles
Parámetros
dec
Una disminución que se aplica al iterador de mensajes.
Qué muestra
El iterador se reduce por el valor dado si hay espacio, o bien se choca directamente contra el principio si no hay.

operador==

bool operator==(
  const MessageIterator &
)

Detalles
Parámetros
aMessageIterator
Otro iterador de mensajes para comparar.

read16

WEAVE_ERROR read16(
  uint16_t *
)

Detalles
Parámetros
aDestination
Es un lugar para guardar una lectura breve en el búfer.
Valores que se muestran
WEAVE_NO_ERROR
Si está todo bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si la ejecución va más allá del final del búfer,

read32

WEAVE_ERROR read32(
  uint32_t *
)

Detalles
Parámetros
aDestination
Es un lugar para colocar un valor de 32 bits del búfer.
Valores que se muestran
WEAVE_NO_ERROR
Si está todo bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si la ejecución va más allá del final del búfer,

read64

WEAVE_ERROR read64(
  uint64_t *
)

Detalles
Parámetros
aDestination
Es un lugar para colocar un valor de 64 bits como lectura del búfer.
Valores que se muestran
WEAVE_NO_ERROR
Si está todo bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si la ejecución va más allá del final del búfer,

readByte

WEAVE_ERROR readByte(
  uint8_t *
)

Detalles
Parámetros
aDestination
Es un lugar para colocar un byte leído del búfer.
Valores que se muestran
WEAVE_NO_ERROR
Si está todo bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si la ejecución va más allá del final del búfer,

readBytes

WEAVE_ERROR readBytes(
  uint16_t,
  uint8_t *
)

Detalles
Parámetros
aLength
La longitud de la string de bytes que se leerá.
aByteString
Es un lugar para colocar los bytes.
Valores que se muestran
WEAVE_NO_ERROR
Si está todo bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si la ejecución va más allá del final del búfer,

readString

WEAVE_ERROR readString(
  uint16_t,
  char *
)

Detalles
Parámetros
aLength
Longitud de la cadena que se leerá.
aString
Es un lugar para poner la cadena.
Valores que se muestran
WEAVE_NO_ERROR
Si está todo bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si la ejecución va más allá del final del búfer,

write16

WEAVE_ERROR write16(
  uint16_t
)

Detalles
Parámetros
aValue
Es un valor corto para escribir.
Valores que se muestran
WEAVE_NO_ERROR
Si está todo bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si la ejecución va más allá del final del búfer,

write32

WEAVE_ERROR write32(
  uint32_t
)

Detalles
Parámetros
aValue
Es un valor de 32 bits para escribir.
Valores que se muestran
WEAVE_NO_ERROR
Si está todo bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si la ejecución va más allá del final del búfer,

write64

WEAVE_ERROR write64(
  uint64_t
)

Detalles
Parámetros
aValue
Es un valor de 64 bits para escribir.
Valores que se muestran
WEAVE_NO_ERROR
Si está todo bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si la ejecución va más allá del final del búfer,

writeByte

WEAVE_ERROR writeByte(
  uint8_t
)

Detalles
Parámetros
aValue
Es un valor de byte para escribir.
Valores que se muestran
WEAVE_NO_ERROR
Si está todo bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si la ejecución va más allá del final del búfer,

writeBytes

WEAVE_ERROR writeBytes(
  uint16_t,
  uint8_t *
)

Detalles
Parámetros
aLength
La longitud de la string de bytes que se escribirá.
aString
La string de bytes en sí.
Valores que se muestran
WEAVE_NO_ERROR
Si está todo bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si la ejecución va más allá del final del búfer,

writeString

WEAVE_ERROR writeString(
  uint16_t,
  char *
)

Detalles
Parámetros
aLength
Longitud de la cadena que se escribirá.
aString
La string en sí.
Valores que se muestran
WEAVE_NO_ERROR
Si está todo bien.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si la ejecución va más allá del final del búfer,