nl :: Dệt :: Hồ sơ :: MessageIterator
#include <src/lib/profiles/common/WeaveMessage.h> Để sử dụng bộ đệm thông báo một cách hợp lý, chúng tôi xác định trình lặp này, có thể được sử dụng để theo dõi các ranh giới, v.v.
Tóm lược
Di sản
Inherits từ: nl :: Weave :: Profiles :: RetainedPacketBuffer Thuộc tính công cộng
thePoint
uint8_t * thePoint
Chức năng công cộng
MessageIterator
MessageIterator(
System::PacketBuffer *
)
Phương thức khởi tạo.
| Chi tiết | | Thông số | aBuffer | Một bộ đệm tin nhắn để lặp lại. |
|
nối thêm
void append(
void
)
Đặt điểm sau bất kỳ dữ liệu nào hiện có trong bộ đệm.
kết thúc
void finishWriting(
void
)
Điều chỉnh bộ đệm sau khi viết.
hasData
bool hasData(
uint16_t
)
| Chi tiết | | Thông số | inc | Một số nguyên có thể được đọc từ bộ đệm. |
|
| Giá trị trả lại | true | Độ dài dữ liệu hiện tại của bộ đệm lớn hơn hoặc bằng số gia đã cho. | false | Nếu không thì. |
|
hasRoom
bool hasRoom(
uint16_t
)
| Chi tiết | | Thông số | inc | Một số nguyên có thể được ghi vào bộ đệm. |
|
| Giá trị trả lại | true | Sự khác biệt giữa độ dài dữ liệu hiện tại của bộ đệm và độ dài dữ liệu tối đa cho phép của nó, (độ dài dữ liệu có sẵn), nhỏ hơn hoặc bằng khoảng gia số đã cho. | false | Nếu không thì. |
|
toán tử! =
bool operator!=(
const MessageIterator &
)
| Chi tiết | | Thông số | aMessageIterator | Một trình lặp thông báo khác để so sánh với. |
|
nhà điều hành*
uint8_t & operator*(
void
)
| Chi tiết | | Lợi nhuận | Những gì chúng tôi đang xem xét trong bộ đệm. |
toán tử +
MessageIterator & operator+(
uint16_t
)
| Chi tiết | | Thông số | inc | Một gia số để áp dụng cho trình lặp thông báo. |
|
| Lợi nhuận | Trình vòng lặp tăng lên theo giá trị đã cho nếu còn chỗ, hoặc nếu không sẽ bị đóng sầm lại ngay phía cuối nếu không có. |
toán tử ++
MessageIterator & operator++(
void
)
Tăng một trình lặp thông báo lên 1 nếu còn chỗ.
nhà điều hành-
MessageIterator & operator-(
uint16_t
)
| Chi tiết | | Thông số | dec | Giảm áp dụng cho trình lặp thông báo. |
|
| Lợi nhuận | Trình lặp giảm dần theo giá trị đã cho nếu còn chỗ hoặc người khác sẽ tăng ngay so với lúc đầu nếu không có. |
toán tử ==
bool operator==(
const MessageIterator &
)
| Chi tiết | | Thông số | aMessageIterator | Một trình lặp thông báo khác để so sánh với. |
|
đọc16
WEAVE_ERROR read16(
uint16_t *
)
| Chi tiết | | Thông số | aDestination | Một nơi để đặt một bài đọc ngắn ra khỏi bộ đệm. |
|
| Giá trị trả lại | WEAVE_NO_ERROR | Nếu tất cả đều ổn. | WEAVE_ERROR_BUFFER_TOO_SMALL | Nếu chúng ta đang chạy qua phần cuối của bộ đệm. |
|
đọc32
WEAVE_ERROR read32(
uint32_t *
)
| Chi tiết | | Thông số | aDestination | Nơi đặt giá trị 32 bit được đọc ra khỏi bộ đệm. |
|
| Giá trị trả lại | WEAVE_NO_ERROR | Nếu tất cả đều ổn. | WEAVE_ERROR_BUFFER_TOO_SMALL | Nếu chúng ta đang chạy qua phần cuối của bộ đệm. |
|
đọc64
WEAVE_ERROR read64(
uint64_t *
)
| Chi tiết | | Thông số | aDestination | Nơi đặt giá trị 64 bit được đọc ra khỏi bộ đệm. |
|
| Giá trị trả lại | WEAVE_NO_ERROR | Nếu tất cả đều ổn. | WEAVE_ERROR_BUFFER_TOO_SMALL | Nếu chúng ta đang chạy qua phần cuối của bộ đệm. |
|
readByte
WEAVE_ERROR readByte(
uint8_t *
)
| Chi tiết | | Thông số | aDestination | Một nơi để đặt một byte đọc ra khỏi bộ đệm. |
|
| Giá trị trả lại | WEAVE_NO_ERROR | Nếu tất cả đều ổn. | WEAVE_ERROR_BUFFER_TOO_SMALL | Nếu chúng ta đang chạy qua phần cuối của bộ đệm. |
|
readBytes
WEAVE_ERROR readBytes(
uint16_t,
uint8_t *
)
| Chi tiết | | Thông số | aLength | Độ dài của chuỗi byte được đọc. | aByteString | Một nơi để đặt các byte. |
|
| Giá trị trả lại | WEAVE_NO_ERROR | Nếu tất cả đều ổn. | WEAVE_ERROR_BUFFER_TOO_SMALL | Nếu chúng ta đang chạy qua phần cuối của bộ đệm. |
|
readString
WEAVE_ERROR readString(
uint16_t,
char *
)
| Chi tiết | | Thông số | aLength | Độ dài của chuỗi được đọc. | aString | Một nơi để đặt chuỗi. |
|
| Giá trị trả lại | WEAVE_NO_ERROR | Nếu tất cả đều ổn. | WEAVE_ERROR_BUFFER_TOO_SMALL | Nếu chúng ta đang chạy qua phần cuối của bộ đệm. |
|
ghi16
WEAVE_ERROR write16(
uint16_t
)
| Chi tiết | | Thông số | aValue | Một giá trị ngắn để viết ra. |
|
| Giá trị trả lại | WEAVE_NO_ERROR | Nếu tất cả đều ổn. | WEAVE_ERROR_BUFFER_TOO_SMALL | Nếu chúng ta đang chạy qua phần cuối của bộ đệm. |
|
viết32
WEAVE_ERROR write32(
uint32_t
)
| Chi tiết | | Thông số | aValue | Giá trị 32 bit để ghi ra. |
|
| Giá trị trả lại | WEAVE_NO_ERROR | Nếu tất cả đều ổn. | WEAVE_ERROR_BUFFER_TOO_SMALL | Nếu chúng ta đang chạy qua phần cuối của bộ đệm. |
|
ghi64
WEAVE_ERROR write64(
uint64_t
)
| Chi tiết | | Thông số | aValue | Giá trị 64-bit để ghi ra. |
|
| Giá trị trả lại | WEAVE_NO_ERROR | Nếu tất cả đều ổn. | WEAVE_ERROR_BUFFER_TOO_SMALL | Nếu chúng ta đang chạy qua phần cuối của bộ đệm. |
|
writeByte
WEAVE_ERROR writeByte(
uint8_t
)
| Chi tiết | | Thông số | aValue | Một giá trị byte để ghi ra. |
|
| Giá trị trả lại | WEAVE_NO_ERROR | Nếu tất cả đều ổn. | WEAVE_ERROR_BUFFER_TOO_SMALL | Nếu chúng ta đang chạy qua phần cuối của bộ đệm. |
|
writeBytes
WEAVE_ERROR writeBytes(
uint16_t,
uint8_t *
)
| Chi tiết | | Thông số | aLength | Độ dài của chuỗi byte cần ghi. | aString | Chuỗi byte chính nó. |
|
| Giá trị trả lại | WEAVE_NO_ERROR | Nếu tất cả đều ổn. | WEAVE_ERROR_BUFFER_TOO_SMALL | Nếu chúng ta đang chạy qua phần cuối của bộ đệm. |
|
writeString
WEAVE_ERROR writeString(
uint16_t,
char *
)
| Chi tiết | | Thông số | aLength | Độ dài của chuỗi để viết. | aString | Chuỗi chính nó. |
|
| Giá trị trả lại | WEAVE_NO_ERROR | Nếu tất cả đều ổn. | WEAVE_ERROR_BUFFER_TOO_SMALL | Nếu chúng ta đang chạy qua phần cuối của bộ đệm. |
|
