nl::Weave::Profiles::MessageIterator

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

Para usar buffers de mensagem de maneira coerente, definimos esse iterador, que pode ser usado para monitorar os limites e assim por diante.

Resumo

Herança

Herda de: nl::Weave::Profiles::RetainedPacketBuffer

Construtores e destruidores
MessageIterator(System::PacketBuffer *)
O método construtor.

Atributos públicos
thePoint
uint8_t *

Funções públicas
append(void)
void
Defina o ponto como após todos os dados atualmente no buffer.
finishWriting(void)
void
Ajuste o buffer depois da gravação.
hasData(uint16_t)
bool
hasRoom(uint16_t)
bool
operator!=(const MessageIterator &)
bool
operator*(void)
uint8_t &
operator+(uint16_t)
operator++(void)
Incremente um iterador de mensagens em 1 se houver espaço.
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

Funções públicas

MessageIterator

 MessageIterator(
  System::PacketBuffer *
)

O método construtor.

Detalhes
Parâmetros
aBuffer
Um buffer de mensagem para iterar.

append

void append(
  void
)

Defina o ponto como após todos os dados atualmente no buffer.

finishWriting

void finishWriting(
  void
)

Ajuste o buffer depois da gravação.

hasData

bool hasData(
  uint16_t
)

Detalhes
Parâmetros
inc
Um valor inteiro que pode ser lido do buffer.
Valores de retorno
true
O comprimento de dados atual do buffer é maior ou igual ao incremento especificado.
false
Caso contrário.

hasRoom

bool hasRoom(
  uint16_t
)

Detalhes
Parâmetros
inc
Um valor inteiro que pode ser gravado no buffer.
Valores de retorno
true
A diferença entre o comprimento de dados atual do buffer e seu comprimento de dados máximo permitido (o comprimento de dados disponível) é menor ou igual ao incremento determinado.
false
Caso contrário.

operator!=

bool operator!=(
  const MessageIterator &
)

Detalhes
Parâmetros
aMessageIterator
Outro iterador de mensagens para comparar.

operador*

uint8_t & operator*(
  void
)

Detalhes
Retornos
O que estamos vendo no buffer.

operador+

MessageIterator & operator+(
  uint16_t
)

Detalhes
Parâmetros
inc
Um incremento a ser aplicado ao iterador de mensagens.
Retornos
O iterador incrementado pelo valor fornecido se houver espaço ou, então, bateu diretamente no final, se não houver.

operador++

MessageIterator & operator++(
  void
)

Incremente um iterador de mensagens em 1 se houver espaço.

operator-

MessageIterator & operator-(
  uint16_t
)

Detalhes
Parâmetros
dec
Um decremento a ser aplicado ao iterador de mensagens.
Retornos
O iterador diminuiu pelo valor fornecido se houver espaço ou, se não houver, bateu diretamente no início.

operador==

bool operator==(
  const MessageIterator &
)

Detalhes
Parâmetros
aMessageIterator
Outro iterador de mensagens para comparar.

read16

WEAVE_ERROR read16(
  uint16_t *
)

Detalhes
Parâmetros
aDestination
Um local para colocar uma leitura curta do buffer.
Valores de retorno
WEAVE_NO_ERROR
Se estiver tudo bem.
WEAVE_ERROR_BUFFER_TOO_SMALL
Quando a execução passa do fim do buffer.

read32

WEAVE_ERROR read32(
  uint32_t *
)

Detalhes
Parâmetros
aDestination
Um local para colocar um valor de 32 bits lido fora do buffer.
Valores de retorno
WEAVE_NO_ERROR
Se estiver tudo bem.
WEAVE_ERROR_BUFFER_TOO_SMALL
Quando a execução passa do fim do buffer.

read64

WEAVE_ERROR read64(
  uint64_t *
)

Detalhes
Parâmetros
aDestination
Um local para colocar um valor de 64 bits lido fora do buffer.
Valores de retorno
WEAVE_NO_ERROR
Se estiver tudo bem.
WEAVE_ERROR_BUFFER_TOO_SMALL
Quando a execução passa do fim do buffer.

readByte

WEAVE_ERROR readByte(
  uint8_t *
)

Detalhes
Parâmetros
aDestination
Um local para colocar um byte lido fora do buffer.
Valores de retorno
WEAVE_NO_ERROR
Se estiver tudo bem.
WEAVE_ERROR_BUFFER_TOO_SMALL
Quando a execução passa do fim do buffer.

readBytes

WEAVE_ERROR readBytes(
  uint16_t,
  uint8_t *
)

Detalhes
Parâmetros
aLength
O tamanho da string de bytes a ser lida.
aByteString
Um local para colocar os bytes.
Valores de retorno
WEAVE_NO_ERROR
Se estiver tudo bem.
WEAVE_ERROR_BUFFER_TOO_SMALL
Quando a execução passa do fim do buffer.

readString

WEAVE_ERROR readString(
  uint16_t,
  char *
)

Detalhes
Parâmetros
aLength
O comprimento da string a ser lida.
aString
Um local para colocar a string.
Valores de retorno
WEAVE_NO_ERROR
Se estiver tudo bem.
WEAVE_ERROR_BUFFER_TOO_SMALL
Quando a execução passa do fim do buffer.

write16

WEAVE_ERROR write16(
  uint16_t
)

Detalhes
Parâmetros
aValue
Um valor curto a ser gravado.
Valores de retorno
WEAVE_NO_ERROR
Se estiver tudo bem.
WEAVE_ERROR_BUFFER_TOO_SMALL
Quando a execução passa do fim do buffer.

write32

WEAVE_ERROR write32(
  uint32_t
)

Detalhes
Parâmetros
aValue
Um valor de 32 bits para gravar.
Valores de retorno
WEAVE_NO_ERROR
Se estiver tudo bem.
WEAVE_ERROR_BUFFER_TOO_SMALL
Quando a execução passa do fim do buffer.

write64

WEAVE_ERROR write64(
  uint64_t
)

Detalhes
Parâmetros
aValue
Um valor de 64 bits para gravar.
Valores de retorno
WEAVE_NO_ERROR
Se estiver tudo bem.
WEAVE_ERROR_BUFFER_TOO_SMALL
Quando a execução passa do fim do buffer.

writeByte

WEAVE_ERROR writeByte(
  uint8_t
)

Detalhes
Parâmetros
aValue
Um valor de byte a ser gravado.
Valores de retorno
WEAVE_NO_ERROR
Se estiver tudo bem.
WEAVE_ERROR_BUFFER_TOO_SMALL
Quando a execução passa do fim do buffer.

writeBytes

WEAVE_ERROR writeBytes(
  uint16_t,
  uint8_t *
)

Detalhes
Parâmetros
aLength
O tamanho da string de bytes a ser gravada.
aString
A própria string de bytes.
Valores de retorno
WEAVE_NO_ERROR
Se estiver tudo bem.
WEAVE_ERROR_BUFFER_TOO_SMALL
Quando a execução passa do fim do buffer.

writeString

WEAVE_ERROR writeString(
  uint16_t,
  char *
)

Detalhes
Parâmetros
aLength
O comprimento da string a ser gravada.
aString
A própria string.
Valores de retorno
WEAVE_NO_ERROR
Se estiver tudo bem.
WEAVE_ERROR_BUFFER_TOO_SMALL
Quando a execução passa do fim do buffer.