nl::Weave::Profiles::BDX_Development::BlockSend

#include <src/lib/profiles/bulk-data-transfer/Development/BDXMessages.h>

Thông báo BlockSend được dùng để chuyển một khối dữ liệu từ người gửi sang người nhận.

Tóm tắt

Tính kế thừa

Kế thừa từ: nl::Weave::Profiles::RetainedPacketBuffer
Lớp con đã biết trực tiếp: nl::Weave::Profiles::BDX_Development::BlockEOF

Hàm khởi tạo và hàm phá

BlockSend(void)
Hàm khởi tạo không có đối số với các giá trị mặc định cho thông báo khối gửi đi.

Thuộc tính công khai

mBlockCounter
uint8_t
Bộ đếm khối này đang được gửi.
mData
uint8_t *
Con trỏ đến dữ liệu cần nhận hoặc chuyển.
mLength
uint64_t
Độ dài của dữ liệu có trong khối này.

Hàm công khai

init(uint8_t aCounter, uint64_t aLength, uint8_t *aData)
Khởi tạo thông báo BlockSend.
operator==(const BlockSend &) const
bool
So sánh bình đẳng giữa các thư BlockSend.
packedLength(void)
uint16_t
Trả về chiều dài đóng gói của khối gửi tin nhắn này.

Hàm tĩnh công khai

parse(PacketBuffer *aBuffer, BlockSend & aResponse)
Phân tích cú pháp dữ liệu từ PacketBuffer thành định dạng thông báo BlockSend.

Thuộc tính công khai

mBlockCounter

uint8_t mBlockCounter

Bộ đếm khối này đang được gửi.

mData

uint8_t * mData

Con trỏ đến dữ liệu cần nhận hoặc chuyển.

mLength

uint64_t mLength

Độ dài của dữ liệu có trong khối này.

Hàm công khai

BlockSend

 BlockSend(
  void
)

Hàm khởi tạo không có đối số với các giá trị mặc định cho thông báo khối gửi đi.

init

WEAVE_ERROR init(
  uint8_t aCounter,
  uint64_t aLength,
  uint8_t *aData
)

Khởi tạo thông báo BlockSend.

Thông tin chi tiết
Các tham số
[in] aCounter
Chặn giá trị bộ đếm cho khối này
[in] aLength
Chiều dài của khối
[in] aData
Con trỏ đến dữ liệu cần chuyển
Trả về
WEAVE_NO_ERROR nếu thành công

toán tử==

bool operator==(
  const BlockSend &
) const 

So sánh bình đẳng giữa các thư BlockSend.

Thông tin chi tiết
Các tham số
[in] another
Một thông báo BlockSend khác để so sánh với thông báo này
Trả về
nếu chúng có tất cả các trường giống nhau.

packedLength

uint16_t packedLength(
  void
)

Trả về chiều dài đóng gói của khối gửi tin nhắn này.

Thông tin chi tiết
Trả về
độ dài của thư khi đóng gói

Hàm tĩnh công khai

parse

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  BlockSend & aResponse
)

Phân tích cú pháp dữ liệu từ PacketBuffer thành định dạng thông báo BlockSend.

Thông tin chi tiết
Các tham số
[in] aBuffer
Con trỏ đến PacketBuffer có dữ liệu mà chúng ta muốn phân tích cú pháp
[out] aResponse
Con trỏ đến một đối tượng BlockSend mà chúng ta nên lưu trữ kết quả
Giá trị trả về
WEAVE_NO_ERROR
Nếu thành công
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu bộ đệm quá nhỏ