nl::Weave::Profiles::MessageIterator

#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

 MessageIterator(
  System::PacketBuffer *
)

طريقة الدالة الإنشائية.

التفاصيل
المعلمات
aBuffer
مخزن مؤقت للرسائل لتكرارها.

إضافة

void append(
  void
)

قم بتعيين النقطة إلى بعد أي بيانات موجودة حاليًا في المخزن المؤقت.

finishWriting

void finishWriting(
  void
)

اضبط المخزن المؤقت بعد الكتابة.

hasData

bool hasData(
  uint16_t
)

التفاصيل
المعلمات
inc
عدد صحيح يمكن قراءته من المخزن المؤقت.
قيم الإرجاع
true
طول البيانات الحالي للمخزن المؤقت أكبر من أو مساوٍ للزيادة المحددة.
false
بخلاف ذلك.

hasRoom

bool hasRoom(
  uint16_t
)

التفاصيل
المعلمات
inc
عدد صحيح يمكن كتابته في المخزن المؤقت.
قيم الإرجاع
true
الفرق بين طول البيانات الحالي للمخزن المؤقت وأقصى طول بيانات مسموح به (طول البيانات المتاحة) أقل من أو يساوي الزيادة المحددة.
false
بخلاف ذلك.

operator!=

bool operator!=(
  const MessageIterator &
)

التفاصيل
المعلمات
aMessageIterator
هناك مكرّر رسالة آخر يمكن المقارنة به.

العامل*

uint8_t & operator*(
  void
)

التفاصيل
المرتجعات
ما ننظر إليه في المورد الاحتياطي.

عامل تشغيل+

MessageIterator & operator+(
  uint16_t
)

التفاصيل
المعلمات
inc
جزء يتم تطبيقه على مكرّر الرسالة
المرتجعات
تتم زيادة المكرر بالقيمة المحددة إذا كان هناك متسع، وإلا يتم الضغط على النهاية إذا لم يكن هناك متسع.

عامل تشغيل++

MessageIterator & operator++(
  void
)

يمكنك زيادة مكرّر الرسالة بمقدار 1 في حال توفّر مساحة.

operator-

MessageIterator & operator-(
  uint16_t
)

التفاصيل
المعلمات
dec
اختصار يتم تطبيقه على مكرّر الرسالة
المرتجعات
يتم إنقاص المكرر بالقيمة المحددة إذا كان هناك متسع، أو انتقاله إلى البداية إذا لم يكن هناك متسع.

عامل التشغيل==

bool operator==(
  const MessageIterator &
)

التفاصيل
المعلمات
aMessageIterator
هناك مكرّر رسالة آخر يمكن المقارنة به.

read16

WEAVE_ERROR read16(
  uint16_t *
)

التفاصيل
المعلمات
aDestination
مكان لوضع قراءة قصيرة من المورد الاحتياطي.
قيم الإرجاع
WEAVE_NO_ERROR
إذا كان كل شيء على ما يرام.
WEAVE_ERROR_BUFFER_TOO_SMALL
إذا تجاوزنا نهاية المخزن المؤقت.

read32

WEAVE_ERROR read32(
  uint32_t *
)

التفاصيل
المعلمات
aDestination
مكان يمكن فيه قراءة قيمة 32 بت من المخزن المؤقت
قيم الإرجاع
WEAVE_NO_ERROR
إذا كان كل شيء على ما يرام.
WEAVE_ERROR_BUFFER_TOO_SMALL
إذا تجاوزنا نهاية المخزن المؤقت.

read64

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
إذا تجاوزنا نهاية المخزن المؤقت.

readString

WEAVE_ERROR readString(
  uint16_t,
  char *
)

التفاصيل
المعلمات
aLength
طول السلسلة المطلوب قراءتها.
aString
مكان لوضع السلسلة.
قيم الإرجاع
WEAVE_NO_ERROR
إذا كان كل شيء على ما يرام.
WEAVE_ERROR_BUFFER_TOO_SMALL
إذا تجاوزنا نهاية المخزن المؤقت.

write16

WEAVE_ERROR write16(
  uint16_t
)

التفاصيل
المعلمات
aValue
قيمة قصيرة يجب كتابتها.
قيم الإرجاع
WEAVE_NO_ERROR
إذا كان كل شيء على ما يرام.
WEAVE_ERROR_BUFFER_TOO_SMALL
إذا تجاوزنا نهاية المخزن المؤقت.

write32

WEAVE_ERROR write32(
  uint32_t
)

التفاصيل
المعلمات
aValue
قيمة 32 بت لكتابتها.
قيم الإرجاع
WEAVE_NO_ERROR
إذا كان كل شيء على ما يرام.
WEAVE_ERROR_BUFFER_TOO_SMALL
إذا تجاوزنا نهاية المخزن المؤقت.

write64

WEAVE_ERROR write64(
  uint64_t
)

التفاصيل
المعلمات
aValue
قيمة 64 بت لتدوينها.
قيم الإرجاع
WEAVE_NO_ERROR
إذا كان كل شيء على ما يرام.
WEAVE_ERROR_BUFFER_TOO_SMALL
إذا تجاوزنا نهاية المخزن المؤقت.

writeByte

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
إذا تجاوزنا نهاية المخزن المؤقت.

writeString

WEAVE_ERROR writeString(
  uint16_t,
  char *
)

التفاصيل
المعلمات
aLength
طول السلسلة المطلوب كتابتها.
aString
السلسلة نفسها.
قيم الإرجاع
WEAVE_NO_ERROR
إذا كان كل شيء على ما يرام.
WEAVE_ERROR_BUFFER_TOO_SMALL
إذا تجاوزنا نهاية المخزن المؤقت.