nl::Weave::Profiles::MessageIterator

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

Aby rozsądnie korzystać z buforów wiadomości, definiujemy iterator, za pomocą którego można śledzić granice itp.

Podsumowanie

Dziedziczenie

Dziedziczy z: nl::Weave::Profiles::RetainedPacketBuffer

Konstruktory i niszczyciele
MessageIterator(System::PacketBuffer *)
Metoda konstruktora.

Atrybuty publiczne
thePoint
uint8_t *

Funkcje publiczne
append(void)
void
Ustaw punkt na podstawie danych znajdujących się obecnie w buforze.
finishWriting(void)
void
Popraw bufor po zakończeniu pisania.
hasData(uint16_t)
bool
hasRoom(uint16_t)
bool
operator!=(const MessageIterator &)
bool
operator*(void)
uint8_t &
operator+(uint16_t)
operator++(void)
Zwiększ iterator wiadomości o 1, jeśli jest dość miejsca.
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 *)

Atrybuty publiczne

thePoint

uint8_t * thePoint

Funkcje publiczne

MessageIterator

 MessageIterator(
  System::PacketBuffer *
)

Metoda konstruktora.

Szczegóły
Parametry
aBuffer
Bufor wiadomości do iteracji.

dołączanie

void append(
  void
)

Ustaw punkt na podstawie danych znajdujących się obecnie w buforze.

finishWriting

void finishWriting(
  void
)

Popraw bufor po zakończeniu pisania.

hasData

bool hasData(
  uint16_t
)

Szczegóły
Parametry
inc
Liczba całkowita, która może zostać odczytana z bufora.
Zwracane wartości
true
Bieżąca długość danych bufora jest większa od podanego przyrostu lub jej równa.
false
W przeciwnym razie.

hasRoom

bool hasRoom(
  uint16_t
)

Szczegóły
Parametry
inc
Liczba całkowita, która może być zapisana w buforze.
Zwracane wartości
true
Różnica między bieżącą długością danych bufora a jego maksymalną dopuszczalną długością (dostępną długością danych) jest mniejsza od podanej wartości lub jej równa.
false
W przeciwnym razie.

operator!=

bool operator!=(
  const MessageIterator &
)

Szczegóły
Parametry
aMessageIterator
Kolejny iterator wiadomości do porównania.

operator*

uint8_t & operator*(
  void
)

Szczegóły
Zwroty
Na co patrzymy w buforze.

operator+

MessageIterator & operator+(
  uint16_t
)

Szczegóły
Parametry
inc
Wzrost, który ma być stosowany do iteratora wiadomości.
Zwroty
Jeśli jest miejsce, iterator zwiększa się o podaną wartość, a jeśli brakuje miejsca, przesuwa się prosto do końca.

operator++

MessageIterator & operator++(
  void
)

Zwiększ iterator wiadomości o 1, jeśli jest dość miejsca.

operator-

MessageIterator & operator-(
  uint16_t
)

Szczegóły
Parametry
dec
Zmniejszenie stosowane do iteratora wiadomości.
Zwroty
iterator pomniejszony o podaną wartość, jeśli jest miejsce, lub w przeciwnym razie uderzył na początku, jeśli brakuje miejsca.

operator==

bool operator==(
  const MessageIterator &
)

Szczegóły
Parametry
aMessageIterator
Kolejny iterator wiadomości do porównania.

read16

WEAVE_ERROR read16(
  uint16_t *
)

Szczegóły
Parametry
aDestination
Miejsce na krótki opis.
Zwracane wartości
WEAVE_NO_ERROR
Jeśli wszystko jest w porządku.
WEAVE_ERROR_BUFFER_TOO_SMALL
Gdy przekraczamy bufor.

read32

WEAVE_ERROR read32(
  uint32_t *
)

Szczegóły
Parametry
aDestination
Miejsce, w którym 32-bitowa wartość jest odczytywana z bufora.
Zwracane wartości
WEAVE_NO_ERROR
Jeśli wszystko jest w porządku.
WEAVE_ERROR_BUFFER_TOO_SMALL
Gdy przekraczamy bufor.

