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
مخزن احتياطي للرسائل للتكرار.

append

void append(
  void
)

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

finishWriting

void finishWriting(
  void
)

ضبط المورد الاحتياطي بعد الكتابة

hasData

bool hasData(
  uint16_t
)

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

hasRoom

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 إذا كان هناك متسع.

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
إذا تجاوزنا نهاية المورد الاحتياطي.