nl::Weave::Profiles::MessageIterator

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

Untuk menggunakan buffering pesan secara wajar, kami menentukan iterator ini, yang dapat digunakan untuk melacak batas dan sebagainya.

Ringkasan

Inheritance

Mewarisi dari: nl::Weave::Profiles::RetainedPacketBuffer

Konstruktor dan Destruktor
MessageIterator(System::PacketBuffer *)
Metode konstruktor.

Atribut publik
thePoint
uint8_t *

Fungsi publik
append(void)
void
Tetapkan titik ke setelah data apa pun saat ini berada dalam buffering.
finishWriting(void)
void
Sesuaikan buffering setelah penulisan.
hasData(uint16_t)
bool
hasRoom(uint16_t)
bool
operator!=(const MessageIterator &)
bool
operator*(void)
uint8_t &
operator+(uint16_t)
operator++(void)
Menambahkan iterator pesan sebesar 1 jika ada ruang.
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 *)

Atribut publik

thePoint

uint8_t * thePoint

Fungsi publik

MessageIterator

 MessageIterator(
  System::PacketBuffer *
)

Metode konstruktor.

Detail
Parameter
aBuffer
Buffering pesan yang akan diiterasi.

append

void append(
  void
)

Tetapkan titik ke setelah data apa pun saat ini berada dalam buffering.

finishWriting

void finishWriting(
  void
)

Sesuaikan buffering setelah penulisan.

hasData

bool hasData(
  uint16_t
)

Detail
Parameter
inc
Jumlah bilangan bulat yang dapat dibaca dari buffer.
Nilai Pengembalian
true
Panjang data buffer saat ini lebih besar dari atau sama dengan pertambahan yang diberikan.
false
Sebaliknya.

hasRoom

bool hasRoom(
  uint16_t
)

Detail
Parameter
inc
Jumlah bilangan bulat yang mungkin ditulis ke buffer.
Nilai Pengembalian
true
Perbedaan antara panjang data buffer saat ini dan panjang data maksimum yang diizinkan, (panjang data yang tersedia), kurang dari atau sama dengan pertambahan tertentu.
false
Sebaliknya.

operator!=

bool operator!=(
  const MessageIterator &
)

Detail
Parameter
aMessageIterator
Iterator pesan lain untuk dibandingkan.

operator*

uint8_t & operator*(
  void
)

Detail
Hasil
Apa yang kita lihat di {i>buffer<i}.

operator+

MessageIterator & operator+(
  uint16_t
)

Detail
Parameter
inc
Kenaikan yang akan diterapkan ke iterator pesan.
Hasil
Iterator bertambah dengan nilai yang diberikan jika ada ruang, atau langsung membanting ke ujung jika tidak ada.

operator++

MessageIterator & operator++(
  void
)

Menambahkan iterator pesan sebesar 1 jika ada ruang.

operator-

MessageIterator & operator-(
  uint16_t
)

Detail
Parameter
dec
Pengurangan yang akan diterapkan ke iterator pesan.
Hasil
Iterator berkurang menurut nilai yang diberikan jika ada ruang, atau langsung membanting ke awal jika tidak ada.

operator==

bool operator==(
  const MessageIterator &
)

Detail
Parameter
aMessageIterator
Iterator pesan lain untuk dibandingkan.

read16

WEAVE_ERROR read16(
  uint16_t *
)

Detail
Parameter
aDestination
Tempat untuk meletakkan pembacaan singkat dari buffer.
Nilai Pengembalian
WEAVE_NO_ERROR
Jika semuanya oke.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika kita melewati akhir {i>buffer<i}.

read32

WEAVE_ERROR read32(
  uint32_t *
)

Detail
Parameter
aDestination
Tempat untuk meletakkan nilai 32-bit membaca buffer.
Nilai Pengembalian
WEAVE_NO_ERROR
Jika semuanya oke.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika kita melewati akhir {i>buffer<i}.

read64

WEAVE_ERROR read64(
  uint64_t *
)

Detail
Parameter
aDestination
Tempat untuk meletakkan nilai 64-bit yang membaca buffer.
Nilai Pengembalian
WEAVE_NO_ERROR
Jika semuanya oke.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika kita melewati akhir {i>buffer<i}.

readByte

WEAVE_ERROR readByte(
  uint8_t *
)

Detail
Parameter
aDestination
Tempat untuk menempatkan byte yang dibaca dari buffer.
Nilai Pengembalian
WEAVE_NO_ERROR
Jika semuanya oke.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika kita melewati akhir {i>buffer<i}.

readBytes

WEAVE_ERROR readBytes(
  uint16_t,
  uint8_t *
)

Detail
Parameter
aLength
Panjang string byte yang akan dibaca.
aByteString
Tempat untuk menempatkan byte.
Nilai Pengembalian
WEAVE_NO_ERROR
Jika semuanya oke.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika kita melewati akhir {i>buffer<i}.

readString

WEAVE_ERROR readString(
  uint16_t,
  char *
)

Detail
Parameter
aLength
Panjang string yang akan dibaca.
aString
Tempat untuk menempatkan string.
Nilai Pengembalian
WEAVE_NO_ERROR
Jika semuanya oke.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika kita melewati akhir {i>buffer<i}.

write16

WEAVE_ERROR write16(
  uint16_t
)

Detail
Parameter
aValue
Nilai singkat yang harus ditulis.
Nilai Pengembalian
WEAVE_NO_ERROR
Jika semuanya oke.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika kita melewati akhir {i>buffer<i}.

write32

WEAVE_ERROR write32(
  uint32_t
)

Detail
Parameter
aValue
Nilai 32-bit yang akan ditulis.
Nilai Pengembalian
WEAVE_NO_ERROR
Jika semuanya oke.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika kita melewati akhir {i>buffer<i}.

write64

WEAVE_ERROR write64(
  uint64_t
)

Detail
Parameter
aValue
Nilai 64-bit yang akan ditulis.
Nilai Pengembalian
WEAVE_NO_ERROR
Jika semuanya oke.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika kita melewati akhir {i>buffer<i}.

writeByte

WEAVE_ERROR writeByte(
  uint8_t
)

Detail
Parameter
aValue
Nilai byte yang akan ditulis.
Nilai Pengembalian
WEAVE_NO_ERROR
Jika semuanya oke.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika kita melewati akhir {i>buffer<i}.

writeBytes

WEAVE_ERROR writeBytes(
  uint16_t,
  uint8_t *
)

Detail
Parameter
aLength
Panjang string byte yang akan ditulis.
aString
String byte itu sendiri.
Nilai Pengembalian
WEAVE_NO_ERROR
Jika semuanya oke.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika kita melewati akhir {i>buffer<i}.

writeString

WEAVE_ERROR writeString(
  uint16_t,
  char *
)

Detail
Parameter
aLength
Panjang {i>string<i} yang akan ditulis.
aString
String itu sendiri.
Nilai Pengembalian
WEAVE_NO_ERROR
Jika semuanya oke.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika kita melewati akhir {i>buffer<i}.