read64

WEAVE_ERROR read64(
  uint64_t *
)

Szczegóły
Parametry
aDestination
Miejsce, w którym 64-bitowa wartość jest odczytywana z bufora.
Zwracane wartości
WEAVE_NO_ERROR
Jeśli wszystko jest w porządku.
WEAVE_ERROR_BUFFER_TOO_SMALL
Gdy przekraczamy bufor.

readByte

WEAVE_ERROR readByte(
  uint8_t *
)

Szczegóły
Parametry
aDestination
Miejsce na zapisanie bajtów w buforze.
Zwracane wartości
WEAVE_NO_ERROR
Jeśli wszystko jest w porządku.
WEAVE_ERROR_BUFFER_TOO_SMALL
Gdy przekraczamy bufor.

readBytes

WEAVE_ERROR readBytes(
  uint16_t,
  uint8_t *
)

Szczegóły
Parametry
aLength
Długość ciągu bajtów do odczytu.
aByteString
Miejsce na bajty.
Zwracane wartości
WEAVE_NO_ERROR
Jeśli wszystko jest w porządku.
WEAVE_ERROR_BUFFER_TOO_SMALL
Gdy przekraczamy bufor.

readString

WEAVE_ERROR readString(
  uint16_t,
  char *
)

Szczegóły
Parametry
aLength
Długość ciągu do odczytu.
aString
Miejsce na wpisanie ciągu znaków.
Zwracane wartości
WEAVE_NO_ERROR
Jeśli wszystko jest w porządku.
WEAVE_ERROR_BUFFER_TOO_SMALL
Gdy przekraczamy bufor.

write16

WEAVE_ERROR write16(
  uint16_t
)

Szczegóły
Parametry
aValue
Krótka wartość do zapisania.
Zwracane wartości
WEAVE_NO_ERROR
Jeśli wszystko jest w porządku.
WEAVE_ERROR_BUFFER_TOO_SMALL
Gdy przekraczamy bufor.

write32

WEAVE_ERROR write32(
  uint32_t
)

Szczegóły
Parametry
aValue
32-bitowa wartość do zapisania.
Zwracane wartości
WEAVE_NO_ERROR
Jeśli wszystko jest w porządku.
WEAVE_ERROR_BUFFER_TOO_SMALL
Gdy przekraczamy bufor.

write64

WEAVE_ERROR write64(
  uint64_t
)

Szczegóły
Parametry
aValue
64-bitowa wartość do zapisania.
Zwracane wartości
WEAVE_NO_ERROR
Jeśli wszystko jest w porządku.
WEAVE_ERROR_BUFFER_TOO_SMALL
Gdy przekraczamy bufor.

writeByte

WEAVE_ERROR writeByte(
  uint8_t
)

Szczegóły
Parametry
aValue
Wartość w bajtach do zapisania.
Zwracane wartości
WEAVE_NO_ERROR
Jeśli wszystko jest w porządku.
WEAVE_ERROR_BUFFER_TOO_SMALL
Gdy przekraczamy bufor.

writeBytes

WEAVE_ERROR writeBytes(
  uint16_t,
  uint8_t *
)

Szczegóły
Parametry
aLength
Długość ciągu bajtów do zapisu.
aString
Sam ciąg bajtów.
Zwracane wartości
WEAVE_NO_ERROR
Jeśli wszystko jest w porządku.
WEAVE_ERROR_BUFFER_TOO_SMALL
Gdy przekraczamy bufor.

writeString

WEAVE_ERROR writeString(
  uint16_t,
  char *
)

Szczegóły
Parametry
aLength
Długość ciągu znaków do zapisania.
aString
sam ciąg znaków.
Zwracane wartości
WEAVE_NO_ERROR
Jeśli wszystko jest w porządku.
WEAVE_ERROR_BUFFER_TOO_SMALL
Gdy przekraczamy bufor.