ไม่มี:: สาน:: โปรไฟล์:: MessageIterator

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

เพื่อที่จะใช้บัฟเฟอร์ข้อความอย่างสมเหตุสมผล เรากำหนดตัววนซ้ำนี้ ซึ่งสามารถใช้เพื่อติดตามขอบเขตและอื่นๆ

สรุป

มรดก

สืบทอดจาก: NL :: สาน :: โปรไฟล์ :: 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
)

ตั้งค่าให้ชี้ไปที่หลังข้อมูลใด ๆ ที่อยู่ในบัฟเฟอร์

จบการเขียน

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 หากมีที่ว่าง

โอเปอเรเตอร์-

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
ถ้าเราวิ่งผ่านจุดสิ้นสุดของบัฟเฟอร์

read32

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
ถ้าเราวิ่งผ่านจุดสิ้นสุดของบัฟเฟอร์

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
ถ้าเราวิ่งผ่านจุดสิ้นสุดของบัฟเฟอร์

เขียนสตริง

WEAVE_ERROR writeString(
  uint16_t,
  char *
)

รายละเอียด
พารามิเตอร์
aLength
ความยาวของสตริงที่จะเขียน
aString
สตริงนั้นเอง
ส่งกลับค่า
WEAVE_NO_ERROR
ถ้าทุกอย่างโอเค
WEAVE_ERROR_BUFFER_TOO_SMALL
ถ้าเราวิ่งผ่านจุดสิ้นสุดของบัฟเฟอร์