нл:: Переплетение:: Профили:: Итератор сообщения

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

Чтобы разумно использовать буферы сообщений, мы определяем этот итератор, который можно использовать для отслеживания границ и т. д.

Краткое содержание

Наследование

Наследуется от: nl::Weave::Profiles::RetainedPacketBuffer

Конструкторы и деструкторы

MessageIterator ( System::PacketBuffer *)
Метод конструктора.

Публичные атрибуты

thePoint
uint8_t *

Общественные функции

append (void)
void
Установите точку после любых данных, находящихся в данный момент в буфере.
finishWriting (void)
void
Настройте буфер после записи.
hasData (uint16_t)
bool
hasRoom (uint16_t)
bool
operator!= (const MessageIterator &)
bool
operator* (void)
uint8_t &
operator+ (uint16_t)
operator++ (void)
Увеличьте итератор сообщения на 1, если есть место.
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 *)

Публичные атрибуты

thePoint 

uint8_t * thePoint

Общественные функции

Итератор сообщения

 MessageIterator(
  System::PacketBuffer *
)

Метод конструктора.

Подробности
Параметры
aBuffer
Буфер сообщений для перебора.

добавить

void append(
  void
)

Установите точку после любых данных, находящихся в данный момент в буфере.

закончитьНаписание

void finishWriting(
  void
)

Настройте буфер после записи.

имеет данные 

bool hasData(
  uint16_t
)

Подробности
Параметры
inc
Целочисленная сумма, которую можно прочитать из буфера.
Возвращаемые значения
true
Текущая длина данных в буфере больше или равна заданному приращению.
false
В противном случае.

имеет комнату 

bool hasRoom(
  uint16_t
)

Подробности
Параметры
inc
Целое число, которое может быть записано в буфер.
Возвращаемые значения
true
Разница между текущей длиной данных буфера и его максимально допустимой длиной данных (его доступной длиной данных) меньше или равна заданному приращению.
false
В противном случае.

оператор!= 

bool operator!=(
  const MessageIterator &
)

Подробности
Параметры
aMessageIterator
Еще один итератор сообщений для сравнения.

оператор* 

uint8_t & operator*(
  void
)

Подробности
Возврат
То, что мы видим в буфере.

оператор+ 

MessageIterator & operator+(
  uint16_t
)

Подробности
Параметры
inc
Приращение, применяемое к итератору сообщения.
Возврат
Итератор увеличивается на заданное значение, если есть место, или прижимается к концу, если его нет.

оператор++

MessageIterator & operator++(
  void
)

Увеличьте итератор сообщения на 1, если есть место.

оператор- 

MessageIterator & operator-(
  uint16_t
)

Подробности
Параметры
dec
Уменьшение, применяемое к итератору сообщения.
Возврат
Итератор уменьшается на заданное значение, если есть место, или врезается в начало, если его нет.

оператор== 

bool operator==(
  const MessageIterator &
)

Подробности
Параметры
aMessageIterator
Еще один итератор сообщений для сравнения.

читать16 

WEAVE_ERROR read16(
  uint16_t *
)

Подробности
Параметры
aDestination
Место для короткого чтения из буфера.
Возвращаемые значения
WEAVE_NO_ERROR
Если все в порядке.
WEAVE_ERROR_BUFFER_TOO_SMALL
Если мы пробегаем конец буфера.

читать32 

WEAVE_ERROR read32(
  uint32_t *
)

Подробности
Параметры
aDestination
Место для помещения 32-битного значения, считанного из буфера.
Возвращаемые значения
WEAVE_NO_ERROR
Если все в порядке.
WEAVE_ERROR_BUFFER_TOO_SMALL
Если мы пробегаем конец буфера.

читать64 

WEAVE_ERROR read64(
  uint64_t *
)

Подробности
Параметры
aDestination
Место для помещения 64-битного значения, считанного из буфера.
Возвращаемые значения
WEAVE_NO_ERROR
Если все в порядке.
WEAVE_ERROR_BUFFER_TOO_SMALL
Если мы пробегаем конец буфера.

readByte 

WEAVE_ERROR readByte(
  uint8_t *
)

Подробности
Параметры
aDestination
Место для размещения байта, прочитанного из буфера.
Возвращаемые значения
WEAVE_NO_ERROR
Если все в порядке.
WEAVE_ERROR_BUFFER_TOO_SMALL
Если мы пробегаем конец буфера.

readBytes 

WEAVE_ERROR readBytes(
  uint16_t,
  uint8_t *
)

Подробности
Параметры
aLength
Длина строки байтов, которую необходимо прочитать.
aByteString
Место для размещения байтов.
Возвращаемые значения
WEAVE_NO_ERROR
Если все в порядке.
WEAVE_ERROR_BUFFER_TOO_SMALL
Если мы пробегаем конец буфера.

читатьстроку 

WEAVE_ERROR readString(
  uint16_t,
  char *
)

Подробности
Параметры
aLength
Длина строки, которую нужно прочитать.
aString
Место для размещения веревки.
Возвращаемые значения
WEAVE_NO_ERROR
Если все в порядке.
WEAVE_ERROR_BUFFER_TOO_SMALL
Если мы проходим за конец буфера.

написать16 

WEAVE_ERROR write16(
  uint16_t
)

Подробности
Параметры
aValue
Короткое значение для записи.
Возвращаемые значения
WEAVE_NO_ERROR
Если все в порядке.
WEAVE_ERROR_BUFFER_TOO_SMALL
Если мы пробегаем конец буфера.

написать32 

WEAVE_ERROR write32(
  uint32_t
)

Подробности
Параметры
aValue
32-битное значение для записи.
Возвращаемые значения
WEAVE_NO_ERROR
Если все в порядке.
WEAVE_ERROR_BUFFER_TOO_SMALL
Если мы проходим за конец буфера.

написать64 

WEAVE_ERROR write64(
  uint64_t
)

Подробности
Параметры
aValue
64-битное значение для записи.
Возвращаемые значения
WEAVE_NO_ERROR
Если все в порядке.
WEAVE_ERROR_BUFFER_TOO_SMALL
Если мы проходим за конец буфера.

записьбайт 

WEAVE_ERROR writeByte(
  uint8_t
)

Подробности
Параметры
aValue
Байтовое значение для записи.
Возвращаемые значения
WEAVE_NO_ERROR
Если все в порядке.
WEAVE_ERROR_BUFFER_TOO_SMALL
Если мы проходим за конец буфера.

writeBytes 

WEAVE_ERROR writeBytes(
  uint16_t,
  uint8_t *
)

Подробности
Параметры
aLength
Длина строки байтов для записи.
aString
Сама байтовая строка.
Возвращаемые значения
WEAVE_NO_ERROR
Если все в порядке.
WEAVE_ERROR_BUFFER_TOO_SMALL
Если мы проходим за конец буфера.

записьстрока 

WEAVE_ERROR writeString(
  uint16_t,
  char *
)

Подробности
Параметры
aLength
Длина строки для записи.
aString
Сама строка.
Возвращаемые значения
WEAVE_NO_ERROR
Если все в порядке.
WEAVE_ERROR_BUFFER_TOO_SMALL
Если мы проходим за конец буфера.