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
หากเราแสดงค่าเกินจุดสิ้นสุดของบัฟเฟอร์