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
บัฟเฟอร์ข้อความที่ต้องทำซ้ำ

ต่อท้าย

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
หากเรียกใช้จนเกินจุดสิ้นสุดของบัฟเฟอร์