تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

nl :: نسج:: مظهر:: مُبدِّل الرسالة

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

من أجل استخدام المخازن المؤقتة للرسائل بشكل معقول ، نحدد هذا المكرر ، والذي يمكن استخدامه لتتبع الحدود وما إلى ذلك.

ملخص

ميراث

يرث من: NL :: :: نسج الملامح :: 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 *)

السمات العامة

النقطة

uint8_t * thePoint

الوظائف العامة

مُبدِّل الرسالة

 MessageIterator(
  System::PacketBuffer *
)

طريقة المنشئ.

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

ألحق

void append(
  void
)

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

إنهاء الكتابة

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

المشغل أو العامل-

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

readString

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