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 học con đã biết trực tiếp: nl::Weave::Profiles::BDX_Development::BlockEOF

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

Các thuộc tính công khai
mBlockCounter
uint8_t
Bộ đếm của khối đang được gửi này.
mData
uint8_t *
Con trỏ đến dữ liệu cần nhận hoặc truyề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 chạy một thông báo BlockSend.
operator==(const BlockSend &) const
bool
So sánh sự bình đẳng giữa các tin nhắn BlockSend.
packedLength(void)
uint16_t
Trả về độ dài đóng gói của thông báo gửi theo khối 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.

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

mBlockCounter

uint8_t mBlockCounter

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

Dữ liệu mData

uint8_t * mData

Con trỏ đến dữ liệu cần nhận hoặc truyề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 giá trị mặc định cho khối gửi thông báo.

khởi tạo

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

Khởi chạy một thông báo BlockSend.

Chi tiết
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 sự bình đẳng giữa các tin nhắn BlockSend.

Chi tiết
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ề
true iff tất cả các trường đều giống nhau.

packedLength

uint16_t packedLength(
  void
)

Trả về độ dài đóng gói của thông báo gửi theo khối này.

Chi tiết
Trả về
chiều dài của thư khi được đóng gói

Hàm tĩnh công khai

phân tích cú pháp

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.

Chi tiết
Tham số
[in] aBuffer
Con trỏ đến một PacketBuffer có dữ liệu mà chúng tôi muốn phân tích cú pháp
[out] aResponse
Con trỏ đến đố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 vùng đệm quá nhỏ