NL::編織::簡介::消息迭代器
#include <src/lib/profiles/common/WeaveMessage.h>
為了明智地使用消息緩衝區,我們定義了這個迭代器,它可以用來跟踪邊界等。
概括
遺產
:從繼承NL ::紡織品::簡介:: RetainedPacketBuffer 公共屬性
公共職能
寫完
void finishWriting(
void
)
有數據
bool hasData(
uint16_t
)
細節 | 參數 | |
返回值 | true | 緩衝區的當前數據長度大於或等於給定的增量。 | false | 除此以外。 |
|
有房間
bool hasRoom(
uint16_t
)
細節 | 參數 | |
返回值 | true | 緩衝區的當前數據長度與其最大允許數據長度(其可用數據長度)之間的差值小於或等於給定增量。 | false | 除此以外。 |
|
運算符!=
bool operator!=(
const MessageIterator &
)
細節 | 參數 | aMessageIterator | 另一個要比較的消息迭代器。 |
|
操作員*
uint8_t & operator*(
void
)
操作員+
MessageIterator & operator+(
uint16_t
)
細節 | 參數 | |
退貨 | 如果有空間,迭代器按給定的值遞增,否則,如果沒有,則直接撞到最後。 |
操作員-
MessageIterator & operator-(
uint16_t
)
細節 | 參數 | |
退貨 | 如果有空間,迭代器將遞減給定的值,否則,如果沒有,則直接撞到開頭。 |
運算符==
bool operator==(
const MessageIterator &
)
細節 | 參數 | aMessageIterator | 另一個要比較的消息迭代器。 |
|
讀16
WEAVE_ERROR read16(
uint16_t *
)
細節 | 參數 | aDestination | 一個可以從緩衝區中讀取簡短內容的地方。 |
|
返回值 | WEAVE_NO_ERROR | 如果一切正常。 | WEAVE_ERROR_BUFFER_TOO_SMALL | 如果我們跑過緩衝區的末尾。 |
|
讀32
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 | 如果我們跑過緩衝區的末尾。 |
|
讀取字節
WEAVE_ERROR readByte(
uint8_t *
)
細節 | 參數 | aDestination | 放置從緩衝區讀取的字節的地方。 |
|
返回值 | WEAVE_NO_ERROR | 如果一切正常。 | WEAVE_ERROR_BUFFER_TOO_SMALL | 如果我們跑過緩衝區的末尾。 |
|
讀取字節數
WEAVE_ERROR readBytes(
uint16_t,
uint8_t *
)
細節 | 參數 | aLength | 要讀取的字節字符串的長度。 | aByteString | 放置字節的地方。 |
|
返回值 | WEAVE_NO_ERROR | 如果一切正常。 | WEAVE_ERROR_BUFFER_TOO_SMALL | 如果我們跑過緩衝區的末尾。 |
|
讀取字符串
WEAVE_ERROR readString(
uint16_t,
char *
)
細節 | 參數 | aLength | 要讀取的字符串的長度。 | aString | 放繩子的地方。 |
|
返回值 | WEAVE_NO_ERROR | 如果一切正常。 | WEAVE_ERROR_BUFFER_TOO_SMALL | 如果我們跑過緩衝區的末尾。 |
|
寫16
WEAVE_ERROR write16(
uint16_t
)
細節 | 參數 | |
返回值 | WEAVE_NO_ERROR | 如果一切正常。 | WEAVE_ERROR_BUFFER_TOO_SMALL | 如果我們跑過緩衝區的末尾。 |
|
寫32
WEAVE_ERROR write32(
uint32_t
)
細節 | 參數 | |
返回值 | WEAVE_NO_ERROR | 如果一切正常。 | WEAVE_ERROR_BUFFER_TOO_SMALL | 如果我們跑過緩衝區的末尾。 |
|
寫64
WEAVE_ERROR write64(
uint64_t
)
細節 | 參數 | |
返回值 | WEAVE_NO_ERROR | 如果一切正常。 | WEAVE_ERROR_BUFFER_TOO_SMALL | 如果我們跑過緩衝區的末尾。 |
|
寫字節
WEAVE_ERROR writeByte(
uint8_t
)
細節 | 參數 | |
返回值 | WEAVE_NO_ERROR | 如果一切正常。 | WEAVE_ERROR_BUFFER_TOO_SMALL | 如果我們跑過緩衝區的末尾。 |
|
寫字節數
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 | 如果我們跑過緩衝區的末尾。 |
|