nl::Weave::Profiles::MessageIterator

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

Để sử dụng vùng đệm thông báo một cách hợp lý, chúng ta xác định biến lặp này (có thể dùng để theo dõi các ranh giới, v.v.).

Tóm tắt

Tính kế thừa

Kế thừa từ: nl::Weave::Profiles::RetainedPacketBuffer

Hàm khởi tạo và phá huỷ
MessageIterator(System::PacketBuffer *)
Phương thức hàm khởi tạo.

Các thuộc tính công khai
thePoint
uint8_t *

Hàm công khai
append(void)
void
Đặt điểm này thành sau mọi dữ liệu hiện có trong vùng đệm.
finishWriting(void)
void
Điều chỉnh vùng đệm sau khi ghi.
hasData(uint16_t)
bool
hasRoom(uint16_t)
bool
operator!=(const MessageIterator &)
bool
operator*(void)
uint8_t &
operator+(uint16_t)
operator++(void)
Tăng số lặp lại tin nhắn lên 1 nếu vẫn còn chỗ.
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 *)

Các thuộc tính công khai

thePoint

uint8_t * thePoint

Hàm công khai

MessageIterator

 MessageIterator(
  System::PacketBuffer *
)

Phương thức hàm khởi tạo.

Thông tin chi tiết
Tham số
aBuffer
Vùng đệm thông báo để lặp lại.

thêm

void append(
  void
)

Đặt điểm này thành sau mọi dữ liệu hiện có trong vùng đệm.

finishWriting

void finishWriting(
  void
)

Điều chỉnh vùng đệm sau khi ghi.

hasData

bool hasData(
  uint16_t
)

Thông tin chi tiết
Tham số
inc
Số nguyên có thể được đọc từ vùng đệm.
Giá trị trả về
true
Độ dài dữ liệu hiện tại của vùng đệm lớn hơn hoặc bằng gia số đã cho.
false
Nếu không.

hasRoom

bool hasRoom(
  uint16_t
)

Thông tin chi tiết
Tham số
inc
Số lượng số nguyên có thể được ghi vào vùng đệm.
Giá trị trả về
true
Chênh lệch giữa độ dài dữ liệu hiện tại của vùng đệm và độ dài dữ liệu tối đa cho phép của vùng đệm (độ dài dữ liệu có sẵn) nhỏ hơn hoặc bằng gia số đã cho.
false
Nếu không.

operator!=

bool operator!=(
  const MessageIterator &
)

Thông tin chi tiết
Tham số
aMessageIterator
Một biến lặp thông điệp khác để so sánh.

toán tử*

uint8_t & operator*(
  void
)

Thông tin chi tiết
Trả về
Những gì chúng ta đang xem trong vùng đệm.

toán tử+

MessageIterator & operator+(
  uint16_t
)

Thông tin chi tiết
Tham số
inc
Giá trị tăng để áp dụng cho trình lặp thông báo.
Trả về
Trình lặp sẽ tăng lên theo giá trị đã cho nếu có chỗ hoặc sẽ tự đổ vào cuối nếu không có chỗ.

toán tử++

MessageIterator & operator++(
  void
)

Tăng số lặp lại tin nhắn lên 1 nếu vẫn còn chỗ.

operator-

MessageIterator & operator-(
  uint16_t
)

Thông tin chi tiết
Tham số
dec
Mức giảm để áp dụng cho trình lặp thông báo.
Trả về
Trình lặp lại bị giảm theo giá trị đã cho nếu vẫn còn chỗ, hoặc sẽ lao ngay vào phần đầu nếu không có.

toán tử==

bool operator==(
  const MessageIterator &
)

Thông tin chi tiết
Tham số
aMessageIterator
Một biến lặp thông điệp khác để so sánh.

read16

WEAVE_ERROR read16(
  uint16_t *
)

Thông tin chi tiết
Tham số
aDestination
Một nơi để đọc một đoạn ngắn cho vùng đệm.
Giá trị trả về
WEAVE_NO_ERROR
Nếu mọi thứ đều ổn.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu chúng ta đang chạy qua hết vùng đệm.

