nl :: Tecer:: Perfis :: MessageIterator
#include <src/lib/profiles/common/WeaveMessage.h> Para usar buffers de mensagem de maneira sensata, definimos esse iterador, que pode ser usado para controlar os limites e assim por diante.
Resumo
Herança
Herda: nl :: Weave :: Profiles :: RetainedPacketBuffer Atributos públicos
o ponto
uint8_t * thePoint
Funções públicas
MessageIterator
MessageIterator(
System::PacketBuffer *
)
O método do construtor.
| Detalhes | | Parâmetros | aBuffer | Um buffer de mensagem para iterar. |
|
acrescentar
void append(
void
)
Defina o ponto após qualquer dado atualmente no buffer.
terminarWriting
void finishWriting(
void
)
Ajuste o buffer após a gravação.
hasData
bool hasData(
uint16_t
)
| Detalhes | | Parâmetros | inc | Uma quantidade inteira que pode ser lida do buffer. |
|
| Valores Retornados | true | O comprimento de dados atual do buffer é maior ou igual ao incremento fornecido. | false | Por outro lado. |
|
hasRoom
bool hasRoom(
uint16_t
)
| Detalhes | | Parâmetros | inc | Uma quantidade inteira que pode ser gravada no buffer. |
|
| Valores Retornados | true | A diferença entre o comprimento de dados atual do buffer e seu comprimento de dados máximo permitido (seu comprimento de dados disponível) é menor ou igual ao incremento fornecido. | false | Por outro lado. |
|
operador! =
bool operator!=(
const MessageIterator &
)
| Detalhes | | Parâmetros | aMessageIterator | Outro iterador de mensagem para comparação. |
|
operador*
uint8_t & operator*(
void
)
| Detalhes | | Devoluções | O que estamos vendo no buffer. |
operador +
MessageIterator & operator+(
uint16_t
)
| Detalhes | | Parâmetros | inc | Um incremento a ser aplicado ao iterador da mensagem. |
|
| Devoluções | O iterador é incrementado pelo valor fornecido se houver espaço, ou então é pressionado contra o final, se não houver. |
operador ++
MessageIterator & operator++(
void
)
Incremente um iterador de mensagem em 1 se houver espaço.
operador-
MessageIterator & operator-(
uint16_t
)
| Detalhes | | Parâmetros | dec | Um decremento a ser aplicado ao iterador da mensagem. |
|
| Devoluções | O iterador é decrementado pelo valor fornecido se houver espaço, ou então vai contra o início, se não houver. |
operador ==
bool operator==(
const MessageIterator &
)
| Detalhes | | Parâmetros | aMessageIterator | Outro iterador de mensagem para comparação. |
|
read16
WEAVE_ERROR read16(
uint16_t *
)
| Detalhes | | Parâmetros | aDestination | Um lugar para colocar uma breve leitura do buffer. |
|
| Valores Retornados | WEAVE_NO_ERROR | Se estiver tudo bem. | WEAVE_ERROR_BUFFER_TOO_SMALL | Se estivermos correndo além do final do buffer. |
|
read32
WEAVE_ERROR read32(
uint32_t *
)
| Detalhes | | Parâmetros | aDestination | Um lugar para colocar um valor de 32 bits lido no buffer. |
|
| Valores Retornados | WEAVE_NO_ERROR | Se estiver tudo bem. | WEAVE_ERROR_BUFFER_TOO_SMALL | Se estivermos correndo além do final do buffer. |
|
read64
WEAVE_ERROR read64(
uint64_t *
)
| Detalhes | | Parâmetros | aDestination | Um lugar para colocar um valor de 64 bits lido no buffer. |
|
| Valores Retornados | WEAVE_NO_ERROR | Se estiver tudo bem. | WEAVE_ERROR_BUFFER_TOO_SMALL | Se estivermos correndo além do final do buffer. |
|
readByte
WEAVE_ERROR readByte(
uint8_t *
)
| Detalhes | | Parâmetros | aDestination | Um lugar para colocar um byte lido no buffer. |
|
| Valores Retornados | WEAVE_NO_ERROR | Se estiver tudo bem. | WEAVE_ERROR_BUFFER_TOO_SMALL | Se estivermos correndo além do final do buffer. |
|
readBytes
WEAVE_ERROR readBytes(
uint16_t,
uint8_t *
)
| Detalhes | | Parâmetros | aLength | O comprimento da string de bytes a ser lida. | aByteString | Um lugar para colocar os bytes. |
|
| Valores Retornados | WEAVE_NO_ERROR | Se estiver tudo bem. | WEAVE_ERROR_BUFFER_TOO_SMALL | Se estivermos correndo além do final do buffer. |
|
readString
WEAVE_ERROR readString(
uint16_t,
char *
)
| Detalhes | | Parâmetros | aLength | O comprimento da string a ser lida. | aString | Um lugar para colocar o barbante. |
|
| Valores Retornados | WEAVE_NO_ERROR | Se estiver tudo bem. | WEAVE_ERROR_BUFFER_TOO_SMALL | Se estivermos correndo além do final do buffer. |
|
write16
WEAVE_ERROR write16(
uint16_t
)
| Detalhes | | Parâmetros | aValue | Um valor curto para escrever. |
|
| Valores Retornados | WEAVE_NO_ERROR | Se estiver tudo bem. | WEAVE_ERROR_BUFFER_TOO_SMALL | Se estivermos correndo além do final do buffer. |
|
write32
WEAVE_ERROR write32(
uint32_t
)
| Detalhes | | Parâmetros | aValue | Um valor de 32 bits para escrever. |
|
| Valores Retornados | WEAVE_NO_ERROR | Se estiver tudo bem. | WEAVE_ERROR_BUFFER_TOO_SMALL | Se estivermos correndo além do final do buffer. |
|
write64
WEAVE_ERROR write64(
uint64_t
)
| Detalhes | | Parâmetros | aValue | Um valor de 64 bits para escrever. |
|
| Valores Retornados | WEAVE_NO_ERROR | Se estiver tudo bem. | WEAVE_ERROR_BUFFER_TOO_SMALL | Se estivermos correndo além do final do buffer. |
|
writeByte
WEAVE_ERROR writeByte(
uint8_t
)
| Detalhes | | Parâmetros | aValue | Um valor de byte para escrever. |
|
| Valores Retornados | WEAVE_NO_ERROR | Se estiver tudo bem. | WEAVE_ERROR_BUFFER_TOO_SMALL | Se estivermos correndo além do final do buffer. |
|
writeBytes
WEAVE_ERROR writeBytes(
uint16_t,
uint8_t *
)
| Detalhes | | Parâmetros | aLength | O comprimento da string de bytes a ser escrita. | aString | A própria string de bytes. |
|
| Valores Retornados | WEAVE_NO_ERROR | Se estiver tudo bem. | WEAVE_ERROR_BUFFER_TOO_SMALL | Se estivermos correndo além do final do buffer. |
|
writeString
WEAVE_ERROR writeString(
uint16_t,
char *
)
| Detalhes | | Parâmetros | aLength | O comprimento da string a ser escrita. | aString | A própria corda. |
|
| Valores Retornados | WEAVE_NO_ERROR | Se estiver tudo bem. | WEAVE_ERROR_BUFFER_TOO_SMALL | Se estivermos correndo além do final do buffer. |
|
