nl :: Tejido:: Perfiles: MessageIterator
#include <src/lib/profiles/common/WeaveMessage.h> Para utilizar los búferes de mensajes de forma sensata, definimos este iterador, que se puede utilizar para realizar un seguimiento de los límites, etc.
Resumen
Herencia
Hereda de: nl :: Armadura :: Perfiles :: RetainedPacketBuffer Atributos públicos
el punto
uint8_t * thePoint
Funciones publicas
MessageIterator
MessageIterator(
System::PacketBuffer *
)
El método constructor.
| Detalles | | Parámetros | aBuffer | Un búfer de mensajes para iterar. |
|
adjuntar
void append(
void
)
Establezca el punto después de cualquier dato actualmente en el búfer.
terminar de escribir
void finishWriting(
void
)
Ajuste el búfer después de escribir.
hasData
bool hasData(
uint16_t
)
| Detalles | | Parámetros | inc | Una cantidad entera que se puede leer del búfer. |
|
| Valores devueltos | true | La longitud actual de los datos del búfer es mayor o igual que el incremento dado. | false | De lo contrario. |
|
hasRoom
bool hasRoom(
uint16_t
)
| Detalles | | Parámetros | inc | Una cantidad entera que se puede escribir en el búfer. |
|
| Valores devueltos | true | La diferencia entre la longitud de datos actual del búfer y su longitud de datos máxima permitida (su longitud de datos disponible) es menor o igual que el incremento dado. | false | De lo contrario. |
|
operador! =
bool operator!=(
const MessageIterator &
)
| Detalles | | Parámetros | aMessageIterator | Otro iterador de mensajes con el que comparar. |
|
operador*
uint8_t & operator*(
void
)
| Detalles | | Devoluciones | Lo que estamos viendo en el búfer. |
operador +
MessageIterator & operator+(
uint16_t
)
| Detalles | | Parámetros | inc | Un incremento que se aplicará al iterador de mensajes. |
|
| Devoluciones | El iterador se incrementa por el valor dado si hay espacio, o se golpea contra el final si no lo hay. |
operador ++
MessageIterator & operator++(
void
)
Incrementa un iterador de mensaje en 1 si hay espacio.
operador-
MessageIterator & operator-(
uint16_t
)
| Detalles | | Parámetros | dec | Una disminución para aplicar al iterador de mensajes. |
|
| Devoluciones | El iterador disminuyó por el valor dado si hay espacio, o se estrelló contra el principio si no lo hay. |
operador ==
bool operator==(
const MessageIterator &
)
| Detalles | | Parámetros | aMessageIterator | Otro iterador de mensajes con el que comparar. |
|
read16
WEAVE_ERROR read16(
uint16_t *
)
| Detalles | | Parámetros | aDestination | Un lugar para hacer una breve lectura del búfer. |
|
| Valores devueltos | WEAVE_NO_ERROR | Si todo está bien. | WEAVE_ERROR_BUFFER_TOO_SMALL | Si estamos pasando el final del búfer. |
|
read32
WEAVE_ERROR read32(
uint32_t *
)
| Detalles | | Parámetros | aDestination | Un lugar para poner un valor de 32 bits leído en el búfer. |
|
| Valores devueltos | WEAVE_NO_ERROR | Si todo está bien. | WEAVE_ERROR_BUFFER_TOO_SMALL | Si estamos pasando el final del búfer. |
|
read64
WEAVE_ERROR read64(
uint64_t *
)
| Detalles | | Parámetros | aDestination | Un lugar para poner un valor de 64 bits leído en el búfer. |
|
| Valores devueltos | WEAVE_NO_ERROR | Si todo está bien. | WEAVE_ERROR_BUFFER_TOO_SMALL | Si estamos pasando el final del búfer. |
|
readByte
WEAVE_ERROR readByte(
uint8_t *
)
| Detalles | | Parámetros | aDestination | Un lugar para colocar un byte leído en el búfer. |
|
| Valores devueltos | WEAVE_NO_ERROR | Si todo está bien. | WEAVE_ERROR_BUFFER_TOO_SMALL | Si estamos pasando el final del búfer. |
|
readBytes
WEAVE_ERROR readBytes(
uint16_t,
uint8_t *
)
| Detalles | | Parámetros | aLength | La longitud de la cadena de bytes que se leerá. | aByteString | Un lugar para poner los bytes. |
|
| Valores devueltos | WEAVE_NO_ERROR | Si todo está bien. | WEAVE_ERROR_BUFFER_TOO_SMALL | Si estamos pasando el final del búfer. |
|
readString
WEAVE_ERROR readString(
uint16_t,
char *
)
| Detalles | | Parámetros | aLength | La longitud de la cadena que se leerá. | aString | Un lugar para poner la cuerda. |
|
| Valores devueltos | WEAVE_NO_ERROR | Si todo está bien. | WEAVE_ERROR_BUFFER_TOO_SMALL | Si estamos pasando el final del búfer. |
|
escribir 16
WEAVE_ERROR write16(
uint16_t
)
| Detalles | | Parámetros | aValue | Un valor corto para escribir. |
|
| Valores devueltos | WEAVE_NO_ERROR | Si todo está bien. | WEAVE_ERROR_BUFFER_TOO_SMALL | Si estamos pasando el final del búfer. |
|
write32
WEAVE_ERROR write32(
uint32_t
)
| Detalles | | Parámetros | aValue | Un valor de 32 bits para escribir. |
|
| Valores devueltos | WEAVE_NO_ERROR | Si todo está bien. | WEAVE_ERROR_BUFFER_TOO_SMALL | Si estamos pasando el final del búfer. |
|
write64
WEAVE_ERROR write64(
uint64_t
)
| Detalles | | Parámetros | aValue | Un valor de 64 bits para escribir. |
|
| Valores devueltos | WEAVE_NO_ERROR | Si todo está bien. | WEAVE_ERROR_BUFFER_TOO_SMALL | Si estamos pasando el final del búfer. |
|
writeByte
WEAVE_ERROR writeByte(
uint8_t
)
| Detalles | | Parámetros | aValue | Un valor de byte para escribir. |
|
| Valores devueltos | WEAVE_NO_ERROR | Si todo está bien. | WEAVE_ERROR_BUFFER_TOO_SMALL | Si estamos pasando el final del búfer. |
|
writeBytes
WEAVE_ERROR writeBytes(
uint16_t,
uint8_t *
)
| Detalles | | Parámetros | aLength | La longitud de la cadena de bytes que se va a escribir. | aString | La propia cadena de bytes. |
|
| Valores devueltos | WEAVE_NO_ERROR | Si todo está bien. | WEAVE_ERROR_BUFFER_TOO_SMALL | Si estamos pasando el final del búfer. |
|
writeString
WEAVE_ERROR writeString(
uint16_t,
char *
)
| Detalles | | Parámetros | aLength | La longitud de la cadena que se va a escribir. | aString | La propia cuerda. |
|
| Valores devueltos | WEAVE_NO_ERROR | Si todo está bien. | WEAVE_ERROR_BUFFER_TOO_SMALL | Si estamos pasando el final del búfer. |
|