read32

WEAVE_ERROR read32(
  uint32_t *
)

Thông tin chi tiết
Tham số
aDestination
Nơi để đặt giá trị 32 bit đọc ra bộ đệm.
Giá trị trả về
WEAVE_NO_ERROR
Nếu mọi thứ đều ổn.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu chúng ta đang chạy qua hết vùng đệm.

read64

WEAVE_ERROR read64(
  uint64_t *
)

Thông tin chi tiết
Tham số
aDestination
Nơi để đặt giá trị 64 bit đọc ra vùng đệm.
Giá trị trả về
WEAVE_NO_ERROR
Nếu mọi thứ đều ổn.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu chúng ta đang chạy qua hết vùng đệm.

readByte

WEAVE_ERROR readByte(
  uint8_t *
)

Thông tin chi tiết
Tham số
aDestination
Nơi để đặt một byte được đọc ra khỏi vùng đệm.
Giá trị trả về
WEAVE_NO_ERROR
Nếu mọi thứ đều ổn.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu chúng ta đang chạy qua hết vùng đệm.

readBytes

WEAVE_ERROR readBytes(
  uint16_t,
  uint8_t *
)

Thông tin chi tiết
Tham số
aLength
Độ dài của chuỗi byte cần đọc.
aByteString
Một nơi để đặt các byte.
Giá trị trả về
WEAVE_NO_ERROR
Nếu mọi thứ đều ổn.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu chúng ta đang chạy qua hết vùng đệm.

readString

WEAVE_ERROR readString(
  uint16_t,
  char *
)

Thông tin chi tiết
Tham số
aLength
Độ dài của chuỗi cần đọc.
aString
Nơi để đặt chuỗi.
Giá trị trả về
WEAVE_NO_ERROR
Nếu mọi thứ đều ổn.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu chúng ta đang chạy qua cuối vùng đệm.

write16

WEAVE_ERROR write16(
  uint16_t
)

Thông tin chi tiết
Tham số
aValue
Một giá trị ngắn để ghi ra.
Giá trị trả về
WEAVE_NO_ERROR
Nếu mọi thứ đều ổn.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu chúng ta đang chạy qua hết vùng đệm.

write32

WEAVE_ERROR write32(
  uint32_t
)

Thông tin chi tiết
Tham số
aValue
Một giá trị 32 bit cần ghi.
Giá trị trả về
WEAVE_NO_ERROR
Nếu mọi thứ đều ổn.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu chúng ta đang chạy qua hết vùng đệm.

write64

WEAVE_ERROR write64(
  uint64_t
)

Thông tin chi tiết
Tham số
aValue
Một giá trị 64 bit cần ghi.
Giá trị trả về
WEAVE_NO_ERROR
Nếu mọi thứ đều ổn.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu chúng ta đang chạy qua cuối vùng đệm.

writeByte

WEAVE_ERROR writeByte(
  uint8_t
)

Thông tin chi tiết
Tham số
aValue
Một giá trị byte để ghi.
Giá trị trả về
WEAVE_NO_ERROR
Nếu mọi thứ đều ổn.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu chúng ta đang chạy qua hết vùng đệm.

writeBytes

WEAVE_ERROR writeBytes(
  uint16_t,
  uint8_t *
)

Thông tin chi tiết
Tham số
aLength
Độ dài của chuỗi byte cần ghi.
aString
Chuỗi byte.
Giá trị trả về
WEAVE_NO_ERROR
Nếu mọi thứ đều ổn.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu chúng ta đang chạy qua hết vùng đệm.

writeString

WEAVE_ERROR writeString(
  uint16_t,
  char *
)

Thông tin chi tiết
Tham số
aLength
Độ dài của chuỗi cần ghi.
aString
Chính chuỗi đó.
Giá trị trả về
WEAVE_NO_ERROR
Nếu mọi thứ đều ổn.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu chúng ta đang chạy qua hết vùng đệm.