nl::Weave::Profiles::MessageIterator

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

כדי להשתמש בצורה חכמה במאגרי הודעות, אנחנו מגדירים את האיטרטור הזה, שיכול לשמש למעקב אחרי גבולות וכן הלאה.

סיכום

ירושה

Inherits from: nl::Weave::Profiles::RetainedPacketBuffer

בונים והורסים

MessageIterator(System::PacketBuffer *)
השיטה של ה-constructor.

מאפיינים ציבוריים

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 *
)

השיטה של ה-constructor.

פרטים
פרמטרים
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
אם אנחנו עוברים את סוף מאגר הנתונים הזמני.