nl::Weave::Profiles::MessageIterator

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

Mesaj tamponlarını makul bir şekilde kullanmak için sınırları ve benzeri öğeleri izlemek için kullanılabilen bu iterasyonu tanımlarız.

Özet

Devralma

Devralır: nl::Weave::Profiles::RetainedPacketBuffer

Oluşturucular ve Yıkıcılar

MessageIterator(System::PacketBuffer *)
Oluşturucu yöntemi.

Herkese açık özellikler

thePoint
uint8_t *

Kamu işlevleri

append(void)
void
Noktayı, arabellekte mevcut olan herhangi bir veriden sonra olacak şekilde ayarlayın.
finishWriting(void)
void
Yazdıktan sonra arabelleği ayarlayın.
hasData(uint16_t)
bool
hasRoom(uint16_t)
bool
operator!=(const MessageIterator &)
bool
operator*(void)
uint8_t &
operator+(uint16_t)
operator++(void)
Yer varsa mesaj yineleyicisini 1 kat artırın.
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 *)

Herkese açık özellikler

thePoint

uint8_t * thePoint

Kamu işlevleri

MessageIterator

 MessageIterator(
  System::PacketBuffer *
)

Oluşturucu yöntemi.

Ayrıntılar
Parametreler
aBuffer
Yinelenecek bir mesaj tamponu.

append

void append(
  void
)

Noktayı, arabellekte mevcut olan herhangi bir veriden sonra olacak şekilde ayarlayın.

finishWriting

void finishWriting(
  void
)

Yazdıktan sonra arabelleği ayarlayın.

hasData

bool hasData(
  uint16_t
)

Ayrıntılar
Parametreler
inc
Arabelleğe okunabilen tam sayı miktarı.
Döndürülen Değerler
true
Arabelleğin geçerli veri uzunluğu belirtilen artımdan büyük veya buna eşit.
false
Aksi takdirde.

hasRoom

bool hasRoom(
  uint16_t
)

Ayrıntılar
Parametreler
inc
Arabelleğe yazılabilecek bir tam sayı miktarıdır.
Döndürülen Değerler
true
Arabelleğin geçerli veri uzunluğu ile izin verilen maksimum veri uzunluğu (mevcut veri uzunluğu) arasındaki fark, belirtilen artıma eşit veya bundan daha küçük.
false
Aksi takdirde.

operatör!=

bool operator!=(
  const MessageIterator &
)

Ayrıntılar
Parametreler
aMessageIterator
Karşılaştırılacak başka bir mesaj yineleme aracı.

operatör*

uint8_t & operator*(
  void
)

Ayrıntılar
İadeler
Tamponda gördüklerimiz.

operatör+

MessageIterator & operator+(
  uint16_t
)

Ayrıntılar
Parametreler
inc
Mesaj yineleyiciye uygulanacak bir artımdır.
İadeler
Yineleme, varsa verilen değer kadar artar veya yoksa sona doğru çarpar.

operatör++

MessageIterator & operator++(
  void
)

Yer varsa mesaj yineleyicisini 1 kat artırın.

operator-

MessageIterator & operator-(
  uint16_t
)

Ayrıntılar
Parametreler
dec
Mesaj yineleyiciye uygulanacak bir azalmadır.
İadeler
Yineleme, yer varsa verilen değere göre azalır, yoksa başa batabilir.

operatör==

bool operator==(
  const MessageIterator &
)

Ayrıntılar
Parametreler
aMessageIterator
Karşılaştırılacak başka bir mesaj yineleme aracı.

read16

WEAVE_ERROR read16(
  uint16_t *
)

Ayrıntılar
Parametreler
aDestination
Arabelleğin üzerinden kısa bir ses kaydı çıkarabileceğiniz bir yer.
Döndürülen Değerler
WEAVE_NO_ERROR
Herhangi bir sorun yoksa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Bu tampon süresi bitmiştir.

read32

WEAVE_ERROR read32(
  uint32_t *
)

Ayrıntılar
Parametreler
aDestination
Arabelleğe alınan 32 bitlik değerin okunacağı bir yer.
Döndürülen Değerler
WEAVE_NO_ERROR
Herhangi bir sorun yoksa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Bu tampon süresi bitmiştir.

read64

WEAVE_ERROR read64(
  uint64_t *
)

Ayrıntılar
Parametreler
aDestination
64 bitlik değerin arabellekten okunacağı bir yer.
Döndürülen Değerler
WEAVE_NO_ERROR
Herhangi bir sorun yoksa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Bu tampon süresi bitmiştir.

readByte

WEAVE_ERROR readByte(
  uint8_t *
)

Ayrıntılar
Parametreler
aDestination
Arabelleğin bayt olarak okunduğu bir yer.
Döndürülen Değerler
WEAVE_NO_ERROR
Herhangi bir sorun yoksa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Bu tampon süresi bitmiştir.

readBytes

WEAVE_ERROR readBytes(
  uint16_t,
  uint8_t *
)

Ayrıntılar
Parametreler
aLength
Okunacak bayt dizesinin uzunluğu.
aByteString
Baytların yerleştirileceği bir yer.
Döndürülen Değerler
WEAVE_NO_ERROR
Herhangi bir sorun yoksa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Bu tampon süresi bitmiştir.

readString

WEAVE_ERROR readString(
  uint16_t,
  char *
)

Ayrıntılar
Parametreler
aLength
Okunacak dizenin uzunluğu.
aString
Dizenin yerleştirileceği bir yer.
Döndürülen Değerler
WEAVE_NO_ERROR
Herhangi bir sorun yoksa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Bu tampon süresi bitmiştir.

write16

WEAVE_ERROR write16(
  uint16_t
)

Ayrıntılar
Parametreler
aValue
Yazılması gereken kısa bir değer.
Döndürülen Değerler
WEAVE_NO_ERROR
Herhangi bir sorun yoksa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Bu tampon süresi bitmiştir.

write32

WEAVE_ERROR write32(
  uint32_t
)

Ayrıntılar
Parametreler
aValue
Yazılacak 32 bitlik bir değer.
Döndürülen Değerler
WEAVE_NO_ERROR
Herhangi bir sorun yoksa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Bu tampon süresi bitmiştir.

write64

WEAVE_ERROR write64(
  uint64_t
)

Ayrıntılar
Parametreler
aValue
Yazılacak 64 bitlik bir değer.
Döndürülen Değerler
WEAVE_NO_ERROR
Herhangi bir sorun yoksa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Bu tampon süresi bitmiştir.

writeByte

WEAVE_ERROR writeByte(
  uint8_t
)

Ayrıntılar
Parametreler
aValue
Yazılacak bayt değeri.
Döndürülen Değerler
WEAVE_NO_ERROR
Herhangi bir sorun yoksa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Bu tampon süresi bitmiştir.

writeBytes

WEAVE_ERROR writeBytes(
  uint16_t,
  uint8_t *
)

Ayrıntılar
Parametreler
aLength
Yazılacak bayt dizesinin uzunluğu.
aString
Bayt dizesinin kendisi.
Döndürülen Değerler
WEAVE_NO_ERROR
Herhangi bir sorun yoksa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Bu tampon süresi bitmiştir.

writeString

WEAVE_ERROR writeString(
  uint16_t,
  char *
)

Ayrıntılar
Parametreler
aLength
Yazılacak dizenin uzunluğu.
aString
Dizenin kendisi.
Döndürülen Değerler
WEAVE_NO_ERROR
Herhangi bir sorun yoksa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Bu tampon süresi bitmiştir.