nl::Weave::Profiles::MessageIterator

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

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

סיכום

ירושה

עובר בירושה מ: 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
אחרת.

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