nl:: بافت:: پروفایل ها:: 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 *)

صفات عمومی

نکته

uint8_t * thePoint

توابع عمومی

MessageIterator

 MessageIterator(
  System::PacketBuffer *
)

روش سازنده

جزئیات
مولفه های
aBuffer
یک بافر پیام برای تکرار.

ضمیمه

void append(
  void
)

نقطه را روی بعد از هر داده ای که در حال حاضر در بافر است تنظیم کنید.

پایان نوشتن

void finishWriting(
  void
)

پس از نوشتن بافر را تنظیم کنید.

hasData

bool hasData(
  uint16_t
)

جزئیات
مولفه های
inc
مقدار صحیحی که ممکن است از بافر خوانده شود.
ارزش های بازگشتی
true
طول داده فعلی بافر بزرگتر یا مساوی با افزایش داده شده است.
false
در غیر این صورت.

دارای اتاق

bool hasRoom(
  uint16_t
)

جزئیات
مولفه های
inc
یک مقدار صحیح که ممکن است در بافر نوشته شود.
ارزش های بازگشتی
true
تفاوت بین طول داده فعلی بافر و حداکثر طول داده مجاز آن، (طول داده موجود آن)، کمتر یا مساوی با افزایش داده شده است.
false
در غیر این صورت.

اپراتور!=

bool operator!=(
  const MessageIterator &
)

جزئیات
مولفه های
aMessageIterator
یکی دیگر از تکرارکننده پیام برای مقایسه.

اپراتور*

uint8_t & operator*(
  void
)

جزئیات
برمی گرداند
چیزی که ما در بافر به آن نگاه می کنیم.

operator+

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
اگر از انتهای بافر عبور کنیم.

writeString

WEAVE_ERROR writeString(
  uint16_t,
  char *
)

جزئیات
مولفه های
aLength
طول رشته برای نوشتن
aString
خود رشته.
ارزش های بازگشتی
WEAVE_NO_ERROR
اگر همه چیز اوکی است.
WEAVE_ERROR_BUFFER_TOO_SMALL
اگر از انتهای بافر عبور کنیم.